Merge lp:~rainct/libzeitgeist/event-origin-subject-current-uri into lp:libzeitgeist

[Siegfried Gevatter]

[Mikkel Kamstrup Erlandsen (kamstrup)]

Looking good Siegfried, and I am glad we that we can stick this in the ABI stable series. from the principle that any mrq with more than 100 lines must have at least one comment - here goes ;-) :

28 + * This differs from a subject's origin, as it describes where the event comes
29 + * from, not where it resides.

Can you add this event.set_origin() as well?

review: Needs Fixing

[lp:~rainct/libzeitgeist/event-origin-subject-current-uri]

216. By Siegfried Gevatter on 2012-02-02

Improve documentation of zeitgeist_event_set_origin

[Siegfried Gevatter (rainct)]

Done :)

[Mikkel Kamstrup Erlandsen (kamstrup)]

Great work!

review: Approve

=== modified file 'src/zeitgeist-event.c'
--- src/zeitgeist-event.c	2011-07-11 18:05:11 +0000
+++ src/zeitgeist-event.c	2012-02-02 09:59:18 +0000
@@ -82,6 +82,7 @@
   ZEITGEIST_EVENT_INTERPRETATION,
   ZEITGEIST_EVENT_MANIFESTATION,
   ZEITGEIST_EVENT_ACTOR,
+  ZEITGEIST_EVENT_ORIGIN,
 } ZeitgeistEventDataOffset;
 
 typedef struct
@@ -91,6 +92,7 @@
   gchar      *interpretation;
   gchar      *manifestation;
   gchar      *actor;
+  gchar      *origin;
   GPtrArray  *subjects;
   GByteArray *payload;
 } ZeitgeistEventPrivate;
@@ -431,6 +433,53 @@
 }
 
 /**
+ * zeitgeist_event_get_origin:
+ * @event: The event to get the origin from
+ *
+ * Get the origin of an event.
+ * This differs from a subject's origin, as it describes where the event comes
+ * from, not where it resides.
+ *
+ * Returns: The origin of @event.
+ */
+const gchar*
+zeitgeist_event_get_origin (ZeitgeistEvent *event)
+{
+  g_return_val_if_fail (ZEITGEIST_IS_EVENT (event), NULL);
+
+  ZeitgeistEventPrivate* priv = ZEITGEIST_EVENT_GET_PRIVATE (event);
+  
+  return priv->origin;
+}
+
+/**
+ * zeitgeist_event_set_origin:
+ * @event: The event to set the origin of
+ * @origin: The origin to set
+ *
+ * Set the origin of an event.
+ * This differs from a subject's origin, as it describes where the event comes
+ * from, not where it resides.
+ */
+void
+zeitgeist_event_set_origin (ZeitgeistEvent *event,
+                            const gchar    *origin)
+{
+  g_return_if_fail (ZEITGEIST_IS_EVENT (event));
+
+  ZeitgeistEventPrivate* priv = ZEITGEIST_EVENT_GET_PRIVATE (event);
+
+  gchar* copy = g_strdup (origin);
+
+  if (priv->origin)
+    {
+      g_free (priv->origin);
+    }
+  
+  priv->origin = copy;
+}
+
+/**
  * zeitgeist_event_get_payload:
  * @event: The event to get the payload for
  *
@@ -439,7 +488,6 @@
  * Returns: The event payload or %NULL if unset. Do not free. If you want to
  *          keep the subject around you need to g_byte_array_ref() it.
  */
-
 GByteArray*
 zeitgeist_event_get_payload (ZeitgeistEvent *event)
 {
@@ -491,6 +539,7 @@
   priv->interpretation = NULL;
   priv->manifestation = NULL;
   priv->actor = NULL;
+  priv->origin = NULL;
   priv->subjects = g_ptr_array_new_with_free_func (
                                                 (GDestroyNotify)g_object_unref);
   priv->payload = NULL;
@@ -506,14 +555,15 @@
 
   if (priv->subjects)
     {
-      /* Subjects are unreffed by the free-func of the GPtrArray  */
+      /* Subjects are unreffed by the free-func of the GPtrArray */
       g_ptr_array_unref (priv->subjects);
       priv->subjects = NULL;
     }
   
   zeitgeist_event_set_interpretation (event, NULL);
   zeitgeist_event_set_manifestation (event, NULL);
-  zeitgeist_event_set_actor (event, NULL);  
+  zeitgeist_event_set_actor (event, NULL);
+  zeitgeist_event_set_origin (event, NULL);
   zeitgeist_event_set_payload (event, NULL);
 
   G_OBJECT_CLASS (zeitgeist_event_parent_class)->finalize (object);
@@ -550,6 +600,7 @@
   return self;
 }
 
+// FIXME: add `origin' parameter
 /** 
  * zeitgeist_event_new_full:
  * @interpretation: The interpretation type of the event.
@@ -691,6 +742,9 @@
   zeitgeist_event_set_actor (result,  str[0] == '\0' ? NULL : str);
   g_free (str);
 
+  if (g_variant_iter_loop (event_data, "s", &str))
+    zeitgeist_event_set_origin (result, str[0] == '\0' ? NULL : str);
+
   /* Build the list of subjects */
   while (g_variant_iter_loop (subjects, "as", &subject_data))
   {
@@ -732,6 +786,9 @@
     zeitgeist_subject_set_storage (subject, str[0] == '\0' ? NULL : str);
     g_free (str);
 
+    if (g_variant_iter_loop (subject_data, "s", &str))
+      zeitgeist_subject_set_current_uri (subject, str[0] == '\0' ? NULL : str);
+
     zeitgeist_event_add_subject (result, subject);
   }
 
@@ -799,6 +856,7 @@
   g_variant_builder_add (&b, "s", (bif = zeitgeist_event_get_interpretation(event), bif ? bif : ""));
   g_variant_builder_add (&b, "s", (bif = zeitgeist_event_get_manifestation(event), bif ? bif : ""));
   g_variant_builder_add (&b, "s", (bif = zeitgeist_event_get_actor (event), bif ? bif : ""));
+  g_variant_builder_add (&b, "s", (bif = zeitgeist_event_get_origin (event), bif ? bif : ""));
   g_variant_builder_close (&b);
 
   /* Build subjects */
@@ -815,6 +873,7 @@
       g_variant_builder_add (&b, "s", (bif = zeitgeist_subject_get_mimetype(su), bif ? bif : ""));
       g_variant_builder_add (&b, "s", (bif = zeitgeist_subject_get_text(su), bif ? bif : ""));
       g_variant_builder_add (&b, "s", (bif = zeitgeist_subject_get_storage(su), bif ? bif : ""));
+      g_variant_builder_add (&b, "s", (bif = zeitgeist_subject_get_current_uri(su), bif ? bif : ""));
       g_variant_builder_close (&b);
     }
   g_variant_builder_close (&b);
 
=== modified file 'src/zeitgeist-event.h'
--- src/zeitgeist-event.h	2011-03-07 14:19:39 +0000
+++ src/zeitgeist-event.h	2012-02-02 09:59:18 +0000
@@ -104,6 +104,10 @@
 void         zeitgeist_event_set_actor         (ZeitgeistEvent *event,
                                                 const gchar    *actor);
 
+const gchar* zeitgeist_event_get_origin        (ZeitgeistEvent *event);
+void         zeitgeist_event_set_origin        (ZeitgeistEvent *event,
+                                                const gchar    *origin);
+
 void         zeitgeist_event_set_actor_from_app_info (ZeitgeistEvent *event,
                                                       GAppInfo       *appinfo);
         
 
=== modified file 'src/zeitgeist-subject.c'
--- src/zeitgeist-subject.c	2011-03-07 14:19:39 +0000
+++ src/zeitgeist-subject.c	2012-02-02 09:59:18 +0000
@@ -43,6 +43,8 @@
   ZEITGEIST_SUBJECT_MIMETYPE,
   ZEITGEIST_SUBJECT_ORIGIN,
   ZEITGEIST_SUBJECT_TEXT,
+  ZEITGEIST_SUBJECT_STORAGE,
+  ZEITGEIST_SUBJECT_CURRENT_URI,
 } ZeitgeistSubjectDataOffset;
 
 typedef struct
@@ -54,6 +56,7 @@
   gchar *origin;
   gchar *text;
   gchar *storage;
+  gchar *current_uri;
 } ZeitgeistSubjectPrivate;
 
 const gchar*
@@ -245,6 +248,33 @@
   priv->storage = copy;
 }
 
+const gchar*
+zeitgeist_subject_get_current_uri (ZeitgeistSubject *subject)
+{
+  g_return_val_if_fail (ZEITGEIST_IS_SUBJECT (subject), NULL);
+
+  ZeitgeistSubjectPrivate *priv = ZEITGEIST_SUBJECT_GET_PRIVATE (subject);
+  return priv->current_uri;
+}
+
+void
+zeitgeist_subject_set_current_uri (ZeitgeistSubject *subject,
+                                   const gchar *current_uri)
+{
+  g_return_if_fail (ZEITGEIST_IS_SUBJECT (subject));
+
+  ZeitgeistSubjectPrivate *priv = ZEITGEIST_SUBJECT_GET_PRIVATE (subject);
+
+  gchar* copy = g_strdup (current_uri);
+
+  if (priv->current_uri)
+    {
+      g_free (priv->current_uri);
+    }
+
+  priv->current_uri = copy;
+}
+
 static void
 zeitgeist_subject_init (ZeitgeistSubject *object)
 {
@@ -258,6 +288,7 @@
   priv->origin = NULL;
   priv->text = NULL;
   priv->storage = NULL;
+  priv->current_uri = NULL;
 }
 
 static void
@@ -275,6 +306,7 @@
   zeitgeist_subject_set_origin (subject, NULL);
   zeitgeist_subject_set_text (subject, NULL);
   zeitgeist_subject_set_storage (subject, NULL);
+  zeitgeist_subject_set_current_uri (subject, NULL);
   
   G_OBJECT_CLASS (zeitgeist_subject_parent_class)->finalize (object);
 }
@@ -306,6 +338,7 @@
   return g_object_new (ZEITGEIST_TYPE_SUBJECT, NULL);
 }
 
+// FIXME: add `current_uri' parameter
 /** 
  * zeitgeist_subject_new_full:
  * @uri: The URI or URL of the subject
@@ -319,7 +352,6 @@
  * @text: A small textual representation of the subject suitable for display
  * @storage: String identifier for the storage medium the subject is on.
  *           Se zeitgeist_subject_set_storage() for details
- * 
  * Create a new subject structure with predefined data
  *
  * Returns: A newly create #ZeitgeistSubject instance. The returned subject will
@@ -347,6 +379,6 @@
   zeitgeist_subject_set_origin (self, origin);
   zeitgeist_subject_set_text (self, text);
   zeitgeist_subject_set_storage (self, storage);
-    
+
   return self;
 }
 
=== modified file 'src/zeitgeist-subject.h'
--- src/zeitgeist-subject.h	2011-03-07 14:19:39 +0000
+++ src/zeitgeist-subject.h	2012-02-02 09:59:18 +0000
@@ -101,6 +101,10 @@
 void         zeitgeist_subject_set_storage        (ZeitgeistSubject *subject,
                                                    const gchar      *storage);
 
+const gchar* zeitgeist_subject_get_current_uri    (ZeitgeistSubject *subject);
+void         zeitgeist_subject_set_current_uri    (ZeitgeistSubject *subject,
+                                                   const gchar      *current_uri);
+
 G_END_DECLS
 
 #endif /* _ZEITGEIST_SUBJECT_H_ */
 
=== modified file 'tests/test-event.c'
--- tests/test-event.c	2011-02-14 08:27:28 +0000
+++ tests/test-event.c	2012-02-02 09:59:18 +0000
@@ -62,6 +62,7 @@
   g_assert_cmpstr (NULL, ==, zeitgeist_event_get_interpretation (ev));
   g_assert_cmpstr (NULL, ==, zeitgeist_event_get_manifestation (ev));
   g_assert_cmpstr (NULL, ==, zeitgeist_event_get_actor (ev));
+  g_assert_cmpstr (NULL, ==, zeitgeist_event_get_origin (ev));
   g_assert_cmpint (0, ==, zeitgeist_event_num_subjects (ev));
   g_assert (zeitgeist_event_get_payload (ev) == NULL);
 
@@ -94,6 +95,7 @@
   g_assert_cmpstr (ZEITGEIST_ZG_ACCESS_EVENT,==, zeitgeist_event_get_interpretation (ev));
   g_assert_cmpstr (ZEITGEIST_ZG_USER_ACTIVITY, ==, zeitgeist_event_get_manifestation (ev));
   g_assert_cmpstr ("application://firefox.desktop", ==, zeitgeist_event_get_actor (ev));
+  g_assert (zeitgeist_event_get_origin (ev) == NULL);
   g_assert_cmpint (2, ==, zeitgeist_event_num_subjects (ev));
   g_assert (zeitgeist_event_get_payload (ev) == NULL);
 
@@ -105,6 +107,7 @@
   g_assert_cmpstr ("http://example.com", ==, zeitgeist_subject_get_origin (su));
   g_assert_cmpstr ("example.com", ==, zeitgeist_subject_get_text (su));
   g_assert_cmpstr ("net", ==, zeitgeist_subject_get_storage (su));
+  g_assert (zeitgeist_subject_get_current_uri (su) == NULL);
 
   su = zeitgeist_event_get_subject (ev, 1);
   g_assert (zeitgeist_subject_get_uri(su) == NULL);
@@ -114,6 +117,7 @@
   g_assert (zeitgeist_subject_get_origin (su) == NULL);
   g_assert (zeitgeist_subject_get_text (su) == NULL);
   g_assert (zeitgeist_subject_get_storage (su) == NULL);
+  g_assert (zeitgeist_subject_get_current_uri (su) == NULL);
 
   g_object_unref (ev);
 }
@@ -183,16 +187,93 @@
   g_assert_cmpstr (ZEITGEIST_ZG_ACCESS_EVENT,==, zeitgeist_event_get_interpretation (ev));
   g_assert_cmpstr (ZEITGEIST_ZG_USER_ACTIVITY, ==, zeitgeist_event_get_manifestation (ev));
   g_assert_cmpstr ("application://foo.desktop", ==, zeitgeist_event_get_actor (ev));
-  g_assert_cmpint (1, ==, zeitgeist_event_num_subjects (ev));
-
-  su = zeitgeist_event_get_subject (ev, 0);
-  g_assert_cmpstr ("file:///tmp/foo.txt", ==, zeitgeist_subject_get_uri(su));
-  g_assert_cmpstr (ZEITGEIST_NFO_DOCUMENT, ==, zeitgeist_subject_get_interpretation (su));
-  g_assert_cmpstr (ZEITGEIST_NFO_FILE_DATA_OBJECT, ==, zeitgeist_subject_get_manifestation (su));
-  g_assert_cmpstr ("text/plain", ==, zeitgeist_subject_get_mimetype (su));
-  g_assert_cmpstr ("file:///tmp", ==, zeitgeist_subject_get_origin (su));
-  g_assert_cmpstr ("foo.txt", ==, zeitgeist_subject_get_text (su));
-  g_assert_cmpstr ("36e5604e-7e1b-4ebd-bb6a-184c6ea99627", ==, zeitgeist_subject_get_storage (su));
+  g_assert (zeitgeist_event_get_origin (ev) == NULL);
+  g_assert_cmpint (1, ==, zeitgeist_event_num_subjects (ev));
+
+  su = zeitgeist_event_get_subject (ev, 0);
+  g_assert_cmpstr ("file:///tmp/foo.txt", ==, zeitgeist_subject_get_uri(su));
+  g_assert_cmpstr (ZEITGEIST_NFO_DOCUMENT, ==, zeitgeist_subject_get_interpretation (su));
+  g_assert_cmpstr (ZEITGEIST_NFO_FILE_DATA_OBJECT, ==, zeitgeist_subject_get_manifestation (su));
+  g_assert_cmpstr ("text/plain", ==, zeitgeist_subject_get_mimetype (su));
+  g_assert_cmpstr ("file:///tmp", ==, zeitgeist_subject_get_origin (su));
+  g_assert_cmpstr ("foo.txt", ==, zeitgeist_subject_get_text (su));
+  g_assert_cmpstr ("36e5604e-7e1b-4ebd-bb6a-184c6ea99627", ==, zeitgeist_subject_get_storage (su));
+  g_assert (zeitgeist_subject_get_current_uri (su) == NULL);
+
+  payload = zeitgeist_event_get_payload (ev);
+  g_assert (payload != NULL);
+  g_assert_cmpint (3, ==, payload->len);
+  g_assert_cmpint (1, ==, payload->data[0]);
+  g_assert_cmpint (2, ==, payload->data[1]);
+  g_assert_cmpint (3, ==, payload->data[2]);
+
+  g_object_unref (ev);
+}
+
+static void
+test_from_variant_with_new_fields (Fixture *fix, gconstpointer data)
+{
+  GVariant *var;
+  GVariantBuilder b;
+  ZeitgeistEvent *ev;
+  ZeitgeistSubject *su;
+  GByteArray *payload;
+
+  g_variant_builder_init (&b, ZEITGEIST_EVENT_VARIANT_TYPE);
+
+  /* Build event data */
+  g_variant_builder_open (&b, G_VARIANT_TYPE ("as"));
+  g_variant_builder_add (&b, "s", "27");
+  g_variant_builder_add (&b, "s", "68");
+  g_variant_builder_add (&b, "s", ZEITGEIST_ZG_ACCESS_EVENT);
+  g_variant_builder_add (&b, "s", ZEITGEIST_ZG_USER_ACTIVITY);
+  g_variant_builder_add (&b, "s", "application://foo.desktop");
+  g_variant_builder_add (&b, "s", "origin");
+  g_variant_builder_close (&b);
+
+  /* Build subjects */
+  g_variant_builder_open (&b, G_VARIANT_TYPE ("aas"));
+    {
+      g_variant_builder_open (&b, G_VARIANT_TYPE ("as"));
+      g_variant_builder_add (&b, "s", "file:///tmp/foo.txt");
+      g_variant_builder_add (&b, "s", ZEITGEIST_NFO_DOCUMENT);
+      g_variant_builder_add (&b, "s", ZEITGEIST_NFO_FILE_DATA_OBJECT);
+      g_variant_builder_add (&b, "s", "file:///tmp");
+      g_variant_builder_add (&b, "s", "text/plain");
+      g_variant_builder_add (&b, "s", "foo.txt");
+      g_variant_builder_add (&b, "s", "36e5604e-7e1b-4ebd-bb6a-184c6ea99627");
+      g_variant_builder_add (&b, "s", "file:///tmp/current.txt");
+      g_variant_builder_close (&b);
+    }
+  g_variant_builder_close (&b);
+
+  /* Build payload */
+  g_variant_builder_open (&b, G_VARIANT_TYPE ("ay"));
+  g_variant_builder_add (&b, "y", 1);
+  g_variant_builder_add (&b, "y", 2);
+  g_variant_builder_add (&b, "y", 3);
+  g_variant_builder_close (&b);
+
+  var = g_variant_builder_end (&b);
+  ev = zeitgeist_event_new_from_variant (var); // var freed
+
+  g_assert_cmpint (27, ==, zeitgeist_event_get_id (ev));
+  g_assert_cmpint (68, ==, zeitgeist_event_get_timestamp (ev));
+  g_assert_cmpstr (ZEITGEIST_ZG_ACCESS_EVENT,==, zeitgeist_event_get_interpretation (ev));
+  g_assert_cmpstr (ZEITGEIST_ZG_USER_ACTIVITY, ==, zeitgeist_event_get_manifestation (ev));
+  g_assert_cmpstr ("application://foo.desktop", ==, zeitgeist_event_get_actor (ev));
+  g_assert_cmpstr ("origin", ==, zeitgeist_event_get_origin (ev));
+  g_assert_cmpint (1, ==, zeitgeist_event_num_subjects (ev));
+
+  su = zeitgeist_event_get_subject (ev, 0);
+  g_assert_cmpstr ("file:///tmp/foo.txt", ==, zeitgeist_subject_get_uri(su));
+  g_assert_cmpstr (ZEITGEIST_NFO_DOCUMENT, ==, zeitgeist_subject_get_interpretation (su));
+  g_assert_cmpstr (ZEITGEIST_NFO_FILE_DATA_OBJECT, ==, zeitgeist_subject_get_manifestation (su));
+  g_assert_cmpstr ("text/plain", ==, zeitgeist_subject_get_mimetype (su));
+  g_assert_cmpstr ("file:///tmp", ==, zeitgeist_subject_get_origin (su));
+  g_assert_cmpstr ("foo.txt", ==, zeitgeist_subject_get_text (su));
+  g_assert_cmpstr ("36e5604e-7e1b-4ebd-bb6a-184c6ea99627", ==, zeitgeist_subject_get_storage (su));
+  g_assert_cmpstr ("file:///tmp/current.txt", ==, zeitgeist_subject_get_current_uri (su));
 
   payload = zeitgeist_event_get_payload (ev);
   g_assert (payload != NULL);
@@ -218,6 +299,7 @@
   g_assert (zeitgeist_event_get_interpretation (marshalled) == NULL);
   g_assert (zeitgeist_event_get_manifestation (marshalled) == NULL);
   g_assert (zeitgeist_event_get_actor (marshalled) == NULL);
+  g_assert (zeitgeist_event_get_origin (marshalled) == NULL);
   g_assert_cmpint (0, ==, zeitgeist_event_num_subjects (marshalled));
   g_assert (zeitgeist_event_get_payload (marshalled) == NULL);
 
@@ -245,6 +327,12 @@
                                                "example.com",
                                                "net"),
                    NULL);
+
+  // Set event origin and current_uri
+  zeitgeist_event_set_origin (orig, "origin");
+  zeitgeist_subject_set_current_uri (
+    zeitgeist_event_get_subject (orig, 0), "http://current-example.com");
+
   payload = g_byte_array_new ();
   byte = 255;
   g_byte_array_append (payload, &byte, 1);
@@ -257,6 +345,7 @@
   g_assert_cmpstr (ZEITGEIST_ZG_ACCESS_EVENT,==, zeitgeist_event_get_interpretation (marshalled));
   g_assert_cmpstr (ZEITGEIST_ZG_USER_ACTIVITY, ==, zeitgeist_event_get_manifestation (marshalled));
   g_assert_cmpstr ("application://firefox.desktop", ==, zeitgeist_event_get_actor (marshalled));
+  g_assert_cmpstr ("origin", ==, zeitgeist_event_get_origin (marshalled));
   g_assert_cmpint (1, ==, zeitgeist_event_num_subjects (marshalled));
 
   payload = zeitgeist_event_get_payload (marshalled);
@@ -272,6 +361,7 @@
   g_assert_cmpstr ("http://example.com", ==, zeitgeist_subject_get_origin (su));
   g_assert_cmpstr ("example.com", ==, zeitgeist_subject_get_text (su));
   g_assert_cmpstr ("net", ==, zeitgeist_subject_get_storage (su));
+  g_assert_cmpstr ("http://current-example.com", ==, zeitgeist_subject_get_current_uri (su));
 
   g_object_unref (orig);
   g_object_unref (marshalled);
@@ -333,6 +423,8 @@
               setup, test_actor_from_app_info, teardown);              
   g_test_add ("/Zeitgeist/Event/FromVariant", Fixture, NULL,
                 setup, test_from_variant, teardown);
+  g_test_add ("/Zeitgeist/Event/FromVariantWithNewFields", Fixture, NULL,
+                setup, test_from_variant_with_new_fields, teardown);
   g_test_add ("/Zeitgeist/Event/EmptyToFromVariant", Fixture, NULL,
               setup, test_empty_to_from_variant, teardown);
   g_test_add ("/Zeitgeist/Event/WithOneSubjectToFromVariant", Fixture, NULL,