Merge lp:~ipv64ever/terminator/custom_commands_plugin_complex_cmd into lp:terminator/gtk3

[Korotin Igor]

Custom Commands Plugin: Added complex option.

This option enables parsing of special characters in command:
  \n - send new line
  \p - add 1 sec delay

This new option doesn't conflict with old Custom Command config.
By default all existing commands get this option disabled

Added unit tests of command parsing command.

At this moment Custom commands plugin allow to send only one string with ending '\n' character.

I suggest to add ability to create complex command. Each part of command is sent one by one.
For example command "command1\ncommand2\ncommand3" will be made as following:

'command1\n'
'command2\n'
'command3\n'

There's also an ability to add delays between commands using "\p" chars.
Example 'command1\n\pcommand2\n\p\pcommand3' will be made as following:

'command1\n'
1 sec delay
'command2\n'
2 sec delay
'command3\n'

Command parsing affects only on these two "\n" and "\p" characters in command

I use terminator in my work and i often have to login on embedded boards remotely through serial port.
Each time i type login, then send password using custom command, then sudo su and finally root password again. It's anoying especially when i have to do it a lot.

Unmerged revisions

1811. By Igor Korotin <email address hidden> on 2018-11-14

Custom Commands Plugin: Added complex option.

This option enables parsing of special characters in command:
  \n - send new line
  \p - add 1 sec delay

This new option doesn't conflict with old Custom Command config.
By default all existing commands get this option disabled

Added unit tests of command parsing command.

=== modified file 'terminatorlib/plugins/custom_commands.py'
--- terminatorlib/plugins/custom_commands.py	2017-02-06 11:09:36 +0000
+++ terminatorlib/plugins/custom_commands.py	2018-11-14 13:07:15 +0000
@@ -4,11 +4,16 @@
 """custom_commands.py - Terminator Plugin to add custom command menu entries"""
 import sys
 import os
+import re
+import threading
 
 # Fix imports when testing this file directly
 if __name__ == '__main__':
+  print os.path.dirname(__file__)
   sys.path.append( os.path.join(os.path.dirname(__file__), "../.."))
 
+import gi
+gi.require_version('Gtk', '3.0')
 from gi.repository import Gtk
 from gi.repository import GObject
 import terminatorlib.plugin as plugin
@@ -16,7 +21,7 @@
 from terminatorlib.translation import _
 from terminatorlib.util import get_config_dir, err, dbg, gerr
 
-(CC_COL_ENABLED, CC_COL_NAME, CC_COL_COMMAND) = range(0,3)
+(CC_COL_ENABLED, CC_COL_NAME, CC_COL_COMMAND,CC_COL_COMPLEX) = range(0,4)
 
 # Every plugin you want Terminator to load *must* be listed in 'AVAILABLE'
 AVAILABLE = ['CustomCommandsMenu']
@@ -30,6 +35,7 @@
     def __init__( self):
       config = Config()
       sections = config.plugin_get_config(self.__class__.__name__)
+
       if not isinstance(sections, dict):
           return
       noord_cmds = []
@@ -41,16 +47,22 @@
         name = s["name"]
         command = s["command"]
         enabled = s["enabled"] and s["enabled"] or False
+        if not (s.has_key("complex")):
+            cmplx = False
+        else:
+            cmplx = s["complex"] and s["complex"] or False
         if s.has_key("position"):
           self.cmd_list[int(s["position"])] = {'enabled' : enabled,
                                                'name' : name,
-                                               'command' : command
+                                               'command' : command,
+                                               'complex' : cmplx
                                               }
         else:
           noord_cmds.append(
                               {'enabled' : enabled,
                                 'name' : name,
-                                'command' : command
+                                'command' : command,
+                                'complex' : cmplx
                               }
                             )
         for cmd in noord_cmds:
@@ -100,7 +112,7 @@
           else:
             menuitem = Gtk.MenuItem(leaf_name)
           terminals = terminal.terminator.get_target_terms(terminal)
-          menuitem.connect("activate", self._execute, {'terminals' : terminals, 'command' : command['command'] })
+          menuitem.connect("activate", self._execute, {'terminals' : terminals, 'command' : command['command'], 'complex' : command['complex'] })
           target_submenu.append(menuitem)
         
     def _save_config(self):
@@ -109,6 +121,7 @@
       i = 0
       for command in [ self.cmd_list[key] for key in sorted(self.cmd_list.keys()) ] :
         enabled = command['enabled']
+        cmplx = command['complex']
         name = command['name']
         command = command['command']
        
@@ -116,18 +129,60 @@
         item['enabled'] = enabled
         item['name'] = name
         item['command'] = command
+        item['complex'] = cmplx
         item['position'] = i
 
         config.plugin_set(self.__class__.__name__, name, item)
         i = i + 1
       config.save()
 
+    def _parse(self, command_str):
+      ret_command_list = []
+      command_list = command_str.split("\\n")
+      delay=0
+
+      for idx, line in enumerate(command_list):
+        if line == '':
+          line = '\n'
+          ret_command_list.append({'command': line, 'delay': delay})
+        else:
+          if line[-1] != '\n':
+            line = line + '\n'
+            # We've got separete command but it might have some other special characters
+            # So first of all - check whether line contains them.
+          obj = re.search(r"(?:\\p)", line)
+          if obj:
+            # Using 0x00 char to parse string.
+            _list = list(filter(None, re.sub(r"(?:\\p)", '\0\\p\0', line).split('\0')))
+            for part in _list:
+              if part == '\\p':
+                delay += 1;
+              else:
+                ret_command_list.append({'command': part, 'delay': delay})
+                delay = 0;
+          else:
+            ret_command_list.append({'command': line, 'delay': delay})
+      return ret_command_list
+
+    def deferred_execute(self, terminal, command, rest_command_list):
+      terminal.vte.feed_child(command, len(command))
+      if rest_command_list:
+        threading.Timer(rest_command_list[0]['delay'], self.deferred_execute, [terminal, rest_command_list[0]['command'], rest_command_list[1:]]).start()
+
     def _execute(self, widget, data):
-      command = data['command']
-      if command[-1] != '\n':
-        command = command + '\n'
-      for terminal in data['terminals']:
-        terminal.vte.feed_child(command,  len(command))
+      cmplx = data['complex']
+
+      if cmplx:
+        command_list = self._parse(data['command'])
+        for terminal in data['terminals']:
+          threading.Timer(command_list[0]['delay'], self.deferred_execute, [terminal, command_list[0]['command'], command_list[1:]]).start()
+            
+      else:  
+        command = data['command']
+        if command[-1] != '\n':
+          command = command + '\n'
+        for terminal in data['terminals']:
+          terminal.vte.feed_child(command,  len(command))
 
     def configure(self, widget, data = None):
       ui = {}
@@ -150,10 +205,10 @@
         icon = dbox.render_icon(Gtk.STOCK_DIALOG_INFO, Gtk.IconSize.BUTTON)
         dbox.set_icon(icon)
 
-      store = Gtk.ListStore(bool, str, str)
+      store = Gtk.ListStore(bool, str, str, bool)
 
       for command in [ self.cmd_list[key] for key in sorted(self.cmd_list.keys()) ]:
-        store.append([command['enabled'], command['name'], command['command']])
+        store.append([command['enabled'], command['name'], command['command'], command['complex']])
  
       treeview = Gtk.TreeView(store)
       #treeview.connect("cursor-changed", self.on_cursor_changed, ui)
@@ -163,7 +218,7 @@
       ui['treeview'] = treeview
 
       renderer = Gtk.CellRendererToggle()
-      renderer.connect('toggled', self.on_toggled, ui)
+      renderer.connect('toggled', self.on_toggled_enabled, ui)
       column = Gtk.TreeViewColumn(_("Enabled"), renderer, active=CC_COL_ENABLED)
       treeview.append_column(column)
 
@@ -175,6 +230,11 @@
       column = Gtk.TreeViewColumn(_("Command"), renderer, text=CC_COL_COMMAND)
       treeview.append_column(column)
 
+      renderer = Gtk.CellRendererToggle()
+      renderer.connect('toggled', self.on_toggled_complex, ui)
+      column = Gtk.TreeViewColumn(_("Complex"), renderer, active=CC_COL_COMPLEX)
+      treeview.append_column(column)
+
       scroll_window = Gtk.ScrolledWindow()
       scroll_window.set_size_request(500, 250)
       scroll_window.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
@@ -246,28 +306,43 @@
         self.cmd_list = {}
         i=0
         while iter:
-          (enabled, name, command) = store.get(iter,
+          (enabled, name, command, cmplx) = store.get(iter,
                                               CC_COL_ENABLED,
                                               CC_COL_NAME,
-                                              CC_COL_COMMAND)
+                                              CC_COL_COMMAND,
+                                              CC_COL_COMPLEX)
           self.cmd_list[i] = {'enabled' : enabled,
                             'name': name,
-                            'command' : command}
+                            'command' : command,
+                            'complex' : cmplx}
           iter = store.iter_next(iter)
           i = i + 1
       
 
-    def on_toggled(self, widget, path, data):
+    def on_toggled_enabled(self, widget, path, data):
       treeview = data['treeview']
       store = treeview.get_model()
       iter = store.get_iter(path)
-      (enabled, name, command) = store.get(iter,
+      (enabled, name, command, cmplx) = store.get(iter,
                                     CC_COL_ENABLED,
                                     CC_COL_NAME,
-                                    CC_COL_COMMAND
+                                    CC_COL_COMMAND,
+                                    CC_COL_COMPLEX
                                         )
       store.set_value(iter, CC_COL_ENABLED, not enabled)
 
+    def on_toggled_complex(self, widget, path, data):
+      treeview = data['treeview']
+      store = treeview.get_model()
+      iter = store.get_iter(path)
+      (enabled, name, command, cmplx) = store.get(iter,
+                                    CC_COL_ENABLED,
+                                    CC_COL_NAME,
+                                    CC_COL_COMMAND,
+                                    CC_COL_COMPLEX
+                                        )
+      store.set_value(iter, CC_COL_COMPLEX, not cmplx)
+
 
     def on_selection_changed(self,selection, data=None):
       treeview = selection.get_tree_view()
@@ -279,7 +354,7 @@
       data['button_edit'].set_sensitive(iter is not None)
       data['button_delete'].set_sensitive(iter is not None)
 
-    def _create_command_dialog(self, enabled_var = False, name_var = "", command_var = ""):
+    def _create_command_dialog(self, enabled_var = False, name_var = "", command_var = "",cmplx_var = False):
       dialog = Gtk.Dialog(
                         _("New Command"),
                         None,
@@ -290,7 +365,7 @@
                         )
                       )
       dialog.set_transient_for(self.dbox)
-      table = Gtk.Table(3, 2)
+      table = Gtk.Table(6, 2)
 
       label = Gtk.Label(label=_("Enabled:"))
       table.attach(label, 0, 1, 0, 1)
@@ -309,19 +384,28 @@
       command = Gtk.Entry()
       command.set_text(command_var)
       table.attach(command, 1, 2, 2, 3)
+      
+      label = Gtk.Label(label=_("Complex:"))
+      table.attach(label, 0, 1, 3, 4)
+      cmplx = Gtk.CheckButton()
+      cmplx.set_active(cmplx_var)
+      table.attach(cmplx, 1, 2, 3, 4)
+      label = Gtk.Label(label=_('Complex Help: \n  \\n - send end of line\n  \\p - add 1 second delay'))
+      table.attach(label, 0, 2, 4, 6)
 
       dialog.vbox.pack_start(table, True, True, 0)
       dialog.show_all()
-      return (dialog,enabled,name,command)
+      return (dialog,enabled,name,command,cmplx)
 
     def on_new(self, button, data):
-      (dialog,enabled,name,command) = self._create_command_dialog()
+      (dialog,enabled,name,command,cmplx) = self._create_command_dialog()
       res = dialog.run()
       item = {}
       if res == Gtk.ResponseType.ACCEPT:
         item['enabled'] = enabled.get_active()
         item['name'] = name.get_text()
         item['command'] = command.get_text()
+        item['complex'] = cmplx.get_active()
         if item['name'] == '' or item['command'] == '':
           err = Gtk.MessageDialog(dialog,
                                   Gtk.DialogFlags.MODAL,
@@ -342,7 +426,7 @@
               break
             iter = store.iter_next(iter)
           if not name_exist:
-            store.append((item['enabled'], item['name'], item['command']))
+            store.append((item['enabled'], item['name'], item['command'], item['complex']))
           else:
             gerr(_("Name *%s* already exist") % item['name'])
       dialog.destroy()
@@ -421,10 +505,11 @@
       if not iter:
         return
        
-      (dialog,enabled,name,command) = self._create_command_dialog(
+      (dialog,enabled,name,command,cmplx) = self._create_command_dialog(
                                                 enabled_var = store.get_value(iter, CC_COL_ENABLED),
                                                 name_var = store.get_value(iter, CC_COL_NAME),
-                                                command_var = store.get_value(iter, CC_COL_COMMAND)
+                                                command_var = store.get_value(iter, CC_COL_COMMAND),
+                                                cmplx_var = store.get_value(iter, CC_COL_COMPLEX)
                                                                   )
       res = dialog.run()
       item = {}
@@ -432,6 +517,7 @@
         item['enabled'] = enabled.get_active()
         item['name'] = name.get_text()
         item['command'] = command.get_text()
+        item['complex'] = cmplx.get_active()
         if item['name'] == '' or item['command'] == '':
           err = Gtk.MessageDialog(dialog,
                                   Gtk.DialogFlags.MODAL,
@@ -453,7 +539,8 @@
             store.set(iter,
                       CC_COL_ENABLED,item['enabled'],
                       CC_COL_NAME, item['name'],
-                      CC_COL_COMMAND, item['command']
+                      CC_COL_COMMAND, item['command'],
+                      CC_COL_COMPLEX, item['complex']
                       )
           else:
             gerr(_("Name *%s* already exist") % item['name'])

=== added file 'tests/test_custom_command_parser.py'
--- tests/test_custom_command_parser.py	1970-01-01 00:00:00 +0000
+++ tests/test_custom_command_parser.py	2018-11-14 13:07:15 +0000
@@ -0,0 +1,31 @@
+#!/usr/bin/env python2
+# Terminator by Chris Jones <[e-mail]>
+# GPL v2 only
+# File created by Igor Korotin <[e-mail]>
+
+import unittest
+import re
+import os
+import sys, os.path
+sys.path.insert(0, os.path.realpath(os.path.join(os.path.dirname(__file__), "..")))
+
+from terminatorlib.plugins.custom_commands import CustomCommandsMenu
+
+class TestCustomCommandParser(unittest.TestCase):
+    def test_parse(self):
+        menu = CustomCommandsMenu()
+        self.assertEqual(menu._parse(      "word"),       [{ 'command': 'word\n'      , 'delay': 0}])
+        self.assertEqual(menu._parse(   "\\nword"),       [{ 'command': '\n'          , 'delay': 0}, { 'command': 'word\n', 'delay': 0}])
+        self.assertEqual(menu._parse(   "\\nword\\n\\n"), [{ 'command': '\n'          , 'delay': 0}, { 'command': 'word\n', 'delay': 0}, {'command': '\n', 'delay': 0}, {'command': '\n', 'delay': 0}])
+        self.assertEqual(menu._parse(   "\\pword"),       [{ 'command': 'word\n'      , 'delay': 1}])
+        self.assertEqual(menu._parse("\\p\\pword"),       [{ 'command': 'word\n'      , 'delay': 2}])
+        self.assertEqual(menu._parse(" \\\\pword"),       [{ 'command': ' \\'         , 'delay': 0}, { 'command': 'word\n', 'delay': 1}])
+        self.assertEqual(menu._parse(     " word"),       [{ 'command': ' word\n'     , 'delay': 0}])
+        self.assertEqual(menu._parse(  "\\p word"),       [{ 'command': ' word\n'     , 'delay': 1}])
+        self.assertEqual(menu._parse(      "word\\p"),    [{ 'command': 'word'        , 'delay': 0}, { 'command': '\n'    , 'delay': 1}])
+        self.assertEqual(menu._parse("\\pword\\pword"),   [{ 'command': 'word'        , 'delay': 1}, { 'command': 'word\n', 'delay': 1}])
+        self.assertEqual(menu._parse("\\pword\\word"),    [{ 'command': 'word\\word\n', 'delay': 1}])
+        self.assertEqual(menu._parse("\\p\\nword\\n\\p"), [{ 'command': '\n'          , 'delay': 1}, { 'command': 'word\n', 'delay': 0}, {'command': '\n', 'delay': 1}])
+
+if __name__ == '__main__':
+    unittest.main()