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>
31 /* FIXME: g_mapped_file_free has been deprecated in GLib 2.22, but the
32 * replacement symbol, g_mapped_file_unref is not available in older Glib
33 * and we're not ready to bump our version requirement just for this. When
34 * we're ready to bump our version requirement, just revert this patch. */
35 #undef G_DISABLE_DEPRECATED
36 #include <glib/gstdio.h>
37 #define G_DISABLE_DEPRECATED
39 #include <telepathy-glib/util.h>
41 #include "empathy-log-store.h"
42 #include "empathy-log-store-empathy.h"
43 #include "empathy-log-manager.h"
44 #include "empathy-account-manager.h"
45 #include "empathy-contact.h"
46 #include "empathy-time.h"
47 #include "empathy-utils.h"
49 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
50 #include "empathy-debug.h"
52 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
53 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
54 #define LOG_DIR_CHATROOMS "chatrooms"
55 #define LOG_FILENAME_SUFFIX ".log"
56 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
57 #define LOG_TIME_FORMAT "%Y%m%d"
59 "<?xml version='1.0' encoding='utf-8'?>\n" \
60 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
67 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLogStoreEmpathy)
72 EmpathyAccountManager *account_manager;
73 } EmpathyLogStoreEmpathyPriv;
75 static void log_store_iface_init (gpointer g_iface,gpointer iface_data);
77 G_DEFINE_TYPE_WITH_CODE (EmpathyLogStoreEmpathy, empathy_log_store_empathy,
78 G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (EMPATHY_TYPE_LOG_STORE,
79 log_store_iface_init));
82 log_store_empathy_finalize (GObject *object)
84 EmpathyLogStoreEmpathy *self = EMPATHY_LOG_STORE_EMPATHY (object);
85 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
87 g_object_unref (priv->account_manager);
88 g_free (priv->basedir);
93 empathy_log_store_empathy_class_init (EmpathyLogStoreEmpathyClass *klass)
95 GObjectClass *object_class = G_OBJECT_CLASS (klass);
97 object_class->finalize = log_store_empathy_finalize;
99 g_type_class_add_private (object_class, sizeof (EmpathyLogStoreEmpathyPriv));
103 empathy_log_store_empathy_init (EmpathyLogStoreEmpathy *self)
105 EmpathyLogStoreEmpathyPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
106 EMPATHY_TYPE_LOG_STORE_EMPATHY, EmpathyLogStoreEmpathyPriv);
110 priv->basedir = g_build_path (G_DIR_SEPARATOR_S, g_get_user_data_dir (),
111 PACKAGE_NAME, "logs", NULL);
113 priv->name = g_strdup ("Empathy");
114 priv->account_manager = empathy_account_manager_dup_singleton ();
118 log_store_empathy_get_dir (EmpathyLogStore *self,
119 EmpathyAccount *account,
120 const gchar *chat_id,
125 EmpathyLogStoreEmpathyPriv *priv;
127 priv = GET_PRIV (self);
129 /* unique name is an object path, ignore the initial / and replace the others
131 escaped = g_strdup (empathy_account_get_unique_name (account) + 1);
133 g_strdelimit (escaped, "/", '%');
136 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir, escaped,
137 LOG_DIR_CHATROOMS, chat_id, NULL);
139 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir,
140 escaped, chat_id, NULL);
148 log_store_empathy_get_timestamp_filename (void)
154 t = empathy_time_get_current ();
155 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
156 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
164 log_store_empathy_get_timestamp_from_message (EmpathyMessage *message)
168 t = empathy_message_get_timestamp (message);
170 /* We keep the timestamps in the messages as UTC. */
171 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
175 log_store_empathy_get_filename (EmpathyLogStore *self,
176 EmpathyAccount *account,
177 const gchar *chat_id,
184 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
185 timestamp = log_store_empathy_get_timestamp_filename ();
186 filename = g_build_filename (basedir, timestamp, NULL);
195 log_store_empathy_add_message (EmpathyLogStore *self,
196 const gchar *chat_id,
198 EmpathyMessage *message,
202 EmpathyAccount *account;
203 EmpathyContact *sender;
204 const gchar *body_str;
206 EmpathyAvatar *avatar;
207 gchar *avatar_token = NULL;
214 TpChannelTextMessageType msg_type;
216 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), FALSE);
217 g_return_val_if_fail (chat_id != NULL, FALSE);
218 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
220 sender = empathy_message_get_sender (message);
221 account = empathy_contact_get_account (sender);
222 body_str = empathy_message_get_body (message);
223 msg_type = empathy_message_get_tptype (message);
225 if (EMP_STR_EMPTY (body_str))
228 filename = log_store_empathy_get_filename (self, account, chat_id, chatroom);
229 basedir = g_path_get_dirname (filename);
230 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
232 DEBUG ("Creating directory:'%s'", basedir);
233 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
237 DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
239 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
241 file = g_fopen (filename, "w+");
243 g_fprintf (file, LOG_HEADER);
245 g_chmod (filename, LOG_FILE_CREATE_MODE);
249 file = g_fopen (filename, "r+");
251 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
254 body = g_markup_escape_text (body_str, -1);
255 timestamp = log_store_empathy_get_timestamp_from_message (message);
257 str = empathy_contact_get_name (sender);
258 contact_name = g_markup_escape_text (str, -1);
260 str = empathy_contact_get_id (sender);
261 contact_id = g_markup_escape_text (str, -1);
263 avatar = empathy_contact_get_avatar (sender);
265 avatar_token = g_markup_escape_text (avatar->token, -1);
268 "<message time='%s' cm_id='%d' id='%s' name='%s' token='%s' isuser='%s' type='%s'>"
269 "%s</message>\n" LOG_FOOTER, timestamp,
270 empathy_message_get_id (message),
271 contact_id, contact_name,
272 avatar_token ? avatar_token : "",
273 empathy_contact_is_user (sender) ? "true" : "false",
274 empathy_message_type_to_str (msg_type), body);
279 g_free (contact_name);
282 g_free (avatar_token);
288 log_store_empathy_exists (EmpathyLogStore *self,
289 EmpathyAccount *account,
290 const gchar *chat_id,
296 dir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
297 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
304 log_store_empathy_get_dates (EmpathyLogStore *self,
305 EmpathyAccount *account,
306 const gchar *chat_id,
313 const gchar *filename;
316 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
317 g_return_val_if_fail (chat_id != NULL, NULL);
319 directory = log_store_empathy_get_dir (self, account, chat_id, chatroom);
320 dir = g_dir_open (directory, 0, NULL);
323 DEBUG ("Could not open directory:'%s'", directory);
328 DEBUG ("Collating a list of dates in:'%s'", directory);
330 while ((filename = g_dir_read_name (dir)) != NULL)
332 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
335 p = strstr (filename, LOG_FILENAME_SUFFIX);
336 date = g_strndup (filename, p - filename);
341 if (!g_regex_match_simple ("\\d{8}", date, 0, 0))
344 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
350 DEBUG ("Parsed %d dates", g_list_length (dates));
356 log_store_empathy_get_filename_for_date (EmpathyLogStore *self,
357 EmpathyAccount *account,
358 const gchar *chat_id,
366 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
367 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
368 filename = g_build_filename (basedir, timestamp, NULL);
376 static EmpathyLogSearchHit *
377 log_store_empathy_search_hit_new (EmpathyLogStore *self,
378 const gchar *filename)
380 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
381 EmpathyLogSearchHit *hit;
388 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
391 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
392 len = g_strv_length (strv);
394 hit = g_slice_new0 (EmpathyLogSearchHit);
396 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
397 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
398 hit->chat_id = g_strdup (strv[len-2]);
399 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
401 if (hit->is_chatroom)
402 account_name = strv[len-4];
404 account_name = strv[len-3];
406 unescaped = g_strdup_printf ("/%s", g_strdelimit (account_name, "%", '/'));
408 hit->account = empathy_account_manager_lookup (priv->account_manager,
410 hit->filename = g_strdup (filename);
419 log_store_empathy_get_messages_for_file (EmpathyLogStore *self,
420 const gchar *filename)
422 GList *messages = NULL;
423 xmlParserCtxtPtr ctxt;
427 EmpathyLogSearchHit *hit;
428 EmpathyAccount *account;
430 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
431 g_return_val_if_fail (filename != NULL, NULL);
433 DEBUG ("Attempting to parse filename:'%s'...", filename);
435 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
437 DEBUG ("Filename:'%s' does not exist", filename);
441 /* Get the account from the filename */
442 hit = log_store_empathy_search_hit_new (self, filename);
444 if (hit->account != NULL)
445 account = g_object_ref (hit->account);
447 empathy_log_manager_search_hit_free (hit);
449 if (hit->account == NULL)
453 ctxt = xmlNewParserCtxt ();
455 /* Parse and validate the file. */
456 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
459 g_warning ("Failed to parse file:'%s'", filename);
460 xmlFreeParserCtxt (ctxt);
464 /* The root node, presets. */
465 log_node = xmlDocGetRootElement (doc);
469 xmlFreeParserCtxt (ctxt);
473 /* Now get the messages. */
474 for (node = log_node->children; node; node = node->next)
476 EmpathyMessage *message;
477 EmpathyContact *sender;
482 gchar *sender_avatar_token;
485 gboolean is_user = FALSE;
489 TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
491 if (strcmp (node->name, "message") != 0)
494 body = xmlNodeGetContent (node);
495 time = xmlGetProp (node, "time");
496 sender_id = xmlGetProp (node, "id");
497 sender_name = xmlGetProp (node, "name");
498 sender_avatar_token = xmlGetProp (node, "token");
499 is_user_str = xmlGetProp (node, "isuser");
500 msg_type_str = xmlGetProp (node, "type");
501 cm_id_str = xmlGetProp (node, "cm_id");
504 is_user = strcmp (is_user_str, "true") == 0;
507 msg_type = empathy_message_type_from_str (msg_type_str);
510 cm_id = atoi (cm_id_str);
512 t = empathy_time_parse (time);
514 sender = empathy_contact_new_for_log (account, sender_id, sender_name,
517 if (!EMP_STR_EMPTY (sender_avatar_token))
518 empathy_contact_load_avatar_cache (sender,
519 sender_avatar_token);
521 message = empathy_message_new (body);
522 empathy_message_set_sender (message, sender);
523 empathy_message_set_timestamp (message, t);
524 empathy_message_set_tptype (message, msg_type);
525 empathy_message_set_is_backlog (message, TRUE);
528 empathy_message_set_id (message, cm_id);
530 messages = g_list_append (messages, message);
532 g_object_unref (sender);
535 xmlFree (sender_name);
537 xmlFree (is_user_str);
538 xmlFree (msg_type_str);
540 xmlFree (sender_avatar_token);
543 DEBUG ("Parsed %d messages", g_list_length (messages));
546 xmlFreeParserCtxt (ctxt);
552 log_store_empathy_get_all_files (EmpathyLogStore *self,
558 const gchar *basedir;
559 EmpathyLogStoreEmpathyPriv *priv;
561 priv = GET_PRIV (self);
563 basedir = dir ? dir : priv->basedir;
565 gdir = g_dir_open (basedir, 0, NULL);
569 while ((name = g_dir_read_name (gdir)) != NULL)
573 filename = g_build_filename (basedir, name, NULL);
574 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
576 files = g_list_prepend (files, filename);
580 if (g_file_test (filename, G_FILE_TEST_IS_DIR))
582 /* Recursively get all log files */
583 files = g_list_concat (files,
584 log_store_empathy_get_all_files (self, filename));
596 log_store_empathy_search_new (EmpathyLogStore *self,
601 gchar *text_casefold;
603 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
604 g_return_val_if_fail (!EMP_STR_EMPTY (text), NULL);
606 text_casefold = g_utf8_casefold (text, -1);
608 files = log_store_empathy_get_all_files (self, NULL);
609 DEBUG ("Found %d log files in total", g_list_length (files));
611 for (l = files; l; l = g_list_next (l))
617 gchar *contents_casefold;
621 file = g_mapped_file_new (filename, FALSE, NULL);
625 length = g_mapped_file_get_length (file);
626 contents = g_mapped_file_get_contents (file);
627 contents_casefold = g_utf8_casefold (contents, length);
629 g_mapped_file_free (file);
631 if (strstr (contents_casefold, text_casefold))
633 EmpathyLogSearchHit *hit;
635 hit = log_store_empathy_search_hit_new (self, filename);
639 hits = g_list_prepend (hits, hit);
640 DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
641 text, hit->filename, hit->date);
645 g_free (contents_casefold);
650 g_free (text_casefold);
656 log_store_empathy_get_chats_for_dir (EmpathyLogStore *self,
658 gboolean is_chatroom)
663 GError *error = NULL;
665 gdir = g_dir_open (dir, 0, &error);
668 DEBUG ("Failed to open directory: %s, error: %s", dir, error->message);
669 g_error_free (error);
673 while ((name = g_dir_read_name (gdir)) != NULL)
675 EmpathyLogSearchHit *hit;
677 if (!is_chatroom && strcmp (name, LOG_DIR_CHATROOMS) == 0)
679 gchar *filename = g_build_filename (dir, name, NULL);
680 hits = g_list_concat (hits, log_store_empathy_get_chats_for_dir (
681 self, filename, TRUE));
685 hit = g_slice_new0 (EmpathyLogSearchHit);
686 hit->chat_id = g_strdup (name);
687 hit->is_chatroom = is_chatroom;
689 hits = g_list_prepend (hits, hit);
699 log_store_empathy_get_messages_for_date (EmpathyLogStore *self,
700 EmpathyAccount *account,
701 const gchar *chat_id,
708 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
709 g_return_val_if_fail (chat_id != NULL, NULL);
711 filename = log_store_empathy_get_filename_for_date (self, account,
712 chat_id, chatroom, date);
713 messages = log_store_empathy_get_messages_for_file (self, filename);
720 log_store_empathy_get_chats (EmpathyLogStore *self,
721 EmpathyAccount *account)
725 EmpathyLogStoreEmpathyPriv *priv;
727 priv = GET_PRIV (self);
729 dir = g_build_filename (priv->basedir,
730 empathy_account_get_unique_name (account), NULL);
732 hits = log_store_empathy_get_chats_for_dir (self, dir, FALSE);
740 log_store_empathy_get_name (EmpathyLogStore *self)
742 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
748 log_store_empathy_get_filtered_messages (EmpathyLogStore *self,
749 EmpathyAccount *account,
750 const gchar *chat_id,
753 EmpathyLogMessageFilter filter,
756 GList *dates, *l, *messages = NULL;
759 dates = log_store_empathy_get_dates (self, account, chat_id, chatroom);
761 for (l = g_list_last (dates); l && i < num_messages; l = g_list_previous (l))
763 GList *new_messages, *n, *next;
765 /* FIXME: We should really restrict the message parsing to get only
766 * the newest num_messages. */
767 new_messages = log_store_empathy_get_messages_for_date (self, account,
768 chat_id, chatroom, l->data);
773 next = g_list_next (n);
774 if (!filter (n->data, user_data))
776 g_object_unref (n->data);
777 new_messages = g_list_delete_link (new_messages, n);
785 messages = g_list_concat (messages, new_messages);
788 g_list_foreach (dates, (GFunc) g_free, NULL);
795 log_store_iface_init (gpointer g_iface,
798 EmpathyLogStoreInterface *iface = (EmpathyLogStoreInterface *) g_iface;
800 iface->get_name = log_store_empathy_get_name;
801 iface->exists = log_store_empathy_exists;
802 iface->add_message = log_store_empathy_add_message;
803 iface->get_dates = log_store_empathy_get_dates;
804 iface->get_messages_for_date = log_store_empathy_get_messages_for_date;
805 iface->get_chats = log_store_empathy_get_chats;
806 iface->search_new = log_store_empathy_search_new;
807 iface->ack_message = NULL;
808 iface->get_filtered_messages = log_store_empathy_get_filtered_messages;