Merge lp:~sprataa/terminator/layoutsonsteroids into lp:terminator/gtk3

[Sérgio Prata Almeida]

This commit is a PoC on how to improve Layout Saving mechanism further and allow automation;

Changelog:

Added virtualenvwrapper Virtual Environment setting to Terminal Layout;
Added Save Layout shortcut to Popup/Context Menu;
Saving a Layout now detects shell child processes and saves it in "Custom Command" field;
Changed "Custom Command" mechanism in order to be ran in child shell via input instead of using -c "command";
Improved PWD/CWD detection;
Added save_layout and push_environment to IPC/DBus Methods;

Example DBUS shell functions and usage:

function push_environment {
 if [ TERMINATOR_UUID ]
 then
  env=`env | egrep "TERMINATOR_UUID|VIRTUAL_ENV|PWD"`
  dbus-send --session --type=method_call --dest=$TERMINATOR_DBUS_NAME /net/tenshu/Terminator2 $TERMINATOR_DBUS_NAME.push_environment string:"$env" &>/dev/null
 fi
}

function save_layout {
 if [ TERMINATOR_UUID ]
 then
  push_environment
  dbus-send --session --type=method_call --dest=$TERMINATOR_DBUS_NAME /net/tenshu/Terminator2 $TERMINATOR_DBUS_NAME.save_layout &>/dev/null
 fi
}

push_environment needs to be called from each terminal's child shell in order to inform terminator of the current environment.
The only place where you can access the current shell's environment. TERMINATOR_UUID needs to be sent in order to determine where it came from.

I currently have push_environment ran every time my shell's prompt is redrawn but this is optional.
You can run push_environment on each terminal you wish to update Virtual Environment and Working Directory.
Be advised that you still need to call save_layout function, "Save Layout" via the context menu or press "Save" in Layout Preferences window.

[Sérgio Prata Almeida (sprataa)]

Greetings! First of all, thank you all for allowing Terminator to thrive!

These changes have been thoroughly tested and are being used daily for a week or so. I confess, mostly with the 'default' profile. Other than the 'default' profile have also been tested but now so much.

Totally changed mine and a couple of co-worker's lives for the better. Saving/Restoring SSH Sessions without having to dial it in manually every time has become priceless - especially because Preferences-Layouts-Save clears the Working Directory and Custom Command fields - not cool.

With these small changes, we turned our static profiles into dynamic, ever-evolving and self updating profiles. Auto-saving should also be present (there is a guy that wants it because he forgets to save) but I didn't want to break Terminator's architecture further before discussing the best way to do it with Terminator's team. Ideally we should add an option to auto-save and define the interval. Well, save_layout can also be called on every prompt but it makes every prompt significantly slower this we are all currently saving it manually either via the context menu or by running the save_layout function in a shell. push_environment on every prompt is unnoticeable for all of us. My suggested shell push_environment function is not optimal but it does the job.

Yes, every user has to add the functions and the every prompt behaviour manually to it's bashrc/zshrc. Examples:

[ ${ZSH_VERSION} ] && precmd() { push_environment; }
[ ${BASH_VERSION} ] && PROMPT_COMMAND=push_environment

We can also create a profile.d/XX-terminator.sh to be included that adds these hooks automatically when TERMINATOR_UUID is present. This behavior could also be controlled via Terminator' Preferences and propagated to child shells by using an extra environment variable such as TERMINATOR_AUTO_REFRESH that the profile.d/XX-terminator.sh would interpret and act accordingly.

Please let me know what you think about my approach and let us work together to make this possible.

Cheers!

Unmerged revisions

1808. By Sérgio Prata Almeida on 2018-10-23

This commit is a PoC on how to improve Layout Saving mechanism further and allow automation;

Changelog:

Added virtualenvwrapper Virtual Environment setting to Terminal Layout;
Added Save Layout shortcut to Popup/Context Menu;
Saving a Layout now detects shell child processes and saves it in "Custom Command" field;
Changed "Custom Command" mechanism in order to be ran in child shell via input instead of using -c "command";
Improved PWD/CWD detection;
Added save_layout and push_environment to IPC/DBus Methods;

-----------------------------------------------

Example DBUS shell functions and usage:

function push_environment {
    if [ TERMINATOR_UUID ]
    then
        env=`env | egrep "TERMINATOR_UUID|VIRTUAL_ENV|PWD"`
        dbus-send --session --type=method_call --dest=$TERMINATOR_DBUS_NAME /net/tenshu/Terminator2 $TERMINATOR_DBUS_NAME.push_environment string:"$env" &>/dev/null
    fi
}

function save_layout {
    if [ TERMINATOR_UUID ]
    then
        push_environment
        dbus-send --session --type=method_call --dest=$TERMINATOR_DBUS_NAME /net/tenshu/Terminator2 $TERMINATOR_DBUS_NAME.save_layout &>/dev/null
    fi
}

push_environment needs to be called from each terminal's child shell in order to inform terminator of the current environment.
The only place where you can access the current shell's environment. TERMINATOR_UUID needs to be sent in order to determine where it came from.

I currently have push_environment ran every time my shell's prompt is redrawn but this is optional.
You can run push_environment on each terminal you wish to update Virtual Environment and Working Directory.
Be advised that you still need to call save_layout function, "Save Layout" via the context menu or press "Save" in Layout Preferences window.

=== modified file 'terminatorlib/ipc.py'
--- terminatorlib/ipc.py	2017-02-13 14:36:55 +0000
+++ terminatorlib/ipc.py	2018-10-23 02:50:13 +0000
@@ -183,6 +183,27 @@
                 if terminal in terms:
                     return root_widget.get_tab_label(tab_child).get_label()
 
+    @dbus.service.method(dbus_interface=BUS_NAME)
+    def push_environment(self, data):
+        environment = {}
+        for line in iter(data.splitlines()):
+            if '=' not in line:
+                environment[var[0]] + line
+            else:
+                var = line.split('=')
+                environment[var[0]] = var[1]
+        dbg('received environment!')
+        dbg(environment)
+        if 'TERMINATOR_UUID' in environment.keys():
+            terminal = self.terminator.find_terminal_by_uuid(environment['TERMINATOR_UUID'])
+            terminal.environment = environment
+
+    @dbus.service.method(dbus_interface=BUS_NAME)
+    def save_layout(self):
+        dbg('received save layout!')
+        self.terminator.save_layout()
+
+
 def with_proxy(func):
     """Decorator function to connect to the session dbus bus"""
     dbg('dbus client call: %s' % func.func_name)

=== modified file 'terminatorlib/preferences.glade'
--- terminatorlib/preferences.glade	2016-12-13 21:08:02 +0000
+++ terminatorlib/preferences.glade	2018-10-23 02:50:13 +0000
@@ -3424,6 +3424,18 @@
                           </packing>
                         </child>
                         <child>
+                          <object class="GtkLabel" id="label44">
+                            <property name="visible">True</property>
+                            <property name="can_focus">False</property>
+                            <property name="label" translatable="yes">Virtual Environment:</property>
+                            <property name="xalign">1</property>
+                          </object>
+                          <packing>
+                            <property name="left_attach">0</property>
+                            <property name="top_attach">3</property>
+                          </packing>
+                        </child>
+                        <child>
                           <object class="GtkComboBoxText" id="layout_profile_chooser">
                             <property name="visible">True</property>
                             <property name="can_focus">False</property>
@@ -3469,6 +3481,21 @@
                             <property name="top_attach">2</property>
                           </packing>
                         </child>
+                        <child>
+                          <object class="GtkEntry" id="layout_profile_virtualenv">
+                            <property name="visible">True</property>
+                            <property name="can_focus">True</property>
+                            <property name="hexpand">True</property>
+                            <property name="invisible_char">•</property>
+                            <property name="primary_icon_activatable">False</property>
+                            <property name="secondary_icon_activatable">False</property>
+                            <signal name="changed" handler="on_layout_profile_virtualenv_changed" swapped="no"/>
+                          </object>
+                          <packing>
+                            <property name="left_attach">1</property>
+                            <property name="top_attach">3</property>
+                          </packing>
+                        </child>
                       </object>
                       <packing>
                         <property name="resize">True</property>

=== modified file 'terminatorlib/prefseditor.py'
--- terminatorlib/prefseditor.py	2017-06-24 02:02:38 +0000
+++ terminatorlib/prefseditor.py	2018-10-23 02:50:13 +0000
@@ -1423,6 +1423,10 @@
         """A different working directory has been entered for this item"""
         self.layouteditor.on_layout_profile_workingdir_activate(widget)
 
+    def on_layout_profile_virtualenv_changed(self, widget):
+        """A different virtualenvironment has been entered for this item"""
+        self.layouteditor.on_layout_profile_virtualenv_activate(widget)
+
     def on_layout_name_edited(self, cell, path, newtext):
         """Update a layout name"""
         oldname = cell.get_property('text')
@@ -1620,9 +1624,11 @@
         command = self.builder.get_object('layout_profile_command')
         chooser = self.builder.get_object('layout_profile_chooser')
         workdir = self.builder.get_object('layout_profile_workingdir')
+        virtualenv = self.builder.get_object('layout_profile_virtualenv')
         command.set_sensitive(False)
         chooser.set_sensitive(False)
         workdir.set_sensitive(False)
+        virtualenv.set_sensitive(False)
 
     def on_layout_item_selection_changed(self, selection):
         """A different item in the layout was selected"""
@@ -1640,16 +1646,20 @@
         command = self.builder.get_object('layout_profile_command')
         chooser = self.builder.get_object('layout_profile_chooser')
         workdir = self.builder.get_object('layout_profile_workingdir')
+        virtualenv = self.builder.get_object('layout_profile_virtualenv')
 
         if layout_item['type'] != 'Terminal':
             command.set_sensitive(False)
             chooser.set_sensitive(False)
             workdir.set_sensitive(False)
+            virtualenv.set_sensitive(False)
             return
 
         command.set_sensitive(True)
         chooser.set_sensitive(True)
         workdir.set_sensitive(True)
+        virtualenv.set_sensitive(True)
+
         if layout_item.has_key('command') and layout_item['command'] != '':
             command.set_text(layout_item['command'])
         else:
@@ -1665,6 +1675,11 @@
         else:
             workdir.set_text('')
 
+        if layout_item.has_key('virtualenv') and layout_item['virtualenv'] != '':
+            virtualenv.set_text(layout_item['virtualenv'])
+        else:
+            virtualenv.set_text('')
+
     def on_layout_profile_chooser_changed(self, widget):
         """A new profile has been selected for this item"""
         if not self.layout_item:
@@ -1688,6 +1703,14 @@
         layout[self.layout_item]['directory'] = workdir
         self.config.save()
 
+    def on_layout_profile_virtualenv_activate(self, widget):
+        """A new virtualenv has been entered for this item"""
+        virtualenv = widget.get_text()
+        layout = self.config.layout_get_config(self.layout_name)
+        layout[self.layout_item]['virtualenv'] = virtualenv
+        self.config.save()
+
+
 if __name__ == '__main__':
     import util
     util.DEBUG = True

=== modified file 'terminatorlib/terminal.py'
--- terminatorlib/terminal.py	2017-06-24 02:02:38 +0000
+++ terminatorlib/terminal.py	2018-10-23 02:50:13 +0000
@@ -12,6 +12,7 @@
 from gi.repository import Vte
 import subprocess
 import urllib
+import psutil
 
 from util import dbg, err, spawn_new_terminator, make_uuid, manual_lookup, display_manager
 import util
@@ -108,6 +109,8 @@
     cnxids = None
     targets_for_new_group = None
 
+    environment = None
+
     def __init__(self):
         """Class initialiser"""
         GObject.GObject.__init__(self)
@@ -176,6 +179,9 @@
         self.reconfigure()
         self.vte.set_size(80, 24)
 
+        self.virtualenv = None
+        self.uuid = None
+
     def get_vte(self):
         """This simply returns the vte widget we are using"""
         return(self.vte)
@@ -1402,8 +1408,10 @@
             else:
                 args.insert(0, shell)
 
-            if command is not None:
-                args += ['-c', command]
+            # This is commented out in order to keep the terminal running after command ends.
+            # Downside is that I figured out no way to run the command without using vte.feed_child
+            #if command is not None:
+            #    args += ['-c', command]
 
         if shell is None:
             self.vte.feed(_('Unable to find a shell'))
@@ -1442,6 +1450,18 @@
             self.vte.feed(_('Unable to start shell:') + shell)
             return(-1)
 
+        if self.virtualenv is not None:
+            virtualenv = 'workon {}'.format(self.virtualenv.split('/')[-1])
+
+            if command is None:
+                command = virtualenv
+            else:
+                command = virtualenv + '\n' + command
+
+        if command is not None:
+            command += '\n'
+            self.vte.feed_child(command, len(command))
+
     def prepare_url(self, urlmatch):
         """Prepare a URL from a VTE match"""
         url = urlmatch[0]
@@ -1621,6 +1641,27 @@
         if title:
             layout['title'] = title
         layout['uuid'] = self.uuid
+
+        if self.environment:
+            if 'VIRTUAL_ENV' in self.environment:
+                layout['virtualenv'] = self.environment['VIRTUAL_ENV']
+            if 'PWD' in self.environment:
+                layout['directory'] = self.environment['PWD']
+        else:
+            layout['virtualenv'] = ''
+            layout['directory'] = self.get_cwd()
+
+        try:
+            parent = psutil.Process(self.pid)
+            children = parent.children(recursive=True)
+            if len(children) > 0:
+                for process in children:
+                    if "+" in subprocess.check_output(["ps", "-o", "stat=", "-p", str(process.pid)]):
+                        cmdline = process.cmdline()
+                        layout['command'] = " ".join(cmdline)
+        except psutil.NoSuchProcess:
+            pass
+
         name = 'terminal%d' % count
         count = count + 1
         global_layout[name] = layout
@@ -1642,6 +1683,8 @@
             self.titlebar.set_custom_string(layout['title'])
         if layout.has_key('directory') and layout['directory'] != '':
             self.directory = layout['directory']
+        if layout.has_key('virtualenv') and layout['virtualenv'] != '':
+            self.virtualenv = layout['virtualenv']
         if layout.has_key('uuid') and layout['uuid'] != '':
             self.uuid = make_uuid(layout['uuid'])
 

=== modified file 'terminatorlib/terminal_popup_menu.py'
--- terminatorlib/terminal_popup_menu.py	2017-02-19 15:57:36 +0000
+++ terminatorlib/terminal_popup_menu.py	2018-10-23 02:50:13 +0000
@@ -191,6 +191,10 @@
             item.connect('activate', lambda x: PrefsEditor(self.terminal))
             menu.append(item)
 
+        item = Gtk.ImageMenuItem.new_with_mnemonic(_('_Save Layout'))
+        item.connect('activate', lambda x: self.terminator.save_layout())
+        menu.append(item)
+
         profilelist = sorted(self.config.list_profiles(), key=string.lower)
 
         if len(profilelist) > 1:

=== modified file 'terminatorlib/terminator.py'
--- terminatorlib/terminator.py	2017-02-28 19:48:11 +0000
+++ terminatorlib/terminator.py	2018-10-23 02:50:13 +0000
@@ -132,6 +132,12 @@
             self.gnome_client = False
             dbg('GNOME session support not available')
 
+    def save_layout(self):
+        """Save Current Layout"""
+        dbg('saving current layout')
+        self.config.layout_set_config(self.layoutname, self.describe_layout())
+        self.config.save()
+
     def save_yourself(self, *args):
         """Save as much state as possible for the session manager"""
         dbg('preparing session manager state')