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 */
58 } EmpathyChatroomManagerPriv;
66 static guint signals[LAST_SIGNAL];
75 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
78 * API to save/load and parse the chatrooms file.
82 chatroom_manager_file_save (EmpathyChatroomManager *manager)
84 EmpathyChatroomManagerPriv *priv;
89 priv = GET_PRIV (manager);
91 doc = xmlNewDoc ("1.0");
92 root = xmlNewNode (NULL, "chatrooms");
93 xmlDocSetRootElement (doc, root);
95 for (l = priv->chatrooms; l; l = l->next) {
96 EmpathyChatroom *chatroom;
98 const gchar *account_id;
102 if (!empathy_chatroom_is_favorite (chatroom)) {
106 account_id = empathy_account_get_unique_name (
107 empathy_chatroom_get_account (chatroom));
109 node = xmlNewChild (root, NULL, "chatroom", NULL);
110 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
111 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
112 xmlNewTextChild (node, NULL, "account", account_id);
113 xmlNewTextChild (node, NULL, "auto_connect",
114 empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
117 /* Make sure the XML is indented properly */
118 xmlIndentTreeOutput = 1;
120 DEBUG ("Saving file:'%s'", priv->file);
121 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
131 save_timeout (EmpathyChatroomManager *self)
133 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
135 priv->save_timer_id = 0;
136 chatroom_manager_file_save (self);
142 reset_save_timeout (EmpathyChatroomManager *self)
144 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
146 if (priv->save_timer_id > 0)
148 g_source_remove (priv->save_timer_id);
151 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
152 (GSourceFunc) save_timeout, self);
156 chatroom_changed_cb (EmpathyChatroom *chatroom,
158 EmpathyChatroomManager *self)
160 reset_save_timeout (self);
164 add_chatroom (EmpathyChatroomManager *self,
165 EmpathyChatroom *chatroom)
167 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
169 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
171 g_signal_connect (chatroom, "notify",
172 G_CALLBACK (chatroom_changed_cb), self);
176 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
179 EmpathyChatroomManagerPriv *priv;
180 EmpathyChatroom *chatroom;
181 EmpathyAccount *account;
187 gboolean auto_connect;
189 priv = GET_PRIV (manager);
191 /* default values. */
197 for (child = node->children; child; child = child->next) {
200 if (xmlNodeIsText (child)) {
204 tag = (gchar *) child->name;
205 str = (gchar *) xmlNodeGetContent (child);
207 if (strcmp (tag, "name") == 0) {
208 name = g_strdup (str);
210 else if (strcmp (tag, "room") == 0) {
211 room = g_strdup (str);
213 else if (strcmp (tag, "auto_connect") == 0) {
214 if (strcmp (str, "yes") == 0) {
217 auto_connect = FALSE;
220 else if (strcmp (tag, "account") == 0) {
221 account_id = g_strdup (str);
227 account = empathy_account_manager_get_account (priv->account_manager,
236 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
237 empathy_chatroom_set_favorite (chatroom, TRUE);
238 add_chatroom (manager, chatroom);
239 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
247 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
248 const gchar *filename)
250 EmpathyChatroomManagerPriv *priv;
251 xmlParserCtxtPtr ctxt;
253 xmlNodePtr chatrooms;
256 priv = GET_PRIV (manager);
258 DEBUG ("Attempting to parse file:'%s'...", filename);
260 ctxt = xmlNewParserCtxt ();
262 /* Parse and validate the file. */
263 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
265 g_warning ("Failed to parse file:'%s'", filename);
266 xmlFreeParserCtxt (ctxt);
270 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
271 g_warning ("Failed to validate file:'%s'", filename);
273 xmlFreeParserCtxt (ctxt);
277 /* The root node, chatrooms. */
278 chatrooms = xmlDocGetRootElement (doc);
280 for (node = chatrooms->children; node; node = node->next) {
281 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
282 chatroom_manager_parse_chatroom (manager, node);
286 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
289 xmlFreeParserCtxt (ctxt);
295 chatroom_manager_get_all (EmpathyChatroomManager *manager)
297 EmpathyChatroomManagerPriv *priv;
299 priv = GET_PRIV (manager);
302 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
303 !chatroom_manager_file_parse (manager, priv->file)) {
311 empathy_chatroom_manager_get_property (GObject *object,
316 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
317 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
322 g_value_set_string (value, priv->file);
325 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
331 empathy_chatroom_manager_set_property (GObject *object,
336 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
337 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
343 priv->file = g_value_dup_string (value);
346 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
352 chatroom_manager_finalize (GObject *object)
354 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
355 EmpathyChatroomManagerPriv *priv;
358 priv = GET_PRIV (object);
360 if (priv->account_manager_ready_handler_id > 0)
362 g_signal_handler_disconnect (priv->account_manager,
363 priv->account_manager_ready_handler_id);
366 g_object_unref (priv->account_manager);
368 if (priv->save_timer_id > 0)
370 /* have to save before destroy the object */
371 g_source_remove (priv->save_timer_id);
372 priv->save_timer_id = 0;
373 chatroom_manager_file_save (self);
376 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
378 EmpathyChatroom *chatroom = l->data;
380 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
383 g_object_unref (chatroom);
386 g_list_free (priv->chatrooms);
389 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
393 account_manager_ready_cb (GObject *gobject,
397 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (user_data);
398 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
400 chatroom_manager_get_all (self);
402 g_signal_handler_disconnect (gobject,
403 priv->account_manager_ready_handler_id);
404 priv->account_manager_ready_handler_id = 0;
408 empathy_chatroom_manager_constructor (GType type,
410 GObjectConstructParam *props)
413 EmpathyChatroomManager *self;
414 EmpathyChatroomManagerPriv *priv;
416 if (chatroom_manager_singleton != NULL)
417 return g_object_ref (chatroom_manager_singleton);
419 /* Parent constructor chain */
420 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
421 constructor (type, n_props, props);
423 self = EMPATHY_CHATROOM_MANAGER (obj);
424 priv = GET_PRIV (self);
426 chatroom_manager_singleton = self;
427 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
429 priv->account_manager = empathy_account_manager_dup_singleton ();
431 priv->account_manager_ready_handler_id = 0;
433 if (empathy_account_manager_is_ready (priv->account_manager))
434 chatroom_manager_get_all (self);
436 priv->account_manager_ready_handler_id = g_signal_connect (
437 G_OBJECT (priv->account_manager), "notify::ready",
438 G_CALLBACK (account_manager_ready_cb), self);
440 if (priv->file == NULL)
442 /* Set the default file path */
445 dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
446 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
447 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
449 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
457 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
459 GObjectClass *object_class = G_OBJECT_CLASS (klass);
460 GParamSpec *param_spec;
462 object_class->constructor = empathy_chatroom_manager_constructor;
463 object_class->get_property = empathy_chatroom_manager_get_property;
464 object_class->set_property = empathy_chatroom_manager_set_property;
465 object_class->finalize = chatroom_manager_finalize;
467 param_spec = g_param_spec_string (
469 "path of the favorite file",
470 "The path of the XML file containing user's favorites",
472 G_PARAM_CONSTRUCT_ONLY |
474 G_PARAM_STATIC_NAME |
475 G_PARAM_STATIC_NICK |
476 G_PARAM_STATIC_BLURB);
477 g_object_class_install_property (object_class, PROP_FILE, param_spec);
479 signals[CHATROOM_ADDED] = g_signal_new ("chatroom-added",
480 G_TYPE_FROM_CLASS (klass),
483 g_cclosure_marshal_VOID__OBJECT,
485 1, EMPATHY_TYPE_CHATROOM);
487 signals[CHATROOM_REMOVED] = g_signal_new ("chatroom-removed",
488 G_TYPE_FROM_CLASS (klass),
491 g_cclosure_marshal_VOID__OBJECT,
493 1, EMPATHY_TYPE_CHATROOM);
495 g_type_class_add_private (object_class, sizeof (EmpathyChatroomManagerPriv));
499 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
501 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
502 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
504 manager->priv = priv;
507 EmpathyChatroomManager *
508 empathy_chatroom_manager_dup_singleton (const gchar *file)
510 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
511 "file", file, NULL));
515 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
516 EmpathyChatroom *chatroom)
518 EmpathyChatroomManagerPriv *priv;
520 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
521 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
523 priv = GET_PRIV (manager);
525 /* don't add more than once */
526 if (!empathy_chatroom_manager_find (manager,
527 empathy_chatroom_get_account (chatroom),
528 empathy_chatroom_get_room (chatroom)))
530 add_chatroom (manager, chatroom);
532 if (empathy_chatroom_is_favorite (chatroom))
533 reset_save_timeout (manager);
535 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
543 chatroom_manager_remove_link (EmpathyChatroomManager *manager,
546 EmpathyChatroomManagerPriv *priv;
547 EmpathyChatroom *chatroom;
549 priv = GET_PRIV (manager);
553 if (empathy_chatroom_is_favorite (chatroom))
554 reset_save_timeout (manager);
556 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
558 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, chatroom);
559 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb, manager);
561 g_object_unref (chatroom);
565 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
566 EmpathyChatroom *chatroom)
568 EmpathyChatroomManagerPriv *priv;
571 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
572 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
574 priv = GET_PRIV (manager);
576 for (l = priv->chatrooms; l; l = l->next)
578 EmpathyChatroom *this_chatroom;
580 this_chatroom = l->data;
582 if (this_chatroom == chatroom ||
583 empathy_chatroom_equal (chatroom, this_chatroom))
585 chatroom_manager_remove_link (manager, l);
592 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
593 EmpathyAccount *account,
596 EmpathyChatroomManagerPriv *priv;
599 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
600 g_return_val_if_fail (room != NULL, NULL);
602 priv = GET_PRIV (manager);
604 for (l = priv->chatrooms; l; l = l->next) {
605 EmpathyChatroom *chatroom;
606 EmpathyAccount *this_account;
607 const gchar *this_room;
610 this_account = empathy_chatroom_get_account (chatroom);
611 this_room = empathy_chatroom_get_room (chatroom);
613 if (this_account && this_room && account == this_account
614 && strcmp (this_room, room) == 0) {
623 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
624 EmpathyAccount *account)
626 EmpathyChatroomManagerPriv *priv;
627 GList *chatrooms, *l;
629 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
631 priv = GET_PRIV (manager);
634 return g_list_copy (priv->chatrooms);
638 for (l = priv->chatrooms; l; l = l->next) {
639 EmpathyChatroom *chatroom;
643 if (account == empathy_chatroom_get_account (chatroom)) {
644 chatrooms = g_list_append (chatrooms, chatroom);
652 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
653 EmpathyAccount *account)
655 EmpathyChatroomManagerPriv *priv;
659 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
661 priv = GET_PRIV (manager);
664 return g_list_length (priv->chatrooms);
667 for (l = priv->chatrooms; l; l = l->next) {
668 EmpathyChatroom *chatroom;
672 if (account == empathy_chatroom_get_account (chatroom)) {
681 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
684 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
687 for (l = priv->chatrooms; l; l = l->next)
689 EmpathyChatroom *chatroom = l->data;
691 if (empathy_chatroom_get_tp_chat (chatroom) != chat)
694 empathy_chatroom_set_tp_chat (chatroom, NULL);
696 if (!empathy_chatroom_is_favorite (chatroom))
698 /* Remove the chatroom from the list, unless it's in the list of
700 * FIXME this policy should probably not be in libempathy */
701 chatroom_manager_remove_link (manager, l);
709 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
710 EmpathyDispatchOperation *operation, gpointer manager)
712 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
713 EmpathyChatroom *chatroom;
716 const gchar *roomname;
718 TpHandleType handle_type;
719 EmpathyAccount *account;
720 TpConnection *connection;
722 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
724 /* Observe Text channels to rooms only */
725 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
728 channel = empathy_dispatch_operation_get_channel (operation);
729 tp_channel_get_handle (channel, &handle_type);
731 if (handle_type != TP_HANDLE_TYPE_ROOM)
734 chat = EMPATHY_TP_CHAT (
735 empathy_dispatch_operation_get_channel_wrapper (operation));
736 connection = empathy_tp_chat_get_connection (chat);
737 account = empathy_account_manager_get_account_for_connection (
738 priv->account_manager, connection);
740 roomname = empathy_tp_chat_get_id (chat);
742 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
744 if (chatroom == NULL)
746 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
748 empathy_chatroom_set_tp_chat (chatroom, chat);
749 empathy_chatroom_manager_add (manager, chatroom);
750 g_object_unref (chatroom);
754 empathy_chatroom_set_tp_chat (chatroom, chat);
757 /* A TpChat is always destroyed as it only gets unreffed after the channel
758 * has been invalidated in the dispatcher.. */
759 g_signal_connect (chat, "destroy",
760 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
765 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
766 EmpathyDispatcher *dispatcher)
768 g_signal_connect (dispatcher, "observe",
769 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);