Merge lp:~chipaca/unity-lens-video/remote-videos-misc-fixes into lp:unity-lens-video

[John Lenton]

Some generic cleanups / improvements to the pythonicity, readability and robustness of the code.

[David Callé (davidc3)]

review: Approve

Unmerged revisions

13. By John Lenton on 2012-02-08

some generic cleanups / improvements to the pythonicity, readability and robustness of the code

12. By David Callé on 2012-02-07

Merge pep8 and lint fixes from Roberto Alsina

11. By David Callé on 2012-02-07

A bit of cleaning

10. By David Callé on 2012-02-07

Move the first server query inside the loop and check for a list of sources after each error. Don't assume we have a network connexion at startup.

9. By David Callé on 2012-02-06

Don't fail on network error

8. By David Callé on 2012-02-06

* Use the shiny new v0 API
* Get a real list of sources to create the filter options

7. By David Callé on 2012-02-05

Generate source internal id

6. By David Callé on 2012-02-03

Simplify sources management

5. By David Callé on 2012-02-02

Add sources, search both to test the sources filters, don't thread for now

4. By David Callé on 2012-02-01

Avoid global search

=== added file 'MANIFEST.in'
--- MANIFEST.in	1970-01-01 00:00:00 +0000
+++ MANIFEST.in	2012-02-08 16:12:18 +0000
@@ -0,0 +1,3 @@
+include unity-scope-video-remote.service
+include video-remote.scope
+include src/unity-scope-video-remote

=== renamed file 'MANIFEST.in' => 'MANIFEST.in.moved'
=== added directory 'debian'
=== renamed directory 'debian' => 'debian.moved'
=== added file 'debian/changelog'
--- debian/changelog	1970-01-01 00:00:00 +0000
+++ debian/changelog	2012-02-08 16:12:18 +0000
@@ -0,0 +1,6 @@
+unity-scope-video-remote (0.1) precise; urgency=low
+
+  [ David Callé ]
+  * First release of the remote video scope
+
+ -- David Callé <[e-mail]>  Tue, 31 Jan 2012 15:55:00 +0200

=== added file 'debian/compat'
--- debian/compat	1970-01-01 00:00:00 +0000
+++ debian/compat	2012-02-08 16:12:18 +0000
@@ -0,0 +1,1 @@
+7

=== added file 'debian/control'
--- debian/control	1970-01-01 00:00:00 +0000
+++ debian/control	2012-02-08 16:12:18 +0000
@@ -0,0 +1,20 @@
+Source: unity-scope-video-remote
+Section: gnome
+Priority: optional
+Maintainer: David Calle <[e-mail]>
+Build-Depends: debhelper (>= 7.0.50~), python, python-distutils-extra
+Standards-Version: 3.9.1
+Homepage: https://launchpad.net/~davidc3
+
+Package: unity-scope-video-remote
+Architecture: all
+Depends: ${shlibs:Depends},
+         ${misc:Depends},
+         ${python:Depends},
+         gir1.2-unity-5.0,
+         gir1.2-dee-1.0,
+         unity-lens-video
+Enhances: unity-lens-video
+Description: Remote videos engine
+ This scope adds a remote videos search engine to the Video lens.
+

=== added file 'debian/copyright'
--- debian/copyright	1970-01-01 00:00:00 +0000
+++ debian/copyright	2012-02-08 16:12:18 +0000
@@ -0,0 +1,29 @@
+This package was debianized by David Calle <[e-mail]> on
+Tue, 31 Jan 2012 16:00:00 +0200.
+
+It was downloaded from <https://code.launchpad.net/~davidc3>
+
+Upstream Author:
+
+    David Calle <[e-mail]>
+
+Copyright:
+
+ Copyright (c) 2012 David Calle <[e-mail]>
+
+License:
+
+      This program is free software: you can redistribute it and/or modify
+      it under the terms of the GNU General Public License version 3 as 
+      published by the Free Software Foundation.
+ 
+      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 General Public License for more details.
+ 
+On Debian systems, the complete text of the GNU General Public License
+can be found in `/usr/share/common-licenses/GPL-3'
+
+The Debian packaging is licensed under the GPL version 3,
+see `/usr/share/common-licenses/GPL-3'.

=== added file 'debian/rules'
--- debian/rules	1970-01-01 00:00:00 +0000
+++ debian/rules	2012-02-08 16:12:18 +0000
@@ -0,0 +1,6 @@
+#!/usr/bin/make -f
+# -*- makefile -*-
+
+
+%:
+	dh $@ --with python2

=== added directory 'debian/source'
=== added file 'debian/source/format'
--- debian/source/format	1970-01-01 00:00:00 +0000
+++ debian/source/format	2012-02-08 16:12:18 +0000
@@ -0,0 +1,1 @@
+3.0 (native)

=== added file 'setup.py'
--- setup.py	1970-01-01 00:00:00 +0000
+++ setup.py	2012-02-08 16:12:18 +0000
@@ -0,0 +1,16 @@
+#!/usr/bin/env python
+#
+from distutils.core import setup
+from DistUtilsExtra.command import *
+
+setup(name="unity-scope-video-remote",
+      version="0.1",
+      author="David Calle",
+      author_email="[e-mail]",
+      url="http://launchpad.net/onehundredscopes",
+      license="GNU General Public License (GPL)",
+      data_files=[
+    ('lib/unity-scope-video-remote', ['src/unity-scope-video-remote']),
+    ('share/dbus-1/services', ['unity-scope-video-remote.service']),
+    ('share/unity/lenses/video', ['video-remote.scope']),
+    ], cmdclass={"build":  build_extra.build_extra, })

=== renamed file 'setup.py' => 'setup.py.moved'
=== added directory 'src'
=== renamed directory 'src' => 'src.moved'
=== added file 'src/unity-scope-video-remote'
--- src/unity-scope-video-remote	1970-01-01 00:00:00 +0000
+++ src/unity-scope-video-remote	2012-02-08 16:12:18 +0000
@@ -0,0 +1,172 @@
+#! /usr/bin/python
+# -*- coding: utf-8 -*-
+
+#    Copyright (c) 2011 David Calle <[e-mail]>
+
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 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 General Public License for more details.
+
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""FIXME: add docstring."""
+
+import json
+import sys
+import urllib
+import urllib2
+
+
+#pylint: disable=E0611
+from gi.repository import (
+    GLib,
+    GObject,
+    Gio,
+    Unity,
+)
+#pylint: enable=E0611
+
+BUS_NAME = "net.launchpad.scope.video.remote"
+SERVER = "http://video.u1.to/v0"
+
+
+class Daemon:
+
+    """FIXME Add docstring."""
+
+    def __init__(self):
+        self.sources_list = None
+        self.scope = Unity.Scope.new("/net/launchpad/scope/video/remote")
+        self.scope.search_in_global = False
+        self.scope.connect("search-changed", self.on_search_changed)
+        self.scope.connect("filters-changed",
+            lambda scope:
+                self.scope.queue_search_changed(Unity.SearchType.DEFAULT))
+        self.scope.props.sources.connect("notify::filtering",
+            self.on_filtering_changed)
+        self.query_list_of_sources()
+        self.scope.export()
+
+    def query_list_of_sources(self):
+        """FIXME Add docstring."""
+        try:
+            self.sources_list = json.load(urllib2.urlopen("%s/sources"
+                                                          % (SERVER,)))
+            print "Got a list of sources from the server."
+        except (IOError,
+                KeyError,
+                urllib2.URLError,
+                urllib2.HTTPError,
+                ValueError):
+            self.sources_list = []
+            print "Error: Unable to query the server for a list of sources"
+        else:
+            for n, source in enumerate(self.sources_list):
+                self.scope.props.sources.add_option(str(n), source, None)
+
+    def on_filtering_changed(self, *_):
+        """FIXME Add docstring."""
+        self.scope.queue_search_changed(Unity.SearchType.DEFAULT)
+
+    # FIXME: if scope is not used, rename it _
+    def source_activated(self, scope, source):
+        """FIXME Add docstring."""
+        # This is currently the only way to get the state of
+        # the filter option with certainty
+        active = self.scope.props.sources.get_option(source).props.active
+        filtering = self.scope.props.sources.props.filtering
+        # equivalent to "return not (active ^ filtering)", but more readable
+        if (active and filtering) or (not active and not filtering):
+            return True
+        else:
+            return False
+
+    # FIXME: if cancellable is not used, rename it _
+    def on_search_changed(self, scope, search, search_type, cancellable):
+        """FIXME Add docstring."""
+        search_string = search.props.search_string.strip()
+        # note search_string is a utf-8 encoded string, now:
+        print "Search changed to %r" % search_string
+        model = search.props.results_model
+        model.clear()
+        # Create a list of activated sources
+        sources = [source for n, source in enumerate(self.sources_list)
+                   if self.source_activated(scope, str(n))]
+        # If all the sources are activated, don't bother
+        # passing them as arguments
+        if len(sources) == len(self.sources_list):
+            sources = ''
+        else:
+            sources = ','.join(sources)
+        # Ensure that we are not in Global search
+        if search_type is Unity.SearchType.DEFAULT:
+            self.update_results_model(search_string, model, sources)
+            model.flush_revision_queue()
+        if search:
+            search.finished()
+
+    def update_results_model(self, search, model, sources):
+        """FIXME Add docstring."""
+        self.pyvore(search, model, sources)
+        if self.sources_list == []:
+            self.query_list_of_sources()
+
+    def pyvore_search(self, search, sources):
+        """FIXME Add docstring."""
+        try:
+            query = dict(q=search)
+            if sources:
+                query['sources'] = sources
+            query = urllib.urlencode(query)
+            url = "%s/search?%s" % (SERVER, query)
+            print "Querying the server:", url
+            return json.load(urllib2.urlopen(url))
+        except (IOError,
+                KeyError,
+                urllib2.URLError,
+                urllib2.HTTPError,
+                ValueError):
+            print "Error: Unable to get results from the server"
+            return []
+
+    def pyvore(self, search, model, sources):
+        """FIXME Add docstring."""
+        for i in self.pyvore_search(search, sources):
+            uri = i['url']
+            title = i['title']
+            icon = i['img']
+            comment = i['source']
+            if uri.startswith('http'):
+                model.append(uri, icon, 1, "text/html", title, comment, uri)
+
+
+def main():
+    """DAVID: insert reasonable docstring here."""
+    session_bus_connection = Gio.bus_get_sync(Gio.BusType.SESSION, None)
+    session_bus = Gio.DBusProxy.new_sync(session_bus_connection, 0, None,
+                                            'org.freedesktop.DBus',
+                                            '/org/freedesktop/DBus',
+                                            'org.freedesktop.DBus', None)
+    result = session_bus.call_sync('RequestName',
+                                    GLib.Variant("(su)", (BUS_NAME, 0x4)),
+                                    0, -1, None)
+
+    # Unpack variant response with signature "(u)". 1 means we got it.
+    result = result.unpack()[0]
+
+    if result != 1:
+        print >> sys.stderr, "Failed to own name %s. Bailing out." % BUS_NAME
+        raise SystemExit(1)
+
+    Daemon()
+    GObject.MainLoop().run()
+
+if __name__ == "__main__":
+    main()

=== added file 'unity-scope-video-remote.service'
--- unity-scope-video-remote.service	1970-01-01 00:00:00 +0000
+++ unity-scope-video-remote.service	2012-02-08 16:12:18 +0000
@@ -0,0 +1,3 @@
+[D-BUS Service]
+Name=net.launchpad.scope.video.remote
+Exec=/usr/lib/unity-scope-video-remote/unity-scope-video-remote

=== added file 'video-remote.scope'
--- video-remote.scope	1970-01-01 00:00:00 +0000
+++ video-remote.scope	2012-02-08 16:12:18 +0000
@@ -0,0 +1,3 @@
+[Scope]
+DBusName=net.launchpad.scope.video.remote
+DBusPath=/net/launchpad/scope/video/remote