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 /* source id of the autosave timer */
57 } EmpathyChatroomManagerPriv;
65 static guint signals[LAST_SIGNAL];
74 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
77 * API to save/load and parse the chatrooms file.
81 chatroom_manager_file_save (EmpathyChatroomManager *manager)
83 EmpathyChatroomManagerPriv *priv;
88 priv = GET_PRIV (manager);
90 doc = xmlNewDoc ("1.0");
91 root = xmlNewNode (NULL, "chatrooms");
92 xmlDocSetRootElement (doc, root);
94 for (l = priv->chatrooms; l; l = l->next) {
95 EmpathyChatroom *chatroom;
97 const gchar *account_id;
101 if (!empathy_chatroom_is_favorite (chatroom)) {
105 account_id = empathy_account_get_unique_name (
106 empathy_chatroom_get_account (chatroom));
108 node = xmlNewChild (root, NULL, "chatroom", NULL);
109 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
110 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
111 xmlNewTextChild (node, NULL, "account", account_id);
112 xmlNewTextChild (node, NULL, "auto_connect",
113 empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
116 /* Make sure the XML is indented properly */
117 xmlIndentTreeOutput = 1;
119 DEBUG ("Saving file:'%s'", priv->file);
120 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
130 save_timeout (EmpathyChatroomManager *self)
132 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
134 priv->save_timer_id = 0;
135 chatroom_manager_file_save (self);
141 reset_save_timeout (EmpathyChatroomManager *self)
143 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
145 if (priv->save_timer_id > 0)
147 g_source_remove (priv->save_timer_id);
150 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
151 (GSourceFunc) save_timeout, self);
155 chatroom_changed_cb (EmpathyChatroom *chatroom,
157 EmpathyChatroomManager *self)
159 reset_save_timeout (self);
163 add_chatroom (EmpathyChatroomManager *self,
164 EmpathyChatroom *chatroom)
166 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
168 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
170 g_signal_connect (chatroom, "notify",
171 G_CALLBACK (chatroom_changed_cb), self);
175 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
178 EmpathyChatroomManagerPriv *priv;
179 EmpathyChatroom *chatroom;
180 EmpathyAccount *account;
186 gboolean auto_connect;
188 priv = GET_PRIV (manager);
190 /* default values. */
196 for (child = node->children; child; child = child->next) {
199 if (xmlNodeIsText (child)) {
203 tag = (gchar *) child->name;
204 str = (gchar *) xmlNodeGetContent (child);
206 if (strcmp (tag, "name") == 0) {
207 name = g_strdup (str);
209 else if (strcmp (tag, "room") == 0) {
210 room = g_strdup (str);
212 else if (strcmp (tag, "auto_connect") == 0) {
213 if (strcmp (str, "yes") == 0) {
216 auto_connect = FALSE;
219 else if (strcmp (tag, "account") == 0) {
220 account_id = g_strdup (str);
226 account = empathy_account_manager_get_account (priv->account_manager,
235 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
236 empathy_chatroom_set_favorite (chatroom, TRUE);
237 add_chatroom (manager, chatroom);
238 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
246 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
247 const gchar *filename)
249 EmpathyChatroomManagerPriv *priv;
250 xmlParserCtxtPtr ctxt;
252 xmlNodePtr chatrooms;
255 priv = GET_PRIV (manager);
257 DEBUG ("Attempting to parse file:'%s'...", filename);
259 ctxt = xmlNewParserCtxt ();
261 /* Parse and validate the file. */
262 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
264 g_warning ("Failed to parse file:'%s'", filename);
265 xmlFreeParserCtxt (ctxt);
269 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
270 g_warning ("Failed to validate file:'%s'", filename);
272 xmlFreeParserCtxt (ctxt);
276 /* The root node, chatrooms. */
277 chatrooms = xmlDocGetRootElement (doc);
279 for (node = chatrooms->children; node; node = node->next) {
280 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
281 chatroom_manager_parse_chatroom (manager, node);
285 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
288 xmlFreeParserCtxt (ctxt);
294 chatroom_manager_get_all (EmpathyChatroomManager *manager)
296 EmpathyChatroomManagerPriv *priv;
298 priv = GET_PRIV (manager);
301 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
302 !chatroom_manager_file_parse (manager, priv->file)) {
310 empathy_chatroom_manager_get_property (GObject *object,
315 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
316 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
321 g_value_set_string (value, priv->file);
324 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
330 empathy_chatroom_manager_set_property (GObject *object,
335 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
336 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
342 priv->file = g_value_dup_string (value);
345 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
351 chatroom_manager_finalize (GObject *object)
353 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
354 EmpathyChatroomManagerPriv *priv;
357 priv = GET_PRIV (object);
359 g_object_unref (priv->account_manager);
361 if (priv->save_timer_id > 0)
363 /* have to save before destroy the object */
364 g_source_remove (priv->save_timer_id);
365 priv->save_timer_id = 0;
366 chatroom_manager_file_save (self);
369 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
371 EmpathyChatroom *chatroom = l->data;
373 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
376 g_object_unref (chatroom);
379 g_list_free (priv->chatrooms);
382 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
386 empathy_chatroom_manager_constructor (GType type,
388 GObjectConstructParam *props)
391 EmpathyChatroomManager *self;
392 EmpathyChatroomManagerPriv *priv;
394 if (chatroom_manager_singleton != NULL)
395 return g_object_ref (chatroom_manager_singleton);
397 /* Parent constructor chain */
398 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
399 constructor (type, n_props, props);
401 self = EMPATHY_CHATROOM_MANAGER (obj);
402 priv = GET_PRIV (self);
404 chatroom_manager_singleton = self;
405 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
407 priv->account_manager = empathy_account_manager_dup_singleton ();
409 if (priv->file == NULL)
411 /* Set the default file path */
414 dir = g_build_filename (g_get_user_config_dir (), PACKAGE_NAME, NULL);
415 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
416 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
418 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
422 chatroom_manager_get_all (self);
427 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
429 GObjectClass *object_class = G_OBJECT_CLASS (klass);
430 GParamSpec *param_spec;
432 object_class->constructor = empathy_chatroom_manager_constructor;
433 object_class->get_property = empathy_chatroom_manager_get_property;
434 object_class->set_property = empathy_chatroom_manager_set_property;
435 object_class->finalize = chatroom_manager_finalize;
437 param_spec = g_param_spec_string (
439 "path of the favorite file",
440 "The path of the XML file containing user's favorites",
442 G_PARAM_CONSTRUCT_ONLY |
444 G_PARAM_STATIC_NAME |
445 G_PARAM_STATIC_NICK |
446 G_PARAM_STATIC_BLURB);
447 g_object_class_install_property (object_class, PROP_FILE, param_spec);
449 signals[CHATROOM_ADDED] = g_signal_new ("chatroom-added",
450 G_TYPE_FROM_CLASS (klass),
453 g_cclosure_marshal_VOID__OBJECT,
455 1, EMPATHY_TYPE_CHATROOM);
457 signals[CHATROOM_REMOVED] = g_signal_new ("chatroom-removed",
458 G_TYPE_FROM_CLASS (klass),
461 g_cclosure_marshal_VOID__OBJECT,
463 1, EMPATHY_TYPE_CHATROOM);
465 g_type_class_add_private (object_class, sizeof (EmpathyChatroomManagerPriv));
469 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
471 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
472 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
474 manager->priv = priv;
477 EmpathyChatroomManager *
478 empathy_chatroom_manager_dup_singleton (const gchar *file)
480 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
481 "file", file, NULL));
485 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
486 EmpathyChatroom *chatroom)
488 EmpathyChatroomManagerPriv *priv;
490 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
491 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
493 priv = GET_PRIV (manager);
495 /* don't add more than once */
496 if (!empathy_chatroom_manager_find (manager,
497 empathy_chatroom_get_account (chatroom),
498 empathy_chatroom_get_room (chatroom)))
500 add_chatroom (manager, chatroom);
502 if (empathy_chatroom_is_favorite (chatroom))
503 reset_save_timeout (manager);
505 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
513 chatroom_manager_remove_link (EmpathyChatroomManager *manager,
516 EmpathyChatroomManagerPriv *priv;
517 EmpathyChatroom *chatroom;
519 priv = GET_PRIV (manager);
523 if (empathy_chatroom_is_favorite (chatroom))
524 reset_save_timeout (manager);
526 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
528 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, chatroom);
529 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb, manager);
531 g_object_unref (chatroom);
535 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
536 EmpathyChatroom *chatroom)
538 EmpathyChatroomManagerPriv *priv;
541 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
542 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
544 priv = GET_PRIV (manager);
546 for (l = priv->chatrooms; l; l = l->next)
548 EmpathyChatroom *this_chatroom;
550 this_chatroom = l->data;
552 if (this_chatroom == chatroom ||
553 empathy_chatroom_equal (chatroom, this_chatroom))
555 chatroom_manager_remove_link (manager, l);
562 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
563 EmpathyAccount *account,
566 EmpathyChatroomManagerPriv *priv;
569 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
570 g_return_val_if_fail (room != NULL, NULL);
572 priv = GET_PRIV (manager);
574 for (l = priv->chatrooms; l; l = l->next) {
575 EmpathyChatroom *chatroom;
576 EmpathyAccount *this_account;
577 const gchar *this_room;
580 this_account = empathy_chatroom_get_account (chatroom);
581 this_room = empathy_chatroom_get_room (chatroom);
583 if (this_account && this_room && account == this_account
584 && strcmp (this_room, room) == 0) {
593 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
594 EmpathyAccount *account)
596 EmpathyChatroomManagerPriv *priv;
597 GList *chatrooms, *l;
599 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
601 priv = GET_PRIV (manager);
604 return g_list_copy (priv->chatrooms);
608 for (l = priv->chatrooms; l; l = l->next) {
609 EmpathyChatroom *chatroom;
613 if (account == 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 (account == empathy_chatroom_get_account (chatroom)) {
651 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
654 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
657 for (l = priv->chatrooms; l; l = l->next)
659 EmpathyChatroom *chatroom = l->data;
661 if (empathy_chatroom_get_tp_chat (chatroom) != chat)
664 empathy_chatroom_set_tp_chat (chatroom, NULL);
666 if (!empathy_chatroom_is_favorite (chatroom))
668 /* Remove the chatroom from the list, unless it's in the list of
670 * FIXME this policy should probably not be in libempathy */
671 chatroom_manager_remove_link (manager, l);
679 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
680 EmpathyDispatchOperation *operation, gpointer manager)
682 EmpathyChatroomManagerPriv *priv = GET_PRIV (manager);
683 EmpathyChatroom *chatroom;
686 const gchar *roomname;
688 TpHandleType handle_type;
689 EmpathyAccount *account;
690 TpConnection *connection;
692 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
694 /* Observe Text channels to rooms only */
695 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
698 channel = empathy_dispatch_operation_get_channel (operation);
699 tp_channel_get_handle (channel, &handle_type);
701 if (handle_type != TP_HANDLE_TYPE_ROOM)
704 chat = EMPATHY_TP_CHAT (
705 empathy_dispatch_operation_get_channel_wrapper (operation));
706 connection = empathy_tp_chat_get_connection (chat);
707 account = empathy_account_manager_get_account_for_connection (
708 priv->account_manager, connection);
710 roomname = empathy_tp_chat_get_id (chat);
712 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
714 if (chatroom == NULL)
716 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
718 empathy_chatroom_set_tp_chat (chatroom, chat);
719 empathy_chatroom_manager_add (manager, chatroom);
720 g_object_unref (chatroom);
724 empathy_chatroom_set_tp_chat (chatroom, chat);
727 /* A TpChat is always destroyed as it only gets unreffed after the channel
728 * has been invalidated in the dispatcher.. */
729 g_signal_connect (chat, "destroy",
730 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
735 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
736 EmpathyDispatcher *dispatcher)
738 g_signal_connect (dispatcher, "observe",
739 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);