Merge lp:~marcelstimberg/zim/zeitgeist-plugin into lp:~jaap.karssenberg/zim/pyzim

[Marcel Stimberg]

[Jaap Karssenberg (jaap.karssenberg)]

No problem merging the plugin. Would be nice though to have a manual
page as well for it (in data/manual/) so users can check what it is
for. Nothing fancy, just short description and reference to zeitgeist
documentation will do.

Thanks,

Jaap

[lp:~marcelstimberg/zim/zeitgeist-plugin]

357. By Marcel Stimberg on 2012-06-05

add a short help page for the Zeitgeist plugin

[Marcel Stimberg (marcelstimberg)]

Thanks, Jaap. I updated the branch with a little help page for the plugin.

=== modified file 'data/manual/Plugins.txt'
--- data/manual/Plugins.txt	2012-03-18 11:40:18 +0000
+++ data/manual/Plugins.txt	2012-06-05 19:42:20 +0000
@@ -17,6 +17,7 @@
 * [[+Insert Symbol|Insert Symbol]]
 * [[+Inline Calculator|Inline Calculator]]
 * [[+Link Map|Link Map]]
+* [[+Log events with Zeitgeist|Log events with Zeitgeist]]
 * [[+Quick Note|Quick Note]]
 * [[+Spell Checker|Spell Checker]]
 * [[+Table Of Contents|Table Of Contents]]

=== added file 'data/manual/Plugins/Log_events_with_Zeitgeist.txt'
--- data/manual/Plugins/Log_events_with_Zeitgeist.txt	1970-01-01 00:00:00 +0000
+++ data/manual/Plugins/Log_events_with_Zeitgeist.txt	2012-06-05 19:42:20 +0000
@@ -0,0 +1,11 @@
+Content-Type: text/x-zim-wiki
+Wiki-Format: zim 0.4
+Creation-Date: 2012-06-05T20:52:03+02:00
+
+====== Log events with Zeitgeist ======
+
+When this plugin is activated, information about accessing, creating and modifying Zim Wiki pages is logged using the Zeitgeist framework. This allows applications like the Unity Dash to display recently used pages or the Activity Journal to give a timeline overview of your activities.
+
+**Dependencies:** This plugin requires the Python bindings for Zeitgeist. For Debian and Ubuntu, these bindings are available in the ''python-zeitgeist'' package.
+
+For more information about the Zeitgeist project see: http://zeitgeist-project.com

=== added file 'zim/plugins/zeitgeist-logger.py'
--- zim/plugins/zeitgeist-logger.py	1970-01-01 00:00:00 +0000
+++ zim/plugins/zeitgeist-logger.py	2012-06-05 19:42:20 +0000
@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2011 Marcel Stimberg <[e-mail]>
+
+'''Push events to the Zeitgeist daemon'''
+
+import gio
+import logging
+import sys
+from zim.plugins import PluginClass
+import zim.fs
+
+logger = logging.getLogger('zim.plugins.zeitgeist')
+
+try:
+	from zeitgeist.client import ZeitgeistClient
+	from zeitgeist.datamodel import Event, Subject, Interpretation, Manifestation
+except:
+	ZeitgeistClient = None
+
+class ZeitgeistPlugin(PluginClass):
+
+	plugin_info = {
+		'name': _('Log events with Zeitgeist'),
+		'description': _('Pushes events to the Zeitgeist daemon.'), 
+		'author': 'Marcel Stimberg',
+		'help': 'Plugins:Log events with Zeitgeist',
+	}
+
+	def __init__(self, ui):
+		PluginClass.__init__(self, ui)
+		try:
+			self.zeitgeist_client = ZeitgeistClient()
+		except RuntimeError, e:
+			logger.exception('Loading zeitgeist client failed, will not log events')
+			self.zeitgeist_client = None
+	
+	def initialize_ui(self, ui):
+		if self.zeitgeist_client is not None:
+			self.zeitgeist_client.register_data_source('application://zim.desktop',
+			                                           _('Zim'), _('A desktop wiki'), [])
+			self.ui.connect_after('open-page', self.do_open_page)
+			self.ui.connect_after('close-page', self.do_close_page)
+
+	def finalize_notebook(self, ui):
+		if self.zeitgeist_client is not None:
+			self.ui.notebook.connect_after('deleted-page', self.do_delete_page)
+			self.ui.notebook.connect_after('stored-page', self.do_store_page)
+
+	@classmethod
+	def check_dependencies(klass):
+		has_zeitgeist = not ZeitgeistClient is None
+		return has_zeitgeist, [('libzeitgeist', has_zeitgeist, False)]
+
+	def create_and_send_event(self, page, path, event_type):
+		#FIXME: Assumes file store
+		store = self.ui.notebook.get_store(page.name)
+		if path is not None:
+			fileobj  = store._get_file(path)
+		else:
+			fileobj = store._get_file(page)
+		
+		uri = fileobj.uri
+		origin = gio.File(uri).get_parent().get_uri()
+		text = _('Wiki page: %s') % page.name
+		
+		subject = Subject.new_for_values(mimetype='text/x-zim-wiki',
+		                                 uri=uri,
+		                                 origin=origin,
+		                                 interpretation=Interpretation.TEXT_DOCUMENT,
+		                                 manifestation=Manifestation.FILE_DATA_OBJECT,
+		                                 text=text)
+		event = Event.new_for_values(actor='application://zim.desktop',
+		                             interpretation=event_type,
+		                             manifestation=Manifestation.USER_ACTIVITY,
+		                             subjects=[subject,])
+		
+		self.zeitgeist_client.insert_event(event)
+
+	def do_open_page(self, ui, page, path):
+		logger.debug("Opened page: %s", page.name)
+		self.create_and_send_event(page, path, Interpretation.ACCESS_EVENT)
+
+	def do_close_page(self, ui, page):
+		logger.debug("Left page: %s", page.name)
+		self.create_and_send_event(page, None, Interpretation.LEAVE_EVENT)
+
+	def do_delete_page(self, page, path):
+		logger.debug("Deleted page: %s", page.name)
+		self.create_and_send_event(page, path, Interpretation.DELETE_EVENT)
+
+	def do_store_page(self, page, path):
+		logger.debug("Modified page: %s", page.name)
+		self.create_and_send_event(page, path, Interpretation.MODIFY_EVENT)
+