new class for a cache implementation, to be shared between calendar and
authorRodrigo Moya <rodrigo@ximian.com>
Mon, 1 Dec 2003 18:04:04 +0000 (18:04 +0000)
committerRodrigo Moya <rodrigo@src.gnome.org>
Mon, 1 Dec 2003 18:04:04 +0000 (18:04 +0000)
2003-12-01  Rodrigo Moya <rodrigo@ximian.com>

* libedataserver/e-cache.[ch]: new class for a cache implementation,
to be shared between calendar and addressbook backends.

* libedataserver/Makefile.am: added new files.

ChangeLog
libedataserver/Makefile.am
libedataserver/e-cache.c [new file with mode: 0644]
libedataserver/e-cache.h [new file with mode: 0644]

index 1798547..307452f 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2003-12-01  Rodrigo Moya <rodrigo@ximian.com>
+
+       * libedataserver/e-cache.[ch]: new class for a cache implementation,
+       to be shared between calendar and addressbook backends.
+
+       * libedataserver/Makefile.am: added new files.
+
 2003-12-01  Hans Petter Jansson  <hpj@ximian.com>
 
        * libedataserver/e-source.c (e_source_to_standalone_xml): Allow
index 8863fc0..5525f92 100644 (file)
@@ -16,6 +16,7 @@ libedataserver_la_SOURCES =           \
        $(MARSHAL_GENERATED)            \
        e-account-list.c                \
        e-account.c                     \
+       e-cache.c                       \
        e-component-listener.c          \
        e-dbhash.c                      \
        e-db3-utils.c                   \
@@ -44,6 +45,7 @@ libedataserverincludedir = $(privincludedir)/libedataserver
 libedataserverinclude_HEADERS =                \
        e-account-list.h                \
        e-account.h                     \
+       e-cache.h                       \
        e-component-listener.h          \
        e-db3-utils.h                   \
        e-dbhash.h                      \
diff --git a/libedataserver/e-cache.c b/libedataserver/e-cache.c
new file mode 100644 (file)
index 0000000..06793b6
--- /dev/null
@@ -0,0 +1,305 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+/* e-cache.c
+ *
+ * Copyright (C) 2003 Novell, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of version 2 of the GNU General Public
+ * License as published by the Free Software Foundation.
+ *
+ * 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: Rodrigo Moya <rodrigo@ximian.com>
+ */
+
+#include <config.h>
+#include <string.h>
+#include "e-cache.h"
+#include "e-xml-hash-utils.h"
+
+struct _ECachePrivate {
+       char *filename;
+       EXmlHash *xml_hash;
+};
+
+/* Property IDs */
+enum {
+       PROP_0,
+       PROP_FILENAME
+};
+
+static GObjectClass *parent_class = NULL;
+
+static void
+e_cache_set_property (GObject *object, guint property_id, const GValue *value, GParamSpec *pspec)
+{
+       ECache *cache;
+       ECachePrivate *priv;
+
+       cache = E_CACHE (object);
+       priv = cache->priv;
+
+       switch (property_id) {
+       case PROP_FILENAME :
+               if (priv->xml_hash)
+                       e_xmlhash_destroy (priv->xml_hash);
+               priv->xml_hash = e_xmlhash_new ((const char *) g_value_get_string (value));
+               break;
+       default :
+               G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+       }
+}
+
+static void
+e_cache_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec)
+{
+       ECache *cache;
+       ECachePrivate *priv;
+
+       cache = E_CACHE (object);
+       priv = cache->priv;
+
+       switch (property_id) {
+       case PROP_FILENAME :
+               g_value_set_string (value, priv->filename);
+               break;
+       default :
+               G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
+       }
+}
+
+static void
+e_cache_finalize (GObject *object)
+{
+       ECache *cache;
+       ECachePrivate *priv;
+
+       cache = E_CACHE (object);
+       priv = cache->priv;
+
+       if (priv) {
+               if (priv->filename) {
+                       g_free (priv->filename);
+                       priv->filename = NULL;
+               }
+
+               if (priv->xml_hash) {
+                       e_xmlhash_destroy (priv->xml_hash);
+                       priv->xml_hash = NULL;
+               }
+
+               g_free (priv);
+               cache->priv = NULL;
+       }
+
+       parent_class->finalize (object);
+}
+
+static void
+e_cache_class_init (ECacheClass *klass)
+{
+       GObjectClass *object_class;
+
+       parent_class = g_type_class_peek_parent (klass);
+
+       object_class = G_OBJECT_CLASS (klass);
+       object_class->finalize = e_cache_finalize;
+       object_class->set_property = e_cache_set_property;
+       object_class->get_property = e_cache_get_property;
+
+       g_object_class_install_property (object_class, PROP_FILENAME,
+                                        g_param_spec_string ("filename", NULL, NULL, "",
+                                                             G_PARAM_READABLE | G_PARAM_WRITABLE
+                                                             | G_PARAM_CONSTRUCT_ONLY));
+}
+
+static void
+e_cache_init (ECache *cache)
+{
+       ECachePrivate *priv;
+
+       priv = g_new0 (ECachePrivate, 1);
+       cache->priv = priv;
+}
+
+/**
+ * e_cache_get_type:
+ * @void:
+ *
+ * Registers the #ECache class if necessary, and returns the type ID
+ * associated to it.
+ *
+ * Return value: The type ID of the #ECache class.
+ **/
+GType
+e_cache_get_type (void)
+{
+       static GType type = 0;
+
+       if (!type) {
+               static GTypeInfo info = {
+                        sizeof (ECacheClass),
+                        (GBaseInitFunc) NULL,
+                        (GBaseFinalizeFunc) NULL,
+                        (GClassInitFunc) e_cache_class_init,
+                        NULL, NULL,
+                        sizeof (ECache),
+                        0,
+                        (GInstanceInitFunc) e_cache_init,
+                };
+               type = g_type_register_static (G_TYPE_OBJECT, "ECache", &info, 0);
+       }
+
+       return type;
+}
+
+/**
+ * e_cache_new
+ * @filename: filename where the cache is kept.
+ *
+ * Creates a new #ECache object, which implements a cache of
+ * objects, very useful for remote backends.
+ *
+ * Return value: The newly created object.
+ */
+ECache *
+e_cache_new (const char *filename)
+{
+       ECache *cache;
+
+       cache = g_object_new (E_TYPE_CACHE, "filename", filename, NULL);
+
+       return cache;
+}
+
+typedef struct {
+       const char *key;
+       gboolean found;
+       const char *found_value;
+} CacheFindData;
+
+static void
+find_object_in_hash (gpointer key, gpointer value, gpointer user_data)
+{
+       CacheFindData *find_data = user_data;
+
+       if (find_data->found)
+               return;
+
+       if (!strcmp (find_data->key, (const char *) key)) {
+               find_data->found = TRUE;
+               find_data->found_value = (const char *) value;
+       }
+}
+
+/**
+ * e_cache_get_object:
+ */
+const char *
+e_cache_get_object (ECache *cache, const char *key)
+{
+       CacheFindData find_data;
+       ECachePrivate *priv;
+
+       g_return_val_if_fail (E_IS_CACHE (cache), NULL);
+       g_return_val_if_fail (key != NULL, NULL);
+
+       priv = cache->priv;
+
+       find_data.key = key;
+       find_data.found = FALSE;
+       find_data.found_value = NULL;
+
+       e_xmlhash_foreach_key (priv->xml_hash, (EXmlHashFunc) find_object_in_hash, &find_data);
+
+       return find_data.found_value;
+}
+
+/**
+ * e_cache_add_object:
+ */
+gboolean
+e_cache_add_object (ECache *cache, const char *key, const char *value)
+{
+       ECachePrivate *priv;
+
+       g_return_val_if_fail (E_IS_CACHE (cache), FALSE);
+       g_return_val_if_fail (key != NULL, FALSE);
+
+       priv = cache->priv;
+
+       if (e_cache_get_object (cache, key))
+               return FALSE;
+
+       e_xmlhash_add (priv->xml_hash, key, value);
+       e_xmlhash_write (priv->xml_hash);
+
+       return TRUE;
+}
+
+/**
+ * e_cache_replace_object:
+ */
+gboolean
+e_cache_replace_object (ECache *cache, const char *key, const char *new_value)
+{
+       ECachePrivate *priv;
+
+       g_return_val_if_fail (E_IS_CACHE (cache), FALSE);
+       g_return_val_if_fail (key != NULL, FALSE);
+
+       priv = cache->priv;
+
+       if (!e_cache_get_object (cache, key))
+               return FALSE;
+
+       if (!e_cache_remove_object (cache, key))
+               return FALSE;
+
+       return e_cache_add_object (cache, key, new_value);
+}
+
+/**
+ * e_cache_remove_object:
+ */
+gboolean
+e_cache_remove_object (ECache *cache, const char *key)
+{
+       ECachePrivate *priv;
+
+       g_return_val_if_fail (E_IS_CACHE (cache), FALSE);
+       g_return_val_if_fail (key != NULL, FALSE);
+
+       priv = cache->priv;
+
+       if (!e_cache_get_object (cache, key))
+               return FALSE;
+
+       e_xmlhash_remove (priv->xml_hash, key);
+       e_xmlhash_write (priv->xml_hash);
+
+       return TRUE;
+}
+
+/**
+ * e_cache_get_filename:
+ * @cache: A %ECache object.
+ *
+ * Gets the name of the file where the cache is being stored.
+ *
+ * Return value: The name of the cache.
+ */
+const char *
+e_cache_get_filename (ECache *cache)
+{
+       g_return_val_if_fail (E_IS_CACHE (cache), NULL);
+       return (const char *) cache->priv->filename;
+}
+
diff --git a/libedataserver/e-cache.h b/libedataserver/e-cache.h
new file mode 100644 (file)
index 0000000..e984fc3
--- /dev/null
@@ -0,0 +1,59 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
+/* e-cache.h
+ *
+ * Copyright (C) 2003 Novell, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of version 2 of the GNU General Public
+ * License as published by the Free Software Foundation.
+ *
+ * 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: Rodrigo Moya <rodrigo@ximian.com>
+ */
+
+#ifndef E_CACHE_H
+#define E_CACHE_H
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+#define E_TYPE_CACHE            (e_cache_get_type ())
+#define E_CACHE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), E_TYPE_CACHE, ECache))
+#define E_CACHE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), E_TYPE_CACHE, ECacheClass))
+#define E_IS_CACHE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), E_TYPE_CACHE))
+#define E_IS_CACHE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), E_TYPE_CACHE))
+
+typedef struct _ECachePrivate ECachePrivate;
+
+typedef struct {
+       GObject parent;
+       ECachePrivate *priv;
+} ECache;
+
+typedef struct {
+       GObjectClass parent_class;
+} ECacheClass;
+
+GType       e_cache_get_type (void);
+
+ECache     *e_cache_new (const char *filename);
+
+const char *e_cache_get_object (ECache *cache, const char *key);
+gboolean    e_cache_add_object (ECache *cache, const char *key, const char *value);
+gboolean    e_cache_replace_object (ECache *cache, const char *key, const char *new_value);
+gboolean    e_cache_remove_object (ECache *cache, const char *key);
+
+const char *e_cache_get_filename (ECache *cache);
+
+G_END_DECLS
+
+#endif