src/empathy-chat-manager.c

   1 /*
   2  * empathy-chat-manager.c - Source for EmpathyChatManager
   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
  20 #include <telepathy-glib/telepathy-glib.h>
  21 #include <telepathy-glib/proxy-subclass.h>
  22
  23 #include <libempathy/empathy-channel-factory.h>
  24 #include <libempathy/empathy-chatroom-manager.h>
  25 #include <libempathy/empathy-request-util.h>
  26 #include <libempathy/empathy-utils.h>
  27
  28 #include <libempathy-gtk/empathy-ui-utils.h>
  29
  30 #include "empathy-chat-window.h"
  31
  32 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
  33 #include <libempathy/empathy-debug.h>
  34
  35 #include "empathy-chat-manager.h"
  36
  37 #include <extensions/extensions.h>
  38
  39 enum {
  40   CLOSED_CHATS_CHANGED,
  41   DISPLAYED_CHATS_CHANGED,
  42   LAST_SIGNAL
  43 };
  44
  45 static guint signals[LAST_SIGNAL];
  46
  47 static void svc_iface_init (gpointer, gpointer);
  48
  49 G_DEFINE_TYPE_WITH_CODE (EmpathyChatManager, empathy_chat_manager,
  50     G_TYPE_OBJECT,
  51     G_IMPLEMENT_INTERFACE (EMP_TYPE_SVC_CHAT_MANAGER,
  52         svc_iface_init)
  53     )
  54
  55 /* private structure */
  56 typedef struct _EmpathyChatManagerPriv EmpathyChatManagerPriv;
  57
  58 struct _EmpathyChatManagerPriv
  59 {
  60   EmpathyChatroomManager *chatroom_mgr;
  61   /* Queue of (ChatData *) representing the closed chats */
  62   GQueue *closed_queue;
  63
  64   guint num_displayed_chat;
  65
  66   /* account path -> (GHashTable<(owned gchar *) contact ID
  67    *                  -> (owned gchar *) non-NULL message>)
  68    */
  69   GHashTable *messages;
  70
  71   TpBaseClient *handler;
  72 };
  73
  74 #define GET_PRIV(o) \
  75   (G_TYPE_INSTANCE_GET_PRIVATE ((o), EMPATHY_TYPE_CHAT_MANAGER, \
  76     EmpathyChatManagerPriv))
  77
  78 static EmpathyChatManager *chat_manager_singleton = NULL;
  79
  80 typedef struct
  81 {
  82   TpAccount *account;
  83   gchar *id;
  84   gboolean room;
  85 } ChatData;
  86
  87 static ChatData *
  88 chat_data_new (EmpathyChat *chat)
  89 {
  90   ChatData *data = NULL;
  91
  92   data = g_slice_new0 (ChatData);
  93
  94   data->account = g_object_ref (empathy_chat_get_account (chat));
  95   data->id = g_strdup (empathy_chat_get_id (chat));
  96   data->room = empathy_chat_is_room (chat);
  97
  98   return data;
  99 }
 100
 101 static void
 102 chat_data_free (ChatData *data)
 103 {
 104   if (data->account != NULL)
 105     {
 106       g_object_unref (data->account);
 107       data->account = NULL;
 108     }
 109
 110   if (data->id != NULL)
 111     {
 112       g_free (data->id);
 113       data->id = NULL;
 114     }
 115
 116   g_slice_free (ChatData, data);
 117 }
 118
 119 static void
 120 chat_destroyed_cb (gpointer data,
 121     GObject *object)
 122 {
 123   EmpathyChatManager *self = data;
 124   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 125
 126   priv->num_displayed_chat--;
 127
 128   DEBUG ("Chat destroyed; we are now displaying %u chats",
 129       priv->num_displayed_chat);
 130
 131   g_signal_emit (self, signals[DISPLAYED_CHATS_CHANGED], 0,
 132       priv->num_displayed_chat);
 133 }
 134
 135 static void
 136 process_tp_chat (EmpathyChatManager *self,
 137     EmpathyTpChat *tp_chat,
 138     TpAccount *account,
 139     gint64 user_action_time)
 140 {
 141   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 142   EmpathyChat *chat = NULL;
 143   const gchar *id;
 144
 145   id = empathy_tp_chat_get_id (tp_chat);
 146   if (!tp_str_empty (id))
 147     {
 148       chat = empathy_chat_window_find_chat (account, id,
 149           empathy_tp_chat_is_sms_channel (tp_chat));
 150     }
 151
 152   if (chat != NULL)
 153     {
 154       empathy_chat_set_tp_chat (chat, tp_chat);
 155     }
 156   else
 157     {
 158       GHashTable *chats = NULL;
 159
 160       chat = empathy_chat_new (tp_chat);
 161       /* empathy_chat_new returns a floating reference as EmpathyChat is
 162        * a GtkWidget. This reference will be taken by a container
 163        * (a GtkNotebook) when we'll call empathy_chat_window_present_chat */
 164
 165       priv->num_displayed_chat++;
 166
 167       DEBUG ("Chat displayed; we are now displaying %u chat",
 168           priv->num_displayed_chat);
 169
 170       g_signal_emit (self, signals[DISPLAYED_CHATS_CHANGED], 0,
 171           priv->num_displayed_chat);
 172
 173       /* Set the saved message in the channel if we have one. */
 174       chats = g_hash_table_lookup (priv->messages,
 175           tp_proxy_get_object_path (account));
 176
 177       if (chats != NULL)
 178         {
 179           const gchar *msg = g_hash_table_lookup (chats, id);
 180
 181           if (msg != NULL)
 182             empathy_chat_set_text (chat, msg);
 183         }
 184
 185       g_object_weak_ref ((GObject *) chat, chat_destroyed_cb, self);
 186     }
 187   empathy_chat_window_present_chat (chat, user_action_time);
 188
 189   if (empathy_tp_chat_is_invited (tp_chat, NULL))
 190     {
 191       /* We have been invited to the room. Add ourself as member as this
 192        * channel has been approved. */
 193       empathy_tp_chat_join (tp_chat);
 194     }
 195
 196   g_object_unref (tp_chat);
 197 }
 198
 199 typedef struct
 200 {
 201   EmpathyChatManager *self;
 202   EmpathyTpChat *tp_chat;
 203   TpAccount *account;
 204   gint64 user_action_time;
 205   gulong sig_id;
 206 } chat_ready_ctx;
 207
 208 static chat_ready_ctx *
 209 chat_ready_ctx_new (EmpathyChatManager *self,
 210     EmpathyTpChat *tp_chat,
 211     TpAccount *account,
 212     gint64 user_action_time)
 213 {
 214   chat_ready_ctx *ctx = g_slice_new0 (chat_ready_ctx);
 215
 216   ctx->self = g_object_ref (self);
 217   ctx->tp_chat = g_object_ref (tp_chat);
 218   ctx->account = g_object_ref (account);
 219   ctx->user_action_time = user_action_time;
 220   return ctx;
 221 }
 222
 223 static void
 224 chat_ready_ctx_free (chat_ready_ctx *ctx)
 225 {
 226   g_object_unref (ctx->self);
 227   g_object_unref (ctx->tp_chat);
 228   g_object_unref (ctx->account);
 229
 230   if (ctx->sig_id != 0)
 231     g_signal_handler_disconnect (ctx->tp_chat, ctx->sig_id);
 232
 233   g_slice_free (chat_ready_ctx, ctx);
 234 }
 235
 236 static void
 237 tp_chat_ready_cb (GObject *object,
 238   GParamSpec *spec,
 239   gpointer user_data)
 240 {
 241   EmpathyTpChat *tp_chat = EMPATHY_TP_CHAT (object);
 242   chat_ready_ctx *ctx = user_data;
 243
 244   if (!empathy_tp_chat_is_ready (tp_chat))
 245     return;
 246
 247   process_tp_chat (ctx->self, tp_chat, ctx->account, ctx->user_action_time);
 248
 249   chat_ready_ctx_free (ctx);
 250 }
 251
 252 static void
 253 handle_channels (TpSimpleHandler *handler,
 254     TpAccount *account,
 255     TpConnection *connection,
 256     GList *channels,
 257     GList *requests_satisfied,
 258     gint64 user_action_time,
 259     TpHandleChannelsContext *context,
 260     gpointer user_data)
 261 {
 262   EmpathyChatManager *self = (EmpathyChatManager *) user_data;
 263   GList *l;
 264
 265   for (l = channels; l != NULL; l = g_list_next (l))
 266     {
 267       TpChannel *channel = l->data;
 268       EmpathyTpChat *tp_chat;
 269
 270       if (tp_proxy_get_invalidated (channel) != NULL)
 271         continue;
 272
 273       if (!TP_IS_TEXT_CHANNEL (channel))
 274         {
 275           DEBUG ("Channel %s doesn't implement Messages; can't handle it",
 276               tp_proxy_get_object_path (channel));
 277           continue;
 278         }
 279
 280       DEBUG ("Now handling channel %s", tp_proxy_get_object_path (channel));
 281
 282       tp_chat = empathy_tp_chat_new (account, channel);
 283
 284       if (empathy_tp_chat_is_ready (tp_chat))
 285         {
 286           process_tp_chat (self, tp_chat, account, user_action_time);
 287         }
 288       else
 289         {
 290           chat_ready_ctx *ctx = chat_ready_ctx_new (self, tp_chat, account,
 291               user_action_time);
 292
 293           ctx->sig_id = g_signal_connect (tp_chat, "notify::ready",
 294               G_CALLBACK (tp_chat_ready_cb), ctx);
 295         }
 296     }
 297
 298   tp_handle_channels_context_accept (context);
 299 }
 300
 301 static void
 302 empathy_chat_manager_init (EmpathyChatManager *self)
 303 {
 304   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 305   TpDBusDaemon *dbus;
 306   GError *error = NULL;
 307   EmpathyChannelFactory *factory;
 308
 309   priv->closed_queue = g_queue_new ();
 310   priv->messages = g_hash_table_new_full (g_str_hash, g_str_equal,
 311       g_free, (GDestroyNotify) g_hash_table_unref);
 312
 313   dbus = tp_dbus_daemon_dup (&error);
 314   if (dbus == NULL)
 315     {
 316       g_critical ("Failed to get D-Bus daemon: %s", error->message);
 317       g_error_free (error);
 318       return;
 319     }
 320
 321   priv->chatroom_mgr = empathy_chatroom_manager_dup_singleton (NULL);
 322
 323   /* Text channels handler */
 324   priv->handler = tp_simple_handler_new (dbus, FALSE, FALSE,
 325       EMPATHY_CHAT_BUS_NAME_SUFFIX, FALSE, handle_channels, self, NULL);
 326
 327   /* EmpathyTpChat relies on these features being prepared */
 328   tp_base_client_add_connection_features_varargs (priv->handler,
 329     TP_CONNECTION_FEATURE_CAPABILITIES, 0);
 330   tp_base_client_add_channel_features_varargs (priv->handler,
 331       TP_CHANNEL_FEATURE_CHAT_STATES, 0);
 332
 333   g_object_unref (dbus);
 334
 335   tp_base_client_take_handler_filter (priv->handler, tp_asv_new (
 336         TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING, TP_IFACE_CHANNEL_TYPE_TEXT,
 337         TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_CONTACT,
 338         NULL));
 339
 340   tp_base_client_take_handler_filter (priv->handler, tp_asv_new (
 341         TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING, TP_IFACE_CHANNEL_TYPE_TEXT,
 342         TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_ROOM,
 343         NULL));
 344
 345   tp_base_client_take_handler_filter (priv->handler, tp_asv_new (
 346         TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING, TP_IFACE_CHANNEL_TYPE_TEXT,
 347         TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_NONE,
 348         NULL));
 349
 350   factory = empathy_channel_factory_dup ();
 351
 352   tp_base_client_set_channel_factory (priv->handler,
 353       TP_CLIENT_CHANNEL_FACTORY (factory));
 354
 355   if (!tp_base_client_register (priv->handler, &error))
 356     {
 357       g_critical ("Failed to register text handler: %s", error->message);
 358       g_error_free (error);
 359     }
 360
 361   g_object_unref (factory);
 362 }
 363
 364 static void
 365 empathy_chat_manager_finalize (GObject *object)
 366 {
 367   EmpathyChatManager *self = EMPATHY_CHAT_MANAGER (object);
 368   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 369
 370   if (priv->closed_queue != NULL)
 371     {
 372       g_queue_foreach (priv->closed_queue, (GFunc) chat_data_free, NULL);
 373       g_queue_free (priv->closed_queue);
 374       priv->closed_queue = NULL;
 375     }
 376
 377   tp_clear_pointer (&priv->messages, g_hash_table_unref);
 378
 379   tp_clear_object (&priv->handler);
 380   tp_clear_object (&priv->chatroom_mgr);
 381
 382   G_OBJECT_CLASS (empathy_chat_manager_parent_class)->finalize (object);
 383 }
 384
 385 static GObject *
 386 empathy_chat_manager_constructor (GType type,
 387     guint n_construct_params,
 388     GObjectConstructParam *construct_params)
 389 {
 390   GObject *retval;
 391
 392   if (!chat_manager_singleton)
 393     {
 394       retval = G_OBJECT_CLASS (empathy_chat_manager_parent_class)->constructor
 395         (type, n_construct_params, construct_params);
 396
 397       chat_manager_singleton = EMPATHY_CHAT_MANAGER (retval);
 398       g_object_add_weak_pointer (retval, (gpointer) &chat_manager_singleton);
 399     }
 400   else
 401     {
 402       retval = g_object_ref (chat_manager_singleton);
 403     }
 404
 405   return retval;
 406 }
 407
 408 static void
 409 empathy_chat_manager_constructed (GObject *obj)
 410 {
 411   TpDBusDaemon *dbus_daemon;
 412
 413   dbus_daemon = tp_dbus_daemon_dup (NULL);
 414
 415   if (dbus_daemon != NULL)
 416     {
 417       tp_dbus_daemon_register_object (dbus_daemon,
 418           "/org/gnome/Empathy/ChatManager", obj);
 419
 420       g_object_unref (dbus_daemon);
 421     }
 422 }
 423
 424 static void
 425 empathy_chat_manager_class_init (
 426   EmpathyChatManagerClass *empathy_chat_manager_class)
 427 {
 428   GObjectClass *object_class = G_OBJECT_CLASS (empathy_chat_manager_class);
 429
 430   object_class->finalize = empathy_chat_manager_finalize;
 431   object_class->constructor = empathy_chat_manager_constructor;
 432   object_class->constructed = empathy_chat_manager_constructed;
 433
 434   signals[CLOSED_CHATS_CHANGED] =
 435     g_signal_new ("closed-chats-changed",
 436         G_TYPE_FROM_CLASS (object_class),
 437         G_SIGNAL_RUN_LAST,
 438         0,
 439         NULL, NULL,
 440         g_cclosure_marshal_VOID__UINT,
 441         G_TYPE_NONE,
 442         1, G_TYPE_UINT, NULL);
 443
 444   signals[DISPLAYED_CHATS_CHANGED] =
 445     g_signal_new ("displayed-chats-changed",
 446         G_TYPE_FROM_CLASS (object_class),
 447         G_SIGNAL_RUN_LAST,
 448         0,
 449         NULL, NULL,
 450         g_cclosure_marshal_VOID__UINT,
 451         G_TYPE_NONE,
 452         1, G_TYPE_UINT, NULL);
 453
 454   g_type_class_add_private (empathy_chat_manager_class,
 455     sizeof (EmpathyChatManagerPriv));
 456 }
 457
 458 EmpathyChatManager *
 459 empathy_chat_manager_dup_singleton (void)
 460 {
 461   return g_object_new (EMPATHY_TYPE_CHAT_MANAGER, NULL);
 462 }
 463
 464 void
 465 empathy_chat_manager_closed_chat (EmpathyChatManager *self,
 466     EmpathyChat *chat)
 467 {
 468   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 469   ChatData *data;
 470   GHashTable *chats;
 471   gchar *message;
 472
 473   data = chat_data_new (chat);
 474
 475   DEBUG ("Adding %s to closed queue: %s",
 476       data->room ? "room" : "contact", data->id);
 477
 478   g_queue_push_tail (priv->closed_queue, data);
 479
 480   g_signal_emit (self, signals[CLOSED_CHATS_CHANGED], 0,
 481       g_queue_get_length (priv->closed_queue));
 482
 483   /* If there was a message saved from last time it was closed
 484    * (perhaps by accident?) save it to our hash table so it can be
 485    * used again when the same chat pops up. Hot. */
 486   message = empathy_chat_dup_text (chat);
 487
 488   chats = g_hash_table_lookup (priv->messages,
 489       tp_proxy_get_object_path (data->account));
 490
 491   /* Don't create a new hash table if we don't already have one and we
 492    * don't actually have a message to save. */
 493   if (chats == NULL && tp_str_empty (message))
 494     {
 495       g_free (message);
 496       return;
 497     }
 498   else if (chats == NULL && !tp_str_empty (message))
 499     {
 500       chats = g_hash_table_new_full (g_str_hash, g_str_equal,
 501           g_free, g_free);
 502
 503       g_hash_table_insert (priv->messages,
 504           g_strdup (tp_proxy_get_object_path (data->account)),
 505           chats);
 506     }
 507
 508   if (tp_str_empty (message))
 509     {
 510       g_hash_table_remove (chats, data->id);
 511       /* might be '\0' */
 512       g_free (message);
 513     }
 514   else
 515     {
 516       /* takes ownership of message */
 517       g_hash_table_insert (chats, g_strdup (data->id), message);
 518     }
 519 }
 520
 521 void
 522 empathy_chat_manager_undo_closed_chat (EmpathyChatManager *self,
 523     gint64 timestamp)
 524 {
 525   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 526   ChatData *data;
 527
 528   data = g_queue_pop_tail (priv->closed_queue);
 529
 530   if (data == NULL)
 531     return;
 532
 533   DEBUG ("Removing %s from closed queue and starting a chat with: %s",
 534       data->room ? "room" : "contact", data->id);
 535
 536   if (data->room)
 537     empathy_join_muc (data->account, data->id, timestamp);
 538   else
 539     empathy_chat_with_contact_id (data->account, data->id, timestamp);
 540
 541   g_signal_emit (self, signals[CLOSED_CHATS_CHANGED], 0,
 542       g_queue_get_length (priv->closed_queue));
 543
 544   chat_data_free (data);
 545 }
 546
 547 guint
 548 empathy_chat_manager_get_num_closed_chats (EmpathyChatManager *self)
 549 {
 550   EmpathyChatManagerPriv *priv = GET_PRIV (self);
 551
 552   return g_queue_get_length (priv->closed_queue);
 553 }
 554
 555 static void
 556 empathy_chat_manager_dbus_undo_closed_chat (EmpSvcChatManager *manager,
 557     gint64 timestamp,
 558     DBusGMethodInvocation *context)
 559 {
 560   empathy_chat_manager_undo_closed_chat ((EmpathyChatManager *) manager,
 561       timestamp);
 562
 563   emp_svc_chat_manager_return_from_undo_closed_chat (context);
 564 }
 565
 566 static void
 567 svc_iface_init (gpointer g_iface,
 568     gpointer iface_data)
 569 {
 570   EmpSvcChatManagerClass *klass = (EmpSvcChatManagerClass *) g_iface;
 571
 572 #define IMPLEMENT(x) emp_svc_chat_manager_implement_##x (\
 573     klass, empathy_chat_manager_dbus_##x)
 574   IMPLEMENT(undo_closed_chat);
 575 #undef IMPLEMENT
 576 }
 577
 578 void
 579 empathy_chat_manager_call_undo_closed_chat (void)
 580 {
 581   TpDBusDaemon *dbus_daemon = tp_dbus_daemon_dup (NULL);
 582   TpProxy *proxy;
 583
 584   if (dbus_daemon == NULL)
 585     return;
 586
 587   proxy = g_object_new (TP_TYPE_PROXY,
 588       "dbus-daemon", dbus_daemon,
 589       "dbus-connection", tp_proxy_get_dbus_connection (TP_PROXY (dbus_daemon)),
 590       "bus-name", EMPATHY_CHAT_BUS_NAME,
 591       "object-path", "/org/gnome/Empathy/ChatManager",
 592       NULL);
 593
 594   tp_proxy_add_interface_by_id (proxy, EMP_IFACE_QUARK_CHAT_MANAGER);
 595
 596   emp_cli_chat_manager_call_undo_closed_chat (proxy, -1, empathy_get_current_action_time (),
 597       NULL, NULL, NULL, NULL);
 598
 599   g_object_unref (proxy);
 600   g_object_unref (dbus_daemon);
 601 }