1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2004-2007 Imendio AB
4 * Copyright (C) 2007-2008 Collabora Ltd.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of the
9 * License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
21 * Authors: Xavier Claessens <xclaesse@gmail.com>
22 * Martyn Russell <martyn@imendio.com>
28 #include <sys/types.h>
31 #include <libxml/parser.h>
32 #include <libxml/tree.h>
34 #include "empathy-tp-chat.h"
35 #include "empathy-chatroom-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 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyChatroomManager)
49 /* source id of the autosave timer */
51 } EmpathyChatroomManagerPriv;
53 static void chatroom_manager_finalize (GObject *object);
54 static gboolean chatroom_manager_get_all (EmpathyChatroomManager *manager);
55 static gboolean chatroom_manager_file_parse (EmpathyChatroomManager *manager,
56 const gchar *filename);
57 static void chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
59 static gboolean chatroom_manager_file_save (EmpathyChatroomManager *manager);
60 static void reset_save_timeout (EmpathyChatroomManager *self);
68 static guint signals[LAST_SIGNAL];
77 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
80 empathy_chatroom_manager_get_property (GObject *object,
85 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
86 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
91 g_value_set_string (value, priv->file);
94 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
100 empathy_chatroom_manager_set_property (GObject *object,
105 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
106 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
112 priv->file = g_value_dup_string (value);
115 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
121 empathy_chatroom_manager_constructor (GType type,
123 GObjectConstructParam *props)
126 EmpathyChatroomManager *self;
127 EmpathyChatroomManagerPriv *priv;
129 /* Parent constructor chain */
130 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
131 constructor (type, n_props, props);
133 self = EMPATHY_CHATROOM_MANAGER (obj);
134 priv = GET_PRIV (self);
136 if (priv->file == NULL)
138 /* Set the default file path */
141 dir = g_build_filename (g_get_home_dir (), ".gnome2", PACKAGE_NAME, NULL);
142 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
143 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
145 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
149 chatroom_manager_get_all (self);
154 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
156 GObjectClass *object_class = G_OBJECT_CLASS (klass);
157 GParamSpec *param_spec;
159 object_class->constructor = empathy_chatroom_manager_constructor;
160 object_class->get_property = empathy_chatroom_manager_get_property;
161 object_class->set_property = empathy_chatroom_manager_set_property;
162 object_class->finalize = chatroom_manager_finalize;
164 param_spec = g_param_spec_string (
166 "path of the favorite file",
167 "The path of the XML file containing user's favorites",
169 G_PARAM_CONSTRUCT_ONLY |
171 G_PARAM_STATIC_NAME |
172 G_PARAM_STATIC_NICK |
173 G_PARAM_STATIC_BLURB);
174 g_object_class_install_property (object_class, PROP_FILE, param_spec);
176 signals[CHATROOM_ADDED] =
177 g_signal_new ("chatroom-added",
178 G_TYPE_FROM_CLASS (klass),
182 g_cclosure_marshal_VOID__OBJECT,
184 1, EMPATHY_TYPE_CHATROOM);
185 signals[CHATROOM_REMOVED] =
186 g_signal_new ("chatroom-removed",
187 G_TYPE_FROM_CLASS (klass),
191 g_cclosure_marshal_VOID__OBJECT,
193 1, EMPATHY_TYPE_CHATROOM);
195 g_type_class_add_private (object_class,
196 sizeof (EmpathyChatroomManagerPriv));
200 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
202 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
203 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
205 manager->priv = priv;
209 chatroom_changed_cb (EmpathyChatroom *chatroom,
211 EmpathyChatroomManager *self)
213 reset_save_timeout (self);
217 chatroom_manager_finalize (GObject *object)
219 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
220 EmpathyChatroomManagerPriv *priv;
223 priv = GET_PRIV (object);
225 if (priv->save_timer_id > 0)
227 /* have to save before destroy the object */
228 g_source_remove (priv->save_timer_id);
229 priv->save_timer_id = 0;
230 chatroom_manager_file_save (self);
233 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
235 EmpathyChatroom *chatroom = l->data;
237 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
240 g_object_unref (chatroom);
243 g_list_free (priv->chatrooms);
246 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
249 EmpathyChatroomManager *
250 empathy_chatroom_manager_new (const gchar *file)
252 static EmpathyChatroomManager *manager = NULL;
255 manager = g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
259 g_object_add_weak_pointer (G_OBJECT (manager), (gpointer) &manager);
261 g_object_ref (manager);
268 save_timeout (EmpathyChatroomManager *self)
270 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
272 priv->save_timer_id = 0;
273 chatroom_manager_file_save (self);
279 reset_save_timeout (EmpathyChatroomManager *self)
281 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
283 if (priv->save_timer_id > 0)
285 g_source_remove (priv->save_timer_id);
288 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
289 (GSourceFunc) save_timeout, self);
293 add_chatroom (EmpathyChatroomManager *self,
294 EmpathyChatroom *chatroom)
296 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
298 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
300 g_signal_connect (chatroom, "notify",
301 G_CALLBACK (chatroom_changed_cb), self);
305 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
306 EmpathyChatroom *chatroom)
308 EmpathyChatroomManagerPriv *priv;
310 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
311 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
313 priv = GET_PRIV (manager);
315 /* don't add more than once */
316 if (!empathy_chatroom_manager_find (manager,
317 empathy_chatroom_get_account (chatroom),
318 empathy_chatroom_get_room (chatroom))) {
321 g_object_get (chatroom, "favorite", &favorite, NULL);
323 add_chatroom (manager, chatroom);
327 reset_save_timeout (manager);
330 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
339 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
340 EmpathyChatroom *chatroom)
342 EmpathyChatroomManagerPriv *priv;
345 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
346 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
348 priv = GET_PRIV (manager);
350 for (l = priv->chatrooms; l; l = l->next) {
351 EmpathyChatroom *this_chatroom;
353 this_chatroom = l->data;
355 if (this_chatroom == chatroom ||
356 empathy_chatroom_equal (chatroom, this_chatroom)) {
358 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
360 g_object_get (chatroom, "favorite", &favorite, NULL);
364 reset_save_timeout (manager);
367 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, this_chatroom);
369 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
372 g_object_unref (this_chatroom);
379 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
383 EmpathyChatroomManagerPriv *priv;
386 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
387 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
388 g_return_val_if_fail (room != NULL, NULL);
390 priv = GET_PRIV (manager);
392 for (l = priv->chatrooms; l; l = l->next) {
393 EmpathyChatroom *chatroom;
394 McAccount *this_account;
395 const gchar *this_room;
398 this_account = empathy_chatroom_get_account (chatroom);
399 this_room = empathy_chatroom_get_room (chatroom);
401 if (this_account && this_room &&
402 empathy_account_equal (account, this_account) &&
403 strcmp (this_room, room) == 0) {
412 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
415 EmpathyChatroomManagerPriv *priv;
416 GList *chatrooms, *l;
418 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
420 priv = GET_PRIV (manager);
423 return g_list_copy (priv->chatrooms);
427 for (l = priv->chatrooms; l; l = l->next) {
428 EmpathyChatroom *chatroom;
432 if (empathy_account_equal (account,
433 empathy_chatroom_get_account (chatroom))) {
434 chatrooms = g_list_append (chatrooms, chatroom);
442 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
445 EmpathyChatroomManagerPriv *priv;
449 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
451 priv = GET_PRIV (manager);
454 return g_list_length (priv->chatrooms);
457 for (l = priv->chatrooms; l; l = l->next) {
458 EmpathyChatroom *chatroom;
462 if (empathy_account_equal (account,
463 empathy_chatroom_get_account (chatroom))) {
472 * API to save/load and parse the chatrooms file.
476 chatroom_manager_get_all (EmpathyChatroomManager *manager)
478 EmpathyChatroomManagerPriv *priv;
480 priv = GET_PRIV (manager);
483 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
484 !chatroom_manager_file_parse (manager, priv->file))
491 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
492 const gchar *filename)
494 EmpathyChatroomManagerPriv *priv;
495 xmlParserCtxtPtr ctxt;
497 xmlNodePtr chatrooms;
500 priv = GET_PRIV (manager);
502 DEBUG ("Attempting to parse file:'%s'...", filename);
504 ctxt = xmlNewParserCtxt ();
506 /* Parse and validate the file. */
507 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
509 g_warning ("Failed to parse file:'%s'", filename);
510 xmlFreeParserCtxt (ctxt);
514 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
515 g_warning ("Failed to validate file:'%s'", filename);
517 xmlFreeParserCtxt (ctxt);
521 /* The root node, chatrooms. */
522 chatrooms = xmlDocGetRootElement (doc);
524 for (node = chatrooms->children; node; node = node->next) {
525 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
526 chatroom_manager_parse_chatroom (manager, node);
530 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
533 xmlFreeParserCtxt (ctxt);
539 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
542 EmpathyChatroomManagerPriv *priv;
543 EmpathyChatroom *chatroom;
550 gboolean auto_connect;
552 priv = GET_PRIV (manager);
554 /* default values. */
560 for (child = node->children; child; child = child->next) {
563 if (xmlNodeIsText (child)) {
567 tag = (gchar *) child->name;
568 str = (gchar *) xmlNodeGetContent (child);
570 if (strcmp (tag, "name") == 0) {
571 name = g_strdup (str);
573 else if (strcmp (tag, "room") == 0) {
574 room = g_strdup (str);
576 else if (strcmp (tag, "auto_connect") == 0) {
577 if (strcmp (str, "yes") == 0) {
580 auto_connect = FALSE;
583 else if (strcmp (tag, "account") == 0) {
584 account_id = g_strdup (str);
590 account = mc_account_lookup (account_id);
598 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
599 g_object_set (chatroom, "favorite", TRUE, NULL);
600 add_chatroom (manager, chatroom);
601 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
603 g_object_unref (account);
610 chatroom_manager_file_save (EmpathyChatroomManager *manager)
612 EmpathyChatroomManagerPriv *priv;
617 priv = GET_PRIV (manager);
619 doc = xmlNewDoc ("1.0");
620 root = xmlNewNode (NULL, "chatrooms");
621 xmlDocSetRootElement (doc, root);
623 for (l = priv->chatrooms; l; l = l->next) {
624 EmpathyChatroom *chatroom;
626 const gchar *account_id;
631 g_object_get (chatroom, "favorite", &favorite, NULL);
635 account_id = mc_account_get_unique_name (empathy_chatroom_get_account (chatroom));
637 node = xmlNewChild (root, NULL, "chatroom", NULL);
638 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
639 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
640 xmlNewTextChild (node, NULL, "account", account_id);
641 xmlNewTextChild (node, NULL, "auto_connect", empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
644 /* Make sure the XML is indented properly */
645 xmlIndentTreeOutput = 1;
647 DEBUG ("Saving file:'%s'", priv->file);
648 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
658 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
661 EmpathyChatroomManager *manager = EMPATHY_CHATROOM_MANAGER (user_data);
662 McAccount *account = empathy_tp_chat_get_account (chat);
663 EmpathyChatroom *chatroom;
664 const gchar *roomname;
667 roomname = empathy_tp_chat_get_id (chat);
668 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
670 if (chatroom == NULL)
673 g_object_get (chatroom, "favorite", &favorite, NULL);
677 /* Remove the chatroom from the list, unless it's in the list of
679 * FIXME this policy should probably not be in libempathy */
680 empathy_chatroom_manager_remove (manager, chatroom);
685 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
686 EmpathyDispatchOperation *operation, gpointer user_data)
688 EmpathyChatroomManager *manager = EMPATHY_CHATROOM_MANAGER (user_data);
689 EmpathyChatroom *chatroom;
692 const gchar *roomname;
694 TpHandleType handle_type;
697 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
699 /* Observe Text channels to rooms only */
700 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
703 channel = empathy_dispatch_operation_get_channel (operation);
704 tp_channel_get_handle (channel, &handle_type);
706 if (handle_type != TP_HANDLE_TYPE_ROOM)
709 chat = EMPATHY_TP_CHAT (
710 empathy_dispatch_operation_get_channel_wrapper (operation));
711 account = empathy_tp_chat_get_account (chat);
713 roomname = empathy_tp_chat_get_id (chat);
715 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
717 if (chatroom == NULL)
719 chatroom = empathy_chatroom_new_full (account, roomname, roomname,
721 empathy_chatroom_manager_add (manager, chatroom);
722 g_object_unref (chatroom);
725 /* A TpChat is always destroyed as it only gets unreffed after the channel
726 * has been invalidated in the dispatcher.. */
727 g_signal_connect (chat, "destroy",
728 G_CALLBACK (chatroom_manager_chat_destroyed_cb),
731 g_object_unref (chat);
733 g_object_unref (channel);
737 empathy_chatroom_manager_observe (EmpathyChatroomManager *manager,
738 EmpathyDispatcher *dispatcher)
740 g_signal_connect (dispatcher, "observe",
741 G_CALLBACK (chatroom_manager_observe_channel_cb), manager);