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 "empathy-tp-chat.h"
34 #include "empathy-chatroom-manager.h"
35 #include "empathy-account-manager.h"
36 #include "empathy-utils.h"
38 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
39 #include "empathy-debug.h"
41 #define CHATROOMS_XML_FILENAME "chatrooms.xml"
42 #define CHATROOMS_DTD_FILENAME "empathy-chatroom-manager.dtd"
45 static EmpathyChatroomManager *chatroom_manager_singleton = NULL;
47 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyChatroomManager)
52 EmpathyAccountManager *account_manager;
53 /* source id of the autosave timer */
55 } EmpathyChatroomManagerPriv;
63 static guint signals[LAST_SIGNAL];
72 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
75 * API to save/load and parse the chatrooms file.
79 chatroom_manager_file_save (EmpathyChatroomManager *manager)
81 EmpathyChatroomManagerPriv *priv;
86 priv = GET_PRIV (manager);
88 doc = xmlNewDoc ("1.0");
89 root = xmlNewNode (NULL, "chatrooms");
90 xmlDocSetRootElement (doc, root);
92 for (l = priv->chatrooms; l; l = l->next) {
93 EmpathyChatroom *chatroom;
95 const gchar *account_id;
99 if (!empathy_chatroom_is_favorite (chatroom)) {
103 account_id = empathy_account_get_unique_name (
104 empathy_chatroom_get_account (chatroom));
106 node = xmlNewChild (root, NULL, "chatroom", NULL);
107 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
108 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
109 xmlNewTextChild (node, NULL, "account", account_id);
110 xmlNewTextChild (node, NULL, "auto_connect",
111 empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
114 /* Make sure the XML is indented properly */
115 xmlIndentTreeOutput = 1;
117 DEBUG ("Saving file:'%s'", priv->file);
118 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
128 save_timeout (EmpathyChatroomManager *self)
130 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
132 priv->save_timer_id = 0;
133 chatroom_manager_file_save (self);
139 reset_save_timeout (EmpathyChatroomManager *self)
141 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
143 if (priv->save_timer_id > 0)
145 g_source_remove (priv->save_timer_id);
148 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
149 (GSourceFunc) save_timeout, self);
153 chatroom_changed_cb (EmpathyChatroom *chatroom,
155 EmpathyChatroomManager *self)
157 reset_save_timeout (self);
161 add_chatroom (EmpathyChatroomManager *self,
162 EmpathyChatroom *chatroom)
164 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
166 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
168 g_signal_connect (chatroom, "notify",
169 G_CALLBACK (chatroom_changed_cb), self);
173 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
176 EmpathyChatroomManagerPriv *priv;
177 EmpathyChatroom *chatroom;
178 EmpathyAccount *account;
184 gboolean auto_connect;
186 priv = GET_PRIV (manager);
188 /* default values. */
194 for (child = node->children; child; child = child->next) {
197 if (xmlNodeIsText (child)) {
201 tag = (gchar *) child->name;
202 str = (gchar *) xmlNodeGetContent (child);
204 if (strcmp (tag, "name") == 0) {
205 name = g_strdup (str);
207 else if (strcmp (tag, "room") == 0) {
208 room = g_strdup (str);
210 else if (strcmp (tag, "auto_connect") == 0) {
211 if (strcmp (str, "yes") == 0) {
214 auto_connect = FALSE;
217 else if (strcmp (tag, "account") == 0) {
218 account_id = g_strdup (str);
224 account = empathy_account_manager_lookup (priv->account_manager, account_id);
232 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
233 empathy_chatroom_set_favorite (chatroom, TRUE);
234 add_chatroom (manager, chatroom);
235 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
237 g_object_unref (account);
244 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
245 const gchar *filename)
247 EmpathyChatroomManagerPriv *priv;
248 xmlParserCtxtPtr ctxt;
250 xmlNodePtr chatrooms;
253 priv = GET_PRIV (manager);
255 DEBUG ("Attempting to parse file:'%s'...", filename);
257 ctxt = xmlNewParserCtxt ();
259 /* Parse and validate the file. */
260 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
262 g_warning ("Failed to parse file:'%s'", filename);
263 xmlFreeParserCtxt (ctxt);
267 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
268 g_warning ("Failed to validate file:'%s'", filename);
270 xmlFreeParserCtxt (ctxt);
274 /* The root node, chatrooms. */
275 chatrooms = xmlDocGetRootElement (doc);
277 for (node = chatrooms->children; node; node = node->next) {
278 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
279 chatroom_manager_parse_chatroom (manager, node);
283 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
286 xmlFreeParserCtxt (ctxt);
292 chatroom_manager_get_all (EmpathyChatroomManager *manager)
294 EmpathyChatroomManagerPriv *priv;
296 priv = GET_PRIV (manager);
299 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
300 !chatroom_manager_file_parse (manager, priv->file)) {
308 empathy_chatroom_manager_get_property (GObject *object,
313 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
314 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
319 g_value_set_string (value, priv->file);
322 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
328 empathy_chatroom_manager_set_property (GObject *object,
333 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
334 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
340 priv->file = g_value_dup_string (value);
343 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
349 chatroom_manager_finalize (GObject *object)
351 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
352 EmpathyChatroomManagerPriv *priv;
355 priv = GET_PRIV (object);
357 g_object_unref (priv->account_manager);
359 if (priv->save_timer_id > 0)
361 /* have to save before destroy the object */
362 g_source_remove (priv->save_timer_id);
363 priv->save_timer_id = 0;
364 chatroom_manager_file_save (self);
367 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
369 EmpathyChatroom *chatroom = l->data;
371 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
374 g_object_unref (chatroom);
377 g_list_free (priv->chatrooms);
380 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
384 empathy_chatroom_manager_constructor (GType type,
386 GObjectConstructParam *props)
389 EmpathyChatroomManager *self;
390 EmpathyChatroomManagerPriv *priv;
392 if (chatroom_manager_singleton != NULL)
393 return g_object_ref (chatroom_manager_singleton);
395 /* Parent constructor chain */
396 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
397 constructor (type, n_props, props);
399 self = EMPATHY_CHATROOM_MANAGER (obj);
400 priv = GET_PRIV (self);
402 chatroom_manager_singleton = self;
403 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
405 priv->account_manager = empathy_account_manager_dup_singleton ();
407 if (priv->file == NULL)
409 /* Set the default file path */
412 dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
413 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
414 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
416 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
420 chatroom_manager_get_all (self);
425 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
427 GObjectClass *object_class = G_OBJECT_CLASS (klass);
428 GParamSpec *param_spec;
430 object_class->constructor = empathy_chatroom_manager_constructor;
431 object_class->get_property = empathy_chatroom_manager_get_property;
432 object_class->set_property = empathy_chatroom_manager_set_property;
433 object_class->finalize = chatroom_manager_finalize;
435 param_spec = g_param_spec_string (
437 "path of the favorite file",
438 "The path of the XML file containing user's favorites",
440 G_PARAM_CONSTRUCT_ONLY |
442 G_PARAM_STATIC_NAME |
443 G_PARAM_STATIC_NICK |
444 G_PARAM_STATIC_BLURB);
445 g_object_class_install_property (object_class, PROP_FILE, param_spec);
447 signals[CHATROOM_ADDED] = g_signal_new ("chatroom-added",
448 G_TYPE_FROM_CLASS (klass),
451 g_cclosure_marshal_VOID__OBJECT,
453 1, EMPATHY_TYPE_CHATROOM);
455 signals[CHATROOM_REMOVED] = g_signal_new ("chatroom-removed",
456 G_TYPE_FROM_CLASS (klass),
459 g_cclosure_marshal_VOID__OBJECT,
461 1, EMPATHY_TYPE_CHATROOM);
463 g_type_class_add_private (object_class, sizeof (EmpathyChatroomManagerPriv));
467 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
469 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
470 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
472 manager->priv = priv;
475 EmpathyChatroomManager *
476 empathy_chatroom_manager_dup_singleton (const gchar *file)
478 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
479 "file", file, NULL));
483 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
484 EmpathyChatroom *chatroom)
486 EmpathyChatroomManagerPriv *priv;
488 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
489 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
491 priv = GET_PRIV (manager);
493 /* don't add more than once */
494 if (!empathy_chatroom_manager_find (manager,
495 empathy_chatroom_get_account (chatroom),
496 empathy_chatroom_get_room (chatroom)))
498 add_chatroom (manager, chatroom);
500 if (empathy_chatroom_is_favorite (chatroom))
501 reset_save_timeout (manager);
503 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
511 chatroom_manager_remove_link (EmpathyChatroomManager *manager,
514 EmpathyChatroomManagerPriv *priv;
515 EmpathyChatroom *chatroom;
517 priv = GET_PRIV (manager);
521 if (empathy_chatroom_is_favorite (chatroom))
522 reset_save_timeout (manager);
524 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
526 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, chatroom);
527 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb, manager);
529 g_object_unref (chatroom);
533 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
534 EmpathyChatroom *chatroom)
536 EmpathyChatroomManagerPriv *priv;
539 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
540 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
542 priv = GET_PRIV (manager);
544 for (l = priv->chatrooms; l; l = l->next)
546 EmpathyChatroom *this_chatroom;
548 this_chatroom = l->data;
550 if (this_chatroom == chatroom ||
551 empathy_chatroom_equal (chatroom, this_chatroom))
553 chatroom_manager_remove_link (manager, l);
560 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
561 EmpathyAccount *account,
564 EmpathyChatroomManagerPriv *priv;
567 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
568 g_return_val_if_fail (room != NULL, NULL);
570 priv = GET_PRIV (manager);
572 for (l = priv->chatrooms; l; l = l->next) {
573 EmpathyChatroom *chatroom;
574 EmpathyAccount *this_account;
575 const gchar *this_room;
578 this_account = empathy_chatroom_get_account (chatroom);
579 this_room = empathy_chatroom_get_room (chatroom);
581 if (this_account && this_room &&
582 empathy_account_equal (account, this_account) &&
583 strcmp (this_room, room) == 0) {
592 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
593 EmpathyAccount *account)
595 EmpathyChatroomManagerPriv *priv;
596 GList *chatrooms, *l;
598 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
600 priv = GET_PRIV (manager);
603 return g_list_copy (priv->chatrooms);
607 for (l = priv->chatrooms; l; l = l->next) {
608 EmpathyChatroom *chatroom;
612 if (empathy_account_equal (account,
613 empathy_chatroom_get_account (chatroom))) {
614 chatrooms = g_list_append (chatrooms, chatroom);
622 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
623 EmpathyAccount *account)
625 EmpathyChatroomManagerPriv *priv;
629 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
631 priv = GET_PRIV (manager);
634 return g_list_length (priv->chatrooms);
637 for (l = priv->chatrooms; l; l = l->next) {
638 EmpathyChatroom *chatroom;
642 if (empathy_account_equal (account,
643 empathy_chatroom_get_account (chatroom))) {
652 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
655 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
658 for (l = priv->chatrooms; l; l = l->next)
660 EmpathyChatroom *chatroom = l->data;
662 if (empathy_chatroom_get_tp_chat (chatroom) != chat)
665 empathy_chatroom_set_tp_chat (chatroom, NULL);
667 if (!empathy_chatroom_is_favorite (chatroom))
669 /* Remove the chatroom from the list, unless it's in the list of
671 * FIXME this policy should probably not be in libempathy */
672 chatroom_manager_remove_link (manager, l);
680 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
681 EmpathyDispatchOperation *operation, gpointer manager)
683 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
684 EmpathyChatroom *chatroom;
687 const gchar *roomname;
689 TpHandleType handle_type;
690 EmpathyAccount *account;
691 TpConnection *connection;
693 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
695 /* Observe Text channels to rooms only */
696 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
699 channel = empathy_dispatch_operation_get_channel (operation);
700 tp_channel_get_handle (channel, &handle_type);
702 if (handle_type != TP_HANDLE_TYPE_ROOM)
705 chat = EMPATHY_TP_CHAT (
706 empathy_dispatch_operation_get_channel_wrapper (operation));
707 connection = empathy_tp_chat_get_connection (chat);
708 account = empathy_account_manager_get_account (priv->account_manager,
711 roomname = empathy_tp_chat_get_id (chat);
713 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
715 if (chatroom == NULL)
717 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
719 empathy_chatroom_set_tp_chat (chatroom, chat);
720 empathy_chatroom_manager_add (manager, chatroom);
721 g_object_unref (chatroom);
725 empathy_chatroom_set_tp_chat (chatroom, chat);
728 /* A TpChat is always destroyed as it only gets unreffed after the channel
729 * has been invalidated in the dispatcher.. */
730 g_signal_connect (chat, "destroy",
731 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
736 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
737 EmpathyDispatcher *dispatcher)
739 g_signal_connect (dispatcher, "observe",
740 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);