2 * Copyright (C) 2004-2007 Imendio AB
3 * Copyright (C) 2007-2009 Collabora Ltd.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * This program 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 * General Public License for more details.
15 * You should have received a copy of the GNU General Public
16 * License along with this program; if not, write to the
17 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301 USA
20 * Authors: Xavier Claessens <xclaesse@gmail.com>
21 * Martyn Russell <martyn@imendio.com>
27 #include <sys/types.h>
30 #include <libxml/parser.h>
31 #include <libxml/tree.h>
33 #include <telepathy-glib/interfaces.h>
35 #include "empathy-tp-chat.h"
36 #include "empathy-chatroom-manager.h"
37 #include "empathy-account-manager.h"
38 #include "empathy-utils.h"
40 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
41 #include "empathy-debug.h"
43 #define CHATROOMS_XML_FILENAME "chatrooms.xml"
44 #define CHATROOMS_DTD_FILENAME "empathy-chatroom-manager.dtd"
47 static EmpathyChatroomManager *chatroom_manager_singleton = NULL;
49 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyChatroomManager)
54 EmpathyAccountManager *account_manager;
55 gulong account_manager_ready_handler_id;
56 /* source id of the autosave timer */
59 } EmpathyChatroomManagerPriv;
67 static guint signals[LAST_SIGNAL];
77 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
80 * API to save/load and parse the chatrooms file.
84 chatroom_manager_file_save (EmpathyChatroomManager *manager)
86 EmpathyChatroomManagerPriv *priv;
91 priv = GET_PRIV (manager);
93 doc = xmlNewDoc ((const xmlChar *) "1.0");
94 root = xmlNewNode (NULL, (const xmlChar *) "chatrooms");
95 xmlDocSetRootElement (doc, root);
97 for (l = priv->chatrooms; l; l = l->next) {
98 EmpathyChatroom *chatroom;
100 const gchar *account_id;
104 if (!empathy_chatroom_is_favorite (chatroom)) {
108 account_id = empathy_account_get_unique_name (
109 empathy_chatroom_get_account (chatroom));
111 node = xmlNewChild (root, NULL, (const xmlChar *) "chatroom", NULL);
112 xmlNewTextChild (node, NULL, (const xmlChar *) "name",
113 (const xmlChar *) empathy_chatroom_get_name (chatroom));
114 xmlNewTextChild (node, NULL, (const xmlChar *) "room",
115 (const xmlChar *) empathy_chatroom_get_name (chatroom));
116 xmlNewTextChild (node, NULL, (const xmlChar *) "account",
117 (const xmlChar *) account_id);
118 xmlNewTextChild (node, NULL, (const xmlChar *) "auto_connect",
119 empathy_chatroom_get_auto_connect (chatroom) ?
120 (const xmlChar *) "yes" : (const xmlChar *) "no");
123 /* Make sure the XML is indented properly */
124 xmlIndentTreeOutput = 1;
126 DEBUG ("Saving file:'%s'", priv->file);
127 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
137 save_timeout (EmpathyChatroomManager *self)
139 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
141 priv->save_timer_id = 0;
142 chatroom_manager_file_save (self);
148 reset_save_timeout (EmpathyChatroomManager *self)
150 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
152 if (priv->save_timer_id > 0)
154 g_source_remove (priv->save_timer_id);
157 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
158 (GSourceFunc) save_timeout, self);
162 chatroom_changed_cb (EmpathyChatroom *chatroom,
164 EmpathyChatroomManager *self)
166 reset_save_timeout (self);
170 add_chatroom (EmpathyChatroomManager *self,
171 EmpathyChatroom *chatroom)
173 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
175 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
177 g_signal_connect (chatroom, "notify",
178 G_CALLBACK (chatroom_changed_cb), self);
182 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
185 EmpathyChatroomManagerPriv *priv;
186 EmpathyChatroom *chatroom;
187 EmpathyAccount *account;
193 gboolean auto_connect;
195 priv = GET_PRIV (manager);
197 /* default values. */
203 for (child = node->children; child; child = child->next) {
206 if (xmlNodeIsText (child)) {
210 tag = (gchar *) child->name;
211 str = (gchar *) xmlNodeGetContent (child);
213 if (strcmp (tag, "name") == 0) {
214 name = g_strdup (str);
216 else if (strcmp (tag, "room") == 0) {
217 room = g_strdup (str);
219 else if (strcmp (tag, "auto_connect") == 0) {
220 if (strcmp (str, "yes") == 0) {
223 auto_connect = FALSE;
226 else if (strcmp (tag, "account") == 0) {
227 account_id = g_strdup (str);
233 account = empathy_account_manager_get_account (priv->account_manager,
242 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
243 empathy_chatroom_set_favorite (chatroom, TRUE);
244 add_chatroom (manager, chatroom);
245 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
253 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
254 const gchar *filename)
256 EmpathyChatroomManagerPriv *priv;
257 xmlParserCtxtPtr ctxt;
259 xmlNodePtr chatrooms;
262 priv = GET_PRIV (manager);
264 DEBUG ("Attempting to parse file:'%s'...", filename);
266 ctxt = xmlNewParserCtxt ();
268 /* Parse and validate the file. */
269 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
271 g_warning ("Failed to parse file:'%s'", filename);
272 xmlFreeParserCtxt (ctxt);
276 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
277 g_warning ("Failed to validate file:'%s'", filename);
279 xmlFreeParserCtxt (ctxt);
283 /* The root node, chatrooms. */
284 chatrooms = xmlDocGetRootElement (doc);
286 for (node = chatrooms->children; node; node = node->next) {
287 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
288 chatroom_manager_parse_chatroom (manager, node);
292 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
295 xmlFreeParserCtxt (ctxt);
301 chatroom_manager_get_all (EmpathyChatroomManager *manager)
303 EmpathyChatroomManagerPriv *priv;
305 priv = GET_PRIV (manager);
308 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
309 !chatroom_manager_file_parse (manager, priv->file)) {
314 g_object_notify (G_OBJECT (manager), "ready");
320 empathy_chatroom_manager_get_property (GObject *object,
325 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
326 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
331 g_value_set_string (value, priv->file);
334 g_value_set_boolean (value, priv->ready);
337 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
343 empathy_chatroom_manager_set_property (GObject *object,
348 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
349 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
355 priv->file = g_value_dup_string (value);
358 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
364 chatroom_manager_finalize (GObject *object)
366 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
367 EmpathyChatroomManagerPriv *priv;
370 priv = GET_PRIV (object);
372 if (priv->account_manager_ready_handler_id > 0)
374 g_signal_handler_disconnect (priv->account_manager,
375 priv->account_manager_ready_handler_id);
378 g_object_unref (priv->account_manager);
380 if (priv->save_timer_id > 0)
382 /* have to save before destroy the object */
383 g_source_remove (priv->save_timer_id);
384 priv->save_timer_id = 0;
385 chatroom_manager_file_save (self);
388 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
390 EmpathyChatroom *chatroom = l->data;
392 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
395 g_object_unref (chatroom);
398 g_list_free (priv->chatrooms);
401 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
405 account_manager_ready_cb (GObject *gobject,
409 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (user_data);
410 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
412 chatroom_manager_get_all (self);
414 g_signal_handler_disconnect (gobject,
415 priv->account_manager_ready_handler_id);
416 priv->account_manager_ready_handler_id = 0;
420 empathy_chatroom_manager_constructor (GType type,
422 GObjectConstructParam *props)
425 EmpathyChatroomManager *self;
426 EmpathyChatroomManagerPriv *priv;
428 if (chatroom_manager_singleton != NULL)
429 return g_object_ref (chatroom_manager_singleton);
431 /* Parent constructor chain */
432 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
433 constructor (type, n_props, props);
435 self = EMPATHY_CHATROOM_MANAGER (obj);
436 priv = GET_PRIV (self);
440 chatroom_manager_singleton = self;
441 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
443 priv->account_manager = empathy_account_manager_dup_singleton ();
445 priv->account_manager_ready_handler_id = 0;
447 if (empathy_account_manager_is_ready (priv->account_manager))
448 chatroom_manager_get_all (self);
450 priv->account_manager_ready_handler_id = g_signal_connect (
451 G_OBJECT (priv->account_manager), "notify::ready",
452 G_CALLBACK (account_manager_ready_cb), self);
454 if (priv->file == NULL)
456 /* Set the default file path */
459 dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
460 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
461 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
463 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
471 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
473 GObjectClass *object_class = G_OBJECT_CLASS (klass);
474 GParamSpec *param_spec;
476 object_class->constructor = empathy_chatroom_manager_constructor;
477 object_class->get_property = empathy_chatroom_manager_get_property;
478 object_class->set_property = empathy_chatroom_manager_set_property;
479 object_class->finalize = chatroom_manager_finalize;
481 param_spec = g_param_spec_string (
483 "path of the favorite file",
484 "The path of the XML file containing user's favorites",
486 G_PARAM_CONSTRUCT_ONLY |
488 G_PARAM_STATIC_NAME |
489 G_PARAM_STATIC_NICK |
490 G_PARAM_STATIC_BLURB);
491 g_object_class_install_property (object_class, PROP_FILE, param_spec);
493 param_spec = g_param_spec_boolean (
495 "whether the manager is ready yet",
496 "whether the manager is ready yet",
499 g_object_class_install_property (object_class, PROP_READY, param_spec);
501 signals[CHATROOM_ADDED] = g_signal_new ("chatroom-added",
502 G_TYPE_FROM_CLASS (klass),
505 g_cclosure_marshal_VOID__OBJECT,
507 1, EMPATHY_TYPE_CHATROOM);
509 signals[CHATROOM_REMOVED] = g_signal_new ("chatroom-removed",
510 G_TYPE_FROM_CLASS (klass),
513 g_cclosure_marshal_VOID__OBJECT,
515 1, EMPATHY_TYPE_CHATROOM);
517 g_type_class_add_private (object_class, sizeof (EmpathyChatroomManagerPriv));
521 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
523 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
524 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
526 manager->priv = priv;
529 EmpathyChatroomManager *
530 empathy_chatroom_manager_dup_singleton (const gchar *file)
532 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
533 "file", file, NULL));
537 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
538 EmpathyChatroom *chatroom)
540 EmpathyChatroomManagerPriv *priv;
542 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
543 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
545 priv = GET_PRIV (manager);
547 /* don't add more than once */
548 if (!empathy_chatroom_manager_find (manager,
549 empathy_chatroom_get_account (chatroom),
550 empathy_chatroom_get_room (chatroom)))
552 add_chatroom (manager, chatroom);
554 if (empathy_chatroom_is_favorite (chatroom))
555 reset_save_timeout (manager);
557 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
565 chatroom_manager_remove_link (EmpathyChatroomManager *manager,
568 EmpathyChatroomManagerPriv *priv;
569 EmpathyChatroom *chatroom;
571 priv = GET_PRIV (manager);
575 if (empathy_chatroom_is_favorite (chatroom))
576 reset_save_timeout (manager);
578 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
580 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, chatroom);
581 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb, manager);
583 g_object_unref (chatroom);
587 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
588 EmpathyChatroom *chatroom)
590 EmpathyChatroomManagerPriv *priv;
593 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
594 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
596 priv = GET_PRIV (manager);
598 for (l = priv->chatrooms; l; l = l->next)
600 EmpathyChatroom *this_chatroom;
602 this_chatroom = l->data;
604 if (this_chatroom == chatroom ||
605 empathy_chatroom_equal (chatroom, this_chatroom))
607 chatroom_manager_remove_link (manager, l);
614 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
615 EmpathyAccount *account,
618 EmpathyChatroomManagerPriv *priv;
621 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
622 g_return_val_if_fail (room != NULL, NULL);
624 priv = GET_PRIV (manager);
626 for (l = priv->chatrooms; l; l = l->next) {
627 EmpathyChatroom *chatroom;
628 EmpathyAccount *this_account;
629 const gchar *this_room;
632 this_account = empathy_chatroom_get_account (chatroom);
633 this_room = empathy_chatroom_get_room (chatroom);
635 if (this_account && this_room && account == this_account
636 && strcmp (this_room, room) == 0) {
645 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
646 EmpathyAccount *account)
648 EmpathyChatroomManagerPriv *priv;
649 GList *chatrooms, *l;
651 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
653 priv = GET_PRIV (manager);
656 return g_list_copy (priv->chatrooms);
660 for (l = priv->chatrooms; l; l = l->next) {
661 EmpathyChatroom *chatroom;
665 if (account == empathy_chatroom_get_account (chatroom)) {
666 chatrooms = g_list_append (chatrooms, chatroom);
674 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
675 EmpathyAccount *account)
677 EmpathyChatroomManagerPriv *priv;
681 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
683 priv = GET_PRIV (manager);
686 return g_list_length (priv->chatrooms);
689 for (l = priv->chatrooms; l; l = l->next) {
690 EmpathyChatroom *chatroom;
694 if (account == empathy_chatroom_get_account (chatroom)) {
703 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
706 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
709 for (l = priv->chatrooms; l; l = l->next)
711 EmpathyChatroom *chatroom = l->data;
713 if (empathy_chatroom_get_tp_chat (chatroom) != chat)
716 empathy_chatroom_set_tp_chat (chatroom, NULL);
718 if (!empathy_chatroom_is_favorite (chatroom))
720 /* Remove the chatroom from the list, unless it's in the list of
722 * FIXME this policy should probably not be in libempathy */
723 chatroom_manager_remove_link (manager, l);
731 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
732 EmpathyDispatchOperation *operation, gpointer manager)
734 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
735 EmpathyChatroom *chatroom;
738 const gchar *roomname;
740 TpHandleType handle_type;
741 EmpathyAccount *account;
742 TpConnection *connection;
744 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
746 /* Observe Text channels to rooms only */
747 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
750 channel = empathy_dispatch_operation_get_channel (operation);
751 tp_channel_get_handle (channel, &handle_type);
753 if (handle_type != TP_HANDLE_TYPE_ROOM)
756 chat = EMPATHY_TP_CHAT (
757 empathy_dispatch_operation_get_channel_wrapper (operation));
758 connection = empathy_tp_chat_get_connection (chat);
759 account = empathy_account_manager_get_account_for_connection (
760 priv->account_manager, connection);
762 roomname = empathy_tp_chat_get_id (chat);
764 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
766 if (chatroom == NULL)
768 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
770 empathy_chatroom_set_tp_chat (chatroom, chat);
771 empathy_chatroom_manager_add (manager, chatroom);
772 g_object_unref (chatroom);
776 empathy_chatroom_set_tp_chat (chatroom, chat);
779 /* A TpChat is always destroyed as it only gets unreffed after the channel
780 * has been invalidated in the dispatcher.. */
781 g_signal_connect (chat, "destroy",
782 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
787 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
788 EmpathyDispatcher *dispatcher)
790 g_signal_connect (dispatcher, "observe",
791 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);