fix: replace 'vim' hook with generic 'edit' hook (#236)

README.md

@@ -51,7 +51,11 @@ Check out the [manpage](/~https://github.com/hnicke/sodalite/blob/master/docs/soda
 ## FAQ
 ##### The default 'open' hook doesn't work / launches weird programs :(
 Most probably it is not sodalite's fault, but your mime default application list isn't configured correctly.
-You could try this:
+Run the following command to find the associated application for given file:
+```bash
+xdg-mime query default $(xdg-mime query filetype <file>)
+```
+In order to change the default application for a files mime type, run:
 ```bash
 xdg-mime default <desktop> $(xdg-mime query filetype <file>)
 ```

scripts/sodalite-open

@@ -12,6 +12,8 @@ function set_fallback_editor {
             editor=vim
         elif type nano; then
             editor=nano
+        elif type vi; then
+            editor=vi
         else
             echo "Could not find a suitable editor"; exit 1
         fi

sodalite/core/action.py

@@ -1,9 +1,9 @@
 from typing import Callable
 
+import sodalite.ui.mmode
 from sodalite.core import config, action_def
 from sodalite.core.action_def import ActionName
-from sodalite.ui import viewmodel
-from sodalite.ui.viewmodel import Mode
+from sodalite.ui.mmode import Mode
 
 
 class Action:
@@ -17,7 +17,7 @@ def __init__(self, name: ActionName, action: Callable[[], None], modes: list[Mod
 
     def handle(self, key: str) -> bool:
         if key == self.keybinding:
-            if self.is_global or viewmodel.global_mode in self.modes:
+            if self.is_global or sodalite.ui.mmode.global_mode in self.modes:
                 self.action()
                 return True
         return False

sodalite/core/hook.py

@@ -5,6 +5,7 @@
 
 from sodalite.core import config
 from sodalite.core.config import HooksConfig
+from sodalite.ui import notify
 
 if TYPE_CHECKING:
     from sodalite.core.entry import Entry
@@ -36,6 +37,8 @@ def trigger(self, entry: 'Entry') -> None:
         logger.info(f"Executing command: {self.action}")
         result = os.system(f"( {self.action} ) > /dev/tty < /dev/tty")
         logger.info(f"Result is {result}")
+        if result != 0:
+            notify.show_error(f"command failed with exit code {result}")
         from sodalite.ui import graphics
         if self.finally_exit:
             graphics.exit(cwd=entry.path)

sodalite/core/sodalite.conf

@@ -69,13 +69,13 @@ hooks:
       action: 'sodalite-open "$entry" 2> /dev/null'
       label: open
   plain_text:
-    v:
-      action: 'vim "$entry"'
-      label: vim
-  executable:
     e:
+      action: '${EDITOR:-$(which vim || which vi || which nano || echo NO_EDITOR_FOUND)} "$entry"'
+      label: edit
+  executable:
+    r:
       action: 'exec "$entry"'
-      label: execute
+      label: run
   custom:
     archive:
       extensions: [xz]

sodalite/ui/control.py

@@ -4,16 +4,17 @@
 from typing import TYPE_CHECKING
 
 import pyperclip
-from urwid import AttrSpec
 
+import sodalite.ui.mmode
 from sodalite.core import key as key_module, hook, buffer, operate, Navigator
 from sodalite.core.action import Action
 from sodalite.core.action_def import ActionName
 from sodalite.core.entry import Entry
 from sodalite.core.key import Key
-from sodalite.ui import graphics, viewmodel, notify, theme
+from sodalite.ui import graphics, notify
 from sodalite.ui.entrylist import EntryList
-from sodalite.ui.viewmodel import Mode, ViewModel
+from sodalite.ui.mmode import Mode
+from sodalite.ui.viewmodel import ViewModel
 from sodalite.util import pubsub
 
 if TYPE_CHECKING:
@@ -95,9 +96,9 @@ def handle_keypress(self, size: Tuple[int, int], key: str):
                         if _action.handle(key):
                             break
         except PermissionError:
-            notify.show((AttrSpec(theme.forbidden + ',bold', '', colors=16), "PERMISSION DENIED"))
+            notify.show_error("PERMISSION DENIED")
         except FileNotFoundError:
-            notify.show((AttrSpec(theme.forbidden + ',bold', '', colors=16), "FILE NOT FOUND"))
+            notify.show_error("FILE NOT FOUND")
 
     def handle_key_individually(self, key):
         pass
@@ -117,17 +118,17 @@ def abort(self) -> None:
         graphics.exit()
 
     def enter_navigate_mode(self) -> None:
-        viewmodel.global_mode.mode = Mode.NAVIGATE
+        sodalite.ui.mmode.global_mode.mode = Mode.NAVIGATE
         self.list.render(self.list_size, True)
 
     def enter_assign_mode(self) -> None:
         if self.model.current_entry.is_dir:
-            viewmodel.global_mode.mode = Mode.ASSIGN_CHOOSE_ENTRY
+            sodalite.ui.mmode.global_mode.mode = Mode.ASSIGN_CHOOSE_ENTRY
             self.list.render(self.list_size, True)
 
     def enter_operate_mode(self) -> None:
         if self.model.current_entry.is_dir:
-            viewmodel.global_mode.mode = Mode.OPERATE
+            sodalite.ui.mmode.global_mode.mode = Mode.OPERATE
             self.list.render(self.list_size, True)
 
     def trigger_filter(self) -> None:
@@ -243,25 +244,25 @@ def __init__(self, frame: 'MainFrame'):
         self.actions = actions
 
     def handle_key_individually(self, key):
-        if viewmodel.global_mode == Mode.ASSIGN_CHOOSE_ENTRY and self.navigator.is_navigation_key(key):
+        if sodalite.ui.mmode.global_mode == Mode.ASSIGN_CHOOSE_ENTRY and self.navigator.is_navigation_key(key):
             self.choose_entry(key)
             return True
-        elif viewmodel.global_mode == Mode.ASSIGN_CHOOSE_KEY and key_module.is_navigation_key(key):
+        elif sodalite.ui.mmode.global_mode == Mode.ASSIGN_CHOOSE_KEY and key_module.is_navigation_key(key):
             self.assign_key(key)
             return True
 
     def exit(self) -> None:
-        if viewmodel.global_mode == Mode.ASSIGN_CHOOSE_ENTRY:
-            viewmodel.global_mode.mode = Mode.ASSIGN_CHOOSE_KEY
+        if sodalite.ui.mmode.global_mode == Mode.ASSIGN_CHOOSE_ENTRY:
+            sodalite.ui.mmode.global_mode.mode = Mode.ASSIGN_CHOOSE_KEY
 
     def choose_entry(self, key: str) -> None:
         if key in key_module.get_all_keys():
             entry = self.navigator.current_entry.get_child_for_key(Key(key))
             assert entry
             self.list.select(entry)
-            viewmodel.global_mode.mode = Mode.ASSIGN_CHOOSE_KEY
+            sodalite.ui.mmode.global_mode.mode = Mode.ASSIGN_CHOOSE_KEY
         elif key == 'enter':
-            viewmodel.global_mode.mode = Mode.ASSIGN_CHOOSE_KEY
+            sodalite.ui.mmode.global_mode.mode = Mode.ASSIGN_CHOOSE_KEY
 
     def assign_key(self, key: str):
         if key_module.is_navigation_key(key):

sodalite/ui/entrylist.py

@@ -5,6 +5,7 @@
 import urwid
 from urwid import AttrSpec, ListBox
 
+import sodalite.ui.mmode
 from sodalite.core.entry import Entry
 from sodalite.core.navigate import Navigator
 from sodalite.ui import theme, graphics, viewmodel
@@ -82,7 +83,7 @@ def render(self, size, focus=False):
         caption = "    " + key + "    "
         text = self.entry.name
         display = caption + text
-        if focus and viewmodel.global_mode in viewmodel.ANY_ASSIGN_MODE:
+        if focus and sodalite.ui.mmode.global_mode in viewmodel.ANY_ASSIGN_MODE:
             color = AttrSpec(self.color.foreground + ',standout', self.color.background, colors=16)
         else:
             color = self.color

sodalite/ui/graphics.py

@@ -14,7 +14,8 @@
 from sodalite.ui.help import HelpLauncher
 from sodalite.ui.hookbox import HookBox
 from sodalite.ui.mainpane import MainPane
-from sodalite.ui.viewmodel import ViewModel, Mode
+from sodalite.ui.viewmodel import ViewModel
+from sodalite.ui.mmode import Mode
 from sodalite.util import env, pubsub
 
 logger = logging.getLogger(__name__)

sodalite/ui/mmode.py

@@ -0,0 +1,32 @@
+from enum import Enum
+
+from sodalite.util import pubsub
+
+
+class Mode(Enum):
+    NAVIGATE = 1
+    ASSIGN_CHOOSE_ENTRY = 2
+    ASSIGN_CHOOSE_KEY = 3
+    OPERATE = 4
+
+
+class GlobalMode:
+
+    def __init__(self):
+        super().__init__()
+        self.mode = Mode.NAVIGATE
+
+    @property
+    def mode(self):
+        return self._mode
+
+    @mode.setter
+    def mode(self, mode: Mode):
+        self._mode = mode
+        pubsub.mode_send(self._mode)
+
+    def __eq__(self, other):
+        return self._mode == other or super.__eq__(self, other)
+
+
+global_mode = GlobalMode()

sodalite/ui/notify.py

@@ -5,8 +5,9 @@
 import urwid
 from urwid import AttrSpec
 
-from sodalite.ui import graphics, theme, viewmodel
-from sodalite.ui.viewmodel import Mode
+import sodalite.ui.mmode
+from sodalite.ui import theme, mmode
+from sodalite.ui.mmode import Mode
 from sodalite.util import pubsub
 
 txt = urwid.AttrMap(urwid.Text('', align='center'), urwid.DEFAULT)
@@ -26,9 +27,19 @@ def show(message: Union[str, Tuple[AttrSpec, str]], duration: float = 1.5) -> No
     thread.start()
 
 
+def show_error(message: str, duration: float = 1.5) -> None:
+    """
+    Triggers a notification
+    :param message: the error to display
+    :param duration: if set to 0, the message is displayed until another call to 'show' or 'clear'
+    """
+    show((AttrSpec(theme.forbidden + ',bold', '', colors=16), message), duration)
+
+
 def _show(message: Union[str, Tuple[AttrSpec, str]], duration: float) -> None:
     global _last_message
     global _original_footer
+    from sodalite.ui import graphics
     frame = graphics.frame
     if _notify_lock.locked() and _last_message == message:
         return
@@ -48,15 +59,16 @@ def _show(message: Union[str, Tuple[AttrSpec, str]], duration: float) -> None:
 
 
 def clear() -> None:
+    from sodalite.ui import graphics
     if graphics.frame and graphics.frame.footer == _notify_box:
         graphics.frame.footer = None
         graphics.draw_screen()
 
 
 def trigger_notifications(mode: Mode) -> None:
-    if viewmodel.global_mode == Mode.ASSIGN_CHOOSE_ENTRY:
+    if mmode.global_mode == Mode.ASSIGN_CHOOSE_ENTRY:
         show("choose entry", duration=0)
-    elif viewmodel.global_mode == Mode.ASSIGN_CHOOSE_KEY:
+    elif sodalite.ui.mmode.global_mode == Mode.ASSIGN_CHOOSE_KEY:
         show("choose new key", duration=0)
     else:
         clear()

sodalite/ui/theme.py

@@ -1,7 +1,7 @@
 import urwid
 from pygments import token
 
-from sodalite.ui.viewmodel import Mode
+from sodalite.ui.mmode import Mode
 from sodalite.util import pubsub
 
 file = urwid.WHITE

sodalite/ui/viewmodel.py

@@ -1,50 +1,20 @@
 import logging
 import re
 import sre_constants
-from enum import Enum
 from re import Pattern
 from typing import Optional
 
 from sodalite.core.entry import Entry
 from sodalite.ui import highlighting
 from sodalite.ui.highlighting import HighlightedLine
+from sodalite.ui.mmode import Mode
 from sodalite.util import pubsub
 
 logger = logging.getLogger(__name__)
 
-
-class Mode(Enum):
-    NAVIGATE = 1
-    ASSIGN_CHOOSE_ENTRY = 2
-    ASSIGN_CHOOSE_KEY = 3
-    OPERATE = 4
-
-
 ANY_ASSIGN_MODE = (Mode.ASSIGN_CHOOSE_KEY, Mode.ASSIGN_CHOOSE_ENTRY)
 
 
-class GlobalMode:
-
-    def __init__(self):
-        super().__init__()
-        self.mode = Mode.NAVIGATE
-
-    @property
-    def mode(self):
-        return self._mode
-
-    @mode.setter
-    def mode(self, mode: Mode):
-        self._mode = mode
-        pubsub.mode_send(self._mode)
-
-    def __eq__(self, other):
-        return self._mode == other or super.__eq__(self, other)
-
-
-global_mode = GlobalMode()
-
-
 class ViewModel:
 
     def __init__(self) -> None:

sodalite/util/pubsub.py

@@ -4,7 +4,7 @@
 
 if TYPE_CHECKING:
     from sodalite.core.entry import Entry
-    from sodalite.ui.viewmodel import Mode
+    from sodalite.ui.mmode import Mode
     from sodalite.ui.highlighting import HighlightedLine