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
 194   /* Select the network */
 195   selection = gtk_tree_view_get_selection (
 196       GTK_TREE_VIEW (priv->treeview));
 197
 198   gtk_tree_selection_select_iter (selection, filter_iter);
 199
 200   /* Scroll to the selected network */
 201   scroll_to_iter (self, filter_iter);
 202
 203   if (emulate_changed)
 204     {
 205       /* gtk_tree_selection_select_iter doesn't fire the 'cursor-changed' signal
 206        * so we call the callback manually. */
 207       treeview_changed_cb (GTK_TREE_VIEW (priv->treeview), self);
 208     }
 209 }
 210
 211 static void
 212 fill_store (EmpathyIrcNetworkChooserDialog *self)
 213 {
 214   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 215   GSList *networks, *l;
 216
 217   networks = empathy_irc_network_manager_get_networks (
 218       priv->network_manager);
 219
 220   for (l = networks; l != NULL; l = g_slist_next (l))
 221     {
 222       EmpathyIrcNetwork *network = l->data;
 223       GtkTreeIter iter;
 224
 225       gtk_list_store_insert_with_values (priv->store, &iter, -1,
 226           COL_NETWORK_OBJ, network,
 227           COL_NETWORK_NAME, empathy_irc_network_get_name (network),
 228           -1);
 229
 230       if (network == priv->network)
 231         {
 232           GtkTreeIter filter_iter;
 233
 234           /* Convert to a filter iter */
 235           gtk_tree_model_filter_convert_child_iter_to_iter (priv->filter,
 236               &filter_iter, &iter);
 237
 238           select_iter (self, &filter_iter, FALSE);
 239         }
 240
 241       g_object_unref (network);
 242     }
 243
 244   g_slist_free (networks);
 245 }
 246
 247 static void
 248 irc_network_dialog_destroy_cb (GtkWidget *widget,
 249     EmpathyIrcNetworkChooserDialog *self)
 250 {
 251   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 252   EmpathyIrcNetwork *network;
 253   GtkTreeIter iter, filter_iter;
 254
 255   priv->changed = TRUE;
 256
 257   network = dup_selected_network (self, &iter);
 258   if (network == NULL)
 259     return;
 260
 261   /* name could be changed */
 262   gtk_list_store_set (GTK_LIST_STORE (priv->store), &iter,
 263       COL_NETWORK_NAME, empathy_irc_network_get_name (network), -1);
 264
 265   /* Convert to a filter iter */
 266   gtk_tree_model_filter_convert_child_iter_to_iter (priv->filter, &filter_iter,
 267       &iter);
 268
 269   scroll_to_iter (self, &iter);
 270
 271   g_object_unref (network);
 272 }
 273
 274 static void
 275 display_irc_network_dialog (EmpathyIrcNetworkChooserDialog *self,
 276     EmpathyIrcNetwork *network)
 277 {
 278   GtkWidget *dialog;
 279
 280   dialog = empathy_irc_network_dialog_show (network, NULL);
 281
 282   g_signal_connect (dialog, "destroy",
 283       G_CALLBACK (irc_network_dialog_destroy_cb), self);
 284 }
 285
 286 static void
 287 edit_network (EmpathyIrcNetworkChooserDialog *self)
 288 {
 289   EmpathyIrcNetwork *network;
 290
 291   network = dup_selected_network (self, NULL);
 292   if (network == NULL)
 293     return;
 294
 295   display_irc_network_dialog (self, network);
 296
 297   g_object_unref (network);
 298 }
 299
 300 static void
 301 add_network (EmpathyIrcNetworkChooserDialog *self)
 302 {
 303   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 304   EmpathyIrcNetwork *network;
 305   GtkTreeIter iter, filter_iter;
 306
 307   network = empathy_irc_network_new (_("New Network"));
 308   empathy_irc_network_manager_add (priv->network_manager, network);
 309
 310   gtk_list_store_insert_with_values (priv->store, &iter, -1,
 311       COL_NETWORK_OBJ, network,
 312       COL_NETWORK_NAME, empathy_irc_network_get_name (network),
 313       -1);
 314
 315   /* Convert to a filter iter */
 316   gtk_tree_model_filter_convert_child_iter_to_iter (priv->filter, &filter_iter,
 317       &iter);
 318
 319   select_iter (self, &filter_iter, TRUE);
 320
 321   display_irc_network_dialog (self, network);
 322
 323   g_object_unref (network);
 324 }
 325
 326 static void
 327 remove_network (EmpathyIrcNetworkChooserDialog *self)
 328 {
 329   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 330   EmpathyIrcNetwork *network;
 331   GtkTreeIter iter;
 332
 333   network = dup_selected_network (self, &iter);
 334   if (network == NULL)
 335     return;
 336
 337   DEBUG ("Remove network %s", empathy_irc_network_get_name (network));
 338
 339   gtk_list_store_remove (priv->store, &iter);
 340   empathy_irc_network_manager_remove (priv->network_manager, network);
 341
 342   /* Select next network */
 343   if (gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->store), &iter))
 344     select_iter (self, &iter, TRUE);
 345
 346   g_object_unref (network);
 347 }
 348
 349 static void
 350 dialog_response_cb (GtkDialog *dialog,
 351     gint response,
 352     EmpathyIrcNetworkChooserDialog *self)
 353 {
 354   if (response == GTK_RESPONSE_OK)
 355     add_network (self);
 356   else if (response == GTK_RESPONSE_APPLY)
 357     edit_network (self);
 358   else if (response == GTK_RESPONSE_REJECT)
 359     remove_network (self);
 360 }
 361
 362 static gboolean
 363 filter_visible_func (GtkTreeModel *model,
 364     GtkTreeIter *iter,
 365     gpointer user_data)
 366 {
 367   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (user_data);
 368   EmpathyIrcNetwork *network;
 369   gboolean visible;
 370
 371   gtk_tree_model_get (model, iter, COL_NETWORK_OBJ, &network, -1);
 372
 373   visible = empathy_live_search_match (EMPATHY_LIVE_SEARCH (priv->search),
 374       empathy_irc_network_get_name (network));
 375
 376   g_object_unref (network);
 377   return visible;
 378 }
 379
 380
 381 static void
 382 search_text_notify_cb (EmpathyLiveSearch *search,
 383     GParamSpec *pspec,
 384     EmpathyIrcNetworkChooserDialog *self)
 385 {
 386   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 387   GtkTreeIter iter;
 388
 389   gtk_tree_model_filter_refilter (priv->filter);
 390
 391   /* Select first matching network */
 392   if (gtk_tree_model_get_iter_first (GTK_TREE_MODEL (priv->filter), &iter))
 393     select_iter (self, &iter, TRUE);
 394   /* TODO: else unsensitive the close button */
 395 }
 396
 397 static void
 398 dialog_destroy_cb (GtkWidget *widget,
 399     EmpathyIrcNetworkChooserDialog *self)
 400 {
 401   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 402
 403   g_signal_handler_disconnect (priv->search, priv->search_sig);
 404 }
 405
 406 static void
 407 empathy_irc_network_chooser_dialog_constructed (GObject *object)
 408 {
 409   EmpathyIrcNetworkChooserDialog *self = (EmpathyIrcNetworkChooserDialog *) object;
 410   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 411   GtkDialog *dialog = GTK_DIALOG (self);
 412   GtkCellRenderer *renderer;
 413   GtkWidget *vbox;
 414   GtkTreeViewColumn *column;
 415   GtkWidget *scroll;
 416
 417   g_assert (priv->settings != NULL);
 418
 419   gtk_window_set_title (GTK_WINDOW (self), _("IRC Networks"));
 420
 421   /* Create store and treeview */
 422   priv->store = gtk_list_store_new (2, G_TYPE_OBJECT, G_TYPE_STRING);
 423
 424   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv->store),
 425       COL_NETWORK_NAME,
 426       GTK_SORT_ASCENDING);
 427
 428   priv->treeview = gtk_tree_view_new ();
 429   gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->treeview), FALSE);
 430   gtk_tree_view_set_enable_search (GTK_TREE_VIEW (priv->treeview), FALSE);
 431
 432   column = gtk_tree_view_column_new ();
 433   gtk_tree_view_append_column (GTK_TREE_VIEW (priv->treeview), column);
 434
 435   renderer = gtk_cell_renderer_text_new ();
 436   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (column), renderer, TRUE);
 437   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (column),
 438       renderer,
 439       "text", COL_NETWORK_NAME,
 440       NULL);
 441
 442   /* add the treeview in a GtkScrolledWindow */
 443   vbox = gtk_dialog_get_content_area (dialog);
 444
 445   scroll = gtk_scrolled_window_new (NULL, NULL);
 446   gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (scroll),
 447       GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
 448
 449   gtk_container_add (GTK_CONTAINER (scroll), priv->treeview);
 450   gtk_box_pack_start (GTK_BOX (vbox), scroll, TRUE, TRUE, 6);
 451
 452   /* Live search */
 453   priv->search = empathy_live_search_new (priv->treeview);
 454
 455   gtk_box_pack_start (GTK_BOX (vbox), priv->search, FALSE, TRUE, 0);
 456
 457   priv->filter = GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new (
 458           GTK_TREE_MODEL (priv->store), NULL));
 459   gtk_tree_model_filter_set_visible_func (priv->filter,
 460           filter_visible_func, self, NULL);
 461
 462   gtk_tree_view_set_model (GTK_TREE_VIEW (priv->treeview),
 463           GTK_TREE_MODEL (priv->filter));
 464
 465   priv->search_sig = g_signal_connect (priv->search, "notify::text",
 466       G_CALLBACK (search_text_notify_cb), self);
 467
 468   /* Add buttons */
 469   gtk_dialog_add_buttons (dialog,
 470       GTK_STOCK_ADD, GTK_RESPONSE_OK,
 471       GTK_STOCK_EDIT, GTK_RESPONSE_APPLY,
 472       GTK_STOCK_REMOVE, GTK_RESPONSE_REJECT,
 473       NULL);
 474
 475   priv->select_button = gtk_dialog_add_button (dialog, _("Select"),
 476       GTK_RESPONSE_CLOSE);
 477
 478   fill_store (self);
 479
 480   g_signal_connect (priv->treeview, "cursor-changed",
 481       G_CALLBACK (treeview_changed_cb), self);
 482
 483   g_signal_connect (self, "response",
 484       G_CALLBACK (dialog_response_cb), self);
 485   g_signal_connect (self, "destroy",
 486       G_CALLBACK (dialog_destroy_cb), self);
 487
 488   /* Request a side ensuring to display at least some networks */
 489   gtk_widget_set_size_request (GTK_WIDGET (self), -1, 300);
 490 }
 491
 492 static void
 493 empathy_irc_network_chooser_dialog_dispose (GObject *object)
 494 {
 495   EmpathyIrcNetworkManager *self = (EmpathyIrcNetworkManager *) object;
 496   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 497
 498   tp_clear_object (&priv->settings);
 499   tp_clear_object (&priv->network);
 500   tp_clear_object (&priv->network_manager);
 501   tp_clear_object (&priv->store);
 502   tp_clear_object (&priv->filter);
 503
 504   if (G_OBJECT_CLASS (empathy_irc_network_chooser_dialog_parent_class)->dispose)
 505     G_OBJECT_CLASS (empathy_irc_network_chooser_dialog_parent_class)->dispose (object);
 506 }
 507
 508 static void
 509 empathy_irc_network_chooser_dialog_class_init (EmpathyIrcNetworkChooserDialogClass *klass)
 510 {
 511   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 512
 513   object_class->get_property = empathy_irc_network_chooser_dialog_get_property;
 514   object_class->set_property = empathy_irc_network_chooser_dialog_set_property;
 515   object_class->constructed = empathy_irc_network_chooser_dialog_constructed;
 516   object_class->dispose = empathy_irc_network_chooser_dialog_dispose;
 517
 518   g_object_class_install_property (object_class, PROP_SETTINGS,
 519     g_param_spec_object ("settings",
 520       "Settings",
 521       "The EmpathyAccountSettings to show and edit",
 522       EMPATHY_TYPE_ACCOUNT_SETTINGS,
 523       G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 524
 525   g_object_class_install_property (object_class, PROP_NETWORK,
 526     g_param_spec_object ("network",
 527       "Network",
 528       "The EmpathyIrcNetwork selected in the treeview",
 529       EMPATHY_TYPE_IRC_NETWORK,
 530       G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
 531
 532   g_type_class_add_private (object_class,
 533       sizeof (EmpathyIrcNetworkChooserDialogPriv));
 534 }
 535
 536 static void
 537 empathy_irc_network_chooser_dialog_init (EmpathyIrcNetworkChooserDialog *self)
 538 {
 539   EmpathyIrcNetworkChooserDialogPriv *priv;
 540
 541   priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
 542       EMPATHY_TYPE_IRC_NETWORK_CHOOSER_DIALOG, EmpathyIrcNetworkChooserDialogPriv);
 543   self->priv = priv;
 544
 545   priv->network_manager = empathy_irc_network_manager_dup_default ();
 546 }
 547
 548 GtkWidget *
 549 empathy_irc_network_chooser_dialog_new (EmpathyAccountSettings *settings,
 550     EmpathyIrcNetwork *network)
 551 {
 552   return g_object_new (EMPATHY_TYPE_IRC_NETWORK_CHOOSER_DIALOG,
 553       "settings", settings,
 554       "network", network,
 555       NULL);
 556 }
 557
 558 EmpathyIrcNetwork *
 559 empathy_irc_network_chooser_dialog_get_network (
 560     EmpathyIrcNetworkChooserDialog *self)
 561 {
 562   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 563
 564   return priv->network;
 565 }
 566
 567 gboolean
 568 empathy_irc_network_chooser_dialog_get_changed (
 569     EmpathyIrcNetworkChooserDialog *self)
 570 {
 571   EmpathyIrcNetworkChooserDialogPriv *priv = GET_PRIV (self);
 572
 573   return priv->changed;
 574 }