Merge lp:~jhodapp/unity-lens-video/remote-videos-scope-trunk into lp:unity-lens-video/remote-videos-scope-trunk

[Jim Hodapp]

Added details to the Amazon video preview

Added details to the Amazon video preview.

[Jim Hodapp (jhodapp)]

One caveat: the SERVER is currently set to the staging URL. This will need to be changed when the JSON API v0 extended is pushed into production.

[Jim Hodapp (jhodapp)]

Change SERVER to videosearch.staging.ubuntu.com to test out the video details for the preview.

[Paweł Stołowski (stolowski)]

Looking good, just minor comments:

46 # Clear results details map
47 - self.details_map = {}

The comment above is not needed anymore.

128 + duration = int(details["duration"]) / 60
129 + # TODO: Extend VideoPreview class and set property for showing video length

Extending MoviePreview shouldn't be needed; looking at the mockups, video length should be displayed next to year as preview subtitle; in fact year property is not really used by Unity, so you should populate subtitle with both year and duration; don't forget about units, e.g. "2012, 88 mins".

[Paweł Stołowski (stolowski)]

review: Needs Fixing

[Paweł Stołowski (stolowski)]

109 + subtitle = release_date.strftime("%Y") + ", " + str(duration) + " mins"

This will crash if release_date or duration are unset (i.e. not in details). Also str(duration) + " mins" should be i18n friendly.

review: Needs Fixing

[lp:~jhodapp/unity-lens-video/remote-videos-scope-trunk]

64. By Jim Hodapp on 2012-08-29

More flexible duration internationalization. Also allow year or duration to be shown independently of each other being present.

65. By Jim Hodapp on 2012-08-29

Hide the rating widget by default since the JSON API doesn't yet support rating data in details.

66. By Jim Hodapp on 2012-08-30

Make the fetch of details data more robust. Signify when the remote server could not be connected to.

[Paweł Stołowski (stolowski)]

78 uri = rawuri.split('lens-meta://')[0]
...
83 - if self.details_map.has_key (uri):
84 - desc = self.details_map[uri][0]
...
87 + uri = details['browser_url']

Seems we don't need uri anymore?

review: Needs Fixing

[lp:~jhodapp/unity-lens-video/remote-videos-scope-trunk]

67. By Jim Hodapp on 2012-08-30

No longer need the variable 'uri' in on_preview_uri().

[Paweł Stołowski (stolowski)]

Looks good and works after adding geo_store=US to urls when run from Europe. Approving.

review: Approve

=== modified file 'src/unity-scope-video-remote'
--- src/unity-scope-video-remote	2012-08-14 12:50:14 +0000
+++ src/unity-scope-video-remote	2012-08-30 13:20:35 +0000
@@ -22,6 +22,7 @@
 import sys
 from urllib import urlencode
 import time
+from datetime import datetime
 import gettext
 
 #pylint: disable=E0611
@@ -49,6 +50,7 @@
 gettext.bindtextdomain(APP_NAME, LOCAL_PATH)
 gettext.textdomain(APP_NAME)
 _ = gettext.gettext
+n_ = gettext.ngettext
 
 BUS_NAME = "net.launchpad.scope.RemoteVideos"
 SERVER = "http://videosearch.ubuntu.com/v0"
@@ -89,14 +91,14 @@
         self.query_list_of_sources()
         self.update_recommendations()
         self.scope.export()
-        self.details_map = {}  #holds details not passed via lens-meta://, needed by preview
 
     def update_recommendations(self):
         """Query the server for 'recommendations'.
 
-        In v0, that means simply do an empty search.
+        In v0 extended, that means simply do an empty search with Amazon
+        as the source since it's the only paid provider at the moment.
         """
-        msg = Soup.Message.new("GET", SERVER + "/search")
+        msg = Soup.Message.new("GET", SERVER + "/search?q=&sources=Amazon")
         self.session.queue_message(msg, self._recs_cb, None)
 
     def _recs_cb(self, session, msg, user_data):
@@ -175,11 +177,10 @@
         the server, update the model and notify the lens when we are done."""
         search_string = search.props.search_string.strip()
         # note search_string is a utf-8 encoded string, now:
-        print "Search changed to %r" % search_string
+        print "Remote scope search changed to %r" % search_string
         model = search.props.results_model
         model.clear()
         # Clear results details map
-        self.details_map = {}
         # Create a list of activated sources
         sources = [source for source in self.sources_list
                    if self.source_activated(source)]
@@ -207,13 +208,17 @@
                 title = i['title'].encode('utf-8')
                 icon = i['img'].encode('utf-8')
                 comment = i['source'].encode('utf-8')
-                self.details_map[uri] = (comment) #TODO: more to come
+                details_url = ""
+                if "details" in i:
+                    details_url = i['details'].encode('utf-8')
+
                 if uri.startswith('http'):
                     # Instead of an uri, we pass a string of uri + metadata
-                    model.append(uri+'lens-meta://'+title+'lens-meta://'+icon,
+                    model.append(uri+'lens-meta://'+title+'lens-meta://'+icon+'lens-meta://'+details_url,
                     icon, 2, "text/html", str(title), str(comment), str(uri))
             except (KeyError, TypeError, AttributeError):
                 print "Malformed result, skipping."
+
         model.flush_revision_queue()
         if search:
             search.finished()
@@ -279,27 +284,106 @@
 
     def on_preview_uri (self, scope, rawuri):
         """Preview request handler"""
-        uri = rawuri.split('lens-meta://')[0]
+        details_url = rawuri.split('lens-meta://')[3]
+        details = self.get_details(details_url)
+
         title = rawuri.split('lens-meta://')[1]
         thumbnail_uri = rawuri.split('lens-meta://')[2]
         subtitle = ''
         desc = ''
-        if self.details_map.has_key (uri):
-            desc = self.details_map[uri][0]
+        source = ''
+        if isinstance(details, dict):
+            title = details['title']
+            thumbnail_uri = details['image']
+            desc = details['description']
+            source = details['source']
+
         try:
             thumbnail_file = Gio.File.new_for_uri (thumbnail_uri)
             thumbnail_icon = Gio.FileIcon.new(thumbnail_file)
         except:
             thumbnail_icon = None
+        
+        release_date = None
+        duration = 0
+            
+        if "release_date" in details:
+            try:
+                # v1 spec states release_date will be YYYY-MM-DD
+                release_date = datetime.strptime(details["release_date"], "%Y-%m-%d")
+            except ValueError:
+                print "Failed to parse release_date since it was not in format: YYYY-MM-DD"
+
+        if "duration" in details:
+            # Given in seconds, convert to minutes
+            duration = int(details["duration"]) / 60
+        
+        if release_date != None:
+            subtitle = release_date.strftime("%Y")
+        if duration > 0:
+            d = n_("%d min", "%d mins", duration) % duration
+            if len(subtitle) > 0:
+                subtitle += ", " + d
+            else:
+                subtitle = d
+            
         preview = Unity.MoviePreview.new(title, subtitle, desc, thumbnail_icon)
         play_video = Unity.PreviewAction.new("play", _("Play"), None)
         play_video.connect('activated', self.play_video)
         preview.add_action(play_video)
-        #TODO: insert proper uploader and upload date when available in videosearch metadata
-        preview.add_info(Unity.InfoHint.new("uploaded-by", _("Uploaded by"), None, ""));
-        preview.add_info(Unity.InfoHint.new("uploaded-on", _("Uploaded on"), None, ""));
+        # For now, rating == -1 and num_ratings == 0 hides the rating widget from the preview
+        preview.set_rating(-1, 0)
+
+        # TODO: For details of future source types, factor out common detail key/value pairs
+        if source == "Amazon":
+            if "directors" in details:
+                directors = details["directors"]
+                preview.add_info(Unity.InfoHint.new("directors",
+                    n_("Director", "Directors", len(directors)), None, ', '.join(directors)))
+            if "starring" in details:
+                cast = details["starring"]
+                if cast:
+                    preview.add_info(Unity.InfoHint.new("cast",
+                        n_("Cast", "Cast", len(cast)), None, ', '.join(cast)))
+            if "genres" in details:
+                genres = details["genres"] 
+                if genres:
+                    preview.add_info(Unity.InfoHint.new("genres",
+                        n_("Genre", "Genres", len(genres)), None, ', '.join(genres)))
+        # TODO: Add Vimeo & YouTube details for v1 of JSON API
+        else:
+            if "uploaded_by" in details:
+                preview.add_info(Unity.InfoHint.new("uploaded-by", _("Uploaded by"),
+                    None, details["uploaded_by"]))
+            if "date_uploaded" in details:
+                preview.add_info(Unity.InfoHint.new("uploaded-on", _("Uploaded on"),
+                    None, details["date_uploaded"]))
+
         return preview
 
+    def get_details(self, details_url):
+        """Get online video details for preview"""
+        details = []
+        if len(details_url) == 0:
+            print "Cannot get preview details, no details_url specified."
+            return details
+
+        if self._pending is not None:
+            self.session.cancel_message(self._pending,
+                                        Soup.KnownStatusCode.CANCELLED)
+
+        self._pending = Soup.Message.new("GET", details_url)
+        # Send a synchronous GET request for video metadata details
+        self.session.send_message(self._pending)
+        try:
+            details = json.loads(self._pending.response_body.data)
+        except ValueError:
+            print "Error: got garbage json from the server"
+        except TypeError:
+            print "Error: failed to connect to videosearch server to retrieve details."
+
+        return details
+
     def play_video (self, action, uri):
         """Preview request - Play action handler"""
         return self.on_activate_uri (action, uri)