Merge lp:~townsend/libertine/xmir-launcher into lp:libertine/trunk

[Christopher Townsend]

Add launching of Xmir to liberine-xmir-tools including Xmir launch helper programs.

The corresponding ubuntu-app-launch MP is found here: https://code.launchpad.net/~townsend/ubuntu-app-launch/remove-xmir-helpers/+merge/312494

Packages for testing are found at https://bileto.ubuntu.com/#/ticket/2264.

[lp:~townsend/libertine/xmir-launcher]

177. By Christopher Townsend on 2016-12-13

Merge lp:libertine/trunk.

178. By Christopher Townsend on 2017-01-13

Merge lp:libertine/trunk.

179. By Christopher Townsend on 2017-01-13

Remove window_manager handling in the LXD backend.

180. By Christopher Townsend on 2017-01-20

Merge lp:libertine/trunk.

181. By Christopher Townsend on 2017-02-14

Merge lp:libertine/trunk.

182. By Christopher Townsend on 2017-02-14

Fix bad commit from last merge with lp:libertine/trunk.

183. By Christopher Townsend on 2017-02-23

Merge lp:libertine/trunk.

184. By Christopher Townsend on 2017-03-06

Merge lp:libertine/trunk.

185. By Christopher Townsend on 2017-03-20

Merge lp:libertine/trunk.

186. By Christopher Townsend on 2017-03-24

Merge lp:libertine/trunk.

[Larry Price (larryprice)]

some diff comments... pick and choose.

review: Needs Information

[lp:~townsend/libertine/xmir-launcher]

187. By Christopher Townsend on 2017-03-29

Changes based on review.

188. By Christopher Townsend on 2017-03-29

Fix 'environ' local variables to avoid confusion with os.environ.

[Larry Price (larryprice)]

seems good, might need another once-over after merge with 1.7.1 release

review: Approve

[lp:~townsend/libertine/xmir-launcher]

189. By Christopher Townsend on 2017-04-04

Merge lp:libertine/trunk.

Unmerged revisions

189. By Christopher Townsend on 2017-04-04

Merge lp:libertine/trunk.

188. By Christopher Townsend on 2017-03-29

Fix 'environ' local variables to avoid confusion with os.environ.

187. By Christopher Townsend on 2017-03-29

Changes based on review.

186. By Christopher Townsend on 2017-03-24

Merge lp:libertine/trunk.

185. By Christopher Townsend on 2017-03-20

Merge lp:libertine/trunk.

184. By Christopher Townsend on 2017-03-06

Merge lp:libertine/trunk.

183. By Christopher Townsend on 2017-02-23

Merge lp:libertine/trunk.

182. By Christopher Townsend on 2017-02-14

Fix bad commit from last merge with lp:libertine/trunk.

181. By Christopher Townsend on 2017-02-14

Merge lp:libertine/trunk.

180. By Christopher Townsend on 2017-01-20

Merge lp:libertine/trunk.

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2017-03-13 13:53:38 +0000
+++ CMakeLists.txt	2017-04-04 15:32:51 +0000
@@ -42,6 +42,7 @@
 set(LIBERTINE_CORE libertine)
 set(LIBERTINE_EXE_NAME libertine-manager-app)
 set(LIBERTINE_QML_PATH ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_DATAROOTDIR}/${CMAKE_PROJECT_NAME}/qml)
+set(pkglibexecdir ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR}/${CMAKE_PROJECT_NAME})
 
 add_subdirectory(qml)
 add_subdirectory(liblibertine)
@@ -52,6 +53,7 @@
 add_subdirectory(data)
 add_subdirectory(tools)
 add_subdirectory(pasted)
+add_subdirectory(xmir-launcher)
 add_subdirectory(po)
 
 include(CTest)

=== modified file 'data/CMakeLists.txt'
--- data/CMakeLists.txt	2017-01-31 16:28:31 +0000
+++ data/CMakeLists.txt	2017-04-04 15:32:51 +0000
@@ -4,8 +4,6 @@
         DESTINATION ${CMAKE_INSTALL_DATADIR}/applications)
 install(FILES libertine_64.png libertine-lxc.conf
   DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJECT_NAME})
-install(FILES libertine-xmir.conf
-        DESTINATION ${CMAKE_INSTALL_DATADIR}/upstart/sessions)
 install(FILES libertine-lxc-sudo libertine-lxd-sudo
         DESTINATION ${CMAKE_INSTALL_SYSCONFDIR}/sudoers.d)
 install(FILES com.canonical.libertine.Service.service

=== removed file 'data/libertine-xmir.conf'
--- data/libertine-xmir.conf	2017-02-08 20:47:37 +0000
+++ data/libertine-xmir.conf	1970-01-01 00:00:00 +0000
@@ -1,8 +0,0 @@
-description "Set global environment variable to tell u-a-l where to look to start Xmir"
-author "Christopher Townsend <[e-mail]>"
-
-start on starting unity8
-
-pre-start script
-	initctl set-env --global UBUNTU_APP_LAUNCH_XMIR_PATH="/usr/bin/libertine-xmir"
-end script

=== modified file 'debian/libertine-xmir-tools.install'
--- debian/libertine-xmir-tools.install	2017-03-13 15:50:54 +0000
+++ debian/libertine-xmir-tools.install	2017-04-04 15:32:51 +0000
@@ -1,7 +1,8 @@
 usr/bin/libertine-launch
 usr/bin/libertine-xmir
 usr/bin/pasted
+usr/bin/xmir-launch
+usr/lib/*/libertine/xmir-launcher
 usr/lib/python*/*/libertine/launcher
 usr/share/man/*/libertine-launch.1
 usr/share/man/*/libertine-xmir.1
-usr/share/upstart/sessions/libertine-xmir.conf

=== modified file 'python/libertine/ChrootContainer.py'
--- python/libertine/ChrootContainer.py	2017-03-08 21:23:54 +0000
+++ python/libertine/ChrootContainer.py	2017-04-04 15:32:51 +0000
@@ -226,6 +226,7 @@
 
         args = shlex.split(proot_cmd)
         args.extend(app_exec_line)
+
         return psutil.Popen(args, env=environ)
 
     def finish_application(self, app):

=== modified file 'python/libertine/launcher/config.py'
--- python/libertine/launcher/config.py	2017-02-07 16:32:02 +0000
+++ python/libertine/launcher/config.py	2017-04-04 15:32:51 +0000
@@ -152,7 +152,7 @@
 
         self.id              = _generate_unique_id()
         self.exec_line       = options.app_exec_line
-        self.host_environ    = self._sanitize_host_environment(options)
+        self.host_environ    = utils.sanitize_host_environment(options)
         self.socket_bridges  = self._create_socket_bridges()
         self.prelaunch_tasks = self._add_prelaunch_tasks()
         self.session_environ = self._generate_session_environment()
@@ -165,34 +165,6 @@
             log.debug('socket bridge: {}'.format(bridge))
         log.debug('Config.__init__() ends')
 
-    def _sanitize_host_environment(self, options):
-        """Create a dictionary of sanitized environment variables.
-
-        The environment available in the Libertine aegis are effectively those
-        of the launcher, but santized to remove any unwanted or dangerous stuff
-        and with and changes requested on the command line.
-
-        :param options: A collection of option values including a dictionary
-                        named 'environ'.
-        :param type: An argparse namespace.
-
-        :returns: A sanitized host environment dictionary.
-        """
-        # inherit from the host
-        environ = os.environ.copy()
-
-        # remove problematic environment variables
-        for e in ['QT_QPA_PLATFORM', 'XDG_DATA_DIRS', 'FAKECHROOT_BASE', 'FAKECHROOT_CMD_SUBST']:
-            if e in environ:
-                del environ[e]
-
-        # add or replace CLI-speicifed variables
-        for e in options.environ:
-            k, v = e.split(sep='=', maxsplit=2)
-            environ[k] = v
-
-        return environ
-
     def _generate_session_environment(self):
         """Generate the session environment."""
 
@@ -213,7 +185,6 @@
     def _add_prelaunch_tasks(self):
         """Create a collection of pre-launch tasks."""
         tasks = []
-        tasks.append(TaskConfig(TaskType.LAUNCH_SERVICE, ["pasted"]))
 
         return tasks
 

=== modified file 'python/libertine/launcher/task.py'
--- python/libertine/launcher/task.py	2016-12-12 19:59:14 +0000
+++ python/libertine/launcher/task.py	2017-04-04 15:32:51 +0000
@@ -14,15 +14,16 @@
 
 """Pre- and post-launch tasks surrounding the Libertine launch of an application."""
 
-
-from os import waitpid, WNOHANG
-from subprocess import Popen
+from psutil import Popen, Process
+from os import environ, waitpid, WNOHANG
+from subprocess import PIPE
 
 
 class TaskType:
     """Namespace used for task type enumeration."""
 
     LAUNCH_SERVICE = 1
+    LAUNCH_XMIR = 2
 
 
 class TaskConfig(object):
@@ -49,20 +50,47 @@
 
         The constructor unpacks the service commandline from the config datum.
         """
+        self._task_type = config.task_type
         self._command_line = config.datum
         self._process = None
 
-    def start(self, environ=None):
+    def start(self, env=None):
         """Start the service.
 
         :param env: An alternate environment dictionary.
         """
-        self._process = Popen(self._command_line, env=environ)
+        if self._task_type == TaskType.LAUNCH_XMIR:
+            proc = Popen(self._command_line, env=env, stdout=PIPE)
+
+            if proc.returncode == 1:
+                return
+
+            stdout = proc.communicate()
+
+            xmir_output = stdout.decode().split('\n')
+
+            # xmir_output[0] is DISPLAY and needs to be printed out for
+            # ubuntu-app-launch
+            print("%s" % xmir_output[0])
+            environ['DISPLAY'] = xmir_output[0].split('=')[-1]
+
+            # xmir_output[1] is XMIR_PID and needs to be captured
+            try:
+                xmir_pid = int(xmir_output[1].split('=')[-1])
+                if xmir_pid > 1:
+                    self._process = Process(xmir_pid)
+            except ValueError as e:
+                pass
+        else:
+            self._process = Popen(self._command_line, env=env)
 
     def stop(self):
         """Shuts the service down."""
         try:
-            self._process.terminate()
+            if self._process:
+                for child in self._process.children():
+                    child.terminate()
+                self._process.terminate()
         except ProcessLookupError:
             pass
 

=== modified file 'python/libertine/utils.py'
--- python/libertine/utils.py	2017-02-15 21:12:37 +0000
+++ python/libertine/utils.py	2017-04-04 15:32:51 +0000
@@ -180,6 +180,36 @@
     return dbus_session_set
 
 
+def sanitize_host_environment(options=None):
+    """Create a dictionary of sanitized environment variables.
+
+    The environment available in the Libertine aegis are effectively those
+    of the launcher, but santized to remove any unwanted or dangerous stuff
+    and with and changes requested on the command line.
+
+    :param options: A collection of option values including a dictionary
+                    named 'environ'.
+    :param type: An argparse namespace.
+
+    :returns: A sanitized host environment dictionary.
+    """
+    # inherit from the host
+    environ = os.environ.copy()
+
+    # remove problematic environment variables
+    for e in ['QT_QPA_PLATFORM', 'LD_LIBRARY_PATH', 'FAKECHROOT_BASE', 'FAKECHROOT_CMD_SUBST']:
+        if e in environ:
+            del environ[e]
+
+    # add or replace CLI-speicifed variables
+    if options and options.environ:
+        for e in options.environ:
+            k, v = e.split(sep='=', maxsplit=2)
+            environ[k] = v
+
+    return environ
+
+
 def is_snap_environment():
     return 'SNAP' in os.environ
 

=== modified file 'tests/unit/test_launcher.py'
--- tests/unit/test_launcher.py	2016-10-27 18:46:19 +0000
+++ tests/unit/test_launcher.py	2017-04-04 15:32:51 +0000
@@ -168,18 +168,6 @@
         self.assertThat(config.session_environ.get(env_key, bogus_host_address),
                         Not(Equals(bogus_host_address)))
 
-    def test_default_prelaunch_tasks(self):
-        """Ensure 'pasted' is in the default pre-launch task list."""
-        def pasted_is_in_list(task_list):
-            for t in task_list:
-                if t.task_type == launcher.TaskType.LAUNCH_SERVICE and t.datum[0] == "pasted":
-                    return True
-            return False
-
-        config = launcher.Config(TestLauncherConfig.basic_args[:])
-        self.assertThat(config.prelaunch_tasks,
-                        MatchesPredicate(pasted_is_in_list, "pasted is not in task list"))
-
 
 class TestLauncherSession(TestLauncher):
     """

=== modified file 'tools/CMakeLists.txt'
--- tools/CMakeLists.txt	2017-01-31 16:28:31 +0000
+++ tools/CMakeLists.txt	2017-04-04 15:32:51 +0000
@@ -1,8 +1,7 @@
 install(PROGRAMS libertine-container-manager libertine-launch
-                 libertine-xmir libertine-lxc-setup libertine-lxd-setup libertined
+                 libertine-lxc-setup libertine-lxd-setup libertined
         DESTINATION ${CMAKE_INSTALL_BINDIR})
 install(FILES libertine-launch.1 libertine-container-manager.1
-              libertine-xmir.1
         DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
         COMPONENT doc)
 install(FILES completions/libertine-container-manager

=== added directory 'xmir-launcher'
=== added file 'xmir-launcher/CMakeLists.txt'
--- xmir-launcher/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ xmir-launcher/CMakeLists.txt	2017-04-04 15:32:51 +0000
@@ -0,0 +1,11 @@
+set(xmir_launcher_SRC
+    xmir-launcher.c
+)
+
+add_executable(xmir-launcher ${xmir_launcher_SRC})
+set_target_properties(xmir-launcher PROPERTIES OUTPUT_NAME "xmir-launcher")
+
+install(TARGETS xmir-launcher RUNTIME DESTINATION ${pkglibexecdir})
+install(PROGRAMS libertine-xmir xmir-launch DESTINATION ${CMAKE_INSTALL_BINDIR})
+install(FILES libertine-xmir.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
+        COMPONENT doc)

=== renamed file 'tools/libertine-xmir' => 'xmir-launcher/libertine-xmir'
=== renamed file 'tools/libertine-xmir.1' => 'xmir-launcher/libertine-xmir.1'
=== added file 'xmir-launcher/xmir-launch'
--- xmir-launcher/xmir-launch	1970-01-01 00:00:00 +0000
+++ xmir-launcher/xmir-launch	2017-04-04 15:32:51 +0000
@@ -0,0 +1,95 @@
+#!/usr/bin/python3
+# -*- coding: utf-8 -*-
+
+# Copyright (C) 2016-2017 Canonical Ltd.
+# Author: Christopher Townsend <[e-mail]>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import psutil
+import os
+import signal
+import sys
+
+from contextlib import suppress
+from libertine.launcher import LaunchServiceTask, TaskConfig, TaskType
+from libertine import utils
+
+
+class XmirLaunch(object):
+    def __init__(self):
+        self.xmir_task = None
+        self.xmir_helper_tasks = []
+        self.libertine_launch_task = None
+
+        self.xmir_task_config = self._add_xmir_launch_task()
+        self.xmir_helper_task_configs = self._add_xmir_helper_tasks()
+        self.libertine_launch_task_config = self._add_libertine_launch_task()
+
+    def _add_xmir_launch_task(self):
+        """Create a xmir-launcher task."""
+        return TaskConfig(TaskType.LAUNCH_XMIR, ['xmir-launcher', sys.argv[1]])
+
+    def _add_xmir_helper_tasks(self):
+        """Create a collection of xmir helper launch tasks."""
+        tasks = []
+        tasks.append(TaskConfig(TaskType.LAUNCH_SERVICE, ['pasted']))
+
+        return tasks
+
+    def _add_libertine_launch_task(self):
+        """Create a libertine-launch task."""
+        return TaskConfig(TaskType.LAUNCH_SERVICE,  sys.argv[2:])
+
+    def launch_tasks(self):
+        with suppress(AttributeError):
+            self.xmir_task = LaunchServiceTask(self.xmir_task_config)
+            self.xmir_task.start()
+
+            environ = utils.sanitize_host_environment()
+
+            for task_config in self.xmir_helper_task_configs:
+                task = LaunchServiceTask(task_config)
+                self.xmir_helper_tasks.append(task)
+                task.start(environ)
+
+            self.libertine_launch_task = LaunchServiceTask(self.libertine_launch_task_config)
+            self.libertine_launch_task.start()
+
+    def shutdown_tasks(self):
+        with suppress(psutil.NoSuchProcess):
+            self.libertine_launch_task.stop()
+            self.libertine_launch_task.wait()
+
+            for task in self.xmir_helper_tasks:
+                task.stop()
+
+            self.xmir_task.stop()
+
+
+def main():
+    def handle_signal(signum, frame):
+        xmir_launch.shutdown_tasks()
+
+    xmir_launch = XmirLaunch()
+
+    xmir_launch.launch_tasks()
+
+    signal.signal(signal.SIGTERM, handle_signal)
+    signal.signal(signal.SIGCHLD, handle_signal)
+
+    signal.pause()
+
+
+if __name__ == '__main__':
+    main()

=== added file 'xmir-launcher/xmir-launcher.c'
--- xmir-launcher/xmir-launcher.c	1970-01-01 00:00:00 +0000
+++ xmir-launcher/xmir-launcher.c	2017-04-04 15:32:51 +0000
@@ -0,0 +1,124 @@
+/*
+ * Copyright © 2014-2017 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authors:
+ *     Ted Gould <[e-mail]>
+ *     Chris Townsend <[e-mail]>
+ */
+
+#define _POSIX_C_SOURCE 200212L
+
+#include <unistd.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <signal.h>
+
+void
+sigchild_handler (int signal)
+{
+  fprintf(stderr, "XMir has closed unexpectedly\n");
+  exit(1);
+}
+
+struct sigaction sigchild_action = {
+  .sa_handler = sigchild_handler,
+  .sa_flags = SA_NOCLDWAIT
+};
+
+int
+main (int argc, char * argv[])
+{
+  pid_t xmir_pid;
+
+  if (argc < 2)
+  {
+    fprintf(stderr, "xmir-launcher needs more arguments: xmir-launcher $(appid)\n");
+    return -1;
+  }
+
+  /* Make nice variables for the things we need */
+  char * appid = argv[1];
+  char * xmir = "/usr/bin/libertine-xmir";
+
+  /* Build a socket pair to get the connection back from XMir */
+  int sockets[2];
+  if (socketpair(AF_LOCAL, SOCK_STREAM, 0, sockets) != 0)
+  {
+    fprintf(stderr, "Unable to create socketpair for communicating with XMir\n");
+    return -1;
+  }
+
+  /* Give them nice names, the compiler will optimize out */
+  int xmirsocket = sockets[0];
+  int helpersocket = sockets[1];
+
+  /* Watch for the child dying */
+  if (sigaction(SIGCHLD, &sigchild_action, NULL) != 0)
+  {
+    fprintf(stderr, "Unable to setup child signal handler\n");
+    return -1;
+  }
+
+  /* Start XMir */
+  xmir_pid = fork();
+
+  if (xmir_pid == 0)
+  {
+    /* XMir start here */
+    /* GOAL: Xmir -displayfd ${xmirsocket} -mir ${appid} */
+    char socketbuf[16] = {0};
+    snprintf(socketbuf, 16, "%d", xmirsocket);
+
+    char * xmirexec[6] = { xmir,
+			   "-displayfd",
+			   socketbuf,
+			   "-mir",
+			   appid,
+			   NULL
+		         };
+
+    return execv(xmir, xmirexec);
+  }
+
+  /* Wait to get the display number from XMir */
+  char readbuf[16] = {0};
+ 
+  if (read(helpersocket, readbuf, 16) == 0)
+  {
+    fprintf(stderr, "Not reading anything from XMir\n");
+    return -1;
+  }
+
+  int i;
+  for (i = 0; i < sizeof(readbuf); i++)
+  {
+    if (readbuf[i] == '\n')
+    {
+      readbuf[i] = '\0';
+      break;
+    }
+  }
+
+  char displaynumber[16] = {0};
+  snprintf(displaynumber, 16, ":%s", readbuf);
+
+  /* Print out the DISPLAY environment variable */
+  printf("DISPLAY=%s\n", displaynumber);
+  printf("XMIR_PID=%d\n", xmir_pid);
+
+  return 0;
+}