libempathy-gtk/empathy-contact-chooser.c

   1 /*
   2  * empathy-contact-chooser.c
   3  *
   4  * EmpathyContactChooser
   5  *
   6  * (c) 2009, Collabora Ltd.
   7  *
   8  * Authors:
   9  *    Danielle Madeley <danielle.madeley@collabora.co.uk>
  10  */
  11
  12 #include <glib/gi18n.h>
  13 #include <folks/folks-telepathy.h>
  14
  15 #include "empathy-contact-chooser.h"
  16
  17 #include <libempathy/empathy-utils.h>
  18
  19 #include <libempathy-gtk/empathy-individual-store-manager.h>
  20 #include <libempathy-gtk/empathy-individual-view.h>
  21 #include <libempathy-gtk/empathy-ui-utils.h>
  22
  23 G_DEFINE_TYPE (EmpathyContactChooser,
  24     empathy_contact_chooser, GTK_TYPE_BOX);
  25
  26 enum {
  27   SIG_SELECTION_CHANGED,
  28   SIG_ACTIVATE,
  29   LAST_SIGNAL
  30 };
  31
  32 static guint signals[LAST_SIGNAL];
  33
  34 typedef struct _AddTemporaryIndividualCtx AddTemporaryIndividualCtx;
  35
  36 struct _EmpathyContactChooserPrivate
  37 {
  38   TpAccountManager *account_mgr;
  39
  40   EmpathyIndividualStore *store;
  41   EmpathyIndividualView *view;
  42   GtkWidget *search_entry;
  43   GtkWidget *scroll_view;
  44
  45   GPtrArray *search_words;
  46   gchar *search_str;
  47
  48   /* Context representing the FolksIndividual which are added because of the
  49    * current search from the user. */
  50   AddTemporaryIndividualCtx *add_temp_ctx;
  51
  52   EmpathyContactChooserFilterFunc filter_func;
  53   gpointer filter_data;
  54 };
  55
  56 struct _AddTemporaryIndividualCtx
  57 {
  58   EmpathyContactChooser *self;
  59   /* List of owned FolksIndividual */
  60   GList *individuals;
  61 };
  62
  63 static AddTemporaryIndividualCtx *
  64 add_temporary_individual_ctx_new (EmpathyContactChooser *self)
  65 {
  66   AddTemporaryIndividualCtx *ctx = g_slice_new0 (AddTemporaryIndividualCtx);
  67
  68   ctx->self = self;
  69   return ctx;
  70 }
  71
  72 static void
  73 add_temporary_individual_ctx_free (AddTemporaryIndividualCtx *ctx)
  74 {
  75   GList *l;
  76
  77   /* Remove all the individuals from the model */
  78   for (l = ctx->individuals; l != NULL; l = g_list_next (l))
  79     {
  80       FolksIndividual *individual = l->data;
  81
  82       individual_store_remove_individual_and_disconnect (ctx->self->priv->store,
  83           individual);
  84
  85       g_object_unref (individual);
  86     }
  87
  88   g_list_free (ctx->individuals);
  89   g_slice_free (AddTemporaryIndividualCtx, ctx);
  90 }
  91
  92 static void
  93 contact_chooser_dispose (GObject *object)
  94 {
  95   EmpathyContactChooser *self = (EmpathyContactChooser *)
  96     object;
  97
  98   tp_clear_pointer (&self->priv->add_temp_ctx,
  99       add_temporary_individual_ctx_free);
 100
 101   tp_clear_object (&self->priv->store);
 102   tp_clear_pointer (&self->priv->search_words, g_ptr_array_unref);
 103   tp_clear_pointer (&self->priv->search_str, g_free);
 104
 105   tp_clear_object (&self->priv->account_mgr);
 106
 107   G_OBJECT_CLASS (empathy_contact_chooser_parent_class)->dispose (
 108       object);
 109 }
 110
 111 static void
 112 empathy_contact_chooser_class_init (
 113     EmpathyContactChooserClass *klass)
 114 {
 115   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 116
 117   object_class->dispose = contact_chooser_dispose;
 118
 119   g_type_class_add_private (object_class,
 120       sizeof (EmpathyContactChooserPrivate));
 121
 122   signals[SIG_SELECTION_CHANGED] = g_signal_new ("selection-changed",
 123             G_TYPE_FROM_CLASS (klass),
 124             G_SIGNAL_RUN_LAST,
 125             0,
 126             NULL, NULL,
 127             g_cclosure_marshal_generic,
 128             G_TYPE_NONE,
 129             1, FOLKS_TYPE_INDIVIDUAL);
 130
 131   signals[SIG_ACTIVATE] = g_signal_new ("activate",
 132             G_TYPE_FROM_CLASS (klass),
 133             G_SIGNAL_RUN_LAST,
 134             0,
 135             NULL, NULL,
 136             g_cclosure_marshal_generic,
 137             G_TYPE_NONE,
 138             0);
 139 }
 140
 141 static void
 142 view_selection_changed_cb (GtkWidget *treeview,
 143     EmpathyContactChooser *self)
 144 {
 145   FolksIndividual *individual;
 146
 147   individual = empathy_individual_view_dup_selected (self->priv->view);
 148
 149   g_signal_emit (self, signals[SIG_SELECTION_CHANGED], 0, individual);
 150
 151   tp_clear_object (&individual);
 152 }
 153
 154 static gboolean
 155 filter_func (GtkTreeModel *model,
 156     GtkTreeIter *iter,
 157     gpointer user_data)
 158 {
 159   EmpathyContactChooser *self = user_data;
 160   FolksIndividual *individual;
 161   gboolean is_online;
 162   gboolean display = FALSE;
 163   gboolean searching = FALSE;
 164
 165   gtk_tree_model_get (model, iter,
 166       EMPATHY_INDIVIDUAL_STORE_COL_INDIVIDUAL, &individual,
 167       EMPATHY_INDIVIDUAL_STORE_COL_IS_ONLINE, &is_online,
 168       -1);
 169
 170   if (individual == NULL)
 171     goto out;
 172
 173   if (self->priv->search_words != NULL)
 174     {
 175       searching = TRUE;
 176
 177       /* Filter out the contact if we are searching and it doesn't match */
 178       if (!empathy_individual_match_string (individual,
 179             self->priv->search_str, self->priv->search_words))
 180         goto out;
 181     }
 182
 183   if (self->priv->filter_func == NULL)
 184     display = TRUE;
 185   else
 186     display = self->priv->filter_func (self, individual, is_online, searching,
 187       self->priv->filter_data);
 188 out:
 189   tp_clear_object (&individual);
 190   return display;
 191 }
 192
 193 static void
 194 contact_capabilities_changed (TpContact *contact,
 195     GParamSpec *pspec,
 196     EmpathyContactChooser *self)
 197 {
 198   empathy_individual_view_refilter (self->priv->view);
 199 }
 200
 201 static void
 202 get_contacts_cb (TpConnection *connection,
 203     guint n_contacts,
 204     TpContact * const *contacts,
 205     const gchar * const *requested_ids,
 206     GHashTable *failed_id_errors,
 207     const GError *error,
 208     gpointer user_data,
 209     GObject *weak_object)
 210 {
 211   EmpathyContactChooser *self =
 212     (EmpathyContactChooser *) weak_object;
 213   AddTemporaryIndividualCtx *ctx = user_data;
 214   FolksIndividual *individual;
 215
 216   if (self->priv->add_temp_ctx != ctx)
 217     /* another request has been started */
 218     return;
 219
 220   if (n_contacts != 1)
 221     return;
 222
 223   individual =  empathy_create_individual_from_tp_contact (contacts[0]);
 224   if (individual == NULL)
 225     return;
 226
 227   /* listen for updates to the capabilities */
 228   tp_g_signal_connect_object (contacts[0], "notify::capabilities",
 229       G_CALLBACK (contact_capabilities_changed), self, 0);
 230
 231   /* Pass ownership to the list */
 232   ctx->individuals = g_list_prepend (ctx->individuals, individual);
 233
 234   individual_store_add_individual_and_connect (self->priv->store, individual);
 235
 236   /* if nothing is selected, select the first matching node */
 237   if (!gtk_tree_selection_get_selected (
 238         gtk_tree_view_get_selection (GTK_TREE_VIEW (self->priv->view)),
 239         NULL, NULL))
 240     empathy_individual_view_select_first (self->priv->view);
 241 }
 242
 243 static void
 244 add_temporary_individuals (EmpathyContactChooser *self,
 245     const gchar *id)
 246 {
 247   GList *accounts, *l;
 248
 249   tp_clear_pointer (&self->priv->add_temp_ctx,
 250       add_temporary_individual_ctx_free);
 251
 252   if (tp_str_empty (id))
 253     return;
 254
 255   self->priv->add_temp_ctx = add_temporary_individual_ctx_new (self);
 256
 257   /* Try to add an individual for each connected account */
 258   accounts = tp_account_manager_get_valid_accounts (self->priv->account_mgr);
 259   for (l = accounts; l != NULL; l = g_list_next (l))
 260     {
 261       TpAccount *account = l->data;
 262       TpConnection *conn;
 263       TpContactFeature features[] = { TP_CONTACT_FEATURE_ALIAS,
 264           TP_CONTACT_FEATURE_AVATAR_DATA,
 265           TP_CONTACT_FEATURE_PRESENCE,
 266           TP_CONTACT_FEATURE_CAPABILITIES };
 267
 268       conn = tp_account_get_connection (account);
 269       if (conn == NULL)
 270         continue;
 271
 272       tp_connection_get_contacts_by_id (conn, 1, &id, G_N_ELEMENTS (features),
 273           features, get_contacts_cb, self->priv->add_temp_ctx, NULL,
 274           G_OBJECT (self));
 275     }
 276
 277   g_list_free (accounts);
 278 }
 279
 280 static void
 281 search_text_changed (GtkEntry *entry,
 282     EmpathyContactChooser *self)
 283 {
 284   const gchar *id;
 285
 286   tp_clear_pointer (&self->priv->search_words, g_ptr_array_unref);
 287   tp_clear_pointer (&self->priv->search_str, g_free);
 288
 289   id = gtk_entry_get_text (entry);
 290
 291   self->priv->search_words = empathy_live_search_strip_utf8_string (id);
 292   self->priv->search_str = g_strdup (id);
 293
 294   add_temporary_individuals (self, id);
 295
 296   empathy_individual_view_refilter (self->priv->view);
 297 }
 298
 299 static void
 300 search_activate_cb (GtkEntry *entry,
 301     EmpathyContactChooser *self)
 302 {
 303   g_signal_emit (self, signals[SIG_ACTIVATE], 0);
 304 }
 305
 306 static void
 307 view_activate_cb (GtkTreeView *view,
 308     GtkTreePath *path,
 309     GtkTreeViewColumn *column,
 310     EmpathyContactChooser *self)
 311 {
 312   g_signal_emit (self, signals[SIG_ACTIVATE], 0);
 313 }
 314
 315 static gboolean
 316 search_key_press_cb (GtkEntry *entry,
 317     GdkEventKey *event,
 318     EmpathyContactChooser *self)
 319 {
 320   GtkTreeSelection *selection;
 321   GtkTreeModel *model;
 322   GtkTreeIter iter;
 323
 324   if (event->state != 0)
 325     return FALSE;
 326
 327   switch (event->keyval)
 328     {
 329       case GDK_KEY_Down:
 330       case GDK_KEY_KP_Down:
 331       case GDK_KEY_Up:
 332       case GDK_KEY_KP_Up:
 333         break;
 334
 335       default:
 336         return FALSE;
 337     }
 338
 339   selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (self->priv->view));
 340
 341   if (!gtk_tree_selection_get_selected (selection, &model, &iter))
 342     return TRUE;
 343
 344   switch (event->keyval)
 345     {
 346       case GDK_KEY_Down:
 347       case GDK_KEY_KP_Down:
 348         if (!gtk_tree_model_iter_next (model, &iter))
 349           return TRUE;
 350
 351         break;
 352
 353       case GDK_KEY_Up:
 354       case GDK_KEY_KP_Up:
 355         if (!gtk_tree_model_iter_previous (model, &iter))
 356           return TRUE;
 357
 358         break;
 359
 360       default:
 361         g_assert_not_reached ();
 362     }
 363
 364   gtk_tree_selection_select_iter (selection, &iter);
 365
 366   return TRUE;
 367 }
 368
 369 static void
 370 empathy_contact_chooser_init (EmpathyContactChooser *self)
 371 {
 372   EmpathyIndividualManager *mgr;
 373   GtkTreeSelection *selection;
 374   GQuark features[] = { TP_ACCOUNT_MANAGER_FEATURE_CORE, 0 };
 375
 376   self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, EMPATHY_TYPE_CONTACT_CHOOSER,
 377       EmpathyContactChooserPrivate);
 378
 379   self->priv->account_mgr = tp_account_manager_dup ();
 380
 381   /* We don't wait for the CORE feature to be prepared, which is fine as we
 382    * won't use the account manager until user starts searching. Furthermore,
 383    * the AM has probably already been prepared by another Empathy
 384    * component. */
 385   tp_proxy_prepare_async (self->priv->account_mgr, features, NULL, NULL);
 386
 387   /* Search entry */
 388   self->priv->search_entry = gtk_entry_new ();
 389   gtk_box_pack_start (GTK_BOX (self), self->priv->search_entry, FALSE, TRUE, 6);
 390   gtk_widget_show (self->priv->search_entry);
 391
 392   g_signal_connect (self->priv->search_entry, "changed",
 393       G_CALLBACK (search_text_changed), self);
 394   g_signal_connect (self->priv->search_entry, "activate",
 395       G_CALLBACK (search_activate_cb), self);
 396   g_signal_connect (self->priv->search_entry, "key-press-event",
 397       G_CALLBACK (search_key_press_cb), self);
 398
 399   /* Add the treeview */
 400   mgr = empathy_individual_manager_dup_singleton ();
 401   self->priv->store = EMPATHY_INDIVIDUAL_STORE (
 402       empathy_individual_store_manager_new (mgr));
 403   g_object_unref (mgr);
 404
 405   empathy_individual_store_set_show_groups (self->priv->store, FALSE);
 406
 407   self->priv->view = empathy_individual_view_new (self->priv->store,
 408       EMPATHY_INDIVIDUAL_VIEW_FEATURE_NONE, EMPATHY_INDIVIDUAL_FEATURE_NONE);
 409
 410   empathy_individual_view_set_custom_filter (self->priv->view,
 411       filter_func, self);
 412
 413   selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (self->priv->view));
 414
 415   g_signal_connect (selection, "changed",
 416       G_CALLBACK (view_selection_changed_cb), self);
 417   g_signal_connect (self->priv->view, "row-activated",
 418       G_CALLBACK (view_activate_cb), self);
 419
 420   self->priv->scroll_view = gtk_scrolled_window_new (NULL, NULL);
 421
 422   gtk_container_add (GTK_CONTAINER (self->priv->scroll_view),
 423       GTK_WIDGET (self->priv->view));
 424
 425   gtk_box_pack_start (GTK_BOX (self), self->priv->scroll_view, TRUE, TRUE, 6);
 426   gtk_widget_show (GTK_WIDGET (self->priv->view));
 427   gtk_widget_show (self->priv->scroll_view);
 428 }
 429
 430 GtkWidget *
 431 empathy_contact_chooser_new (void)
 432 {
 433   return g_object_new (EMPATHY_TYPE_CONTACT_CHOOSER,
 434       "orientation", GTK_ORIENTATION_VERTICAL,
 435       NULL);
 436 }
 437
 438 FolksIndividual *
 439 empathy_contact_chooser_dup_selected (EmpathyContactChooser *self)
 440 {
 441   return empathy_individual_view_dup_selected (self->priv->view);
 442 }
 443
 444 void
 445 empathy_contact_chooser_set_filter_func (EmpathyContactChooser *self,
 446     EmpathyContactChooserFilterFunc func,
 447     gpointer user_data)
 448 {
 449   g_assert (self->priv->filter_func == NULL);
 450
 451   self->priv->filter_func = func;
 452   self->priv->filter_data = user_data;
 453 }
 454
 455 void
 456 empathy_contact_chooser_show_search_entry (EmpathyContactChooser *self,
 457     gboolean show)
 458 {
 459   gtk_widget_set_visible (self->priv->search_entry, show);
 460 }
 461
 462 void
 463 empathy_contact_chooser_show_tree_view (EmpathyContactChooser *self,
 464     gboolean show)
 465 {
 466   gtk_widget_set_visible (GTK_WIDGET (self->priv->scroll_view), show);
 467 }