1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2007 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>
28 #include <glib/gstdio.h>
30 #include "empathy-log-manager.h"
31 #include "empathy-contact.h"
32 #include "empathy-time.h"
33 #include "empathy-debug.h"
34 #include "empathy-utils.h"
36 #define GET_PRIV(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
37 EMPATHY_TYPE_LOG_MANAGER, EmpathyLogManagerPriv))
39 #define DEBUG_DOMAIN "LogManager"
41 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
42 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
43 #define LOG_DIR_CHATROOMS "chatrooms"
44 #define LOG_FILENAME_SUFFIX ".log"
45 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
46 #define LOG_TIME_FORMAT "%Y%m%d"
48 "<?xml version='1.0' encoding='utf-8'?>\n" \
49 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
55 struct _EmpathyLogManagerPriv {
59 static void empathy_log_manager_class_init (EmpathyLogManagerClass *klass);
60 static void empathy_log_manager_init (EmpathyLogManager *manager);
61 static void log_manager_finalize (GObject *object);
62 static const gchar * log_manager_get_basedir (EmpathyLogManager *manager);
63 static GList * log_manager_get_all_files (EmpathyLogManager *manager,
65 static GList * log_manager_get_chats (EmpathyLogManager *manager,
67 gboolean is_chatroom);
68 static gchar * log_manager_get_dir (EmpathyLogManager *manager,
72 static gchar * log_manager_get_filename (EmpathyLogManager *manager,
76 static gchar * log_manager_get_filename_for_date (EmpathyLogManager *manager,
81 static gchar * log_manager_get_timestamp_filename (void);
82 static gchar * log_manager_get_timestamp_from_message (EmpathyMessage *message);
83 static EmpathyLogSearchHit *log_manager_search_hit_new (EmpathyLogManager *manager,
84 const gchar *filename);
85 static void log_manager_search_hit_free (EmpathyLogSearchHit *hit);
87 G_DEFINE_TYPE (EmpathyLogManager, empathy_log_manager, G_TYPE_OBJECT);
90 empathy_log_manager_class_init (EmpathyLogManagerClass *klass)
92 GObjectClass *object_class = G_OBJECT_CLASS (klass);
94 object_class->finalize = log_manager_finalize;
96 g_type_class_add_private (object_class, sizeof (EmpathyLogManagerPriv));
100 empathy_log_manager_init (EmpathyLogManager *manager)
105 log_manager_finalize (GObject *object)
107 EmpathyLogManagerPriv *priv;
109 priv = GET_PRIV (object);
111 g_free (priv->basedir);
115 empathy_log_manager_new (void)
117 static EmpathyLogManager *manager = NULL;
120 manager = g_object_new (EMPATHY_TYPE_LOG_MANAGER, NULL);
121 g_object_add_weak_pointer (G_OBJECT (manager), (gpointer) &manager);
123 g_object_ref (manager);
130 empathy_log_manager_add_message (EmpathyLogManager *manager,
131 const gchar *chat_id,
133 EmpathyMessage *message)
137 EmpathyContact *sender;
138 const gchar *body_str;
146 EmpathyMessageType msg_type;
148 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
149 g_return_if_fail (chat_id != NULL);
150 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
152 sender = empathy_message_get_sender (message);
153 account = empathy_contact_get_account (sender);
154 body_str = empathy_message_get_body (message);
155 msg_type = empathy_message_get_type (message);
157 if (G_STR_EMPTY (body_str)) {
161 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
162 basedir = g_path_get_dirname (filename);
163 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
164 empathy_debug (DEBUG_DOMAIN, "Creating directory:'%s'", basedir);
166 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
170 empathy_debug (DEBUG_DOMAIN, "Adding message: '%s' to file: '%s'",
173 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
174 file = g_fopen (filename, "w+");
176 g_fprintf (file, LOG_HEADER);
178 g_chmod (filename, LOG_FILE_CREATE_MODE);
180 file = g_fopen (filename, "r+");
182 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
186 body = g_markup_escape_text (body_str, -1);
187 timestamp = log_manager_get_timestamp_from_message (message);
189 str = empathy_contact_get_name (sender);
190 contact_name = g_markup_escape_text (str, -1);
192 str = empathy_contact_get_id (sender);
193 contact_id = g_markup_escape_text (str, -1);
196 "<message time='%s' id='%s' name='%s' isuser='%s' type='%s'>%s</message>\n" LOG_FOOTER,
200 empathy_contact_is_user (sender) ? "true" : "false",
201 empathy_message_type_to_str (msg_type),
207 g_free (contact_name);
213 empathy_log_manager_exists (EmpathyLogManager *manager,
215 const gchar *chat_id,
221 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
222 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
229 empathy_log_manager_get_dates (EmpathyLogManager *manager,
231 const gchar *chat_id,
238 const gchar *filename;
241 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
242 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
243 g_return_val_if_fail (chat_id != NULL, NULL);
245 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
246 dir = g_dir_open (directory, 0, NULL);
248 empathy_debug (DEBUG_DOMAIN, "Could not open directory:'%s'", directory);
253 empathy_debug (DEBUG_DOMAIN, "Collating a list of dates in:'%s'", directory);
255 while ((filename = g_dir_read_name (dir)) != NULL) {
256 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
260 p = strstr (filename, LOG_FILENAME_SUFFIX);
261 date = g_strndup (filename, p - filename);
266 if (!g_regex_match_simple ("\\d{8}", date, 0, 0)) {
270 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
276 empathy_debug (DEBUG_DOMAIN, "Parsed %d dates", g_list_length (dates));
282 empathy_log_manager_get_messages_for_file (EmpathyLogManager *manager,
283 const gchar *filename)
285 GList *messages = NULL;
286 xmlParserCtxtPtr ctxt;
290 EmpathyLogSearchHit *hit;
293 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
294 g_return_val_if_fail (filename != NULL, NULL);
296 empathy_debug (DEBUG_DOMAIN, "Attempting to parse filename:'%s'...", filename);
298 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
299 empathy_debug (DEBUG_DOMAIN, "Filename:'%s' does not exist", filename);
303 /* Get the account from the filename */
304 hit = log_manager_search_hit_new (manager, filename);
305 account = g_object_ref (hit->account);
306 log_manager_search_hit_free (hit);
309 ctxt = xmlNewParserCtxt ();
311 /* Parse and validate the file. */
312 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
314 g_warning ("Failed to parse file:'%s'", filename);
315 xmlFreeParserCtxt (ctxt);
319 /* The root node, presets. */
320 log_node = xmlDocGetRootElement (doc);
323 xmlFreeParserCtxt (ctxt);
327 /* Now get the messages. */
328 for (node = log_node->children; node; node = node->next) {
329 EmpathyMessage *message;
330 EmpathyContact *sender;
337 gboolean is_user = FALSE;
339 EmpathyMessageType msg_type = EMPATHY_MESSAGE_TYPE_NORMAL;
341 if (strcmp (node->name, "message") != 0) {
345 body = xmlNodeGetContent (node);
346 time = xmlGetProp (node, "time");
347 sender_id = xmlGetProp (node, "id");
348 sender_name = xmlGetProp (node, "name");
349 is_user_str = xmlGetProp (node, "isuser");
350 msg_type_str = xmlGetProp (node, "type");
353 is_user = strcmp (is_user_str, "true") == 0;
356 msg_type = empathy_message_type_from_str (msg_type_str);
359 t = empathy_time_parse (time);
361 sender = empathy_contact_new_full (account, sender_id, sender_name);
362 empathy_contact_set_is_user (sender, is_user);
363 message = empathy_message_new (body);
364 empathy_message_set_sender (message, sender);
365 empathy_message_set_timestamp (message, t);
366 empathy_message_set_type (message, msg_type);
368 messages = g_list_append (messages, message);
370 g_object_unref (sender);
373 xmlFree (sender_name);
375 xmlFree (is_user_str);
376 xmlFree (msg_type_str);
379 empathy_debug (DEBUG_DOMAIN, "Parsed %d messages", g_list_length (messages));
382 xmlFreeParserCtxt (ctxt);
388 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
390 const gchar *chat_id,
397 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
398 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
399 g_return_val_if_fail (chat_id != NULL, NULL);
401 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
402 messages = empathy_log_manager_get_messages_for_file (manager, filename);
409 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
411 const gchar *chat_id,
414 GList *messages = NULL;
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 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
424 l = g_list_last (dates);
426 messages = empathy_log_manager_get_messages_for_date (manager,
433 g_list_foreach (dates, (GFunc) g_free, NULL);
440 empathy_log_manager_get_chats (EmpathyLogManager *manager,
443 const gchar *basedir;
446 basedir = log_manager_get_basedir (manager);
447 dir = g_build_filename (basedir,
448 mc_account_get_unique_name (account),
451 return log_manager_get_chats (manager, dir, FALSE);
455 empathy_log_manager_search_new (EmpathyLogManager *manager,
460 gchar *text_casefold;
462 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
463 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
465 text_casefold = g_utf8_casefold (text, -1);
467 files = log_manager_get_all_files (manager, NULL);
468 empathy_debug (DEBUG_DOMAIN, "Found %d log files in total",
469 g_list_length (files));
471 for (l = files; l; l = l->next) {
476 gchar *contents_casefold;
480 file = g_mapped_file_new (filename, FALSE, NULL);
485 length = g_mapped_file_get_length (file);
486 contents = g_mapped_file_get_contents (file);
487 contents_casefold = g_utf8_casefold (contents, length);
489 g_mapped_file_free (file);
491 if (strstr (contents_casefold, text_casefold)) {
492 EmpathyLogSearchHit *hit;
494 hit = log_manager_search_hit_new (manager, filename);
497 hits = g_list_prepend (hits, hit);
498 empathy_debug (DEBUG_DOMAIN,
499 "Found text:'%s' in file:'%s' on date:'%s'...",
500 text, hit->filename, hit->date);
504 g_free (contents_casefold);
509 g_free (text_casefold);
515 empathy_log_manager_search_free (GList *hits)
519 for (l = hits; l; l = l->next) {
520 log_manager_search_hit_free (l->data);
526 /* Format is just date, 20061201. */
528 empathy_log_manager_get_date_readable (const gchar *date)
532 t = empathy_time_parse (date);
534 return empathy_time_to_string_local (t, "%a %d %b %Y");
538 log_manager_get_basedir (EmpathyLogManager *manager)
540 EmpathyLogManagerPriv *priv;
542 priv = GET_PRIV (manager);
545 return priv->basedir;
548 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
555 return priv->basedir;
559 log_manager_get_all_files (EmpathyLogManager *manager,
567 dir = log_manager_get_basedir (manager);
570 gdir = g_dir_open (dir, 0, NULL);
575 while ((name = g_dir_read_name (gdir)) != NULL) {
578 filename = g_build_filename (dir, name, NULL);
579 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
580 files = g_list_prepend (files, filename);
584 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
585 /* Recursively get all log files */
586 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
597 log_manager_get_chats (EmpathyLogManager *manager,
599 gboolean is_chatroom)
605 gdir = g_dir_open (dir, 0, NULL);
610 while ((name = g_dir_read_name (gdir)) != NULL) {
611 EmpathyLogSearchHit *hit;
614 filename = g_build_filename (dir, name, NULL);
615 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
616 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
621 hit = g_slice_new0 (EmpathyLogSearchHit);
622 hit->chat_id = g_strdup (name);
623 hit->is_chatroom = is_chatroom;
625 hits = g_list_prepend (hits, hit);
634 log_manager_get_dir (EmpathyLogManager *manager,
636 const gchar *chat_id,
639 const gchar *account_id;
642 account_id = mc_account_get_unique_name (account);
645 basedir = g_build_path (G_DIR_SEPARATOR_S,
646 log_manager_get_basedir (manager),
652 basedir = g_build_path (G_DIR_SEPARATOR_S,
653 log_manager_get_basedir (manager),
663 log_manager_get_filename (EmpathyLogManager *manager,
665 const gchar *chat_id,
672 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
673 timestamp = log_manager_get_timestamp_filename ();
674 filename = g_build_filename (basedir, timestamp, NULL);
683 log_manager_get_filename_for_date (EmpathyLogManager *manager,
685 const gchar *chat_id,
693 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
694 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
695 filename = g_build_filename (basedir, timestamp, NULL);
704 log_manager_get_timestamp_filename (void)
710 t = empathy_time_get_current ();
711 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
712 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
720 log_manager_get_timestamp_from_message (EmpathyMessage *message)
724 t = empathy_message_get_timestamp (message);
726 /* We keep the timestamps in the messages as UTC. */
727 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
730 static EmpathyLogSearchHit *
731 log_manager_search_hit_new (EmpathyLogManager *manager,
732 const gchar *filename)
734 EmpathyLogSearchHit *hit;
735 const gchar *account_name;
740 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
744 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
745 len = g_strv_length (strv);
747 hit = g_slice_new0 (EmpathyLogSearchHit);
749 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
750 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
751 hit->chat_id = g_strdup (strv[len-2]);
752 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
753 if (hit->is_chatroom) {
754 account_name = strv[len-4];
756 account_name = strv[len-3];
758 hit->account = mc_account_lookup (account_name);
759 hit->filename = g_strdup (filename);
767 log_manager_search_hit_free (EmpathyLogSearchHit *hit)
770 g_object_unref (hit->account);
774 g_free (hit->filename);
775 g_free (hit->chat_id);
777 g_slice_free (EmpathyLogSearchHit, hit);