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., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, 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-utils.h"
37 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
38 #include "empathy-debug.h"
40 #define CHATROOMS_XML_FILENAME "chatrooms.xml"
41 #define CHATROOMS_DTD_FILENAME "empathy-chatroom-manager.dtd"
44 static EmpathyChatroomManager *chatroom_manager_singleton = NULL;
46 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyChatroomManager)
51 /* source id of the autosave timer */
53 } EmpathyChatroomManagerPriv;
61 static guint signals[LAST_SIGNAL];
70 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
73 * API to save/load and parse the chatrooms file.
77 chatroom_manager_file_save (EmpathyChatroomManager *manager)
79 EmpathyChatroomManagerPriv *priv;
84 priv = GET_PRIV (manager);
86 doc = xmlNewDoc ("1.0");
87 root = xmlNewNode (NULL, "chatrooms");
88 xmlDocSetRootElement (doc, root);
90 for (l = priv->chatrooms; l; l = l->next) {
91 EmpathyChatroom *chatroom;
93 const gchar *account_id;
98 g_object_get (chatroom, "favorite", &favorite, NULL);
103 account_id = mc_account_get_unique_name (empathy_chatroom_get_account (chatroom));
105 node = xmlNewChild (root, NULL, "chatroom", NULL);
106 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
107 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
108 xmlNewTextChild (node, NULL, "account", account_id);
109 xmlNewTextChild (node, NULL, "auto_connect",
110 empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
113 /* Make sure the XML is indented properly */
114 xmlIndentTreeOutput = 1;
116 DEBUG ("Saving file:'%s'", priv->file);
117 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
127 save_timeout (EmpathyChatroomManager *self)
129 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
131 priv->save_timer_id = 0;
132 chatroom_manager_file_save (self);
138 reset_save_timeout (EmpathyChatroomManager *self)
140 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
142 if (priv->save_timer_id > 0)
144 g_source_remove (priv->save_timer_id);
147 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
148 (GSourceFunc) save_timeout, self);
152 chatroom_changed_cb (EmpathyChatroom *chatroom,
154 EmpathyChatroomManager *self)
156 reset_save_timeout (self);
160 add_chatroom (EmpathyChatroomManager *self,
161 EmpathyChatroom *chatroom)
163 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
165 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
167 g_signal_connect (chatroom, "notify",
168 G_CALLBACK (chatroom_changed_cb), self);
172 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
175 EmpathyChatroomManagerPriv *priv;
176 EmpathyChatroom *chatroom;
183 gboolean auto_connect;
185 priv = GET_PRIV (manager);
187 /* default values. */
193 for (child = node->children; child; child = child->next) {
196 if (xmlNodeIsText (child)) {
200 tag = (gchar *) child->name;
201 str = (gchar *) xmlNodeGetContent (child);
203 if (strcmp (tag, "name") == 0) {
204 name = g_strdup (str);
206 else if (strcmp (tag, "room") == 0) {
207 room = g_strdup (str);
209 else if (strcmp (tag, "auto_connect") == 0) {
210 if (strcmp (str, "yes") == 0) {
213 auto_connect = FALSE;
216 else if (strcmp (tag, "account") == 0) {
217 account_id = g_strdup (str);
223 account = mc_account_lookup (account_id);
231 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
232 g_object_set (chatroom, "favorite", TRUE, NULL);
233 add_chatroom (manager, chatroom);
234 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
236 g_object_unref (account);
243 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
244 const gchar *filename)
246 EmpathyChatroomManagerPriv *priv;
247 xmlParserCtxtPtr ctxt;
249 xmlNodePtr chatrooms;
252 priv = GET_PRIV (manager);
254 DEBUG ("Attempting to parse file:'%s'...", filename);
256 ctxt = xmlNewParserCtxt ();
258 /* Parse and validate the file. */
259 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
261 g_warning ("Failed to parse file:'%s'", filename);
262 xmlFreeParserCtxt (ctxt);
266 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
267 g_warning ("Failed to validate file:'%s'", filename);
269 xmlFreeParserCtxt (ctxt);
273 /* The root node, chatrooms. */
274 chatrooms = xmlDocGetRootElement (doc);
276 for (node = chatrooms->children; node; node = node->next) {
277 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
278 chatroom_manager_parse_chatroom (manager, node);
282 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
285 xmlFreeParserCtxt (ctxt);
291 chatroom_manager_get_all (EmpathyChatroomManager *manager)
293 EmpathyChatroomManagerPriv *priv;
295 priv = GET_PRIV (manager);
298 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
299 !chatroom_manager_file_parse (manager, priv->file)) {
307 empathy_chatroom_manager_get_property (GObject *object,
312 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
313 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
318 g_value_set_string (value, priv->file);
321 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
327 empathy_chatroom_manager_set_property (GObject *object,
332 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
333 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
339 priv->file = g_value_dup_string (value);
342 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
348 chatroom_manager_finalize (GObject *object)
350 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
351 EmpathyChatroomManagerPriv *priv;
354 priv = GET_PRIV (object);
356 if (priv->save_timer_id > 0)
358 /* have to save before destroy the object */
359 g_source_remove (priv->save_timer_id);
360 priv->save_timer_id = 0;
361 chatroom_manager_file_save (self);
364 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
366 EmpathyChatroom *chatroom = l->data;
368 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
371 g_object_unref (chatroom);
374 g_list_free (priv->chatrooms);
377 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
381 empathy_chatroom_manager_constructor (GType type,
383 GObjectConstructParam *props)
386 EmpathyChatroomManager *self;
387 EmpathyChatroomManagerPriv *priv;
389 if (chatroom_manager_singleton != NULL)
390 return g_object_ref (chatroom_manager_singleton);
392 /* Parent constructor chain */
393 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
394 constructor (type, n_props, props);
396 self = EMPATHY_CHATROOM_MANAGER (obj);
397 priv = GET_PRIV (self);
399 chatroom_manager_singleton = self;
400 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
402 if (priv->file == NULL)
404 /* Set the default file path */
407 dir = g_build_filename (g_get_home_dir (), ".gnome2", PACKAGE_NAME, NULL);
408 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
409 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
411 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
415 chatroom_manager_get_all (self);
420 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
422 GObjectClass *object_class = G_OBJECT_CLASS (klass);
423 GParamSpec *param_spec;
425 object_class->constructor = empathy_chatroom_manager_constructor;
426 object_class->get_property = empathy_chatroom_manager_get_property;
427 object_class->set_property = empathy_chatroom_manager_set_property;
428 object_class->finalize = chatroom_manager_finalize;
430 param_spec = g_param_spec_string (
432 "path of the favorite file",
433 "The path of the XML file containing user's favorites",
435 G_PARAM_CONSTRUCT_ONLY |
437 G_PARAM_STATIC_NAME |
438 G_PARAM_STATIC_NICK |
439 G_PARAM_STATIC_BLURB);
440 g_object_class_install_property (object_class, PROP_FILE, param_spec);
442 signals[CHATROOM_ADDED] = g_signal_new ("chatroom-added",
443 G_TYPE_FROM_CLASS (klass),
446 g_cclosure_marshal_VOID__OBJECT,
448 1, EMPATHY_TYPE_CHATROOM);
450 signals[CHATROOM_REMOVED] = g_signal_new ("chatroom-removed",
451 G_TYPE_FROM_CLASS (klass),
454 g_cclosure_marshal_VOID__OBJECT,
456 1, EMPATHY_TYPE_CHATROOM);
458 g_type_class_add_private (object_class, sizeof (EmpathyChatroomManagerPriv));
462 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
464 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
465 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
467 manager->priv = priv;
470 EmpathyChatroomManager *
471 empathy_chatroom_manager_dup_singleton (const gchar *file)
473 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
474 "file", file, NULL));
478 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
479 EmpathyChatroom *chatroom)
481 EmpathyChatroomManagerPriv *priv;
483 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
484 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
486 priv = GET_PRIV (manager);
488 /* don't add more than once */
489 if (!empathy_chatroom_manager_find (manager,
490 empathy_chatroom_get_account (chatroom),
491 empathy_chatroom_get_room (chatroom)))
495 g_object_get (chatroom, "favorite", &favorite, NULL);
496 add_chatroom (manager, chatroom);
499 reset_save_timeout (manager);
501 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
509 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
510 EmpathyChatroom *chatroom)
512 EmpathyChatroomManagerPriv *priv;
515 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
516 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
518 priv = GET_PRIV (manager);
520 for (l = priv->chatrooms; l; l = l->next)
522 EmpathyChatroom *this_chatroom;
524 this_chatroom = l->data;
526 if (this_chatroom == chatroom ||
527 empathy_chatroom_equal (chatroom, this_chatroom))
531 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
532 g_object_get (chatroom, "favorite", &favorite, NULL);
534 reset_save_timeout (manager);
536 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, this_chatroom);
537 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
540 g_object_unref (this_chatroom);
547 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
551 EmpathyChatroomManagerPriv *priv;
554 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
555 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
556 g_return_val_if_fail (room != NULL, NULL);
558 priv = GET_PRIV (manager);
560 for (l = priv->chatrooms; l; l = l->next) {
561 EmpathyChatroom *chatroom;
562 McAccount *this_account;
563 const gchar *this_room;
566 this_account = empathy_chatroom_get_account (chatroom);
567 this_room = empathy_chatroom_get_room (chatroom);
569 if (this_account && this_room &&
570 empathy_account_equal (account, this_account) &&
571 strcmp (this_room, room) == 0) {
580 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
583 EmpathyChatroomManagerPriv *priv;
584 GList *chatrooms, *l;
586 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
588 priv = GET_PRIV (manager);
591 return g_list_copy (priv->chatrooms);
595 for (l = priv->chatrooms; l; l = l->next) {
596 EmpathyChatroom *chatroom;
600 if (empathy_account_equal (account,
601 empathy_chatroom_get_account (chatroom))) {
602 chatrooms = g_list_append (chatrooms, chatroom);
610 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
613 EmpathyChatroomManagerPriv *priv;
617 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
619 priv = GET_PRIV (manager);
622 return g_list_length (priv->chatrooms);
625 for (l = priv->chatrooms; l; l = l->next) {
626 EmpathyChatroom *chatroom;
630 if (empathy_account_equal (account,
631 empathy_chatroom_get_account (chatroom))) {
640 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
643 EmpathyChatroomManager *manager = EMPATHY_CHATROOM_MANAGER (user_data);
644 McAccount *account = empathy_tp_chat_get_account (chat);
645 EmpathyChatroom *chatroom;
646 const gchar *roomname;
649 roomname = empathy_tp_chat_get_id (chat);
650 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
652 if (chatroom == NULL)
655 g_object_set (chatroom, "tp-chat", NULL, NULL);
656 g_object_get (chatroom, "favorite", &favorite, NULL);
660 /* Remove the chatroom from the list, unless it's in the list of
662 * FIXME this policy should probably not be in libempathy */
663 empathy_chatroom_manager_remove (manager, chatroom);
668 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
669 EmpathyDispatchOperation *operation, gpointer user_data)
671 EmpathyChatroomManager *manager = EMPATHY_CHATROOM_MANAGER (user_data);
672 EmpathyChatroom *chatroom;
675 const gchar *roomname;
677 TpHandleType handle_type;
680 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
682 /* Observe Text channels to rooms only */
683 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
686 channel = empathy_dispatch_operation_get_channel (operation);
687 tp_channel_get_handle (channel, &handle_type);
689 if (handle_type != TP_HANDLE_TYPE_ROOM)
692 chat = EMPATHY_TP_CHAT (
693 empathy_dispatch_operation_get_channel_wrapper (operation));
694 account = empathy_tp_chat_get_account (chat);
696 roomname = empathy_tp_chat_get_id (chat);
698 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
700 if (chatroom == NULL)
702 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
704 g_object_set (G_OBJECT (chatroom), "tp-chat", chat, NULL);
705 empathy_chatroom_manager_add (manager, chatroom);
706 g_object_unref (chatroom);
710 g_object_set (G_OBJECT (chatroom), "tp-chat", chat, NULL);
713 /* A TpChat is always destroyed as it only gets unreffed after the channel
714 * has been invalidated in the dispatcher.. */
715 g_signal_connect (chat, "destroy",
716 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
721 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
722 EmpathyDispatcher *dispatcher)
724 g_signal_connect (dispatcher, "observe",
725 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);