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-utils.h"
36 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
37 #include "empathy-debug.h"
39 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
40 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
41 #define LOG_DIR_CHATROOMS "chatrooms"
42 #define LOG_FILENAME_SUFFIX ".log"
43 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
44 #define LOG_TIME_FORMAT "%Y%m%d"
46 "<?xml version='1.0' encoding='utf-8'?>\n" \
47 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
53 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLogManager)
56 } EmpathyLogManagerPriv;
58 static void log_manager_finalize (GObject *object);
59 static const gchar * log_manager_get_basedir (EmpathyLogManager *manager);
60 static GList * log_manager_get_all_files (EmpathyLogManager *manager,
62 static GList * log_manager_get_chats (EmpathyLogManager *manager,
64 gboolean is_chatroom);
65 static gchar * log_manager_get_dir (EmpathyLogManager *manager,
69 static gchar * log_manager_get_filename (EmpathyLogManager *manager,
73 static gchar * log_manager_get_filename_for_date (EmpathyLogManager *manager,
78 static gchar * log_manager_get_timestamp_filename (void);
79 static gchar * log_manager_get_timestamp_from_message (EmpathyMessage *message);
80 static EmpathyLogSearchHit *log_manager_search_hit_new (EmpathyLogManager *manager,
81 const gchar *filename);
82 static void log_manager_search_hit_free (EmpathyLogSearchHit *hit);
84 G_DEFINE_TYPE (EmpathyLogManager, empathy_log_manager, G_TYPE_OBJECT);
87 empathy_log_manager_class_init (EmpathyLogManagerClass *klass)
89 GObjectClass *object_class = G_OBJECT_CLASS (klass);
91 object_class->finalize = log_manager_finalize;
93 g_type_class_add_private (object_class, sizeof (EmpathyLogManagerPriv));
97 empathy_log_manager_init (EmpathyLogManager *manager)
99 EmpathyLogManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
100 EMPATHY_TYPE_LOG_MANAGER, EmpathyLogManagerPriv);
102 manager->priv = priv;
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 TpChannelTextMessageType 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_tptype (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 DEBUG ("Creating directory:'%s'", basedir);
169 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
173 DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
175 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
176 file = g_fopen (filename, "w+");
178 g_fprintf (file, LOG_HEADER);
180 g_chmod (filename, LOG_FILE_CREATE_MODE);
182 file = g_fopen (filename, "r+");
184 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
188 body = g_markup_escape_text (body_str, -1);
189 timestamp = log_manager_get_timestamp_from_message (message);
191 str = empathy_contact_get_name (sender);
192 contact_name = g_markup_escape_text (str, -1);
194 str = empathy_contact_get_id (sender);
195 contact_id = g_markup_escape_text (str, -1);
197 avatar = empathy_contact_get_avatar (sender);
199 avatar_token = g_markup_escape_text (avatar->token, -1);
203 "<message time='%s' id='%s' name='%s' token='%s' isuser='%s' type='%s'>%s</message>\n" LOG_FOOTER,
207 avatar_token ? avatar_token : "",
208 empathy_contact_is_user (sender) ? "true" : "false",
209 empathy_message_type_to_str (msg_type),
215 g_free (contact_name);
218 g_free (avatar_token);
222 empathy_log_manager_exists (EmpathyLogManager *manager,
224 const gchar *chat_id,
230 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
231 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
238 empathy_log_manager_get_dates (EmpathyLogManager *manager,
240 const gchar *chat_id,
247 const gchar *filename;
250 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
251 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
252 g_return_val_if_fail (chat_id != NULL, NULL);
254 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
255 dir = g_dir_open (directory, 0, NULL);
257 DEBUG ("Could not open directory:'%s'", directory);
262 DEBUG ("Collating a list of dates in:'%s'", directory);
264 while ((filename = g_dir_read_name (dir)) != NULL) {
265 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
269 p = strstr (filename, LOG_FILENAME_SUFFIX);
270 date = g_strndup (filename, p - filename);
275 if (!g_regex_match_simple ("\\d{8}", date, 0, 0)) {
279 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
285 DEBUG ("Parsed %d dates", g_list_length (dates));
291 empathy_log_manager_get_messages_for_file (EmpathyLogManager *manager,
292 const gchar *filename)
294 GList *messages = NULL;
295 xmlParserCtxtPtr ctxt;
299 EmpathyLogSearchHit *hit;
302 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
303 g_return_val_if_fail (filename != NULL, NULL);
305 DEBUG ("Attempting to parse filename:'%s'...", filename);
307 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
308 DEBUG ("Filename:'%s' does not exist", filename);
312 /* Get the account from the filename */
313 hit = log_manager_search_hit_new (manager, filename);
314 account = g_object_ref (hit->account);
315 log_manager_search_hit_free (hit);
318 ctxt = xmlNewParserCtxt ();
320 /* Parse and validate the file. */
321 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
323 g_warning ("Failed to parse file:'%s'", filename);
324 xmlFreeParserCtxt (ctxt);
328 /* The root node, presets. */
329 log_node = xmlDocGetRootElement (doc);
332 xmlFreeParserCtxt (ctxt);
336 /* Now get the messages. */
337 for (node = log_node->children; node; node = node->next) {
338 EmpathyMessage *message;
339 EmpathyContact *sender;
340 EmpathyAvatar *avatar = NULL;
345 gchar *sender_avatar_token;
348 gboolean is_user = FALSE;
350 TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
352 if (strcmp (node->name, "message") != 0) {
356 body = xmlNodeGetContent (node);
357 time = xmlGetProp (node, "time");
358 sender_id = xmlGetProp (node, "id");
359 sender_name = xmlGetProp (node, "name");
360 sender_avatar_token = xmlGetProp (node, "token");
361 is_user_str = xmlGetProp (node, "isuser");
362 msg_type_str = xmlGetProp (node, "type");
364 if (!G_STR_EMPTY (sender_avatar_token)) {
365 avatar = empathy_avatar_new_from_cache (sender_avatar_token);
368 is_user = strcmp (is_user_str, "true") == 0;
371 msg_type = empathy_message_type_from_str (msg_type_str);
374 t = empathy_time_parse (time);
376 sender = empathy_contact_new_full (account, sender_id, sender_name);
377 empathy_contact_set_is_user (sender, is_user);
379 empathy_contact_set_avatar (sender, avatar);
380 empathy_avatar_unref (avatar);
383 message = empathy_message_new (body);
384 empathy_message_set_sender (message, sender);
385 empathy_message_set_timestamp (message, t);
386 empathy_message_set_tptype (message, msg_type);
388 messages = g_list_append (messages, message);
390 g_object_unref (sender);
393 xmlFree (sender_name);
395 xmlFree (is_user_str);
396 xmlFree (msg_type_str);
399 DEBUG ("Parsed %d messages", g_list_length (messages));
402 xmlFreeParserCtxt (ctxt);
408 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
410 const gchar *chat_id,
417 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
418 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
419 g_return_val_if_fail (chat_id != NULL, NULL);
421 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
422 messages = empathy_log_manager_get_messages_for_file (manager, filename);
429 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
431 const gchar *chat_id,
434 GList *messages = NULL;
438 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
439 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
440 g_return_val_if_fail (chat_id != NULL, NULL);
442 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
444 l = g_list_last (dates);
446 messages = empathy_log_manager_get_messages_for_date (manager,
453 g_list_foreach (dates, (GFunc) g_free, NULL);
460 empathy_log_manager_get_chats (EmpathyLogManager *manager,
463 const gchar *basedir;
466 basedir = log_manager_get_basedir (manager);
467 dir = g_build_filename (basedir,
468 mc_account_get_unique_name (account),
471 return log_manager_get_chats (manager, dir, FALSE);
475 empathy_log_manager_search_new (EmpathyLogManager *manager,
480 gchar *text_casefold;
482 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
483 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
485 text_casefold = g_utf8_casefold (text, -1);
487 files = log_manager_get_all_files (manager, NULL);
488 DEBUG ("Found %d log files in total", g_list_length (files));
490 for (l = files; l; l = l->next) {
495 gchar *contents_casefold;
499 file = g_mapped_file_new (filename, FALSE, NULL);
504 length = g_mapped_file_get_length (file);
505 contents = g_mapped_file_get_contents (file);
506 contents_casefold = g_utf8_casefold (contents, length);
508 g_mapped_file_free (file);
510 if (strstr (contents_casefold, text_casefold)) {
511 EmpathyLogSearchHit *hit;
513 hit = log_manager_search_hit_new (manager, filename);
516 hits = g_list_prepend (hits, hit);
517 DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
518 text, hit->filename, hit->date);
522 g_free (contents_casefold);
527 g_free (text_casefold);
533 empathy_log_manager_search_free (GList *hits)
537 for (l = hits; l; l = l->next) {
538 log_manager_search_hit_free (l->data);
544 /* Format is just date, 20061201. */
546 empathy_log_manager_get_date_readable (const gchar *date)
550 t = empathy_time_parse (date);
552 return empathy_time_to_string_local (t, "%a %d %b %Y");
556 log_manager_get_basedir (EmpathyLogManager *manager)
558 EmpathyLogManagerPriv *priv;
560 priv = GET_PRIV (manager);
563 return priv->basedir;
566 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
573 return priv->basedir;
577 log_manager_get_all_files (EmpathyLogManager *manager,
585 dir = log_manager_get_basedir (manager);
588 gdir = g_dir_open (dir, 0, NULL);
593 while ((name = g_dir_read_name (gdir)) != NULL) {
596 filename = g_build_filename (dir, name, NULL);
597 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
598 files = g_list_prepend (files, filename);
602 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
603 /* Recursively get all log files */
604 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
615 log_manager_get_chats (EmpathyLogManager *manager,
617 gboolean is_chatroom)
623 gdir = g_dir_open (dir, 0, NULL);
628 while ((name = g_dir_read_name (gdir)) != NULL) {
629 EmpathyLogSearchHit *hit;
632 filename = g_build_filename (dir, name, NULL);
633 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
634 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
639 hit = g_slice_new0 (EmpathyLogSearchHit);
640 hit->chat_id = g_strdup (name);
641 hit->is_chatroom = is_chatroom;
643 hits = g_list_prepend (hits, hit);
652 log_manager_get_dir (EmpathyLogManager *manager,
654 const gchar *chat_id,
657 const gchar *account_id;
660 account_id = mc_account_get_unique_name (account);
663 basedir = g_build_path (G_DIR_SEPARATOR_S,
664 log_manager_get_basedir (manager),
670 basedir = g_build_path (G_DIR_SEPARATOR_S,
671 log_manager_get_basedir (manager),
681 log_manager_get_filename (EmpathyLogManager *manager,
683 const gchar *chat_id,
690 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
691 timestamp = log_manager_get_timestamp_filename ();
692 filename = g_build_filename (basedir, timestamp, NULL);
701 log_manager_get_filename_for_date (EmpathyLogManager *manager,
703 const gchar *chat_id,
711 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
712 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
713 filename = g_build_filename (basedir, timestamp, NULL);
722 log_manager_get_timestamp_filename (void)
728 t = empathy_time_get_current ();
729 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
730 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
738 log_manager_get_timestamp_from_message (EmpathyMessage *message)
742 t = empathy_message_get_timestamp (message);
744 /* We keep the timestamps in the messages as UTC. */
745 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
748 static EmpathyLogSearchHit *
749 log_manager_search_hit_new (EmpathyLogManager *manager,
750 const gchar *filename)
752 EmpathyLogSearchHit *hit;
753 const gchar *account_name;
758 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
762 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
763 len = g_strv_length (strv);
765 hit = g_slice_new0 (EmpathyLogSearchHit);
767 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
768 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
769 hit->chat_id = g_strdup (strv[len-2]);
770 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
771 if (hit->is_chatroom) {
772 account_name = strv[len-4];
774 account_name = strv[len-3];
776 hit->account = mc_account_lookup (account_name);
777 hit->filename = g_strdup (filename);
785 log_manager_search_hit_free (EmpathyLogSearchHit *hit)
788 g_object_unref (hit->account);
792 g_free (hit->filename);
793 g_free (hit->chat_id);
795 g_slice_free (EmpathyLogSearchHit, hit);