Merge lp:~jamesh/unity-scope-gdrive/previews into lp:~submarine/unity-scope-gdrive/libunity-7-compatible

[James Henstridge]

Convert to the new scope API and add a preview.

Convert scope to new API, and add a simple preview showing author, modification date and whether the document has been starred or shared.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:49
http://jenkins.qa.ubuntu.com/job/submarine-unity-scope-gdrive-libunity-7-compatible-ci/3/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/submarine-unity-scope-gdrive-libunity-7-compatible-raring-amd64-ci/3

Click here to trigger a rebuild:
http://s-jenkins:8080/job/submarine-unity-scope-gdrive-libunity-7-compatible-ci/3/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

Could we get some tests? Or is that too complex with the authentication?

review: Needs Information

[lp:~jamesh/unity-scope-gdrive/previews]

50. By James Henstridge on 2013-05-08

Use InfoHint to construct the preview.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:50
http://jenkins.qa.ubuntu.com/job/submarine-unity-scope-gdrive-libunity-7-compatible-ci/4/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/submarine-unity-scope-gdrive-libunity-7-compatible-raring-amd64-ci/4

Click here to trigger a rebuild:
http://s-jenkins:8080/job/submarine-unity-scope-gdrive-libunity-7-compatible-ci/4/rebuild

review: Approve (continuous-integration)

[lp:~jamesh/unity-scope-gdrive/previews]

51. By James Henstridge on 2013-05-09

Add a test for the search functionality. Unfortunately we need to use a
stub document since GData.Parsable.new_from_xml() segfaults for
GData.Feed subtypes.

The preview test is also skipped because I can't initialise the metadata
dictionary.

52. By James Henstridge on 2013-05-09

Enable tests in packaging.

[James Henstridge (jamesh)]

I've added some basic tests for the search functionality, although it stubs out all the account discovery code and provides a fake DocumentsEntry class.

My original plan was to use GData.Parsable.new_from_xml() to build the feed from some sample XML, but that segfaults the interpreter. A quick poke with GDB shows that this wouldn't work from C either: it looks like you can only decode into GData.Feed subclasses from the query code path.

The previewer test is also disabled because I wasn't able to initialise Unity.ScopeResult.metadata from Python in a way that wouldn't cause it to segfault.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:52
http://jenkins.qa.ubuntu.com/job/submarine-unity-scope-gdrive-libunity-7-compatible-ci/5/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/submarine-unity-scope-gdrive-libunity-7-compatible-raring-amd64-ci/5

Click here to trigger a rebuild:
http://s-jenkins:8080/job/submarine-unity-scope-gdrive-libunity-7-compatible-ci/5/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

LGTM.

review: Approve

=== modified file 'debian/control'
--- debian/control	2013-03-15 10:09:23 +0000
+++ debian/control	2013-05-09 07:42:25 +0000
@@ -7,6 +7,13 @@
                pkg-config,
                python3,
                python3-distutils-extra,
+               python3-nose,
+               python3-gi,
+               gir1.2-glib-2.0,
+               gir1.2-accounts-1.0,
+               gir1.2-signon-1.0,
+               gir1.2-gdata-0.0,
+               gir1.2-unity-5.0 (>= 6.91),
 Standards-Version: 3.9.3
 Homepage: https://launchpad.net/unity-scope-gdrive
 # If you aren't a member of ~online-accounts but need to upload packaging

=== modified file 'debian/rules'
--- debian/rules	2012-11-30 16:02:18 +0000
+++ debian/rules	2013-05-09 07:42:25 +0000
@@ -13,6 +13,9 @@
 override_dh_auto_build:
 	python3 setup.py build
 
+override_dh_auto_test:
+	nosetests3
+
 override_dh_auto_install:
 	python3 setup.py install --root=$(CURDIR)/debian/unity-scope-gdrive --install-layout=deb
 

=== modified file 'gdrive.scope'
--- gdrive.scope	2013-05-01 17:52:08 +0000
+++ gdrive.scope	2013-05-09 07:42:25 +0000
@@ -4,7 +4,7 @@
 Icon=/usr/share/icons/unity-icon-theme/places/svg/service-gdrive.svg
 Keywords=gdrive;doc;drive;google;
 Loader=/usr/share/unity-scopes/gdrive/unity_gdrive_daemon.py
-RequiredMetadata=
+RequiredMetadata=author[s];shared[b];starred[b];updated[i]
 OptionalMetadata=
 RemoteContent=true
 Type=file

=== added file 'test_scope.py'
--- test_scope.py	1970-01-01 00:00:00 +0000
+++ test_scope.py	2013-05-09 07:42:25 +0000
@@ -0,0 +1,142 @@
+import unittest
+
+from gi.repository import GData, GLib, Unity
+
+import unity_gdrive_daemon as gdrive
+
+
+class ResultSet(Unity.ResultSet):
+    def __init__(self):
+        Unity.ResultSet.__init__(self)
+        self.results = []
+
+    def do_add_result(self, result):
+        self.results.append(dict(uri=result.uri,
+                                 icon=result.icon_hint,
+                                 category=result.category,
+                                 result_type=result.result_type,
+                                 mimetype=result.mimetype,
+                                 title=result.title,
+                                 comment=result.comment,
+                                 dnd_uri=result.dnd_uri,
+                                 author=result.metadata['author'].get_string(),
+                                 shared=result.metadata['shared'].get_boolean(),
+                                 starred=result.metadata['starred'].get_boolean(),
+                                 updated=result.metadata['updated'].get_int32()))
+
+
+class FakeDocumentsEntry:
+    """A fake GData.DocumentsEntry"""
+
+    def get_resource_id(self):
+        return 'spreadsheet:abcdefghij'
+
+    def look_up_link(self, rel):
+        assert rel == GData.LINK_ALTERNATE
+        return GData.Link.new("http://example.com/view", rel)
+
+    def get_updated(self):
+        return 1000000000
+
+    def get_title(self):
+        return "Fake title"
+
+    def get_authors(self):
+        return [GData.Author.new('john.smith', '', '[e-mail]')]
+
+    def get_categories(self):
+        return [GData.Category.new(
+                'http://schemas.google.com/g/2005/labels#starred',
+                'http://schemas.google.com/g/2005/labels', 'starred')]
+
+    def get_content_uri(self):
+        return "http://example.com/export"
+
+
+class StubGDocsAccount(gdrive.GDocsAccount):
+    def __init__(self):
+        self._enabled = True
+
+    def get_doc_list(self, search, filters, is_global):
+        # It would be nice if we could use
+        # GData.Parsable.new_from_xml() to generate the feed from XML,
+        # but it segfaults.
+        return [FakeDocumentsEntry()]
+
+
+def fake_setup_accounts(self):
+    self._gdocs_accounts.append(StubGDocsAccount())
+
+
+class GDriveTests(unittest.TestCase):
+    def setUp(self):
+        super(GDriveTests, self).setUp()
+        self._orig_setup_accounts = gdrive.GDriveScope.setup_accounts
+        gdrive.GDriveScope.setup_accounts = fake_setup_accounts
+
+    def tearDown(self):
+        gdrive.GDriveScope.setup_accounts = self._orig_setup_accounts
+        super(GDriveTests, self).tearDown()
+
+    def perform_query(self, query):
+        scope = gdrive.GDriveScope()
+        filter_set = scope.get_filters()
+        result_set = ResultSet()
+        context = Unity.SearchContext.create(
+            query, 0, filter_set, None, result_set, None)
+
+        search = scope.create_search_for_query(context)
+        search.run()
+        return result_set.results
+
+    def test_get_categories(self):
+        scope = gdrive.GDriveScope()
+        category_set = scope.get_categories()
+        self.assertEqual(
+            [cat.props.id for cat in category_set.get_categories()],
+            ['global', 'recent', 'downloads', 'folders'])
+
+    def test_get_filters(self):
+        scope = gdrive.GDriveScope()
+        filter_set = scope.get_filters()
+        self.assertEqual(
+            [filter.props.id for filter in filter_set.get_filters()],
+            ['modified', 'type'])
+
+    def test_search(self):
+        results = self.perform_query("foo")
+        self.assertEqual(len(results), 1)
+        self.assertEqual(results[0], dict(
+                uri='http://example.com/view',
+                icon='x-office-spreadsheet',
+                category=1,
+                result_type=Unity.ResultType.PERSONAL,
+                mimetype='text/html',
+                title='Fake title',
+                comment='spreadsheet',
+                dnd_uri='http://example.com/export',
+                author='john.smith',
+                shared=False,
+                starred=True,
+                updated=1000000000))
+
+    @unittest.skip("Can not set up metadata in ScopeResult")
+    def test_preview(self):
+        result = Unity.ScopeResult.create(
+            uri='http://example.com/view',
+            icon_hint='x-office-spreadsheet',
+            category=1,
+            result_type=Unity.ResultType.PERSONAL,
+            mimetype='text/html',
+            title='Fake title',
+            comment='spreadsheet',
+            dnd_uri='http://example.com/export',
+            metadata={
+                'author': GLib.Variant('s', 'john.smith'),
+                'shared': GLib.Variant('b', False),
+                'starred': GLib.Variant('b', True),
+                'updated': GLib.Variant('i', 1000000000)})
+        metadata = Unity.SearchMetadata()
+        scope = gdrive.GDriveScope()
+        previewer = scope.create_previewer(result, metadata)
+        preview = previewer.run()

=== modified file 'unity-scope-gdrive.service'
--- unity-scope-gdrive.service	2013-03-22 15:25:03 +0000
+++ unity-scope-gdrive.service	2013-05-09 07:42:25 +0000
@@ -1,3 +1,3 @@
 [D-BUS Service]
 Name=com.canonical.Unity.Scope.File.Gdrive
-Exec=/usr/share/unity-scopes/gdrive/unity_gdrive_daemon.py
+Exec=/usr/bin/python3 /usr/share/unity-scopes/scope-runner-dbus.py /usr/share/unity-scopes/gdrive/unity_gdrive_daemon.py

=== modified file 'unity_gdrive_daemon.py' (properties changed: +x to -x)
--- unity_gdrive_daemon.py	2013-03-22 15:25:03 +0000
+++ unity_gdrive_daemon.py	2013-05-09 07:42:25 +0000
@@ -1,4 +1,5 @@
 #! /usr/bin/python3
+# -*- mode: python; python-indent: 2 -*-
 #
 # Copyright 2012 Canonical Ltd.
 #
@@ -7,27 +8,26 @@
 # GPLv3
 #
 
+from datetime import datetime, timedelta
+import gettext
+import locale
 import sys
+import time
+
 from gi.repository import GLib, GObject, Gio
 from gi.repository import Accounts, Signon
 from gi.repository import GData
-from gi.repository import Unity, UnityExtras
+from gi.repository import Unity
 
-from datetime import datetime, timedelta
-import gettext
-import time
 
 APP_NAME = "unity-scope-gdrive"
 LOCAL_PATH = "/usr/share/locale/"
 
+locale.setlocale(locale.LC_ALL, '')
 gettext.bindtextdomain(APP_NAME, LOCAL_PATH)
 gettext.textdomain(APP_NAME)
 _ = gettext.gettext
 
-#
-# The primary bus name we grab *must* match what we specify in our .scope file
-#
-BUS_NAME = "com.canonical.Unity.Scope.File.Gdrive"
 # Map Google Docs types to the values of the "type" filter
 TYPE_MAP = {
     "document": "documents",
@@ -38,34 +38,34 @@
 }
 THEME = "/usr/share/icons/unity-icon-theme/places/svg/"
 
-class Daemon:
-
-  def __init__ (self):
-    self._scope = Unity.DeprecatedScope.new ("/com/canonical/unity/scope/file/gdrive", "gdrive")
-    self._scope.search_in_global = True;
-    self._preferences = Unity.PreferencesManager.get_default()
-    self._preferences.connect ("notify::remote-content-search",
-            self._on_filters_or_preferences_changed);
+
+class GDriveScope(Unity.AbstractScope):
+  __g_type_name__ = "GDriveScope"
+
+  def __init__(self):
+    super(GDriveScope, self).__init__()
+    self.search_in_global = True;
 
     self._gdocs_accounts = []
-    try:
-      self._account_manager = Accounts.Manager.new_for_service_type("documents")
-    except TypeError as e:
-      print ("Couldn't start account manager, not initialising: %s" % e)
-      sys.exit(0)
-    self._account_manager.connect("enabled-event", self._on_enabled_event);
-    for account in self._account_manager.get_enabled_account_services():
-      self.add_account_service(account)
-
-    # Listen for changes and requests
-    self._scope.connect ("search-changed", self._on_search_changed)
-
-    # This allows us to re-do the search if any parameter on a filter has changed
-    # Though it's possible to connect to a more-specific changed signal on each
-    # Fitler, as we re-do the search anyway, this catch-all signal is perfect for
-    # us.
-    self._scope.connect ("notify::filtering", self._on_filters_or_preferences_changed);
-    
+    self.setup_accounts()
+
+  def do_get_group_name(self):
+    # The primary bus name we grab *must* match what we specify in our
+    # .scope file
+    return "com.canonical.Unity.Scope.File.Gdrive"
+
+  def do_get_unique_name(self):
+    return "/com/canonical/unity/scope/file/gdrive"
+
+  def do_get_schema(self):
+    schema = Unity.Schema.new()
+    schema.add_field('author', 's', Unity.SchemaFieldType.REQUIRED)
+    schema.add_field('shared', 'b', Unity.SchemaFieldType.REQUIRED)
+    schema.add_field('starred', 'b', Unity.SchemaFieldType.REQUIRED)
+    schema.add_field('updated', 'i', Unity.SchemaFieldType.REQUIRED)
+    return schema
+
+  def do_get_filters(self):
     filters = Unity.FilterSet.new()
     f = Unity.RadioOptionFilter.new ("modified", _("Last modified"), Gio.ThemedIcon.new("input-keyboard-symbolic"), False)
     f.add_option ("last-7-days", _("Last 7 days"), None)
@@ -81,7 +81,9 @@
     f2.add_option ("presentations", _("Presentations"), None)
     f2.add_option ("other", _("Other"), None)
     filters.add (f2)
-    self._scope.props.filters = filters
+    return filters
+
+  def do_get_categories(self):
     cats = Unity.CategorySet.new()
     cats.add (Unity.Category.new ('global',
                                   _("Files & Folders"),
@@ -99,8 +101,26 @@
                                   _("Folders"),
                                   Gio.ThemedIcon.new(THEME + "group-folders.svg"),
                                   Unity.CategoryRenderer.VERTICAL_TILE))
-    self._scope.props.categories = cats
-    self._scope.export()
+    return cats
+
+  def do_create_search_for_query(self, search_context):
+    return GDriveScopeSearch(search_context, self._gdocs_accounts)
+
+  def do_create_previewer(self, result, metadata):
+    previewer = GDriveScopePreviewer()
+    previewer.set_scope_result(result)
+    previewer.set_search_metadata(metadata)
+    return previewer
+
+  def setup_accounts(self):
+    try:
+      self._account_manager = Accounts.Manager.new_for_service_type("documents")
+    except TypeError as e:
+      print ("Couldn't start account manager, not initialising: %s" % e)
+      sys.exit(0)
+    self._account_manager.connect("enabled-event", self._on_enabled_event);
+    for account in self._account_manager.get_enabled_account_services():
+      self.add_account_service(account)
 
   def _on_enabled_event (self, account_manager, account_id):
     account = self._account_manager.get_account(account_id)
@@ -113,32 +133,49 @@
     for gdocs_account in self._gdocs_accounts:
       if gdocs_account.get_account_service() == account_service:
         return
-    gdocs_account = GDocsAccount(self._scope, account_service);
+    gdocs_account = GDocsAccount(account_service);
     self._gdocs_accounts.append(gdocs_account)
 
-  def _on_search_changed (self, scope, search, search_type, cancellable):
-    search_string = search.props.search_string
-    results = search.props.results_model
-    results.clear()
-
-    if self._preferences.props.remote_content_search != Unity.PreferencesManagerRemoteContent.ALL:
-      search.emit("finished")
-      return
-
-    if search_type == Unity.SearchType.GLOBAL:
-      is_global = True
-    else:
-      is_global = False
-
-    print("Search changed to: '%s'" % search_string)
-
+
+class GDriveScopeSearch(Unity.ScopeSearchBase):
+  __g_type_name__ = "GDriveScopeSearch"
+
+  def __init__(self, search_context, accounts):
+    super(GDriveScopeSearch, self).__init__()
+    self.set_search_context(search_context)
+    self._gdocs_accounts = accounts
+
+  def do_run(self):
+    print("Search changed to: '%s'" % self.search_context.search_query)
     for gdocs_account in self._gdocs_accounts:
-      gdocs_account.update_results_model (search_string, results, search, is_global)
-    search.emit("finished")
-  
-  def _on_filters_or_preferences_changed (self, *_):
-    self._scope.queue_search_changed(Unity.SearchType.DEFAULT)
-  
+      gdocs_account.search(self.search_context)
+
+
+class GDriveScopePreviewer(Unity.ResultPreviewer):
+  __g_type_name__ = "GDriveScopePreviewer"
+
+  def do_run(self):
+    icon = Gio.ThemedIcon.new(self.result.icon_hint)
+    preview = Unity.GenericPreview.new(self.result.title, '', icon)
+    author = self.result.metadata['author'].get_string()
+    modified = datetime.fromtimestamp(
+      self.result.metadata['updated'].get_int32())
+    shared = self.result.metadata['shared'].get_boolean()
+    starred = self.result.metadata['starred'].get_boolean()
+    preview.props.subtitle = _("By %s") % author
+    preview.add_info(Unity.InfoHint.new(
+        "format", _("Format"), None, self.result.comment))
+    preview.add_info(Unity.InfoHint.new(
+        "modified", _("Modified"), None, modified.strftime('%x, %X')))
+    preview.add_info(Unity.InfoHint.new(
+        "shared", _("Shared"), None, _('yes') if shared else _('no')))
+    preview.add_info(Unity.InfoHint.new(
+        "starred", _("Starred"), None, _('yes') if starred else _('no')))
+
+    action = Unity.PreviewAction.new("open", _("Open"), None)
+    preview.add_action(action)
+    return preview
+
 
 class SignOnAuthorizer(GObject.Object, GData.Authorizer):
   __g_type_name__ = "SignOnAuthorizer"
@@ -195,8 +232,7 @@
 
 # Encapsulates searching a single user's GDocs
 class GDocsAccount:
-  def __init__ (self, scope, account_service):
-    self._scope = scope
+  def __init__ (self, account_service):
     self._account_service = account_service
     self._account_service.connect("enabled", self._on_account_enabled)
     self._enabled = self._account_service.get_enabled()
@@ -212,12 +248,15 @@
     print("account %s, enabled %s" % (account, enabled))
     self._enabled = enabled
 
-  def update_results_model (self, search, model, s, is_global=False):
+  def search (self, context):
     if not self._enabled:
       return
 
     # Get the list of documents
-    feed = self.get_doc_list(search, s, is_global);
+    is_global = context.search_type == Unity.SearchType.GLOBAL
+    feed = self.get_doc_list(
+      context.search_query, context.filter_state, is_global)
+    result_set = context.result_set
     for entry in feed:
       rtype = entry.get_resource_id().split(":")[0]
 
@@ -229,22 +268,38 @@
         else:
           category = 1
 
-      model.append(uri=entry.look_up_link(GData.LINK_ALTERNATE).get_uri(),
-                   icon_hint=self.icon_for_type(rtype),
-                   category=category,
-                   mimetype="text/html",
-                   title=entry.props.title,
-                   comment=rtype,
-                   dnd_uri=entry.props.content_uri,
-                   result_type=Unity.ResultType.PERSONAL);
+      authors = sorted([author.get_name() for author in entry.get_authors()])
+      shared = False
+      starred = False
+      for cat in entry.get_categories():
+        if cat.get_scheme() != 'http://schemas.google.com/g/2005/labels':
+          continue
+        if cat.get_label() == 'shared':
+          shared = True
+        elif cat.get_label() == 'starred':
+          starred = True
+
+      result_set.add_result(
+        uri=entry.look_up_link(GData.LINK_ALTERNATE).get_uri(),
+        icon=self.icon_for_type(rtype),
+        category=category,
+        result_type=Unity.ResultType.PERSONAL,
+        mimetype="text/html",
+        title=entry.get_title(),
+        comment=rtype,
+        dnd_uri=entry.get_content_uri(),
+        author=GLib.Variant('s', ', '.join(authors)),
+        shared=GLib.Variant('b', shared),
+        starred=GLib.Variant('b', starred),
+        updated=GLib.Variant('i', entry.get_updated()))
 
   # This is where we do the actual search for documents
-  def get_doc_list (self, search, s, is_global):
+  def get_doc_list (self, search, filters, is_global):
     query = GData.DocumentsQuery(q=search)
 
     # We do not want filters to effect global results
     if not is_global:
-      self.apply_filters(query, s)
+      self.apply_filters(query, filters)
 
     print("Searching for: " + query.props.q)
 
@@ -258,11 +313,11 @@
       return []
 
     if not is_global:
-      feed = self.filter_results(feed, s)
+      feed = self.filter_results(feed, filters)
     return feed
 
-  def apply_filters (self, query, s):
-    f = s.get_filter("modified")
+  def apply_filters (self, query, filters):
+    f = filters.get_filter_by_id("modified")
     if f != None:
       o = f.get_active_option()
       if o != None:
@@ -277,8 +332,8 @@
           last_time = datetime.now() - timedelta(age)
           query.set_updated_min(time.mktime(last_time.timetuple()))
 
-  def filter_results (self, feed, s):
-    f = s.get_filter("type")
+  def filter_results (self, feed, filters):
+    f = filters.get_filter_by_id("type")
     if not f: return feed
     if not f.props.filtering:
       return feed
@@ -313,9 +368,6 @@
 
     return ret;
 
-if __name__ == '__main__':
-    daemon = UnityExtras.dbus_own_name(BUS_NAME, Daemon, None)
-    if daemon:
-        GLib.unix_signal_add(0, 2, lambda x: daemon.quit(), None)
-        daemon.run([])
 
+def load_scope():
+  return GDriveScope()