path: root/calendar/pcs/query-backend.c

/* Evolution calendar - Backend cache for calendar queries.
 *
 * Copyright (C) 2001 Ximian, Inc.
 *
 * Author: Rodrigo Moya <rodrigo@ximian.com>
 *
 * 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.
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <glib.h>
#include <libgnome/gnome-defs.h>
#include <libgnome/gnome-i18n.h>
#include <gtk/gtksignal.h>
#include <cal-util/cal-component.h>
#include "query.h"
#include "query-backend.h"

static void query_backend_class_init (QueryBackendClass *klass);
static void query_backend_init       (QueryBackend *qb);
static void query_backend_destroy    (GtkObject *object);

typedef struct {
    CalComponent *comp;
} QueryBackendComponent;

/* Private part of the QueryBackend structure */
struct _QueryBackendPrivate {
    char *uri;
    CalBackend *backend;
    GHashTable *components;
    GList *queries;
};

static GHashTable *loaded_backends = NULL;
static GtkObjectClass *parent_class = NULL;

/* Class initialization function for the backend cache */
static void
query_backend_class_init (QueryBackendClass *klass)
{
    GtkObjectClass *object_class = GTK_OBJECT_CLASS (klass);

    parent_class = gtk_type_class (GTK_TYPE_OBJECT);

    object_class->destroy = query_backend_destroy;
}

/* Object initialization function for the backend cache */
static void
query_backend_init (QueryBackend *qb)
{
    QueryBackendPrivate *priv;

    priv = g_new0 (QueryBackendPrivate, 1);
    qb->priv = priv;

    priv->uri = NULL;
    priv->backend = NULL;
    priv->components = g_hash_table_new (g_str_hash, g_str_equal);
    priv->queries = NULL;
}

static void
free_hash_comp_cb (gpointer key, gpointer value, gpointer user_data)
{
    g_free (key);
    gtk_object_unref (GTK_OBJECT (value));
}

/* Destroy handler for the backend cache */
static void
query_backend_destroy (GtkObject *object)
{
    QueryBackend *qb = (QueryBackend *) object;

    g_return_if_fail (object != NULL);
    g_return_if_fail (IS_QUERY_BACKEND (qb));

    /* remove the QueryBackend from the internal hash table */
    g_hash_table_remove (loaded_backends, qb->priv->uri);
    if (g_hash_table_size (loaded_backends) == 0) {
        g_hash_table_destroy (loaded_backends);
        loaded_backends = NULL;
    }

    /* free memory */
    qb->priv->backend = NULL;

    g_free (qb->priv->uri);
    qb->priv->uri = NULL;

    g_hash_table_foreach (qb->priv->components, (GHFunc) free_hash_comp_cb, NULL);
    g_hash_table_destroy (qb->priv->components);
    qb->priv->components = NULL;

    g_list_free (qb->priv->queries);
    qb->priv->queries = NULL;

    g_free (qb->priv);
    qb->priv = NULL;

    if (GTK_OBJECT_CLASS (parent_class)->destroy)
        (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}

/**
 * query_backend_get_type:
 * @void:
 *
 * Registers the #QueryBackend class if necessary, and returns the type ID
 * associated to it.
 *
 * Return value: The type ID of the #QueryBackend class.
 **/
GtkType
query_backend_get_type (void)
{
    static GtkType type = 0;

    if (!type) {
        static const GtkTypeInfo info = {
            "QueryBackend",
            sizeof (QueryBackend),
            sizeof (QueryBackendClass),
            (GtkClassInitFunc) query_backend_class_init,
            (GtkObjectInitFunc) query_backend_init,
            NULL, /* reserved_1 */
            NULL, /* reserved_2 */
            (GtkClassInitFunc) NULL
        };

        type = gtk_type_unique (GTK_TYPE_OBJECT, &info);
    }

    return type;
}

static void
backend_destroyed_cb (GtkObject *object, gpointer user_data)
{
    CalBackend *backend = (CalBackend *) object;
    QueryBackend *qb = (QueryBackend *) user_data;

    g_return_if_fail (IS_CAL_BACKEND (backend));
    g_return_if_fail (IS_QUERY_BACKEND (qb));

    gtk_object_unref (GTK_OBJECT (qb));
}

static void
object_updated_cb (CalBackend *backend, const char *uid, gpointer user_data)
{
    gpointer orig_key, orig_value;
    const char *tmp_uid;
    CalComponent *comp;
    icalcomponent *icalcomp;
    char *comp_str;
    QueryBackend *qb = (QueryBackend *) user_data;

    g_return_if_fail (IS_QUERY_BACKEND (qb));

    if (g_hash_table_lookup_extended (qb->priv->components, uid, &orig_key, &orig_value)) {
        g_hash_table_remove (qb->priv->components, uid);
        g_free (orig_key);
        gtk_object_unref (GTK_OBJECT (orig_value));
    }

    comp_str = cal_backend_get_object (qb->priv->backend, uid);
    if (!comp_str)
        return;

    icalcomp = icalparser_parse_string (comp_str);
    g_free (comp_str);
    if (icalcomp) {
        comp = cal_component_new ();
        if (!cal_component_set_icalcomponent (comp, icalcomp)) {
            icalcomponent_free (icalcomp);
            gtk_object_unref (GTK_OBJECT (comp));
            return;
        }

        cal_component_get_uid (comp, &tmp_uid);
        if (!uid || !*uid) {
            gtk_object_unref (GTK_OBJECT (comp));
        } else
            g_hash_table_insert (qb->priv->components, g_strdup (tmp_uid), comp);
    }
}

static void
object_removed_cb (CalBackend *backend, const char *uid, gpointer user_data)
{
    gpointer orig_key, orig_value;
    QueryBackend *qb = (QueryBackend *) user_data;

    g_return_if_fail (IS_QUERY_BACKEND (qb));

    if (g_hash_table_lookup_extended (qb->priv->components, uid, &orig_key, &orig_value)) {
        g_hash_table_remove (qb->priv->components, uid);
        g_free (orig_key);
        gtk_object_unref (GTK_OBJECT (orig_value));
    }
}

static void
query_destroyed_cb (GtkObject *object, gpointer user_data)
{
    Query *query = (Query *) object;
    QueryBackend *qb = (QueryBackend *) user_data;

    g_return_if_fail (IS_QUERY (query));
    g_return_if_fail (IS_QUERY_BACKEND (qb));

    qb->priv->queries = g_list_remove (qb->priv->queries, query);
}

static void
foreach_uid_cb (gpointer data, gpointer user_data)
{
    QueryBackend *qb = (QueryBackend *) user_data;

    g_return_if_fail (data != NULL);
    g_return_if_fail (IS_QUERY_BACKEND (qb));

    object_updated_cb (qb->priv->backend, (const char *) data, qb);
}

/**
 * query_backend_new
 * @query: The #Query object that issues the query.
 * @backend: A #CalBackend object.
 *
 * Create a new #QueryBackend instance, which is a class to
 * have a cache of objects for the calendar queries, so that
 * we don't have to ask the calendar backend to get the objects
 * everytime.
 *
 * Returns: the newly-created object.
 */
QueryBackend *
query_backend_new (Query *query, CalBackend *backend)
{
    QueryBackend *qb = NULL;

    g_return_val_if_fail (IS_QUERY (query), NULL);
    g_return_val_if_fail (IS_CAL_BACKEND (backend), NULL);

    /* see if we already have the backend loaded */
    qb = g_hash_table_lookup (loaded_backends,
                  cal_backend_get_uri (backend));
    if (!qb) {
        GList *uidlist;

        qb = gtk_type_new (QUERY_BACKEND_TYPE);

        qb->priv->uri = g_strdup (cal_backend_get_uri (backend));
        qb->priv->backend = backend;

        /* load all UIDs */
        uidlist = cal_backend_get_uids (backend, CALOBJ_TYPE_ANY);
        g_list_foreach (uidlist, foreach_uid_cb, qb);
        cal_obj_uid_list_free (uidlist);

        gtk_signal_connect (GTK_OBJECT (backend), "destroy",
                    GTK_SIGNAL_FUNC (backend_destroyed_cb), qb);
        gtk_signal_connect (GTK_OBJECT (backend), "obj_updated",
                    GTK_SIGNAL_FUNC (object_updated_cb), qb);
        gtk_signal_connect (GTK_OBJECT (backend), "obj_removed",
                    GTK_SIGNAL_FUNC (object_removed_cb), qb);

        if (!loaded_backends)
            loaded_backends = g_hash_table_new (g_str_hash, g_str_equal);
        g_hash_table_insert (loaded_backends, qb->priv->uri, qb);
    }

    qb->priv->queries = g_list_append (qb->priv->queries, query);
    gtk_signal_connect (GTK_OBJECT (query), "destroy",
                GTK_SIGNAL_FUNC (query_destroyed_cb), qb);

    return qb;
}

typedef struct {
    GList *uidlist;
    CalObjType type;
} GetUidsData;

static void
uid_hash_cb (gpointer key, gpointer value, gpointer user_data)
{
    CalComponentVType vtype;
    char *uid = (char *) key;
    CalComponent *comp = (CalComponent *) value;
    GetUidsData *uids_data = (GetUidsData *) user_data;

    g_return_if_fail (uid != NULL);
    g_return_if_fail (IS_CAL_COMPONENT (comp));
    g_return_if_fail (uids_data != NULL);

    vtype = cal_component_get_vtype (comp);
    if (vtype == CAL_COMPONENT_EVENT && uids_data->type == CALOBJ_TYPE_EVENT)
        uids_data->uidlist = g_list_append (uids_data->uidlist, g_strdup (uid));
    else if (vtype == CAL_COMPONENT_TODO && uids_data->type == CALOBJ_TYPE_TODO)
        uids_data->uidlist = g_list_append (uids_data->uidlist, g_strdup (uid));
    else if (vtype == CAL_COMPONENT_JOURNAL && uids_data->type == CALOBJ_TYPE_JOURNAL)
        uids_data->uidlist = g_list_append (uids_data->uidlist, g_strdup (uid));
    else if (uids_data->type == CALOBJ_TYPE_ANY)
        uids_data->uidlist = g_list_append (uids_data->uidlist, g_strdup (uid));
}

/**
 * query_backend_get_uids
 * @qb: A #QueryBackend type.
 * @type: Type of objects to get the UIDs for.
 *
 * Get a list of all UIDs for objects of the given type out from
 * the specified #QueryBackend object.
 *
 * Returns: a GList of UIDs, which should be freed, when no longer needed,
 * via a call to cal_obj_uid_list_free.
 */
GList *
query_backend_get_uids (QueryBackend *qb, CalObjType type)
{
    GetUidsData uids_data;

    g_return_val_if_fail (IS_QUERY_BACKEND (qb), NULL);

    uids_data.uidlist = NULL;
    uids_data.type = type;
    g_hash_table_foreach (qb->priv->components, (GHFunc) uid_hash_cb, &uids_data);

    return uids_data.uidlist;
}

/**
 * query_backend_get_object_component
 * @qb: A #QueryBackend object.
 * @uid: UID of the object to retrieve.
 *
 * Get a #CalComponent from the given #QueryBackend.
 *
 * Returns: the component if found, NULL otherwise.
 */
CalComponent *
query_backend_get_object_component (QueryBackend *qb, const char *uid)
{
    g_return_val_if_fail (IS_QUERY_BACKEND (qb), NULL);
    g_return_val_if_fail (uid != NULL, NULL);

    return g_hash_table_lookup (qb->priv->components, uid);
}