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>
27 #include <glib/gstdio.h>
29 #include "empathy-log-manager.h"
30 #include "empathy-contact.h"
31 #include "empathy-time.h"
32 #include "empathy-debug.h"
33 #include "empathy-utils.h"
35 #define GET_PRIV(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), \
36 EMPATHY_TYPE_LOG_MANAGER, EmpathyLogManagerPriv))
38 #define DEBUG_DOMAIN "LogManager"
40 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
41 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
42 #define LOG_DIR_CHATROOMS "chatrooms"
43 #define LOG_FILENAME_SUFFIX ".log"
44 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
45 #define LOG_TIME_FORMAT "%Y%m%d"
47 "<?xml version='1.0' encoding='utf-8'?>\n" \
48 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
54 struct _EmpathyLogManagerPriv {
58 static void empathy_log_manager_class_init (EmpathyLogManagerClass *klass);
59 static void empathy_log_manager_init (EmpathyLogManager *manager);
60 static void log_manager_finalize (GObject *object);
61 static const gchar * log_manager_get_basedir (EmpathyLogManager *manager);
62 static GList * log_manager_get_all_files (EmpathyLogManager *manager,
64 static GList * log_manager_get_chats (EmpathyLogManager *manager,
66 gboolean is_chatroom);
67 static gchar * log_manager_get_dir (EmpathyLogManager *manager,
71 static gchar * log_manager_get_filename (EmpathyLogManager *manager,
75 static gchar * log_manager_get_filename_for_date (EmpathyLogManager *manager,
80 static gchar * log_manager_get_timestamp_filename (void);
81 static gchar * log_manager_get_timestamp_from_message (EmpathyMessage *message);
82 static EmpathyLogSearchHit *log_manager_search_hit_new (EmpathyLogManager *manager,
83 const gchar *filename);
85 G_DEFINE_TYPE (EmpathyLogManager, empathy_log_manager, G_TYPE_OBJECT);
88 empathy_log_manager_class_init (EmpathyLogManagerClass *klass)
90 GObjectClass *object_class = G_OBJECT_CLASS (klass);
92 object_class->finalize = log_manager_finalize;
94 g_type_class_add_private (object_class, sizeof (EmpathyLogManagerPriv));
98 empathy_log_manager_init (EmpathyLogManager *manager)
103 log_manager_finalize (GObject *object)
105 EmpathyLogManagerPriv *priv;
107 priv = GET_PRIV (object);
109 g_free (priv->basedir);
113 empathy_log_manager_new (void)
115 static EmpathyLogManager *manager = NULL;
118 manager = g_object_new (EMPATHY_TYPE_LOG_MANAGER, NULL);
119 g_object_add_weak_pointer (G_OBJECT (manager), (gpointer) &manager);
121 g_object_ref (manager);
128 empathy_log_manager_add_message (EmpathyLogManager *manager,
129 const gchar *chat_id,
131 EmpathyMessage *message)
135 EmpathyContact *sender;
136 const gchar *body_str;
145 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
146 g_return_if_fail (chat_id != NULL);
147 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
149 sender = empathy_message_get_sender (message);
150 account = empathy_contact_get_account (sender);
151 body_str = empathy_message_get_body (message);
153 if (G_STR_EMPTY (body_str)) {
157 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
158 basedir = g_path_get_dirname (filename);
159 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
160 empathy_debug (DEBUG_DOMAIN, "Creating directory:'%s'", basedir);
162 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
166 empathy_debug (DEBUG_DOMAIN, "Adding message: '%s' to file: '%s'",
169 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
170 file = g_fopen (filename, "w+");
172 g_fprintf (file, LOG_HEADER);
174 g_chmod (filename, LOG_FILE_CREATE_MODE);
176 file = g_fopen (filename, "r+");
178 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
182 body = g_markup_escape_text (body_str, -1);
183 timestamp = log_manager_get_timestamp_from_message (message);
185 str = empathy_contact_get_name (sender);
186 contact_name = g_markup_escape_text (str, -1);
188 str = empathy_contact_get_id (sender);
189 contact_id = g_markup_escape_text (str, -1);
192 "<message time='%s' id='%s' name='%s' isuser='%s'>%s</message>\n" LOG_FOOTER,
196 empathy_contact_is_user (sender) ? "true" : "false",
202 g_free (contact_name);
208 empathy_log_manager_exists (EmpathyLogManager *manager,
210 const gchar *chat_id,
216 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
217 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
224 empathy_log_manager_get_dates (EmpathyLogManager *manager,
226 const gchar *chat_id,
233 const gchar *filename;
236 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
237 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
238 g_return_val_if_fail (chat_id != NULL, NULL);
240 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
241 dir = g_dir_open (directory, 0, NULL);
243 empathy_debug (DEBUG_DOMAIN, "Could not open directory:'%s'", directory);
248 empathy_debug (DEBUG_DOMAIN, "Collating a list of dates in:'%s'", directory);
250 while ((filename = g_dir_read_name (dir)) != NULL) {
251 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
255 p = strstr (filename, LOG_FILENAME_SUFFIX);
256 date = g_strndup (filename, p - filename);
261 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
267 empathy_debug (DEBUG_DOMAIN, "Parsed %d dates", g_list_length (dates));
273 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
275 const gchar *chat_id,
280 GList *messages = NULL;
281 xmlParserCtxtPtr ctxt;
286 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
287 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
288 g_return_val_if_fail (chat_id != NULL, NULL);
290 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
292 empathy_debug (DEBUG_DOMAIN, "Attempting to parse filename:'%s'...", filename);
294 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
295 empathy_debug (DEBUG_DOMAIN, "Filename:'%s' does not exist", filename);
301 ctxt = xmlNewParserCtxt ();
303 /* Parse and validate the file. */
304 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
306 g_warning ("Failed to parse file:'%s'", filename);
308 xmlFreeParserCtxt (ctxt);
312 /* The root node, presets. */
313 log_node = xmlDocGetRootElement (doc);
317 xmlFreeParserCtxt (ctxt);
321 /* Now get the messages. */
322 for (node = log_node->children; node; node = node->next) {
323 EmpathyMessage *message;
324 EmpathyContact *sender;
331 gboolean is_user = FALSE;
333 if (strcmp (node->name, "message") != 0) {
337 body = xmlNodeGetContent (node);
338 time = xmlGetProp (node, "time");
339 sender_id = xmlGetProp (node, "id");
340 sender_name = xmlGetProp (node, "name");
341 is_user_str = xmlGetProp (node, "isuser");
344 is_user = strcmp (is_user_str, "true") == 0;
347 t = empathy_time_parse (time);
349 sender = empathy_contact_new_full (account, sender_id, sender_name);
350 empathy_contact_set_is_user (sender, is_user);
351 message = empathy_message_new (body);
352 empathy_message_set_sender (message, sender);
353 empathy_message_set_timestamp (message, t);
355 messages = g_list_append (messages, message);
357 g_object_unref (sender);
360 xmlFree (sender_name);
364 empathy_debug (DEBUG_DOMAIN, "Parsed %d messages", g_list_length (messages));
368 xmlFreeParserCtxt (ctxt);
374 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
376 const gchar *chat_id,
379 GList *messages = NULL;
383 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
384 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
385 g_return_val_if_fail (chat_id != NULL, NULL);
387 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
389 l = g_list_last (dates);
391 messages = empathy_log_manager_get_messages_for_date (manager,
398 g_list_foreach (dates, (GFunc) g_free, NULL);
405 empathy_log_manager_get_chats (EmpathyLogManager *manager,
408 const gchar *basedir;
411 basedir = log_manager_get_basedir (manager);
412 dir = g_build_filename (basedir,
413 mc_account_get_unique_name (account),
416 return log_manager_get_chats (manager, dir, FALSE);
420 empathy_log_manager_search_new (EmpathyLogManager *manager,
425 gchar *text_casefold;
427 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
428 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
430 text_casefold = g_utf8_casefold (text, -1);
432 files = log_manager_get_all_files (manager, NULL);
433 empathy_debug (DEBUG_DOMAIN, "Found %d log files in total",
434 g_list_length (files));
436 for (l = files; l; l = l->next) {
441 gchar *contents_casefold;
445 file = g_mapped_file_new (filename, FALSE, NULL);
450 length = g_mapped_file_get_length (file);
451 contents = g_mapped_file_get_contents (file);
452 contents_casefold = g_utf8_casefold (contents, length);
454 g_mapped_file_free (file);
456 if (strstr (contents_casefold, text_casefold)) {
457 EmpathyLogSearchHit *hit;
459 hit = log_manager_search_hit_new (manager, filename);
462 hits = g_list_prepend (hits, hit);
463 empathy_debug (DEBUG_DOMAIN,
464 "Found text:'%s' in file:'%s' on date:'%s'...",
465 text, hit->filename, hit->date);
469 g_free (contents_casefold);
474 g_free (text_casefold);
480 empathy_log_manager_search_free (GList *hits)
483 EmpathyLogSearchHit *hit;
485 for (l = hits; l; l = l->next) {
489 g_object_unref (hit->account);
493 g_free (hit->filename);
494 g_free (hit->chat_id);
496 g_slice_free (EmpathyLogSearchHit, hit);
502 /* Format is just date, 20061201. */
504 empathy_log_manager_get_date_readable (const gchar *date)
508 t = empathy_time_parse (date);
510 return empathy_time_to_string_local (t, "%a %d %b %Y");
514 log_manager_get_basedir (EmpathyLogManager *manager)
516 EmpathyLogManagerPriv *priv;
518 priv = GET_PRIV (manager);
521 return priv->basedir;
524 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
531 return priv->basedir;
535 log_manager_get_all_files (EmpathyLogManager *manager,
543 dir = log_manager_get_basedir (manager);
546 gdir = g_dir_open (dir, 0, NULL);
551 while ((name = g_dir_read_name (gdir)) != NULL) {
554 filename = g_build_filename (dir, name, NULL);
555 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
556 files = g_list_prepend (files, filename);
560 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
561 /* Recursively get all log files */
562 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
573 log_manager_get_chats (EmpathyLogManager *manager,
575 gboolean is_chatroom)
581 gdir = g_dir_open (dir, 0, NULL);
586 while ((name = g_dir_read_name (gdir)) != NULL) {
587 EmpathyLogSearchHit *hit;
590 filename = g_build_filename (dir, name, NULL);
591 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
592 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
597 hit = g_slice_new0 (EmpathyLogSearchHit);
598 hit->chat_id = g_strdup (name);
599 hit->is_chatroom = is_chatroom;
601 hits = g_list_prepend (hits, hit);
610 log_manager_get_dir (EmpathyLogManager *manager,
612 const gchar *chat_id,
615 const gchar *account_id;
619 account_id = mc_account_get_unique_name (account);
621 str = g_build_path (G_DIR_SEPARATOR_S,
622 log_manager_get_basedir (manager),
628 basedir = g_build_path (G_DIR_SEPARATOR_S,
641 log_manager_get_filename (EmpathyLogManager *manager,
643 const gchar *chat_id,
650 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
651 timestamp = log_manager_get_timestamp_filename ();
652 filename = g_build_filename (basedir, timestamp, NULL);
661 log_manager_get_filename_for_date (EmpathyLogManager *manager,
663 const gchar *chat_id,
671 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
672 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
673 filename = g_build_filename (basedir, timestamp, NULL);
682 log_manager_get_timestamp_filename (void)
688 t = empathy_time_get_current ();
689 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
690 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
698 log_manager_get_timestamp_from_message (EmpathyMessage *message)
702 t = empathy_message_get_timestamp (message);
704 /* We keep the timestamps in the messages as UTC. */
705 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
708 static EmpathyLogSearchHit *
709 log_manager_search_hit_new (EmpathyLogManager *manager,
710 const gchar *filename)
712 EmpathyLogSearchHit *hit;
713 const gchar *account_name;
718 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
722 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
723 len = g_strv_length (strv);
725 hit = g_slice_new0 (EmpathyLogSearchHit);
727 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
728 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
729 hit->chat_id = g_strdup (strv[len-2]);
730 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
731 if (hit->is_chatroom) {
732 account_name = strv[len-4];
734 account_name = strv[len-3];
736 hit->account = mc_account_lookup (account_name);
737 hit->filename = g_strdup (filename);