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 "gossip-contact.h"
31 #include "gossip-time.h"
32 #include "gossip-debug.h"
33 #include "gossip-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=\"gossip-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 (GossipMessage *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 GossipMessage *message)
135 GossipContact *sender;
136 const gchar *body_str;
144 g_return_if_fail (EMPATHY_IS_LOG_MANAGER (manager));
145 g_return_if_fail (chat_id != NULL);
146 g_return_if_fail (GOSSIP_IS_MESSAGE (message));
148 sender = gossip_message_get_sender (message);
149 account = gossip_contact_get_account (sender);
150 body_str = gossip_message_get_body (message);
152 if (G_STR_EMPTY (body_str)) {
156 filename = log_manager_get_filename (manager, account, chat_id, chatroom);
158 gossip_debug (DEBUG_DOMAIN, "Adding message: '%s' to file: '%s'",
161 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
162 file = g_fopen (filename, "w+");
164 g_fprintf (file, LOG_HEADER);
166 g_chmod (filename, LOG_FILE_CREATE_MODE);
168 file = g_fopen (filename, "r+");
170 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
174 body = g_markup_escape_text (body_str, -1);
175 timestamp = log_manager_get_timestamp_from_message (message);
177 str = gossip_contact_get_name (sender);
178 contact_name = g_markup_escape_text (str, -1);
180 str = gossip_contact_get_id (sender);
181 contact_id = g_markup_escape_text (str, -1);
184 "<message time='%s' id='%s' name='%s' isuser='%s'>%s</message>\n" LOG_FOOTER,
188 gossip_contact_is_user (sender) ? "true" : "false",
194 g_free (contact_name);
200 empathy_log_manager_get_dates (EmpathyLogManager *manager,
202 const gchar *chat_id,
209 const gchar *filename;
212 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
213 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
214 g_return_val_if_fail (chat_id != NULL, NULL);
216 directory = log_manager_get_dir (manager, account, chat_id, chatroom);
221 dir = g_dir_open (directory, 0, NULL);
223 gossip_debug (DEBUG_DOMAIN, "Could not open directory:'%s'", directory);
228 gossip_debug (DEBUG_DOMAIN, "Collating a list of dates in:'%s'", directory);
230 while ((filename = g_dir_read_name (dir)) != NULL) {
231 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
235 p = strstr (filename, LOG_FILENAME_SUFFIX);
236 date = g_strndup (filename, p - filename);
241 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
247 gossip_debug (DEBUG_DOMAIN, "Parsed %d dates", g_list_length (dates));
253 empathy_log_manager_get_messages_for_date (EmpathyLogManager *manager,
255 const gchar *chat_id,
260 GList *messages = NULL;
261 xmlParserCtxtPtr ctxt;
266 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
267 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
268 g_return_val_if_fail (chat_id != NULL, NULL);
270 filename = log_manager_get_filename_for_date (manager, account, chat_id, chatroom, date);
272 gossip_debug (DEBUG_DOMAIN, "Attempting to parse filename:'%s'...", filename);
274 if (!g_file_test (filename, G_FILE_TEST_EXISTS)) {
275 gossip_debug (DEBUG_DOMAIN, "Filename:'%s' does not exist", filename);
281 ctxt = xmlNewParserCtxt ();
283 /* Parse and validate the file. */
284 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
286 g_warning ("Failed to parse file:'%s'", filename);
288 xmlFreeParserCtxt (ctxt);
292 /* The root node, presets. */
293 log_node = xmlDocGetRootElement (doc);
297 xmlFreeParserCtxt (ctxt);
301 /* Now get the messages. */
302 for (node = log_node->children; node; node = node->next) {
303 GossipMessage *message;
304 GossipContact *sender;
311 gboolean is_user = FALSE;
313 if (strcmp (node->name, "message") != 0) {
317 body = xmlNodeGetContent (node);
318 time = xmlGetProp (node, "time");
319 sender_id = xmlGetProp (node, "id");
320 sender_name = xmlGetProp (node, "name");
321 is_user_str = xmlGetProp (node, "isuser");
324 is_user = strcmp (is_user_str, "true") == 0;
327 t = gossip_time_parse (time);
329 sender = gossip_contact_new_full (account, sender_id, sender_name);
330 gossip_contact_set_is_user (sender, is_user);
331 message = gossip_message_new (body);
332 gossip_message_set_sender (message, sender);
333 gossip_message_set_timestamp (message, t);
335 messages = g_list_append (messages, message);
337 g_object_unref (sender);
340 xmlFree (sender_name);
344 gossip_debug (DEBUG_DOMAIN, "Parsed %d messages", g_list_length (messages));
348 xmlFreeParserCtxt (ctxt);
354 empathy_log_manager_get_last_messages (EmpathyLogManager *manager,
356 const gchar *chat_id,
359 GList *messages = NULL;
363 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
364 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
365 g_return_val_if_fail (chat_id != NULL, NULL);
367 dates = empathy_log_manager_get_dates (manager, account, chat_id, chatroom);
369 l = g_list_last (dates);
371 messages = empathy_log_manager_get_messages_for_date (manager,
378 g_list_foreach (dates, (GFunc) g_free, NULL);
385 empathy_log_manager_get_chats (EmpathyLogManager *manager,
388 const gchar *basedir;
391 basedir = log_manager_get_basedir (manager);
392 dir = g_build_filename (basedir,
393 mc_account_get_unique_name (account),
396 return log_manager_get_chats (manager, dir, FALSE);
400 empathy_log_manager_search_new (EmpathyLogManager *manager,
405 gchar *text_casefold;
407 g_return_val_if_fail (EMPATHY_IS_LOG_MANAGER (manager), NULL);
408 g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
410 text_casefold = g_utf8_casefold (text, -1);
412 files = log_manager_get_all_files (manager, NULL);
413 gossip_debug (DEBUG_DOMAIN, "Found %d log files in total",
414 g_list_length (files));
416 for (l = files; l; l = l->next) {
421 gchar *contents_casefold;
425 file = g_mapped_file_new (filename, FALSE, NULL);
430 length = g_mapped_file_get_length (file);
431 contents = g_mapped_file_get_contents (file);
432 contents_casefold = g_utf8_casefold (contents, length);
434 g_mapped_file_free (file);
436 if (strstr (contents_casefold, text_casefold)) {
437 EmpathyLogSearchHit *hit;
439 hit = log_manager_search_hit_new (manager, filename);
442 hits = g_list_prepend (hits, hit);
443 gossip_debug (DEBUG_DOMAIN,
444 "Found text:'%s' in file:'%s' on date:'%s'...",
445 text, hit->filename, hit->date);
449 g_free (contents_casefold);
454 g_free (text_casefold);
460 empathy_log_manager_search_free (GList *hits)
463 EmpathyLogSearchHit *hit;
465 for (l = hits; l; l = l->next) {
469 g_object_unref (hit->account);
473 g_free (hit->filename);
474 g_free (hit->chat_id);
476 g_slice_free (EmpathyLogSearchHit, hit);
482 /* Format is just date, 20061201. */
484 empathy_log_manager_get_date_readable (const gchar *date)
488 t = gossip_time_parse (date);
490 return gossip_time_to_string_local (t, "%a %d %b %Y");
494 log_manager_get_basedir (EmpathyLogManager *manager)
496 EmpathyLogManagerPriv *priv;
498 priv = GET_PRIV (manager);
501 return priv->basedir;
504 priv->basedir = g_build_path (G_DIR_SEPARATOR_S,
511 return priv->basedir;
515 log_manager_get_all_files (EmpathyLogManager *manager,
523 dir = log_manager_get_basedir (manager);
526 gdir = g_dir_open (dir, 0, NULL);
531 while ((name = g_dir_read_name (gdir)) != NULL) {
534 filename = g_build_filename (dir, name, NULL);
535 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
536 files = g_list_prepend (files, filename);
540 if (g_file_test (filename, G_FILE_TEST_IS_DIR)) {
541 /* Recursively get all log files */
542 files = g_list_concat (files, log_manager_get_all_files (manager, filename));
553 log_manager_get_chats (EmpathyLogManager *manager,
555 gboolean is_chatroom)
561 gdir = g_dir_open (dir, 0, NULL);
566 while ((name = g_dir_read_name (gdir)) != NULL) {
567 EmpathyLogSearchHit *hit;
570 filename = g_build_filename (dir, name, NULL);
571 if (strcmp (name, LOG_DIR_CHATROOMS) == 0) {
572 hits = g_list_concat (hits, log_manager_get_chats (manager, filename, TRUE));
577 hit = g_slice_new0 (EmpathyLogSearchHit);
578 hit->chat_id = g_strdup (name);
579 hit->is_chatroom = is_chatroom;
581 hits = g_list_prepend (hits, hit);
590 log_manager_get_dir (EmpathyLogManager *manager,
592 const gchar *chat_id,
595 const gchar *account_id;
599 account_id = mc_account_get_unique_name (account);
601 str = g_build_path (G_DIR_SEPARATOR_S,
602 log_manager_get_basedir (manager),
608 basedir = g_build_path (G_DIR_SEPARATOR_S,
617 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR)) {
618 gossip_debug (DEBUG_DOMAIN, "Creating directory:'%s'", basedir);
620 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
627 log_manager_get_filename (EmpathyLogManager *manager,
629 const gchar *chat_id,
636 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
637 timestamp = log_manager_get_timestamp_filename ();
638 filename = g_build_filename (basedir, timestamp, NULL);
647 log_manager_get_filename_for_date (EmpathyLogManager *manager,
649 const gchar *chat_id,
657 basedir = log_manager_get_dir (manager, account, chat_id, chatroom);
658 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
659 filename = g_build_filename (basedir, timestamp, NULL);
668 log_manager_get_timestamp_filename (void)
674 t = gossip_time_get_current ();
675 time_str = gossip_time_to_string_local (t, LOG_TIME_FORMAT);
676 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
684 log_manager_get_timestamp_from_message (GossipMessage *message)
688 t = gossip_message_get_timestamp (message);
690 /* We keep the timestamps in the messages as UTC. */
691 return gossip_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
694 static EmpathyLogSearchHit *
695 log_manager_search_hit_new (EmpathyLogManager *manager,
696 const gchar *filename)
698 EmpathyLogSearchHit *hit;
699 const gchar *account_name;
704 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX)) {
708 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
709 len = g_strv_length (strv);
711 hit = g_slice_new0 (EmpathyLogSearchHit);
713 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
714 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
715 hit->chat_id = g_strdup (strv[len-2]);
716 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
717 if (hit->is_chatroom) {
718 account_name = strv[len-4];
720 account_name = strv[len-3];
722 hit->account = mc_account_lookup (account_name);
723 hit->filename = g_strdup (filename);