Merge lp:~zeitgeist/zeitgeist/find.applications into lp:zeitgeist/0.1

[Siegfried Gevatter]

Merge with trunk and address Markus Korn's comment about a wrong docstring.

[Markus Korn (thekorn)]

docstring of FindApplications is not correct:
 """:rtype: list of tuples presenting an :ref:`item-label`"""
in fact it is a list of tuples containing the .desktop file and some counter

Apart from that, ACK, good work

review: Needs Fixing

[lp:~zeitgeist/zeitgeist/find.applications]

1021. By Siegfried Gevatter on 2009-07-13

Merge with trunk and address Markus Korn's comment about a wrong docstring.

[Markus Korn (thekorn)]

full ACK with after the docstring change

review: Approve

[Siegfried Gevatter (rainct)]

text conflict in _zeitgeist/engine/engine.py
text conflict in _zeitgeist/engine/remote.py

=== modified file '_zeitgeist/engine/engine.py'
--- _zeitgeist/engine/engine.py	2009-07-11 23:20:37 +0000
+++ _zeitgeist/engine/engine.py	2009-07-13 18:00:06 +0000
@@ -276,7 +276,7 @@
 			return self._format_result(item)
 	
 	def find_events(self, min=0, max=sys.maxint, limit=0,
-			sorting_asc=True, mode="event", filters=(), only_count=False):
+			sorting_asc=True, mode="event", filters=(), return_mode=0):
 		"""
 		Returns all items from the database between the indicated
 		timestamps `min' and `max'. Optionally the argument `tags'
@@ -296,6 +296,12 @@
 		between diferent structs it is OR-like (only the conditions
 		described in one of the structs need to match for the item to
 		be returned).
+		
+		Possible values for return_mode, which is an internal variable
+		not exposed in the API:
+		 - 0: Return the events/items.
+		 - 1: Return the amount of events/items which would be returned.
+		 - 2: Return only the applications for the matching events.
 		"""
 		
 		time1 = time.time()
@@ -379,7 +385,11 @@
 			preexpressions += ", MAX(event.start)"
 			expressions += " GROUP BY event.subject_id"
 			if mode == "mostused":
-				additional_orderby = "COUNT(event.rowid) DESC,"
+				additional_orderby += " COUNT(event.rowid) DESC,"
+		elif return_mode == 2:
+			preexpressions += " , COUNT(event.app_id) AS app_count"
+			expressions += " GROUP BY event.app_id"
+			additional_orderby += " app_count DESC,"
 		
 		args = [ Content.BOOKMARK.id, Content.TAG.id, min, max ]
 		args += additional_args
@@ -415,17 +425,19 @@
 			""" % (preexpressions, expressions, additional_orderby,
 				"ASC" if sorting_asc else "DESC"), args).get_all()
 		
-		if not only_count:
+		if return_mode == 0:
 			result = [self._format_result(event) for event in events]
 			
 			time2 = time.time()
 			log.debug("Fetched %s items in %.5f s." % (len(result), time2 - time1))
-		else:
+		elif return_mode == 1:
 			# We could change the query above to "SELECT COUNT(*) FROM (...)",
 			# where "..." is the complete query converted into a temporary
 			# table, and get the result directly but there isn't enough of
 			# a speed gain in doing that as that it'd be worth doing.
 			result = len(events)
+		elif return_mode == 2:
+			return [(event[10], event[13]) for event in events]
 		
 		return result
 	

=== modified file '_zeitgeist/engine/remote.py'
--- _zeitgeist/engine/remote.py	2009-07-11 23:20:37 +0000
+++ _zeitgeist/engine/remote.py	2009-07-13 18:00:06 +0000
@@ -85,7 +85,27 @@
 		#   content: <str>
 		#   bookmarked: <bool> (True means bookmarked items, and vice versa
 		return _engine.find_events(min_timestamp, max_timestamp, limit,
-			sorting_asc, mode, filters, False)
+			sorting_asc, mode, filters, return_mode=0)
+	
+	@dbus.service.method("org.gnome.zeitgeist",
+						in_signature="iiaa{sv}", out_signature="a(si)")
+	def FindApplications(self, min_timestamp, max_timestamp, filters):
+		"""This method takes a subset of the parameters from ``FindEvents()``
+		and returns the path to the .desktop file of the applications which
+		were used for the matching events.
+		
+		:param min_timestamp: search for application beginning after this timestamp
+		:type min_timestamp: integer
+		:param max_timestamp: search for applications beginning before this timestamp;
+			``max_timestamp`` equals ``0`` means indefinite time
+		:type max_timestamp: integer
+		:param filters: list of filter, multiple filters are connected by an ``OR`` condition
+		:type filters: list of tuples presenting a :ref:`filter-label`
+		:returns: list of items
+		:rtype: list of tuples presenting an :ref:`item-label`
+		"""
+		return _engine.find_events(min_timestamp, max_timestamp, 0, True,
+			u"event", filters, return_mode=2)
 	
 	@dbus.service.method("org.gnome.zeitgeist",
 						in_signature="iisaa{sv}", out_signature="i")
@@ -109,7 +129,7 @@
 		:rtype: list of tuples presenting an :ref:`item-label`
 		"""
 		return _engine.find_events(min_timestamp, max_timestamp, 0, True,
-			mode, filters, True)
+			mode, filters, return_mode=1)
 	
 	@dbus.service.method("org.gnome.zeitgeist",
 						in_signature="siii", out_signature="a(si)")

=== modified file 'test/engine-engine-test.py'
--- test/engine-engine-test.py	2009-07-11 23:20:37 +0000
+++ test/engine-engine-test.py	2009-07-13 18:00:06 +0000
@@ -419,11 +419,33 @@
 			[{"content": [Content.IMAGE.uri]}], True)
 		self.assertEquals(result, 3)
 	
+	def testFindApplications(self):
+		self._init_with_various_events()
+		result = self.engine.find_events(0, 0, 0, True, u"event", [],
+			return_mode=2)
+		self.assertEquals(result, [(u"/usr/share/applications/eog.desktop", 3),
+			(u"/usr/share/applications/firefox.desktop", 2)])
+	
+	def testFindApplications(self):
+		self._init_with_various_events()
+		result = self.engine.find_events(0, 0, 0, True, u"event",
+			[], return_mode=2)
+		self.assertEquals(result, [(u"/usr/share/applications/eog.desktop", 3),
+			(u"/usr/share/applications/firefox.desktop", 2)])
+	
+	def testFindApplicationsTimestampMimetypeTags(self):
+		self._init_with_various_events()
+		result = self.engine.find_events(1219325, 4563533, 0, True, u"event",
+			[{"mimetypes": [u"image/png"], "tags": [u"examples"]}],
+			return_mode=2)
+		self.assertEquals(result, [(u"/usr/share/applications/eog.desktop", 1),
+			(u"/usr/share/applications/firefox.desktop", 1)])
+	
 	def testGetTagsNameFilter(self):
 		self._init_with_various_events()
 		result = self.engine.get_tags(u"f%")
-		self.assertEquals(result, [(u'filtertest', 1),
-			(u'files', 1)])
+		self.assertEquals(result, [(u"filtertest", 1),
+			(u"files", 1)])
 	
 	def testGetTagsLimit(self):
 		self._init_with_various_events()