Merge lp:~jamesh/software-center/scan-scopes into lp:software-center

[James Henstridge]

Include unity-scope-* packages in the list of dash search plugins.

We want Unity scopes to appear in the software center. The archive indexer has been updated to extract scope files from packages in the archive. We would also like information from these files included in the Xapian index Software Center creates from this data.

This branch adds such support.

Since we aren't including the new Unity stack in 13.04 it doesn't need to hit that deadline, but it'd be nice to know whether the approach seems sound.

[Dimitri John Ledkov (xnox)]

On 10 April 2013 09:23, James Henstridge <email address hidden> wrote:
> @@ -1019,13 +1031,16 @@
> if not datadir:
> datadir = softwarecenter.paths.APP_INSTALL_DESKTOP_PATH
> context = GLib.main_context_default()
> - for desktopf in glob(datadir + "/*.desktop"):
> + for desktopf in glob(datadir + "/*.desktop") + glob(datadir + "/*.scope"):

Right, so scope files are in the same place as the .desktop files. I
will make sure app-install-data has them in the matching above place.
I didn't know at the time if we will use
/usr/share/app-install/desktop or /usr/share/app-install/scopes.

Regards,

Dmitrijs.

[Michael Vogt (mvo)]

On Wed, Apr 10, 2013 at 08:22:24AM -0000, James Henstridge wrote:
> James Henstridge has proposed merging lp:~jamesh/software-center/scan-scopes into lp:software-center.
>
> Requested reviews:
> software-store-developers (software-store-developers)
>
> For more details, see:
> https://code.launchpad.net/~jamesh/software-center/scan-scopes/+merge/158014
>
> We want Unity scopes to appear in the software center. The archive indexer has been updated to extract scope files from packages in the archive. We would also like information from these files included in the Xapian index Software Center creates from this data.
>
> This branch adds such support.
[..]

Thanks James, this looks fine.

Approved from me.

[dobey (dobey)]

review: Approve

[lp:~jamesh/software-center/scan-scopes]

3304. By James Henstridge on 2013-05-02

Force scope files to have Type=Scope so they don't get mistaken for
other desktop entry types via [Scope]/Type.

=== modified file 'data/software-center.menu.in'
--- data/software-center.menu.in	2012-08-21 11:58:06 +0000
+++ data/software-center.menu.in	2013-05-02 21:39:26 +0000
@@ -538,7 +538,10 @@
       <SCIcon>preferences-other</SCIcon>
       <Include>
         <And>
-          <SCPkgnameWildcard>unity-lens-*</SCPkgnameWildcard>
+          <Or>
+            <SCPkgnameWildcard>unity-lens-*</SCPkgnameWildcard>
+            <SCPkgnameWildcard>unity-scope-*</SCPkgnameWildcard>
+          </Or>
         </And>
       </Include>
     </Menu>

=== modified file 'softwarecenter/db/update.py'
--- softwarecenter/db/update.py	2013-02-07 16:10:44 +0000
+++ softwarecenter/db/update.py	2013-05-02 21:39:26 +0000
@@ -933,6 +933,21 @@
     def desktopf(self):
         return self._filename
 
+class ScopeConfigParser(DesktopConfigParser):
+    """Thin wrapper to handle Scope files."""
+
+    SCOPE = "Scope"
+
+    def _get_option_desktop(self, key):
+        # Mark scopes as Type=Scope.
+        if key.lower() == 'type':
+            return 'Scope'
+        value = super(ScopeConfigParser, self)._get_option_desktop(key)
+        if value is not None:
+            return value
+        # Fall back to values from the SCOPE section.
+        if self.has_option(self.SCOPE, key):
+            return self.get(self.SCOPE, key)
 
 def ascii_upper(key):
     """Translate an ASCII string to uppercase
@@ -1019,13 +1034,16 @@
     if not datadir:
         datadir = softwarecenter.paths.APP_INSTALL_DESKTOP_PATH
     context = GLib.main_context_default()
-    for desktopf in glob(datadir + "/*.desktop"):
+    for desktopf in glob(datadir + "/*.desktop") + glob(datadir + "/*.scope"):
         LOG.debug("processing %r", desktopf)
         # process events
         while context.pending():
             context.iteration()
         try:
-            parser = DesktopConfigParser()
+            if desktopf.endswith('.scope'):
+                parser = ScopeConfigParser()
+            else:
+                parser = DesktopConfigParser()
             parser.read(desktopf)
             parser.index_app_info(db, cache)
         except Exception as e:

=== added file 'tests/data/desktop/music-banshee.scope'
--- tests/data/desktop/music-banshee.scope	1970-01-01 00:00:00 +0000
+++ tests/data/desktop/music-banshee.scope	2013-05-02 21:39:26 +0000
@@ -0,0 +1,17 @@
+[Scope]
+DBusName=com.canonical.Unity.Scope.Music
+DBusPath=/com/canonical/unity/scope/banshee
+Icon=/usr/share/unity/6/lens-nav-music.svg
+Name=Music (Banshee)
+Description=Find artists, albums, and your favorite tracks
+SearchHint=Search Music Collection
+Shortcut=m
+Type=music
+
+[Desktop Entry]
+X-AppInstall-Package=unity-lens-music
+X-AppInstall-Popcon=1000
+X-AppInstallSection=main
+
+X-Ubuntu-Gettext-Domain=unity-lens-music
+

=== modified file 'tests/test_database.py'
--- tests/test_database.py	2013-02-06 23:14:37 +0000
+++ tests/test_database.py	2013-05-02 21:39:26 +0000
@@ -102,6 +102,17 @@
         for it in db.postlist("AAUbuntu Software Zentrum"):
             i+=1
 
+    def test_update_includes_scope_files(self):
+        datadir = os.path.join(DATA_DIR, "desktop")
+        db = get_test_db_from_app_install_data(datadir)
+        for it in db.postlist("APMunity_lens_music"):
+            doc = db.get_document(it.docid)
+            self.assertEqual(
+                doc.get_value(XapianValues.APPNAME), "Music (Banshee)")
+            break
+        else:
+            self.fail("Did not find scope file in Xapian database")
+
     def test_regression_index_terms(self):
         """ this tests for a regression that we had in the term indexer
             that would index hundrets of size 1 terms due to a bug
@@ -230,7 +241,7 @@
         self.assertTrue(res)
         db = StoreDatabase(TEST_DB, self.cache)
         db.open(use_axi=False, use_agent=False)
-        self.assertEqual(len(db), 5)
+        self.assertEqual(len(db), 6)
         # test details
         app = Application("Ubuntu Software Center Test", "software-center")
         details = app.get_details(db)
@@ -940,6 +951,4 @@
 
 
 if __name__ == "__main__":
-    #import logging
-    #logging.basicConfig(level=logging.DEBUG)
     unittest.main()