libempathy-gtk/empathy-irc-network-chooser-dialog.c

   1 /*
   2  * Copyright (C) 2007-2008 Guillaume Desmottes
   3  * Copyright (C) 2010 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  * Authors: Guillaume Desmottes <gdesmott@gnome.org>
  20  */
  21
  22 #include "config.h"
  23
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <sys/stat.h>
  27
  28 #include <glib/gi18n-lib.h>
  29 #include <gtk/gtk.h>
  30
  31 #include <libempathy/empathy-utils.h>
  32 #include <libempathy/empathy-irc-network-manager.h>
  33
  34 #include "empathy-irc-network-dialog.h"
  35 #include "empathy-ui-utils.h"
  36 #include "empathy-live-search.h"
  37
  38 #define DEBUG_FLAG EMPATHY_DEBUG_ACCOUNT | EMPATHY_DEBUG_IRC
  39 #include <libempathy/empathy-debug.h>
  40
  41 #include "empathy-irc-network-chooser-dialog.h"
  42
  43 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyIrcNetworkChooserDialog)
  44
  45 enum {
  46     PROP_SETTINGS = 1,
  47     PROP_NETWORK
  48 };
  49
  50 typedef struct {
  51     EmpathyAccountSettings *settings;
  52     EmpathyIrcNetwork *network;
  53
  54     EmpathyIrcNetworkManager *network_manager;
  55     gboolean changed;
  56
  57     GtkWidget *treeview;
  58     GtkListStore *store;
  59     GtkTreeModelFilter *filter;
  60     GtkWidget *search;
  61     GtkWidget *select_button;
  62
  63     gulong search_sig;
  64 } EmpathyIrcNetworkChooserDialogPriv;
  65
  66 enum {
  67   COL_NETWORK_OBJ,
  68   COL_NETWORK_NAME,
  69 };
  70
  71 G_DEFINE_TYPE (EmpathyIrcNetworkChooserDialog, empathy_irc_network_chooser_dialog,
  72     GTK_TYPE_DIALOG);
  73
  74 static void
  75 empathy_irc_network_chooser_dialog_set_property (GObject *object,
  76     guint prop_id,
  77     const GValue *value,
  78     GParamSpec *pspec)
  79 {
  80   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (object);
  81
  82   switch (prop_id)
  83     {
  84       case PROP_SETTINGS:
  85         priv->settings = g_value_dup_object (value);
  86         break;
  87       case PROP_NETWORK:
  88         priv->network = g_value_dup_object (value);
  89         break;
  90       default:
  91         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
  92         break;
  93     }
  94 }
  95
  96 static void
  97 empathy_irc_network_chooser_dialog_get_property (GObject *object,
  98     guint prop_id,
  99     GValue *value,
 100     GParamSpec *pspec)
 101 {
 102   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (object);
 103
 104   switch (prop_id)
 105     {
 106       case PROP_SETTINGS:
 107         g_value_set_object (value, priv->settings);
 108         break;
 109       case PROP_NETWORK:
 110         g_value_set_object (value, priv->network);
 111         break;
 112       default:
 113         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 114         break;
 115     }
 116 }
 117
 118 /* The iter returned by *it is a priv->store iter (not a filter one) */
 119 static EmpathyIrcNetwork *
 120 dup_selected_network (EmpathyIrcNetworkChooserDialog *self,
 121     GtkTreeIter *it)
 122 {
 123   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 124   EmpathyIrcNetwork *network;
 125   GtkTreeSelection *selection;
 126   GtkTreeIter iter;
 127   GtkTreeModel *model;
 128
 129   selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->treeview));
 130   if (!gtk_tree_selection_get_selected (selection, &model, &iter))
 131     return NULL;
 132
 133   gtk_tree_model_get (model, &iter, COL_NETWORK_OBJ, &network, -1);
 134   g_assert (network != NULL);
 135
 136   if (it != NULL)
 137     {
 138       gtk_tree_model_filter_convert_iter_to_child_iter (priv->filter, it,
 139           &iter);
 140     }
 141
 142   return network;
 143 }
 144
 145 static void
 146 treeview_changed_cb (GtkTreeView *treeview,
 147     EmpathyIrcNetworkChooserDialog *self)
 148 {
 149   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 150   EmpathyIrcNetwork *network;
 151
 152   network = dup_selected_network (self, NULL);
 153   if (network == priv->network)
 154     {
 155       g_object_unref (network);
 156       return;
 157     }
 158
 159   tp_clear_object (&priv->network);
 160   /* Transfer the reference */
 161   priv->network = network;
 162
 163   priv->changed = TRUE;
 164 }
 165
 166 /* Take a filter iterator as argument */
 167 static void
 168 scroll_to_iter (EmpathyIrcNetworkChooserDialog *self,
 169     GtkTreeIter *filter_iter)
 170 {
 171   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 172   GtkTreePath *path;
 173
 174   path = gtk_tree_model_get_path (GTK_TREE_MODEL (priv->filter), filter_iter);
 175
 176   if (path != NULL)
 177     {
 178       gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW (priv->treeview),
 179           path, NULL, FALSE, 0, 0);
 180
 181       gtk_tree_path_free (path);
 182     }
 183 }
 184
 185 /* Take a filter iterator as argument */
 186 static void
 187 select_iter (EmpathyIrcNetworkChooserDialog *self,
 188     GtkTreeIter *filter_iter,
 189     gboolean emulate_changed)
 190 {
 191   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 192   GtkTreeSelection *selection;
 193   GtkTreePath *path;
 194
 195   /* Select the network */
 196   selection = gtk_tree_view_get_selection (
 197       GTK_TREE_VIEW (priv->treeview));
 198
 199   gtk_tree_selection_select_iter (selection, filter_iter);
 200
 201   path = gtk_tree_model_get_path (GTK_TREE_MODEL (priv->filter), filter_iter);
 202   if (path != NULL)
 203     {
 204       gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->treeview), path,
 205           NULL, FALSE);
 206
 207       gtk_tree_path_free (path);
 208     }
 209
 210   /* Scroll to the selected network */
 211   scroll_to_iter (self, filter_iter);
 212
 213   if (emulate_changed)
 214     {
 215       /* gtk_tree_selection_select_iter doesn't fire the 'cursor-changed' signal
 216        * so we call the callback manually. */
 217       treeview_changed_cb (GTK_TREE_VIEW (priv->treeview), self);
 218     }
 219 }
 220
 221 static GtkTreeIter
 222 iter_to_filter_iter (EmpathyIrcNetworkChooserDialog *self,
 223     GtkTreeIter *iter)
 224 {
 225   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 226   GtkTreeIter filter_iter;
 227
 228   g_assert (gtk_tree_model_filter_convert_child_iter_to_iter (priv->filter,
 229         &filter_iter, iter));
 230
 231   return filter_iter;
 232 }
 233
 234 static void
 235 fill_store (EmpathyIrcNetworkChooserDialog *self)
 236 {
 237   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 238   GSList *networks, *l;
 239
 240   networks = empathy_irc_network_manager_get_networks (
 241       priv->network_manager);
 242
 243   for (l = networks; l != NULL; l = g_slist_next (l))
 244     {
 245       EmpathyIrcNetwork *network = l->data;
 246       GtkTreeIter iter;
 247
 248       gtk_list_store_insert_with_values (priv->store, &iter, -1,
 249           COL_NETWORK_OBJ, network,
 250           COL_NETWORK_NAME, empathy_irc_network_get_name (network),
 251           -1);
 252
 253       if (network == priv->network)
 254         {
 255           GtkTreeIter filter_iter = iter_to_filter_iter (self, &iter);
 256
 257           select_iter (self, &filter_iter, FALSE);
 258         }
 259
 260       g_object_unref (network);
 261     }
 262
 263   g_slist_free (networks);
 264 }
 265
 266 static void
 267 irc_network_dialog_destroy_cb (GtkWidget *widget,
 268     EmpathyIrcNetworkChooserDialog *self)
 269 {
 270   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 271   EmpathyIrcNetwork *network;
 272   GtkTreeIter iter, filter_iter;
 273
 274   priv->changed = TRUE;
 275
 276   network = dup_selected_network (self, &iter);
 277   if (network == NULL)
 278     return;
 279
 280   /* name could be changed */
 281   gtk_list_store_set (GTK_LIST_STORE (priv->store), &iter,
 282       COL_NETWORK_NAME, empathy_irc_network_get_name (network), -1);
 283
 284   filter_iter = iter_to_filter_iter (self, &iter);
 285   scroll_to_iter (self, &filter_iter);
 286
 287   g_object_unref (network);
 288 }
 289
 290 static void
 291 display_irc_network_dialog (EmpathyIrcNetworkChooserDialog *self,
 292     EmpathyIrcNetwork *network)
 293 {
 294   GtkWidget *dialog;
 295
 296   dialog = empathy_irc_network_dialog_show (network, NULL);
 297
 298   g_signal_connect (dialog, "destroy",
 299       G_CALLBACK (irc_network_dialog_destroy_cb), self);
 300 }
 301
 302 static void
 303 edit_network (EmpathyIrcNetworkChooserDialog *self)
 304 {
 305   EmpathyIrcNetwork *network;
 306
 307   network = dup_selected_network (self, NULL);
 308   if (network == NULL)
 309     return;
 310
 311   display_irc_network_dialog (self, network);
 312
 313   g_object_unref (network);
 314 }
 315
 316 static void
 317 add_network (EmpathyIrcNetworkChooserDialog *self)
 318 {
 319   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 320   EmpathyIrcNetwork *network;
 321   GtkTreeIter iter, filter_iter;
 322
 323   gtk_widget_hide (priv->search);
 324
 325   network = empathy_irc_network_new (_("New Network"));
 326   empathy_irc_network_manager_add (priv->network_manager, network);
 327
 328   gtk_list_store_insert_with_values (priv->store, &iter, -1,
 329       COL_NETWORK_OBJ, network,
 330       COL_NETWORK_NAME, empathy_irc_network_get_name (network),
 331       -1);
 332
 333   filter_iter = iter_to_filter_iter (self, &iter);
 334   select_iter (self, &filter_iter, TRUE);
 335
 336   display_irc_network_dialog (self, network);
 337
 338   g_object_unref (network);
 339 }
 340
 341 static void
 342 remove_network (EmpathyIrcNetworkChooserDialog *self)
 343 {
 344   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 345   EmpathyIrcNetwork *network;
 346   GtkTreeIter iter;
 347
 348   gtk_widget_hide (priv->search);
 349
 350   network = dup_selected_network (self, &iter);
 351   if (network == NULL)
 352     return;
 353
 354   DEBUG ("Remove network %s", empathy_irc_network_get_name (network));
 355
 356   gtk_list_store_remove (priv->store, &iter);
 357   empathy_irc_network_manager_remove (priv->network_manager, network);
 358
 359   /* Select next network */
 360   if (gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->store), &iter))
 361     {
 362       GtkTreeIter filter_iter = iter_to_filter_iter (self, &iter);
 363
 364       select_iter (self, &filter_iter, TRUE);
 365     }
 366
 367   g_object_unref (network);
 368 }
 369
 370 static void
 371 dialog_response_cb (GtkDialog *dialog,
 372     gint response,
 373     EmpathyIrcNetworkChooserDialog *self)
 374 {
 375   if (response == GTK_RESPONSE_OK)
 376     add_network (self);
 377   else if (response == GTK_RESPONSE_APPLY)
 378     edit_network (self);
 379   else if (response == GTK_RESPONSE_REJECT)
 380     remove_network (self);
 381 }
 382
 383 static gboolean
 384 filter_visible_func (GtkTreeModel *model,
 385     GtkTreeIter *iter,
 386     gpointer user_data)
 387 {
 388   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (user_data);
 389   EmpathyIrcNetwork *network;
 390   gboolean visible;
 391
 392   gtk_tree_model_get (model, iter, COL_NETWORK_OBJ, &network, -1);
 393
 394   visible = empathy_live_search_match (EMPATHY_LIVE_SEARCH (priv->search),
 395       empathy_irc_network_get_name (network));
 396
 397   g_object_unref (network);
 398   return visible;
 399 }
 400
 401
 402 static void
 403 search_text_notify_cb (EmpathyLiveSearch *search,
 404     GParamSpec *pspec,
 405     EmpathyIrcNetworkChooserDialog *self)
 406 {
 407   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 408   GtkTreeIter filter_iter;
 409   gboolean sensitive = FALSE;
 410
 411   gtk_tree_model_filter_refilter (priv->filter);
 412
 413   /* Select first matching network */
 414   if (gtk_tree_model_get_iter_first (GTK_TREE_MODEL (priv->filter),
 415         &filter_iter))
 416     {
 417       select_iter (self, &filter_iter, TRUE);
 418       sensitive = TRUE;
 419     }
 420
 421   gtk_widget_set_sensitive (priv->select_button, sensitive);
 422 }
 423
 424 static void
 425 dialog_destroy_cb (GtkWidget *widget,
 426     EmpathyIrcNetworkChooserDialog *self)
 427 {
 428   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 429
 430   g_signal_handler_disconnect (priv->search, priv->search_sig);
 431 }
 432
 433 static void
 434 empathy_irc_network_chooser_dialog_constructed (GObject *object)
 435 {
 436   EmpathyIrcNetworkChooserDialog *self = (EmpathyIrcNetworkChooserDialog *) object;
 437   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 438   GtkDialog *dialog = GTK_DIALOG (self);
 439   GtkCellRenderer *renderer;
 440   GtkWidget *vbox;
 441   GtkTreeViewColumn *column;
 442   GtkWidget *scroll;
 443
 444   g_assert (priv->settings != NULL);
 445
 446   gtk_window_set_title (GTK_WINDOW (self), _("Choose an IRC network"));
 447
 448   /* Create store and treeview */
 449   priv->store = gtk_list_store_new (2, G_TYPE_OBJECT, G_TYPE_STRING);
 450
 451   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv->store),
 452       COL_NETWORK_NAME,
 453       GTK_SORT_ASCENDING);
 454
 455   priv->treeview = gtk_tree_view_new ();
 456   gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->treeview), FALSE);
 457   gtk_tree_view_set_enable_search (GTK_TREE_VIEW (priv->treeview), FALSE);
 458
 459   column = gtk_tree_view_column_new ();
 460   gtk_tree_view_append_column (GTK_TREE_VIEW (priv->treeview), column);
 461
 462   renderer = gtk_cell_renderer_text_new ();
 463   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (column), renderer, TRUE);
 464   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (column),
 465       renderer,
 466       "text", COL_NETWORK_NAME,
 467       NULL);
 468
 469   /* add the treeview in a GtkScrolledWindow */
 470   vbox = gtk_dialog_get_content_area (dialog);
 471
 472   scroll = gtk_scrolled_window_new (NULL, NULL);
 473   gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scroll),
 474       GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 475
 476   gtk_container_add (GTK_CONTAINER (scroll), priv->treeview);
 477   gtk_box_pack_start (GTK_BOX (vbox), scroll, TRUE, TRUE, 6);
 478
 479   /* Live search */
 480   priv->search = empathy_live_search_new (priv->treeview);
 481
 482   gtk_box_pack_start (GTK_BOX (vbox), priv->search, FALSE, TRUE, 0);
 483
 484   priv->filter = GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new (
 485           GTK_TREE_MODEL (priv->store), NULL));
 486   gtk_tree_model_filter_set_visible_func (priv->filter,
 487           filter_visible_func, self, NULL);
 488
 489   gtk_tree_view_set_model (GTK_TREE_VIEW (priv->treeview),
 490           GTK_TREE_MODEL (priv->filter));
 491
 492   priv->search_sig = g_signal_connect (priv->search, "notify::text",
 493       G_CALLBACK (search_text_notify_cb), self);
 494
 495   /* Add buttons */
 496   gtk_dialog_add_buttons (dialog,
 497       GTK_STOCK_ADD, GTK_RESPONSE_OK,
 498       GTK_STOCK_EDIT, GTK_RESPONSE_APPLY,
 499       GTK_STOCK_REMOVE, GTK_RESPONSE_REJECT,
 500       NULL);
 501
 502   priv->select_button = gtk_dialog_add_button (dialog, _("Select"),
 503       GTK_RESPONSE_CLOSE);
 504
 505   fill_store (self);
 506
 507   g_signal_connect (priv->treeview, "cursor-changed",
 508       G_CALLBACK (treeview_changed_cb), self);
 509
 510   g_signal_connect (self, "response",
 511       G_CALLBACK (dialog_response_cb), self);
 512   g_signal_connect (self, "destroy",
 513       G_CALLBACK (dialog_destroy_cb), self);
 514
 515   /* Request a side ensuring to display at least some networks */
 516   gtk_widget_set_size_request (GTK_WIDGET (self), -1, 300);
 517 }
 518
 519 static void
 520 empathy_irc_network_chooser_dialog_dispose (GObject *object)
 521 {
 522   EmpathyIrcNetworkManager *self = (EmpathyIrcNetworkManager *) object;
 523   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 524
 525   tp_clear_object (&priv->settings);
 526   tp_clear_object (&priv->network);
 527   tp_clear_object (&priv->network_manager);
 528   tp_clear_object (&priv->store);
 529   tp_clear_object (&priv->filter);
 530
 531   if (G_OBJECT_CLASS (empathy_irc_network_chooser_dialog_parent_class)->dispose)
 532     G_OBJECT_CLASS (empathy_irc_network_chooser_dialog_parent_class)->dispose (object);
 533 }
 534
 535 static void
 536 empathy_irc_network_chooser_dialog_class_init (EmpathyIrcNetworkChooserDialogClass *klass)
 537 {
 538   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 539
 540   object_class->get_property = empathy_irc_network_chooser_dialog_get_property;
 541   object_class->set_property = empathy_irc_network_chooser_dialog_set_property;
 542   object_class->constructed = empathy_irc_network_chooser_dialog_constructed;
 543   object_class->dispose = empathy_irc_network_chooser_dialog_dispose;
 544
 545   g_object_class_install_property (object_class, PROP_SETTINGS,
 546     g_param_spec_object ("settings",
 547       "Settings",
 548       "The EmpathyAccountSettings to show and edit",
 549       EMPATHY_TYPE_ACCOUNT_SETTINGS,
 550       G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 551
 552   g_object_class_install_property (object_class, PROP_NETWORK,
 553     g_param_spec_object ("network",
 554       "Network",
 555       "The EmpathyIrcNetwork selected in the treeview",
 556       EMPATHY_TYPE_IRC_NETWORK,
 557       G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 558
 559   g_type_class_add_private (object_class,
 560       sizeof (EmpathyIrcNetworkChooserDialogPriv));
 561 }
 562
 563 static void
 564 empathy_irc_network_chooser_dialog_init (EmpathyIrcNetworkChooserDialog *self)
 565 {
 566   EmpathyIrcNetworkChooserDialogPriv *priv;
 567
 568   priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
 569       EMPATHY_TYPE_IRC_NETWORK_CHOOSER_DIALOG, EmpathyIrcNetworkChooserDialogPriv);
 570   self->priv = priv;
 571
 572   priv->network_manager = empathy_irc_network_manager_dup_default ();
 573 }
 574
 575 GtkWidget *
 576 empathy_irc_network_chooser_dialog_new (EmpathyAccountSettings *settings,
 577     EmpathyIrcNetwork *network)
 578 {
 579   return g_object_new (EMPATHY_TYPE_IRC_NETWORK_CHOOSER_DIALOG,
 580       "settings", settings,
 581       "network", network,
 582       NULL);
 583 }
 584
 585 EmpathyIrcNetwork *
 586 empathy_irc_network_chooser_dialog_get_network (
 587     EmpathyIrcNetworkChooserDialog *self)
 588 {
 589   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 590
 591   return priv->network;
 592 }
 593
 594 gboolean
 595 empathy_irc_network_chooser_dialog_get_changed (
 596     EmpathyIrcNetworkChooserDialog *self)
 597 {
 598   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 599
 600   return priv->changed;
 601 }