Renamed EmpathyLogSource to EmpathyLogStore.

Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>

svn path=/trunk/; revision=2593

1 files changed, 714 insertions, 0 deletions

diff --git a/libempathy/empathy-log-store-empathy.c b/libempathy/empathy-log-store-empathy.c
new file mode 100644
index 000000000..e9cf887b2
--- /dev/null
+++ b/libempathy/empathy-log-store-empathy.c
@@ -0,0 +1,714 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+/*
+ * Copyright (C) 2003-2007 Imendio AB
+ * Copyright (C) 2007-2008 Collabora Ltd.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation; either version 2 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Authors: Xavier Claessens <xclaesse@gmail.com>
+ *          Jonny Lamb <jonny.lamb@collabora.co.uk>
+ */
+
+#include <config.h>
+
+#include <string.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <glib/gstdio.h>
+
+#include "empathy-log-store.h"
+#include "empathy-log-store-empathy.h"
+#include "empathy-log-manager.h"
+#include "empathy-contact.h"
+#include "empathy-time.h"
+#include "empathy-utils.h"
+
+#define DEBUG_FLAG EMPATHY_DEBUG_OTHER
+#include "empathy-debug.h"
+
+#define LOG_DIR_CREATE_MODE       (S_IRUSR | S_IWUSR | S_IXUSR)
+#define LOG_FILE_CREATE_MODE      (S_IRUSR | S_IWUSR)
+#define LOG_DIR_CHATROOMS         "chatrooms"
+#define LOG_FILENAME_SUFFIX       ".log"
+#define LOG_TIME_FORMAT_FULL      "%Y%m%dT%H:%M:%S"
+#define LOG_TIME_FORMAT           "%Y%m%d"
+#define LOG_HEADER \
+    "<?xml version='1.0' encoding='utf-8'?>\n" \
+    "<?xml-stylesheet type=\"text/xsl\" href=\"empathy-log.xsl\"?>\n" \
+    "<log>\n"
+
+#define LOG_FOOTER \
+    "</log>\n"
+
+
+#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyLogStoreEmpathy)
+typedef struct
+{
+  gchar *basedir;
+  gchar *name;
+} EmpathyLogStoreEmpathyPriv;
+
+static void log_store_iface_init (gpointer g_iface,gpointer iface_data);
+
+G_DEFINE_TYPE_WITH_CODE (EmpathyLogStoreEmpathy, empathy_log_store_empathy,
+    G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (EMPATHY_TYPE_LOG_STORE,
+      log_store_iface_init));
+
+static void
+log_store_empathy_finalize (GObject *object)
+{
+  EmpathyLogStoreEmpathy *self = EMPATHY_LOG_STORE_EMPATHY (object);
+  EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
+
+  g_free (priv->basedir);
+  g_free (priv->name);
+}
+
+static void
+empathy_log_store_empathy_class_init (EmpathyLogStoreEmpathyClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->finalize = log_store_empathy_finalize;
+
+  g_type_class_add_private (object_class, sizeof (EmpathyLogStoreEmpathyPriv));
+}
+
+static void
+empathy_log_store_empathy_init (EmpathyLogStoreEmpathy *self)
+{
+  EmpathyLogStoreEmpathyPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
+      EMPATHY_TYPE_LOG_STORE_EMPATHY, EmpathyLogStoreEmpathyPriv);
+
+  self->priv = priv;
+
+  priv->basedir = g_build_path (G_DIR_SEPARATOR_S, g_get_home_dir (),
+      ".gnome2", PACKAGE_NAME, "logs", NULL);
+
+  priv->name = g_strdup ("Empathy");
+}
+
+static gchar *
+log_store_empathy_get_dir (EmpathyLogStore *self,
+                           McAccount *account,
+                           const gchar *chat_id,
+                           gboolean chatroom)
+{
+  const gchar *account_id;
+  gchar *basedir;
+  EmpathyLogStoreEmpathyPriv *priv;
+
+  priv = GET_PRIV (self);
+
+  account_id = mc_account_get_unique_name (account);
+
+  if (chatroom)
+    basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir, account_id,
+        LOG_DIR_CHATROOMS, chat_id, NULL);
+  else
+    basedir = g_build_path (G_DIR_SEPARATOR_S, priv->basedir,
+        account_id, chat_id, NULL);
+
+  return basedir;
+}
+
+static gchar *
+log_store_empathy_get_timestamp_filename (void)
+{
+  time_t t;
+  gchar *time_str;
+  gchar *filename;
+
+  t = empathy_time_get_current ();
+  time_str = empathy_time_to_string_local (t, LOG_TIME_FORMAT);
+  filename = g_strconcat (time_str, LOG_FILENAME_SUFFIX, NULL);
+
+  g_free (time_str);
+
+  return filename;
+}
+
+static gchar *
+log_store_empathy_get_timestamp_from_message (EmpathyMessage *message)
+{
+  time_t t;
+
+  t = empathy_message_get_timestamp (message);
+
+  /* We keep the timestamps in the messages as UTC. */
+  return empathy_time_to_string_utc (t, LOG_TIME_FORMAT_FULL);
+}
+
+static gchar *
+log_store_empathy_get_filename (EmpathyLogStore *self,
+                                McAccount *account,
+                                const gchar *chat_id,
+                                gboolean chatroom)
+{
+  gchar *basedir;
+  gchar *timestamp;
+  gchar *filename;
+
+  basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
+  timestamp = log_store_empathy_get_timestamp_filename ();
+  filename = g_build_filename (basedir, timestamp, NULL);
+
+  g_free (basedir);
+  g_free (timestamp);
+
+  return filename;
+}
+
+static gboolean
+log_store_empathy_add_message (EmpathyLogStore *self,
+                               const gchar *chat_id,
+                               gboolean chatroom,
+                               EmpathyMessage *message,
+                               GError **error)
+{
+  FILE *file;
+  McAccount *account;
+  EmpathyContact *sender;
+  const gchar *body_str;
+  const gchar *str;
+  EmpathyAvatar *avatar;
+  gchar *avatar_token = NULL;
+  gchar *filename;
+  gchar *basedir;
+  gchar *body;
+  gchar *timestamp;
+  gchar *contact_name;
+  gchar *contact_id;
+  TpChannelTextMessageType msg_type;
+
+  g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), FALSE);
+  g_return_val_if_fail (chat_id != NULL, FALSE);
+  g_return_val_if_fail (EMPATHY_IS_MESSAGE (message), FALSE);
+
+  sender = empathy_message_get_sender (message);
+  account = empathy_contact_get_account (sender);
+  body_str = empathy_message_get_body (message);
+  msg_type = empathy_message_get_tptype (message);
+
+  if (G_STR_EMPTY (body_str))
+    return FALSE;
+
+  filename = log_store_empathy_get_filename (self, account, chat_id, chatroom);
+  basedir = g_path_get_dirname (filename);
+  if (!g_file_test (basedir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))
+    {
+      DEBUG ("Creating directory:'%s'", basedir);
+      g_mkdir_with_parents (basedir, LOG_DIR_CREATE_MODE);
+    }
+  g_free (basedir);
+
+  DEBUG ("Adding message: '%s' to file: '%s'", body_str, filename);
+
+  if (!g_file_test (filename, G_FILE_TEST_EXISTS))
+    {
+      file = g_fopen (filename, "w+");
+      if (file)
+        g_fprintf (file, LOG_HEADER);
+
+      g_chmod (filename, LOG_FILE_CREATE_MODE);
+    }
+  else
+    {
+      file = g_fopen (filename, "r+");
+      if (file)
+        fseek (file, - strlen (LOG_FOOTER), SEEK_END);
+    }
+
+  body = g_markup_escape_text (body_str, -1);
+  timestamp = log_store_empathy_get_timestamp_from_message (message);
+
+  str = empathy_contact_get_name (sender);
+  contact_name = g_markup_escape_text (str, -1);
+
+  str = empathy_contact_get_id (sender);
+  contact_id = g_markup_escape_text (str, -1);
+
+  avatar = empathy_contact_get_avatar (sender);
+  if (avatar)
+    avatar_token = g_markup_escape_text (avatar->token, -1);
+
+  g_fprintf (file,
+       "<message time='%s' id='%s' name='%s' token='%s' isuser='%s' type='%s'>"
+       "%s</message>\n" LOG_FOOTER, timestamp, contact_id, contact_name,
+       avatar_token ? avatar_token : "",
+       empathy_contact_is_user (sender) ? "true" : "false",
+       empathy_message_type_to_str (msg_type), body);
+
+  fclose (file);
+  g_free (filename);
+  g_free (contact_id);
+  g_free (contact_name);
+  g_free (timestamp);
+  g_free (body);
+  g_free (avatar_token);
+
+  return TRUE;
+}
+
+static gboolean
+log_store_empathy_exists (EmpathyLogStore *self,
+                          McAccount *account,
+                          const gchar *chat_id,
+                          gboolean chatroom)
+{
+  gchar *dir;
+  gboolean exists;
+
+  dir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
+  exists = g_file_test (dir, G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR);
+  g_free (dir);
+
+  return exists;
+}
+
+static GList *
+log_store_empathy_get_dates (EmpathyLogStore *self,
+                             McAccount *account,
+                             const gchar *chat_id,
+                             gboolean chatroom)
+{
+  GList *dates = NULL;
+  gchar *date;
+  gchar *directory;
+  GDir *dir;
+  const gchar *filename;
+  const gchar *p;
+
+  g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
+  g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
+  g_return_val_if_fail (chat_id != NULL, NULL);
+
+  directory = log_store_empathy_get_dir (self, account, chat_id, chatroom);
+  dir = g_dir_open (directory, 0, NULL);
+  if (!dir)
+    {
+      DEBUG ("Could not open directory:'%s'", directory);
+      g_free (directory);
+      return NULL;
+    }
+
+  DEBUG ("Collating a list of dates in:'%s'", directory);
+
+  while ((filename = g_dir_read_name (dir)) != NULL)
+    {
+      if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
+        continue;
+
+      p = strstr (filename, LOG_FILENAME_SUFFIX);
+      date = g_strndup (filename, p - filename);
+
+      if (!date)
+        continue;
+
+      if (!g_regex_match_simple ("\\d{8}", date, 0, 0))
+        continue;
+
+      dates = g_list_insert_sorted (dates, date, (GCompareFunc) strcmp);
+    }
+
+  g_free (directory);
+  g_dir_close (dir);
+
+  DEBUG ("Parsed %d dates", g_list_length (dates));
+
+  return dates;
+}
+
+static gchar *
+log_store_empathy_get_filename_for_date (EmpathyLogStore *self,
+                                         McAccount *account,
+                                         const gchar *chat_id,
+                                         gboolean chatroom,
+                                         const gchar *date)
+{
+  gchar *basedir;
+  gchar *timestamp;
+  gchar *filename;
+
+  basedir = log_store_empathy_get_dir (self, account, chat_id, chatroom);
+  timestamp = g_strconcat (date, LOG_FILENAME_SUFFIX, NULL);
+  filename = g_build_filename (basedir, timestamp, NULL);
+
+  g_free (basedir);
+  g_free (timestamp);
+
+  return filename;
+}
+
+static EmpathyLogSearchHit *
+log_store_empathy_search_hit_new (EmpathyLogStore *self,
+                                  const gchar *filename)
+{
+  EmpathyLogSearchHit *hit;
+  const gchar *account_name;
+  const gchar *end;
+  gchar **strv;
+  guint len;
+
+  if (!g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
+    return NULL;
+
+  strv = g_strsplit (filename, G_DIR_SEPARATOR_S, -1);
+  len = g_strv_length (strv);
+
+  hit = g_slice_new0 (EmpathyLogSearchHit);
+
+  end = strstr (strv[len-1], LOG_FILENAME_SUFFIX);
+  hit->date = g_strndup (strv[len-1], end - strv[len-1]);
+  hit->chat_id = g_strdup (strv[len-2]);
+  hit->is_chatroom = (strcmp (strv[len-3], LOG_DIR_CHATROOMS) == 0);
+
+  if (hit->is_chatroom)
+    account_name = strv[len-4];
+  else
+    account_name = strv[len-3];
+
+  hit->account = mc_account_lookup (account_name);
+  hit->filename = g_strdup (filename);
+
+  g_strfreev (strv);
+
+  return hit;
+}
+
+static GList *
+log_store_empathy_get_messages_for_file (EmpathyLogStore *self,
+                                         const gchar *filename)
+{
+  GList *messages = NULL;
+  xmlParserCtxtPtr ctxt;
+  xmlDocPtr doc;
+  xmlNodePtr log_node;
+  xmlNodePtr node;
+  EmpathyLogSearchHit *hit;
+  McAccount *account;
+
+  g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
+  g_return_val_if_fail (filename != NULL, NULL);
+
+  DEBUG ("Attempting to parse filename:'%s'...", filename);
+
+  if (!g_file_test (filename, G_FILE_TEST_EXISTS))
+    {
+      DEBUG ("Filename:'%s' does not exist", filename);
+      return NULL;
+    }
+
+  /* Get the account from the filename */
+  hit = log_store_empathy_search_hit_new (self, filename);
+  account = g_object_ref (hit->account);
+  empathy_log_manager_search_hit_free (hit);
+
+  /* Create parser. */
+  ctxt = xmlNewParserCtxt ();
+
+  /* Parse and validate the file. */
+  doc = xmlCtxtReadFile (ctxt, filename, NULL, 0);
+  if (!doc)
+    {
+      g_warning ("Failed to parse file:'%s'", filename);
+      xmlFreeParserCtxt (ctxt);
+      return NULL;
+    }
+
+  /* The root node, presets. */
+  log_node = xmlDocGetRootElement (doc);
+  if (!log_node)
+    {
+      xmlFreeDoc (doc);
+      xmlFreeParserCtxt (ctxt);
+      return NULL;
+    }
+
+  /* Now get the messages. */
+  for (node = log_node->children; node; node = node->next)
+    {
+      EmpathyMessage *message;
+      EmpathyContact *sender;
+      gchar *time;
+      time_t t;
+      gchar *sender_id;
+      gchar *sender_name;
+      gchar *sender_avatar_token;
+      gchar *body;
+      gchar *is_user_str;
+      gboolean is_user = FALSE;
+      gchar *msg_type_str;
+      TpChannelTextMessageType msg_type = TP_CHANNEL_TEXT_MESSAGE_TYPE_NORMAL;
+
+      if (strcmp (node->name, "message") != 0)
+        continue;
+
+      body = xmlNodeGetContent (node);
+      time = xmlGetProp (node, "time");
+      sender_id = xmlGetProp (node, "id");
+      sender_name = xmlGetProp (node, "name");
+      sender_avatar_token = xmlGetProp (node, "token");
+      is_user_str = xmlGetProp (node, "isuser");
+      msg_type_str = xmlGetProp (node, "type");
+
+      if (is_user_str)
+        is_user = strcmp (is_user_str, "true") == 0;
+
+      if (msg_type_str)
+        msg_type = empathy_message_type_from_str (msg_type_str);
+
+      t = empathy_time_parse (time);
+
+      sender = empathy_contact_new_full (account, sender_id, sender_name);
+      empathy_contact_set_is_user (sender, is_user);
+      if (!G_STR_EMPTY (sender_avatar_token))
+        empathy_contact_load_avatar_cache (sender,
+            sender_avatar_token);
+
+      message = empathy_message_new (body);
+      empathy_message_set_sender (message, sender);
+      empathy_message_set_timestamp (message, t);
+      empathy_message_set_tptype (message, msg_type);
+
+      messages = g_list_append (messages, message);
+
+      g_object_unref (sender);
+      xmlFree (time);
+      xmlFree (sender_id);
+      xmlFree (sender_name);
+      xmlFree (body);
+      xmlFree (is_user_str);
+      xmlFree (msg_type_str);
+    }
+
+  DEBUG ("Parsed %d messages", g_list_length (messages));
+
+  xmlFreeDoc (doc);
+  xmlFreeParserCtxt (ctxt);
+
+  return messages;
+}
+
+static GList *
+log_store_empathy_get_all_files (EmpathyLogStore *self,
+                                 const gchar *dir)
+{
+  GDir *gdir;
+  GList *files = NULL;
+  const gchar *name;
+  const gchar *basedir;
+  EmpathyLogStoreEmpathyPriv *priv;
+
+  priv = GET_PRIV (self);
+
+  basedir = dir ? dir : priv->basedir;
+
+  gdir = g_dir_open (basedir, 0, NULL);
+  if (!gdir)
+    return NULL;
+
+  while ((name = g_dir_read_name (gdir)) != NULL)
+    {
+      gchar *filename;
+
+      filename = g_build_filename (basedir, name, NULL);
+      if (g_str_has_suffix (filename, LOG_FILENAME_SUFFIX))
+        {
+          files = g_list_prepend (files, filename);
+          continue;
+        }
+
+      if (g_file_test (filename, G_FILE_TEST_IS_DIR))
+        {
+          /* Recursively get all log files */
+          files = g_list_concat (files,
+              log_store_empathy_get_all_files (self, filename));
+        }
+
+      g_free (filename);
+    }
+
+  g_dir_close (gdir);
+
+  return files;
+}
+
+static GList *
+log_store_empathy_search_new (EmpathyLogStore *self,
+                              const gchar *text)
+{
+  GList *files, *l;
+  GList *hits = NULL;
+  gchar *text_casefold;
+
+  g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
+  g_return_val_if_fail (!G_STR_EMPTY (text), NULL);
+
+  text_casefold = g_utf8_casefold (text, -1);
+
+  files = log_store_empathy_get_all_files (self, NULL);
+  DEBUG ("Found %d log files in total", g_list_length (files));
+
+  for (l = files; l; l = l->next)
+    {
+      gchar *filename;
+      GMappedFile *file;
+      gsize length;
+      gchar *contents;
+      gchar *contents_casefold;
+
+      filename = l->data;
+
+      file = g_mapped_file_new (filename, FALSE, NULL);
+      if (!file)
+        continue;
+
+      length = g_mapped_file_get_length (file);
+      contents = g_mapped_file_get_contents (file);
+      contents_casefold = g_utf8_casefold (contents, length);
+
+      g_mapped_file_free (file);
+
+      if (strstr (contents_casefold, text_casefold))
+        {
+          EmpathyLogSearchHit *hit;
+
+          hit = log_store_empathy_search_hit_new (self, filename);
+
+          if (hit)
+            {
+              hits = g_list_prepend (hits, hit);
+              DEBUG ("Found text:'%s' in file:'%s' on date:'%s'",
+                  text, hit->filename, hit->date);
+            }
+        }
+
+      g_free (contents_casefold);
+      g_free (filename);
+    }
+
+  g_list_free (files);
+  g_free (text_casefold);
+
+  return hits;
+}
+
+static GList *
+log_store_empathy_get_chats_for_dir (EmpathyLogStore *self,
+                                     const gchar *dir,
+                                     gboolean is_chatroom)
+{
+  GDir *gdir;
+  GList *hits = NULL;
+  const gchar *name;
+
+  gdir = g_dir_open (dir, 0, NULL);
+  if (!gdir)
+    return NULL;
+
+  while ((name = g_dir_read_name (gdir)) != NULL)
+    {
+      EmpathyLogSearchHit *hit;
+      gchar *filename;
+
+      filename = g_build_filename (dir, name, NULL);
+      if (strcmp (name, LOG_DIR_CHATROOMS) == 0)
+        {
+          hits = g_list_concat (hits, log_store_empathy_get_chats_for_dir (
+                self, dir, TRUE));
+          g_free (filename);
+          continue;
+        }
+
+      hit = g_slice_new0 (EmpathyLogSearchHit);
+      hit->chat_id = g_strdup (name);
+      hit->is_chatroom = is_chatroom;
+
+      hits = g_list_prepend (hits, hit);
+    }
+
+  g_dir_close (gdir);
+
+  return hits;
+}
+
+
+static GList *
+log_store_empathy_get_messages_for_date (EmpathyLogStore *self,
+                                         McAccount *account,
+                                         const gchar *chat_id,
+                                         gboolean chatroom,
+                                         const gchar *date)
+{
+  gchar *filename;
+  GList *messages;
+
+  g_return_val_if_fail (EMPATHY_IS_LOG_STORE (self), NULL);
+  g_return_val_if_fail (MC_IS_ACCOUNT (account), NULL);
+  g_return_val_if_fail (chat_id != NULL, NULL);
+
+  filename = log_store_empathy_get_filename_for_date (self, account,
+      chat_id, chatroom, date);
+  messages = log_store_empathy_get_messages_for_file (self, filename);
+  g_free (filename);
+
+  return messages;
+}
+
+static GList *
+log_store_empathy_get_chats (EmpathyLogStore *self,
+                              McAccount *account)
+{
+  gchar *dir;
+  GList *hits;
+  EmpathyLogStoreEmpathyPriv *priv;
+
+  priv = GET_PRIV (self);
+
+  dir = g_build_filename (priv->basedir,
+      mc_account_get_unique_name (account), NULL);
+
+  hits = log_store_empathy_get_chats_for_dir (self, dir, FALSE);
+
+  g_free (dir);
+
+  return hits;
+}
+
+static const gchar *
+log_store_empathy_get_name (EmpathyLogStore *self)
+{
+  EmpathyLogStoreEmpathyPriv *priv = GET_PRIV (self);
+
+  return priv->name;
+}
+
+static void
+log_store_iface_init (gpointer g_iface,
+                      gpointer iface_data)
+{
+  EmpathyLogStoreInterface *iface = (EmpathyLogStoreInterface *) g_iface;
+
+  iface->get_name = log_store_empathy_get_name;
+  iface->exists = log_store_empathy_exists;
+  iface->add_message = log_store_empathy_add_message;
+  iface->get_dates = log_store_empathy_get_dates;
+  iface->get_messages_for_date = log_store_empathy_get_messages_for_date;
+  iface->get_chats = log_store_empathy_get_chats;
+  iface->search_new = log_store_empathy_search_new;
+  iface->ack_message = NULL;
+}