Merge lp:~ted/url-dispatcher/mediaplayer-app-helper-rtm into lp:url-dispatcher/rtm-14.09

[Ted Gould]

Add special handling for mediaplayer to call the helper instead of an app

Unmerged revisions

103. By Ted Gould on 2015-01-16

Adding a manual test for working with the camera AND the dash

102. By Ted Gould on 2015-01-16

Checking the other parameters as well

101. By Ted Gould on 2015-01-16

Make the test check to ensure the PID is the correct one

100. By Ted Gould on 2015-01-16

Switching back to discovering the PID from the dbus message for the camera app

99. By Ted Gould on 2015-01-16

Make sure to pick up our new binary

98. By Ted Gould on 2015-01-15

Don't hardcode the utility being called

97. By Ted Gould on 2015-01-15

Setup a fork/exec relationship so we keep the Mir connection open

96. By Ted Gould on 2015-01-15

Getting the PID from Upstart

95. By Ted Gould on 2015-01-15

A test to ensure we call the helper correctly

94. By Ted Gould on 2015-01-15

Test setup

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2014-05-26 12:56:47 +0000
+++ CMakeLists.txt	2015-01-16 16:37:34 +0000
@@ -76,6 +76,7 @@
 add_subdirectory(service)
 add_subdirectory(liburl-dispatcher)
 add_subdirectory(tools)
+add_subdirectory(trusted-session-helper)
 
 # testing & coverage
 if (${enable_tests})

=== modified file 'debian/control'
--- debian/control	2014-08-20 18:41:41 +0000
+++ debian/control	2015-01-16 16:37:34 +0000
@@ -14,6 +14,7 @@
                libglib2.0-dev,
                libjson-glib-dev,
                libgtest-dev,
+               libmirclient-dev,
                libsqlite3-dev,
                libubuntu-app-launch2-dev (>= 0.3),
                python3,

=== modified file 'debian/url-dispatcher.install'
--- debian/url-dispatcher.install	2013-06-28 16:35:12 +0000
+++ debian/url-dispatcher.install	2015-01-16 16:37:34 +0000
@@ -1,3 +1,4 @@
 usr/lib/*/url-dispatcher
+usr/lib/*/trusted-session-helper
 usr/share/dbus-1
 usr/share/upstart/sessions

=== modified file 'service/CMakeLists.txt'
--- service/CMakeLists.txt	2014-05-26 12:56:47 +0000
+++ service/CMakeLists.txt	2015-01-16 16:37:34 +0000
@@ -36,6 +36,8 @@
 # Dispatcher Lib
 ###########################
 
+add_definitions(-DURL_DISPATCHER_TRUST_SESSION_HELPER="${CMAKE_INSTALL_FULL_LIBEXECDIR}/trusted-session-helper")
+
 add_library(dispatcher-lib STATIC
 	dispatcher.h
 	dispatcher.c)

=== modified file 'service/dispatcher.c'
--- service/dispatcher.c	2014-12-11 19:00:04 +0000
+++ service/dispatcher.c	2015-01-16 16:37:34 +0000
@@ -190,16 +190,90 @@
 	return TRUE;
 }
 
+/* React to getting the PID and start the media player helper */
+static void
+send_to_media_player_pid_cb (GObject * obj, GAsyncResult * res, gpointer user_data)
+{
+	gchar * url = (gchar *)user_data;
+	GVariant * pid_tuple = NULL;
+	GError * error = NULL;
+
+	pid_tuple = g_dbus_connection_call_finish(G_DBUS_CONNECTION(obj), res, &error);
+	if (error != NULL) {
+		g_warning("Unable to get PID for media player with URL '%s': %s", url, error->message);
+		g_free(url);
+		g_error_free(error);
+		return;
+	}
+
+	guint32 pid = 0;
+	g_variant_get(pid_tuple, "(u)", &pid);
+	g_variant_unref(pid_tuple);
+
+	gchar * pidstr = g_strdup_printf("%d", pid);
+
+	static const gchar * helper = NULL;
+
+	if (helper == NULL) {
+		helper = g_getenv("URL_DISPATCHER_TRUST_SESSION_HELPER");
+	}
+	if (helper == NULL) {
+		helper = URL_DISPATCHER_TRUST_SESSION_HELPER;
+	}
+
+	const gchar * argv[5] = {
+		helper,
+		pidstr,
+		"mediaplayer-app", /* TODO: Discover this */
+		url,
+		NULL
+	};
+
+	g_spawn_async(NULL,
+		(gchar **)argv,
+		NULL, /* envp */
+		G_SPAWN_DEFAULT,
+		NULL, /* child setup */
+		NULL, /* user_data */
+		NULL, /* child pid */
+		&error);
+
+	g_free(pidstr);
+
+	if (error != NULL) {
+		g_warning("Unable to start trusted session helper for '%s': %s", url, error->message);
+		g_error_free(error);
+	}
+}
+
+gboolean
+send_to_scope_helper (GDBusMethodInvocation * invocation, const gchar * url)
+{
+	const gchar * sender = g_dbus_method_invocation_get_sender(invocation);
+	GDBusConnection * conn = g_dbus_method_invocation_get_connection(invocation);
+
+	g_dbus_connection_call(conn,
+	                       "org.freedesktop.DBus",
+	                       "/",
+	                       "org.freedesktop.DBus",
+	                       "GetConnectionUnixProcessID",
+	                       g_variant_new("(s)", sender),
+	                       G_VARIANT_TYPE("(u)"),
+	                       G_DBUS_CALL_FLAGS_NONE,
+	                       -1, /* timeout */
+	                       NULL, /* cancellable */
+	                       send_to_media_player_pid_cb,
+	                       g_strdup(url));
+
+	return FALSE;
+}
+
 /* Handles taking an application and an URL and sending them to Upstart */
 gboolean
 dispatcher_send_to_app (const gchar * app_id, const gchar * url)
 {
 	g_debug("Emitting 'application-start' for APP_ID='%s' and URLS='%s'", app_id, url);
 
-	if (g_strcmp0(app_id, "unity8-dash") == 0) {
-		return send_to_dash(url);
-	}
-
 	const gchar * urls[2] = {
 		url,
 		NULL
@@ -276,7 +350,17 @@
 	}
 
 	/* We're cleared to continue */
-	dispatcher_send_to_app(appid, outurl);
+	/* Handle special cases */
+	if (g_strcmp0(appid, "unity8-dash") == 0) {
+		send_to_dash(outurl);
+	} else if (g_strcmp0(appid, "mediaplayer-app") == 0) {
+		/* TODO: This should be more than mediaplayer-app in the future, but we're
+		         implementing that first and then we can expand it. */
+		send_to_scope_helper(invocation, outurl);
+	} else {
+		dispatcher_send_to_app(appid, outurl);
+	}
+
 	g_free(appid);
 
 	g_dbus_method_invocation_return_value(invocation, NULL);

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2014-09-22 15:20:40 +0000
+++ tests/CMakeLists.txt	2015-01-16 16:37:34 +0000
@@ -1,5 +1,6 @@
 
 add_definitions ( -DCMAKE_BINARY_DIR="${CMAKE_CURRENT_BINARY_DIR}" )
+add_definitions ( -DURL_DISPATCHER_TRUST_SESSION_HELPER="${CMAKE_BINARY_DIR}/trusted-session-helper/trusted-session-helper" )
 
 ###########################
 # Click Database
@@ -88,8 +89,11 @@
 # service test
 ###########################
 
+configure_file ("ts-helper-test.sh.in" "${CMAKE_CURRENT_BINARY_DIR}/ts-helper-test.sh" @ONLY)
 add_definitions ( -DURL_DISPATCHER_SERVICE="${CMAKE_BINARY_DIR}/service/url-dispatcher" )
 add_definitions ( -DXDG_DATA_DIRS="${CMAKE_CURRENT_SOURCE_DIR}/xdg-data" )
+add_definitions ( -DTS_HELPER_TEST="${CMAKE_CURRENT_BINARY_DIR}/ts-helper-test.sh" )
+add_definitions ( -DTS_HELPER_TEST_FILE="${CMAKE_CURRENT_BINARY_DIR}/ts-helper-test-ran" )
 
 add_executable (service-test service-test.cc)
 target_link_libraries (service-test

=== modified file 'tests/manual'
--- tests/manual	2014-02-05 04:57:41 +0000
+++ tests/manual	2015-01-16 16:37:34 +0000
@@ -25,3 +25,20 @@
         <dd>The settings application should come to focus</dd>
         <dd>The settings app should display the battery settings</dd>
 </dl>
+
+Test-case url-dispatcher/mediaplayer-special-case
+<dl>
+    <dt>NOTE: Testing for a special case, should go away in the future</dt>
+    <dt>Open the camera app</dt>
+    <dt>Record a video of yourself singing "Mary had a little lamb"</dt>
+    <dt>Open the camera roll</dt>
+    <dt>Play the video you just recorded</dt>
+        <dd>The video should start playing above the camera app</dd>
+        <dd>When looking at the application switcher the video should be managed as the camera app</dd>
+    <dt>Stop the video playing</dt>
+    <dt>Navigate to the dash</dt>
+    <dt>Switch to the My Videos scope</dt>
+    <dt>Select and play the video you just recorded</dt>
+        <dd>The video should start playing above the dash</dd>
+        <dd>When looking at the application switcher the video should be managed as the dash</dd>
+</dl>

=== modified file 'tests/service-test.cc'
--- tests/service-test.cc	2014-09-22 15:20:40 +0000
+++ tests/service-test.cc	2015-01-16 16:37:34 +0000
@@ -15,8 +15,10 @@
  *
  */
 
+#include <string>
 
 #include <gio/gio.h>
+#include <glib/gstdio.h>
 #include <gtest/gtest.h>
 #include <liburl-dispatcher/url-dispatcher.h>
 #include <libdbustest/dbus-test.h>
@@ -38,6 +40,10 @@
 			g_setenv("UBUNTU_APP_LAUNCH_USE_SESSION", "1", TRUE);
 			g_setenv("URL_DISPATCHER_DISABLE_RECOVERABLE_ERROR", "1", TRUE);
 			g_setenv("XDG_DATA_DIRS", XDG_DATA_DIRS, TRUE);
+			g_setenv("URL_DISPATCHER_TRUST_SESSION_HELPER", TS_HELPER_TEST, TRUE);
+			
+			g_debug("Deleting TS helper file: '" TS_HELPER_TEST_FILE "'");
+			g_unlink(TS_HELPER_TEST_FILE);
 
 			SetUpDb();
 
@@ -113,6 +119,9 @@
 			}
 
 			TearDownDb();
+
+			g_unlink(TS_HELPER_TEST_FILE);
+
 			return;
 		}
 
@@ -128,6 +137,8 @@
 			time.tv_sec = 5;
 			url_db_set_file_motification_time(db, "/unity8-dash.url-dispatcher", &time);
 			url_db_insert_url(db, "/unity8-dash.url-dispatcher", "scope", NULL);
+			url_db_set_file_motification_time(db, "/mediaplayer-app.url-dispatcher", &time);
+			url_db_insert_url(db, "/mediaplayer-app.url-dispatcher", "video", NULL);
 			sqlite3_close(db);
 		}
 
@@ -297,3 +308,35 @@
 	g_dbus_connection_signal_unsubscribe(bus, focus_signal);
 	g_clear_object(&bus);
 }
+
+TEST_F(ServiceTest, MediaPlayerHelperTest) {
+	EXPECT_FALSE(g_file_test(TS_HELPER_TEST_FILE, G_FILE_TEST_EXISTS));
+
+	GMainLoop * main = g_main_loop_new(NULL, FALSE);
+
+	/* Send a dummy URL */
+	url_dispatch_send("dummy:///this/wont/work.mp4", simple_cb, main);
+
+	/* Give it some time to send and reply */
+	g_main_loop_run(main);
+
+	EXPECT_FALSE(g_file_test(TS_HELPER_TEST_FILE, G_FILE_TEST_EXISTS));
+
+	/* Send an video URL */
+	url_dispatch_send("video:///foo/bar/movie.mp4", simple_cb, main);
+
+	/* Give it some time to send and reply */
+	g_main_loop_run(main);
+	g_main_loop_unref(main);
+
+	g_usleep(0.2 * G_USEC_PER_SEC);
+
+	EXPECT_TRUE(g_file_test(TS_HELPER_TEST_FILE, G_FILE_TEST_EXISTS));
+
+	gchar * pidstr = NULL;
+	gchar * getpidstr = g_strdup_printf("%d", getpid());
+	EXPECT_TRUE(g_file_get_contents(TS_HELPER_TEST_FILE, &pidstr, NULL, NULL));
+	EXPECT_STREQ(getpidstr, pidstr);
+	g_free(getpidstr);
+	g_free(pidstr);
+}

=== added file 'tests/ts-helper-test.sh.in'
--- tests/ts-helper-test.sh.in	1970-01-01 00:00:00 +0000
+++ tests/ts-helper-test.sh.in	2015-01-16 16:37:34 +0000
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+if [ "$2" != "mediaplayer-app" ] ; then
+	exit 1;
+fi
+
+if [ "$3" != "video:///foo/bar/movie.mp4" ] ; then
+	exit 1;
+fi
+
+echo "TS Helper Touching: @CMAKE_CURRENT_BINARY_DIR@/ts-helper-test-ran"
+echo -n $1 > @CMAKE_CURRENT_BINARY_DIR@/ts-helper-test-ran

=== added directory 'trusted-session-helper'
=== added file 'trusted-session-helper/CMakeLists.txt'
--- trusted-session-helper/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ trusted-session-helper/CMakeLists.txt	2015-01-16 16:37:34 +0000
@@ -0,0 +1,13 @@
+
+find_package (PkgConfig REQUIRED)
+pkg_check_modules (HELPER_DEPS REQUIRED
+                   glib-2.0
+                   mirclient)
+include_directories (SYSTEM ${HELPER_DEPS_INCLUDE_DIRS})
+
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -g -fPIE")
+
+add_executable(trusted-session-helper main.cpp)
+target_link_libraries(trusted-session-helper ${HELPER_DEPS_LIBRARIES})
+
+install(TARGETS trusted-session-helper RUNTIME DESTINATION ${CMAKE_INSTALL_FULL_LIBEXECDIR})

=== added file 'trusted-session-helper/main.cpp'
--- trusted-session-helper/main.cpp	1970-01-01 00:00:00 +0000
+++ trusted-session-helper/main.cpp	2015-01-16 16:37:34 +0000
@@ -0,0 +1,103 @@
+
+#include <memory>
+#include <string>
+#include <iostream>
+#include <cstdlib>
+
+extern "C" {
+#include <unistd.h>
+#include <fcntl.h>
+#include <sys/wait.h>
+
+#include <glib.h>
+#include <mir_toolkit/mir_connection.h>
+#include <mir_toolkit/mir_prompt_session.h>
+}
+
+int
+main (int argc, char * argv[])
+{
+	if (argc != 4) {
+		std::cerr << "Usage: " << argv[0] << " [parent pid] [appid] [url]" << std::endl;
+		std::cerr << "TODO: AppID is currently just the binary to execute" << std::endl;
+		return -1;
+	}
+
+	pid_t pid = atoi(argv[1]);
+	if (pid == 0) {
+		std::cerr << "Invalid PID: " << argv[1] << std::endl;
+		return -1;
+	}
+
+	/* Connect to Mir */
+	gchar* mirpath = g_build_filename(g_get_user_runtime_dir(), "mir_socket_trusted", NULL);
+
+	std::shared_ptr<MirConnection> connection = std::shared_ptr<MirConnection>(
+			mir_connect_sync(mirpath, "url-dispatcher-trusted-session-helper"),
+			[](MirConnection * connection)
+			{
+				if (connection != nullptr)
+				{
+					mir_connection_release(connection);
+				}
+			});
+	g_free(mirpath);
+
+	if (connection == nullptr) {
+		std::cerr << "Unable to connect to Mir" << std::endl;
+		return -1;
+	}
+
+	/* Setup the trusted prompt session */
+	auto session = std::shared_ptr<MirPromptSession>(
+					   mir_connection_create_prompt_session_sync(connection.get(), pid, nullptr, nullptr),
+					   [](MirPromptSession * session)
+	{
+		if (session != nullptr)
+		{
+			mir_prompt_session_release_sync(session);
+		}
+	});
+
+	if (session == nullptr) {
+		std::cerr << "Unable to make Mir Trusted Prompt session" << std::endl;
+		return -1;
+	}
+
+	int fd = 0;
+	auto mirwait = mir_prompt_session_new_fds_for_prompt_providers(session.get(),
+			1,
+			[](MirPromptSession * session, size_t count, int const * fdsin, void* context) -> void
+            {
+                g_debug("FDs %d Returned from Mir", count);
+                if (count != 1) return;
+				int * fd = reinterpret_cast<int *>(context);
+				*fd = fdsin[0];
+            },
+            &fd);
+
+	mir_wait_for(mirwait);
+
+	if (fd == 0) {
+		std::cerr << "Unable to get Mir socket" << std::endl;
+		return -1;
+	}
+
+	/* Ensure FD will get passed to an exec */
+	fcntl(fd, F_SETFD, 0);
+
+	pid_t child = fork();
+	if (child == 0) {
+		std::string socketstr("fd://");
+		socketstr += std::to_string(fd);
+
+		setenv("MIR_SOCKET", socketstr.c_str(), 1);
+
+		return execlp(argv[2], argv[2], argv[3]);
+	}
+
+	int childstatus = 0;
+	waitpid(child, &childstatus, 0);
+
+	return childstatus;
+}