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 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;
147 EmpathyMessageType msg_type;
149 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
150 g_return_if_fail (chat_id != NULL);
151 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
153 sender = empathy_message_get_sender (message);
154 account = empathy_contact_get_account (sender);
155 body_str = empathy_message_get_body (message);
156 msg_type = empathy_message_get_type (message);
158 if (G_STR_EMPTY (body_str)) {
162 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
163 basedir = g_path_get_dirname (filename);
164 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
165 empathy_debug (DEBUG_DOMAIN, "Creating directory:'%s'", basedir);
167 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
171 empathy_debug (DEBUG_DOMAIN, "Adding message: '%s' to file: '%s'",
174 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
175 file = g_fopen (filename, "w+");
177 g_fprintf (file, LOG_HEADER);
179 g_chmod (filename, LOG_FILE_CREATE_MODE);
181 file = g_fopen (filename, "r+");
183 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
187 body = g_markup_escape_text (body_str, -1);
188 timestamp = log_manager_get_timestamp_from_message (message);
190 str = empathy_contact_get_name (sender);
191 contact_name = g_markup_escape_text (str, -1);
193 str = empathy_contact_get_id (sender);
194 contact_id = g_markup_escape_text (str, -1);
197 "<message time='%s' id='%s' name='%s' isuser='%s' type='%s'>%s</message>\n" LOG_FOOTER,
201 empathy_contact_is_user (sender) ? "true" : "false",
202 empathy_message_type_to_str (msg_type),
208 g_free (contact_name);
214 empathy_log_manager_exists (EmpathyLogManager *manager,
216 const gchar *chat_id,
222 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
223 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
230 empathy_log_manager_get_dates (EmpathyLogManager *manager,
232 const gchar *chat_id,
239 const gchar *filename;
242 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
243 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
244 g_return_val_if_fail (chat_id != NULL, NULL);
246 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
247 dir = g_dir_open (directory, 0, NULL);
249 empathy_debug (DEBUG_DOMAIN, "Could not open directory:'%s'", directory);
254 empathy_debug (DEBUG_DOMAIN, "Collating a list of dates in:'%s'", directory);
256 while ((filename = g_dir_read_name (dir)) != NULL) {
257 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
261 p = strstr (filename, LOG_FILENAME_SUFFIX);
262 date = g_strndup (filename, p - filename);
267 if (!g_regex_match_simple ("\\d{8}", date, 0, 0)) {
271 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
277 empathy_debug (DEBUG_DOMAIN, "Parsed %d dates", g_list_length (dates));
283 empathy_log_manager_get_messages_for_file (EmpathyLogManager *manager,
284 const gchar *filename)
286 GList *messages = NULL;
287 xmlParserCtxtPtr ctxt;
291 EmpathyLogSearchHit *hit;
294 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
295 g_return_val_if_fail (filename != NULL, NULL);
297 empathy_debug (DEBUG_DOMAIN, "Attempting to parse filename:'%s'...", filename);
299 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
300 empathy_debug (DEBUG_DOMAIN, "Filename:'%s' does not exist", filename);
304 /* Get the account from the filename */
305 hit = log_manager_search_hit_new (manager, filename);
306 account = g_object_ref (hit->account);
307 log_manager_search_hit_free (hit);
310 ctxt = xmlNewParserCtxt ();
312 /* Parse and validate the file. */
313 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
315 g_warning ("Failed to parse file:'%s'", filename);
316 xmlFreeParserCtxt (ctxt);
320 /* The root node, presets. */
321 log_node = xmlDocGetRootElement (doc);
324 xmlFreeParserCtxt (ctxt);
328 /* Now get the messages. */
329 for (node = log_node->children; node; node = node->next) {
330 EmpathyMessage *message;
331 EmpathyContact *sender;
338 gboolean is_user = FALSE;
340 EmpathyMessageType msg_type = EMPATHY_MESSAGE_TYPE_NORMAL;
342 if (strcmp (node->name, "message") != 0) {
346 body = xmlNodeGetContent (node);
347 time = xmlGetProp (node, "time");
348 sender_id = xmlGetProp (node, "id");
349 sender_name = xmlGetProp (node, "name");
350 is_user_str = xmlGetProp (node, "isuser");
351 msg_type_str = xmlGetProp (node, "type");
354 is_user = strcmp (is_user_str, "true") == 0;
357 msg_type = empathy_message_type_from_str (msg_type_str);
360 t = empathy_time_parse (time);
362 sender = empathy_contact_new_full (account, sender_id, sender_name);
363 empathy_contact_set_is_user (sender, is_user);
364 message = empathy_message_new (body);
365 empathy_message_set_sender (message, sender);
366 empathy_message_set_timestamp (message, t);
367 empathy_message_set_type (message, msg_type);
369 messages = g_list_append (messages, message);
371 g_object_unref (sender);
374 xmlFree (sender_name);
376 xmlFree (is_user_str);
377 xmlFree (msg_type_str);
380 empathy_debug (DEBUG_DOMAIN, "Parsed %d messages", g_list_length (messages));
383 xmlFreeParserCtxt (ctxt);
389 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
391 const gchar *chat_id,
398 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
399 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
400 g_return_val_if_fail (chat_id != NULL, NULL);
402 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
403 messages = empathy_log_manager_get_messages_for_file (manager, filename);
410 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
412 const gchar *chat_id,
415 GList *messages = NULL;
419 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
420 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
421 g_return_val_if_fail (chat_id != NULL, NULL);
423 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
425 l = g_list_last (dates);
427 messages = empathy_log_manager_get_messages_for_date (manager,
434 g_list_foreach (dates, (GFunc) g_free, NULL);
441 empathy_log_manager_get_chats (EmpathyLogManager *manager,
444 const gchar *basedir;
447 basedir = log_manager_get_basedir (manager);
448 dir = g_build_filename (basedir,
449 mc_account_get_unique_name (account),
452 return log_manager_get_chats (manager, dir, FALSE);
456 empathy_log_manager_search_new (EmpathyLogManager *manager,
461 gchar *text_casefold;
463 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
464 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
466 text_casefold = g_utf8_casefold (text, -1);
468 files = log_manager_get_all_files (manager, NULL);
469 empathy_debug (DEBUG_DOMAIN, "Found %d log files in total",
470 g_list_length (files));
472 for (l = files; l; l = l->next) {
477 gchar *contents_casefold;
481 file = g_mapped_file_new (filename, FALSE, NULL);
486 length = g_mapped_file_get_length (file);
487 contents = g_mapped_file_get_contents (file);
488 contents_casefold = g_utf8_casefold (contents, length);
490 g_mapped_file_free (file);
492 if (strstr (contents_casefold, text_casefold)) {
493 EmpathyLogSearchHit *hit;
495 hit = log_manager_search_hit_new (manager, filename);
498 hits = g_list_prepend (hits, hit);
499 empathy_debug (DEBUG_DOMAIN,
500 "Found text:'%s' in file:'%s' on date:'%s'...",
501 text, hit->filename, hit->date);
505 g_free (contents_casefold);
510 g_free (text_casefold);
516 empathy_log_manager_search_free (GList *hits)
520 for (l = hits; l; l = l->next) {
521 log_manager_search_hit_free (l->data);
527 /* Format is just date, 20061201. */
529 empathy_log_manager_get_date_readable (const gchar *date)
533 t = empathy_time_parse (date);
535 return empathy_time_to_string_local (t, "%a %d %b %Y");
539 log_manager_get_basedir (EmpathyLogManager *manager)
541 EmpathyLogManagerPriv *priv;
543 priv = GET_PRIV (manager);
546 return priv->basedir;
549 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
556 return priv->basedir;
560 log_manager_get_all_files (EmpathyLogManager *manager,
568 dir = log_manager_get_basedir (manager);
571 gdir = g_dir_open (dir, 0, NULL);
576 while ((name = g_dir_read_name (gdir)) != NULL) {
579 filename = g_build_filename (dir, name, NULL);
580 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
581 files = g_list_prepend (files, filename);
585 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
586 /* Recursively get all log files */
587 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
598 log_manager_get_chats (EmpathyLogManager *manager,
600 gboolean is_chatroom)
606 gdir = g_dir_open (dir, 0, NULL);
611 while ((name = g_dir_read_name (gdir)) != NULL) {
612 EmpathyLogSearchHit *hit;
615 filename = g_build_filename (dir, name, NULL);
616 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
617 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
622 hit = g_slice_new0 (EmpathyLogSearchHit);
623 hit->chat_id = g_strdup (name);
624 hit->is_chatroom = is_chatroom;
626 hits = g_list_prepend (hits, hit);
635 log_manager_get_dir (EmpathyLogManager *manager,
637 const gchar *chat_id,
640 const gchar *account_id;
643 account_id = mc_account_get_unique_name (account);
646 basedir = g_build_path (G_DIR_SEPARATOR_S,
647 log_manager_get_basedir (manager),
653 basedir = g_build_path (G_DIR_SEPARATOR_S,
654 log_manager_get_basedir (manager),
664 log_manager_get_filename (EmpathyLogManager *manager,
666 const gchar *chat_id,
673 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
674 timestamp = log_manager_get_timestamp_filename ();
675 filename = g_build_filename (basedir, timestamp, NULL);
684 log_manager_get_filename_for_date (EmpathyLogManager *manager,
686 const gchar *chat_id,
694 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
695 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
696 filename = g_build_filename (basedir, timestamp, NULL);
705 log_manager_get_timestamp_filename (void)
711 t = empathy_time_get_current ();
712 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
713 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
721 log_manager_get_timestamp_from_message (EmpathyMessage *message)
725 t = empathy_message_get_timestamp (message);
727 /* We keep the timestamps in the messages as UTC. */
728 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
731 static EmpathyLogSearchHit *
732 log_manager_search_hit_new (EmpathyLogManager *manager,
733 const gchar *filename)
735 EmpathyLogSearchHit *hit;
736 const gchar *account_name;
741 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
745 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
746 len = g_strv_length (strv);
748 hit = g_slice_new0 (EmpathyLogSearchHit);
750 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
751 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
752 hit->chat_id = g_strdup (strv[len-2]);
753 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
754 if (hit->is_chatroom) {
755 account_name = strv[len-4];
757 account_name = strv[len-3];
759 hit->account = mc_account_lookup (account_name);
760 hit->filename = g_strdup (filename);
768 log_manager_search_hit_free (EmpathyLogSearchHit *hit)
771 g_object_unref (hit->account);
775 g_free (hit->filename);
776 g_free (hit->chat_id);
778 g_slice_free (EmpathyLogSearchHit, hit);