libempathy-gtk/empathy-protocol-chooser.c

   1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
   2 /*
   3  * Copyright (C) 2007-2009 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: Xavier Claessens <xclaesse@gmail.com>
  20  *          Jonny Lamb <jonny.lamb@collabora.co.uk>
  21  */
  22
  23 #include <config.h>
  24
  25 #include <string.h>
  26
  27 #include <telepathy-glib/util.h>
  28
  29 #include <gtk/gtk.h>
  30
  31 #include <glib/gi18n-lib.h>
  32
  33 #include <libempathy/empathy-utils.h>
  34 #include <libempathy/empathy-connection-managers.h>
  35
  36 #include "empathy-protocol-chooser.h"
  37 #include "empathy-ui-utils.h"
  38
  39 #define DEBUG_FLAG EMPATHY_DEBUG_ACCOUNT
  40 #include <libempathy/empathy-debug.h>
  41
  42 /**
  43  * SECTION:empathy-protocol-chooser
  44  * @title: EmpathyProtocolChooser
  45  * @short_description: A widget used to choose from a list of protocols
  46  * @include: libempathy-gtk/empathy-protocol-chooser.h
  47  *
  48  * #EmpathyProtocolChooser is a widget which extends #GtkComboBox to provides a
  49  * chooser of available protocols.
  50  */
  51
  52 /**
  53  * EmpathyProtocolChooser:
  54  * @parent: parent object
  55  *
  56  * Widget which extends #GtkComboBox to provide a chooser of available
  57  * protocols.
  58  */
  59
  60 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyProtocolChooser)
  61 typedef struct
  62 {
  63   GtkListStore *store;
  64
  65   gboolean dispose_run;
  66   EmpathyConnectionManagers *cms;
  67
  68   EmpathyProtocolChooserFilterFunc filter_func;
  69   gpointer filter_user_data;
  70
  71   GHashTable *protocols;
  72 } EmpathyProtocolChooserPriv;
  73
  74 enum
  75 {
  76   COL_ICON,
  77   COL_LABEL,
  78   COL_CM,
  79   COL_PROTOCOL_NAME,
  80   COL_SERVICE,
  81   COL_COUNT
  82 };
  83
  84 G_DEFINE_TYPE (EmpathyProtocolChooser, empathy_protocol_chooser,
  85     GTK_TYPE_COMBO_BOX);
  86
  87 static gint
  88 protocol_chooser_sort_protocol_value (const gchar *protocol_name)
  89 {
  90   guint i;
  91   const gchar *names[] = {
  92     "jabber",
  93     "local-xmpp",
  94     "gtalk",
  95     NULL
  96   };
  97
  98   for (i = 0 ; names[i]; i++)
  99     {
 100       if (strcmp (protocol_name, names[i]) == 0)
 101         return i;
 102     }
 103
 104   return i;
 105 }
 106
 107 static gint
 108 protocol_chooser_sort_func (GtkTreeModel *model,
 109     GtkTreeIter  *iter_a,
 110     GtkTreeIter  *iter_b,
 111     gpointer      user_data)
 112 {
 113   gchar *protocol_a;
 114   gchar *protocol_b;
 115   gint cmp = 0;
 116
 117   gtk_tree_model_get (model, iter_a,
 118       COL_PROTOCOL_NAME, &protocol_a,
 119       -1);
 120   gtk_tree_model_get (model, iter_b,
 121       COL_PROTOCOL_NAME, &protocol_b,
 122       -1);
 123
 124   cmp = protocol_chooser_sort_protocol_value (protocol_a);
 125   cmp -= protocol_chooser_sort_protocol_value (protocol_b);
 126   if (cmp == 0)
 127     {
 128       cmp = strcmp (protocol_a, protocol_b);
 129       /* only happens for jabber where there is one entry for gtalk and one for
 130        * non-gtalk */
 131       if (cmp == 0)
 132         {
 133           gchar *service;
 134
 135           gtk_tree_model_get (model, iter_a,
 136             COL_SERVICE, &service,
 137             -1);
 138
 139           if (service != NULL)
 140             cmp = 1;
 141           else
 142             cmp = -1;
 143
 144           g_free (service);
 145         }
 146     }
 147
 148   g_free (protocol_a);
 149   g_free (protocol_b);
 150   return cmp;
 151 }
 152
 153 static void
 154 protocol_choosers_add_cm (EmpathyProtocolChooser *chooser,
 155     TpConnectionManager *cm)
 156 {
 157   EmpathyProtocolChooserPriv *priv = GET_PRIV (chooser);
 158   GList *protocols, *l;
 159   const gchar *cm_name;
 160
 161   cm_name = tp_connection_manager_get_name (cm);
 162
 163   protocols = tp_connection_manager_dup_protocols (cm);
 164
 165   for (l = protocols; l != NULL; l = g_list_next (l))
 166     {
 167       TpProtocol *protocol = l->data;
 168       gchar *icon_name;
 169       const gchar *display_name;
 170       const gchar *saved_cm_name;
 171       const gchar *proto_name;
 172
 173       proto_name = tp_protocol_get_name (protocol);
 174       saved_cm_name = g_hash_table_lookup (priv->protocols, proto_name);
 175
 176       if (!tp_strdiff (cm_name, "haze") && saved_cm_name != NULL &&
 177           tp_strdiff (saved_cm_name, "haze"))
 178         /* the CM we're adding is a haze implementation of something we already
 179          * have; drop it.
 180          */
 181         continue;
 182
 183       if (!tp_strdiff (cm_name, "haze") &&
 184           !tp_strdiff (proto_name, "facebook"))
 185         /* Facebook now supports XMPP so drop the purple facebook plugin; user
 186          * should use Gabble */
 187         continue;
 188
 189       if (!tp_strdiff (cm_name, "haze") &&
 190           !tp_strdiff (proto_name, "sip"))
 191         /* Haze's SIP implementation is pretty useless (bgo #629736) */
 192         continue;
 193
 194       if (!tp_strdiff (cm_name, "butterfly"))
 195         /* Butterfly isn't supported any more */
 196         continue;
 197
 198       if (tp_strdiff (cm_name, "haze") && !tp_strdiff (saved_cm_name, "haze"))
 199         {
 200           GtkTreeIter titer;
 201           gboolean valid;
 202           TpConnectionManager *haze_cm;
 203
 204           /* let's this CM replace the haze implementation */
 205           valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (priv->store),
 206               &titer);
 207
 208           while (valid)
 209             {
 210               gchar *haze_proto_name = NULL;
 211
 212               gtk_tree_model_get (GTK_TREE_MODEL (priv->store), &titer,
 213                   COL_PROTOCOL_NAME, &haze_proto_name,
 214                   COL_CM, &haze_cm, -1);
 215
 216               if (haze_cm == NULL)
 217                 continue;
 218
 219               if (!tp_strdiff (tp_connection_manager_get_name (haze_cm), "haze")
 220                   && !tp_strdiff (haze_proto_name, proto_name))
 221                 {
 222                   gtk_list_store_remove (priv->store, &titer);
 223                   g_object_unref (haze_cm);
 224                   g_free (haze_proto_name);
 225                   break;
 226                 }
 227
 228               g_object_unref (haze_cm);
 229               g_free (haze_proto_name);
 230               valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (priv->store),
 231                   &titer);
 232             }
 233         }
 234
 235       g_hash_table_insert (priv->protocols,
 236           g_strdup (proto_name), g_strdup (cm_name));
 237
 238       icon_name = empathy_protocol_icon_name (proto_name);
 239
 240       display_name = empathy_protocol_name_to_display_name (proto_name);
 241
 242       gtk_list_store_insert_with_values (priv->store,
 243           NULL, 0,
 244           COL_ICON, icon_name,
 245           COL_LABEL, display_name,
 246           COL_CM, cm,
 247           COL_PROTOCOL_NAME, proto_name,
 248           -1);
 249
 250       if (!tp_strdiff (proto_name, "jabber") &&
 251           !tp_strdiff (cm_name, "gabble"))
 252         {
 253           display_name = empathy_service_name_to_display_name ("google-talk");
 254           gtk_list_store_insert_with_values (priv->store,
 255              NULL, 0,
 256              COL_ICON, "im-google-talk",
 257              COL_LABEL, display_name,
 258              COL_CM, cm,
 259              COL_PROTOCOL_NAME, proto_name,
 260              COL_SERVICE, "google-talk",
 261              -1);
 262
 263           display_name = empathy_service_name_to_display_name ("facebook");
 264           gtk_list_store_insert_with_values (priv->store,
 265              NULL, 0,
 266              COL_ICON, "im-facebook",
 267              COL_LABEL, display_name,
 268              COL_CM, cm,
 269              COL_PROTOCOL_NAME, proto_name,
 270              COL_SERVICE, "facebook",
 271              -1);
 272         }
 273
 274       g_free (icon_name);
 275     }
 276
 277   g_list_free_full (protocols, g_object_unref);
 278 }
 279
 280 static void
 281 protocol_chooser_add_cms_list (EmpathyProtocolChooser *protocol_chooser,
 282     GList *cms)
 283 {
 284   GList *l;
 285
 286   for (l = cms; l != NULL; l = l->next)
 287     protocol_choosers_add_cm (protocol_chooser, l->data);
 288
 289   gtk_combo_box_set_active (GTK_COMBO_BOX (protocol_chooser), 0);
 290 }
 291
 292 static void
 293 protocol_chooser_cms_prepare_cb (GObject *source,
 294     GAsyncResult *result,
 295     gpointer user_data)
 296 {
 297   EmpathyConnectionManagers *cms = EMPATHY_CONNECTION_MANAGERS (source);
 298   EmpathyProtocolChooser *protocol_chooser = user_data;
 299
 300   if (!empathy_connection_managers_prepare_finish (cms, result, NULL))
 301     return;
 302
 303   protocol_chooser_add_cms_list (protocol_chooser,
 304       empathy_connection_managers_get_cms (cms));
 305 }
 306
 307 static void
 308 protocol_chooser_constructed (GObject *object)
 309 {
 310   EmpathyProtocolChooser *protocol_chooser;
 311   EmpathyProtocolChooserPriv *priv;
 312   GtkCellRenderer *renderer;
 313
 314   priv = GET_PRIV (object);
 315   protocol_chooser = EMPATHY_PROTOCOL_CHOOSER (object);
 316
 317   /* set up combo box with new store */
 318   priv->store = gtk_list_store_new (COL_COUNT,
 319           G_TYPE_STRING,    /* Icon name */
 320           G_TYPE_STRING,    /* Label     */
 321           G_TYPE_OBJECT,    /* CM */
 322           G_TYPE_STRING,    /* protocol name  */
 323           G_TYPE_STRING);   /* service */
 324
 325   /* Set the protocol sort function */
 326   gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (priv->store),
 327       COL_PROTOCOL_NAME,
 328       protocol_chooser_sort_func,
 329       NULL, NULL);
 330   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv->store),
 331       COL_PROTOCOL_NAME,
 332       GTK_SORT_ASCENDING);
 333
 334   gtk_combo_box_set_model (GTK_COMBO_BOX (object),
 335       GTK_TREE_MODEL (priv->store));
 336
 337   renderer = gtk_cell_renderer_pixbuf_new ();
 338   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (object), renderer, FALSE);
 339   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (object), renderer,
 340       "icon-name", COL_ICON,
 341       NULL);
 342   g_object_set (renderer, "stock-size", GTK_ICON_SIZE_BUTTON, NULL);
 343
 344   renderer = gtk_cell_renderer_text_new ();
 345   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (object), renderer, TRUE);
 346   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (object), renderer,
 347       "text", COL_LABEL,
 348       NULL);
 349
 350   empathy_connection_managers_prepare_async (priv->cms,
 351       protocol_chooser_cms_prepare_cb, protocol_chooser);
 352
 353   if (G_OBJECT_CLASS (empathy_protocol_chooser_parent_class)->constructed)
 354     G_OBJECT_CLASS
 355       (empathy_protocol_chooser_parent_class)->constructed (object);
 356 }
 357
 358 static void
 359 empathy_protocol_chooser_init (EmpathyProtocolChooser *protocol_chooser)
 360 {
 361   EmpathyProtocolChooserPriv *priv =
 362     G_TYPE_INSTANCE_GET_PRIVATE (protocol_chooser,
 363         EMPATHY_TYPE_PROTOCOL_CHOOSER, EmpathyProtocolChooserPriv);
 364
 365   priv->dispose_run = FALSE;
 366   priv->cms = empathy_connection_managers_dup_singleton ();
 367   priv->protocols = g_hash_table_new_full (g_str_hash, g_str_equal,
 368       g_free, g_free);
 369
 370   protocol_chooser->priv = priv;
 371 }
 372
 373 static void
 374 protocol_chooser_finalize (GObject *object)
 375 {
 376   EmpathyProtocolChooser *protocol_chooser = EMPATHY_PROTOCOL_CHOOSER (object);
 377   EmpathyProtocolChooserPriv *priv = GET_PRIV (protocol_chooser);
 378
 379   if (priv->protocols)
 380     {
 381       g_hash_table_unref (priv->protocols);
 382       priv->protocols = NULL;
 383     }
 384
 385   (G_OBJECT_CLASS (empathy_protocol_chooser_parent_class)->finalize) (object);
 386 }
 387
 388 static void
 389 protocol_chooser_dispose (GObject *object)
 390 {
 391   EmpathyProtocolChooser *protocol_chooser = EMPATHY_PROTOCOL_CHOOSER (object);
 392   EmpathyProtocolChooserPriv *priv = GET_PRIV (protocol_chooser);
 393
 394   if (priv->dispose_run)
 395     return;
 396
 397   priv->dispose_run = TRUE;
 398
 399   if (priv->store)
 400     {
 401       g_object_unref (priv->store);
 402       priv->store = NULL;
 403     }
 404
 405   if (priv->cms)
 406     {
 407       g_object_unref (priv->cms);
 408       priv->cms = NULL;
 409     }
 410
 411   (G_OBJECT_CLASS (empathy_protocol_chooser_parent_class)->dispose) (object);
 412 }
 413
 414 static void
 415 empathy_protocol_chooser_class_init (EmpathyProtocolChooserClass *klass)
 416 {
 417   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 418
 419   object_class->constructed = protocol_chooser_constructed;
 420   object_class->dispose = protocol_chooser_dispose;
 421   object_class->finalize = protocol_chooser_finalize;
 422
 423   g_type_class_add_private (object_class, sizeof (EmpathyProtocolChooserPriv));
 424 }
 425
 426 static gboolean
 427 protocol_chooser_filter_visible_func (GtkTreeModel *model,
 428     GtkTreeIter *iter,
 429     gpointer user_data)
 430 {
 431   EmpathyProtocolChooser *protocol_chooser = user_data;
 432   EmpathyProtocolChooserPriv *priv = GET_PRIV (protocol_chooser);
 433   TpConnectionManager *cm = NULL;
 434   gchar *protocol_name = NULL;
 435   gboolean visible = FALSE;
 436   gchar *service;
 437
 438   gtk_tree_model_get (model, iter,
 439       COL_CM, &cm,
 440       COL_PROTOCOL_NAME, &protocol_name,
 441       COL_SERVICE, &service,
 442       -1);
 443
 444   if (cm != NULL && protocol_name != NULL)
 445     {
 446       TpProtocol *protocol;
 447
 448       protocol = tp_connection_manager_get_protocol_object (cm, protocol_name);
 449
 450       if (protocol != NULL)
 451         {
 452           visible = priv->filter_func (cm, protocol, service,
 453               priv->filter_user_data);
 454         }
 455     }
 456
 457   if (cm != NULL)
 458     g_object_unref (cm);
 459
 460   g_free (service);
 461   return visible;
 462 }
 463
 464 /* public methods */
 465
 466 /**
 467  * empathy_protocol_chooser_get_selected_protocol:
 468  * @protocol_chooser: an #EmpathyProtocolChooser
 469  *
 470  * Returns a pointer to the selected #TpConnectionManagerProtocol in
 471  * @protocol_chooser.
 472  *
 473  * Return value: a pointer to the selected #TpConnectionManagerProtocol
 474  */
 475 TpConnectionManager *
 476 empathy_protocol_chooser_dup_selected (
 477     EmpathyProtocolChooser *protocol_chooser,
 478     TpProtocol **protocol,
 479     gchar **service)
 480 {
 481   GtkTreeIter iter;
 482   TpConnectionManager *cm = NULL;
 483   GtkTreeModel *cur_model;
 484
 485   g_return_val_if_fail (EMPATHY_IS_PROTOCOL_CHOOSER (protocol_chooser), NULL);
 486
 487   /* get the current model from the chooser, as we could either be filtering
 488    * or not.
 489    */
 490   cur_model = gtk_combo_box_get_model (GTK_COMBO_BOX (protocol_chooser));
 491
 492   if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (protocol_chooser), &iter))
 493     {
 494       gtk_tree_model_get (GTK_TREE_MODEL (cur_model), &iter,
 495           COL_CM, &cm,
 496           -1);
 497
 498       if (protocol != NULL)
 499         {
 500           gchar *protocol_name = NULL;
 501
 502           gtk_tree_model_get (GTK_TREE_MODEL (cur_model), &iter,
 503               COL_PROTOCOL_NAME, &protocol_name,
 504               -1);
 505
 506           *protocol = tp_connection_manager_get_protocol_object (cm,
 507               protocol_name);
 508
 509           g_free (protocol_name);
 510
 511           if (*protocol == NULL)
 512             {
 513               /* For some reason the CM doesn't know about this protocol
 514                * any more */
 515               g_object_unref (cm);
 516               return NULL;
 517             }
 518         }
 519
 520       if (service != NULL)
 521         {
 522           gtk_tree_model_get (GTK_TREE_MODEL (cur_model), &iter,
 523               COL_SERVICE, service,
 524               -1);
 525         }
 526     }
 527
 528   return cm;
 529 }
 530
 531 /**
 532  * empathy_protocol_chooser_new:
 533  *
 534  * Triggers the creation of a new #EmpathyProtocolChooser.
 535  *
 536  * Return value: a new #EmpathyProtocolChooser widget
 537  */
 538
 539 GtkWidget *
 540 empathy_protocol_chooser_new (void)
 541 {
 542   return GTK_WIDGET (g_object_new (EMPATHY_TYPE_PROTOCOL_CHOOSER, NULL));
 543 }
 544
 545 void
 546 empathy_protocol_chooser_set_visible (EmpathyProtocolChooser *protocol_chooser,
 547     EmpathyProtocolChooserFilterFunc func,
 548     gpointer user_data)
 549 {
 550   EmpathyProtocolChooserPriv *priv;
 551   GtkTreeModel *filter_model;
 552
 553   g_return_if_fail (EMPATHY_IS_PROTOCOL_CHOOSER (protocol_chooser));
 554
 555   priv = GET_PRIV (protocol_chooser);
 556   priv->filter_func = func;
 557   priv->filter_user_data = user_data;
 558
 559   filter_model = gtk_tree_model_filter_new (GTK_TREE_MODEL (priv->store),
 560       NULL);
 561   gtk_combo_box_set_model (GTK_COMBO_BOX (protocol_chooser), filter_model);
 562   g_object_unref (filter_model);
 563
 564   gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER
 565       (filter_model), protocol_chooser_filter_visible_func,
 566       protocol_chooser, NULL);
 567
 568   gtk_tree_model_filter_refilter (GTK_TREE_MODEL_FILTER (filter_model));
 569
 570   gtk_combo_box_set_active (GTK_COMBO_BOX (protocol_chooser), 0);
 571 }
 572
 573 EmpathyAccountSettings *
 574 empathy_protocol_chooser_create_account_settings (EmpathyProtocolChooser *self)
 575 {
 576   EmpathyAccountSettings *settings = NULL;
 577   gchar *str;
 578   const gchar *display_name;
 579   TpConnectionManager *cm;
 580   TpProtocol *proto;
 581   gchar *service = NULL;
 582
 583   cm = empathy_protocol_chooser_dup_selected (self, &proto, &service);
 584   if (cm == NULL || proto == NULL)
 585     goto out;
 586
 587   if (service != NULL)
 588     display_name = empathy_service_name_to_display_name (service);
 589   else
 590     display_name = empathy_protocol_name_to_display_name (
 591         tp_protocol_get_name (proto));
 592
 593   /* Create account */
 594   /* To translator: %s is the name of the protocol, such as "Google Talk" or
 595    * "Yahoo!"
 596    */
 597   str = g_strdup_printf (_("New %s account"), display_name);
 598
 599   settings = empathy_account_settings_new (tp_connection_manager_get_name (cm),
 600       tp_protocol_get_name (proto), service, str);
 601
 602   g_free (str);
 603
 604   if (!tp_strdiff (service, "google-talk"))
 605     {
 606       const gchar *fallback_servers[] = {
 607           "talkx.l.google.com",
 608           "talkx.l.google.com:443,oldssl",
 609           "talkx.l.google.com:80",
 610           NULL};
 611
 612       const gchar *extra_certificate_identities[] = {
 613           "talk.google.com",
 614           NULL};
 615
 616       empathy_account_settings_set_icon_name_async (settings, "im-google-talk",
 617           NULL, NULL);
 618       empathy_account_settings_set (settings, "server",
 619           g_variant_new_string (extra_certificate_identities[0]));
 620       empathy_account_settings_set (settings, "require-encryption",
 621           g_variant_new_boolean (TRUE));
 622       empathy_account_settings_set (settings, "fallback-servers",
 623           g_variant_new_strv (fallback_servers, -1));
 624
 625       if (empathy_account_settings_have_tp_param (settings,
 626               "extra-certificate-identities"))
 627         {
 628           empathy_account_settings_set (settings,
 629               "extra-certificate-identities",
 630               g_variant_new_strv (extra_certificate_identities, -1));
 631         }
 632     }
 633   else if (!tp_strdiff (service, "facebook"))
 634     {
 635       const gchar *fallback_servers[] = {
 636           "chat.facebook.com:443",
 637           NULL };
 638
 639       empathy_account_settings_set_icon_name_async (settings, "im-facebook",
 640           NULL, NULL);
 641       empathy_account_settings_set (settings, "require-encryption",
 642           g_variant_new_boolean (TRUE));
 643       empathy_account_settings_set (settings, "server",
 644           g_variant_new_string ("chat.facebook.com"));
 645       empathy_account_settings_set (settings, "fallback-servers",
 646           g_variant_new_strv (fallback_servers, -1));
 647     }
 648
 649 out:
 650   tp_clear_object (&cm);
 651   g_free (service);
 652   return settings;
 653 }