Moved the calendar backend here. This is the actual calendar-handling

2000-01-18  Federico Mena Quintero  <federico@helixcode.com>

	* cal-backend.c cal-backend.h: Moved the calendar backend here.
	This is the actual calendar-handling object.
	(load_from_vobject): Moved over from calendar.c.  Modified to use
	a CalBackend instead of the old Calendar structure.
	(add_object): Likewise.

	* cal.c: Now the Cal object is just a calendar client interface
	object; we use it as a "viewport" onto a CalBackend.  This also
	lets us do correct resource management.

	* cal-common.h: New file with common forward declarations; we
	can't have circular dependencies between headers.

2000-01-18  Federico Mena Quintero  <federico@helixcode.com>

	* cal-factory.c (cal_factory_load): Queue a load job.
	(load_fn): Load job handler.  Lookup the calendar by URI, load it
	if it is not loaded, or just report it to the new listener if it is.

	* job.c job.h: New files with a simple job queue manager.

	* gnome-calendar.idl (Listener::cal_loaded): Do not return the
	whole calendar object string.  The client will be able to query
	the calendar for the events it needs.

	* cal-listener.c (Listener_cal_loaded): Ref the calendar GNOME
	object.  We unref it when the listener is destroyed.

2000-01-17  Federico Mena Quintero  <federico@helixcode.com>

	The files from the gncal directory of the gnome-pim module on CVS
	were moved here, to evolution/calendar, in preparation for the
	Evolution work.  The calendar is being split into a model/view
	architecture.  The model is a personal calendar server (PAS):  it
	provides storage, notification, and event generation; the
	views/controllers are the calendar user agents and things like
	Pilot synchronizers.

svn path=/trunk/; revision=1591

1 files changed, 344 insertions, 0 deletions

diff --git a/calendar/cal-backend.c b/calendar/cal-backend.c
new file mode 100644
index 0000000000..2fb523dc14
--- /dev/null
+++ b/calendar/cal-backend.c
@@ -0,0 +1,344 @@
+/* GNOME calendar backend
+ *
+ * Copyright (C) 2000 Helix Code, Inc.
+ *
+ * Author: Federico Mena-Quintero <federico@helixcode.com>
+ *
+ * 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.
+ */
+
+#include <config.h>
+#include "cal-backend.h"
+#include "../libversit/vcc.h"
+
+
+
+/* Private part of the CalBackend structure */
+typedef struct {
+	/* URI where the calendar data is stored */
+	GnomeVFSURI *uri;
+
+	/* List of Cal client interface objects, each with its listener */
+	GList *clients;
+
+	/* All events in the calendar and uri->event hash */
+	GList *events;
+	GHashTable *event_hash;
+
+	/* All TODOs in the calendar */
+	GList *todos;
+
+	/* All journals in the calendar */
+	GList *journals;
+
+	/* Whether a calendar has been loaded */
+	guint loaded : 1;
+} CalBackendPrivate;
+
+
+
+static void cal_backend_class_init (CalBackendClass *class);
+static void cal_backend_init (CalBackend *backend);
+static void cal_backend_destroy (GtkObject *object);
+
+static GtkObjectClass *parent_class;
+
+
+
+/**
+ * cal_backend_get_type:
+ * @void:
+ *
+ * Registers the #CalBackend class if necessary, and returns the type ID
+ * associated to it.
+ *
+ * Return value: The type ID of the #CalBackend class.
+ **/
+GtkType
+cal_backend_get_type (void)
+{
+	static GtkType cal_backend_type = 0;
+
+	if (!cal_backend_type) {
+		static const GtkTypeInfo cal_backend_info = {
+			"CalBackend",
+			sizeof (CalBackend),
+			sizeof (CalBackendClass),
+			(GtkClassInitFunc) cal_backend_class_init,
+			(GtkObjectInitFunc) cal_backend_init,
+			NULL, /* reserved_1 */
+			NULL, /* reserved_2 */
+			(GtkClassInitFunc) NULL
+		};
+
+		cal_backend_type = gtk_type_unique (GTK_TYPE_OBJECT, &cal_backend_info);
+	}
+
+	return cal_backend_type;
+}
+
+/* Class initialization function for the calendar backend */
+static void
+cal_backend_class_init (CalBackendClass *class)
+{
+	GtkObjectClass *object_class;
+
+	object_class = (GtkObjectClass *) class;
+
+	parent_class = gtk_type_class (GTK_TYPE_OBJECT);
+
+	object_class->destroy = cal_backend_destroy;
+}
+
+/* Object initialization function for the calendar backend */
+static void
+cal_backend_init (CalBackend *backend)
+{
+	CalBackendPrivate *priv;
+
+	priv = g_new0 (CalBackendPrivate, 1);
+	backend->priv = priv;
+}
+
+/* Destroy handler for the calendar backend */
+static void
+cal_backend_destroy (GtkObject *object)
+{
+	CalBackend *backend;
+	CalBackendPrivate *priv;
+
+	g_return_if_fail (object != NULL);
+	g_return_if_fail (IS_CAL_BACKEND (object));
+
+	backend = CAL_BACKEND (object);
+	priv = backend->priv;
+
+	/* FIXME: free stuff */
+
+	g_free (priv);
+
+	if (GTK_OBJECT_CLASS (parent_class)->destroy)
+		(* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
+}
+
+
+
+/* Adds an object to the calendar backend */
+static void
+add_object (CalBackend *backend, iCalObject *ico)
+{
+	CalBackendPrivate *priv;
+
+	g_assert (ico != NULL);
+	g_assert (ico->uid != NULL);
+
+	priv = backend->priv;
+
+	ico->new = 0;
+	switch (ico->type) {
+	case ICAL_EVENT:
+		g_hash_table_insert (priv->event_hash, ico->uid, ico);
+		priv->events = g_list_prepend (priv->events, ico);
+#if 0
+		/* FIXME: gnomecal old code */
+		ical_object_try_alarms (ico);
+#ifdef DEBUGGING_MAIL_ALARM
+		ico->malarm.trigger = 0;
+		calendar_notify (0, ico);
+#endif
+#endif
+		break;
+
+	case ICAL_TODO:
+		priv->todos = g_list_prepend (priv->todos, ico);
+		break;
+
+	case ICAL_JOURNAL:
+		priv->journals = g_list_prepend (priv->journals, ico);
+		break;
+
+	default:
+		g_assert_not_reached ();
+	}
+
+	/* FIXME: things must come with an UID! */
+
+	if (!ico->uid) {
+		char buffer [80];
+
+		snprintf (buffer, sizeof (buffer), "GnomeCalendar-%ld\n", time (NULL));
+		ico->uid = g_strdup (buffer);
+	}
+#if 0
+	/* FIXME: gnomecal old code */
+	ico->last_mod = time (NULL);
+#endif
+}
+
+/* Load a calendar from a VObject */
+static void
+load_from_vobject (CalBackend *backend, VObject *vobject)
+{
+	CalBackendPrivate *priv;
+	VObjectIterator i;
+
+	priv = backend->priv;
+
+	g_assert (priv->event_hash == NULL);
+	priv->event_hash = g_hash_table_new (g_str_hash, g_str_equal);
+
+	initPropIterator (&i, vobject);
+
+	while (moreIteration (&i)) {
+		VObject *this;
+		iCalObject *ical;
+		const char *object_name;
+
+		this = nextVObject (&i);
+		object_name = vObjectName (this);
+#if 0
+		/* FIXME?  What is this used for? */
+		if (strcmp (object_name, VCDCreatedProp) == 0) {
+			cal->created = time_from_isodate (str_val (this));
+			continue;
+		}
+#endif
+		if (strcmp (object_name, VCLocationProp) == 0)
+			continue; /* FIXME: imlement */
+
+		if (strcmp (object_name, VCProdIdProp) == 0)
+			continue; /* FIXME: implement */
+
+		if (strcmp (object_name, VCVersionProp) == 0)
+			continue; /* FIXME: implement */
+
+		if (strcmp (object_name, VCTimeZoneProp) == 0)
+			continue; /* FIXME: implement */
+
+		ical = ical_object_create_from_vobject (this, object_name);
+
+		if (ical)
+			add_object (backend, ical);
+	}
+}
+
+
+
+/**
+ * cal_backend_new:
+ * @void:
+ *
+ * Creates a new empty calendar backend.  A calendar must then be loaded or
+ * created before the backend can be used.
+ *
+ * Return value: A newly-created calendar backend.
+ **/
+CalBackend *
+cal_backend_new (void)
+{
+	return CAL_BACKEND (gtk_type_new (TYPE_CAL_BACKEND));
+}
+
+/**
+ * cal_backend_get_uri:
+ * @backend: A calendar backend.
+ *
+ * Queries the URI of a calendar backend, which must already have a loaded
+ * calendar.
+ *
+ * Return value: The URI where the calendar is stored.
+ **/
+GnomeVFSURI *
+cal_backend_get_uri (CalBackend *backend)
+{
+	CalBackendPrivate *priv;
+
+	g_return_val_if_fail (backend != NULL, NULL);
+	g_return_val_if_fail (IS_CAL_BACKEND, NULL);
+
+	priv = backend->priv;
+	g_return_val_if_fail (priv->loaded, NULL);
+	g_assert (priv->uri != NULL);
+
+	return priv->uri;
+}
+
+/**
+ * cal_backend_add_cal:
+ * @backend: A calendar backend.
+ * @cal: A calendar client interface object.
+ *
+ * Adds a calendar client interface object to a calendar @backend.  The calendar
+ * backend must already have a loaded calendar.
+ **/
+void
+cal_backend_add_cal (CalBackend *backend, Cal *cal)
+{
+	CalBackendPrivate *priv;
+
+	g_return_if_fail (backend != NULL);
+	g_return_if_fail (IS_CAL_BACKEND (backend));
+
+	priv = backend->priv;
+	g_return_if_fail (priv->loaded);
+
+	g_return_if_fail (cal != NULL);
+	g_return_if_fail (IS_CAL (cal));
+
+	priv->clients = g_list_prepend (priv->clients, cal);
+}
+
+/**
+ * cal_backend_load:
+ * @backend: A calendar backend.
+ * @str_uri: URI that contains the calendar data.
+ *
+ * Loads a calendar backend with data from a calendar stored at the specified
+ * URI.
+ *
+ * Return value: An operation result code.
+ **/
+CalBackendLoadResult
+cal_backend_load (CalBackend *backend, char *str_uri)
+{
+	CalBackendPrivate *priv;
+	GnomeVFSURI *uri;
+	VObject *vobject;
+
+	g_return_val_if_fail (backend != NULL, CAL_BACKEND_LOAD_ERROR);
+	g_return_val_if_fail (IS_CAL_BACKEND (backend), CAL_BACKEND_LOAD_ERROR);
+	g_return_val_if_fail (str_uri != NULL, CAL_BACKEND_LOAD_ERROR);
+
+	priv = backend->priv;
+	g_return_val_if_fail (!priv->loaded, CAL_BACKEND_LOAD_ERROR);
+
+	uri = gnome_vfs_uri_new (str_uri);
+	if (!uri)
+		return CAL_BACKEND_LOAD_ERROR;
+
+	vobject = Parse_MIME_FromURI (uri);
+	if (!vobject) {
+		gnome_vfs_uri_unref (uri);
+		return CAL_BACKEND_LOAD_ERROR;
+	}
+
+	load_from_vobject (backend, vobject);
+	cleanVObject (vobject);
+	cleanStrTbl ();
+
+	priv->uri = uri;
+	priv->loaded = TRUE;
+	return CAL_BACKEND_LOAD_SUCCESS;
+}