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);
84 static void log_manager_search_hit_free (EmpathyLogSearchHit *hit);
86 G_DEFINE_TYPE (EmpathyLogManager, empathy_log_manager, G_TYPE_OBJECT);
89 empathy_log_manager_class_init (EmpathyLogManagerClass *klass)
91 GObjectClass *object_class = G_OBJECT_CLASS (klass);
93 object_class->finalize = log_manager_finalize;
95 g_type_class_add_private (object_class, sizeof (EmpathyLogManagerPriv));
99 empathy_log_manager_init (EmpathyLogManager *manager)
104 log_manager_finalize (GObject *object)
106 EmpathyLogManagerPriv *priv;
108 priv = GET_PRIV (object);
110 g_free (priv->basedir);
114 empathy_log_manager_new (void)
116 static EmpathyLogManager *manager = NULL;
119 manager = g_object_new (EMPATHY_TYPE_LOG_MANAGER, NULL);
120 g_object_add_weak_pointer (G_OBJECT (manager), (gpointer) &manager);
122 g_object_ref (manager);
129 empathy_log_manager_add_message (EmpathyLogManager *manager,
130 const gchar *chat_id,
132 EmpathyMessage *message)
136 EmpathyContact *sender;
137 const gchar *body_str;
146 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
147 g_return_if_fail (chat_id != NULL);
148 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
150 sender = empathy_message_get_sender (message);
151 account = empathy_contact_get_account (sender);
152 body_str = empathy_message_get_body (message);
154 if (G_STR_EMPTY (body_str)) {
158 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
159 basedir = g_path_get_dirname (filename);
160 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
161 empathy_debug (DEBUG_DOMAIN, "Creating directory:'%s'", basedir);
163 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
167 empathy_debug (DEBUG_DOMAIN, "Adding message: '%s' to file: '%s'",
170 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
171 file = g_fopen (filename, "w+");
173 g_fprintf (file, LOG_HEADER);
175 g_chmod (filename, LOG_FILE_CREATE_MODE);
177 file = g_fopen (filename, "r+");
179 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
183 body = g_markup_escape_text (body_str, -1);
184 timestamp = log_manager_get_timestamp_from_message (message);
186 str = empathy_contact_get_name (sender);
187 contact_name = g_markup_escape_text (str, -1);
189 str = empathy_contact_get_id (sender);
190 contact_id = g_markup_escape_text (str, -1);
193 "<message time='%s' id='%s' name='%s' isuser='%s'>%s</message>\n" LOG_FOOTER,
197 empathy_contact_is_user (sender) ? "true" : "false",
203 g_free (contact_name);
209 empathy_log_manager_exists (EmpathyLogManager *manager,
211 const gchar *chat_id,
217 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
218 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
225 empathy_log_manager_get_dates (EmpathyLogManager *manager,
227 const gchar *chat_id,
234 const gchar *filename;
237 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
238 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
239 g_return_val_if_fail (chat_id != NULL, NULL);
241 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
242 dir = g_dir_open (directory, 0, NULL);
244 empathy_debug (DEBUG_DOMAIN, "Could not open directory:'%s'", directory);
249 empathy_debug (DEBUG_DOMAIN, "Collating a list of dates in:'%s'", directory);
251 while ((filename = g_dir_read_name (dir)) != NULL) {
252 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
256 p = strstr (filename, LOG_FILENAME_SUFFIX);
257 date = g_strndup (filename, p - filename);
262 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
268 empathy_debug (DEBUG_DOMAIN, "Parsed %d dates", g_list_length (dates));
274 empathy_log_manager_get_messages_for_file (EmpathyLogManager *manager,
275 const gchar *filename)
277 GList *messages = NULL;
278 xmlParserCtxtPtr ctxt;
282 EmpathyLogSearchHit *hit;
285 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
286 g_return_val_if_fail (filename != NULL, NULL);
288 empathy_debug (DEBUG_DOMAIN, "Attempting to parse filename:'%s'...", filename);
290 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
291 empathy_debug (DEBUG_DOMAIN, "Filename:'%s' does not exist", filename);
295 /* Get the account from the filename */
296 hit = log_manager_search_hit_new (manager, filename);
297 account = g_object_ref (hit->account);
298 log_manager_search_hit_free (hit);
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);
307 xmlFreeParserCtxt (ctxt);
311 /* The root node, presets. */
312 log_node = xmlDocGetRootElement (doc);
315 xmlFreeParserCtxt (ctxt);
319 /* Now get the messages. */
320 for (node = log_node->children; node; node = node->next) {
321 EmpathyMessage *message;
322 EmpathyContact *sender;
329 gboolean is_user = FALSE;
331 if (strcmp (node->name, "message") != 0) {
335 body = xmlNodeGetContent (node);
336 time = xmlGetProp (node, "time");
337 sender_id = xmlGetProp (node, "id");
338 sender_name = xmlGetProp (node, "name");
339 is_user_str = xmlGetProp (node, "isuser");
342 is_user = strcmp (is_user_str, "true") == 0;
345 t = empathy_time_parse (time);
347 sender = empathy_contact_new_full (account, sender_id, sender_name);
348 empathy_contact_set_is_user (sender, is_user);
349 message = empathy_message_new (body);
350 empathy_message_set_sender (message, sender);
351 empathy_message_set_timestamp (message, t);
353 messages = g_list_append (messages, message);
355 g_object_unref (sender);
358 xmlFree (sender_name);
362 empathy_debug (DEBUG_DOMAIN, "Parsed %d messages", g_list_length (messages));
365 xmlFreeParserCtxt (ctxt);
371 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
373 const gchar *chat_id,
380 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
381 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
382 g_return_val_if_fail (chat_id != NULL, NULL);
384 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
385 messages = empathy_log_manager_get_messages_for_file (manager, filename);
392 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
394 const gchar *chat_id,
397 GList *messages = NULL;
401 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
402 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
403 g_return_val_if_fail (chat_id != NULL, NULL);
405 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
407 l = g_list_last (dates);
409 messages = empathy_log_manager_get_messages_for_date (manager,
416 g_list_foreach (dates, (GFunc) g_free, NULL);
423 empathy_log_manager_get_chats (EmpathyLogManager *manager,
426 const gchar *basedir;
429 basedir = log_manager_get_basedir (manager);
430 dir = g_build_filename (basedir,
431 mc_account_get_unique_name (account),
434 return log_manager_get_chats (manager, dir, FALSE);
438 empathy_log_manager_search_new (EmpathyLogManager *manager,
443 gchar *text_casefold;
445 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
446 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
448 text_casefold = g_utf8_casefold (text, -1);
450 files = log_manager_get_all_files (manager, NULL);
451 empathy_debug (DEBUG_DOMAIN, "Found %d log files in total",
452 g_list_length (files));
454 for (l = files; l; l = l->next) {
459 gchar *contents_casefold;
463 file = g_mapped_file_new (filename, FALSE, NULL);
468 length = g_mapped_file_get_length (file);
469 contents = g_mapped_file_get_contents (file);
470 contents_casefold = g_utf8_casefold (contents, length);
472 g_mapped_file_free (file);
474 if (strstr (contents_casefold, text_casefold)) {
475 EmpathyLogSearchHit *hit;
477 hit = log_manager_search_hit_new (manager, filename);
480 hits = g_list_prepend (hits, hit);
481 empathy_debug (DEBUG_DOMAIN,
482 "Found text:'%s' in file:'%s' on date:'%s'...",
483 text, hit->filename, hit->date);
487 g_free (contents_casefold);
492 g_free (text_casefold);
498 empathy_log_manager_search_free (GList *hits)
502 for (l = hits; l; l = l->next) {
503 log_manager_search_hit_free (l->data);
509 /* Format is just date, 20061201. */
511 empathy_log_manager_get_date_readable (const gchar *date)
515 t = empathy_time_parse (date);
517 return empathy_time_to_string_local (t, "%a %d %b %Y");
521 log_manager_get_basedir (EmpathyLogManager *manager)
523 EmpathyLogManagerPriv *priv;
525 priv = GET_PRIV (manager);
528 return priv->basedir;
531 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
538 return priv->basedir;
542 log_manager_get_all_files (EmpathyLogManager *manager,
550 dir = log_manager_get_basedir (manager);
553 gdir = g_dir_open (dir, 0, NULL);
558 while ((name = g_dir_read_name (gdir)) != NULL) {
561 filename = g_build_filename (dir, name, NULL);
562 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
563 files = g_list_prepend (files, filename);
567 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
568 /* Recursively get all log files */
569 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
580 log_manager_get_chats (EmpathyLogManager *manager,
582 gboolean is_chatroom)
588 gdir = g_dir_open (dir, 0, NULL);
593 while ((name = g_dir_read_name (gdir)) != NULL) {
594 EmpathyLogSearchHit *hit;
597 filename = g_build_filename (dir, name, NULL);
598 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
599 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
604 hit = g_slice_new0 (EmpathyLogSearchHit);
605 hit->chat_id = g_strdup (name);
606 hit->is_chatroom = is_chatroom;
608 hits = g_list_prepend (hits, hit);
617 log_manager_get_dir (EmpathyLogManager *manager,
619 const gchar *chat_id,
622 const gchar *account_id;
626 account_id = mc_account_get_unique_name (account);
628 str = g_build_path (G_DIR_SEPARATOR_S,
629 log_manager_get_basedir (manager),
635 basedir = g_build_path (G_DIR_SEPARATOR_S,
648 log_manager_get_filename (EmpathyLogManager *manager,
650 const gchar *chat_id,
657 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
658 timestamp = log_manager_get_timestamp_filename ();
659 filename = g_build_filename (basedir, timestamp, NULL);
668 log_manager_get_filename_for_date (EmpathyLogManager *manager,
670 const gchar *chat_id,
678 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
679 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
680 filename = g_build_filename (basedir, timestamp, NULL);
689 log_manager_get_timestamp_filename (void)
695 t = empathy_time_get_current ();
696 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
697 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
705 log_manager_get_timestamp_from_message (EmpathyMessage *message)
709 t = empathy_message_get_timestamp (message);
711 /* We keep the timestamps in the messages as UTC. */
712 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
715 static EmpathyLogSearchHit *
716 log_manager_search_hit_new (EmpathyLogManager *manager,
717 const gchar *filename)
719 EmpathyLogSearchHit *hit;
720 const gchar *account_name;
725 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
729 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
730 len = g_strv_length (strv);
732 hit = g_slice_new0 (EmpathyLogSearchHit);
734 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
735 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
736 hit->chat_id = g_strdup (strv[len-2]);
737 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
738 if (hit->is_chatroom) {
739 account_name = strv[len-4];
741 account_name = strv[len-3];
743 hit->account = mc_account_lookup (account_name);
744 hit->filename = g_strdup (filename);
752 log_manager_search_hit_free (EmpathyLogSearchHit *hit)
755 g_object_unref (hit->account);
759 g_free (hit->filename);
760 g_free (hit->chat_id);
762 g_slice_free (EmpathyLogSearchHit, hit);