Add search to current VM Tab

.gitignore

@@ -1,3 +1,6 @@
+# Glade backup file
+*.glade~
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

Pipfile

@@ -0,0 +1,21 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+watchdog = "*"
+pyxdg = "*"
+pygobject = "*"
+gbulb = "*"
+qubesadmin = "*" # install this manually, or use the following
+# qubesadmin = {git = "https://github.com/QubesOS/qubes-core-admin-client"}
+thefuzz = "*"
+
+[dev-packages]
+pytest = "*"
+# pytest-asyncio = "*"
+pylint = "*"
+
+[requires]
+python_version = ">=3.8"

README.md

@@ -76,6 +76,14 @@ position or via executing `qubes-app-menu` with desired params in CLI.
 
 ![](readme_img/menu_howto.png)
 
+## How to test
+```
+pipenv shell
+QUBES_MENU_TEST=1 python qubes_menu
+```
+
+You also need to install `qubesadmin` from https://github.com/QubesOS/qubes-core-admin-client. Run `python setup.py` in the dowloaded repo in pipenv shell to install.
+
 ## Technical details
 
 ### New features

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+asyncio_mode=strict

qubes_menu/__main__.py

@@ -0,0 +1,4 @@
+from .appmenu import main
+
+if __name__ == "__main__":
+    main()

qubes_menu/appmenu.py

@@ -264,23 +264,23 @@ def exit_app(self):
                 task.cancel()
 
 
+from .tests.mock_app import new_mock_qapp
+import os
+
+
 def main():
     """
     Start the menu app
     """
+
     qapp = qubesadmin.Qubes()
+    if "QUBES_MENU_TEST" in os.environ:
+        qapp = new_mock_qapp(qapp)
+        qapp.domains[qapp.local_name] = qapp.domains['dom0']
     dispatcher = qubesadmin.events.EventsDispatcher(qapp)
     app = AppMenu(qapp, dispatcher)
     app.run(sys.argv)
 
-    if f'--{constants.RESTART_PARAM_LONG}' in sys.argv or \
-            f'-{constants.RESTART_PARAM_SHORT}' in sys.argv:
-        sys.argv = [x for x in sys.argv if x not in
-                    (f'--{constants.RESTART_PARAM_LONG}',
-                     f'-{constants.RESTART_PARAM_SHORT}')]
-        app = AppMenu(qapp, dispatcher)
-        app.run(sys.argv)
-
 
 if __name__ == '__main__':
     sys.exit(main())

qubes_menu/desktop_file_manager.py

@@ -20,11 +20,13 @@
 """
 Helper class that manages all events related to .desktop files.
 """
-import pyinotify
 import logging
 import asyncio
 import os
 import shlex
+
+from watchdog.observers import Observer
+from watchdog.events import FileSystemEventHandler
 import xdg.DesktopEntry
 import xdg.BaseDirectory
 import xdg.Menu
@@ -125,6 +127,39 @@ def is_qubes_specific(self):
         return 'X-Qubes-VM' in self.categories
 
 
+
+class FileChangeHandler(FileSystemEventHandler):
+    def __init__(self, manager: 'DesktopFileManager'):
+        self.manager = manager
+        super().__init__()
+
+    def try_load(self, filename):
+        try:
+            self.manager.load_file(filename)
+        except FileNotFoundError:
+            self.manager.remove_file(filename)
+
+    def on_created(self, event):
+        """On file create, attempt to load it. This can lead to spurious
+        warnings due to 0-byte files being loaded, but in some cases
+        is necessary to correctly process files."""
+        self.try_load(event.src_path)
+
+    def on_deleted(self, event):
+        """
+        On file delete, remove the tile and all its children menu entries
+        """
+        self.manager.remove_file(event.src_path)
+
+    def on_modified(self, event):
+        """On modify, simply attempt to load the file again."""
+        self.try_load(event.src_path)
+
+    def on_moved(self, event):
+        self.manager.remove_file(event.src_path)
+        self.try_load(event.dest_path)
+
+
 class DesktopFileManager:
     """
     Class that loads, caches and observes changes in .desktop files.
@@ -133,40 +168,10 @@ class DesktopFileManager:
         Path(xdg.BaseDirectory.xdg_data_home) / 'applications',
         Path('/usr/share/applications')]
 
-    # pylint: disable=invalid-name
-    class EventProcessor(pyinotify.ProcessEvent):
-        """pyinotify helper class"""
-        def __init__(self, parent):
-            self.parent = parent
-            super().__init__()
-
-        def process_IN_CREATE(self, event):
-            """On file create, attempt to load it. This can lead to spurious
-            warnings due to 0-byte files being loaded, but in some cases
-            is necessary to correctly process files."""
-            try:
-                self.parent.load_file(event.pathname)
-            except FileNotFoundError:
-                self.parent.remove_file(event.pathname)
-
-        def process_IN_DELETE(self, event):
-            """
-            On file delete, remove the tile and all its children menu entries
-            """
-            self.parent.remove_file(event.pathname)
-
-        def process_IN_MODIFY(self, event):
-            """On modify, simply attempt to laod the file again."""
-            try:
-                self.parent.load_file(event.pathname)
-            except FileNotFoundError:
-                self.parent.remove_file(event.pathname)
-
     def __init__(self, qapp):
         self.qapp = qapp
         self.watch_manager = None
-        self.notifier = None
-        self.watches = []
+        self.observer = None
         self._callbacks: List[Callable] = []
 
         # directories used by Qubes menu tools, not necessarily all possible
@@ -273,18 +278,12 @@ def _initialize_watchers(self):
         """
         Initialize all watcher entities.
         """
-        self.watch_manager = pyinotify.WatchManager()
+        event_handler = FileChangeHandler(self)
+        observer = Observer()
 
-        # pylint: disable=no-member
-        mask = pyinotify.IN_CREATE | pyinotify.IN_DELETE | pyinotify.IN_MODIFY
-
-        loop = asyncio.get_event_loop()
-
-        self.notifier = pyinotify.AsyncioNotifier(
-            self.watch_manager, loop,
-            default_proc_fun=DesktopFileManager.EventProcessor(self))
+        self.observer = observer
 
         for path in self.desktop_dirs:
-            self.watches.append(
-                self.watch_manager.add_watch(
-                    str(path), mask, rec=True, auto_add=True))
+            observer.schedule(event_handler, str(path), recursive=True)
+
+        observer.start()

qubes_menu/qubes-menu.glade

@@ -17,7 +17,7 @@
         <property name="can-focus">True</property>
         <property name="tab-pos">left</property>
         <child>
-          <object class="GtkBox">
+          <object class="GtkBox" id="tab_all">
             <property name="visible">True</property>
             <property name="can-focus">False</property>
             <child>
@@ -301,7 +301,7 @@
           </packing>
         </child>
         <child>
-          <object class="GtkBox">
+          <object class="GtkBox" id="tab_current_vm">
             <property name="visible">True</property>
             <property name="can-focus">False</property>
             <child>
@@ -319,30 +319,56 @@
               </packing>
             </child>
             <child>
-              <object class="GtkScrolledWindow">
+              <object class="GtkBox">
                 <property name="visible">True</property>
-                <property name="can-focus">True</property>
-                <property name="hscrollbar-policy">never</property>
-                <property name="shadow-type">in</property>
+                <property name="can-focus">False</property>
+                <property name="orientation">vertical</property>
                 <child>
-                  <object class="GtkViewport">
+                  <object class="GtkSearchEntry" id="current_search">
                     <property name="visible">True</property>
-                    <property name="can-focus">False</property>
+                    <property name="can-focus">True</property>
+                    <property name="primary-icon-name">edit-find-symbolic</property>
+                    <property name="primary-icon-activatable">False</property>
+                    <property name="primary-icon-sensitive">False</property>
+                  </object>
+                  <packing>
+                    <property name="expand">False</property>
+                    <property name="fill">True</property>
+                    <property name="position">0</property>
+                  </packing>
+                </child>
+                <child>
+                  <object class="GtkScrolledWindow">
+                    <property name="visible">True</property>
+                    <property name="can-focus">True</property>
+                    <property name="hscrollbar-policy">never</property>
+                    <property name="shadow-type">in</property>
                     <child>
-                      <object class="GtkListBox" id="sys_tools_list">
+                      <object class="GtkViewport">
                         <property name="visible">True</property>
                         <property name="can-focus">False</property>
-                        <property name="selection-mode">none</property>
-                        <style>
-                          <class name="right_pane"/>
-                        </style>
+                        <child>
+                          <object class="GtkListBox" id="sys_tools_list">
+                            <property name="visible">True</property>
+                            <property name="can-focus">False</property>
+                            <property name="selection-mode">none</property>
+                            <style>
+                              <class name="right_pane"/>
+                            </style>
+                          </object>
+                        </child>
                       </object>
                     </child>
+                    <style>
+                      <class name="right_pane"/>
+                    </style>
                   </object>
+                  <packing>
+                    <property name="expand">True</property>
+                    <property name="fill">True</property>
+                    <property name="position">1</property>
+                  </packing>
                 </child>
-                <style>
-                  <class name="right_pane"/>
-                </style>
               </object>
               <packing>
                 <property name="expand">True</property>
@@ -352,6 +378,7 @@
             </child>
           </object>
           <packing>
+            <property name="menu-label">Stuff in Current VM</property>
             <property name="position">2</property>
           </packing>
         </child>
@@ -393,6 +420,7 @@
             </style>
           </object>
           <packing>
+            <property name="menu-label">Power Button</property>
             <property name="tab-fill">False</property>
           </packing>
         </child>

qubes_menu/settings_page.py

@@ -53,14 +53,17 @@ class SettingsPage:
     def __init__(self, qapp, builder: Gtk.Builder,
                  desktop_file_manager: DesktopFileManager,
                  dispatcher: qubesadmin.events.EventsDispatcher):
+        self.query = ""
+        self.query_entry: Gtk.SearchEntry = builder.get_object('current_search')
+        self.query_entry.connect("changed", self._on_query_change)
+
         self.qapp = qapp
         self.desktop_file_manager = desktop_file_manager
         self.dispatcher = dispatcher
 
         self.app_list: Gtk.ListBox = builder.get_object('sys_tools_list')
         self.app_list.connect('row-activated', self._app_clicked)
-        self.app_list.set_sort_func(
-            lambda x, y: x.app_info.app_name > y.app_info.app_name)
+        self.app_list.set_sort_func(self._sort_apps)
         self.app_list.set_filter_func(self._filter_apps)
 
         self.category_list: Gtk.ListBox = builder.get_object(
@@ -80,9 +83,21 @@ def __init__(self, qapp, builder: Gtk.Builder,
         self.app_list.invalidate_filter()
         self.app_list.invalidate_sort()
 
+
     def initialize_state(self):
         """On initialization, no category should be selected."""
         self.category_list.select_row(None)
+
+    def _on_query_change(self, entry: Gtk.SearchEntry):
+        self.query = entry.get_text()
+        self.app_list.invalidate_sort()
+
+    def _sort_apps(self, x, y):
+        from thefuzz import fuzz
+        edit_distance = fuzz.token_sort_ratio
+        if not self.query:
+            return x.app_info.app_name > y.app_info.app_name
+        return edit_distance(self.query, x.app_info.app_name) < edit_distance(self.query, y.app_info.app_name)
 
     def _filter_apps(self, row):
         filter_func = getattr(self.category_list.get_selected_row(),