Merge ~khurshid-alam/ubuntu/+source/rhythmbox:master into ~ubuntu-desktop/ubuntu/+source/rhythmbox:ubuntu/master

[Khurshid Alam]

Port zeitgeist plugin to Python3

Zeitgeist already provides python bindings. Convert them to python3 and use them in rbzeitgeist plugin. That way we can avoid using gir bindings and various manual mappings from zeitgeist interpretation to string. Fixes LP: #1813813

[fossfreedom (fossfreedom)]

I know I am not a reviewer ...

From a quick look it seems like a good conversion.

Given that no one uses this plugin other than Unity wouldn't this be a good opportunity to split the plugin into its own package? This would align more to the current Debian rhythmbox package that no longer ships zeitgeist and reduce the overhead of ubuntu specific patches.

[Khurshid Alam (khurshid-alam)]

@fossfreedom

Perhaps so. But that means finding a repo, work on makefile etc which will take more time. I would appreciate some help regarding this.

Meanwhile this can go into disco and perhaps @jbicha can merge it back on debian.

[Khurshid Alam (khurshid-alam)]

@fossfreedom Also synapse used to use it. Though I don't know if they still uses but their zeitgeist plugin should still work as the there hasn't been any API change for zeitgeist in recent years.

[Jeremy Bícha (jbicha)]

Debian might accept our rhythmbox-plugin-zeitgeist package once we get the plugin working.

I would normally expect something like this to be forwarded to https://gitlab.gnome.org/GNOME/rhythmbox/merge_requests

Are you aware of this comment from the zeitgeist Debian changelog?
https://tracker.debian.org/news/939461/accepted-zeitgeist-101-02-source-amd64-all-into-unstable/

  "Drop python3-zeitgeist package as the binding is not compatible with
  python3, for python3, GIR binding should be used instead. Reintroduce the
  python2 binding for now as we still have one rdependency"

Maybe those extra files you added should be shipped by the zeitgeist package instead?

Maybe Ricotz has some time to help review what you're trying to do here.

[Khurshid Alam (khurshid-alam)]

@jbicha

Ah. Right. It has already been ported. See https://gitlab.gnome.org/GNOME/rhythmbox/merge_requests/18/

Perhaps you could cherry pick the merge into debian and then it can re-sync into Ubuntu ?

Force pushed with author's commit.

And it's working. I checked.

[Jeremy Bícha (jbicha)]

Khurshid, have you ever used git-buildpackage's patch-queue feature (gbp pq)?

https://wiki.ubuntu.com/DesktopTeam/git#Pick_some_upstream_commits
https://manpages.debian.org/unstable/gbp-pq

Specifically, we don't edit upstream directly, but we use debian/patches/ so gbp pq helps create and modify those patches.

review: Needs Fixing

[Khurshid Alam (khurshid-alam)]

Never used gbp-pq, but trying now.

cceffdc... by Khurshid Alam on 2019-02-18

 Zeigeist-plugin: Cherry-pick fix for upstream merge

[Khurshid Alam (khurshid-alam)]

I simply added the patch with gbp pq and modify debian/control. I left updating changelog, because I never do that for other upstream merge.

Unmerged commits

cceffdc... by Khurshid Alam on 2019-02-18

 Zeigeist-plugin: Cherry-pick fix for upstream merge

diff --git a/debian/control b/debian/control
index 5de2fda..8e6fd7f 100644
--- a/debian/control
+++ b/debian/control
@@ -187,8 +187,11 @@ Depends: ${misc:Depends},
          ${shlibs:Depends},
          rhythmbox (>= ${gnome:Version}),
          rhythmbox (<< ${gnome:NextVersion}),
+         gir1.2-rb-3.0 (= ${binary:Version}),
          gir1.2-glib-2.0,
          gir1.2-peas-1.0,
+         gir1.2-zeitgeist-2.0,
+         python3-gi,
          zeitgeist-core
 Description: zeitgeist plugin for rhythmbox music player
  Rhythmbox is a very easy to use music playing and management program
diff --git a/debian/control.in b/debian/control.in
index 049e836..e66c5e4 100644
--- a/debian/control.in
+++ b/debian/control.in
@@ -183,8 +183,11 @@ Depends: ${misc:Depends},
          ${shlibs:Depends},
          rhythmbox (>= ${gnome:Version}),
          rhythmbox (<< ${gnome:NextVersion}),
+         gir1.2-rb-3.0 (= ${binary:Version}),
          gir1.2-glib-2.0,
          gir1.2-peas-1.0,
+         gir1.2-zeitgeist-2.0,
+         python3-gi,
          zeitgeist-core
 Description: zeitgeist plugin for rhythmbox music player
  Rhythmbox is a very easy to use music playing and management program
diff --git a/debian/patches/series b/debian/patches/series
index febc85f..f95255e 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -8,3 +8,4 @@ multiarch_fallback.patch
 make-shuffle-repeat-proper-toggle-actions.patch
 restore-traditional-menubar.patch
 0002-grilo-container-max-tracks.patch
+zeitgeist-Use-zeitgeist-via-Gobject-introspection.patch
diff --git a/debian/patches/zeitgeist-Use-zeitgeist-via-Gobject-introspection.patch b/debian/patches/zeitgeist-Use-zeitgeist-via-Gobject-introspection.patch
new file mode 100644
index 0000000..f7b2dc6
--- /dev/null
+++ b/debian/patches/zeitgeist-Use-zeitgeist-via-Gobject-introspection.patch
@@ -0,0 +1,191 @@
+From: joerg eichhorn <[e-mail]>
+Date: Sat, 10 Nov 2018 16:42:58 +0100
+Subject: zeitgeist: Use zeitgeist via Gobject introspection
+
+Fixes #1340
+Fixes https://bugs.launchpad.net/ubuntu/+source/rhythmbox/+bug/1313914
+Fixes https://bugzilla.gnome.org/show_bug.cgi?id=707527
+
+From 33bd55de358325ff775cf903371949ca26198d41 Mon Sep 17 00:00:00 2001
+From: vrishab <[e-mail]>
+Date: Sun, 27 Nov 2016 18:29:33 +0530
+Subject: [PATCH] zeitgeist: Use zeitgeist via Gobject introspection
+
+(cherry picked from commit efcb4653a13a723b5b99fb5e387f60d5110ae840)
+---
+ plugins/rbzeitgeist/rbzeitgeist.plugin.in |  2 +-
+ plugins/rbzeitgeist/rbzeitgeist.py        | 95 ++++++++++++++++++++-----------
+ 2 files changed, 63 insertions(+), 34 deletions(-)
+
+diff --git a/plugins/rbzeitgeist/rbzeitgeist.plugin.in b/plugins/rbzeitgeist/rbzeitgeist.plugin.in
+index b699ee7..3d362bb 100644
+--- a/plugins/rbzeitgeist/rbzeitgeist.plugin.in
++++ b/plugins/rbzeitgeist/rbzeitgeist.plugin.in
+@@ -7,4 +7,4 @@ _Name=Zeitgeist
+ _Description=Inform Zeitgeist about your activity
+ Authors=Markus Korn <[e-mail]>
+ Copyright=Copyright © 2009 Markus Korn
+-Website=http://www.zeitgeist-project.com
++Website=http://www.rhythmbox.org/
+diff --git a/plugins/rbzeitgeist/rbzeitgeist.py b/plugins/rbzeitgeist/rbzeitgeist.py
+index b04a082..6bba195 100644
+--- a/plugins/rbzeitgeist/rbzeitgeist.py
++++ b/plugins/rbzeitgeist/rbzeitgeist.py
+@@ -26,20 +26,23 @@
+ # along with this program; if not, write to the Free Software
+ # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
+ 
+-import time
++import gi
+ import rb
++import time
+ 
+-from gi.repository import GObject, Gio, GLib, Peas
+-from gi.repository import RB
++gi.require_version('Peas', '1.0')
++gi.require_version('RB', '3.0')
++gi.require_version('Zeitgeist', '2.0')
+ 
+-from zeitgeist.client import ZeitgeistClient
+-from zeitgeist.datamodel import Event, Subject, Interpretation, Manifestation
++from gi.repository import GObject, Gio, GLib, Peas, Zeitgeist
++from gi.repository import RB
+ 
+ try:
+-    IFACE = ZeitgeistClient()
++    logger = Zeitgeist.Log.new()
++
+ except RuntimeError as e:
+     print("Unable to connect to Zeitgeist, won't send events. Reason: '%s'" % e)
+-    IFACE = None
++    logger = None
+ 
+ class ZeitgeistPlugin(GObject.Object, Peas.Activatable):
+     __gtype_name__ = 'ZeitgeistPlugin'
+@@ -50,7 +53,8 @@ class ZeitgeistPlugin(GObject.Object, Peas.Activatable):
+ 
+     def do_activate(self):
+         print("Loading Zeitgeist plugin...")
+-        if IFACE is not None:
++
++        if logger is not None:
+             shell = self.object
+             shell_player = shell.props.shell_player
+             self.__psc_id = shell_player.connect("playing-song-changed", self.playing_song_changed)
+@@ -61,9 +65,28 @@ class ZeitgeistPlugin(GObject.Object, Peas.Activatable):
+             self.__manual_switch = True
+             self.__current_song = None
+ 
+-            if IFACE.get_version() >= [0, 3, 2, 999]:
+-                IFACE.register_data_source("org.gnome.Rhythmbox,dataprovider", "Rhythmbox", "Play and organize your music collection",
+-                                           [Event.new_for_values(actor="application://rhythmbox.desktop")])
++            event = Zeitgeist.Event.new()
++            event.set_property("interpretation", "Source Registration")
++            event.set_property("manifestation", Zeitgeist.USER_ACTIVITY)
++            event.set_property("actor", "application://rhythmbox.desktop")
++
++            datasource = Zeitgeist.DataSource.new()
++            datasource.set_unique_id("org.gnome.Rhythmbox3,dataprovider")
++            datasource.set_name("Rhythmbox")
++            datasource.set_description("Play and organize your music collection")
++            datasource.set_event_templates([event,])
++            datasource.set_enabled(True)
++            datasource.set_timestamp(int(time.time()*1000))
++
++            # Register Rhythmbox as a data source with Zeitgeist
++            # engine.
++            registry = Zeitgeist.DataSourceRegistry.new()
++            registry.register_data_source(datasource)
++
++            # Save references as register_data_source is async.
++            self.event = event
++            self.datasource = datasource
++            self.registry = registry
+ 
+     @staticmethod
+     def get_song_info(db, entry):
+@@ -85,10 +108,10 @@ class ZeitgeistPlugin(GObject.Object, Peas.Activatable):
+ 
+     def playing_song_changed(self, shell, entry):
+         if self.__current_song is not None:
+-            self.send_to_zeitgeist_async(self.__current_song, Interpretation.LEAVE_EVENT)
++            self.send_to_zeitgeist_async(self.__current_song, Zeitgeist.LEAVE_EVENT)
+ 
+         if entry is not None:
+-            self.send_to_zeitgeist_async(entry, Interpretation.ACCESS_EVENT)
++            self.send_to_zeitgeist_async(entry, Zeitgeist.ACCESS_EVENT)
+ 
+         self.__current_song = entry
+         GLib.idle_add(self.reset_manual_switch)
+@@ -111,15 +134,16 @@ class ZeitgeistPlugin(GObject.Object, Peas.Activatable):
+         """
+         shell = self.object
+         db = shell.props.db
++
+         GLib.idle_add(self.send_to_zeitgeist, db, entry, event_type)
+ 
+     def send_to_zeitgeist(self, db, entry, event_type):
+         song = self.get_song_info(db, entry)
+ 
+         if self.__manual_switch:
+-            manifest = Manifestation.USER_ACTIVITY
++            manifest = Zeitgeist.USER_ACTIVITY
+         else:
+-            manifest = Manifestation.SCHEDULED_ACTIVITY
++            manifest = Zeitgeist.SCHEDULED_ACTIVITY
+ 
+         def file_info_complete(obj, res, user_data):
+             try:
+@@ -129,29 +153,34 @@ class ZeitgeistPlugin(GObject.Object, Peas.Activatable):
+ 
+             uri_mimetype = fi.get_content_type()
+ 
+-            subject = Subject.new_for_values(
+-                uri=song["location"],
+-                interpretation=unicode(Interpretation.AUDIO),
+-                manifestation=unicode(Manifestation.FILE_DATA_OBJECT),
+-                origin=song["location"].rpartition("/")[0],
+-                mimetype=uri_mimetype,
+-                text=" - ".join([song["title"], song["artist"], song["album"]])
+-            )
+-            event = Event.new_for_values(
+-                timestamp=int(time.time()*1000),
+-                interpretation=unicode(event_type),
+-                manifestation=unicode(manifest),
+-                actor="application://rhythmbox.desktop",
+-                subjects=[subject,]
+-            )
+-            IFACE.insert_event(event)
++            subject = Zeitgeist.Subject.new()
++            subject.set_property("uri", song["location"])
++            subject.set_property("interpretation", str(Zeitgeist.AUDIO))
++            subject.set_property("manifestation", str(Zeitgeist.FILE_DATA_OBJECT))
++            subject.set_property("origin", song["location"].rpartition("/")[0])
++            subject.set_property("mimetype", uri_mimetype)
++            subject.set_property("text", " - ".join([song["title"], song["artist"], song["album"]]))
++
++            event = Zeitgeist.Event.new()
++            event.set_property("timestamp", int(time.time()*1000))
++            event.set_property("interpretation", str(event_type))
++            event.set_property("manifestation", str(manifest))
++            event.set_property("actor", "application://rhythmbox.desktop")
++            event.add_subject(subject)
++
++            logger.insert_event(event)
+ 
+         f = Gio.file_new_for_uri(song["location"])
+-        f.query_info_async(Gio.FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE, Gio.FileQueryInfoFlags.NONE, GLib.PRIORITY_DEFAULT, None, file_info_complete, None)
++        f.query_info_async(Gio.FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
++                           Gio.FileQueryInfoFlags.NONE,
++                           GLib.PRIORITY_DEFAULT,
++                           None,
++                           file_info_complete,
++                           None)
+ 
+     def do_deactivate(self):
+         print("Deactivating Zeitgeist plugin...")
+-        if IFACE is not None:
++        if logger is not None:
+             shell = self.object
+             shell_player = shell.props.shell_player
+             shell_player.disconnect(self.__psc_id)