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 static EmpathyChatroomManager *chatroom_manager_singleton = NULL;
47 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyChatroomManager)
51 /* source id of the autosave timer */
53 } EmpathyChatroomManagerPriv;
55 static void chatroom_manager_finalize (GObject *object);
56 static gboolean chatroom_manager_get_all (EmpathyChatroomManager *manager);
57 static gboolean chatroom_manager_file_parse (EmpathyChatroomManager *manager,
58 const gchar *filename);
59 static void chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
61 static gboolean chatroom_manager_file_save (EmpathyChatroomManager *manager);
62 static void reset_save_timeout (EmpathyChatroomManager *self);
70 static guint signals[LAST_SIGNAL];
79 G_DEFINE_TYPE (EmpathyChatroomManager, empathy_chatroom_manager, G_TYPE_OBJECT);
82 empathy_chatroom_manager_get_property (GObject *object,
87 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
88 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
93 g_value_set_string (value, priv->file);
96 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
102 empathy_chatroom_manager_set_property (GObject *object,
107 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
108 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
114 priv->file = g_value_dup_string (value);
117 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
123 empathy_chatroom_manager_constructor (GType type,
125 GObjectConstructParam *props)
128 EmpathyChatroomManager *self;
129 EmpathyChatroomManagerPriv *priv;
131 if (chatroom_manager_singleton != NULL)
132 return g_object_ref (chatroom_manager_singleton);
134 /* Parent constructor chain */
135 obj = G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->
136 constructor (type, n_props, props);
138 self = EMPATHY_CHATROOM_MANAGER (obj);
139 priv = GET_PRIV (self);
141 chatroom_manager_singleton = self;
142 g_object_add_weak_pointer (obj, (gpointer) &chatroom_manager_singleton);
144 if (priv->file == NULL)
146 /* Set the default file path */
149 dir = g_build_filename (g_get_home_dir (), ".gnome2", PACKAGE_NAME, NULL);
150 if (!g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
151 g_mkdir_with_parents (dir, S_IRUSR | S_IWUSR | S_IXUSR);
153 priv->file = g_build_filename (dir, CHATROOMS_XML_FILENAME, NULL);
157 chatroom_manager_get_all (self);
162 empathy_chatroom_manager_class_init (EmpathyChatroomManagerClass *klass)
164 GObjectClass *object_class = G_OBJECT_CLASS (klass);
165 GParamSpec *param_spec;
167 object_class->constructor = empathy_chatroom_manager_constructor;
168 object_class->get_property = empathy_chatroom_manager_get_property;
169 object_class->set_property = empathy_chatroom_manager_set_property;
170 object_class->finalize = chatroom_manager_finalize;
172 param_spec = g_param_spec_string (
174 "path of the favorite file",
175 "The path of the XML file containing user's favorites",
177 G_PARAM_CONSTRUCT_ONLY |
179 G_PARAM_STATIC_NAME |
180 G_PARAM_STATIC_NICK |
181 G_PARAM_STATIC_BLURB);
182 g_object_class_install_property (object_class, PROP_FILE, param_spec);
184 signals[CHATROOM_ADDED] =
185 g_signal_new ("chatroom-added",
186 G_TYPE_FROM_CLASS (klass),
190 g_cclosure_marshal_VOID__OBJECT,
192 1, EMPATHY_TYPE_CHATROOM);
193 signals[CHATROOM_REMOVED] =
194 g_signal_new ("chatroom-removed",
195 G_TYPE_FROM_CLASS (klass),
199 g_cclosure_marshal_VOID__OBJECT,
201 1, EMPATHY_TYPE_CHATROOM);
203 g_type_class_add_private (object_class,
204 sizeof (EmpathyChatroomManagerPriv));
208 empathy_chatroom_manager_init (EmpathyChatroomManager *manager)
210 EmpathyChatroomManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
211 EMPATHY_TYPE_CHATROOM_MANAGER, EmpathyChatroomManagerPriv);
213 manager->priv = priv;
217 chatroom_changed_cb (EmpathyChatroom *chatroom,
219 EmpathyChatroomManager *self)
221 reset_save_timeout (self);
225 chatroom_manager_finalize (GObject *object)
227 EmpathyChatroomManager *self = EMPATHY_CHATROOM_MANAGER (object);
228 EmpathyChatroomManagerPriv *priv;
231 priv = GET_PRIV (object);
233 if (priv->save_timer_id > 0)
235 /* have to save before destroy the object */
236 g_source_remove (priv->save_timer_id);
237 priv->save_timer_id = 0;
238 chatroom_manager_file_save (self);
241 for (l = priv->chatrooms; l != NULL; l = g_list_next (l))
243 EmpathyChatroom *chatroom = l->data;
245 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
248 g_object_unref (chatroom);
251 g_list_free (priv->chatrooms);
254 (G_OBJECT_CLASS (empathy_chatroom_manager_parent_class)->finalize) (object);
257 EmpathyChatroomManager *
258 empathy_chatroom_manager_dup_singleton (const gchar *file)
260 return EMPATHY_CHATROOM_MANAGER (g_object_new (EMPATHY_TYPE_CHATROOM_MANAGER,
261 "file", file, NULL));
265 save_timeout (EmpathyChatroomManager *self)
267 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
269 priv->save_timer_id = 0;
270 chatroom_manager_file_save (self);
276 reset_save_timeout (EmpathyChatroomManager *self)
278 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
280 if (priv->save_timer_id > 0)
282 g_source_remove (priv->save_timer_id);
285 priv->save_timer_id = g_timeout_add_seconds (SAVE_TIMER,
286 (GSourceFunc) save_timeout, self);
290 add_chatroom (EmpathyChatroomManager *self,
291 EmpathyChatroom *chatroom)
293 EmpathyChatroomManagerPriv *priv = GET_PRIV (self);
295 priv->chatrooms = g_list_prepend (priv->chatrooms, g_object_ref (chatroom));
297 g_signal_connect (chatroom, "notify",
298 G_CALLBACK (chatroom_changed_cb), self);
302 empathy_chatroom_manager_add (EmpathyChatroomManager *manager,
303 EmpathyChatroom *chatroom)
305 EmpathyChatroomManagerPriv *priv;
307 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), FALSE);
308 g_return_val_if_fail (EMPATHY_IS_CHATROOM (chatroom), FALSE);
310 priv = GET_PRIV (manager);
312 /* don't add more than once */
313 if (!empathy_chatroom_manager_find (manager,
314 empathy_chatroom_get_account (chatroom),
315 empathy_chatroom_get_room (chatroom))) {
318 g_object_get (chatroom, "favorite", &favorite, NULL);
320 add_chatroom (manager, chatroom);
324 reset_save_timeout (manager);
327 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
336 empathy_chatroom_manager_remove (EmpathyChatroomManager *manager,
337 EmpathyChatroom *chatroom)
339 EmpathyChatroomManagerPriv *priv;
342 g_return_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager));
343 g_return_if_fail (EMPATHY_IS_CHATROOM (chatroom));
345 priv = GET_PRIV (manager);
347 for (l = priv->chatrooms; l; l = l->next) {
348 EmpathyChatroom *this_chatroom;
350 this_chatroom = l->data;
352 if (this_chatroom == chatroom ||
353 empathy_chatroom_equal (chatroom, this_chatroom)) {
355 priv->chatrooms = g_list_delete_link (priv->chatrooms, l);
357 g_object_get (chatroom, "favorite", &favorite, NULL);
361 reset_save_timeout (manager);
364 g_signal_emit (manager, signals[CHATROOM_REMOVED], 0, this_chatroom);
366 g_signal_handlers_disconnect_by_func (chatroom, chatroom_changed_cb,
369 g_object_unref (this_chatroom);
376 empathy_chatroom_manager_find (EmpathyChatroomManager *manager,
380 EmpathyChatroomManagerPriv *priv;
383 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
384 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
385 g_return_val_if_fail (room != NULL, NULL);
387 priv = GET_PRIV (manager);
389 for (l = priv->chatrooms; l; l = l->next) {
390 EmpathyChatroom *chatroom;
391 McAccount *this_account;
392 const gchar *this_room;
395 this_account = empathy_chatroom_get_account (chatroom);
396 this_room = empathy_chatroom_get_room (chatroom);
398 if (this_account && this_room &&
399 empathy_account_equal (account, this_account) &&
400 strcmp (this_room, room) == 0) {
409 empathy_chatroom_manager_get_chatrooms (EmpathyChatroomManager *manager,
412 EmpathyChatroomManagerPriv *priv;
413 GList *chatrooms, *l;
415 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), NULL);
417 priv = GET_PRIV (manager);
420 return g_list_copy (priv->chatrooms);
424 for (l = priv->chatrooms; l; l = l->next) {
425 EmpathyChatroom *chatroom;
429 if (empathy_account_equal (account,
430 empathy_chatroom_get_account (chatroom))) {
431 chatrooms = g_list_append (chatrooms, chatroom);
439 empathy_chatroom_manager_get_count (EmpathyChatroomManager *manager,
442 EmpathyChatroomManagerPriv *priv;
446 g_return_val_if_fail (EMPATHY_IS_CHATROOM_MANAGER (manager), 0);
448 priv = GET_PRIV (manager);
451 return g_list_length (priv->chatrooms);
454 for (l = priv->chatrooms; l; l = l->next) {
455 EmpathyChatroom *chatroom;
459 if (empathy_account_equal (account,
460 empathy_chatroom_get_account (chatroom))) {
469 * API to save/load and parse the chatrooms file.
473 chatroom_manager_get_all (EmpathyChatroomManager *manager)
475 EmpathyChatroomManagerPriv *priv;
477 priv = GET_PRIV (manager);
480 if (g_file_test (priv->file, G_FILE_TEST_EXISTS) &&
481 !chatroom_manager_file_parse (manager, priv->file))
488 chatroom_manager_file_parse (EmpathyChatroomManager *manager,
489 const gchar *filename)
491 EmpathyChatroomManagerPriv *priv;
492 xmlParserCtxtPtr ctxt;
494 xmlNodePtr chatrooms;
497 priv = GET_PRIV (manager);
499 DEBUG ("Attempting to parse file:'%s'...", filename);
501 ctxt = xmlNewParserCtxt ();
503 /* Parse and validate the file. */
504 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
506 g_warning ("Failed to parse file:'%s'", filename);
507 xmlFreeParserCtxt (ctxt);
511 if (!empathy_xml_validate (doc, CHATROOMS_DTD_FILENAME)) {
512 g_warning ("Failed to validate file:'%s'", filename);
514 xmlFreeParserCtxt (ctxt);
518 /* The root node, chatrooms. */
519 chatrooms = xmlDocGetRootElement (doc);
521 for (node = chatrooms->children; node; node = node->next) {
522 if (strcmp ((gchar *) node->name, "chatroom") == 0) {
523 chatroom_manager_parse_chatroom (manager, node);
527 DEBUG ("Parsed %d chatrooms", g_list_length (priv->chatrooms));
530 xmlFreeParserCtxt (ctxt);
536 chatroom_manager_parse_chatroom (EmpathyChatroomManager *manager,
539 EmpathyChatroomManagerPriv *priv;
540 EmpathyChatroom *chatroom;
547 gboolean auto_connect;
549 priv = GET_PRIV (manager);
551 /* default values. */
557 for (child = node->children; child; child = child->next) {
560 if (xmlNodeIsText (child)) {
564 tag = (gchar *) child->name;
565 str = (gchar *) xmlNodeGetContent (child);
567 if (strcmp (tag, "name") == 0) {
568 name = g_strdup (str);
570 else if (strcmp (tag, "room") == 0) {
571 room = g_strdup (str);
573 else if (strcmp (tag, "auto_connect") == 0) {
574 if (strcmp (str, "yes") == 0) {
577 auto_connect = FALSE;
580 else if (strcmp (tag, "account") == 0) {
581 account_id = g_strdup (str);
587 account = mc_account_lookup (account_id);
595 chatroom = empathy_chatroom_new_full (account, room, name, auto_connect);
596 g_object_set (chatroom, "favorite", TRUE, NULL);
597 add_chatroom (manager, chatroom);
598 g_signal_emit (manager, signals[CHATROOM_ADDED], 0, chatroom);
600 g_object_unref (account);
607 chatroom_manager_file_save (EmpathyChatroomManager *manager)
609 EmpathyChatroomManagerPriv *priv;
614 priv = GET_PRIV (manager);
616 doc = xmlNewDoc ("1.0");
617 root = xmlNewNode (NULL, "chatrooms");
618 xmlDocSetRootElement (doc, root);
620 for (l = priv->chatrooms; l; l = l->next) {
621 EmpathyChatroom *chatroom;
623 const gchar *account_id;
628 g_object_get (chatroom, "favorite", &favorite, NULL);
632 account_id = mc_account_get_unique_name (empathy_chatroom_get_account (chatroom));
634 node = xmlNewChild (root, NULL, "chatroom", NULL);
635 xmlNewTextChild (node, NULL, "name", empathy_chatroom_get_name (chatroom));
636 xmlNewTextChild (node, NULL, "room", empathy_chatroom_get_room (chatroom));
637 xmlNewTextChild (node, NULL, "account", account_id);
638 xmlNewTextChild (node, NULL, "auto_connect", empathy_chatroom_get_auto_connect (chatroom) ? "yes" : "no");
641 /* Make sure the XML is indented properly */
642 xmlIndentTreeOutput = 1;
644 DEBUG ("Saving file:'%s'", priv->file);
645 xmlSaveFormatFileEnc (priv->file, doc, "utf-8", 1);
655 chatroom_manager_chat_destroyed_cb (EmpathyTpChat *chat,
658 EmpathyChatroomManager *manager = EMPATHY_CHATROOM_MANAGER (user_data);
659 McAccount *account = empathy_tp_chat_get_account (chat);
660 EmpathyChatroom *chatroom;
661 const gchar *roomname;
664 roomname = empathy_tp_chat_get_id (chat);
665 chatroom = empathy_chatroom_manager_find (manager, account, roomname);
667 if (chatroom == NULL)
670 g_object_set (chatroom, "tp-chat", NULL, NULL);
671 g_object_get (chatroom, "favorite", &favorite, NULL);
675 /* Remove the chatroom from the list, unless it's in the list of
677 * FIXME this policy should probably not be in libempathy */
678 empathy_chatroom_manager_remove (manager, chatroom);
683 chatroom_manager_observe_channel_cb (EmpathyDispatcher *dispatcher,
684 EmpathyDispatchOperation *operation, gpointer user_data)
686 EmpathyChatroomManager *manager = EMPATHY_CHATROOM_MANAGER (user_data);
687 EmpathyChatroom *chatroom;
690 const gchar *roomname;
692 TpHandleType handle_type;
695 channel_type = empathy_dispatch_operation_get_channel_type_id (operation);
697 /* Observe Text channels to rooms only */
698 if (channel_type != TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
701 channel = empathy_dispatch_operation_get_channel (operation);
702 tp_channel_get_handle (channel, &handle_type);
704 if (handle_type != TP_HANDLE_TYPE_ROOM)
707 chat = EMPATHY_TP_CHAT (
708 empathy_dispatch_operation_get_channel_wrapper (operation));
709 account = empathy_tp_chat_get_account (chat);
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 g_object_set (G_OBJECT (chatroom), "tp-chat", chat, NULL);
720 empathy_chatroom_manager_add (manager, chatroom);
721 g_object_unref (chatroom);
725 g_object_set (G_OBJECT (chatroom), "tp-chat", chat, NULL);
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);