Merge lp:~mvo/software-center/video-support into lp:software-center

[Michael Vogt]

This branch adds basic support for displaying application releated videos inside software-center. If there is a X-AppInstall-Video-Url in the desktop file or the software-center-agent the video is displayed in a embedded webkit.

This means that something like:
<iframe width="640" height="390" src="http://www.youtube.com/embed/KBpdLe80gLE" frameborder="0" allowfullscreen></iframe>

on the server is enough to display a video. AFAICT (but please double check) this means we can embed videos from e.g. vimeo as they require only that their embedded player is used. In order to use this in production we will need a video hoster that can host WebM/ogg theora videos though.

[lp:~mvo/software-center/video-support]

2553. By Michael Vogt on 2011-11-10

softwarecenter/ui/gtk3/widgets/videoplayer.py: ensure that clicking on links keeps working in the embedded video player

[Michael Vogt (mvo)]

I should also add that the current placement probably needs tweaking, here is what it currently looks like:
http://people.canonical.com/~mvo/tmp/Screenshot%20at%202011-11-10%2012:14:25.png

Note that without (much?) server support this is probably the best we can do for now, but simple server side
tweaks should help. The ToS needs some careful review, but I think it should be fine for free apps to embed the videos.

[Gary Lasker (gary-lasker)]

Michael, this is *seriously* cool!! It works really well and look just great. Awesome work!

I looked over the Terms of Service for YouTube (http://www.youtube.com/static?gl=US&template=terms) and I agree that from all appearances this implementation conforms to all of the terms; that seems to be true certainly for the free apps. The regular YouTube embedded player is used, and you implemented the links back to the YouTube site itself as required. From what I can tell that satisfies all of the conditions on that page.

It's not as clear to me that Vimeo is also an option, based on their Terms of Service at http://vimeo.com/terms. I don't see anything there that clearly describes the use of their embedded player. I guess we would need to explore this further if an app developer wanted consider using Vimeo.

review: Approve

=== modified file 'softwarecenter/db/application.py'
--- softwarecenter/db/application.py	2011-11-07 08:26:13 +0000
+++ softwarecenter/db/application.py	2011-11-10 11:11:58 +0000
@@ -563,6 +563,17 @@
                                                      'version' : self.version or 0}
 
     @property
+    def video_url(self):
+        # if there is a custom video url provided, use that
+        if self._doc:
+            if self._doc.get_value(XapianValues.VIDEO_URL):
+                return self._doc.get_value(XapianValues.VIDEO_URL)
+        # else use the video server
+        #return self._distro.VIDEO_URL % { 'pkgname' : self.pkgname, 
+        #                                  'version' : self.version or 0}
+        return None
+        
+    @property
     def version(self):
         if self._pkg:
             if self._pkg.installed:

=== modified file 'softwarecenter/db/update.py'
--- softwarecenter/db/update.py	2011-10-26 08:34:48 +0000
+++ softwarecenter/db/update.py	2011-11-10 11:11:58 +0000
@@ -151,6 +151,7 @@
                 'Icon'       : 'icon',
                 'Screenshot-Url' : 'screenshot_url',
                 'Thumbnail-Url' : 'thumbnail_url',
+                'Video-Url' :  'video_url',
                 'Icon-Url'   : 'icon_url',
               }
 
@@ -693,6 +694,10 @@
         if parser.has_option_desktop("X-AppInstall-Thumbnail-Url"):
             url = parser.get_desktop("X-AppInstall-Thumbnail-Url")
             doc.add_value(XapianValues.THUMBNAIL_URL, url)
+        # video support (for third party mostly)
+        if parser.has_option_desktop("X-AppInstall-Video-Url"):
+            url = parser.get_desktop("X-AppInstall-Video-Url")
+            doc.add_value(XapianValues.VIDEO_URL, url)
         # icon (for third party)
         if parser.has_option_desktop("X-AppInstall-Icon-Url"):
             url = parser.get_desktop("X-AppInstall-Icon-Url")

=== modified file 'softwarecenter/enums.py'
--- softwarecenter/enums.py	2011-10-22 04:24:42 +0000
+++ softwarecenter/enums.py	2011-11-10 11:11:58 +0000
@@ -128,6 +128,7 @@
     LICENSE_KEY = 192
     LICENSE_KEY_PATH = 193           # no longer used
     LICENSE = 194
+    VIDEO_URL = 194
 
 # fake channels
 PURCHASED_NEEDS_REINSTALL_MAGIC_CHANNEL_NAME = "for-pay-needs-reinstall"

=== modified file 'softwarecenter/testutils.py'
--- softwarecenter/testutils.py	2011-11-09 10:06:32 +0000
+++ softwarecenter/testutils.py	2011-11-10 11:11:58 +0000
@@ -109,9 +109,29 @@
                        limit=limit,
                        nonblocking_load=False)
     return enquirer.matches
+<<<<<<< TREE
 
 def do_events():
     from gi.repository import GObject
     main_loop = GObject.main_context_default()
     while main_loop.pending():
         main_loop.iteration()
+=======
+
+def get_mock_app_from_real_app(real_app):
+    """ take a application and return a app where the details are a mock
+        of the real details so they can easily be modified
+    """
+    from mock import Mock
+    import copy
+    app = copy.copy(real_app)
+    db = get_test_db()
+    details = app.get_details(db)
+    details_mock = Mock()
+    for a in dir(details):
+        if a.startswith("_"): continue
+        setattr(details_mock, a, getattr(details, a))
+    app._details = details_mock
+    app.get_details = lambda db: app._details
+    return app
+>>>>>>> MERGE-SOURCE

=== modified file 'softwarecenter/ui/gtk3/views/appdetailsview_gtk.py'
--- softwarecenter/ui/gtk3/views/appdetailsview_gtk.py	2011-11-09 10:10:52 +0000
+++ softwarecenter/ui/gtk3/views/appdetailsview_gtk.py	2011-11-10 11:11:58 +0000
@@ -994,6 +994,11 @@
         self.homepage_btn.set_name("subtle-label")
         self.homepage_btn.connect('activate-link', self._on_homepage_clicked)
 
+        # video
+        from softwarecenter.ui.gtk3.widgets.videoplayer import VideoPlayer
+        self.videoplayer = VideoPlayer()
+        vb.pack_start(self.videoplayer, False, False, 0)
+
         # add the links footer to the description widget
         footer_hb = Gtk.HBox(spacing=6)
         footer_hb.pack_start(self.homepage_btn, False, False, 0)
@@ -1145,6 +1150,13 @@
             self.homepage_btn.hide()
         return
 
+    def _update_app_video(self, app_details):
+        if app_details.video_url:
+            self.videoplayer.uri = app_details.video_url
+            self.videoplayer.show()
+        else:
+            self.videoplayer.hide()
+
     def _update_app_screenshot(self, app_details):
         # get screenshot urls and configure the ScreenshotView...
         if app_details.thumbnail and app_details.screenshot:
@@ -1232,6 +1244,7 @@
         self._update_app_description(app_details, app_details.pkgname)
         self._update_description_footer_links(app_details)
         self._update_app_screenshot(app_details)
+        self._update_app_video(app_details)
         self._update_weblive(app_details)
         self._update_pkg_info_table(app_details)
         if not skip_update_addons:

=== modified file 'softwarecenter/ui/gtk3/widgets/videoplayer.py'
--- softwarecenter/ui/gtk3/widgets/videoplayer.py	2011-08-09 08:47:43 +0000
+++ softwarecenter/ui/gtk3/widgets/videoplayer.py	2011-11-10 11:11:58 +0000
@@ -31,15 +31,32 @@
     def __init__(self):
         super(VideoPlayer, self).__init__()
         self.webkit = WebKit.WebView()
+        self.webkit.connect("new-window-policy-decision-requested", self._on_new_window)
         self.pack_start(self.webkit, True, True, 0)
         self._uri = ""
+
+    # helper required to follow ToS about the "back" link
+    def _on_new_window(self, view, frame, request, action, policy):
+        import subprocess
+        subprocess.Popen(['xdg-open', request.get_uri()])
+        return True
+
+    # uri property
     def _set_uri(self, v):
         self._uri = v
         self.webkit.load_uri(v)
     def _get_uri(self):
         return self._uri
     uri = property(_get_uri, _set_uri, None, "uri property")
-    
+
+    def load_html_string(self, html):
+        """ Instead of a video URI use a html embedded video like e.g.
+            youtube or vimeo. Note that on a default install not all
+            video codecs will play (no flash!), so be careful!
+        """
+        # FIXME: add something more useful here
+        base_uri = "http://www.ubuntu.com"
+        self.webkit.load_html_string(html, base_uri)
 
 # AKA the-segfault-edition-with-no-documentation
 class VideoPlayerGtk3(Gtk.VBox):
@@ -108,6 +125,9 @@
 
 
 def get_test_videoplayer_window():
+    html = """
+    <iframe width="640" height="390" src="http://www.youtube.com/embed/h3oBU0NZJuA" frameborder="0" allowfullscreen></iframe>
+"""
     win = Gtk.Window.new(Gtk.WindowType.TOPLEVEL)
     win.set_default_size(500, 400)
     win.connect("destroy", Gtk.main_quit)
@@ -115,6 +135,7 @@
     win.add(player)
     if len(sys.argv) < 2:
         player.uri = "http://upload.wikimedia.org/wikipedia/commons/9/9b/Pentagon_News_Sample.ogg"
+        #player.load_html_string(html)
     else:
         player.uri = sys.argv[1]
     win.show_all()

=== added file 'test/gtk3/test_appdetailsview.py'
--- test/gtk3/test_appdetailsview.py	1970-01-01 00:00:00 +0000
+++ test/gtk3/test_appdetailsview.py	2011-11-10 11:11:58 +0000
@@ -0,0 +1,46 @@
+#!/usr/bin/python
+
+from gi.repository import Gtk, GObject
+import sys
+import unittest
+
+sys.path.insert(0,"../..")
+sys.path.insert(0,"..")
+
+#from mock import Mock
+
+import softwarecenter.paths
+softwarecenter.paths.datadir = "../data"
+
+from softwarecenter.db.application import Application
+from softwarecenter.testutils import get_test_db, get_mock_app_from_real_app
+from softwarecenter.ui.gtk3.views.appdetailsview_gtk import get_test_window_appdetails
+class TestAppdetailsViews(unittest.TestCase):
+
+    def test_videoplayer(self):
+        # get the widget
+        win = get_test_window_appdetails()
+        view = win.get_data("view")
+
+        # show app with no video
+        app = Application("", "2vcard")
+        view.show_app(app)
+        while Gtk.events_pending():
+            Gtk.main_iteration()
+        self.assertFalse(view.videoplayer.get_property("visible"))
+
+        # create app with video and ensure its visible
+        app = Application("", "synaptic")
+        mock = get_mock_app_from_real_app(app)
+        details = mock.get_details(None)
+        # this is a example html - any html5 video will do
+        details.video_url = "http://people.canonical.com/~mvo/totem.html"
+        view.show_app(mock)
+        while Gtk.events_pending():
+            Gtk.main_iteration()
+        self.assertTrue(view.videoplayer.get_property("visible"))
+
+if __name__ == "__main__":
+    import logging
+    logging.basicConfig(level=logging.DEBUG)
+    unittest.main()

=== modified file 'test/test_plugin.py'
--- test/test_plugin.py	2011-05-18 08:26:04 +0000
+++ test/test_plugin.py	2011-11-10 11:11:58 +0000
@@ -11,7 +11,7 @@
 class MockApp(object):
     """ mock app """
 
-class testPlugin(unittest.TestCase):
+class TestPlugin(unittest.TestCase):
 
     def setUp(self):
         pass