Merge lp:~jplacerda/libzeitgeist/776651 into lp:libzeitgeist

[J.P. Lacerda]

[Mikkel Kamstrup Erlandsen (kamstrup)]

Awesome work! The code looks good at a glance. I'll do a thorough review later today and run the tests to give it a final +1.

[Siegfried Gevatter (rainct)]

It's missing support for old variants (without origin/current_uri). Other than that (and some typo in a comment) it looks good to me.

Nice work!

I'm uploading an updated branch with that fix plus removing the changes to the constructors for now, since those break the API (we can introduce them at some later point).

[Mikkel Kamstrup Erlandsen (kamstrup)]

Siegfried's work is now in lp:~rainct/libzeitgeist/event-origin-subject-current-uri

Unmerged revisions

=== modified file 'src/zeitgeist-event.c'
--- src/zeitgeist-event.c	2011-03-25 12:14:46 +0000
+++ src/zeitgeist-event.c	2011-05-11 16:08:25 +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,51 @@
 }
 
 /**
+ * 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 described 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.
+ */
+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 +486,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 +537,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 +553,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);
@@ -574,14 +622,15 @@
 zeitgeist_event_new_full (const gchar *interpretation,
                           const gchar *manifestation,
                           const gchar *actor,
+                          const gchar *origin,
                           ...)
 {
   va_list         args;
   ZeitgeistEvent *self;
 
-  va_start (args, actor);
+  va_start (args, origin);
   self = zeitgeist_event_new_full_valist (interpretation, manifestation,
-                                          actor, args);
+                                          actor, origin, args);
   va_end (args);
     
   return self;
@@ -605,6 +654,7 @@
 zeitgeist_event_new_full_valist (const gchar *interpretation,
                                  const gchar *manifestation,
                                  const gchar *actor,
+                                 const gchar *origin,
                                  va_list      args)
 {
   ZeitgeistEvent *self;
@@ -614,6 +664,7 @@
   zeitgeist_event_set_interpretation (self, interpretation);
   zeitgeist_event_set_manifestation (self, manifestation);
   zeitgeist_event_set_actor (self, actor);
+  zeitgeist_event_set_origin (self, origin);
 
   subject = va_arg (args, ZeitgeistSubject*);
   while (subject != NULL)
@@ -686,6 +737,9 @@
   g_variant_iter_loop (event_data, "s", &str);
   zeitgeist_event_set_actor (result,  str[0] == '\0' ? NULL : str);
 
+  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))
   {
@@ -720,6 +774,9 @@
     g_variant_iter_loop (subject_data, "s", &str);
     zeitgeist_subject_set_storage (subject, str[0] == '\0' ? NULL : str);
 
+    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);
   }
 
@@ -787,6 +844,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 */
@@ -803,6 +861,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	2011-05-11 16:08:25 +0000
@@ -70,11 +70,13 @@
 ZeitgeistEvent* zeitgeist_event_new_full        (const gchar    *interpretation,
                                                  const gchar    *manifestation,
                                                  const gchar    *actor,
+                                                 const gchar    *origin,
                                                  ...) G_GNUC_NULL_TERMINATED;
 
 ZeitgeistEvent* zeitgeist_event_new_full_valist (const gchar    *interpretation,
                                                  const gchar    *manifestation,
                                                  const gchar    *actor,
+                                                 const gchar    *origin,
                                                  va_list         args);
 
 ZeitgeistEvent* zeitgeist_event_new_from_variant (GVariant *event);
@@ -104,6 +106,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	2011-05-11 16:08:25 +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);
 }
@@ -319,7 +351,7 @@
  * @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
- * 
+ * @current_uri: The current URI or URL of the subject
  * Create a new subject structure with predefined data
  *
  * Returns: A newly create #ZeitgeistSubject instance. The returned subject will
@@ -335,7 +367,8 @@
                             const gchar *mimetype,
                             const gchar *origin,
                             const gchar *text,
-                            const gchar *storage)
+                            const gchar *storage,
+                            const gchar *current_uri)
 {
   ZeitgeistSubject *self;
 
@@ -347,6 +380,7 @@
   zeitgeist_subject_set_origin (self, origin);
   zeitgeist_subject_set_text (self, text);
   zeitgeist_subject_set_storage (self, storage);
-    
+  zeitgeist_subject_set_current_uri (self, current_uri);
+
   return self;
 }
 
=== modified file 'src/zeitgeist-subject.h'
--- src/zeitgeist-subject.h	2011-03-07 14:19:39 +0000
+++ src/zeitgeist-subject.h	2011-05-11 16:08:25 +0000
@@ -71,7 +71,8 @@
                                                    const gchar *mimetype,
                                                    const gchar *origin,
                                                    const gchar *text,
-                                                   const gchar *storage);
+                                                   const gchar *storage,
+                                                   const gchar *current_uri);
 
 const gchar* zeitgeist_subject_get_uri            (ZeitgeistSubject *subject);
 void         zeitgeist_subject_set_uri            (ZeitgeistSubject *subject,
@@ -101,6 +102,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	2011-05-11 16:08:25 +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);
 
@@ -79,13 +80,15 @@
                    ZEITGEIST_ZG_ACCESS_EVENT,
                    ZEITGEIST_ZG_USER_ACTIVITY,
                    "application://firefox.desktop",
+                   "origin",
                    zeitgeist_subject_new_full ("http://example.com",
                                                ZEITGEIST_NFO_WEBSITE,
                                                ZEITGEIST_NFO_REMOTE_DATA_OBJECT,
                                                "text/html",
                                                "http://example.com",
                                                "example.com",
-                                               "net"),
+                                               "net",
+                                               "http://current-example.com"),
                    zeitgeist_subject_new (),
                    NULL);
 
@@ -94,6 +97,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_cmpstr ("origin", ==, zeitgeist_event_get_origin (ev));
   g_assert_cmpint (2, ==, zeitgeist_event_num_subjects (ev));
   g_assert (zeitgeist_event_get_payload (ev) == NULL);
 
@@ -105,6 +109,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));
 
   su = zeitgeist_event_get_subject (ev, 1);
   g_assert (zeitgeist_subject_get_uri(su) == NULL);
@@ -114,6 +119,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);
 }
@@ -151,6 +157,7 @@
   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 */
@@ -164,6 +171,7 @@
       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);
@@ -183,6 +191,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://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);
@@ -193,6 +202,7 @@
   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 +228,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);
 
@@ -237,13 +248,15 @@
                    ZEITGEIST_ZG_ACCESS_EVENT,
                    ZEITGEIST_ZG_USER_ACTIVITY,
                    "application://firefox.desktop",
+                   "origin",
                    zeitgeist_subject_new_full ("http://example.com",
                                                ZEITGEIST_NFO_WEBSITE,
                                                ZEITGEIST_NFO_REMOTE_DATA_OBJECT,
                                                "text/html",
                                                "http://example.com",
                                                "example.com",
-                                               "net"),
+                                               "net",
+                                               "http://current-example.com"),
                    NULL);
   payload = g_byte_array_new ();
   byte = 255;
@@ -257,6 +270,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 +286,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);