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 ("1.0");
94 root = xmlNewNode (NULL, "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, "chatroom", NULL);
112 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
113 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
114 xmlNewTextChild (node, NULL, "account", account_id);
115 xmlNewTextChild (node, NULL, "auto_connect",
116 empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
119 /* Make sure the XML is indented properly */
120 xmlIndentTreeOutput = 1;
122 DEBUG ("Saving file:'%s'", priv->file);
123 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
133 save_timeout (EmpathyChatroomManager *self)
135 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
137 priv->save_timer_id = 0;
138 chatroom_manager_file_save (self);
144 reset_save_timeout (EmpathyChatroomManager *self)
146 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
148 if (priv->save_timer_id > 0)
150 g_source_remove (priv->save_timer_id);
153 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
154 (GSourceFunc) save_timeout, self);
158 chatroom_changed_cb (EmpathyChatroom *chatroom,
160 EmpathyChatroomManager *self)
162 reset_save_timeout (self);
166 add_chatroom (EmpathyChatroomManager *self,
167 EmpathyChatroom *chatroom)
169 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
171 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
173 g_signal_connect (chatroom, "notify",
174 G_CALLBACK (chatroom_changed_cb), self);
178 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
181 EmpathyChatroomManagerPriv *priv;
182 EmpathyChatroom *chatroom;
183 EmpathyAccount *account;
189 gboolean auto_connect;
191 priv = GET_PRIV (manager);
193 /* default values. */
199 for (child = node->children; child; child = child->next) {
202 if (xmlNodeIsText (child)) {
206 tag = (gchar *) child->name;
207 str = (gchar *) xmlNodeGetContent (child);
209 if (strcmp (tag, "name") == 0) {
210 name = g_strdup (str);
212 else if (strcmp (tag, "room") == 0) {
213 room = g_strdup (str);
215 else if (strcmp (tag, "auto_connect") == 0) {
216 if (strcmp (str, "yes") == 0) {
219 auto_connect = FALSE;
222 else if (strcmp (tag, "account") == 0) {
223 account_id = g_strdup (str);
229 account = empathy_account_manager_get_account (priv->account_manager,
238 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
239 empathy_chatroom_set_favorite (chatroom, TRUE);
240 add_chatroom (manager, chatroom);
241 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
249 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
250 const gchar *filename)
252 EmpathyChatroomManagerPriv *priv;
253 xmlParserCtxtPtr ctxt;
255 xmlNodePtr chatrooms;
258 priv = GET_PRIV (manager);
260 DEBUG ("Attempting to parse file:'%s'...", filename);
262 ctxt = xmlNewParserCtxt ();
264 /* Parse and validate the file. */
265 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
267 g_warning ("Failed to parse file:'%s'", filename);
268 xmlFreeParserCtxt (ctxt);
272 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
273 g_warning ("Failed to validate file:'%s'", filename);
275 xmlFreeParserCtxt (ctxt);
279 /* The root node, chatrooms. */
280 chatrooms = xmlDocGetRootElement (doc);
282 for (node = chatrooms->children; node; node = node->next) {
283 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
284 chatroom_manager_parse_chatroom (manager, node);
288 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
291 xmlFreeParserCtxt (ctxt);
297 chatroom_manager_get_all (EmpathyChatroomManager *manager)
299 EmpathyChatroomManagerPriv *priv;
301 priv = GET_PRIV (manager);
304 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
305 !chatroom_manager_file_parse (manager, priv->file)) {
310 g_object_notify (G_OBJECT (manager), "ready");
316 empathy_chatroom_manager_get_property (GObject *object,
321 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
322 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
327 g_value_set_string (value, priv->file);
330 g_value_set_boolean (value, priv->ready);
333 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
339 empathy_chatroom_manager_set_property (GObject *object,
344 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
345 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
351 priv->file = g_value_dup_string (value);
354 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
360 chatroom_manager_finalize (GObject *object)
362 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
363 EmpathyChatroomManagerPriv *priv;
366 priv = GET_PRIV (object);
368 if (priv->account_manager_ready_handler_id > 0)
370 g_signal_handler_disconnect (priv->account_manager,
371 priv->account_manager_ready_handler_id);
374 g_object_unref (priv->account_manager);
376 if (priv->save_timer_id > 0)
378 /* have to save before destroy the object */
379 g_source_remove (priv->save_timer_id);
380 priv->save_timer_id = 0;
381 chatroom_manager_file_save (self);
384 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
386 EmpathyChatroom *chatroom = l->data;
388 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
391 g_object_unref (chatroom);
394 g_list_free (priv->chatrooms);
397 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
401 account_manager_ready_cb (GObject *gobject,
405 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (user_data);
406 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
408 chatroom_manager_get_all (self);
410 g_signal_handler_disconnect (gobject,
411 priv->account_manager_ready_handler_id);
412 priv->account_manager_ready_handler_id = 0;
416 empathy_chatroom_manager_constructor (GType type,
418 GObjectConstructParam *props)
421 EmpathyChatroomManager *self;
422 EmpathyChatroomManagerPriv *priv;
424 if (chatroom_manager_singleton != NULL)
425 return g_object_ref (chatroom_manager_singleton);
427 /* Parent constructor chain */
428 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
429 constructor (type, n_props, props);
431 self = EMPATHY_CHATROOM_MANAGER (obj);
432 priv = GET_PRIV (self);
436 chatroom_manager_singleton = self;
437 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
439 priv->account_manager = empathy_account_manager_dup_singleton ();
441 priv->account_manager_ready_handler_id = 0;
443 if (empathy_account_manager_is_ready (priv->account_manager))
444 chatroom_manager_get_all (self);
446 priv->account_manager_ready_handler_id = g_signal_connect (
447 G_OBJECT (priv->account_manager), "notify::ready",
448 G_CALLBACK (account_manager_ready_cb), self);
450 if (priv->file == NULL)
452 /* Set the default file path */
455 dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
456 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
457 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
459 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
467 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
469 GObjectClass *object_class = G_OBJECT_CLASS (klass);
470 GParamSpec *param_spec;
472 object_class->constructor = empathy_chatroom_manager_constructor;
473 object_class->get_property = empathy_chatroom_manager_get_property;
474 object_class->set_property = empathy_chatroom_manager_set_property;
475 object_class->finalize = chatroom_manager_finalize;
477 param_spec = g_param_spec_string (
479 "path of the favorite file",
480 "The path of the XML file containing user's favorites",
482 G_PARAM_CONSTRUCT_ONLY |
484 G_PARAM_STATIC_NAME |
485 G_PARAM_STATIC_NICK |
486 G_PARAM_STATIC_BLURB);
487 g_object_class_install_property (object_class, PROP_FILE, param_spec);
489 param_spec = g_param_spec_boolean (
491 "whether the manager is ready yet",
492 "whether the manager is ready yet",
495 g_object_class_install_property (object_class, PROP_READY, param_spec);
497 signals[CHATROOM_ADDED] = g_signal_new ("chatroom-added",
498 G_TYPE_FROM_CLASS (klass),
501 g_cclosure_marshal_VOID__OBJECT,
503 1, EMPATHY_TYPE_CHATROOM);
505 signals[CHATROOM_REMOVED] = g_signal_new ("chatroom-removed",
506 G_TYPE_FROM_CLASS (klass),
509 g_cclosure_marshal_VOID__OBJECT,
511 1, EMPATHY_TYPE_CHATROOM);
513 g_type_class_add_private (object_class, sizeof (EmpathyChatroomManagerPriv));
517 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
519 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
520 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
522 manager->priv = priv;
525 EmpathyChatroomManager *
526 empathy_chatroom_manager_dup_singleton (const gchar *file)
528 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
529 "file", file, NULL));
533 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
534 EmpathyChatroom *chatroom)
536 EmpathyChatroomManagerPriv *priv;
538 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
539 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
541 priv = GET_PRIV (manager);
543 /* don't add more than once */
544 if (!empathy_chatroom_manager_find (manager,
545 empathy_chatroom_get_account (chatroom),
546 empathy_chatroom_get_room (chatroom)))
548 add_chatroom (manager, chatroom);
550 if (empathy_chatroom_is_favorite (chatroom))
551 reset_save_timeout (manager);
553 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
561 chatroom_manager_remove_link (EmpathyChatroomManager *manager,
564 EmpathyChatroomManagerPriv *priv;
565 EmpathyChatroom *chatroom;
567 priv = GET_PRIV (manager);
571 if (empathy_chatroom_is_favorite (chatroom))
572 reset_save_timeout (manager);
574 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
576 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, chatroom);
577 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb, manager);
579 g_object_unref (chatroom);
583 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
584 EmpathyChatroom *chatroom)
586 EmpathyChatroomManagerPriv *priv;
589 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
590 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
592 priv = GET_PRIV (manager);
594 for (l = priv->chatrooms; l; l = l->next)
596 EmpathyChatroom *this_chatroom;
598 this_chatroom = l->data;
600 if (this_chatroom == chatroom ||
601 empathy_chatroom_equal (chatroom, this_chatroom))
603 chatroom_manager_remove_link (manager, l);
610 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
611 EmpathyAccount *account,
614 EmpathyChatroomManagerPriv *priv;
617 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
618 g_return_val_if_fail (room != NULL, NULL);
620 priv = GET_PRIV (manager);
622 for (l = priv->chatrooms; l; l = l->next) {
623 EmpathyChatroom *chatroom;
624 EmpathyAccount *this_account;
625 const gchar *this_room;
628 this_account = empathy_chatroom_get_account (chatroom);
629 this_room = empathy_chatroom_get_room (chatroom);
631 if (this_account && this_room && account == this_account
632 && strcmp (this_room, room) == 0) {
641 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
642 EmpathyAccount *account)
644 EmpathyChatroomManagerPriv *priv;
645 GList *chatrooms, *l;
647 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
649 priv = GET_PRIV (manager);
652 return g_list_copy (priv->chatrooms);
656 for (l = priv->chatrooms; l; l = l->next) {
657 EmpathyChatroom *chatroom;
661 if (account == empathy_chatroom_get_account (chatroom)) {
662 chatrooms = g_list_append (chatrooms, chatroom);
670 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
671 EmpathyAccount *account)
673 EmpathyChatroomManagerPriv *priv;
677 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
679 priv = GET_PRIV (manager);
682 return g_list_length (priv->chatrooms);
685 for (l = priv->chatrooms; l; l = l->next) {
686 EmpathyChatroom *chatroom;
690 if (account == empathy_chatroom_get_account (chatroom)) {
699 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
702 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
705 for (l = priv->chatrooms; l; l = l->next)
707 EmpathyChatroom *chatroom = l->data;
709 if (empathy_chatroom_get_tp_chat (chatroom) != chat)
712 empathy_chatroom_set_tp_chat (chatroom, NULL);
714 if (!empathy_chatroom_is_favorite (chatroom))
716 /* Remove the chatroom from the list, unless it's in the list of
718 * FIXME this policy should probably not be in libempathy */
719 chatroom_manager_remove_link (manager, l);
727 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
728 EmpathyDispatchOperation *operation, gpointer manager)
730 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
731 EmpathyChatroom *chatroom;
734 const gchar *roomname;
736 TpHandleType handle_type;
737 EmpathyAccount *account;
738 TpConnection *connection;
740 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
742 /* Observe Text channels to rooms only */
743 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
746 channel = empathy_dispatch_operation_get_channel (operation);
747 tp_channel_get_handle (channel, &handle_type);
749 if (handle_type != TP_HANDLE_TYPE_ROOM)
752 chat = EMPATHY_TP_CHAT (
753 empathy_dispatch_operation_get_channel_wrapper (operation));
754 connection = empathy_tp_chat_get_connection (chat);
755 account = empathy_account_manager_get_account_for_connection (
756 priv->account_manager, connection);
758 roomname = empathy_tp_chat_get_id (chat);
760 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
762 if (chatroom == NULL)
764 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
766 empathy_chatroom_set_tp_chat (chatroom, chat);
767 empathy_chatroom_manager_add (manager, chatroom);
768 g_object_unref (chatroom);
772 empathy_chatroom_set_tp_chat (chatroom, chat);
775 /* A TpChat is always destroyed as it only gets unreffed after the channel
776 * has been invalidated in the dispatcher.. */
777 g_signal_connect (chat, "destroy",
778 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
783 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
784 EmpathyDispatcher *dispatcher)
786 g_signal_connect (dispatcher, "observe",
787 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);