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>
22 * Jonny Lamb <jonny.lamb@collabora.co.uk>
30 #include <glib/gstdio.h>
32 #include "empathy-log-store.h"
33 #include "empathy-log-store-empathy.h"
34 #include "empathy-log-manager.h"
35 #include "empathy-contact.h"
36 #include "empathy-time.h"
37 #include "empathy-utils.h"
39 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
40 #include "empathy-debug.h"
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" \
57 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLogStoreEmpathy)
62 } EmpathyLogStoreEmpathyPriv;
64 static void log_store_iface_init (gpointer g_iface,gpointer iface_data);
66 G_DEFINE_TYPE_WITH_CODE (EmpathyLogStoreEmpathy, empathy_log_store_empathy,
67 G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (EMPATHY_TYPE_LOG_STORE,
68 log_store_iface_init));
71 log_store_empathy_finalize (GObject *object)
73 EmpathyLogStoreEmpathy *self = EMPATHY_LOG_STORE_EMPATHY (object);
74 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
76 g_free (priv->basedir);
81 empathy_log_store_empathy_class_init (EmpathyLogStoreEmpathyClass *klass)
83 GObjectClass *object_class = G_OBJECT_CLASS (klass);
85 object_class->finalize = log_store_empathy_finalize;
87 g_type_class_add_private (object_class, sizeof (EmpathyLogStoreEmpathyPriv));
91 empathy_log_store_empathy_init (EmpathyLogStoreEmpathy *self)
93 EmpathyLogStoreEmpathyPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
94 EMPATHY_TYPE_LOG_STORE_EMPATHY, EmpathyLogStoreEmpathyPriv);
98 priv->basedir = g_build_path (G_DIR_SEPARATOR_S, g_get_home_dir (),
99 ".gnome2", PACKAGE_NAME, "logs", NULL);
101 priv->name = g_strdup ("Empathy");
105 log_store_empathy_get_dir (EmpathyLogStore *self,
107 const gchar *chat_id,
110 const gchar *account_id;
112 EmpathyLogStoreEmpathyPriv *priv;
114 priv = GET_PRIV (self);
116 account_id = mc_account_get_unique_name (account);
119 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir, account_id,
120 LOG_DIR_CHATROOMS, chat_id, NULL);
122 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir,
123 account_id, chat_id, NULL);
129 log_store_empathy_get_timestamp_filename (void)
135 t = empathy_time_get_current ();
136 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
137 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
145 log_store_empathy_get_timestamp_from_message (EmpathyMessage *message)
149 t = empathy_message_get_timestamp (message);
151 /* We keep the timestamps in the messages as UTC. */
152 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
156 log_store_empathy_get_filename (EmpathyLogStore *self,
158 const gchar *chat_id,
165 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
166 timestamp = log_store_empathy_get_timestamp_filename ();
167 filename = g_build_filename (basedir, timestamp, NULL);
176 log_store_empathy_add_message (EmpathyLogStore *self,
177 const gchar *chat_id,
179 EmpathyMessage *message,
184 EmpathyContact *sender;
185 const gchar *body_str;
187 EmpathyAvatar *avatar;
188 gchar *avatar_token = NULL;
195 TpChannelTextMessageType msg_type;
197 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), FALSE);
198 g_return_val_if_fail (chat_id != NULL, FALSE);
199 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
201 sender = empathy_message_get_sender (message);
202 account = empathy_contact_get_account (sender);
203 body_str = empathy_message_get_body (message);
204 msg_type = empathy_message_get_tptype (message);
206 if (EMP_STR_EMPTY (body_str))
209 filename = log_store_empathy_get_filename (self, account, chat_id, chatroom);
210 basedir = g_path_get_dirname (filename);
211 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
213 DEBUG ("Creating directory:'%s'", basedir);
214 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
218 DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
220 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
222 file = g_fopen (filename, "w+");
224 g_fprintf (file, LOG_HEADER);
226 g_chmod (filename, LOG_FILE_CREATE_MODE);
230 file = g_fopen (filename, "r+");
232 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
235 body = g_markup_escape_text (body_str, -1);
236 timestamp = log_store_empathy_get_timestamp_from_message (message);
238 str = empathy_contact_get_name (sender);
239 contact_name = g_markup_escape_text (str, -1);
241 str = empathy_contact_get_id (sender);
242 contact_id = g_markup_escape_text (str, -1);
244 avatar = empathy_contact_get_avatar (sender);
246 avatar_token = g_markup_escape_text (avatar->token, -1);
249 "<message time='%s' cm_id='%d' id='%s' name='%s' token='%s' isuser='%s' type='%s'>"
250 "%s</message>\n" LOG_FOOTER, timestamp,
251 empathy_message_get_id (message),
252 contact_id, contact_name,
253 avatar_token ? avatar_token : "",
254 empathy_contact_is_user (sender) ? "true" : "false",
255 empathy_message_type_to_str (msg_type), body);
260 g_free (contact_name);
263 g_free (avatar_token);
269 log_store_empathy_exists (EmpathyLogStore *self,
271 const gchar *chat_id,
277 dir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
278 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
285 log_store_empathy_get_dates (EmpathyLogStore *self,
287 const gchar *chat_id,
294 const gchar *filename;
297 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
298 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
299 g_return_val_if_fail (chat_id != NULL, NULL);
301 directory = log_store_empathy_get_dir (self, account, chat_id, chatroom);
302 dir = g_dir_open (directory, 0, NULL);
305 DEBUG ("Could not open directory:'%s'", directory);
310 DEBUG ("Collating a list of dates in:'%s'", directory);
312 while ((filename = g_dir_read_name (dir)) != NULL)
314 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
317 p = strstr (filename, LOG_FILENAME_SUFFIX);
318 date = g_strndup (filename, p - filename);
323 if (!g_regex_match_simple ("\\d{8}", date, 0, 0))
326 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
332 DEBUG ("Parsed %d dates", g_list_length (dates));
338 log_store_empathy_get_filename_for_date (EmpathyLogStore *self,
340 const gchar *chat_id,
348 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
349 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
350 filename = g_build_filename (basedir, timestamp, NULL);
358 static EmpathyLogSearchHit *
359 log_store_empathy_search_hit_new (EmpathyLogStore *self,
360 const gchar *filename)
362 EmpathyLogSearchHit *hit;
363 const gchar *account_name;
368 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
371 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
372 len = g_strv_length (strv);
374 hit = g_slice_new0 (EmpathyLogSearchHit);
376 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
377 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
378 hit->chat_id = g_strdup (strv[len-2]);
379 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
381 if (hit->is_chatroom)
382 account_name = strv[len-4];
384 account_name = strv[len-3];
386 hit->account = mc_account_lookup (account_name);
387 hit->filename = g_strdup (filename);
395 log_store_empathy_get_messages_for_file (EmpathyLogStore *self,
396 const gchar *filename)
398 GList *messages = NULL;
399 xmlParserCtxtPtr ctxt;
403 EmpathyLogSearchHit *hit;
406 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
407 g_return_val_if_fail (filename != NULL, NULL);
409 DEBUG ("Attempting to parse filename:'%s'...", filename);
411 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
413 DEBUG ("Filename:'%s' does not exist", filename);
417 /* Get the account from the filename */
418 hit = log_store_empathy_search_hit_new (self, filename);
419 account = g_object_ref (hit->account);
420 empathy_log_manager_search_hit_free (hit);
423 ctxt = xmlNewParserCtxt ();
425 /* Parse and validate the file. */
426 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
429 g_warning ("Failed to parse file:'%s'", filename);
430 xmlFreeParserCtxt (ctxt);
434 /* The root node, presets. */
435 log_node = xmlDocGetRootElement (doc);
439 xmlFreeParserCtxt (ctxt);
443 /* Now get the messages. */
444 for (node = log_node->children; node; node = node->next)
446 EmpathyMessage *message;
447 EmpathyContact *sender;
452 gchar *sender_avatar_token;
455 gboolean is_user = FALSE;
459 TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
461 if (strcmp (node->name, "message") != 0)
464 body = xmlNodeGetContent (node);
465 time = xmlGetProp (node, "time");
466 sender_id = xmlGetProp (node, "id");
467 sender_name = xmlGetProp (node, "name");
468 sender_avatar_token = xmlGetProp (node, "token");
469 is_user_str = xmlGetProp (node, "isuser");
470 msg_type_str = xmlGetProp (node, "type");
471 cm_id_str = xmlGetProp (node, "cm_id");
474 is_user = strcmp (is_user_str, "true") == 0;
477 msg_type = empathy_message_type_from_str (msg_type_str);
480 cm_id = atoi (cm_id_str);
482 t = empathy_time_parse (time);
484 sender = empathy_contact_new_full (account, sender_id, sender_name);
485 empathy_contact_set_is_user (sender, is_user);
486 if (!EMP_STR_EMPTY (sender_avatar_token))
487 empathy_contact_load_avatar_cache (sender,
488 sender_avatar_token);
490 message = empathy_message_new (body);
491 empathy_message_set_sender (message, sender);
492 empathy_message_set_timestamp (message, t);
493 empathy_message_set_tptype (message, msg_type);
496 empathy_message_set_id (message, cm_id);
498 messages = g_list_append (messages, message);
500 g_object_unref (sender);
503 xmlFree (sender_name);
505 xmlFree (is_user_str);
506 xmlFree (msg_type_str);
508 xmlFree (sender_avatar_token);
511 DEBUG ("Parsed %d messages", g_list_length (messages));
514 xmlFreeParserCtxt (ctxt);
520 log_store_empathy_get_all_files (EmpathyLogStore *self,
526 const gchar *basedir;
527 EmpathyLogStoreEmpathyPriv *priv;
529 priv = GET_PRIV (self);
531 basedir = dir ? dir : priv->basedir;
533 gdir = g_dir_open (basedir, 0, NULL);
537 while ((name = g_dir_read_name (gdir)) != NULL)
541 filename = g_build_filename (basedir, name, NULL);
542 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
544 files = g_list_prepend (files, filename);
548 if (g_file_test (filename, G_FILE_TEST_IS_DIR))
550 /* Recursively get all log files */
551 files = g_list_concat (files,
552 log_store_empathy_get_all_files (self, filename));
564 log_store_empathy_search_new (EmpathyLogStore *self,
569 gchar *text_casefold;
571 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
572 g_return_val_if_fail (!EMP_STR_EMPTY (text), NULL);
574 text_casefold = g_utf8_casefold (text, -1);
576 files = log_store_empathy_get_all_files (self, NULL);
577 DEBUG ("Found %d log files in total", g_list_length (files));
579 for (l = files; l; l = g_list_next (l))
585 gchar *contents_casefold;
589 file = g_mapped_file_new (filename, FALSE, NULL);
593 length = g_mapped_file_get_length (file);
594 contents = g_mapped_file_get_contents (file);
595 contents_casefold = g_utf8_casefold (contents, length);
597 g_mapped_file_free (file);
599 if (strstr (contents_casefold, text_casefold))
601 EmpathyLogSearchHit *hit;
603 hit = log_store_empathy_search_hit_new (self, filename);
607 hits = g_list_prepend (hits, hit);
608 DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
609 text, hit->filename, hit->date);
613 g_free (contents_casefold);
618 g_free (text_casefold);
624 log_store_empathy_get_chats_for_dir (EmpathyLogStore *self,
626 gboolean is_chatroom)
631 GError *error = NULL;
633 gdir = g_dir_open (dir, 0, &error);
636 DEBUG ("Failed to open directory: %s, error: %s", dir, error->message);
637 g_error_free (error);
641 while ((name = g_dir_read_name (gdir)) != NULL)
643 EmpathyLogSearchHit *hit;
646 filename = g_build_filename (dir, name, NULL);
647 if (!is_chatroom && strcmp (name, LOG_DIR_CHATROOMS) == 0)
649 hits = g_list_concat (hits, log_store_empathy_get_chats_for_dir (
650 self, filename, TRUE));
655 hit = g_slice_new0 (EmpathyLogSearchHit);
656 hit->chat_id = g_strdup (name);
657 hit->is_chatroom = is_chatroom;
659 hits = g_list_prepend (hits, hit);
669 log_store_empathy_get_messages_for_date (EmpathyLogStore *self,
671 const gchar *chat_id,
678 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
679 g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
680 g_return_val_if_fail (chat_id != NULL, NULL);
682 filename = log_store_empathy_get_filename_for_date (self, account,
683 chat_id, chatroom, date);
684 messages = log_store_empathy_get_messages_for_file (self, filename);
691 log_store_empathy_get_chats (EmpathyLogStore *self,
696 EmpathyLogStoreEmpathyPriv *priv;
698 priv = GET_PRIV (self);
700 dir = g_build_filename (priv->basedir,
701 mc_account_get_unique_name (account), NULL);
703 hits = log_store_empathy_get_chats_for_dir (self, dir, FALSE);
711 log_store_empathy_get_name (EmpathyLogStore *self)
713 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
719 log_store_empathy_get_filtered_messages (EmpathyLogStore *self,
721 const gchar *chat_id,
724 EmpathyLogMessageFilter filter,
727 GList *dates, *l, *messages = NULL;
730 dates = log_store_empathy_get_dates (self, account, chat_id, chatroom);
732 for (l = g_list_last (dates); l && i < num_messages; l = g_list_previous (l))
734 GList *new_messages, *n, *next;
736 /* FIXME: We should really restrict the message parsing to get only
737 * the newest num_messages. */
738 new_messages = log_store_empathy_get_messages_for_date (self, account,
739 chat_id, chatroom, l->data);
744 next = g_list_next (n);
745 if (!filter (n->data, user_data))
747 g_object_unref (n->data);
748 new_messages = g_list_delete_link (new_messages, n);
756 messages = g_list_concat (messages, new_messages);
759 g_list_foreach (dates, (GFunc) g_free, NULL);
766 log_store_iface_init (gpointer g_iface,
769 EmpathyLogStoreInterface *iface = (EmpathyLogStoreInterface *) g_iface;
771 iface->get_name = log_store_empathy_get_name;
772 iface->exists = log_store_empathy_exists;
773 iface->add_message = log_store_empathy_add_message;
774 iface->get_dates = log_store_empathy_get_dates;
775 iface->get_messages_for_date = log_store_empathy_get_messages_for_date;
776 iface->get_chats = log_store_empathy_get_chats;
777 iface->search_new = log_store_empathy_search_new;
778 iface->ack_message = NULL;
779 iface->get_filtered_messages = log_store_empathy_get_filtered_messages;