1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2003-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>
29 #include <glib/gstdio.h>
31 #include "empathy-log-manager.h"
32 #include "empathy-contact.h"
33 #include "empathy-time.h"
34 #include "empathy-debug.h"
35 #include "empathy-utils.h"
37 #define GET_PRIV(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
38 EMPATHY_TYPE_LOG_MANAGER, EmpathyLogManagerPriv))
40 #define DEBUG_DOMAIN "LogManager"
42 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
43 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
44 #define LOG_DIR_CHATROOMS "chatrooms"
45 #define LOG_FILENAME_SUFFIX ".log"
46 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
47 #define LOG_TIME_FORMAT "%Y%m%d"
49 "<?xml version='1.0' encoding='utf-8'?>\n" \
50 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
56 struct _EmpathyLogManagerPriv {
60 static void empathy_log_manager_class_init (EmpathyLogManagerClass *klass);
61 static void empathy_log_manager_init (EmpathyLogManager *manager);
62 static void log_manager_finalize (GObject *object);
63 static const gchar * log_manager_get_basedir (EmpathyLogManager *manager);
64 static GList * log_manager_get_all_files (EmpathyLogManager *manager,
66 static GList * log_manager_get_chats (EmpathyLogManager *manager,
68 gboolean is_chatroom);
69 static gchar * log_manager_get_dir (EmpathyLogManager *manager,
73 static gchar * log_manager_get_filename (EmpathyLogManager *manager,
77 static gchar * log_manager_get_filename_for_date (EmpathyLogManager *manager,
82 static gchar * log_manager_get_timestamp_filename (void);
83 static gchar * log_manager_get_timestamp_from_message (EmpathyMessage *message);
84 static EmpathyLogSearchHit *log_manager_search_hit_new (EmpathyLogManager *manager,
85 const gchar *filename);
86 static void log_manager_search_hit_free (EmpathyLogSearchHit *hit);
88 G_DEFINE_TYPE (EmpathyLogManager, empathy_log_manager, G_TYPE_OBJECT);
91 empathy_log_manager_class_init (EmpathyLogManagerClass *klass)
93 GObjectClass *object_class = G_OBJECT_CLASS (klass);
95 object_class->finalize = log_manager_finalize;
97 g_type_class_add_private (object_class, sizeof (EmpathyLogManagerPriv));
101 empathy_log_manager_init (EmpathyLogManager *manager)
106 log_manager_finalize (GObject *object)
108 EmpathyLogManagerPriv *priv;
110 priv = GET_PRIV (object);
112 g_free (priv->basedir);
116 empathy_log_manager_new (void)
118 static EmpathyLogManager *manager = NULL;
121 manager = g_object_new (EMPATHY_TYPE_LOG_MANAGER, NULL);
122 g_object_add_weak_pointer (G_OBJECT (manager), (gpointer) &manager);
124 g_object_ref (manager);
131 empathy_log_manager_add_message (EmpathyLogManager *manager,
132 const gchar *chat_id,
134 EmpathyMessage *message)
138 EmpathyContact *sender;
139 const gchar *body_str;
141 EmpathyAvatar *avatar;
142 gchar *avatar_token = NULL;
149 EmpathyMessageType msg_type;
151 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
152 g_return_if_fail (chat_id != NULL);
153 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
155 sender = empathy_message_get_sender (message);
156 account = empathy_contact_get_account (sender);
157 body_str = empathy_message_get_body (message);
158 msg_type = empathy_message_get_type (message);
160 if (G_STR_EMPTY (body_str)) {
164 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
165 basedir = g_path_get_dirname (filename);
166 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
167 empathy_debug (DEBUG_DOMAIN, "Creating directory:'%s'", basedir);
169 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
173 empathy_debug (DEBUG_DOMAIN, "Adding message: '%s' to file: '%s'",
176 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
177 file = g_fopen (filename, "w+");
179 g_fprintf (file, LOG_HEADER);
181 g_chmod (filename, LOG_FILE_CREATE_MODE);
183 file = g_fopen (filename, "r+");
185 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
189 body = g_markup_escape_text (body_str, -1);
190 timestamp = log_manager_get_timestamp_from_message (message);
192 str = empathy_contact_get_name (sender);
193 contact_name = g_markup_escape_text (str, -1);
195 str = empathy_contact_get_id (sender);
196 contact_id = g_markup_escape_text (str, -1);
198 avatar = empathy_contact_get_avatar (sender);
200 avatar_token = g_markup_escape_text (avatar->token, -1);
204 "<message time='%s' id='%s' name='%s' token='%s' isuser='%s' type='%s'>%s</message>\n" LOG_FOOTER,
208 avatar_token ? avatar_token : "",
209 empathy_contact_is_user (sender) ? "true" : "false",
210 empathy_message_type_to_str (msg_type),
216 g_free (contact_name);
219 g_free (avatar_token);
223 empathy_log_manager_exists (EmpathyLogManager *manager,
225 const gchar *chat_id,
231 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
232 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
239 empathy_log_manager_get_dates (EmpathyLogManager *manager,
241 const gchar *chat_id,
248 const gchar *filename;
251 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
252 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
253 g_return_val_if_fail (chat_id != NULL, NULL);
255 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
256 dir = g_dir_open (directory, 0, NULL);
258 empathy_debug (DEBUG_DOMAIN, "Could not open directory:'%s'", directory);
263 empathy_debug (DEBUG_DOMAIN, "Collating a list of dates in:'%s'", directory);
265 while ((filename = g_dir_read_name (dir)) != NULL) {
266 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
270 p = strstr (filename, LOG_FILENAME_SUFFIX);
271 date = g_strndup (filename, p - filename);
276 if (!g_regex_match_simple ("\\d{8}", date, 0, 0)) {
280 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
286 empathy_debug (DEBUG_DOMAIN, "Parsed %d dates", g_list_length (dates));
292 empathy_log_manager_get_messages_for_file (EmpathyLogManager *manager,
293 const gchar *filename)
295 GList *messages = NULL;
296 xmlParserCtxtPtr ctxt;
300 EmpathyLogSearchHit *hit;
303 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
304 g_return_val_if_fail (filename != NULL, NULL);
306 empathy_debug (DEBUG_DOMAIN, "Attempting to parse filename:'%s'...", filename);
308 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
309 empathy_debug (DEBUG_DOMAIN, "Filename:'%s' does not exist", filename);
313 /* Get the account from the filename */
314 hit = log_manager_search_hit_new (manager, filename);
315 account = g_object_ref (hit->account);
316 log_manager_search_hit_free (hit);
319 ctxt = xmlNewParserCtxt ();
321 /* Parse and validate the file. */
322 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
324 g_warning ("Failed to parse file:'%s'", filename);
325 xmlFreeParserCtxt (ctxt);
329 /* The root node, presets. */
330 log_node = xmlDocGetRootElement (doc);
333 xmlFreeParserCtxt (ctxt);
337 /* Now get the messages. */
338 for (node = log_node->children; node; node = node->next) {
339 EmpathyMessage *message;
340 EmpathyContact *sender;
341 EmpathyAvatar *avatar = NULL;
346 gchar *sender_avatar_token;
349 gboolean is_user = FALSE;
351 EmpathyMessageType msg_type = EMPATHY_MESSAGE_TYPE_NORMAL;
353 if (strcmp (node->name, "message") != 0) {
357 body = xmlNodeGetContent (node);
358 time = xmlGetProp (node, "time");
359 sender_id = xmlGetProp (node, "id");
360 sender_name = xmlGetProp (node, "name");
361 sender_avatar_token = xmlGetProp (node, "token");
362 is_user_str = xmlGetProp (node, "isuser");
363 msg_type_str = xmlGetProp (node, "type");
365 if (!G_STR_EMPTY (sender_avatar_token)) {
366 avatar = empathy_avatar_new_from_cache (sender_avatar_token);
369 is_user = strcmp (is_user_str, "true") == 0;
372 msg_type = empathy_message_type_from_str (msg_type_str);
375 t = empathy_time_parse (time);
377 sender = empathy_contact_new_full (account, sender_id, sender_name);
378 empathy_contact_set_is_user (sender, is_user);
380 empathy_contact_set_avatar (sender, avatar);
381 empathy_avatar_unref (avatar);
384 message = empathy_message_new (body);
385 empathy_message_set_sender (message, sender);
386 empathy_message_set_timestamp (message, t);
387 empathy_message_set_type (message, msg_type);
389 messages = g_list_append (messages, message);
391 g_object_unref (sender);
394 xmlFree (sender_name);
396 xmlFree (is_user_str);
397 xmlFree (msg_type_str);
400 empathy_debug (DEBUG_DOMAIN, "Parsed %d messages", g_list_length (messages));
403 xmlFreeParserCtxt (ctxt);
409 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
411 const gchar *chat_id,
418 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
419 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
420 g_return_val_if_fail (chat_id != NULL, NULL);
422 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
423 messages = empathy_log_manager_get_messages_for_file (manager, filename);
430 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
432 const gchar *chat_id,
435 GList *messages = NULL;
439 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
440 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
441 g_return_val_if_fail (chat_id != NULL, NULL);
443 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
445 l = g_list_last (dates);
447 messages = empathy_log_manager_get_messages_for_date (manager,
454 g_list_foreach (dates, (GFunc) g_free, NULL);
461 empathy_log_manager_get_chats (EmpathyLogManager *manager,
464 const gchar *basedir;
467 basedir = log_manager_get_basedir (manager);
468 dir = g_build_filename (basedir,
469 mc_account_get_unique_name (account),
472 return log_manager_get_chats (manager, dir, FALSE);
476 empathy_log_manager_search_new (EmpathyLogManager *manager,
481 gchar *text_casefold;
483 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
484 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
486 text_casefold = g_utf8_casefold (text, -1);
488 files = log_manager_get_all_files (manager, NULL);
489 empathy_debug (DEBUG_DOMAIN, "Found %d log files in total",
490 g_list_length (files));
492 for (l = files; l; l = l->next) {
497 gchar *contents_casefold;
501 file = g_mapped_file_new (filename, FALSE, NULL);
506 length = g_mapped_file_get_length (file);
507 contents = g_mapped_file_get_contents (file);
508 contents_casefold = g_utf8_casefold (contents, length);
510 g_mapped_file_free (file);
512 if (strstr (contents_casefold, text_casefold)) {
513 EmpathyLogSearchHit *hit;
515 hit = log_manager_search_hit_new (manager, filename);
518 hits = g_list_prepend (hits, hit);
519 empathy_debug (DEBUG_DOMAIN,
520 "Found text:'%s' in file:'%s' on date:'%s'...",
521 text, hit->filename, hit->date);
525 g_free (contents_casefold);
530 g_free (text_casefold);
536 empathy_log_manager_search_free (GList *hits)
540 for (l = hits; l; l = l->next) {
541 log_manager_search_hit_free (l->data);
547 /* Format is just date, 20061201. */
549 empathy_log_manager_get_date_readable (const gchar *date)
553 t = empathy_time_parse (date);
555 return empathy_time_to_string_local (t, "%a %d %b %Y");
559 log_manager_get_basedir (EmpathyLogManager *manager)
561 EmpathyLogManagerPriv *priv;
563 priv = GET_PRIV (manager);
566 return priv->basedir;
569 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
576 return priv->basedir;
580 log_manager_get_all_files (EmpathyLogManager *manager,
588 dir = log_manager_get_basedir (manager);
591 gdir = g_dir_open (dir, 0, NULL);
596 while ((name = g_dir_read_name (gdir)) != NULL) {
599 filename = g_build_filename (dir, name, NULL);
600 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
601 files = g_list_prepend (files, filename);
605 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
606 /* Recursively get all log files */
607 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
618 log_manager_get_chats (EmpathyLogManager *manager,
620 gboolean is_chatroom)
626 gdir = g_dir_open (dir, 0, NULL);
631 while ((name = g_dir_read_name (gdir)) != NULL) {
632 EmpathyLogSearchHit *hit;
635 filename = g_build_filename (dir, name, NULL);
636 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
637 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
642 hit = g_slice_new0 (EmpathyLogSearchHit);
643 hit->chat_id = g_strdup (name);
644 hit->is_chatroom = is_chatroom;
646 hits = g_list_prepend (hits, hit);
655 log_manager_get_dir (EmpathyLogManager *manager,
657 const gchar *chat_id,
660 const gchar *account_id;
663 account_id = mc_account_get_unique_name (account);
666 basedir = g_build_path (G_DIR_SEPARATOR_S,
667 log_manager_get_basedir (manager),
673 basedir = g_build_path (G_DIR_SEPARATOR_S,
674 log_manager_get_basedir (manager),
684 log_manager_get_filename (EmpathyLogManager *manager,
686 const gchar *chat_id,
693 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
694 timestamp = log_manager_get_timestamp_filename ();
695 filename = g_build_filename (basedir, timestamp, NULL);
704 log_manager_get_filename_for_date (EmpathyLogManager *manager,
706 const gchar *chat_id,
714 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
715 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
716 filename = g_build_filename (basedir, timestamp, NULL);
725 log_manager_get_timestamp_filename (void)
731 t = empathy_time_get_current ();
732 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
733 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
741 log_manager_get_timestamp_from_message (EmpathyMessage *message)
745 t = empathy_message_get_timestamp (message);
747 /* We keep the timestamps in the messages as UTC. */
748 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
751 static EmpathyLogSearchHit *
752 log_manager_search_hit_new (EmpathyLogManager *manager,
753 const gchar *filename)
755 EmpathyLogSearchHit *hit;
756 const gchar *account_name;
761 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
765 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
766 len = g_strv_length (strv);
768 hit = g_slice_new0 (EmpathyLogSearchHit);
770 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
771 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
772 hit->chat_id = g_strdup (strv[len-2]);
773 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
774 if (hit->is_chatroom) {
775 account_name = strv[len-4];
777 account_name = strv[len-3];
779 hit->account = mc_account_lookup (account_name);
780 hit->filename = g_strdup (filename);
788 log_manager_search_hit_free (EmpathyLogSearchHit *hit)
791 g_object_unref (hit->account);
795 g_free (hit->filename);
796 g_free (hit->chat_id);
798 g_slice_free (EmpathyLogSearchHit, hit);