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 "empathy-log-store.h"
33 #include "empathy-log-store-empathy.h"
34 #include "empathy-log-manager.h"
35 #include "empathy-account-manager.h"
36 #include "empathy-contact.h"
37 #include "empathy-time.h"
38 #include "empathy-utils.h"
40 #define DEBUG_FLAG EMPATHY_DEBUG_OTHER
41 #include "empathy-debug.h"
43 #define LOG_DIR_CREATE_MODE (S_IRUSR | S_IWUSR | S_IXUSR)
44 #define LOG_FILE_CREATE_MODE (S_IRUSR | S_IWUSR)
45 #define LOG_DIR_CHATROOMS "chatrooms"
46 #define LOG_FILENAME_SUFFIX ".log"
47 #define LOG_TIME_FORMAT_FULL "%Y%m%dT%H:%M:%S"
48 #define LOG_TIME_FORMAT "%Y%m%d"
50 "<?xml version='1.0' encoding='utf-8'?>\n" \
51 "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
58 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLogStoreEmpathy)
63 EmpathyAccountManager *account_manager;
64 } EmpathyLogStoreEmpathyPriv;
66 static void log_store_iface_init (gpointer g_iface,gpointer iface_data);
68 G_DEFINE_TYPE_WITH_CODE (EmpathyLogStoreEmpathy, empathy_log_store_empathy,
69 G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (EMPATHY_TYPE_LOG_STORE,
70 log_store_iface_init));
73 log_store_empathy_finalize (GObject *object)
75 EmpathyLogStoreEmpathy *self = EMPATHY_LOG_STORE_EMPATHY (object);
76 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
78 g_object_unref (priv->account_manager);
79 g_free (priv->basedir);
84 empathy_log_store_empathy_class_init (EmpathyLogStoreEmpathyClass *klass)
86 GObjectClass *object_class = G_OBJECT_CLASS (klass);
88 object_class->finalize = log_store_empathy_finalize;
90 g_type_class_add_private (object_class, sizeof (EmpathyLogStoreEmpathyPriv));
94 empathy_log_store_empathy_init (EmpathyLogStoreEmpathy *self)
96 EmpathyLogStoreEmpathyPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
97 EMPATHY_TYPE_LOG_STORE_EMPATHY, EmpathyLogStoreEmpathyPriv);
101 priv->basedir = g_build_path (G_DIR_SEPARATOR_S, g_get_home_dir (),
102 ".gnome2", PACKAGE_NAME, "logs", NULL);
104 priv->name = g_strdup ("Empathy");
105 priv->account_manager = empathy_account_manager_dup_singleton ();
109 log_store_empathy_get_dir (EmpathyLogStore *self,
110 EmpathyAccount *account,
111 const gchar *chat_id,
114 const gchar *account_id;
116 EmpathyLogStoreEmpathyPriv *priv;
118 priv = GET_PRIV (self);
120 account_id = empathy_account_get_unique_name (account);
123 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir, account_id,
124 LOG_DIR_CHATROOMS, chat_id, NULL);
126 basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir,
127 account_id, chat_id, NULL);
133 log_store_empathy_get_timestamp_filename (void)
139 t = empathy_time_get_current ();
140 time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
141 filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
149 log_store_empathy_get_timestamp_from_message (EmpathyMessage *message)
153 t = empathy_message_get_timestamp (message);
155 /* We keep the timestamps in the messages as UTC. */
156 return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
160 log_store_empathy_get_filename (EmpathyLogStore *self,
161 EmpathyAccount *account,
162 const gchar *chat_id,
169 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
170 timestamp = log_store_empathy_get_timestamp_filename ();
171 filename = g_build_filename (basedir, timestamp, NULL);
180 log_store_empathy_add_message (EmpathyLogStore *self,
181 const gchar *chat_id,
183 EmpathyMessage *message,
187 EmpathyAccount *account;
188 EmpathyContact *sender;
189 const gchar *body_str;
191 EmpathyAvatar *avatar;
192 gchar *avatar_token = NULL;
199 TpChannelTextMessageType msg_type;
201 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), FALSE);
202 g_return_val_if_fail (chat_id != NULL, FALSE);
203 g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
205 sender = empathy_message_get_sender (message);
206 account = empathy_contact_get_account (sender);
207 body_str = empathy_message_get_body (message);
208 msg_type = empathy_message_get_tptype (message);
210 if (EMP_STR_EMPTY (body_str))
213 filename = log_store_empathy_get_filename (self, account, chat_id, chatroom);
214 basedir = g_path_get_dirname (filename);
215 if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
217 DEBUG ("Creating directory:'%s'", basedir);
218 g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
222 DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
224 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
226 file = g_fopen (filename, "w+");
228 g_fprintf (file, LOG_HEADER);
230 g_chmod (filename, LOG_FILE_CREATE_MODE);
234 file = g_fopen (filename, "r+");
236 fseek (file, - strlen (LOG_FOOTER), SEEK_END);
239 body = g_markup_escape_text (body_str, -1);
240 timestamp = log_store_empathy_get_timestamp_from_message (message);
242 str = empathy_contact_get_name (sender);
243 contact_name = g_markup_escape_text (str, -1);
245 str = empathy_contact_get_id (sender);
246 contact_id = g_markup_escape_text (str, -1);
248 avatar = empathy_contact_get_avatar (sender);
250 avatar_token = g_markup_escape_text (avatar->token, -1);
253 "<message time='%s' cm_id='%d' id='%s' name='%s' token='%s' isuser='%s' type='%s'>"
254 "%s</message>\n" LOG_FOOTER, timestamp,
255 empathy_message_get_id (message),
256 contact_id, contact_name,
257 avatar_token ? avatar_token : "",
258 empathy_contact_is_user (sender) ? "true" : "false",
259 empathy_message_type_to_str (msg_type), body);
264 g_free (contact_name);
267 g_free (avatar_token);
273 log_store_empathy_exists (EmpathyLogStore *self,
274 EmpathyAccount *account,
275 const gchar *chat_id,
281 dir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
282 exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
289 log_store_empathy_get_dates (EmpathyLogStore *self,
290 EmpathyAccount *account,
291 const gchar *chat_id,
298 const gchar *filename;
301 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
302 g_return_val_if_fail (chat_id != NULL, NULL);
304 directory = log_store_empathy_get_dir (self, account, chat_id, chatroom);
305 dir = g_dir_open (directory, 0, NULL);
308 DEBUG ("Could not open directory:'%s'", directory);
313 DEBUG ("Collating a list of dates in:'%s'", directory);
315 while ((filename = g_dir_read_name (dir)) != NULL)
317 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
320 p = strstr (filename, LOG_FILENAME_SUFFIX);
321 date = g_strndup (filename, p - filename);
326 if (!g_regex_match_simple ("\\d{8}", date, 0, 0))
329 dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
335 DEBUG ("Parsed %d dates", g_list_length (dates));
341 log_store_empathy_get_filename_for_date (EmpathyLogStore *self,
342 EmpathyAccount *account,
343 const gchar *chat_id,
351 basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
352 timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
353 filename = g_build_filename (basedir, timestamp, NULL);
361 static EmpathyLogSearchHit *
362 log_store_empathy_search_hit_new (EmpathyLogStore *self,
363 const gchar *filename)
365 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
366 EmpathyLogSearchHit *hit;
367 const gchar *account_name;
372 if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
375 strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
376 len = g_strv_length (strv);
378 hit = g_slice_new0 (EmpathyLogSearchHit);
380 end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
381 hit->date = g_strndup (strv[len-1], end - strv[len-1]);
382 hit->chat_id = g_strdup (strv[len-2]);
383 hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
385 if (hit->is_chatroom)
386 account_name = strv[len-4];
388 account_name = strv[len-3];
390 hit->account = empathy_account_manager_lookup (priv->account_manager,
392 hit->filename = g_strdup (filename);
400 log_store_empathy_get_messages_for_file (EmpathyLogStore *self,
401 const gchar *filename)
403 GList *messages = NULL;
404 xmlParserCtxtPtr ctxt;
408 EmpathyLogSearchHit *hit;
409 EmpathyAccount *account;
411 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
412 g_return_val_if_fail (filename != NULL, NULL);
414 DEBUG ("Attempting to parse filename:'%s'...", filename);
416 if (!g_file_test (filename, G_FILE_TEST_EXISTS))
418 DEBUG ("Filename:'%s' does not exist", filename);
422 /* Get the account from the filename */
423 hit = log_store_empathy_search_hit_new (self, filename);
424 account = g_object_ref (hit->account);
425 empathy_log_manager_search_hit_free (hit);
428 ctxt = xmlNewParserCtxt ();
430 /* Parse and validate the file. */
431 doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
434 g_warning ("Failed to parse file:'%s'", filename);
435 xmlFreeParserCtxt (ctxt);
439 /* The root node, presets. */
440 log_node = xmlDocGetRootElement (doc);
444 xmlFreeParserCtxt (ctxt);
448 /* Now get the messages. */
449 for (node = log_node->children; node; node = node->next)
451 EmpathyMessage *message;
452 EmpathyContact *sender;
457 gchar *sender_avatar_token;
460 gboolean is_user = FALSE;
464 TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
466 if (strcmp (node->name, "message") != 0)
469 body = xmlNodeGetContent (node);
470 time = xmlGetProp (node, "time");
471 sender_id = xmlGetProp (node, "id");
472 sender_name = xmlGetProp (node, "name");
473 sender_avatar_token = xmlGetProp (node, "token");
474 is_user_str = xmlGetProp (node, "isuser");
475 msg_type_str = xmlGetProp (node, "type");
476 cm_id_str = xmlGetProp (node, "cm_id");
479 is_user = strcmp (is_user_str, "true") == 0;
482 msg_type = empathy_message_type_from_str (msg_type_str);
485 cm_id = atoi (cm_id_str);
487 t = empathy_time_parse (time);
489 sender = empathy_contact_new_for_log (account, sender_id, sender_name,
492 if (!EMP_STR_EMPTY (sender_avatar_token))
493 empathy_contact_load_avatar_cache (sender,
494 sender_avatar_token);
496 message = empathy_message_new (body);
497 empathy_message_set_sender (message, sender);
498 empathy_message_set_timestamp (message, t);
499 empathy_message_set_tptype (message, msg_type);
502 empathy_message_set_id (message, cm_id);
504 messages = g_list_append (messages, message);
506 g_object_unref (sender);
509 xmlFree (sender_name);
511 xmlFree (is_user_str);
512 xmlFree (msg_type_str);
514 xmlFree (sender_avatar_token);
517 DEBUG ("Parsed %d messages", g_list_length (messages));
520 xmlFreeParserCtxt (ctxt);
526 log_store_empathy_get_all_files (EmpathyLogStore *self,
532 const gchar *basedir;
533 EmpathyLogStoreEmpathyPriv *priv;
535 priv = GET_PRIV (self);
537 basedir = dir ? dir : priv->basedir;
539 gdir = g_dir_open (basedir, 0, NULL);
543 while ((name = g_dir_read_name (gdir)) != NULL)
547 filename = g_build_filename (basedir, name, NULL);
548 if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
550 files = g_list_prepend (files, filename);
554 if (g_file_test (filename, G_FILE_TEST_IS_DIR))
556 /* Recursively get all log files */
557 files = g_list_concat (files,
558 log_store_empathy_get_all_files (self, filename));
570 log_store_empathy_search_new (EmpathyLogStore *self,
575 gchar *text_casefold;
577 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
578 g_return_val_if_fail (!EMP_STR_EMPTY (text), NULL);
580 text_casefold = g_utf8_casefold (text, -1);
582 files = log_store_empathy_get_all_files (self, NULL);
583 DEBUG ("Found %d log files in total", g_list_length (files));
585 for (l = files; l; l = g_list_next (l))
591 gchar *contents_casefold;
595 file = g_mapped_file_new (filename, FALSE, NULL);
599 length = g_mapped_file_get_length (file);
600 contents = g_mapped_file_get_contents (file);
601 contents_casefold = g_utf8_casefold (contents, length);
603 g_mapped_file_free (file);
605 if (strstr (contents_casefold, text_casefold))
607 EmpathyLogSearchHit *hit;
609 hit = log_store_empathy_search_hit_new (self, filename);
613 hits = g_list_prepend (hits, hit);
614 DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
615 text, hit->filename, hit->date);
619 g_free (contents_casefold);
624 g_free (text_casefold);
630 log_store_empathy_get_chats_for_dir (EmpathyLogStore *self,
632 gboolean is_chatroom)
637 GError *error = NULL;
639 gdir = g_dir_open (dir, 0, &error);
642 DEBUG ("Failed to open directory: %s, error: %s", dir, error->message);
643 g_error_free (error);
647 while ((name = g_dir_read_name (gdir)) != NULL)
649 EmpathyLogSearchHit *hit;
651 if (!is_chatroom && strcmp (name, LOG_DIR_CHATROOMS) == 0)
653 gchar *filename = g_build_filename (dir, name, NULL);
654 hits = g_list_concat (hits, log_store_empathy_get_chats_for_dir (
655 self, filename, TRUE));
659 hit = g_slice_new0 (EmpathyLogSearchHit);
660 hit->chat_id = g_strdup (name);
661 hit->is_chatroom = is_chatroom;
663 hits = g_list_prepend (hits, hit);
673 log_store_empathy_get_messages_for_date (EmpathyLogStore *self,
674 EmpathyAccount *account,
675 const gchar *chat_id,
682 g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
683 g_return_val_if_fail (chat_id != NULL, NULL);
685 filename = log_store_empathy_get_filename_for_date (self, account,
686 chat_id, chatroom, date);
687 messages = log_store_empathy_get_messages_for_file (self, filename);
694 log_store_empathy_get_chats (EmpathyLogStore *self,
695 EmpathyAccount *account)
699 EmpathyLogStoreEmpathyPriv *priv;
701 priv = GET_PRIV (self);
703 dir = g_build_filename (priv->basedir,
704 empathy_account_get_unique_name (account), NULL);
706 hits = log_store_empathy_get_chats_for_dir (self, dir, FALSE);
714 log_store_empathy_get_name (EmpathyLogStore *self)
716 EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
722 log_store_empathy_get_filtered_messages (EmpathyLogStore *self,
723 EmpathyAccount *account,
724 const gchar *chat_id,
727 EmpathyLogMessageFilter filter,
730 GList *dates, *l, *messages = NULL;
733 dates = log_store_empathy_get_dates (self, account, chat_id, chatroom);
735 for (l = g_list_last (dates); l && i < num_messages; l = g_list_previous (l))
737 GList *new_messages, *n, *next;
739 /* FIXME: We should really restrict the message parsing to get only
740 * the newest num_messages. */
741 new_messages = log_store_empathy_get_messages_for_date (self, account,
742 chat_id, chatroom, l->data);
747 next = g_list_next (n);
748 if (!filter (n->data, user_data))
750 g_object_unref (n->data);
751 new_messages = g_list_delete_link (new_messages, n);
759 messages = g_list_concat (messages, new_messages);
762 g_list_foreach (dates, (GFunc) g_free, NULL);
769 log_store_iface_init (gpointer g_iface,
772 EmpathyLogStoreInterface *iface = (EmpathyLogStoreInterface *) g_iface;
774 iface->get_name = log_store_empathy_get_name;
775 iface->exists = log_store_empathy_exists;
776 iface->add_message = log_store_empathy_add_message;
777 iface->get_dates = log_store_empathy_get_dates;
778 iface->get_messages_for_date = log_store_empathy_get_messages_for_date;
779 iface->get_chats = log_store_empathy_get_chats;
780 iface->search_new = log_store_empathy_search_new;
781 iface->ack_message = NULL;
782 iface->get_filtered_messages = log_store_empathy_get_filtered_messages;