Merge lp:~submarine/unity-scope-isgd/isgd-previews into lp:unity-scope-isgd

[Mark Tully]

Add Previews and Activation
Change from Utilities master scope to Info master scope

Add Previews and Activation
Change from Utilities master scope to Info master scope

[David Callé (davidc3)]

+1

review: Approve

[James Henstridge (jamesh)]

+ description = '<big><b>' + self.result.title + "</b></big>\n\n"
+ description += _('is.gd is a free service for shortening web addresses and ')
+ description += _('other URLs. This is useful in many circumstances e.g. when ')
+ description += _('sending an address to a phone via SMS and character count is limited.\n\n')
+ description += _('Click the <i>Shorten url</i> button below to shorten <b>%s</b> ' % self.result.uri.replace('&', '&amp;'))
+ description += _('and copy the shortened link to the clipboard, ready for pasting or the ')
+ description += _('<i>is.gd Preferences</i> button to visit is.gd\'s preferences ')
+ description += _('page.')

This is going to be a pain to translate, since the translator has 7 separate strings to translate. Can you do something like:

description = _(
    '<big><b>%(title)s</b></big>\n\n'
    '...'
    'Click the <i>Shorten url</i> button below to shorten <b>%(uri)s</b>'
    '...') % dict(title=escape(self.result.title), uri=escape(self.result.uri))

It would be necessary to check that the string gets extracted correctly in the .pot file.

Unmerged revisions

12. By Mark Tully on 2013-04-18

Fix Previews and Activation
Change from Utilities master scope to Info master scope

=== added file '.bzrignore'
--- .bzrignore	1970-01-01 00:00:00 +0000
+++ .bzrignore	2013-04-20 13:47:26 +0000
@@ -0,0 +1,5 @@
+*.log
+*.substvars
+./build
+./debian/files
+./debian/unity-scope-isgd

=== modified file 'data/isgd.scope.in'
--- data/isgd.scope.in	2013-03-15 17:29:22 +0000
+++ data/isgd.scope.in	2013-04-20 13:47:26 +0000
@@ -1,13 +1,13 @@
 [Scope]
-DBusName=com.canonical.Unity.Scope.Utilities.Isgd
-DBusPath=/com/canonical/unity/scope/utilities/isgd
+DBusName=com.canonical.Unity.Scope.Info.Isgd
+DBusPath=/com/canonical/unity/scope/info/isgd
 Icon=
 _Keywords=isgd;
 RequiredMetadata=
 OptionalMetadata=
 Loader=/usr/share/unity-scopes/isgd/unity_isgd_daemon.py
 RemoteContent=true
-Type=utilities
+Type=info
 _Name=Isgd
 _Description=Find Isgd items
 _SearchHint=Search Isgd

=== modified file 'data/unity-scope-isgd.service'
--- data/unity-scope-isgd.service	2013-03-14 12:28:39 +0000
+++ data/unity-scope-isgd.service	2013-04-20 13:47:26 +0000
@@ -1,3 +1,3 @@
 [D-BUS Service]
-Name=com.canonical.Unity.Scope.Utilities.Isgd
+Name=com.canonical.Unity.Scope.Info.Isgd
 Exec=/usr/bin/python3 /usr/share/unity-scopes/scope-runner-dbus.py /usr/share/unity-scopes/isgd/unity_isgd_daemon.py

=== modified file 'debian/control'
--- debian/control	2013-03-14 15:15:18 +0000
+++ debian/control	2013-04-20 13:47:26 +0000
@@ -19,7 +19,7 @@
          ${python3:Depends},
          python3,
          gir1.2-unity-5.0 (>= 6.8),
-         gir1.2-dee-1.0,
+         gir1.2-dee-1.0,
          unity-scopes-runner,
          gir1.2-glib-2.0
 Description: isgd scope for Unity

=== modified file 'debian/rules' (properties changed: -x to +x)
=== modified file 'po/unity-scope-isgd.pot'
--- po/unity-scope-isgd.pot	2013-02-21 00:56:47 +0000
+++ po/unity-scope-isgd.pot	2013-04-20 13:47:26 +0000
@@ -9,7 +9,7 @@
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2013-02-21 01:56+0100\n"
+"POT-Creation-Date: 2013-04-18 01:13+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -30,55 +30,63 @@
 msgid "Shorten URL"
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:79
+#: ../src/unity_isgd_daemon.py:80
 #, python-format
 msgid "Shorten %s with is.gd"
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:101
+#: ../src/unity_isgd_daemon.py:105
 msgid "Copied shortened url to clipboard"
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:101
+#: ../src/unity_isgd_daemon.py:105
 #, python-format
 msgid "%s → %s"
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:125
+#: ../src/unity_isgd_daemon.py:117
 msgid "is.gd url shortener"
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:127
+#: ../src/unity_isgd_daemon.py:120
 msgid "is.gd is a free service for shortening web addresses and "
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:128
+#: ../src/unity_isgd_daemon.py:121
 msgid "other URLs. This is useful in many circumstances e.g. when "
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:129
+#: ../src/unity_isgd_daemon.py:122
 msgid ""
 "sending an address to a phone via SMS and character count is limited.\n"
 "\n"
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:130
+#: ../src/unity_isgd_daemon.py:123
 #, python-format
 msgid "Click the <i>Shorten url</i> button below to shorten <b>%s</b> "
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:131
+#: ../src/unity_isgd_daemon.py:124
 msgid "and copy the shortened link to the clipboard, ready for pasting or the "
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:132
+#: ../src/unity_isgd_daemon.py:125
 msgid "<i>is.gd Preferences</i> button to visit is.gd's preferences "
 msgstr ""
 
-#: ../src/unity_isgd_daemon.py:133
+#: ../src/unity_isgd_daemon.py:126
 msgid "page."
 msgstr ""
 
+#: ../src/unity_isgd_daemon.py:128
+msgid "Shorten"
+msgstr ""
+
+#: ../src/unity_isgd_daemon.py:130
+msgid "Preferences"
+msgstr ""
+
 #: ../data/isgd.scope.in.h:1
 msgid "isgd;"
 msgstr ""

=== modified file 'setup.py'
--- setup.py	2013-03-14 12:28:39 +0000
+++ setup.py	2013-04-20 13:47:26 +0000
@@ -16,7 +16,7 @@
       url='http://launchpad.net/ubuntu-scopes',
       license='GNU General Public License (GPL)',
       data_files=[('share/dbus-1/services', ['data/unity-scope-isgd.service']),
-                  ('share/icons/unity-icon-theme/places/svg', ['data/icons/service-isgd.svg']),
+                  #('share/icons/unity-icon-theme/places/svg', ['data/icons/service-isgd.svg']),
                   ('share/unity-scopes/isgd', ['src/unity_isgd_daemon.py']),
                   ('share/unity-scopes/isgd', ['src/__init__.py']), ],
       cmdclass={'build': build_extra.build_extra,

=== modified file 'src/unity_isgd_daemon.py'
--- src/unity_isgd_daemon.py	2013-03-14 12:28:39 +0000
+++ src/unity_isgd_daemon.py	2013-04-20 13:47:26 +0000
@@ -18,6 +18,7 @@
 from gi.repository import Unity
 import gettext
 import urllib.request
+import urllib.parse
 import json
 import subprocess
 import webbrowser
@@ -28,20 +29,20 @@
 gettext.textdomain(APP_NAME)
 _ = gettext.gettext
 
-GROUP_NAME = 'com.canonical.Unity.Scope.Utilities.Isgd'
-UNIQUE_PATH = '/com/canonical/unity/scope/utilities/isgd'
+GROUP_NAME = 'com.canonical.Unity.Scope.Info.Isgd'
+UNIQUE_PATH = '/com/canonical/unity/scope/info/isgd'
 
 SEARCH_HINT = _('Shorten URL with is.gd')
 NO_RESULTS_HINT = _('Sorry, there is no url to shorten')
 PROVIDER_CREDITS = _('')
 SVG_DIR = '/usr/share/icons/unity-icon-theme/places/svg/'
 PROVIDER_ICON = SVG_DIR + 'service-isgd.svg'
-DEFAULT_RESULT_ICON = SVG_DIR + 'result-help.svg'
-DEFAULT_RESULT_MIMETYPE = 'x-scheme-handler/man'
+DEFAULT_RESULT_ICON = SVG_DIR + 'result-isgd.svg'
+DEFAULT_RESULT_MIMETYPE = 'text/html'
 DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
 SEARCH_URI = 'http://is.gd/create.php?format=json&url=%s'
 
-c1 = {'id': 'shorten',
+c1 = {'id': 'results',
       'name': _('Shorten URL'),
       'icon': SVG_DIR + 'group-installed.svg',
       'renderer': Unity.CategoryRenderer.VERTICAL_TILE}
@@ -69,90 +70,63 @@
     try:
         urllib.request.urlopen(search)
         real = True
-    except:
+    except IOError:
         real = False
     if real:
         if not search.startswith("http://is.gd"):
             results.append({'uri': search,
-                            'icon': '',
-                            'category': 0,
-                            'title': _("Shorten %s with is.gd" % search),
-                            'comment': ''})
+                            'title': _("Shorten %s with is.gd" % search)})
     return results
 
 
-def activate(scope, uri):
+def activate(result, metadata, action):
     '''
     On activation, the url is shortened and the shortened version is
     copied to the system clipboard.  A notificatin is also displayed
     letting the user know what has happened.
     '''
-    # FIXME: Activate is not yet implemented
-    search_url = SEARCH_URI % urllib.quote(uri)
-    response = urllib.request.urlopen(search_url).read()
-    try:
-        json_response = json.loads(response)
-    except:
-        result = None
-    clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
-    clipboard.set_text(json_response['shorturl'], -1)
-    clipboard.store()
-
-    subprocess.Popen(["notify-send", _("Copied shortened url to clipboard"), _("%s → %s" % (uri, json_response['shorturl'])), "-i", SERVICE_ICON_LOCATION])
-    return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri='')
-
-
-def visit_prefs(scope, uri):
-    '''
-    Open the webbrowser to is.gd's preferences page
-    '''
-    webbrowser.open('http://is.gd/previews.php')
-    return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri='')
-
-
-def preview(scope, uri):
-    '''
-    Preview request handler
-    '''
-    # FIXME: Preview is not yet implemented
-    model = self.model
-    iteration = model.get_first_iter()
-    end_iter = model.get_last_iter()
-    preview = None
-    while iteration != end_iter:
-        if model.get_value(iteration, 0) == uri:
-            display_uri = uri.replace('&', '&amp;')
-            title = _("is.gd url shortener")
-            description = '<big><b>' + model.get_value(iteration, 5) + "</b></big>\n\n"
-            description += _('is.gd is a free service for shortening web addresses and ')
-            description += _('other URLs. This is useful in many circumstances e.g. when ')
-            description += _('sending an address to a phone via SMS and character count is limited.\n\n')
-            description += _('Click the <i>Shorten url</i> button below to shorten <b>%s</b> ' % display_uri)
-            description += _('and copy the shortened link to the clipboard, ready for pasting or the ')
-            description += _('<i>is.gd Preferences</i> button to visit is.gd\'s preferences ')
-            description += _('page.')
-
-            icon_hint = SVG_DIR + 'isgd.png'
-            # Assemble the preview
-            preview = Unity.GenericPreview.new(title, description, None)
-            preview.props.image_source_uri = icon_hint
-            preview.props.subtitle = model.get_value(iteration, 5)
-
-            # Add the "View" action
-            view_action = Unity.PreviewAction.new("activate_uri", "Shorten url", None)
-            view_action.connect("activated", activate)
-            preview.add_action(view_action)
-
-            # Add the "View" action
-            view_action = Unity.PreviewAction.new("visit_prefs", "is.gd Preferences", None)
-            view_action.connect("activated", visit_prefs)
-            preview.add_action(view_action)
-            break
-
-        iteration = model.next(iteration)
-    if preview is None:
-        print ("Couldn't find model row for requested preview uri: '%s'", uri)
-    return preview
+    if action == 'preferences':
+        webbrowser.open('http://is.gd/previews.php')
+    else:
+        search_url = SEARCH_URI % urllib.parse.quote(result.uri)
+        response = urllib.request.urlopen(search_url).read()
+        json_response = json.loads(response.decode('utf8'))
+        clipboard = Gtk.Clipboard.get(Gdk.SELECTION_CLIPBOARD)
+        clipboard.set_text(json_response['shorturl'], -1)
+        clipboard.store()
+        subprocess.Popen(["notify-send",
+                          _("Copied shortened url to clipboard"),
+                          _("%s → %s" % (result.uri, json_response['shorturl'])),
+                          "-i",
+                          DEFAULT_RESULT_ICON])
+    return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri='')
+
+
+class Preview(Unity.ResultPreviewer):
+    '''
+    Creates the preview for the result
+    '''
+    def do_run(self):
+        '''
+        Create a preview and return it
+        '''
+        preview = Unity.GenericPreview.new(_("is.gd url shortener"), '', None)
+        preview.props.image_source_uri = 'file://%s' % self.result.icon_hint
+        description = '<big><b>' + self.result.title + "</b></big>\n\n"
+        description += _('is.gd is a free service for shortening web addresses and ')
+        description += _('other URLs. This is useful in many circumstances e.g. when ')
+        description += _('sending an address to a phone via SMS and character count is limited.\n\n')
+        description += _('Click the <i>Shorten url</i> button below to shorten <b>%s</b> ' % self.result.uri.replace('&', '&amp;'))
+        description += _('and copy the shortened link to the clipboard, ready for pasting or the ')
+        description += _('<i>is.gd Preferences</i> button to visit is.gd\'s preferences ')
+        description += _('page.')
+        preview.props.description_markup = description
+        shorten_action = Unity.PreviewAction.new("shorten", _("Shorten url"), None)
+        preview.add_action(shorten_action)
+        preferences_action = Unity.PreviewAction.new("preferences", _("isgd Preferences"), None)
+        preview.add_action(preferences_action)
+        return preview
+
 
 # Classes below this point establish communication
 # with Unity, you probably shouldn't modify them.
@@ -187,19 +161,8 @@
                     i['comment'] = ''
                 if not 'dnd_uri' in i or not i['dnd_uri'] or i['dnd_uri'] == '':
                     i['dnd_uri'] = i['uri']
-                i['metadata'] = {}
-                if EXTRA_METADATA:
-                    for e in i:
-                        for m in EXTRA_METADATA:
-                            if m['id'] == e:
-                                i['metadata'][e] = i[e]
-                i['metadata']['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
-                result = Unity.ScopeResult.create(str(i['uri']), str(i['icon']),
-                                                  i['category'], i['result_type'],
-                                                  str(i['mimetype']), str(i['title']),
-                                                  str(i['comment']), str(i['dnd_uri']),
-                                                  i['metadata'])
-                result_set.add_result(result)
+                i['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
+                result_set.add_result(**i)
         except Exception as error:
             print(error)
 
@@ -255,6 +218,21 @@
         se = MySearch(search_context)
         return se
 
+    def do_activate(self, result, metadata, action):
+        '''
+        What to do when a resut is clicked
+        '''
+        return activate(result, metadata, action)
+
+    def do_create_previewer(self, result, metadata):
+        '''
+        Creates a preview when a resut is right-clicked
+        '''
+        result_preview = Preview()
+        result_preview.set_scope_result(result)
+        result_preview.set_search_metadata(metadata)
+        return result_preview
+
 
 def load_scope():
     return Scope()