path: root/python/client.py

# -.- coding: utf-8 -.-

# Zeitgeist
#
# Copyright © 2009-2011 Siegfried-Angel Gevatter Pujals <siegfried@gevatter.com>
# Copyright © 2009 Mikkel Kamstrup Erlandsen <mikkel.kamstrup@gmail.com>
# Copyright © 2009-2011 Markus Korn <thekorn@gmx.de>
# Copyright © 2011 Collabora Ltd.
#             By Siegfried-Angel Gevatter Pujals <siegfried@gevatter.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 2.1 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import dbus
import dbus.service
import dbus.mainloop.glib
import logging
import os.path
import sys
import inspect

from xml.etree import ElementTree

dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)

from zeitgeist.datamodel import (Event, Subject, TimeRange, StorageState,
	ResultType)

SIG_EVENT = "asaasay"

log = logging.getLogger("zeitgeist.client")

# This is here so testutils.py can override it with a private bus connection.
# Init needs to be lazy so tests will use the private D-Bus instance.
global session_bus
session_bus = None
def get_bus():
	global session_bus
	if session_bus is None:
		session_bus = dbus.SessionBus()
	return session_bus
def _set_bus(bus):
	global session_bus
	session_bus = bus

class _DBusInterface(object):
	"""Wrapper around dbus.Interface adding convenience methods."""

	# We initialize those as sets in the constructor. Remember that we can't do
	# that here because otherwise all instances would share their state.
	_disconnect_callbacks = None
	_reconnect_callbacks = None

	@staticmethod
	def get_members(introspection_xml):
		"""Parses the XML context returned by Introspect() and returns
		a tuple, where the first item is a list of all methods and the
		second one a list of all signals for the related interface
		"""
		xml = ElementTree.fromstring(introspection_xml)
		nodes = xml.findall("interface/signal")
		signals = [node.attrib["name"] for node in nodes]
		nodes = xml.findall("interface/method")
		methods = [node.attrib["name"] for node in nodes]
		try:
			methods.remove("Introspect") # Introspect is not part of the API
		except ValueError:
			pass
		return methods, signals

	def reconnect(self):
		if not self._reconnect_when_needed:
			return
		self.__proxy = get_bus().get_object(
			self.__iface.requested_bus_name, self.__object_path,
			follow_name_owner_changes=True)
		self.__iface = dbus.Interface(self.__proxy, self.__interface_name)
		self._load_introspection_data()

	def _disconnection_safe(self, method_getter, *args, **kwargs):
		"""
		Executes the method returned by method_getter. If it fails because
		the D-Bus connection was lost, it attempts to recover it and executes
		the method again.
		"""
		
		custom_error_handler = None
		original_kwargs = dict(kwargs)

		def reconnecting_error_handler(e):
			error = e.get_dbus_name()
			if error == "org.freedesktop.DBus.Error.ServiceUnknown":
				self.reconnect()
				# We don't use the reconnecting_error_handler here since that'd
				# get us into an endless loop if Zeitgeist really isn't there.
				return method_getter()(*args, **original_kwargs)
			else:
				if custom_error_handler is not None:
					custom_error_handler(e)
				else:
					raise

		if 'error_handler' in kwargs:
			# If the method is being called asynchronously it'll call the given
			# handler on failure instead of directly raising an exception.
			custom_error_handler = kwargs['error_handler']
			kwargs['error_handler'] = reconnecting_error_handler

		try:
			return method_getter()(*args, **kwargs)
		except dbus.exceptions.DBusException as e:
			return reconnecting_error_handler(e)

	def __getattr__(self, name):
		if self.__methods is not None and name not in self.__methods:
			raise TypeError("Unknown method name: %s" % name)
		def _ProxyMethod(*args, **kwargs):
			"""
			Method wrapping around a D-Bus call, which attempts to recover
			the connection to Zeitgeist if it got lost.
			"""
			return self._disconnection_safe(
				lambda: getattr(self.__iface, name), *args, **kwargs)
		return _ProxyMethod

	def get_property(self, property_name):
		return self._disconnection_safe(
			lambda: self.__proxy.get_dbus_method("Get", dbus.PROPERTIES_IFACE),
			self.__interface_name, property_name)

	def connect(self, signal, callback, **kwargs):
		"""Connect a callback to a signal of the current proxy instance."""
		if self.__signals is None:
			self.reconnect()
		if signal not in self.__signals:
			raise TypeError("Unknown signal name: %s" % signal)
		return self.__proxy.connect_to_signal(
			signal,
			callback,
			dbus_interface=self.__interface_name,
			**kwargs)

	def connect_exit(self, callback):
		"""Executes callback when the remote interface disappears from the bus"""
		self._disconnect_callbacks.add(callback)

	def connect_join(self, callback):
		"""
		Executes callback when someone claims the Zeitgeist D-Bus name.
		This may be used to perform some action if the daemon is restarted while
		it was being used.
		"""
		self._reconnect_callbacks.add(callback)

	@property
	def proxy(self):
		return self.__proxy

	def _load_introspection_data(self):
		self.__methods, self.__signals = self.get_members(
			self.__proxy.Introspect(
				dbus_interface='org.freedesktop.DBus.Introspectable'))

	def __init__(self, proxy, interface_name, object_path, reconnect=True):
		self.__proxy = proxy
		self.__interface_name = interface_name
		self.__object_path = object_path
		self.__iface = dbus.Interface(proxy, interface_name)
		self._reconnect_when_needed = reconnect
		self._load_introspection_data()
		
		self._first_connection = True
		self._disconnect_callbacks = set()
		self._reconnect_callbacks = set()
		
		# Listen to (dis)connection notifications, for connect_exit and connect_join
		def name_owner_changed(connection_name):
			if connection_name == "":
				self.__methods = self.__signals = None
				for callback in self._disconnect_callbacks:
					callback()
			elif self._first_connection:
				# python-dbus guarantees that it'll call NameOwnerChanged at startup
				# (even if the service was already running). When that happens, we
				# don't want to connect the signals a second time.
				self._first_connection = False
			else:
				if not self._reconnect_when_needed:
					return
				self.reconnect()
				for callback in self._reconnect_callbacks:
					callback()
		get_bus().watch_name_owner(self.__iface.requested_bus_name,
			name_owner_changed)

class ZeitgeistDBusInterface(object):
	""" Central DBus interface to the Zeitgeist engine
	
	There does not necessarily have to be one single instance of this
	interface class, but all instances should share the same state
	(like use the same bus and be connected to the same proxy). This is
	achieved by extending the `Borg Pattern` as described by Alex Martelli	
	"""
	__shared_state = {}
	
	BUS_NAME = "org.gnome.zeitgeist.Engine"
	INTERFACE_NAME = "org.gnome.zeitgeist.Log"
	OBJECT_PATH = "/org/gnome/zeitgeist/log/activity"
	
	def __getattr__(self, name):
		return getattr(self.__shared_state["dbus_interface"], name)
	
	def version(self):
		"""Returns the API version"""
		dbus_interface = self.__shared_state["dbus_interface"]
		return dbus_interface.get_property("version")
	
	def extensions(self):
		"""Returns active extensions"""
		dbus_interface = self.__shared_state["dbus_interface"]
		return dbus_interface.get_property("extensions")
	
	def get_extension(cls, name, path, busname=None):
		""" Returns an interface to the given extension.
		
		Example usage:
			>> reg = get_extension("DataSourceRegistry", "data_source_registry")
			>> reg.RegisterDataSource(...)
		"""
		if busname:
			busname = "org.gnome.zeitgeist.%s" % busname
		else:
			busname = cls.BUS_NAME
		if not name in cls.__shared_state["extension_interfaces"]:
			interface_name = "org.gnome.zeitgeist.%s" % name
			object_path = "/org/gnome/zeitgeist/%s" % path
			proxy = get_bus().get_object(busname, object_path,
				follow_name_owner_changes=True)
			iface = _DBusInterface(proxy, interface_name, object_path)
			iface.BUS_NAME = busname
			iface.INTERFACE_NAME = interface_name
			iface.OBJECT_PATH = object_path
			cls.__shared_state["extension_interfaces"][name] = iface
		return cls.__shared_state["extension_interfaces"][name]
	
	def __init__(self, reconnect=True):
		if not "dbus_interface" in self.__shared_state:
			try:
				proxy = get_bus().get_object(self.BUS_NAME,
					self.OBJECT_PATH, follow_name_owner_changes=True)
			except dbus.exceptions.DBusException as e:
				if e.get_dbus_name() == "org.freedesktop.DBus.Error.ServiceUnknown":
					raise RuntimeError(
						"Found no running zeitgeist-daemon instance: %s" % \
						e.get_dbus_message())
				else:
					raise
			self.__shared_state["extension_interfaces"] = {}
			self.__shared_state["dbus_interface"] = _DBusInterface(proxy,
				self.INTERFACE_NAME, self.OBJECT_PATH, reconnect)

class Monitor(dbus.service.Object):
	"""
	DBus interface for monitoring the Zeitgeist log for certain types
	of events.
	
	When using the Python bindings monitors are normally instantiated
	indirectly by calling :meth:`ZeitgeistClient.install_monitor`.
	
	It is important to understand that the Monitor instance lives on the
	client side, and expose a DBus service there, and the Zeitgeist engine
	calls back to the monitor when matching events are registered.
	"""
	
	# Used in Monitor._next_path() to generate unique path names
	_last_path_id = 0
	
	_event_type = Event

	def __init__ (self, time_range, event_templates, insert_callback,
		delete_callback, monitor_path=None, event_type=None):
		if not monitor_path:
			monitor_path = Monitor._next_path()
		elif isinstance(monitor_path, str):
			monitor_path = dbus.ObjectPath(monitor_path)
		
		if event_type:
			if not issubclass(event_type, Event):
				raise TypeError("Event subclass expected.")
			self._event_type = event_type
		
		self._time_range = time_range
		self._templates = event_templates
		self._path = monitor_path
		self._insert_callback = insert_callback
		self._delete_callback = delete_callback
		dbus.service.Object.__init__(self, get_bus(), monitor_path)
	
	def get_path (self): return self._path
	path = property(get_path,
		doc="Read only property with the DBus path of the monitor object")
	
	def get_time_range(self): return self._time_range
	time_range = property(get_time_range,
		doc="Read only property with the :class:`TimeRange` matched by this monitor")
	
	def get_templates (self): return self._templates
	templates = property(get_templates,
		doc="Read only property with installed templates")
	
	@dbus.service.method("org.gnome.zeitgeist.Monitor",
	                     in_signature="(xx)a("+SIG_EVENT+")")
	def NotifyInsert(self, time_range, events):
		"""
		Receive notification that a set of events matching the monitor's
		templates has been recorded in the log.
		
		This method is the raw DBus callback and should normally not be
		overridden. Events are received via the *insert_callback*
		argument given in the constructor to this class.
		
		:param time_range: A two-tuple of 64 bit integers with the minimum
		    and maximum timestamps found in *events*. DBus signature (xx)
		:param events: A list of DBus event structs, signature a(asaasay)
		    with the events matching the monitor.
		    See :meth:`ZeitgeistClient.install_monitor`
		"""
		self._insert_callback(TimeRange(time_range[0], time_range[1]),
			list(map(self._event_type, events)))
	
	@dbus.service.method("org.gnome.zeitgeist.Monitor",
	                     in_signature="(xx)au")
	def NotifyDelete(self, time_range, event_ids):
		"""
		Receive notification that a set of events within the monitor's
		matched time range has been deleted. Note that this notification
		will also be emitted for deleted events that doesn't match the
		event templates of the monitor. It's just the time range which
		is considered here.
		
		This method is the raw DBus callback and should normally not be
		overridden. Events are received via the *delete_callback*
		argument given in the constructor to this class.
		
		:param time_range: A two-tuple of 64 bit integers with the minimum
		    and maximum timestamps found in *events*. DBus signature (xx)
		:param event_ids: A list of event ids. An event id is simply
		    and unsigned 32 bit integer. DBus signature au.
		"""
		self._delete_callback(TimeRange(time_range[0], time_range[1]), event_ids)
	
	def __hash__ (self):
		return hash(self._path)
	
	@classmethod
	def _next_path(cls):
		"""
		Generate a new unique DBus object path for a monitor
		"""
		cls._last_path_id += 1
		return dbus.ObjectPath("/org/gnome/zeitgeist/monitor/%s" % \
			cls._last_path_id)

class ZeitgeistClient(object):
	"""
	Convenience APIs to have a Pythonic way to call and monitor the running
	Zeitgeist engine. For raw DBus access use the
	:class:`ZeitgeistDBusInterface` class.
	
	Note that this class only does asynchronous DBus calls. This is almost
	always the right thing to do. If you really want to do synchronous
	DBus calls use the raw DBus API found in the ZeitgeistDBusInterface class.
	"""
	
	_installed_monitors = []
	_event_type = Event
	
	@staticmethod
	def get_event_and_extra_arguments(arguments):
		""" some methods of :class:`ZeitgeistClient` take a variable
		number of arguments, where one part of the arguments are used
		to build one :class:`Event` instance and the other part
		is forwarded to another method. This function returns an event
		and the remaining arguments."""
		kwargs = {}
		for arg in _FIND_EVENTS_FOR_TEMPLATES_ARGS:
			if arg in arguments:
				kwargs[arg] = arguments.pop(arg)
		ev = Event.new_for_values(**arguments)
		return ev, kwargs
	
	def __init__ (self):
		self._iface = ZeitgeistDBusInterface()
		self._registry = self._iface.get_extension("DataSourceRegistry",
			"data_source_registry")
		
		# Reconnect all active monitors if the connection is reset.
		def reconnect_monitors():
			log.info("Reconnected to Zeitgeist engine...")
			for monitor in self._installed_monitors:
				self._iface.InstallMonitor(monitor.path,
					monitor.time_range,
					monitor.templates,
					reply_handler=self._void_reply_handler,
					error_handler=lambda err: log.warn(
						"Error reinstalling monitor: %s" % err))
		self._iface.connect_join(reconnect_monitors)
	
	def register_event_subclass(self, event_type):
		"""
		Register a subclass of Event with this ZeiteistClient instance. When
		data received over D-Bus is instantiated into an Event object, the
		provided subclass will be used.
		"""
		if not issubclass(event_type, Event):
			raise TypeError("Event subclass expected.")
		self._event_type = event_type
	
	def register_subject_subclass(self, subject_type):
		"""
		Register a subclass of Subject with this ZeiteistClient instance. When
		data received over D-Bus is instantiated into a Subject object, the
		provided subclass will be used.
		
		Note that this method works by changing the Event type associated with
		this ZeitgeistClient instance, so it should always be called *after*
		any register_event_subclass calls.
		
		Even better, if you also have a custom Event subclass, you may directly
		override the Subject type by changing its _subject_type class variable.
		"""
		if not issubclass(subject_type, Subject):
			raise TypeError("Subject subclass expected.")
		class EventWithCustomSubject(self._event_type):
			_subject_type = subject_type
		self._event_type = EventWithCustomSubject
	
	def _safe_error_handler(self, error_handler, *args):
		if error_handler is not None:
			if callable(error_handler):
				return error_handler
			raise TypeError(
				"Error handler not callable, found %s" % error_handler)
		return lambda raw: self._stderr_error_handler(raw, *args)
	
	def _safe_reply_handler(self, reply_handler):
		if reply_handler is not None:
			if callable(reply_handler):
				return reply_handler
			raise TypeError(
				"Reply handler not callable, found %s" % reply_handler)
		return self._void_reply_handler
	
	# Properties
	
	def get_version(self):
		return [int(i) for i in self._iface.version()]
		
	def get_extensions(self):
		return [str(i) for i in self._iface.extensions()]
	
	# Methods
	
	def insert_event (self, event, ids_reply_handler=None, error_handler=None):
		"""
		Send an event to the Zeitgeist event log. The 'event' parameter
		must be an instance of the Event class.
		
		The insertion will be done via an asynchronous DBus call and
		this method will return immediately. This means that the
		Zeitgeist engine will most likely not have inserted the event
		when this method returns. There will be a short delay.
		
		If the ids_reply_handler argument is set to a callable it will
		be invoked with a list containing the ids of the inserted events
		when they have been registered in Zeitgeist.
		
		In case of errors a message will be printed on stderr, and
		an empty result passed to ids_reply_handler (if set).
		To override this default set the error_handler named argument
		to a callable that takes a single exception as its sole
		argument.
		
		In order to use this method there needs to be a mainloop
		runnning. Both Qt and GLib mainloops are supported.
		"""
		self.insert_events([event],
				ids_reply_handler=ids_reply_handler,
				error_handler=error_handler)
	
	def insert_event_for_values (self, **values):
		"""
		Send an event to the Zeitgeist event log. The keyword arguments
		must match those as provided to Event.new_for_values().
		
		The insertion will be done via an asynchronous DBus call and
		this method will return immediately. This means that the
		Zeitgeist engine will most likely not have inserted the event
		when this method returns. There will be a short delay.
		
		If the ids_reply_handler argument is set to a callable it will
		be invoked with a list containing the ids of the inserted events
		when they have been registered in Zeitgeist.
		
		In case of errors a message will be printed on stderr, and
		an empty result passed to ids_reply_handler (if set).
		To override this default set the error_handler named argument
		to a callable that takes a single exception as its sole
		argument.
		
		In order to use this method there needs to be a mainloop
		runnning. Both Qt and GLib mainloops are supported.
		"""
		ev = Event.new_for_values(**values)
		self.insert_events([ev],
				values.get("ids_reply_handler", None),
				values.get("error_handler", None))
	
	def insert_events (self, events, ids_reply_handler=None, error_handler=None):
		"""
		Send a collection of events to the Zeitgeist event log. The
		*events* parameter must be a list or tuple containing only
		members of of type :class:`Event <zeitgeist.datamodel.Event>`.
		
		The insertion will be done via an asynchronous DBus call and
		this method will return immediately. This means that the
		Zeitgeist engine will most likely not have inserted the events
		when this method returns. There will be a short delay.
		
		In case of errors a message will be printed on stderr, and
		an empty result passed to *ids_reply_handler* (if set).
		To override this default set the *error_handler* named argument
		to a callable that takes a single exception as its sole
		argument.
		
		In order to use this method there needs to be a mainloop
		runnning. Both Qt and GLib mainloops are supported.
		"""
		
		self._check_list_or_tuple(events)
		self._check_members(events, Event)
		self._iface.InsertEvents(events,
					reply_handler=self._safe_reply_handler(ids_reply_handler),
					error_handler=self._safe_error_handler(error_handler,
						self._safe_reply_handler(ids_reply_handler), []))
	
	def find_event_ids_for_templates (self,
					event_templates,
					ids_reply_handler,
					timerange = None,
					storage_state = StorageState.Any,
					num_events = 20,
					result_type = ResultType.MostRecentEvents,
					error_handler=None):
		"""
		Send a query matching a collection of
		:class:`Event <zeitgeist.datamodel.Event>` templates to the
		Zeitgeist event log. The query will match if an event matches
		any of the templates. If an event template has more
		than one subject the query will match if any one of the subject
		templates match.
		
		The query will be done via an asynchronous DBus call and
		this method will return immediately. The return value
		will be passed to 'ids_reply_handler' as a list
		of integer event ids. This list must be the sole argument for
		the callback.
		
		The actual :class:`Events` can be looked up via the
		:meth:`get_events()` method.
		
		This method is intended for queries potentially returning a
		large result set. It is especially useful in cases where only
		a portion of the results are to be displayed at the same time
		(eg., by using paging or dynamic scrollbars), as by holding a
		list of IDs you keep a stable ordering, and you can ask for
		the details associated to them in batches, when you need them. For
		queries with a small amount of results, or where you need the
		information about all results at once no matter how many of them
		there are, see :meth:`find_events_for_templates`.
		 
		In case of errors a message will be printed on stderr, and
		an empty result passed to ids_reply_handler.
		To override this default set the error_handler named argument
		to a callable that takes a single exception as its sole
		argument.
		
		In order to use this method there needs to be a mainloop
		runnning. Both Qt and GLib mainloops are supported.
		
		:param event_templates: List or tuple of
		    :class:`Event <zeitgeist.datamodel.Event>` instances
		:param ids_reply_handler: Callable taking a list of integers
		:param timerange: A
		    :class:`TimeRange <zeitgeist.datamodel.TimeRange>` instance
		    that the events must have occured within. Defaults to
		    :meth:`TimeRange.until_now()`.
		:param storage_state: A value from the
		    :class:`StorageState <zeitgeist.datamodel.StorageState>`
		    enumeration. Defaults to :const:`StorageState.Any`
		:param num_events: The number of events to return; default is 20
		:param result_type: A value from the
		    :class:`ResultType <zeitgeist.datamodel.ResultType>`
		    enumeration. Defaults to ResultType.MostRecentEvent
		:param error_handler: Callback to catch error messages.
		        Read about the default behaviour above
		"""
		self._check_list_or_tuple(event_templates)
		self._check_members(event_templates, Event)
		
		if not callable(ids_reply_handler):
			raise TypeError(
				"Reply handler not callable, found %s" % ids_reply_handler)
		
		if timerange is None:
			timerange = TimeRange.until_now()
		
		self._iface.FindEventIds(timerange,
					event_templates,
					storage_state,
					num_events,
					result_type,
					reply_handler=self._safe_reply_handler(ids_reply_handler),
					error_handler=self._safe_error_handler(error_handler,
						ids_reply_handler, []))
	
	def find_event_ids_for_template (self, event_template, ids_reply_handler,
		**kwargs):
		"""
		Alias for :meth:`find_event_ids_for_templates`, for use when only
		one template is needed.
		"""
		self.find_event_ids_for_templates([event_template],
						ids_reply_handler,
						**kwargs)
	
	def find_event_ids_for_values(self, ids_reply_handler, **kwargs):
		"""
		Alias for :meth:`find_event_ids_for_templates`, for when only
		one template is needed. Instead of taking an already created
		template, like :meth:`find_event_ids_for_template`, this method
		will construct the template from the parameters it gets. The
		allowed keywords are the same as the ones allowed by
		:meth:`Event.new_for_values() <zeitgeist.datamodel.Event.new_for_values>`.
		"""
		ev, arguments = self.get_event_and_extra_arguments(kwargs)
		self.find_event_ids_for_templates([ev],
						ids_reply_handler,
						**arguments)
	
	def find_events_for_templates (self,
					event_templates,
					events_reply_handler,
					timerange = None,
					storage_state = StorageState.Any,
					num_events = 20,
					result_type = ResultType.MostRecentEvents,
					error_handler=None):
		"""
		Send a query matching a collection of
		:class:`Event <zeitgeist.datamodel.Event>` templates to the
		Zeitgeist event log. The query will match if an event matches
		any of the templates. If an event template has more
		than one subject the query will match if any one of the subject
		templates match.
		
		The query will be done via an asynchronous DBus call and
		this method will return immediately. The return value
		will be passed to 'events_reply_handler' as a list
		of :class:`Event`s. This list must be the sole argument for
		the callback.
		
		If you need to do a query yielding a large (or unpredictable)
		result set and you only want to show some of the results at the
		same time (eg., by paging them), consider using
		:meth:`find_event_ids_for_templates`.
		 
		In case of errors a message will be printed on stderr, and
		an empty result passed to events_reply_handler.
		To override this default set the error_handler named argument
		to a callable that takes a single exception as its sole
		argument.
		
		In order to use this method there needs to be a mainloop
		runnning. Both Qt and GLib mainloops are supported.
		
		:param event_templates: List or tuple of
		    :class:`Event <zeitgeist.datamodel.Event>` instances
		:param events_reply_handler: Callable taking a list of integers
		:param timerange: A
		    :class:`TimeRange <zeitgeist.datamodel.TimeRange>` instance
		    that the events must have occured within. Defaults to
		    :meth:`TimeRange.until_now()`.
		:param storage_state: A value from the
		    :class:`StorageState <zeitgeist.datamodel.StorageState>`
		    enumeration. Defaults to :const:`StorageState.Any`
		:param num_events: The number of events to return; default is 20
		:param result_type: A value from the
		    :class:`ResultType <zeitgeist.datamodel.ResultType>`
		    enumeration. Defaults to ResultType.MostRecentEvent
		:param error_handler: Callback to catch error messages.
		        Read about the default behaviour above
		"""
		self._check_list_or_tuple(event_templates)
		self._check_members(event_templates, Event)
		
		if not callable(events_reply_handler):
			raise TypeError(
				"Reply handler not callable, found %s" % events_reply_handler)
		
		if timerange is None:
			timerange = TimeRange.until_now()
		
		self._iface.FindEvents(timerange,
					event_templates,
					storage_state,
					num_events,
					result_type,
					reply_handler=lambda raw: events_reply_handler(
						list(map(self._event_type.new_for_struct, raw))),
					error_handler=self._safe_error_handler(error_handler,
						events_reply_handler, []))
	
	def find_events_for_template (self, event_template, events_reply_handler,
		**kwargs):
		"""
		Alias for :meth:`find_events_for_templates`, for use when only
		one template is needed.
		"""
		self.find_events_for_templates([event_template],
						events_reply_handler,
						**kwargs)
	
	def find_events_for_values(self, events_reply_handler, **kwargs):
		"""
		Alias for :meth:`find_events_for_templates`, for when only
		one template is needed. Instead of taking an already created
		template, like :meth:`find_event_ids_for_template`, this method
		will construct the template from the parameters it gets. The
		allowed keywords are the same as the ones allowed by
		:meth:`Event.new_for_values() <zeitgeist.datamodel.Event.new_for_values>`.
		"""
		ev, arguments = self.get_event_and_extra_arguments(kwargs)
		self.find_events_for_templates([ev],
						events_reply_handler,
						**arguments)
	
	def get_events (self, event_ids, events_reply_handler, error_handler=None):
		"""
		Look up a collection of :class:`Events <zeitgeist.datamodel.Event>`
		in the Zeitgeist event log given a collection of event ids.
		This is useful for looking up the event data for events found
		with the *find_event_ids_** family of functions.
		
		Each event which is not found in the event log is represented
		by `None` in the resulting collection.
		
		The query will be done via an asynchronous DBus call and
		this method will return immediately. The returned events
		will be passed to *events_reply_handler* as a list
		of Events, which must be the only argument of the function.
		 
		In case of errors a message will be printed on stderr, and
		an empty result passed to *events_reply_handler*.
		To override this default set the *error_handler* named argument
		to a callable that takes a single exception as its sole
		argument.
		
		In order to use this method there needs to be a mainloop
		runnning. Both Qt and GLib mainloops are supported.
		"""
		
		if not callable(events_reply_handler):
			raise TypeError(
				"Reply handler not callable, found %s" % events_reply_handler)
		
		# Generate a wrapper callback that does automagic conversion of
		# the raw DBus reply into a list of Event instances
		self._iface.GetEvents(event_ids,
				reply_handler=lambda raw: events_reply_handler(
					list(map(self._event_type.new_for_struct, raw))),
				error_handler=self._safe_error_handler(error_handler,
						events_reply_handler, []))
	
	def delete_events(self, event_ids, reply_handler=None, error_handler=None):
		"""
		Warning: This API is EXPERIMENTAL and is not fully supported yet.
		
		Delete a collection of events from the zeitgeist log given their
		event ids.
		
		The deletion will be done asynchronously, and this method returns
		immediately. To check whether the deletions went well supply
		the *reply_handler* and/or *error_handler* funtions. The
		reply handler should not take any argument. The error handler
		must take a single argument - being the error.
		
		With custom handlers any errors will be printed to stderr.
		
		In order to use this method there needs to be a mainloop
		runnning.
		"""
		self._check_list_or_tuple(event_ids)
		# we need dbus.UInt32 here as long as dbus.UInt32 is not a subtype
		# of int, this might change in the future, see docstring of dbus.UInt32
		self._check_members(event_ids, (int, dbus.UInt32))
		
		self._iface.DeleteEvents(event_ids,
					reply_handler=self._safe_reply_handler(reply_handler),
					error_handler=self._safe_error_handler(error_handler))
	
	def find_related_uris_for_events(self, event_templates, uris_reply_handler,
		error_handler=None, time_range = None, result_event_templates=[],
		storage_state=StorageState.Any, num_events=10, result_type=0):
		"""
		Warning: This API is EXPERIMENTAL and is not fully supported yet.
		
		Get a list of URIs of subjects which frequently occur together
		with events matching `event_templates`. Possibly restricting to
		`time_range` or to URIs that occur as subject of events matching
		`result_event_templates`.
		
		:param event_templates: Templates for events that you want to
		    find URIs that relate to
		:param uris_reply_handler: A callback that takes a list of strings
		    with the URIs of the subjects related to the requested events
		:param time_range: A :class:`TimeRange <zeitgeist.datamodel.TimeRange>`
		    to restrict to
		:param result_event_templates: The related URIs must occur
		    as subjects of events matching these templates
		:param storage_state: The returned URIs must have this
		    :class:`storage state <zeitgeist.datamodel.StorageState>`
		:param num_events: number of related uris you want to have returned
		:param result_type: sorting of the results by 
			0 for relevancy
			1 for recency
		:param error_handler: An optional callback in case of errors.
		    Must take a single argument being the error raised by the
		    server. The default behaviour in case of errors is to call
		    `uris_reply_handler` with an empty list and print an error
		    message on standard error.
		"""
		if not callable(uris_reply_handler):
			raise TypeError(
				"Reply handler not callable, found %s" % uris_reply_handler)
		
		if time_range is None:
			time_range = TimeRange.until_now()
			
		self._iface.FindRelatedUris(time_range, event_templates,
			result_event_templates, storage_state, num_events, result_type,
			reply_handler=self._safe_reply_handler(uris_reply_handler),
			error_handler=self._safe_error_handler(error_handler,
			                                       uris_reply_handler,
			                                       [])
			)
	
	def find_related_uris_for_uris(self, subject_uris, uris_reply_handler,
		time_range=None, result_event_templates=[],
		storage_state=StorageState.Any,  num_events=10, result_type=0, error_handler=None):
		"""
		Warning: This API is EXPERIMENTAL and is not fully supported yet.
		
		Same as :meth:`find_related_uris_for_events`, but taking a list
		of subject URIs instead of event templates.
		"""
		
		event_template = Event.new_for_values(subjects=
			[Subject.new_for_values(uri=uri) for uri in subject_uris])
		
		self.find_related_uris_for_events([event_template],
		                                  uris_reply_handler,
		                                  time_range=time_range,
		                                  result_event_templates=result_event_templates,
		                                  storage_state=storage_state,
		                                  num_events = num_events,
		                                  result_type = result_type,
		                                  error_handler=error_handler)
	
	def install_monitor (self, time_range, event_templates,
		notify_insert_handler, notify_delete_handler, monitor_path=None):
		"""
		Install a monitor in the Zeitgeist engine that calls back
		when events matching *event_templates* are logged. The matching
		is done exactly as in the *find_** family of methods and in
		:meth:`Event.matches_template <zeitgeist.datamodel.Event.matches_template>`.
		Furthermore matched events must also have timestamps lying in
		*time_range*.
		
		To remove a monitor call :meth:`remove_monitor` on the returned
		:class:`Monitor` instance.
		
		The *notify_insert_handler* will be called when events matching
		the monitor are inserted into the log. The *notify_delete_handler*
		function will be called when events lying within the monitored
		time range are deleted.
		
		:param time_range: A :class:`TimeRange <zeitgeist.datamodel.TimeRange>`
		    that matched events must lie within. To obtain a time range
		    from now and indefinitely into the future use
		    :meth:`TimeRange.from_now() <zeitgeist.datamodel.TimeRange.from_now>`
		:param event_templates: The event templates to look for
		:param notify_insert_handler: Callback for receiving notifications
		    about insertions of matching events. The callback should take
		    a :class:`TimeRange` as first parameter and a list of
		    :class:`Events` as the second parameter.
		    The time range will cover the minimum and maximum timestamps
		    of the inserted events
		:param notify_delete_handler: Callback for receiving notifications
		    about deletions of events in the monitored time range.
		    The callback should take a :class:`TimeRange` as first
		    parameter and a list of event ids as the second parameter.
		    Note that an event id is simply an unsigned integer.
		:param monitor_path: Optional argument specifying the DBus path
		    to install the client side monitor object on. If none is provided
		    the client will provide one for you namespaced under
		    /org/gnome/zeitgeist/monitor/*
		:returns: a :class:`Monitor`
		"""
		self._check_list_or_tuple(event_templates)
		self._check_members(event_templates, Event)
		if not callable(notify_insert_handler):
			raise TypeError("notify_insert_handler not callable, found %s" % \
				notify_reply_handler)
			
		if not callable(notify_delete_handler):
			raise TypeError("notify_delete_handler not callable, found %s" % \
				notify_reply_handler)
		
		
		mon = Monitor(time_range, event_templates, notify_insert_handler,
			notify_delete_handler, monitor_path=monitor_path,
			event_type=self._event_type)
		self._iface.InstallMonitor(mon.path,
		                           mon.time_range,
		                           mon.templates,
		                           reply_handler=self._void_reply_handler,
		                           error_handler=lambda err: log.warn(
									"Error installing monitor: %s" % err))
		self._installed_monitors.append(mon)
		return mon
	
	def remove_monitor (self, monitor, monitor_removed_handler=None):
		"""
		Remove a :class:`Monitor` installed with :meth:`install_monitor`
		
		:param monitor: Monitor to remove. Either as a :class:`Monitor`
		    instance or a DBus object path to the monitor either as a
		    string or :class:`dbus.ObjectPath`
		:param monitor_removed_handler: A callback function taking
		    one integer argument. 1 on success, 0 on failure.
		"""
		if isinstance(monitor, str):
			path = dbus.ObjectPath(monitor)
		elif isinstance(monitor, Monitor):
			path = monitor.path
		else:
			raise TypeError(
				"Monitor, str, or unicode expected. Found %s" % type(monitor))
		
		if callable(monitor_removed_handler):
			
			def dispatch_handler (error=None):
				if error :
					log.warn("Error removing monitor %s: %s" % (monitor, error))
					monitor_removed_handler(0)
				else: monitor_removed_handler(1)
				
			reply_handler = dispatch_handler
			error_handler = dispatch_handler
		else:
			reply_handler = self._void_reply_handler
			error_handler = lambda err: log.warn(
				"Error removing monitor %s: %s" % (monitor, err))
		
		self._iface.RemoveMonitor(path,
		                          reply_handler=reply_handler,
		                          error_handler=error_handler)
		self._installed_monitors.remove(monitor)
	
	# Data-source related class variables
	_data_sources = {}
	_data_sources_callback_installed = False
	
	def register_data_source(self, unique_id, name, description,
		event_templates, enabled_callback=None):
		"""
		Register a data-source as currently running. If the data-source was
		already in the database, its metadata (name, description and
		event_templates) are updated.
		
		If the data-source registry isn't enabled, do nothing.
		
		The optional event_templates is purely informational and serves to
		let data-source management applications and other data-sources know
		what sort of information you log.
		
		:param unique_id: unique ASCII string identifying the data-source
		:param name: data-source name (may be translated)
		:param description: data-source description (may be translated)
		:param event_templates: list of
			:class:`Event <zeitgeist.datamodel.Event>` templates.
		:param enabled_callback: method to call as response with the `enabled'
			status of the data-source, and after that every time said status
			is toggled. See set_data_source_enabled_callback() for more
			information.
		"""
		
		self._data_sources[unique_id] = {'enabled': None, 'callback': None}
		
		if enabled_callback is not None:
			self.set_data_source_enabled_callback(unique_id, enabled_callback)

		def _data_source_enabled_cb(unique_id, enabled):
			if unique_id not in self._data_sources:
				return
			self._data_sources[unique_id]['enabled'] = enabled
			callback = self._data_sources[unique_id]['callback']
			if callback is not None:
				callback(enabled)
		
		def _data_source_register_cb(enabled):
			_data_source_enabled_cb(unique_id, enabled)

		if not self._data_sources_callback_installed:
			self._registry.connect('DataSourceEnabled', _data_source_enabled_cb)
			self._data_sources_callback_installed = True

		self._registry.RegisterDataSource(unique_id, name, description,
			event_templates,
			reply_handler=_data_source_register_cb,
			error_handler=self._void_reply_handler) # Errors are ignored
	
	def set_data_source_enabled_callback(self, unique_id, enabled_callback):
		"""
		This method may only be used after having registered the given unique_id
		with register_data_source before.
		
		It registers a method to be called whenever the `enabled' status of
		the previously registered data-source changes.
		
		Remember that on some systems the DataSourceRegistry extension may be
		disabled, in which case this method will have no effect.
		"""
		
		if unique_id not in self._data_sources:
			raise ValueError('set_data_source_enabled_callback() called before ' \
			'register_data_source()')
		
		if not callable(enabled_callback):
			raise TypeError('enabled_callback: expected a callable method')
		
		self._data_sources[unique_id]['callback'] = enabled_callback
	
	def _check_list_or_tuple(self, collection):
		"""
		Raise a ValueError unless 'collection' is a list or tuple
		"""
		if not (isinstance(collection, list) or isinstance(collection, tuple)):
			raise TypeError("Expected list or tuple, found %s" % type(collection))
	
	def _check_members (self, collection, member_class):
		"""
		Raise a ValueError unless all of the members of 'collection'
		are of class 'member_class'
		"""
		for m in collection:
			if not isinstance(m, member_class):
				raise TypeError(
					"Collection contains member of invalid type %s. Expected %s" % \
					(m.__class__, member_class))
	
	def _void_reply_handler(self, *args, **kwargs):
		"""
		Reply handler for async DBus calls that simply ignores the response
		"""
		pass
		
	def _stderr_error_handler(self, exception, normal_reply_handler=None,
		normal_reply_data=None):
		"""
		Error handler for async DBus calls that prints the error
		to sys.stderr
		"""
		print("Error from Zeitgeist engine:", exception, file=sys.stderr)
		
		if callable(normal_reply_handler):
			normal_reply_handler(normal_reply_data)

_FIND_EVENTS_FOR_TEMPLATES_ARGS = inspect.getfullargspec(
	ZeitgeistClient.find_events_for_templates).args

# vim:noexpandtab:ts=4:sw=4