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

[Mark Tully]

Add Previews and Activation

Add Previews and Activation

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:20
http://jenkins.qa.ubuntu.com/job/unity-scope-gmusicbrowser-ci/1/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-gmusicbrowser-raring-amd64-ci/1/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-scope-gmusicbrowser-ci/1/rebuild

review: Needs Fixing (continuous-integration)

[David Callé (davidc3)]

Works well. +1

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-scope-gmusicbrowser-autolanding/1/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-gmusicbrowser-raring-amd64-autolanding/1/console

review: Needs Fixing (continuous-integration)

[lp:~submarine/unity-scope-gmusicbrowser/gmusicbrowser-previews]

21. By Mark Tully on 2013-04-22

Fixed tests

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:21
http://jenkins.qa.ubuntu.com/job/unity-scope-gmusicbrowser-ci/2/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-gmusicbrowser-raring-amd64-ci/2

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-scope-gmusicbrowser-ci/2/rebuild

review: Approve (continuous-integration)

=== modified file 'data/gmusicbrowser.scope.in'
--- data/gmusicbrowser.scope.in	2013-03-20 16:43:38 +0000
+++ data/gmusicbrowser.scope.in	2013-04-22 13:23:30 +0000
@@ -5,7 +5,9 @@
 QueryBinary=gmusicbrowser
 _Keywords=gmusicbrowser;
 RequiredMetadata=
-OptionalMetadata=
+OptionalMetadata=album[s];artist[s];genre[s];year[i];track_length[i];track_number[i]
+Loader=/usr/share/unity-scopes/gmusicbrowser/unity_gmusicbrowser_daemon.py
+RemoteContent=false
 Type=music
 _Name=Gmusicbrowser
 _Description=Find Gmusicbrowser items

=== modified file 'src/unity_gmusicbrowser_daemon.py'
--- src/unity_gmusicbrowser_daemon.py	2013-03-19 15:40:16 +0000
+++ src/unity_gmusicbrowser_daemon.py	2013-04-22 13:23:30 +0000
@@ -64,12 +64,13 @@
 m4 = {'id'   :'year',
       'type' :'i',
       'field':Unity.SchemaFieldType.OPTIONAL}
-EXTRA_METADATA = [m1, m2, m3, m4]
-
-REFRESH_TIMEOUT = 300
-PREVIEW_PLAYER_DBUS_NAME = "com.canonical.Unity.Lens.Music.PreviewPlayer"
-PREVIEW_PLAYER_DBUS_PATH = "/com/canonical/Unity/Lens/Music/PreviewPlayer"
-PREVIEW_PLAYER_DBUS_IFACE = PREVIEW_PLAYER_DBUS_NAME
+m5 = {'id': 'track_length',
+      'type': 'i',
+      'field': Unity.SchemaFieldType.OPTIONAL}
+m6 = {'id': 'track_number',
+      'type': 'i',
+      'field': Unity.SchemaFieldType.OPTIONAL}
+EXTRA_METADATA = [m1, m2, m3, m4, m5, m6]
 
 tracks = []
 albumart = []
@@ -77,6 +78,8 @@
 
 def get_music_from_gmusicbrowser():
     """Parses GMusicBrowser's collection into a form we can use"""
+    global tracks
+    global albumart
     tracks = []
     albumart = []
     songlist = []
@@ -95,7 +98,6 @@
                 albumstart = index
             if item == '[artist]\n':
                 artiststart = index
-        print(songstart)
     except:
         return tracks
 
@@ -122,7 +124,7 @@
         if track[7] == "":
             track[7] = "0"
         track[8] = 0 if fields[32] is None else fields[32]
-        track[9] = fields[32]
+        track[9] = int(fields[32])
         track[10] = fields[17]
         tracks.append(track)
     albumartlist = database[albumstart + 2:artiststart - 1]
@@ -135,7 +137,8 @@
         albumarta[2] = fields[1]
         albumart.append(albumarta)
     print("Updated tracks from GMusicBrowser database")
-
+    
+    tracks.sort(key=lambda track: track[9])
     return albumart, tracks
 
 
@@ -149,6 +152,8 @@
     '''
     Search for help documents matching the search string
     '''
+    global tracks
+    global albumart
     results = []
     albums, tracks = get_music_from_gmusicbrowser()
     trackresults = []
@@ -162,166 +167,75 @@
         albumartist = "" if track[5] is None else track[5]
         year = 0 if track[7] is None else int(track[7])
         genre = "" if track[6] is None else track[6]
+        track_length = 0 if track[10] is None else int(track[10])
+        track_number = 0 if track[9] is None else int(track[9])
         trackname = title + " - " + album + " - " + artist
         if search.lower() in trackname.lower():
-            albumart = get_album_art(track, albums)
+            albumart = 'file://' + get_album_art(track, albums).replace('\n', '')
             albumuri = "album://" + albumartist + "/" + album
             if track not in trackresults:
                 results.append({'uri': uri,
                                 'icon': albumart,
                                 'category': 0,
-                                'mimetype': mimetype,
                                 'title': title,
-                                'comment': artist,
                                 'album':GLib.Variant('s', album),
                                 'artist':GLib.Variant('s', artist),
                                 'genre':GLib.Variant('s', genre),
-                                'year':GLib.Variant('i', year)})
+                                'year':GLib.Variant('i', year),
+                                'track_length': GLib.Variant('i', track_length),
+                                'track_number': GLib.Variant('i', track_number)})
                 trackresults.append(track)
 
             if album not in albumresults:
                 results.append({'uri': albumuri,
                                 'icon': albumart,
                                 'category': 1,
-                                'mimetype': mimetype,
                                 'title': album,
-                                'comment': artist,
                                 'album':GLib.Variant('s', album),
                                 'artist':GLib.Variant('s', artist),
                                 'genre':GLib.Variant('s', genre),
-                                'year':GLib.Variant('i', year)})
+                                'year':GLib.Variant('i', year),
+                                'track_length': GLib.Variant('i', track_length),
+                                'track_number': GLib.Variant('i', track_number)})
                 albumresults.append(album)
     return results
 
 
-def activate(scope, uri):
-    import subprocess
-    albumtracks = []
-    albumtracks.append("gmusicbrowser")
-    albumtracks.append("-play")
-    albumtracks.append("-playlist")
-    # If uri starts with album:// then we need to play all the songs on it
-    if uri.startswith("album://"):
-        trackdetails = []
-        for track in tracks:
-            trackdetail = []
-            album = "album://" + track[5] + "/" + track[3]
-            if not album.find(uri) == -1:
-                albumtrack = track[1]
-                trackdetail.append(albumtrack)
-                trackdetail.append(track[8])
-                trackdetails.append(trackdetail)
-        trackdetails.sort(key=lambda track: int(track[1]))
-        for track in trackdetails:
-            albumtracks.append(track[0])
-        subprocess.Popen(albumtracks)
-    else:
-        albumtracks.append("file://" + uri)
-        subprocess.Popen(albumtracks)
-    return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri='')
-
-
-def show_in_folder(scope, uri):
-    """ Shows the folder containing the selected track as requested from the Preview
-    """
-    if uri.startswith("album://"):
-        for track in tracks:
-            album = "album://" + track[2] + "/" + track[3]
-            if not album.find(uri) == -1:
-                filename = track[1]
-                continue
-    else:
-        filename = uri
-    dirname = os.path.dirname(filename)
-    dirname = dirname.replace("%20", "\ ")
-    os.system("xdg-open '%s'" % str(dirname))
-    return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri='')
-
-
-def preview_uri(scope, uri):
-    """Preview request handler"""
-    albumtracks = []
-    isalbum = False
-    if uri.startswith("album://"):
-        isalbum = True
-        for track in tracks:
-            album = "album://" + track[2] + "/" + track[3]
-            if not album.find(uri) == -1:
-                albumtracks.append(track)
-        albumtracks.sort(key=lambda track: int(track[7]))
-    else:
-        for track in tracks:
-            album = "file://" + track[1]
-            if not album.find(uri) == -1:
-                albumtracks.append(track)
-    iteration = model.get_first_iter()
-    end_iter = model.get_last_iter()
-    while iteration != end_iter:
-        if model.get_value(iteration, 0) == uri:
-            title = model.get_value(iteration, 5)
-            description = model.get_value(iteration, 6)
-            if model.get_value(iteration, 1) == "musique":
-                image = "file:///usr/share/icons/hicolor/scalable/apps/audacious.svg"
-            else:
-                image = "file://%s" % model.get_value(iteration, 1)
-
-            preview = Unity.MusicPreview.new(title, description, None)
-            preview.props.image_source_uri = image
-            for albumtrack in albumtracks:
-                if isalbum:
-                    track = Unity.TrackMetadata.full("file://" + urllib.parse.unquote(str(albumtrack[1])),  # uri
-                                                     int(albumtrack[7]),                              # track number
-                                                     albumtrack[0],                                   # track title
-                                                     albumtrack[2],                                   # artist
-                                                     albumtrack[3],                                   # album
-                                                     int(albumtrack[8]) / 1000)                       # track length
-                else:
-                    preview = Unity.MusicPreview.new(albumtrack[0], "", None)
-                    preview.props.image_source_uri = image
-                    track = Unity.TrackMetadata.full("file://" + urllib.parse.unquote(str(albumtrack[1])),
-                                                     int(albumtrack[7]),
-                                                     albumtrack[0],
-                                                     albumtrack[2],
-                                                     albumtrack[3],
-                                                     int(albumtrack[8]) / 1000)
-                preview.add_track(track)
-
-            # Add the "Play" action
-            play_action = Unity.PreviewAction.new("activate_uri", "Play", None)
-            play_action.connect("activated", activate)
-            preview.add_action(play_action)
-
-            # Add the "Show in folder" action
-            show_action = Unity.PreviewAction.new("show_in_folder", "Show In Folder", None)
-            show_action.connect("activated", show_in_folder)
-            preview.add_action(show_action)
-
-            preview.connect("play", play)
-            preview.connect("pause", pause)
-            preview.connect("closed", closed)
-            break
-        iteration = model.next(iteration)
-    if preview is None:
-        print("Couldn't find model row for requested preview uri: '%s'", uri)
-    return preview
-
-
-def play(preview, uri):
-    """Plays the selected track as selected in the Preview"""
-    player = self.bus.get_object(PREVIEW_PLAYER_DBUS_NAME, PREVIEW_PLAYER_DBUS_PATH)
-    dbus.Interface(player, PREVIEW_PLAYER_DBUS_IFACE).Play(uri)
-
-
-def pause(preview, uri):
-    """Pauses the selected track as selected in the Preview"""
-    player = self.bus.get_object(PREVIEW_PLAYER_DBUS_NAME, PREVIEW_PLAYER_DBUS_PATH)
-    dbus.Interface(player, PREVIEW_PLAYER_DBUS_IFACE).Pause()
-
-
-def closed(preview):
-    """Stops playing when the previre is closed"""
-    player = self.bus.get_object(PREVIEW_PLAYER_DBUS_NAME, PREVIEW_PLAYER_DBUS_PATH)
-    dbus.Interface(player, PREVIEW_PLAYER_DBUS_IFACE).Close()
+class Preview(Unity.ResultPreviewer):
+
+    def do_run(self):
+        global tracks
+        album = self.result.metadata['album'].get_string()
+        artist = self.result.metadata['artist'].get_string()
+        preview = Unity.MusicPreview.new(self.result.title, '', None)
+        preview.props.image_source_uri = self.result.icon_hint
+        preview.props.subtitle = self.result.metadata['artist'].get_string()
+        if self.result.uri.startswith("album://"):
+            for track in tracks:
+                if album in track[3] and artist in track[2]:
+                    track = Unity.TrackMetadata.full(track[1],
+                                                     int(track[9]),
+                                                     track[0],
+                                                     track[2],
+                                                     track[3],
+                                                     int(track[10]))
+                    preview.add_track(track)
+        else:
+            print(self.result.uri)
+            track = Unity.TrackMetadata.full('file://%s' % self.result.uri.replace(' ', '%20'),
+                                             self.result.metadata['track_number'].get_int32(),
+                                             self.result.title,
+                                             self.result.metadata['artist'].get_string(),
+                                             self.result.metadata['album'].get_string(),
+                                             self.result.metadata['track_length'].get_int32())
+            preview.add_track(track)
+
+        view_action = Unity.PreviewAction.new("play", _("Play"), None)
+        preview.add_action(view_action)
+        show_action = Unity.PreviewAction.new("show", _("Show in Folder"), None)
+        preview.add_action(show_action)
+        return preview
+
 
 # Classes below this point establish communication
 # with Unity, you probably shouldn't modify them.
@@ -356,19 +270,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)
 
@@ -424,6 +327,38 @@
         se = MySearch(search_context)
         return se
 
+    def do_activate(self, result, metadata, id):
+        album = result.metadata['album'].get_string()
+        artist = result.metadata['artist'].get_string()
+        global tracks
+        if id == 'show':
+            if result.uri.startswith("album://"):
+                for track in tracks:
+                    if album in track[3] and artist in track[2]:
+                        filename = tracks[1]
+                        continue
+            else:
+                filename = result.uri
+            dirname = os.path.dirname(filename)
+            os.system("xdg-open '%s'" % str(dirname))
+        else:
+            albumtracks = ''
+            if result.uri.startswith('album://'):
+                for track in tracks:
+                    if album in track[3] and artist in track[2]:
+                        albumtracks = albumtracks + ' \'%s\'' % (track[1])
+            else:
+                albumtracks = '\'%s\'' % result.uri
+            os.system('gmusicbrowser -play -playlist %s' % albumtracks)
+
+        return Unity.ActivationResponse(handled=Unity.HandledType.HIDE_DASH, goto_uri=None)
+
+    def do_create_previewer(self, result, metadata):
+        rp = Preview()
+        rp.set_scope_result(result)
+        rp.set_search_metadata(metadata)
+        return rp
+
 
 def load_scope():
     return Scope()

=== modified file 'tests/test_gmusicbrowser.py'
--- tests/test_gmusicbrowser.py	2013-03-03 19:20:19 +0000
+++ tests/test_gmusicbrowser.py	2013-04-22 13:23:30 +0000
@@ -11,17 +11,18 @@
         self.results = []
 
     def do_add_result(self, result):
-        self.results.append({'uri':result.uri,
-                             'title':result.title,
-                             'comment':result.comment,
-                             'icon':result.icon_hint})
+        self.results.append({'uri': result.uri,
+                             'title': result.title,
+                             'comment': result.comment,
+                             'icon': result.icon_hint})
+
 
 class ScopeTestCase(TestCase):
     def init_scope(self, scope_path):
         self.scope_module = imp.load_source('scope', scope_path)
         self.scope = self.scope_module.load_scope()
 
-    def perform_query(self, query, filter_set = Unity.FilterSet.new()):
+    def perform_query(self, query, filter_set=Unity.FilterSet.new()):
         result_set = ResultSet()
         ctx = Unity.SearchContext.create(query, 0, filter_set,
                                          None, result_set, None)
@@ -30,7 +31,7 @@
         return result_set
 
 
-class TestAskUbuntu(ScopeTestCase):
+class TestGmusicbrowser(ScopeTestCase):
     def setUp(self):
         self.init_scope('src/unity_gmusicbrowser_daemon.py')
 
@@ -38,7 +39,7 @@
         self.scope = None
         self.scope_module = None
 
-    def test_questions_search(self):
+    def test_qsearch(self):
         self.scope_module.GMUSICBROWSER_DBFILE = 'tests/data/mock_gmusicbrowser_pass'
         expected_results = ["/home/mark/Music/Jacques Dutronc/En Vogue/02. Mini, Mini, Mini.mp3",
                             "Mini, Mini, Mini"]
@@ -49,8 +50,7 @@
             results.append(result_set.results[0]['title'])
         self.assertEqual(results, expected_results)
 
-
-    def test_questions_failing_search(self):        
+    def test_failing_search(self):
         self.scope_module.GMUSICBROWSER_DBFILE = 'tests/data/mock_gmusicbrowser_fail'
         for s in ['upnriitnyt']:
             result_set = self.perform_query(s)