[libgdata] [calendar] Implement ACL functionality on GDataCalendarCalendar

[Philip Withnall <pwithnall src gnome org>]

commit c81b6308a8fbad64618073df83a92d2ff8a5f2c2
Author: Philip Withnall <philip tecnocode co uk>
Date:   Sun May 17 12:53:16 2009 +0100

    [calendar] Implement ACL functionality on GDataCalendarCalendar
    
    GDataCalendarCalendar now implements the GDataAccessHandler interface. A
    complete set of test cases is included.
---
 gdata/services/calendar/gdata-calendar-calendar.c |   17 ++-
 gdata/tests/calendar.c                            |  235 +++++++++++++++++++--
 2 files changed, 235 insertions(+), 17 deletions(-)

diff --git a/gdata/services/calendar/gdata-calendar-calendar.c b/gdata/services/calendar/gdata-calendar-calendar.c
index 64839a9..fefa1b4 100644
--- a/gdata/services/calendar/gdata-calendar-calendar.c
+++ b/gdata/services/calendar/gdata-calendar-calendar.c
@@ -41,7 +41,9 @@
 #include "gdata-gdata.h"
 #include "gdata-parser.h"
 #include "gdata-types.h"
+#include "gdata-access-handler.h"
 
+static void gdata_calendar_calendar_access_handler_init (GDataAccessHandlerIface *iface);
 static void gdata_calendar_calendar_finalize (GObject *object);
 static void gdata_calendar_calendar_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec);
 static void gdata_calendar_calendar_set_property (GObject *object, guint property_id, const GValue *value, GParamSpec *pspec);
@@ -70,7 +72,8 @@ enum {
 	PROP_EDITED
 };
 
-G_DEFINE_TYPE (GDataCalendarCalendar, gdata_calendar_calendar, GDATA_TYPE_ENTRY)
+G_DEFINE_TYPE_WITH_CODE (GDataCalendarCalendar, gdata_calendar_calendar, GDATA_TYPE_ENTRY,
+			 G_IMPLEMENT_INTERFACE (GDATA_TYPE_ACCESS_HANDLER, gdata_calendar_calendar_access_handler_init))
 #define GDATA_CALENDAR_CALENDAR_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GDATA_TYPE_CALENDAR_CALENDAR, GDataCalendarCalendarPrivate))
 
 static void
@@ -180,6 +183,18 @@ gdata_calendar_calendar_init (GDataCalendarCalendar *self)
 	self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, GDATA_TYPE_CALENDAR_CALENDAR, GDataCalendarCalendarPrivate);
 }
 
+static gboolean
+is_owner_rule (GDataAccessRule *rule)
+{
+	return (strcmp (gdata_access_rule_get_role (rule), "http://schemas.google.com/gCal/2005#owner";) == 0) ? TRUE : FALSE;
+}
+
+static void
+gdata_calendar_calendar_access_handler_init (GDataAccessHandlerIface *iface)
+{
+	iface->is_owner_rule = is_owner_rule;
+}
+
 static void
 gdata_calendar_calendar_finalize (GObject *object)
 {
diff --git a/gdata/tests/calendar.c b/gdata/tests/calendar.c
index dc006be..113487c 100644
--- a/gdata/tests/calendar.c
+++ b/gdata/tests/calendar.c
@@ -19,6 +19,7 @@
 
 #include <glib.h>
 #include <unistd.h>
+#include <string.h>
 
 #include "gdata.h"
 #include "common.h"
@@ -27,6 +28,30 @@
 static GDataService *service = NULL;
 static GMainLoop *main_loop = NULL;
 
+static GDataCalendarCalendar *
+get_calendar (GError **error)
+{
+	GDataFeed *calendar_feed;
+	GDataCalendarCalendar *calendar;
+	GList *calendars;
+
+	/* Get a calendar */
+	calendar_feed = gdata_calendar_service_query_own_calendars (GDATA_CALENDAR_SERVICE (service), NULL, NULL, NULL, NULL, error);
+	g_assert_no_error (*error);
+	g_assert (GDATA_IS_FEED (calendar_feed));
+	g_clear_error (error);
+
+	calendars = gdata_feed_get_entries (calendar_feed);
+	g_assert (calendars != NULL);
+	calendar = calendars->data;
+	g_assert (GDATA_IS_CALENDAR_CALENDAR (calendar));
+
+	g_object_ref (calendar);
+	g_object_unref (calendar_feed);
+
+	return calendar;
+}
+
 static void
 test_authentication (void)
 {
@@ -186,26 +211,13 @@ test_query_own_calendars_async (void)
 static void
 test_query_events (void)
 {
-	GDataFeed *feed, *calendar_feed;
+	GDataFeed *feed;
 	GDataCalendarCalendar *calendar;
-	GList *calendars;
 	GError *error = NULL;
 
 	g_assert (service != NULL);
 
-	/* Get a calendar */
-	calendar_feed = gdata_calendar_service_query_own_calendars (GDATA_CALENDAR_SERVICE (service), NULL, NULL, NULL, NULL, &error);
-	g_assert_no_error (error);
-	g_assert (GDATA_IS_FEED (calendar_feed));
-	g_clear_error (&error);
-
-	calendars = gdata_feed_get_entries (calendar_feed);
-	g_assert (calendars != NULL);
-	calendar = calendars->data;
-	g_assert (GDATA_IS_CALENDAR_CALENDAR (calendar));
-
-	g_object_ref (calendar);
-	g_object_unref (calendar_feed);
+	calendar = get_calendar (&error);
 
 	/* Get the entry feed */
 	feed = gdata_calendar_service_query_events (GDATA_CALENDAR_SERVICE (service), calendar, NULL, NULL, NULL, NULL, &error);
@@ -376,7 +388,6 @@ static void
 test_xml_recurrence (void)
 {
 	GDataCalendarEvent *event;
-	gchar *xml;
 	GError *error = NULL;
 	gchar *id, *uri;
 
@@ -506,6 +517,192 @@ test_query_uri (void)
 	g_object_unref (query);
 }
 
+static void
+test_acls_get_rules (void)
+{
+	GDataFeed *feed;
+	GDataCalendarCalendar *calendar;
+	GError *error = NULL;
+
+	g_assert (service != NULL);
+
+	calendar = get_calendar (&error);
+
+	/* Get the rules */
+	feed = gdata_access_handler_get_rules (GDATA_ACCESS_HANDLER (calendar), service, NULL, NULL, NULL, &error);
+	g_assert_no_error (error);
+	g_assert (GDATA_IS_FEED (feed));
+	g_clear_error (&error);
+
+	/* TODO: check rules and feed properties */
+
+	g_object_unref (feed);
+	g_object_unref (calendar);
+}
+
+static void
+test_acls_insert_rule (void)
+{
+	GDataCalendarCalendar *calendar;
+	GDataAccessRule *rule, *new_rule;
+	const gchar *scope_type, *scope_value;
+	GDataCategory *category;
+	GList *categories;
+	gchar *xml;
+	GError *error = NULL;
+
+	g_assert (service != NULL);
+
+	calendar = get_calendar (&error);
+
+	rule = gdata_access_rule_new (NULL);
+
+	gdata_access_rule_set_role (rule, "http://schemas.google.com/gCal/2005#editor";);
+	g_assert_cmpstr (gdata_access_rule_get_role (rule), ==, "http://schemas.google.com/gCal/2005#editor";);
+
+	gdata_access_rule_set_scope (rule, "user", "darcy gmail com");
+	gdata_access_rule_get_scope (rule, &scope_type, &scope_value);
+	g_assert_cmpstr (scope_type, ==, "user");
+	g_assert_cmpstr (scope_value, ==, "darcy gmail com");
+
+	/* Check the XML */
+	xml = gdata_entry_get_xml (GDATA_ENTRY (rule));
+	g_assert_cmpstr (xml, ==,
+			 "<entry xmlns='http://www.w3.org/2005/Atom' "
+			 	"xmlns:gd='http://schemas.google.com/g/2005' "
+			 	"xmlns:gAcl='http://schemas.google.com/acl/2007'>"
+			 	"<title type='text'>http://schemas.google.com/gCal/2005#editor</title>"
+			 	"<category term='http://schemas.google.com/acl/2007#accessRule' scheme='http://schemas.google.com/g/2005#kind'/>"
+				"<gAcl:role value='http://schemas.google.com/gCal/2005#editor'/>"
+				"<gAcl:scope type='user' value='darcy gmail com'/>"
+			 "</entry>");
+	g_free (xml);
+
+	/* Insert the rule */
+	new_rule = gdata_access_handler_insert_rule (GDATA_ACCESS_HANDLER (calendar), service, rule, NULL, &error);
+	g_assert_no_error (error);
+	g_assert (GDATA_IS_ACCESS_RULE (new_rule));
+	g_clear_error (&error);
+
+	/* Check the properties of the returned rule */
+	g_assert_cmpstr (gdata_access_rule_get_role (new_rule), ==, "http://schemas.google.com/gCal/2005#editor";);
+	gdata_access_rule_get_scope (new_rule, &scope_type, &scope_value);
+	g_assert_cmpstr (scope_type, ==, "user");
+	g_assert_cmpstr (scope_value, ==, "darcy gmail com");
+
+	/* Check it only has the one category and that it's correct */
+	categories = gdata_entry_get_categories (GDATA_ENTRY (new_rule));
+	g_assert (categories != NULL);
+	g_assert_cmpuint (g_list_length (categories), ==, 1);
+	category = categories->data;
+	g_assert_cmpstr (category->term, ==, "http://schemas.google.com/acl/2007#accessRule";);
+	g_assert_cmpstr (category->scheme, ==, "http://schemas.google.com/g/2005#kind";);
+	g_assert (category->label == NULL);
+
+	/* TODO: Check more properties? */
+
+	g_object_unref (rule);
+	g_object_unref (new_rule);
+}
+
+static void
+test_acls_update_rule (void)
+{
+	GDataFeed *feed;
+	GDataCalendarCalendar *calendar;
+	GDataAccessRule *rule = NULL, *new_rule;
+	const gchar *scope_type, *scope_value;
+	GList *rules;
+	GError *error = NULL;
+
+	g_assert (service != NULL);
+
+	calendar = get_calendar (&error);
+
+	/* Get a rule */
+	feed = gdata_access_handler_get_rules (GDATA_ACCESS_HANDLER (calendar), service, NULL, NULL, NULL, &error);
+	g_assert_no_error (error);
+	g_assert (GDATA_IS_FEED (feed));
+	g_clear_error (&error);
+
+	/* Find the rule applying to darcy gmail com */
+	for (rules = gdata_feed_get_entries (feed); rules != NULL; rules = rules->next) {
+		gdata_access_rule_get_scope (GDATA_ACCESS_RULE (rules->data), NULL, &scope_value);
+		if (scope_value != NULL && strcmp (scope_value, "darcy gmail com") == 0) {
+			rule = GDATA_ACCESS_RULE (rules->data);
+			break;
+		}
+	}
+	g_assert (GDATA_IS_ACCESS_RULE (rule));
+
+	g_object_ref (rule);
+	g_object_unref (feed);
+
+	/* Update the rule */
+	gdata_access_rule_set_role (rule, "http://schemas.google.com/gCal/2005#read";);
+	g_assert_cmpstr (gdata_access_rule_get_role (rule), ==, "http://schemas.google.com/gCal/2005#read";);
+
+	/* Send the update to the server */
+	new_rule = gdata_access_handler_update_rule (GDATA_ACCESS_HANDLER (calendar), service, rule, NULL, &error);
+	g_assert_no_error (error);
+	g_assert (GDATA_IS_ACCESS_RULE (new_rule));
+	g_clear_error (&error);
+	g_object_unref (rule);
+
+	/* Check the properties of the returned rule */
+	g_assert_cmpstr (gdata_access_rule_get_role (new_rule), ==, "http://schemas.google.com/gCal/2005#read";);
+	gdata_access_rule_get_scope (new_rule, &scope_type, &scope_value);
+	g_assert_cmpstr (scope_type, ==, "user");
+	g_assert_cmpstr (scope_value, ==, "darcy gmail com");
+
+	g_object_unref (new_rule);
+	g_object_unref (calendar);
+}
+
+static void
+test_acls_delete_rule (void)
+{
+	GDataFeed *feed;
+	GDataCalendarCalendar *calendar;
+	GDataAccessRule *rule = NULL;
+	GList *rules;
+	gboolean success;
+	GError *error = NULL;
+
+	g_assert (service != NULL);
+
+	calendar = get_calendar (&error);
+
+	/* Get a rule */
+	feed = gdata_access_handler_get_rules (GDATA_ACCESS_HANDLER (calendar), service, NULL, NULL, NULL, &error);
+	g_assert_no_error (error);
+	g_assert (GDATA_IS_FEED (feed));
+	g_clear_error (&error);
+
+	/* Find the rule applying to darcy gmail com */
+	for (rules = gdata_feed_get_entries (feed); rules != NULL; rules = rules->next) {
+		const gchar *scope_value;
+
+		gdata_access_rule_get_scope (GDATA_ACCESS_RULE (rules->data), NULL, &scope_value);
+		if (scope_value != NULL && strcmp (scope_value, "darcy gmail com") == 0) {
+			rule = GDATA_ACCESS_RULE (rules->data);
+			break;
+		}
+	}
+	g_assert (GDATA_IS_ACCESS_RULE (rule));
+
+	g_object_ref (rule);
+	g_object_unref (feed);
+
+	/* Delete the rule */
+	success = gdata_access_handler_delete_rule (GDATA_ACCESS_HANDLER (calendar), service, rule, NULL, &error);
+	g_assert_no_error (error);
+	g_assert (success == TRUE);
+	g_clear_error (&error);
+
+	g_object_unref (rule);
+}
+
 int
 main (int argc, char *argv[])
 {
@@ -531,6 +728,12 @@ main (int argc, char *argv[])
 	g_test_add_func ("/calendar/xml/dates", test_xml_dates);
 	g_test_add_func ("/calendar/xml/recurrence", test_xml_recurrence);
 	g_test_add_func ("/calendar/query/uri", test_query_uri);
+	g_test_add_func ("/calendar/acls/get_rules", test_acls_get_rules);
+	if (g_test_slow () == TRUE) {
+		g_test_add_func ("/calendar/acls/insert_rule", test_acls_insert_rule);
+		g_test_add_func ("/calendar/acls/update_rule", test_acls_update_rule);
+		g_test_add_func ("/calendar/acls/delete_rule", test_acls_delete_rule);
+	}
 
 	retval = g_test_run ();
 	if (service != NULL)