[gnome-shell/wip/re-search: 449/457] {app, place}Display: Add provider icons for the search system

[Jasper St. Pierre <jstpierre src gnome org>]

commit 0215d3e2c5259a95da674275fdd2a6913d92b269
Author: Tanner Doshier <doshitan gmail com>
Date:   Mon Jul 9 19:17:09 2012 -0500

    {app,place}Display: Add provider icons for the search system
    
    Only temporary, to test with, unless remote providers for Settings and Places
    & Devices don't materialize. this.icon should be a GIcon since that is what
    remote providers will return.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=681797

 js/ui/appDisplay.js   |    3 +
 js/ui/placeDisplay.js |  432 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 435 insertions(+), 0 deletions(-)
---
diff --git a/js/ui/appDisplay.js b/js/ui/appDisplay.js
index b0ff291..64817bb 100644
--- a/js/ui/appDisplay.js
+++ b/js/ui/appDisplay.js
@@ -1,6 +1,7 @@
 // -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
 
 const Clutter = imports.gi.Clutter;
+const Gio = imports.gi.Gio;
 const GLib = imports.gi.GLib;
 const Gtk = imports.gi.Gtk;
 const GMenu = imports.gi.GMenu;
@@ -371,6 +372,8 @@ const SettingsSearchProvider = new Lang.Class({
 
         this._appSys = Shell.AppSystem.get_default();
         this._gnomecc = this._appSys.lookup_app('gnome-control-center.desktop');
+        let appInfo = Gio.DesktopAppInfo.new('gnome-control-center.desktop');
+        this.icon = appInfo.get_icon();
     },
 
     getResultMetas: function(prefs, callback) {
diff --git a/js/ui/placeDisplay.js b/js/ui/placeDisplay.js
new file mode 100644
index 0000000..5aae072
--- /dev/null
+++ b/js/ui/placeDisplay.js
@@ -0,0 +1,432 @@
+// -*- mode: js; js-indent-level: 4; indent-tabs-mode: nil -*-
+
+const GLib = imports.gi.GLib;
+const Gio = imports.gi.Gio;
+const Shell = imports.gi.Shell;
+const Lang = imports.lang;
+const Mainloop = imports.mainloop;
+const Signals = imports.signals;
+const St = imports.gi.St;
+
+const DND = imports.ui.dnd;
+const Main = imports.ui.main;
+const Params = imports.misc.params;
+const Search = imports.ui.search;
+const Util = imports.misc.util;
+
+/**
+ * Represents a place object, which is most normally a bookmark entry,
+ * a mount/volume, or a special place like the Home Folder, Computer, and Network.
+ *
+ * @name: String title
+ * @iconFactory: A JavaScript callback which will create an icon texture given a size parameter
+ * @launch: A JavaScript callback to launch the entry
+ */
+const PlaceInfo = new Lang.Class({
+    Name: 'PlaceInfo',
+
+    _init: function(id, name, iconFactory, launch) {
+        this.id = id;
+        this.name = name;
+        this._lowerName = name.toLowerCase();
+        this.iconFactory = iconFactory;
+        this.launch = launch;
+    },
+
+    matchTerms: function(terms) {
+        let mtype = Search.MatchType.NONE;
+        for (let i = 0; i < terms.length; i++) {
+            let term = terms[i];
+            let idx = this._lowerName.indexOf(term);
+            if (idx == 0) {
+                mtype = Search.MatchType.PREFIX;
+            } else if (idx > 0) {
+                if (mtype == Search.MatchType.NONE)
+                    mtype = Search.MatchType.SUBSTRING;
+            } else {
+                return Search.MatchType.NONE;
+            }
+        }
+        return mtype;
+    },
+
+    isRemovable: function() {
+        return false;
+    }
+});
+
+// Helper function to translate launch parameters into a GAppLaunchContext
+function _makeLaunchContext(params)
+{
+    params = Params.parse(params, { workspace: -1,
+                                    timestamp: 0 });
+
+    let launchContext = global.create_app_launch_context();
+    if (params.workspace != -1)
+        launchContext.set_desktop(params.workspace);
+    if (params.timestamp != 0)
+        launchContext.set_timestamp(params.timestamp);
+
+    return launchContext;
+}
+
+const PlaceDeviceInfo = new Lang.Class({
+    Name: 'PlaceDeviceInfo',
+    Extends: PlaceInfo,
+
+    _init: function(mount) {
+        this._mount = mount;
+        this.name = mount.get_name();
+        this._lowerName = this.name.toLowerCase();
+        this.id = 'mount:' + mount.get_root().get_uri();
+    },
+
+    iconFactory: function(size) {
+        let icon = this._mount.get_icon();
+        return St.TextureCache.get_default().load_gicon(null, icon, size);
+    },
+
+    launch: function(params) {
+        Gio.app_info_launch_default_for_uri(this._mount.get_root().get_uri(),
+                                            _makeLaunchContext(params));
+    },
+
+    isRemovable: function() {
+        return this._mount.can_unmount();
+    },
+
+    remove: function() {
+        if (!this.isRemovable())
+            return;
+
+        if (this._mount.can_eject())
+            this._mount.eject(0, null, Lang.bind(this, this._removeFinish));
+        else
+            this._mount.unmount(0, null, Lang.bind(this, this._removeFinish));
+    },
+
+    _removeFinish: function(o, res, data) {
+        try {
+            if (this._mount.can_eject())
+                this._mount.eject_finish(res);
+            else
+                this._mount.unmount_finish(res);
+        } catch (e) {
+            let message = _("Failed to unmount '%s'").format(o.get_name());
+            Main.overview.setMessage(message,
+                                     Lang.bind(this, this.remove),
+                                     _("Retry"));
+        }
+    }
+});
+
+const PlacesManager = new Lang.Class({
+    Name: 'PlacesManager',
+
+    _init: function() {
+        this._defaultPlaces = [];
+        this._mounts = [];
+        this._bookmarks = [];
+
+        let homeFile = Gio.file_new_for_path (GLib.get_home_dir());
+        let homeUri = homeFile.get_uri();
+        let homeLabel = Shell.util_get_label_for_uri (homeUri);
+        let homeIcon = Shell.util_get_icon_for_uri (homeUri);
+        this._home = new PlaceInfo('special:home', homeLabel,
+            function(size) {
+                return St.TextureCache.get_default().load_gicon(null, homeIcon, size);
+            },
+            function(params) {
+                Gio.app_info_launch_default_for_uri(homeUri, _makeLaunchContext(params));
+            });
+
+        let desktopPath = GLib.get_user_special_dir(GLib.UserDirectory.DIRECTORY_DESKTOP);
+        let desktopFile = Gio.file_new_for_path (desktopPath);
+        let desktopUri = desktopFile.get_uri();
+        let desktopLabel = Shell.util_get_label_for_uri (desktopUri);
+        let desktopIcon = Shell.util_get_icon_for_uri (desktopUri);
+        this._desktopMenu = new PlaceInfo('special:desktop', desktopLabel,
+            function(size) {
+                return St.TextureCache.get_default().load_gicon(null, desktopIcon, size);
+            },
+            function(params) {
+                Gio.app_info_launch_default_for_uri(desktopUri, _makeLaunchContext(params));
+            });
+
+        this._connect = new PlaceInfo('special:connect', _("Connect to..."),
+            function (size) {
+                // do NOT use St.Icon here, it crashes the shell
+                // see wanda.js for details
+                return St.TextureCache.get_default().load_icon_name(null,
+                                                                    'applications-internet',
+                                                                    St.IconType.FULLCOLOR,
+                                                                    size);
+            },
+            function (params) {
+                // BUG: nautilus-connect-server doesn't have a desktop file, so we can't
+                // launch it with the workspace from params. It's probably pretty rare
+                // and odd to drag this place onto a workspace in any case
+
+                Util.spawn(['nautilus-connect-server']);
+            });
+
+        this._defaultPlaces.push(this._home);
+        this._defaultPlaces.push(this._desktopMenu);
+        this._defaultPlaces.push(this._connect);
+
+        /*
+        * Show devices, code more or less ported from nautilus-places-sidebar.c
+        */
+        this._volumeMonitor = Gio.VolumeMonitor.get();
+        this._volumeMonitor.connect('volume-added', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('volume-removed',Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('volume-changed', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('mount-added', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('mount-removed', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('mount-changed', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('drive-connected', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('drive-disconnected', Lang.bind(this, this._updateDevices));
+        this._volumeMonitor.connect('drive-changed', Lang.bind(this, this._updateDevices));
+        this._updateDevices();
+
+        this._bookmarksPath = GLib.build_filenamev([GLib.get_user_config_dir(), 'gtk-3.0', 'bookmarks']);
+        this._bookmarksFile = Gio.file_new_for_path(this._bookmarksPath);
+        this._monitor = this._bookmarksFile.monitor_file(Gio.FileMonitorFlags.NONE, null);
+        this._bookmarkTimeoutId = 0;
+        this._monitor.connect('changed', Lang.bind(this, function () {
+            if (this._bookmarkTimeoutId > 0)
+                return;
+            /* Defensive event compression */
+            this._bookmarkTimeoutId = Mainloop.timeout_add(100, Lang.bind(this, function () {
+                this._bookmarkTimeoutId = 0;
+                this._reloadBookmarks();
+                return false;
+            }));
+        }));
+
+        this._reloadBookmarks();
+    },
+
+    _updateDevices: function() {
+        this._mounts = [];
+
+        /* first go through all connected drives */
+        let drives = this._volumeMonitor.get_connected_drives();
+        for (let i = 0; i < drives.length; i++) {
+            let volumes = drives[i].get_volumes();
+            for(let j = 0; j < volumes.length; j++) {
+                let mount = volumes[j].get_mount();
+                if(mount != null) {
+                    this._addMount(mount);
+                }
+            }
+        }
+
+        /* add all volumes that is not associated with a drive */
+        let volumes = this._volumeMonitor.get_volumes();
+        for(let i = 0; i < volumes.length; i++) {
+            if(volumes[i].get_drive() != null)
+                continue;
+
+            let mount = volumes[i].get_mount();
+            if(mount != null) {
+                this._addMount(mount);
+            }
+        }
+
+        /* add mounts that have no volume (/etc/mtab mounts, ftp, sftp,...) */
+        let mounts = this._volumeMonitor.get_mounts();
+        for(let i = 0; i < mounts.length; i++) {
+            if(mounts[i].is_shadowed())
+                continue;
+
+            if(mounts[i].get_volume())
+                continue;
+
+            this._addMount(mounts[i]);
+        }
+
+        /* We emit two signals, one for a generic 'all places' update
+         * and the other for one specific to mounts. We do this because
+         * clients like PlaceDisplay may only care about places in general
+         * being updated while clients like DashPlaceDisplay care which
+         * specific type of place got updated.
+         */
+        this.emit('mounts-updated');
+        this.emit('places-updated');
+
+    },
+
+    _reloadBookmarks: function() {
+
+        this._bookmarks = [];
+
+        if (!GLib.file_test(this._bookmarksPath, GLib.FileTest.EXISTS))
+            return;
+
+        let bookmarksContent = Shell.get_file_contents_utf8_sync(this._bookmarksPath);
+
+        let bookmarks = bookmarksContent.split('\n');
+
+        let bookmarksToLabel = {};
+        let bookmarksOrder = [];
+        for (let i = 0; i < bookmarks.length; i++) {
+            let bookmarkLine = bookmarks[i];
+            let components = bookmarkLine.split(' ');
+            let bookmark = components[0];
+            if (bookmark in bookmarksToLabel)
+                continue;
+            let label = null;
+            if (components.length > 1)
+                label = components.slice(1).join(' ');
+            bookmarksToLabel[bookmark] = label;
+            bookmarksOrder.push(bookmark);
+        }
+
+        for (let i = 0; i < bookmarksOrder.length; i++) {
+            let bookmark = bookmarksOrder[i];
+            let label = bookmarksToLabel[bookmark];
+            let file = Gio.file_new_for_uri(bookmark);
+            if (!file.query_exists(null))
+                continue;
+            if (label == null)
+                label = Shell.util_get_label_for_uri(bookmark);
+            if (label == null)
+                continue;
+            let icon = Shell.util_get_icon_for_uri(bookmark);
+
+            let item = new PlaceInfo('bookmark:' + bookmark, label,
+                function(size) {
+                    return St.TextureCache.get_default().load_gicon(null, icon, size);
+                },
+                function(params) {
+                    Gio.app_info_launch_default_for_uri(bookmark, _makeLaunchContext(params));
+                });
+            this._bookmarks.push(item);
+        }
+
+        /* See comment in _updateDevices for explanation why there are two signals. */
+        this.emit('bookmarks-updated');
+        this.emit('places-updated');
+    },
+
+    _addMount: function(mount) {
+        let devItem = new PlaceDeviceInfo(mount);
+        this._mounts.push(devItem);
+    },
+
+    getAllPlaces: function () {
+        return this.getDefaultPlaces().concat(this.getBookmarks(), this.getMounts());
+    },
+
+    getDefaultPlaces: function () {
+        return this._defaultPlaces;
+    },
+
+    getBookmarks: function () {
+        return this._bookmarks;
+    },
+
+    getMounts: function () {
+        return this._mounts;
+    },
+
+    _lookupIndexById: function(sourceArray, id) {
+        for (let i = 0; i < sourceArray.length; i++) {
+            let place = sourceArray[i];
+            if (place.id == id)
+                return i;
+        }
+        return -1;
+    },
+
+    lookupPlaceById: function(id) {
+        let colonIdx = id.indexOf(':');
+        let type = id.substring(0, colonIdx);
+        let sourceArray = null;
+        if (type == 'special')
+            sourceArray = this._defaultPlaces;
+        else if (type == 'mount')
+            sourceArray = this._mounts;
+        else if (type == 'bookmark')
+            sourceArray = this._bookmarks;
+        return sourceArray[this._lookupIndexById(sourceArray, id)];
+    },
+
+    _removeById: function(sourceArray, id) {
+        sourceArray.splice(this._lookupIndexById(sourceArray, id), 1);
+    }
+});
+Signals.addSignalMethods(PlacesManager.prototype);
+
+const PlaceSearchProvider = new Lang.Class({
+    Name: 'PlaceSearchProvider',
+    Extends: Search.SearchProvider,
+
+    _init: function() {
+        this.parent(_("PLACES & DEVICES"));
+        this.placesManager = new PlacesManager();
+        let appInfo = Gio.DesktopAppInfo.new('nautilus.desktop');
+        this.icon = appInfo.get_icon();
+    },
+
+    getResultMetas: function(resultIds, callback) {
+        let metas = [];
+        for (let i = 0; i < resultIds.length; i++) {
+            let placeInfo = this.placesManager.lookupPlaceById(resultIds[i]);
+            if (!placeInfo)
+                metas.push(null);
+            else
+                metas.push({ 'id': resultIds[i],
+                             'name': placeInfo.name,
+                             'createIcon': function(size) {
+                                 return placeInfo.iconFactory(size);
+                             }
+                           });
+        }
+        callback(metas);
+    },
+
+    activateResult: function(id, params) {
+        let placeInfo = this.placesManager.lookupPlaceById(id);
+        placeInfo.launch(params);
+    },
+
+    _compareResultMeta: function (idA, idB) {
+        let infoA = this.placesManager.lookupPlaceById(idA);
+        let infoB = this.placesManager.lookupPlaceById(idB);
+        return infoA.name.localeCompare(infoB.name);
+    },
+
+    _searchPlaces: function(places, terms) {
+        let prefixResults = [];
+        let substringResults = [];
+
+        terms = terms.map(String.toLowerCase);
+
+        for (let i = 0; i < places.length; i++) {
+            let place = places[i];
+            let mtype = place.matchTerms(terms);
+            if (mtype == Search.MatchType.PREFIX)
+                prefixResults.push(place.id);
+            else if (mtype == Search.MatchType.SUBSTRING)
+                substringResults.push(place.id);
+        }
+        prefixResults.sort(Lang.bind(this, this._compareResultMeta));
+        substringResults.sort(Lang.bind(this, this._compareResultMeta));
+
+        this.searchSystem.pushResults(this, prefixResults.concat(substringResults));
+    },
+
+    getInitialResultSet: function(terms) {
+        let places = this.placesManager.getAllPlaces();
+        this._searchPlaces(places, terms);
+    },
+
+    getSubsearchResultSet: function(previousResults, terms) {
+        let places = previousResults.map(Lang.bind(this, function(id) {
+            return this.placesManager.lookupPlaceById(id);
+        }));
+        this._searchPlaces(places, terms);
+    }
+});