Added dotoolc support. Closes #179

Author: firecat53

README.md

@@ -29,7 +29,7 @@ For full installation documention see the [installation docs][docs/install.md].
 3. Bemenu, Dmenu, Wmenu, Fuzzel, Rofi, Tofi, Wofi, or Yofi
 4. xsel or wl-copy
 5. (optional) Pinentry
-6. (optional) xdotool (for X), [ydotool][10] or [wtype][11](for Wayland), [dotool][12] (X or Wayland).
+6. (optional) xdotool (for X), [ydotool][10] or [wtype][11](for Wayland), [dotool][12] or dotoolc (X or Wayland).
 
 ## Features
 

config.ini.example

@@ -29,7 +29,7 @@
 # editor = <path/to/terminal editor> 'vim' by default
 # terminal = <xterm, urxvt> <options if necessary>. 'xterm' by default
 # gui_editor = <path/to/editor> <options>  e.g. gui_editor = gvim -f
-# type_library = pynput (default), xdotool (for alternate keyboard layout support), ydotool (for Wayland), or wtype (also for Wayland)
+# type_library = pynput (default), xdotool (for alternate keyboard layout support), ydotool (for Wayland), wtype (also for Wayland), dotool, or dotoolc (dotool client for dotoold daemon)
 # hide_groups = Recycle Bin  <Note formatting for adding multiple groups>
 #               Group 2
 #               Group 3

docs/configure.md

@@ -28,7 +28,7 @@ Alternatively you can specify the file path to your config.ini using the -c/--co
 |                           | `editor`                     | `vim`                                   |                                                              |
 |                           | `terminal`                   | `xterm`                                 |                                                              |
 |                           | `gui_editor`                 | None                                    |                                                              |
-|                           | `type_library`               | `pynput`                                | xdotool, ydotool, wtype  or pynput                           |
+|                           | `type_library`               | `pynput`                                | xdotool, ydotool, wtype, dotool, dotoolc or pynput           |
 |                           | `hide_groups`                | None                                    | See below for formatting of multiple groups                  |
 |                           | `autotype_default`           | `{USERNAME}{TAB}{PASSWORD}{ENTER}`      | [Keepass autotype sequences][1]                              |
 |                           | `type_url`                   | `False`                                 |                                                              |

docs/install.md

@@ -11,9 +11,9 @@
 4. (optional) Pinentry. Make sure to set which flavor of pinentry command to use
    in the config file.
 5. (optional) xdotool (for X) or ydotool (>=1.0.0, for Wayland), wtype (for
-   Wayland), dotool (X or Wayland). If you have a lot of Unicode characters or
-   use a non-U.S. English keyboard layout, you might have to experiment with
-   these to determine which works properly for your use case.
+   Wayland), dotool/dotoolc (X or Wayland). If you have a lot of
+   Unicode characters or use a non-U.S. English keyboard layout, you might have
+   to experiment with these to determine which works properly for your use case.
 
 #### Archlinux
 

keepmenu/__init__.py

@@ -6,6 +6,7 @@
 import locale
 import os
 import shlex
+import shutil
 from subprocess import run, DEVNULL
 import sys
 from os.path import exists, expanduser
@@ -99,6 +100,11 @@ def reload_config(conf_file = None):  # pylint: disable=too-many-statements,too-
                     dmenu_err(f"{typ} not installed.\n"
                               "Please install or remove that option from config.ini")
                     sys.exit()
+        if CONF.get("database", "type_library") == "dotoolc":
+            if shutil.which("dotoolc") is None:
+                dmenu_err("dotoolc not installed.\n"
+                          "Please install or remove that option from config.ini")
+                sys.exit()
     if os.environ.get('WAYLAND_DISPLAY'):
         clips = ['wl-copy -o']
     else:

keepmenu/type.py

@@ -122,7 +122,8 @@ def type_entry(entry, db_autotype=None):
                  'xdotool': type_entry_xdotool,
                  'ydotool': type_entry_ydotool,
                  'wtype': type_entry_wtype,
-                 'dotool': type_entry_dotool}
+                 'dotool': type_entry_dotool,
+                 'dotoolc': type_entry_dotoolc}
     library = keepmenu.CONF.get('database', 'type_library', fallback='pynput')
     libraries.get(library, type_entry_pynput)(entry, tokens)
 
@@ -340,6 +341,35 @@ def type_entry_dotool(entry, tokens):
             _ = run(['dotool'], check=True, encoding=keepmenu.ENC, input=f"type {token}")
 
 
+def type_entry_dotoolc(entry, tokens):
+    """Auto-type entry entry using dotoolc (client for dotoold daemon)
+
+    """
+    from .tokens_dotool import AUTOTYPE_TOKENS
+    for token, special in tokens:
+        if special:
+            cmd = token_command(token)
+            if callable(cmd):
+                to_type = cmd(entry)  # pylint: disable=not-callable
+                if to_type is not None:
+                    _ = run(['dotoolc'], check=True, encoding=keepmenu.ENC, input=f"type {to_type}")
+            elif token in PLACEHOLDER_AUTOTYPE_TOKENS:
+                to_type = PLACEHOLDER_AUTOTYPE_TOKENS[token](entry)
+                if to_type:
+                    _ = run(['dotoolc'], check=True, encoding=keepmenu.ENC, input=f"type {to_type}")
+            elif token in STRING_AUTOTYPE_TOKENS:
+                to_type = STRING_AUTOTYPE_TOKENS[token]
+                _ = run(['dotoolc'], check=True, encoding=keepmenu.ENC, input=f"type {to_type}")
+            elif token in AUTOTYPE_TOKENS:
+                to_type = " ".join(AUTOTYPE_TOKENS[token])
+                _ = run(['dotoolc'], check=True, encoding=keepmenu.ENC, input=to_type)
+            else:
+                dmenu_err(f"Unsupported auto-type token (dotoolc): \"{token}\"")
+                return
+        else:
+            _ = run(['dotoolc'], check=True, encoding=keepmenu.ENC, input=f"type {token}")
+
+
 def type_text(data):
     """Type the given text data
 
@@ -358,6 +388,8 @@ def type_text(data):
         call(['wtype', '--', data])
     elif library == 'dotool':
         _ = run(['dotool'], check=True, encoding=keepmenu.ENC, input=f"type {data}")
+    elif library == 'dotoolc':
+        _ = run(['dotoolc'], check=True, encoding=keepmenu.ENC, input=f"type {data}")
     else:
         try:
             from pynput import keyboard