Merge lp:~jelmer/bzr-dbus/zeitgeist into lp:bzr-dbus

[Jelmer Vernooij]

[Jelmer Vernooij (jelmer)]

This adds support for providing events to zeitgeist to the dbus plugin. Talking to zeitgeist is done through a small Python wrapper around the dbus Python module, but that python module should always be installed when zeitgeist itself is installed.

This allows showing bzr commits in gnome-activity-journal.

It's based on Markus Korn's initial plugin that is living in a separate Bazaar branch, but is not packaged. He is fine with moving this code into bzr-dbus.

[Robert Collins (lifeless)]

bzr-dbus is part of the canonical maintained plugins for bzr, so it needs copyright assignment.

I don't see that you need the commit hook, as bzr-dbus is already connected to tip changes, which all commits are. I'd like you to have a look at that ;).

Other than that conceptually sure its fine to have this live in -dbus.

review: Needs Fixing

[Jelmer Vernooij (jelmer)]

> bzr-dbus is part of the canonical maintained plugins for bzr, so it needs
> copyright assignment.
>
> I don't see that you need the commit hook, as bzr-dbus is already connected to
> tip changes, which all commits are. I'd like you to have a look at that ;).
>
> Other than that conceptually sure its fine to have this live in -dbus.
I've updated the copyright - Markus told me he's already signed the contributor assignment.

I think we should just support notifications of commits that were made by the local user for now and possibly supporti the notification of pull/push on branches later on

[Robert Collins (lifeless)]

On Thu, 2010-02-18 at 02:38 +0000, Jelmer Vernooij wrote:
> > bzr-dbus is part of the canonical maintained plugins for bzr, so it needs
> > copyright assignment.
> >
> > I don't see that you need the commit hook, as bzr-dbus is already connected to
> > tip changes, which all commits are. I'd like you to have a look at that ;).
> >
> > Other than that conceptually sure its fine to have this live in -dbus.
> I've updated the copyright - Markus told me he's already signed the contributor assignment.
>
> I think we should just support notifications of commits that were made by the local user for now and possibly supporti the notification of pull/push on branches later on

I'd really rather not have duplicate code in the codebase, and it sure
looks like that is what it is at the moment.

Have you tried just logging what it grabs with the current hook - you
might like it!

-Rob

[Jelmer Vernooij (jelmer)]

On Thu, 2010-02-18 at 02:54 +0000, Robert Collins wrote:
> On Thu, 2010-02-18 at 02:38 +0000, Jelmer Vernooij wrote:
> > > bzr-dbus is part of the canonical maintained plugins for bzr, so it needs
> > > copyright assignment.
> > >
> > > I don't see that you need the commit hook, as bzr-dbus is already connected to
> > > tip changes, which all commits are. I'd like you to have a look at that ;).
> > >
> > > Other than that conceptually sure its fine to have this live in -dbus.
> > I've updated the copyright - Markus told me he's already signed the contributor assignment.
> >
> > I think we should just support notifications of commits that were made by the local user for now and possibly supporti the notification of pull/push on branches later on
>
> I'd really rather not have duplicate code in the codebase, and it sure
> looks like that is what it is at the moment.
>
> Have you tried just logging what it grabs with the current hook - you
> might like it!
The 'duplication' is an extra hook, one line for the registration and
one line for the actual hook.

The alternative is filtering out commits in the current hook and only
calling the zeitgeist code in that case - that's still one or two lines
of code.

Using the post_branch_change_tip hook logs waaay too much data and
delutes gnome-activity-journal significantly at least for me, but I do a
lot of pulls.

Cheers,

Jelmer

[Robert Collins (lifeless)]

If you've actually tried it [branch tip change] and didn't like it, then
merging the post commit hook is fine. Please open a bug to make more
capturing possible.

-Rob

=== modified file '__init__.py'
--- __init__.py	2010-02-10 13:03:00 +0000
+++ __init__.py	2010-02-18 02:34:09 +0000
@@ -66,7 +66,7 @@
 
 from bzrlib import commands
 
-from hook import install_hooks
+from bzrlib.plugins.dbus.hook import install_hooks
 
 
 def test_suite():

=== modified file 'hook.py'
--- hook.py	2010-02-16 21:40:36 +0000
+++ hook.py	2010-02-18 02:34:09 +0000
@@ -1,7 +1,8 @@
 # bzr-dbus: dbus support for bzr/bzrlib.
-# Copyright (C) 2007 Canonical Limited.
-#   Author: Robert Collins.
-# 
+# Copyright (C) 2007,2009 Canonical Limited.
+#   Author: Robert Collins
+#   Author: Markus Korn (zeitgeist support)
+#
 # 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; version 2 of the License.
@@ -27,6 +28,9 @@
     Branch.hooks.install_named_hook(
         'post_change_branch_tip', on_post_change_branch_tip,
         'Announcing on branch change on D-Bus')
+    Branch.hooks.install_named_hook(
+         'post_commit', on_post_commit,
+         'Zeitgeist dataprovider')
     SmartTCPServer.hooks.install_named_hook(
         'server_started', on_server_start,
         'Registering server URL mapping')
@@ -68,3 +72,60 @@
         return
     for local_url in local_urls:
         activity.remove_url_map(local_url, public_url)
+
+
+_checked_zeitgeist_client = False
+_zeitgeist_client = None
+
+
+def get_zeitgeist_client():
+    global _zeitgeist_client, _checked_zeitgeist_client
+    if _checked_zeitgeist_client:
+        return _zeitgeist_client
+    _checked_zeitgeist_client = True
+    from bzrlib import trace
+    try:
+        from zeitgeist.client import ZeitgeistClient
+    except ImportError, e:
+        trace.mutter("Zeitgeist not present: %s" % e)
+        return None
+    try:
+        _zeitgeist_client = ZeitgeistClient()
+    except RuntimeError, e:
+        trace.warn("Unable to connect to Zeitgeist, won't send events."
+                   "Reason: '%s'" % e)
+        return None
+    else:
+        return _zeitgeist_client
+
+
+def on_post_commit(local, master, old_revno, old_revid, new_revno, new_revid):
+    """A commit was done. Inform zeitgeist if possible."""
+    client = get_zeitgeist_client()
+    if client is None:
+        return
+    import time
+    from zeitgeist.datamodel import (Event, Subject, Interpretation,
+                                     Manifestation)
+    revision = master.repository.get_revision(new_revid)
+    if new_revno == 1:
+        interpretation = Interpretation.CREATE_EVENT
+    else:
+        interpretation = Interpretation.MODIFY_EVENT
+    subject = Subject.new_for_values(
+        uri=unicode(master.base),
+        interpretation=unicode(Interpretation.SOURCECODE),
+        manifestation=unicode(Manifestation.FILE),
+        text=unicode(revision.message),
+        origin=unicode(master.base),
+    )            
+    event = Event.new_for_values(
+        timestamp=int(time.time()*1000),
+        interpretation=unicode(interpretation),
+        manifestation=unicode(Manifestation.USER_ACTIVITY),
+        actor="application://bzr.desktop", #something usefull here, always olive-gtk?
+        subjects=[subject,]
+    )
+    client.insert_event(event)
+
+