Merge lp:~kay20/switchboard/plug_search into lp:~elementary-pantheon/switchboard/switchboard

[kay van der Zander]

Implement deep search in the plugs and search callback.

this branch implements the deep plug search + the search callback to the plug to show the right ui element when opening.

this is tested with A11Y branch: https://code.launchpad.net/~kay20/switchboard-plug-a11y/plug-search

[Corentin Noël (tintou)]

A few things and here we go

[lp:~kay20/switchboard/plug_search]

578. By kay van der Zander on 2016-02-07

implement search callback function

[kay van der Zander (kay20)]

by Corentin Noël

review: Approve

=== modified file 'lib/PlugsManager.vala'
--- lib/PlugsManager.vala	2014-12-01 21:07:00 +0000
+++ lib/PlugsManager.vala	2016-02-07 15:47:43 +0000
@@ -102,4 +102,4 @@
     public Gee.Collection<Switchboard.Plug> get_plugs () {
         return plugs.read_only_view;
     }
-}
\ No newline at end of file
+}

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2014-04-14 20:39:34 +0000
+++ src/CMakeLists.txt	2016-02-07 15:47:43 +0000
@@ -1,6 +1,7 @@
 set(CLIENT_SOURCE
     Switchboard.vala
     CategoryView.vala
+    PlugsSearch.vala
     EmbeddedAlert.vala
     NavigationButton.vala
 )

=== modified file 'src/CategoryView.vala'
--- src/CategoryView.vala	2016-01-13 20:05:32 +0000
+++ src/CategoryView.vala	2016-02-07 15:47:43 +0000
@@ -42,16 +42,19 @@
         public Gtk.IconView hardware_iconview;
         public Gtk.IconView network_iconview;
         public Gtk.IconView system_iconview;
+        public Gee.ArrayList<SearchEntry?> plug_search_result;
 
         private string? plug_to_open = null;
+        private PlugsSearch plug_search;
 
         public CategoryView (string? plug_to_open = null) {
             this.plug_to_open = plug_to_open;
-
             setup_category (Switchboard.Plug.Category.PERSONAL, 0);
             setup_category (Switchboard.Plug.Category.HARDWARE, 1);
             setup_category (Switchboard.Plug.Category.NETWORK, 2);
             setup_category (Switchboard.Plug.Category.SYSTEM, 3);
+            plug_search = new PlugsSearch ();
+            plug_search_result = new Gee.ArrayList<SearchEntry?> ();
         }
 
         private void setup_category (Switchboard.Plug.Category category, int i) {
@@ -312,15 +315,25 @@
         public void filter_plugs (string filter) {
 
             var any_found = false;
-
-            if (search_by_category (filter, Switchboard.Plug.Category.PERSONAL))
-                any_found = true;
-            if (search_by_category (filter, Switchboard.Plug.Category.HARDWARE))
-                any_found = true;
-            if (search_by_category (filter, Switchboard.Plug.Category.NETWORK))
-                any_found = true;
-            if (search_by_category (filter, Switchboard.Plug.Category.SYSTEM))
-                any_found = true;
+            var model_filter = (Gtk.TreeModelFilter) personal_iconview.get_model ();
+            if (search_by_category (filter, model_filter, personal_grid)) {
+                any_found = true;
+            }
+
+            model_filter = (Gtk.TreeModelFilter) hardware_iconview.get_model ();
+            if (search_by_category (filter, model_filter, hardware_grid)) {
+                any_found = true;
+            }
+
+            model_filter = (Gtk.TreeModelFilter) network_iconview.get_model ();
+            if (search_by_category (filter, model_filter, network_grid)) {
+                any_found = true;
+            }
+
+            model_filter = (Gtk.TreeModelFilter) system_iconview.get_model ();
+            if (search_by_category (filter, model_filter, system_grid)) {
+                any_found = true;
+            }
 
             unowned SwitchboardApp app = (SwitchboardApp) GLib.Application.get_default ();
             if (!any_found) {
@@ -330,43 +343,39 @@
             }
         }
 
-        private bool search_by_category (string filter, Plug.Category category) {
-
-            Gtk.TreeModelFilter model_filter;
-            Gtk.Widget grid;
-
-            switch (category) {
-                case Switchboard.Plug.Category.PERSONAL:
-                    model_filter = (Gtk.TreeModelFilter)personal_iconview.get_model ();
-                    grid = personal_grid;
-                    break;
-                case Switchboard.Plug.Category.HARDWARE:
-                    model_filter = (Gtk.TreeModelFilter)hardware_iconview.get_model ();
-                    grid = hardware_grid;
-                    break;
-                case Switchboard.Plug.Category.NETWORK:
-                    model_filter = (Gtk.TreeModelFilter)network_iconview.get_model ();
-                    grid = network_grid;
-                    break;
-                case Switchboard.Plug.Category.SYSTEM:
-                    model_filter = (Gtk.TreeModelFilter)system_iconview.get_model ();
-                    grid = system_grid;
-                    break;
-                default:
-                    return false;
+        private void deep_search (string filter) {
+            if (plug_search.ready) {
+                plug_search_result.clear ();
+                foreach (var tmp in plug_search.search_entries) {
+                    if (tmp.ui_elements.down ().contains (filter.down ())) {
+                        plug_search_result.add (tmp);
+                    }
+                }
             }
-
+        }
+
+        private bool search_by_category (string filter, Gtk.TreeModelFilter model_filter, Gtk.Widget grid) {
+
+            deep_search (filter);
             var store = model_filter.child_model as Gtk.ListStore;
             int shown = 0;
             store.foreach ((model, path, iter) => {
                 string title;
 
                 store.get (iter, Columns.TEXT, out title);
+                bool show_element = false;
+                foreach (var tmp in plug_search_result) {
+                    if (tmp.plug_name.down () in title.down ()) {
+                        store.set_value (iter, Columns.VISIBLE, true);
+                        shown++;
+                        show_element = true;
+                    }
+                }
 
                 if (filter.down () in title.down ()) {
                     store.set_value (iter, Columns.VISIBLE, true);
                     shown++;
-                } else {
+                } else if (!show_element) {
                     store.set_value (iter, Columns.VISIBLE, false);
                 }
 

=== added file 'src/PlugsSearch.vala'
--- src/PlugsSearch.vala	1970-01-01 00:00:00 +0000
+++ src/PlugsSearch.vala	2016-02-07 15:47:43 +0000
@@ -0,0 +1,64 @@
+/*-
+ * Copyright (c) 2015-2016 elementary LLC.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Kay van der Zander <[e-mail]>
+ */
+
+namespace Switchboard {
+
+    public struct SearchEntry {
+        string plug_name;
+        string ui_elements;
+        string open_window;
+    }
+
+    public class PlugsSearch {
+        
+        public Gee.ArrayList<SearchEntry?> search_entries;
+        public bool ready {get; private set;}
+
+        public PlugsSearch () {
+            ready = false;
+            search_entries = new Gee.ArrayList<SearchEntry?>();
+            cache_search_entries.begin((obj, res) => {
+                cache_search_entries.end (res);
+                ready = true;
+            });
+        }
+
+        // key ("%s → %s".printf (display_name, _("Network Time")))
+        public async void cache_search_entries () {
+            var plugsmanager = Switchboard.PlugsManager.get_default ();
+
+            foreach (var plug in plugsmanager.get_plugs ()) {
+                var tmp_entries = yield plug.search ("");
+
+                foreach (var entry in tmp_entries.entries) {
+                    string [] tmp = entry.key.split(" → ");
+                    SearchEntry tmp_entry = SearchEntry ();
+                    tmp_entry.plug_name = tmp[0];
+                    string ui_elements_name = entry.key;
+                    tmp_entry.ui_elements = ui_elements_name;
+                    tmp_entry.open_window = entry.value;
+                    search_entries.add (tmp_entry);
+                    debug ("plugsSearch: add open window: %s ", tmp_entry.open_window);
+                    debug ("plugsSearch: add ui elements: %s ", tmp_entry.ui_elements);
+                    debug ("plugsSearch: add plug name: %s ", tmp_entry.plug_name);
+                }
+            }
+        }
+    }
+}

=== modified file 'src/Switchboard.vala'
--- src/Switchboard.vala	2015-12-04 11:00:41 +0000
+++ src/Switchboard.vala	2016-02-07 15:47:43 +0000
@@ -182,6 +182,20 @@
                     loaded_plugs.add (plug.code_name);
                 }
 
+                category_view.plug_search_result.foreach ((entry) => {
+                    if (plug.display_name == entry.plug_name) {
+                        if (entry.open_window == null) {
+                            plug.search_callback (""); // open default in the switch
+                        } else {
+                            plug.search_callback (entry.open_window);
+                        }
+                        debug ("open section:%s of plug: %s",entry.open_window, plug.display_name);
+                        return true;
+                    }
+
+                    return false;
+                });
+
                 previous_plugs.add (plug);
 
                 // Launch plug's executable