search: Add RemoteSearchProvider

Add an asynchronous search provider for results from a DBus service implementing the org.gnome.Shell.SearchProvider interface; this will allow applications to hook into the Shell's search without implementing it in Shell itself or requiring an extension. https://bugzilla.gnome.org/show_bug.cgi?id=663125
2011-11-17 00:11:05 +01:00
parent 89fe43f70c
commit f6749fb204
4 changed files with 283 additions and 0 deletions
--- a/js/ui/remoteSearch.js
+++ b/js/ui/remoteSearch.js
@ -0,0 +1,131 @@
+// -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
+
+const Gio = imports.gi.Gio;
+const Lang = imports.lang;
+const St = imports.gi.St;
+
+const Search = imports.ui.search;
+
+const SearchProviderIface = <interface name="org.gnome.Shell.SearchProvider">
+<method name="GetInitialResultSet">
+    <arg type="as" direction="in" />
+    <arg type="as" direction="out" />
+</method>
+<method name="GetSubsearchResultSet">
+    <arg type="as" direction="in" />
+    <arg type="as" direction="in" />
+    <arg type="as" direction="out" />
+</method>
+<method name="GetResultMetas">
+    <arg type="as" direction="in" />
+    <arg type="aa{sv}" direction="out" />
+</method>
+<method name="ActivateResult">
+    <arg type="s" direction="in" />
+</method>
+</interface>;
+
+var SearchProviderProxy = Gio.DBusProxy.makeProxyWrapper(SearchProviderIface);
+
+
+const RemoteSearchProvider = new Lang.Class({
+    Name: 'RemoteSearchProvider',
+    Extends: Search.SearchProvider,
+
+    _init: function(title, icon, dbusName, dbusPath) {
+        this._proxy = new SearchProviderProxy(Gio.DBus.session,
+                                              dbusName, dbusPath);
+
+        this.parent(title.toUpperCase());
+        this.async = true;
+        this._cancellable = new Gio.Cancellable();
+    },
+
+    createIcon: function(size, meta) {
+        if (meta['gicon']) {
+            return new St.Icon({ gicon: Gio.icon_new_for_string(meta['gicon']),
+                                 icon_size: size,
+                                 icon_type: St.IconType.FULLCOLOR });
+        } else if (meta['icon-data']) {
+            let [width, height, rowStride, hasAlpha,
+                 bitsPerSample, nChannels, data] = meta['icon-data'];
+            let textureCache = St.TextureCache.get_default();
+            return textureCache.load_from_raw(data, hasAlpha,
+                                              width, height, rowStride, size);
+        }
+
+        // Ugh, but we want to fall back to something ...
+        return new St.Icon({ icon_name: 'text-x-generic',
+                             icon_size: size,
+                             icon_type: St.IconType.FULLCOLOR });
+    },
+
+    _getResultsFinished: function(results, error) {
+        if (error)
+            return;
+        this.searchSystem.pushResults(this, results[0]);
+    },
+
+    getInitialResultSetAsync: function(terms) {
+        this._cancellable.cancel();
+        this._cancellable.reset();
+        try {
+            this._proxy.GetInitialResultSetRemote(terms,
+                                                  Lang.bind(this, this._getResultsFinished),
+                                                  this._cancellable);
+        } catch(e) {
+            log('Error calling GetInitialResultSet for provider %s: %s'.format( this.title, e.toString()));
+            this.searchSystem.pushResults(this, []);
+        }
+    },
+
+    getSubsearchResultSetAsync: function(previousResults, newTerms) {
+        this._cancellable.cancel();
+        this._cancellable.reset();
+        try {
+            this._proxy.GetSubsearchResultSetRemote(previousResults, newTerms,
+                                                    Lang.bind(this, this._getResultsFinished),
+                                                    this._cancellable);
+        } catch(e) {
+            log('Error calling GetSubsearchResultSet for provider %s: %s'.format(this.title, e.toString()));
+            this.searchSystem.pushResults(this, []);
+        }
+    },
+
+    _getResultMetasFinished: function(results, error, callback) {
+        if (error) {
+            callback([]);
+            return;
+        }
+        let metas = results[0];
+        let resultMetas = [];
+        for (let i = 0; i < metas.length; i++) {
+            for (let prop in metas[i])
+                metas[i][prop] = metas[i][prop].deep_unpack();
+            resultMetas.push({ id: metas[i]['id'],
+                               name: metas[i]['name'],
+                               createIcon: Lang.bind(this,
+                                                     this.createIcon, metas[i]) });
+        }
+        callback(resultMetas);
+    },
+
+    getResultMetasAsync: function(ids, callback) {
+        this._cancellable.cancel();
+        this._cancellable.reset();
+        try {
+            this._proxy.GetResultMetasRemote(ids,
+                                             Lang.bind(this, this._getResultMetasFinished, callback),
+                                             this._cancellable);
+        } catch(e) {
+            log('Error calling GetResultMetas for provider %s: %s'.format(this.title, e.toString()));
+            callback([]);
+        }
+    },
+
+    activateResult: function(id) {
+        this._proxy.ActivateResultRemote(id);
+    }
+});
+
+