path: root/calendar/gui/alarm-notify/alarm-notify.c

/* Evolution calendar - Alarm notification service object
 *
 * Copyright (C) 2001 Ximian, Inc.
 *
 * Author: Federico Mena-Quintero <federico@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 <string.h>
#include <libecal/e-cal.h>
#include "alarm-notify.h"
#include "alarm-queue.h"
#include "save.h"
#include "e-util/e-url.h"



/* Private part of the AlarmNotify structure */
struct _AlarmNotifyPrivate {
    /* Mapping from EUri's to LoadedClient structures */
    GHashTable *uri_client_hash;
};



static void alarm_notify_class_init (AlarmNotifyClass *klass);
static void alarm_notify_init (AlarmNotify *an, AlarmNotifyClass *klass);
static void alarm_notify_finalize (GObject *object);


static BonoboObjectClass *parent_class;



GType
alarm_notify_get_type (void)
{
    static GType type = 0;
                                                                                
        if (!type) {
                static GTypeInfo info = {
                        sizeof (AlarmNotifyClass),
                        (GBaseInitFunc) NULL,
                        (GBaseFinalizeFunc) NULL,
                        (GClassInitFunc) alarm_notify_class_init,
                        NULL, NULL,
                        sizeof (AlarmNotify),
                        0,
                        (GInstanceInitFunc) alarm_notify_init
                };
                type = g_type_register_static (G_TYPE_OBJECT, "AlarmNotify", &info, 0);
        }

        return type;
}

/* Class initialization function for the alarm notify service */
static void
alarm_notify_class_init (AlarmNotifyClass *klass)
{
    GObjectClass *object_class;

    object_class = (GObjectClass *) klass;

    parent_class = g_type_class_peek_parent (klass);

    object_class->finalize = alarm_notify_finalize;
}

/* Object initialization function for the alarm notify system */
static void
alarm_notify_init (AlarmNotify *an, AlarmNotifyClass *klass)
{
    AlarmNotifyPrivate *priv;

    priv = g_new0 (AlarmNotifyPrivate, 1);
    an->priv = priv;

    priv->uri_client_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
}

static void
free_client_hash (gpointer key, gpointer value, gpointer user_data)
{
    char *uri = key;
    ECal *client = value;

    g_free (uri);
    g_object_unref (client);
}

/* Finalize handler for the alarm notify system */
static void
alarm_notify_finalize (GObject *object)
{
    AlarmNotify *an;
    AlarmNotifyPrivate *priv;

    g_return_if_fail (object != NULL);
    g_return_if_fail (IS_ALARM_NOTIFY (object));

    an = ALARM_NOTIFY (object);
    priv = an->priv;

    g_hash_table_foreach (priv->uri_client_hash, (GHFunc) free_client_hash, NULL);
    g_hash_table_destroy (priv->uri_client_hash);

    g_free (priv);

    if (G_OBJECT_CLASS (parent_class)->finalize)
        (* G_OBJECT_CLASS (parent_class)->finalize) (object);
}



/* Looks for a canonicalized URI inside an array of URIs; returns the index
 * within the array or -1 if not found.
 */
static int
find_uri_index (GPtrArray *uris, const char *str_uri)
{
    int i;

    for (i = 0; i < uris->len; i++) {
        char *uri;

        uri = uris->pdata[i];
        if (strcmp (uri, str_uri) == 0)
            break;
    }

    if (i == uris->len)
        return -1;
    else
        return i;
}

/* Frees an array of URIs and the URIs within it. */
static void
free_uris (GPtrArray *uris)
{
    int i;

    for (i = 0; i < uris->len; i++) {
        char *uri;

        uri = uris->pdata[i];
        g_free (uri);
    }

    g_ptr_array_free (uris, TRUE);
}

/* Adds an URI to the list of calendars to load on startup */
static void
add_uri_to_load (const char *str_uri)
{
    GPtrArray *loaded_uris;
    int i;

    loaded_uris = get_calendars_to_load ();
    if (!loaded_uris) {
        g_message ("add_uri_to_load(): Could not get the list of calendars to load; "
               "will not add `%s'", str_uri);
        return;
    }

    /* Look for the URI in the list of calendars to load */

    i = find_uri_index (loaded_uris, str_uri);

    /* We only need to add the URI if we didn't find it among the list of
     * calendars.
     */
    if (i != -1) {
        free_uris (loaded_uris);
        return;
    }

    g_ptr_array_add (loaded_uris, g_strdup (str_uri));
    save_calendars_to_load (loaded_uris);

    free_uris (loaded_uris);
}

/* Removes an URI from the list of calendars to load on startup */
static void
remove_uri_to_load (const char *str_uri)
{
    GPtrArray *loaded_uris;
    char *loaded_uri;
    int i;

    loaded_uris = get_calendars_to_load ();
    if (!loaded_uris) {
        g_message ("remove_uri_to_load(): Could not get the list of calendars to load; "
               "will not add `%s'", str_uri);
        return;
    }

    /* Look for the URI in the list of calendars to load */

    i = find_uri_index (loaded_uris, str_uri);

    /* If we didn't find it, there is no need to remove it */
    if (i == -1) {
        free_uris (loaded_uris);
        return;
    }

    loaded_uri = loaded_uris->pdata[i];
    g_free (loaded_uri);

    g_ptr_array_remove_index (loaded_uris, i);
    save_calendars_to_load (loaded_uris);

    free_uris (loaded_uris);
}



/**
 * alarm_notify_new:
 * 
 * Creates a new #AlarmNotify object.
 * 
 * Return value: A newly-created #AlarmNotify, or NULL if its corresponding
 * CORBA object could not be created.
 **/
AlarmNotify *
alarm_notify_new (void)
{
    AlarmNotify *an;

    an = g_object_new (TYPE_ALARM_NOTIFY, NULL);
    return an;
}

/**
 * alarm_notify_add_calendar:
 * @an: An alarm notification service.
 * @uri: URI of the calendar to load.
 * @load_afterwards: Whether this calendar should be loaded in the future
 * when the alarm daemon starts up.
 * 
 * Tells the alarm notification service to load a calendar and start monitoring
 * its alarms.  It can optionally be made to save the URI of this calendar so
 * that it can be loaded in the future when the alarm daemon starts up.
 **/
void
alarm_notify_add_calendar (AlarmNotify *an, const char *str_uri, gboolean load_afterwards)
{
    AlarmNotifyPrivate *priv;
    ECal *client;

    g_return_if_fail (an != NULL);
    g_return_if_fail (IS_ALARM_NOTIFY (an));
    g_return_if_fail (str_uri != NULL);

    priv = an->priv;

    /* See if we already know about this uri */
    if (g_hash_table_lookup (priv->uri_client_hash, str_uri))
        return;

    client = e_cal_new (str_uri, CALOBJ_TYPE_EVENT);

    if (client) {
        if (e_cal_open (client, FALSE, NULL)) {
            add_uri_to_load (str_uri);
            
            g_hash_table_insert (priv->uri_client_hash,
                         g_strdup (str_uri), client);
        }
    }
}

void
alarm_notify_remove_calendar (AlarmNotify *an, const char *str_uri)
{
    AlarmNotifyPrivate *priv;
    ECal *client;

    priv = an->priv;

    client = g_hash_table_lookup (priv->uri_client_hash, str_uri);
    if (client) {
        alarm_queue_remove_client (client);

        g_hash_table_remove (priv->uri_client_hash, str_uri);
    }
    remove_uri_to_load (str_uri);
}