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., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301 USA
21 * Authors: Xavier Claessens <xclaesse@gmail.com>
22 * Jonny Lamb <jonny.lamb@collabora.co.uk>
30 #include <glib/gstdio.h>
32 #include <telepathy-glib/util.h>
34 #include "empathy-log-store.h"
35 #include "empathy-log-store-empathy.h"
36 #include "empathy-log-manager.h"
37 #include "empathy-account-manager.h"
38 #include "empathy-contact.h"
39 #include "empathy-time.h"
40 #include "empathy-utils.h"
42 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
43 #include "empathy-debug.h"
45 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
46 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
47 #define LOG_DIR_CHATROOMS "chatrooms"
48 #define LOG_FILENAME_SUFFIX ".log"
49 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
50 #define LOG_TIME_FORMAT "%Y%m%d"
52 "<?xml version='1.0' encoding='utf-8'?>\n" \
53 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
60 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLogStoreEmpathy)
65 EmpathyAccountManager *account_manager;
66 } EmpathyLogStoreEmpathyPriv;
68 static void log_store_iface_init (gpointer g_iface,gpointer iface_data);
70 G_DEFINE_TYPE_WITH_CODE (EmpathyLogStoreEmpathy, empathy_log_store_empathy,
71 G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (EMPATHY_TYPE_LOG_STORE,
72 log_store_iface_init));
75 log_store_empathy_finalize (GObject *object)
77 EmpathyLogStoreEmpathy *self = EMPATHY_LOG_STORE_EMPATHY (object);
78 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
80 g_object_unref (priv->account_manager);
81 g_free (priv->basedir);
86 empathy_log_store_empathy_class_init (EmpathyLogStoreEmpathyClass *klass)
88 GObjectClass *object_class = G_OBJECT_CLASS (klass);
90 object_class->finalize = log_store_empathy_finalize;
92 g_type_class_add_private (object_class, sizeof (EmpathyLogStoreEmpathyPriv));
96 empathy_log_store_empathy_init (EmpathyLogStoreEmpathy *self)
98 EmpathyLogStoreEmpathyPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
99 EMPATHY_TYPE_LOG_STORE_EMPATHY, EmpathyLogStoreEmpathyPriv);
103 priv->basedir = g_build_path (G_DIR_SEPARATOR_S, g_get_user_data_dir (),
104 PACKAGE_NAME, "logs", NULL);
106 priv->name = g_strdup ("Empathy");
107 priv->account_manager = empathy_account_manager_dup_singleton ();
111 log_store_empathy_get_dir (EmpathyLogStore *self,
112 EmpathyAccount *account,
113 const gchar *chat_id,
118 EmpathyLogStoreEmpathyPriv *priv;
120 priv = GET_PRIV (self);
122 /* unique name is an object path, ignore the initial / and replace the others
124 escaped = g_strdup (empathy_account_get_unique_name (account) + 1);
126 g_strdelimit (escaped, "/", '%');
129 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir, escaped,
130 LOG_DIR_CHATROOMS, chat_id, NULL);
132 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir,
133 escaped, chat_id, NULL);
141 log_store_empathy_get_timestamp_filename (void)
147 t = empathy_time_get_current ();
148 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
149 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
157 log_store_empathy_get_timestamp_from_message (EmpathyMessage *message)
161 t = empathy_message_get_timestamp (message);
163 /* We keep the timestamps in the messages as UTC. */
164 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
168 log_store_empathy_get_filename (EmpathyLogStore *self,
169 EmpathyAccount *account,
170 const gchar *chat_id,
177 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
178 timestamp = log_store_empathy_get_timestamp_filename ();
179 filename = g_build_filename (basedir, timestamp, NULL);
188 log_store_empathy_add_message (EmpathyLogStore *self,
189 const gchar *chat_id,
191 EmpathyMessage *message,
195 EmpathyAccount *account;
196 EmpathyContact *sender;
197 const gchar *body_str;
199 EmpathyAvatar *avatar;
200 gchar *avatar_token = NULL;
207 TpChannelTextMessageType msg_type;
209 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), FALSE);
210 g_return_val_if_fail (chat_id != NULL, FALSE);
211 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
213 sender = empathy_message_get_sender (message);
214 account = empathy_contact_get_account (sender);
215 body_str = empathy_message_get_body (message);
216 msg_type = empathy_message_get_tptype (message);
218 if (EMP_STR_EMPTY (body_str))
221 filename = log_store_empathy_get_filename (self, account, chat_id, chatroom);
222 basedir = g_path_get_dirname (filename);
223 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
225 DEBUG ("Creating directory:'%s'", basedir);
226 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
230 DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
232 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
234 file = g_fopen (filename, "w+");
236 g_fprintf (file, LOG_HEADER);
238 g_chmod (filename, LOG_FILE_CREATE_MODE);
242 file = g_fopen (filename, "r+");
244 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
247 body = g_markup_escape_text (body_str, -1);
248 timestamp = log_store_empathy_get_timestamp_from_message (message);
250 str = empathy_contact_get_name (sender);
251 contact_name = g_markup_escape_text (str, -1);
253 str = empathy_contact_get_id (sender);
254 contact_id = g_markup_escape_text (str, -1);
256 avatar = empathy_contact_get_avatar (sender);
258 avatar_token = g_markup_escape_text (avatar->token, -1);
261 "<message time='%s' cm_id='%d' id='%s' name='%s' token='%s' isuser='%s' type='%s'>"
262 "%s</message>\n" LOG_FOOTER, timestamp,
263 empathy_message_get_id (message),
264 contact_id, contact_name,
265 avatar_token ? avatar_token : "",
266 empathy_contact_is_user (sender) ? "true" : "false",
267 empathy_message_type_to_str (msg_type), body);
272 g_free (contact_name);
275 g_free (avatar_token);
281 log_store_empathy_exists (EmpathyLogStore *self,
282 EmpathyAccount *account,
283 const gchar *chat_id,
289 dir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
290 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
297 log_store_empathy_get_dates (EmpathyLogStore *self,
298 EmpathyAccount *account,
299 const gchar *chat_id,
306 const gchar *filename;
309 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
310 g_return_val_if_fail (chat_id != NULL, NULL);
312 directory = log_store_empathy_get_dir (self, account, chat_id, chatroom);
313 dir = g_dir_open (directory, 0, NULL);
316 DEBUG ("Could not open directory:'%s'", directory);
321 DEBUG ("Collating a list of dates in:'%s'", directory);
323 while ((filename = g_dir_read_name (dir)) != NULL)
325 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
328 p = strstr (filename, LOG_FILENAME_SUFFIX);
329 date = g_strndup (filename, p - filename);
334 if (!g_regex_match_simple ("\\d{8}", date, 0, 0))
337 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
343 DEBUG ("Parsed %d dates", g_list_length (dates));
349 log_store_empathy_get_filename_for_date (EmpathyLogStore *self,
350 EmpathyAccount *account,
351 const gchar *chat_id,
359 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
360 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
361 filename = g_build_filename (basedir, timestamp, NULL);
369 static EmpathyLogSearchHit *
370 log_store_empathy_search_hit_new (EmpathyLogStore *self,
371 const gchar *filename)
373 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
374 EmpathyLogSearchHit *hit;
381 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
384 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
385 len = g_strv_length (strv);
387 hit = g_slice_new0 (EmpathyLogSearchHit);
389 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
390 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
391 hit->chat_id = g_strdup (strv[len-2]);
392 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
394 if (hit->is_chatroom)
395 account_name = strv[len-4];
397 account_name = strv[len-3];
399 unescaped = g_strdup_printf ("/%s", g_strdelimit (account_name, "%", '/'));
401 hit->account = empathy_account_manager_lookup (priv->account_manager,
403 hit->filename = g_strdup (filename);
412 log_store_empathy_get_messages_for_file (EmpathyLogStore *self,
413 const gchar *filename)
415 GList *messages = NULL;
416 xmlParserCtxtPtr ctxt;
420 EmpathyLogSearchHit *hit;
421 EmpathyAccount *account;
423 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
424 g_return_val_if_fail (filename != NULL, NULL);
426 DEBUG ("Attempting to parse filename:'%s'...", filename);
428 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
430 DEBUG ("Filename:'%s' does not exist", filename);
434 /* Get the account from the filename */
435 hit = log_store_empathy_search_hit_new (self, filename);
437 if (hit->account != NULL)
438 account = g_object_ref (hit->account);
440 empathy_log_manager_search_hit_free (hit);
442 if (hit->account == NULL)
446 ctxt = xmlNewParserCtxt ();
448 /* Parse and validate the file. */
449 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
452 g_warning ("Failed to parse file:'%s'", filename);
453 xmlFreeParserCtxt (ctxt);
457 /* The root node, presets. */
458 log_node = xmlDocGetRootElement (doc);
462 xmlFreeParserCtxt (ctxt);
466 /* Now get the messages. */
467 for (node = log_node->children; node; node = node->next)
469 EmpathyMessage *message;
470 EmpathyContact *sender;
475 gchar *sender_avatar_token;
478 gboolean is_user = FALSE;
482 TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
484 if (strcmp (node->name, "message") != 0)
487 body = xmlNodeGetContent (node);
488 time = xmlGetProp (node, "time");
489 sender_id = xmlGetProp (node, "id");
490 sender_name = xmlGetProp (node, "name");
491 sender_avatar_token = xmlGetProp (node, "token");
492 is_user_str = xmlGetProp (node, "isuser");
493 msg_type_str = xmlGetProp (node, "type");
494 cm_id_str = xmlGetProp (node, "cm_id");
497 is_user = strcmp (is_user_str, "true") == 0;
500 msg_type = empathy_message_type_from_str (msg_type_str);
503 cm_id = atoi (cm_id_str);
505 t = empathy_time_parse (time);
507 sender = empathy_contact_new_for_log (account, sender_id, sender_name,
510 if (!EMP_STR_EMPTY (sender_avatar_token))
511 empathy_contact_load_avatar_cache (sender,
512 sender_avatar_token);
514 message = empathy_message_new (body);
515 empathy_message_set_sender (message, sender);
516 empathy_message_set_timestamp (message, t);
517 empathy_message_set_tptype (message, msg_type);
520 empathy_message_set_id (message, cm_id);
522 messages = g_list_append (messages, message);
524 g_object_unref (sender);
527 xmlFree (sender_name);
529 xmlFree (is_user_str);
530 xmlFree (msg_type_str);
532 xmlFree (sender_avatar_token);
535 DEBUG ("Parsed %d messages", g_list_length (messages));
538 xmlFreeParserCtxt (ctxt);
544 log_store_empathy_get_all_files (EmpathyLogStore *self,
550 const gchar *basedir;
551 EmpathyLogStoreEmpathyPriv *priv;
553 priv = GET_PRIV (self);
555 basedir = dir ? dir : priv->basedir;
557 gdir = g_dir_open (basedir, 0, NULL);
561 while ((name = g_dir_read_name (gdir)) != NULL)
565 filename = g_build_filename (basedir, name, NULL);
566 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
568 files = g_list_prepend (files, filename);
572 if (g_file_test (filename, G_FILE_TEST_IS_DIR))
574 /* Recursively get all log files */
575 files = g_list_concat (files,
576 log_store_empathy_get_all_files (self, filename));
588 log_store_empathy_search_new (EmpathyLogStore *self,
593 gchar *text_casefold;
595 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
596 g_return_val_if_fail (!EMP_STR_EMPTY (text), NULL);
598 text_casefold = g_utf8_casefold (text, -1);
600 files = log_store_empathy_get_all_files (self, NULL);
601 DEBUG ("Found %d log files in total", g_list_length (files));
603 for (l = files; l; l = g_list_next (l))
609 gchar *contents_casefold;
613 file = g_mapped_file_new (filename, FALSE, NULL);
617 length = g_mapped_file_get_length (file);
618 contents = g_mapped_file_get_contents (file);
619 contents_casefold = g_utf8_casefold (contents, length);
621 g_mapped_file_free (file);
623 if (strstr (contents_casefold, text_casefold))
625 EmpathyLogSearchHit *hit;
627 hit = log_store_empathy_search_hit_new (self, filename);
631 hits = g_list_prepend (hits, hit);
632 DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
633 text, hit->filename, hit->date);
637 g_free (contents_casefold);
642 g_free (text_casefold);
648 log_store_empathy_get_chats_for_dir (EmpathyLogStore *self,
650 gboolean is_chatroom)
655 GError *error = NULL;
657 gdir = g_dir_open (dir, 0, &error);
660 DEBUG ("Failed to open directory: %s, error: %s", dir, error->message);
661 g_error_free (error);
665 while ((name = g_dir_read_name (gdir)) != NULL)
667 EmpathyLogSearchHit *hit;
669 if (!is_chatroom && strcmp (name, LOG_DIR_CHATROOMS) == 0)
671 gchar *filename = g_build_filename (dir, name, NULL);
672 hits = g_list_concat (hits, log_store_empathy_get_chats_for_dir (
673 self, filename, TRUE));
677 hit = g_slice_new0 (EmpathyLogSearchHit);
678 hit->chat_id = g_strdup (name);
679 hit->is_chatroom = is_chatroom;
681 hits = g_list_prepend (hits, hit);
691 log_store_empathy_get_messages_for_date (EmpathyLogStore *self,
692 EmpathyAccount *account,
693 const gchar *chat_id,
700 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
701 g_return_val_if_fail (chat_id != NULL, NULL);
703 filename = log_store_empathy_get_filename_for_date (self, account,
704 chat_id, chatroom, date);
705 messages = log_store_empathy_get_messages_for_file (self, filename);
712 log_store_empathy_get_chats (EmpathyLogStore *self,
713 EmpathyAccount *account)
717 EmpathyLogStoreEmpathyPriv *priv;
719 priv = GET_PRIV (self);
721 dir = g_build_filename (priv->basedir,
722 empathy_account_get_unique_name (account), NULL);
724 hits = log_store_empathy_get_chats_for_dir (self, dir, FALSE);
732 log_store_empathy_get_name (EmpathyLogStore *self)
734 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
740 log_store_empathy_get_filtered_messages (EmpathyLogStore *self,
741 EmpathyAccount *account,
742 const gchar *chat_id,
745 EmpathyLogMessageFilter filter,
748 GList *dates, *l, *messages = NULL;
751 dates = log_store_empathy_get_dates (self, account, chat_id, chatroom);
753 for (l = g_list_last (dates); l && i < num_messages; l = g_list_previous (l))
755 GList *new_messages, *n, *next;
757 /* FIXME: We should really restrict the message parsing to get only
758 * the newest num_messages. */
759 new_messages = log_store_empathy_get_messages_for_date (self, account,
760 chat_id, chatroom, l->data);
765 next = g_list_next (n);
766 if (!filter (n->data, user_data))
768 g_object_unref (n->data);
769 new_messages = g_list_delete_link (new_messages, n);
777 messages = g_list_concat (messages, new_messages);
780 g_list_foreach (dates, (GFunc) g_free, NULL);
787 log_store_iface_init (gpointer g_iface,
790 EmpathyLogStoreInterface *iface = (EmpathyLogStoreInterface *) g_iface;
792 iface->get_name = log_store_empathy_get_name;
793 iface->exists = log_store_empathy_exists;
794 iface->add_message = log_store_empathy_add_message;
795 iface->get_dates = log_store_empathy_get_dates;
796 iface->get_messages_for_date = log_store_empathy_get_messages_for_date;
797 iface->get_chats = log_store_empathy_get_chats;
798 iface->search_new = log_store_empathy_search_new;
799 iface->ack_message = NULL;
800 iface->get_filtered_messages = log_store_empathy_get_filtered_messages;