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 const gchar * log_manager_get_basedir (EmpathyLogManager *manager);
59 static GList * log_manager_get_all_files (EmpathyLogManager *manager,
61 static GList * log_manager_get_chats (EmpathyLogManager *manager,
63 gboolean is_chatroom);
64 static gchar * log_manager_get_dir (EmpathyLogManager *manager,
68 static gchar * log_manager_get_filename (EmpathyLogManager *manager,
72 static gchar * log_manager_get_filename_for_date (EmpathyLogManager *manager,
77 static gchar * log_manager_get_timestamp_filename (void);
78 static gchar * log_manager_get_timestamp_from_message (EmpathyMessage *message);
79 static EmpathyLogSearchHit *log_manager_search_hit_new (EmpathyLogManager *manager,
80 const gchar *filename);
81 static void log_manager_search_hit_free (EmpathyLogSearchHit *hit);
83 G_DEFINE_TYPE (EmpathyLogManager, empathy_log_manager, G_TYPE_OBJECT);
85 static EmpathyLogManager * manager_singleton = NULL;
88 empathy_log_manager_init (EmpathyLogManager *manager)
90 EmpathyLogManagerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (manager,
91 EMPATHY_TYPE_LOG_MANAGER, EmpathyLogManagerPriv);
97 log_manager_finalize (GObject *object)
99 EmpathyLogManagerPriv *priv;
101 priv = GET_PRIV (object);
103 g_free (priv->basedir);
107 log_manager_constructor (GType type,
109 GObjectConstructParam *props)
113 if (manager_singleton) {
114 retval = g_object_ref (manager_singleton);
116 retval = G_OBJECT_CLASS (empathy_log_manager_parent_class)->constructor
117 (type, n_props, props);
119 manager_singleton = EMPATHY_LOG_MANAGER (retval);
120 g_object_add_weak_pointer (retval, (gpointer *) &manager_singleton);
127 empathy_log_manager_class_init (EmpathyLogManagerClass *klass)
129 GObjectClass *object_class = G_OBJECT_CLASS (klass);
131 object_class->finalize = log_manager_finalize;
132 object_class->constructor = log_manager_constructor;
134 g_type_class_add_private (object_class, sizeof (EmpathyLogManagerPriv));
138 empathy_log_manager_dup_singleton (void)
140 return g_object_new (EMPATHY_TYPE_LOG_MANAGER, NULL);
144 empathy_log_manager_add_message (EmpathyLogManager *manager,
145 const gchar *chat_id,
147 EmpathyMessage *message)
151 EmpathyContact *sender;
152 const gchar *body_str;
154 EmpathyAvatar *avatar;
155 gchar *avatar_token = NULL;
162 TpChannelTextMessageType msg_type;
164 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
165 g_return_if_fail (chat_id != NULL);
166 g_return_if_fail (EMPATHY_IS_MESSAGE (message));
168 sender = empathy_message_get_sender (message);
169 account = empathy_contact_get_account (sender);
170 body_str = empathy_message_get_body (message);
171 msg_type = empathy_message_get_tptype (message);
173 if (EMP_STR_EMPTY (body_str)) {
177 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
178 basedir = g_path_get_dirname (filename);
179 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
180 DEBUG ("Creating directory:'%s'", basedir);
182 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
186 DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
188 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
189 file = g_fopen (filename, "w+");
191 g_fprintf (file, LOG_HEADER);
193 g_chmod (filename, LOG_FILE_CREATE_MODE);
195 file = g_fopen (filename, "r+");
197 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
201 body = g_markup_escape_text (body_str, -1);
202 timestamp = log_manager_get_timestamp_from_message (message);
204 str = empathy_contact_get_name (sender);
205 contact_name = g_markup_escape_text (str, -1);
207 str = empathy_contact_get_id (sender);
208 contact_id = g_markup_escape_text (str, -1);
210 avatar = empathy_contact_get_avatar (sender);
212 avatar_token = g_markup_escape_text (avatar->token, -1);
216 "<message time='%s' id='%s' name='%s' token='%s' isuser='%s' type='%s'>%s</message>\n" LOG_FOOTER,
220 avatar_token ? avatar_token : "",
221 empathy_contact_is_user (sender) ? "true" : "false",
222 empathy_message_type_to_str (msg_type),
228 g_free (contact_name);
231 g_free (avatar_token);
235 empathy_log_manager_exists (EmpathyLogManager *manager,
237 const gchar *chat_id,
243 dir = log_manager_get_dir (manager, account, chat_id, chatroom);
244 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
251 empathy_log_manager_get_dates (EmpathyLogManager *manager,
253 const gchar *chat_id,
260 const gchar *filename;
263 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
264 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
265 g_return_val_if_fail (chat_id != NULL, NULL);
267 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
268 dir = g_dir_open (directory, 0, NULL);
270 DEBUG ("Could not open directory:'%s'", directory);
275 DEBUG ("Collating a list of dates in:'%s'", directory);
277 while ((filename = g_dir_read_name (dir)) != NULL) {
278 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
282 p = strstr (filename, LOG_FILENAME_SUFFIX);
283 date = g_strndup (filename, p - filename);
288 if (!g_regex_match_simple ("\\d{8}", date, 0, 0)) {
292 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
298 DEBUG ("Parsed %d dates", g_list_length (dates));
304 empathy_log_manager_get_messages_for_file (EmpathyLogManager *manager,
305 const gchar *filename)
307 GList *messages = NULL;
308 xmlParserCtxtPtr ctxt;
312 EmpathyLogSearchHit *hit;
315 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
316 g_return_val_if_fail (filename != NULL, NULL);
318 DEBUG ("Attempting to parse filename:'%s'...", filename);
320 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
321 DEBUG ("Filename:'%s' does not exist", filename);
325 /* Get the account from the filename */
326 hit = log_manager_search_hit_new (manager, filename);
327 account = g_object_ref (hit->account);
328 log_manager_search_hit_free (hit);
331 ctxt = xmlNewParserCtxt ();
333 /* Parse and validate the file. */
334 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
336 g_warning ("Failed to parse file:'%s'", filename);
337 xmlFreeParserCtxt (ctxt);
341 /* The root node, presets. */
342 log_node = xmlDocGetRootElement (doc);
345 xmlFreeParserCtxt (ctxt);
349 /* Now get the messages. */
350 for (node = log_node->children; node; node = node->next) {
351 EmpathyMessage *message;
352 EmpathyContact *sender;
357 gchar *sender_avatar_token;
360 gboolean is_user = FALSE;
362 TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
364 if (strcmp (node->name, "message") != 0) {
368 body = xmlNodeGetContent (node);
369 time = xmlGetProp (node, "time");
370 sender_id = xmlGetProp (node, "id");
371 sender_name = xmlGetProp (node, "name");
372 sender_avatar_token = xmlGetProp (node, "token");
373 is_user_str = xmlGetProp (node, "isuser");
374 msg_type_str = xmlGetProp (node, "type");
377 is_user = strcmp (is_user_str, "true") == 0;
380 msg_type = empathy_message_type_from_str (msg_type_str);
383 t = empathy_time_parse (time);
385 sender = empathy_contact_new_full (account, sender_id, sender_name);
386 empathy_contact_set_is_user (sender, is_user);
387 if (!EMP_STR_EMPTY (sender_avatar_token)) {
388 empathy_contact_load_avatar_cache (sender,
389 sender_avatar_token);
392 message = empathy_message_new (body);
393 empathy_message_set_sender (message, sender);
394 empathy_message_set_timestamp (message, t);
395 empathy_message_set_tptype (message, msg_type);
397 messages = g_list_append (messages, message);
399 g_object_unref (sender);
402 xmlFree (sender_name);
404 xmlFree (is_user_str);
405 xmlFree (msg_type_str);
408 DEBUG ("Parsed %d messages", g_list_length (messages));
411 xmlFreeParserCtxt (ctxt);
417 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
419 const gchar *chat_id,
426 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
427 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
428 g_return_val_if_fail (chat_id != NULL, NULL);
430 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
431 messages = empathy_log_manager_get_messages_for_file (manager, filename);
438 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
440 const gchar *chat_id,
443 GList *messages = NULL;
447 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
448 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
449 g_return_val_if_fail (chat_id != NULL, NULL);
451 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
453 l = g_list_last (dates);
455 messages = empathy_log_manager_get_messages_for_date (manager,
462 g_list_foreach (dates, (GFunc) g_free, NULL);
469 empathy_log_manager_get_chats (EmpathyLogManager *manager,
472 const gchar *basedir;
475 basedir = log_manager_get_basedir (manager);
476 dir = g_build_filename (basedir,
477 mc_account_get_unique_name (account),
480 return log_manager_get_chats (manager, dir, FALSE);
484 empathy_log_manager_search_new (EmpathyLogManager *manager,
489 gchar *text_casefold;
491 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
492 g_return_val_if_fail (!EMP_STR_EMPTY (text), NULL);
494 text_casefold = g_utf8_casefold (text, -1);
496 files = log_manager_get_all_files (manager, NULL);
497 DEBUG ("Found %d log files in total", g_list_length (files));
499 for (l = files; l; l = l->next) {
504 gchar *contents_casefold;
508 file = g_mapped_file_new (filename, FALSE, NULL);
513 length = g_mapped_file_get_length (file);
514 contents = g_mapped_file_get_contents (file);
515 contents_casefold = g_utf8_casefold (contents, length);
517 g_mapped_file_free (file);
519 if (strstr (contents_casefold, text_casefold)) {
520 EmpathyLogSearchHit *hit;
522 hit = log_manager_search_hit_new (manager, filename);
525 hits = g_list_prepend (hits, hit);
526 DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
527 text, hit->filename, hit->date);
531 g_free (contents_casefold);
536 g_free (text_casefold);
542 empathy_log_manager_search_free (GList *hits)
546 for (l = hits; l; l = l->next) {
547 log_manager_search_hit_free (l->data);
553 /* Format is just date, 20061201. */
555 empathy_log_manager_get_date_readable (const gchar *date)
559 t = empathy_time_parse (date);
561 return empathy_time_to_string_local (t, "%a %d %b %Y");
565 log_manager_get_basedir (EmpathyLogManager *manager)
567 EmpathyLogManagerPriv *priv;
569 priv = GET_PRIV (manager);
572 return priv->basedir;
575 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
582 return priv->basedir;
586 log_manager_get_all_files (EmpathyLogManager *manager,
594 dir = log_manager_get_basedir (manager);
597 gdir = g_dir_open (dir, 0, NULL);
602 while ((name = g_dir_read_name (gdir)) != NULL) {
605 filename = g_build_filename (dir, name, NULL);
606 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
607 files = g_list_prepend (files, filename);
611 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
612 /* Recursively get all log files */
613 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
624 log_manager_get_chats (EmpathyLogManager *manager,
626 gboolean is_chatroom)
632 gdir = g_dir_open (dir, 0, NULL);
637 while ((name = g_dir_read_name (gdir)) != NULL) {
638 EmpathyLogSearchHit *hit;
641 filename = g_build_filename (dir, name, NULL);
642 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
643 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
648 hit = g_slice_new0 (EmpathyLogSearchHit);
649 hit->chat_id = g_strdup (name);
650 hit->is_chatroom = is_chatroom;
652 hits = g_list_prepend (hits, hit);
661 log_manager_get_dir (EmpathyLogManager *manager,
663 const gchar *chat_id,
666 const gchar *account_id;
669 account_id = mc_account_get_unique_name (account);
672 basedir = g_build_path (G_DIR_SEPARATOR_S,
673 log_manager_get_basedir (manager),
679 basedir = g_build_path (G_DIR_SEPARATOR_S,
680 log_manager_get_basedir (manager),
690 log_manager_get_filename (EmpathyLogManager *manager,
692 const gchar *chat_id,
699 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
700 timestamp = log_manager_get_timestamp_filename ();
701 filename = g_build_filename (basedir, timestamp, NULL);
710 log_manager_get_filename_for_date (EmpathyLogManager *manager,
712 const gchar *chat_id,
720 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
721 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
722 filename = g_build_filename (basedir, timestamp, NULL);
731 log_manager_get_timestamp_filename (void)
737 t = empathy_time_get_current ();
738 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
739 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
747 log_manager_get_timestamp_from_message (EmpathyMessage *message)
751 t = empathy_message_get_timestamp (message);
753 /* We keep the timestamps in the messages as UTC. */
754 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
757 static EmpathyLogSearchHit *
758 log_manager_search_hit_new (EmpathyLogManager *manager,
759 const gchar *filename)
761 EmpathyLogSearchHit *hit;
762 const gchar *account_name;
767 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
771 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
772 len = g_strv_length (strv);
774 hit = g_slice_new0 (EmpathyLogSearchHit);
776 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
777 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
778 hit->chat_id = g_strdup (strv[len-2]);
779 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
780 if (hit->is_chatroom) {
781 account_name = strv[len-4];
783 account_name = strv[len-3];
785 hit->account = mc_account_lookup (account_name);
786 hit->filename = g_strdup (filename);
794 log_manager_search_hit_free (EmpathyLogSearchHit *hit)
797 g_object_unref (hit->account);
801 g_free (hit->filename);
802 g_free (hit->chat_id);
804 g_slice_free (EmpathyLogSearchHit, hit);