improve system/user detection for systemd

Skycoder42 · Skycoder42 · commit f1ad6f973e3f · 2019-03-07T20:33:46.000+01:00
diff --git a/ProjectTemplate/service.service.in b/ProjectTemplate/service.service.in
@@ -8,9 +8,9 @@ After=network-online.target %{SvcSystemdSocketName}
 [Service]
 Type=notify
 NotifyAccess=exec
-ExecStart=$${target.path}/$$TARGET -platform minimal --backend systemd
-ExecReload=$${target.path}/$$TARGET -platform minimal --backend systemd reload $MAINPID
-ExecStop=$${target.path}/$$TARGET -platform minimal --backend systemd stop $MAINPID
+ExecStart=$${target.path}/$$TARGET --backend systemd
+ExecReload=$${target.path}/$$TARGET --backend systemd reload
+ExecStop=$${target.path}/$$TARGET --backend systemd stop
 #WatchdogSec=10
 Restart=on-abnormal
 RuntimeDirectory=$$TARGET
diff --git a/README.md b/README.md
@@ -128,7 +128,7 @@ To start a terminal client, simply prepend `--terminal` as well as the backend t
 ```.sh
 #!/bin/sh
 # use as "service-cli <arguments>" (assuming this script is named service-cli)
-exec /path/to/service -platform minimal --backend systemd --terminal "$@"
+exec /path/to/service --backend systemd --terminal "$@"
 ```
 
 (The platform argument is recommended to not depend on any windowing system)
diff --git a/doc/backends.dox b/doc/backends.dox
@@ -42,7 +42,6 @@ backend can be controlled properly
 - All QDebug is logged into journald
 - Uses QCoreApplication as application
 - Can be used for user and system services
-- should be used with `-platform minimal` to avoid any dependencies to the windowing system
 - supported systemd commands:
 	- start
 	- stop
@@ -77,6 +76,9 @@ backend can be controlled properly
 of that command. The first two parameters as well as the service name are automatically determined
 by the backend, depending on the control configuration. For example, to send the `SIGUSR1` signal to
 a running service, you would call `callCommand<int>("kill", QStringLiteral("--signal=SIGUSR1"));`
+- Custom Properties:
+	- `runAsUser: bool [GSNR]`: Holds whether commands to systemd are issued as `--user` or `--system`.
+The default is determined by checking the current user id, but it can be overwritten.
 - Supports both blocking and nonblocking, the default is ServiceControl::BlockMode::Blocking
 - Has native restart command
 
diff --git a/examples/service/EchoService/echoservice.service b/examples/service/EchoService/echoservice.service
@@ -6,9 +6,9 @@ After=network-online.target echoservice.socket
 [Service]
 Type=notify
 NotifyAccess=exec
-ExecStart=/path/to/echoservice -platform minimal --backend systemd
-ExecReload=/path/to/echoservice -platform minimal --backend systemd reload $MAINPID
-ExecStop=/path/to/echoservice -platform minimal --backend systemd stop $MAINPID
+ExecStart=/path/to/echoservice --backend systemd
+ExecReload=/path/to/echoservice --backend systemd reload
+ExecStop=/path/to/echoservice --backend systemd stop
 WatchdogSec=10
 Restart=on-abnormal
 RuntimeDirectory=echoservice
diff --git a/src/plugins/servicebackends/launchd/launchdservicecontrol.cpp b/src/plugins/servicebackends/launchd/launchdservicecontrol.cpp
@@ -33,7 +33,7 @@ bool LaunchdServiceControl::serviceExists() const
 bool LaunchdServiceControl::isEnabled() const
 {
 	const auto target = QStringLiteral("user/%1/")
-						.arg(::getuid());
+						.arg(::geteuid());
 	QByteArray outData;
 	if (runLaunchctl("print-disabled", {target}, false, &outData) == EXIT_SUCCESS) {
 		const QRegularExpression lineRegex{
@@ -71,7 +71,7 @@ bool LaunchdServiceControl::setEnabled(bool enabled)
 		return true;
 
 	const auto target = QStringLiteral("user/%1/%2")
-						.arg(::getuid())
+						.arg(::geteuid())
 						.arg(serviceId());
 	return runLaunchctl(enabled ? "enable" : "disable", {target}, false) == EXIT_SUCCESS;
 }
diff --git a/src/plugins/servicebackends/systemd/systemdservicebackend.cpp b/src/plugins/servicebackends/systemd/systemdservicebackend.cpp
@@ -1,7 +1,7 @@
 #include "systemdservicebackend.h"
 #include "systemdserviceplugin.h"
 
-#include <QtDBus/QDBusConnection>
+#include <QtCore/QCommandLineParser>
 
 #include <chrono>
 #include <csignal>
@@ -32,9 +32,37 @@ int SystemdServiceBackend::runService(int &argc, char **argv, int flags)
 {
 	qInstallMessageHandler(SystemdServiceBackend::systemdMessageHandler);
 	QCoreApplication app{argc, argv, flags};
-	if(findArg(QStringLiteral("stop")))
+
+	QCommandLineParser parser;
+	parser.addHelpOption();
+	QCommandLineOption backendOpt{QStringLiteral("backend"), {}, QStringLiteral("backend")};
+	backendOpt.setFlags(QCommandLineOption::HiddenFromHelp);
+	parser.addOption(backendOpt);
+	parser.addOption({
+						 QStringLiteral("system"),
+						 tr("Run the service as system service, independend of the current user id")
+					 });
+	parser.addOption({
+						 QStringLiteral("user"),
+						 tr("Run the service as user service, independend of the current user id")
+					 });
+	parser.addPositionalArgument(QStringLiteral("command"),
+								 tr("A command to execute on the primary service process. "
+									"Can be either 'reload' to let the service reload its configuration "
+									"or 'stop' to halt the service"),
+								 QStringLiteral("[stop|reload]"));
+
+	parser.process(app);
+	if(parser.isSet(QStringLiteral("user")))
+		_userService = true;
+	else if(parser.isSet(QStringLiteral("system")))
+		_userService = false;
+	else
+		_userService = ::geteuid() != 0;
+
+	if(parser.positionalArguments().startsWith(QStringLiteral("stop")))
 		return stop();
-	else if(findArg(QStringLiteral("reload")))
+	else if(parser.positionalArguments().startsWith(QStringLiteral("reload")))
 		return reload();
 	else
 		return run();
@@ -123,8 +151,7 @@ void SystemdServiceBackend::onStarted(bool success)
 
 void SystemdServiceBackend::onReloaded(bool success)
 {
-	if(!success) //TODO does not work! modify commands instead
-		sd_notify(false, "ERRNO=1");
+	Q_UNUSED(success)
 	sd_notify(false, "READY=1");
 }
 
@@ -159,7 +186,7 @@ int SystemdServiceBackend::run()
 		registerForSignal(signal);
 
 	// register the D-Bus service
-	auto connection = QDBusConnection::sessionBus();
+	auto connection = dbusConnection();
 	if(!connection.registerObject(DBusObjectPath, this)) {
 		printDbusError(connection.lastError());
 		return EXIT_FAILURE;
@@ -180,7 +207,7 @@ int SystemdServiceBackend::stop()
 	using namespace de::skycoder42::QtService::ServicePlugin;
 	sd_notify(false, "STOPPING=1");
 
-	auto connection = QDBusConnection::sessionBus();
+	auto connection = dbusConnection();
 	auto dbusInterface = new systemd{dbusId(), DBusObjectPath, connection, this};
 	if (!dbusInterface->isValid()) {
 		printDbusError(connection.lastError());
@@ -217,7 +244,7 @@ int SystemdServiceBackend::reload()
 	using namespace de::skycoder42::QtService::ServicePlugin;
 	sd_notify(false, "RELOADING=1");
 
-	auto connection = QDBusConnection::sessionBus();
+	auto connection = dbusConnection();
 	auto dbusInterface = new systemd{dbusId(), DBusObjectPath, connection, this};
 	if (!dbusInterface->isValid()) {
 		printDbusError(connection.lastError());
@@ -265,13 +292,12 @@ void SystemdServiceBackend::prepareWatchdog()
 	}
 }
 
-bool SystemdServiceBackend::findArg(const QString &command) const
+QDBusConnection SystemdServiceBackend::dbusConnection() const
 {
-	for(const auto arg : QCoreApplication::arguments()) {
-		if(arg == command)
-			return true;
-	}
-	return false;
+	if(_userService)
+		return QDBusConnection::sessionBus();
+	else
+		return QDBusConnection::systemBus();
 }
 
 QString SystemdServiceBackend::dbusId() const
diff --git a/src/plugins/servicebackends/systemd/systemdservicebackend.h b/src/plugins/servicebackends/systemd/systemdservicebackend.h
@@ -2,6 +2,9 @@
 #define SYSTEMDSERVICEBACKEND_H
 
 #include <QtCore/QTimer>
+
+#include <QtDBus/QDBusConnection>
+
 #include <QtService/ServiceBackend>
 
 #include "systemd_adaptor.h"
@@ -32,6 +35,7 @@ private Q_SLOTS:
 	void onPaused(bool success);
 
 private:
+	bool _userService = true;
 	QTimer *_watchdogTimer = nullptr;
 	QMultiHash<QByteArray, int> _sockets;
 
@@ -42,8 +46,8 @@ private Q_SLOTS:
 	int reload();
 
 	void prepareWatchdog();
-	bool findArg(const QString &command) const;
 
+	QDBusConnection dbusConnection() const;
 	QString dbusId() const;
 	void printDbusError(const QDBusError &error) const;
 
diff --git a/src/plugins/servicebackends/systemd/systemdservicecontrol.cpp b/src/plugins/servicebackends/systemd/systemdservicecontrol.cpp
@@ -8,7 +8,8 @@
 using namespace QtService;
 
 SystemdServiceControl::SystemdServiceControl(QString &&serviceId, QObject *parent) :
-	ServiceControl{std::move(serviceId), parent}
+	ServiceControl{std::move(serviceId), parent},
+	_runAsUser{::geteuid() != 0}
 {}
 
 QString SystemdServiceControl::backend() const
@@ -140,6 +141,11 @@ ServiceControl::BlockMode SystemdServiceControl::blocking() const
 	return _blocking ? BlockMode::Blocking : BlockMode::NonBlocking;
 }
 
+bool SystemdServiceControl::isRunAsUser() const
+{
+	return _runAsUser;
+}
+
 QVariant SystemdServiceControl::callGenericCommand(const QByteArray &kind, const QVariantList &args)
 {
 	QStringList sArgs;
@@ -189,6 +195,20 @@ bool SystemdServiceControl::setBlocking(bool blocking)
 	return true;
 }
 
+void SystemdServiceControl::setRunAsUser(bool runAsUser)
+{
+	if (_runAsUser == runAsUser)
+		return;
+
+	_runAsUser = runAsUser;
+	emit runAsUserChanged(_runAsUser);
+}
+
+void SystemdServiceControl::resetRunAsUser()
+{
+	setRunAsUser(::geteuid() != 0);
+}
+
 QString SystemdServiceControl::serviceName() const
 {
 	const static QRegularExpression regex(QStringLiteral(R"__((.+)\.(?:service|socket|device|mount|automount|swap|target|path|timer|slice|scope))__"));
@@ -213,10 +233,10 @@ int SystemdServiceControl::runSystemctl(const QByteArray &command, const QString
 
 	QStringList args;
 	args.reserve(extraArgs.size() + 4);
-	if(::geteuid() == 0)
-		args.append(QStringLiteral("--system"));
-	else
+	if(_runAsUser)
 		args.append(QStringLiteral("--user"));
+	else
+		args.append(QStringLiteral("--system"));
 	args.append(QString::fromUtf8(command));
 	if(!noPrepare) {
 		args.append(serviceId());
diff --git a/src/plugins/servicebackends/systemd/systemdservicecontrol.h b/src/plugins/servicebackends/systemd/systemdservicecontrol.h
@@ -7,6 +7,8 @@ class SystemdServiceControl : public QtService::ServiceControl
 {
 	Q_OBJECT
 
+	Q_PROPERTY(bool runAsUser READ isRunAsUser WRITE setRunAsUser RESET resetRunAsUser NOTIFY runAsUserChanged)
+
 public:
 	explicit SystemdServiceControl(QString &&serviceId, QObject *parent = nullptr);
 
@@ -16,6 +18,7 @@ class SystemdServiceControl : public QtService::ServiceControl
 	Status status() const override;
 	bool isAutostartEnabled() const override;
 	BlockMode blocking() const override;
+	bool isRunAsUser() const;
 
 	QVariant callGenericCommand(const QByteArray &kind, const QVariantList &args) override;
 
@@ -27,6 +30,11 @@ public Q_SLOTS:
 	bool enableAutostart() override;
 	bool disableAutostart() override;
 	bool setBlocking(bool blocking) override;
+	void setRunAsUser(bool runAsUser);
+	void resetRunAsUser();
+
+Q_SIGNALS:
+	void runAsUserChanged(bool runAsUser);
 
 protected:
 	QString serviceName() const override;
@@ -35,6 +43,7 @@ public Q_SLOTS:
 	mutable bool _existsRefBase = false;
 	mutable bool *_exists = nullptr;
 	bool _blocking = true;
+	bool _runAsUser;
 
 	int runSystemctl(const QByteArray &command,
 					 const QStringList &extraArgs = {},
diff --git a/src/service/service.h b/src/service/service.h
@@ -105,7 +105,7 @@ public Q_SLOTS:
 
 Q_SIGNALS:
 	//! Must be emitted when starting was completed if onStart returned OperationPending
-	void started(bool success); //TODO doc should be direct connected
+	void started(bool success);
 	//! Must be emitted when stopping was completed if onStop returned OperationPending
 	void stopped(int exitCode = EXIT_SUCCESS);
 	//! Must be emitted when reloading was completed if onReload returned OperationPending
diff --git a/src/service/service.pro b/src/service/service.pro
@@ -53,7 +53,7 @@ QDEP_DEPENDS += \
 # extra cpp files for translations
 never_true_lupdate_only {
 	PLUGINS = $$files(../plugins/servicebackends/*)
-	for(plugin, PLUGINS): SOURCES += $$plugin/*.h
+	for(plugin, PLUGINS): HEADERS += $$plugin/*.h
 	for(plugin, PLUGINS): SOURCES += $$plugin/*.cpp
 }
 
diff --git a/src/service/translations/qtservice_de.ts b/src/service/translations/qtservice_de.ts
diff --git a/src/service/translations/qtservice_template.ts b/src/service/translations/qtservice_template.ts
diff --git a/tests/auto/service/TestService/testservice.cpp b/tests/auto/service/TestService/testservice.cpp
diff --git a/tests/auto/service/TestSystemdService/testservice.service b/tests/auto/service/TestSystemdService/testservice.service
diff --git a/tests/auto/service/TestSystemdService/tst_systemdservice.cpp b/tests/auto/service/TestSystemdService/tst_systemdservice.cpp
