From 8feca2472ccb71d49716a37e86db2fc3a485ae4e Mon Sep 17 00:00:00 2001 From: Benjamin Berg Date: Wed, 25 Mar 2020 16:59:40 +0100 Subject: [PATCH] xdg-autostart-generator: Add a generator for XDG autostart files This generator can be used by desktop environments to launch autostart applications and services. The feature is an opt-in, triggered by xdg-desktop-autostart.target being activated. Also included is the new binary xdg-autostart-condition. This binary is used as an ExecCondition to test the OnlyShowIn and NotShowIn XDG desktop file keys. These need to be evaluated against the XDG_CURRENT_DESKTOP environment variable which may not be known at generation time. Co-authored-by: Henri Chain --- man/systemd.special.xml | 10 + meson.build | 24 + meson_options.txt | 2 + .../xdg-autostart-condition.c | 46 ++ .../xdg-autostart-generator.c | 116 ++++ .../xdg-autostart-service.c | 618 ++++++++++++++++++ .../xdg-autostart-service.h | 36 + units/user/meson.build | 4 + units/user/xdg-desktop-autostart.target | 14 + 9 files changed, 870 insertions(+) create mode 100644 src/xdg-autostart-generator/xdg-autostart-condition.c create mode 100644 src/xdg-autostart-generator/xdg-autostart-generator.c create mode 100644 src/xdg-autostart-generator/xdg-autostart-service.c create mode 100644 src/xdg-autostart-generator/xdg-autostart-service.h create mode 100644 units/user/xdg-desktop-autostart.target diff --git a/man/systemd.special.xml b/man/systemd.special.xml index c37e732b5f..2f40667b0a 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -1150,6 +1150,16 @@ gnome-session.target. + + + xdg-desktop-autostart.target + + The XDG specification defines a way to autostart applications using XDG desktop files. + systemd ships a generator for the XDG desktop files in autostart directories. + Desktop Environments can opt-in to use this service by adding a Wants= + dependency on xdg-desktop-autostart.target. + + diff --git a/meson.build b/meson.build index 53c450eb01..008fd998e9 100644 --- a/meson.build +++ b/meson.build @@ -1417,6 +1417,7 @@ foreach term : ['utmp', 'tmpfiles', 'hwdb', 'rfkill', + 'xdg-autostart', 'ldconfig', 'efi', 'tpm', @@ -1520,6 +1521,7 @@ includes = include_directories('src/basic', 'src/libudev', 'src/core', 'src/shutdown', + 'src/xdg-autostart-generator', 'src/libsystemd/sd-bus', 'src/libsystemd/sd-device', 'src/libsystemd/sd-event', @@ -2301,6 +2303,27 @@ if conf.get('HAVE_SYSV_COMPAT') == 1 install_dir : systemgeneratordir) endif +if conf.get('ENABLE_XDG_AUTOSTART') == 1 + executable( + 'systemd-xdg-autostart-generator', + 'src/xdg-autostart-generator/xdg-autostart-generator.c', + 'src/xdg-autostart-generator/xdg-autostart-service.c', + include_directories : includes, + link_with : [libshared], + install_rpath : rootlibexecdir, + install : true, + install_dir : usergeneratordir) + + executable( + 'systemd-xdg-autostart-condition', + 'src/xdg-autostart-generator/xdg-autostart-condition.c', + include_directories : includes, + link_with : [libshared], + install_rpath : rootlibexecdir, + install : true, + install_dir : rootlibexecdir) +endif + if conf.get('ENABLE_HOSTNAMED') == 1 executable( 'systemd-hostnamed', @@ -3566,6 +3589,7 @@ foreach tuple : [ ['randomseed'], ['backlight'], ['rfkill'], + ['xdg-autostart'], ['logind'], ['machined'], ['portabled'], diff --git a/meson_options.txt b/meson_options.txt index d5ed2a7a42..2a2597912f 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -142,6 +142,8 @@ option('hwdb', type : 'boolean', description : 'support for the hardware database') option('rfkill', type : 'boolean', description : 'support for the rfkill tools') +option('xdg-autostart', type : 'boolean', + description : 'install the xdg-autostart-generator and unit') option('man', type : 'combo', choices : ['auto', 'true', 'false'], value : 'false', description : 'build and install man pages') diff --git a/src/xdg-autostart-generator/xdg-autostart-condition.c b/src/xdg-autostart-generator/xdg-autostart-condition.c new file mode 100644 index 0000000000..84a3561654 --- /dev/null +++ b/src/xdg-autostart-generator/xdg-autostart-condition.c @@ -0,0 +1,46 @@ +/* SPDX-License-Identifier: LGPL-2.1+ */ + +#include "main-func.h" +#include "strv.h" + +/* + * This binary is intended to be run as an ExecCondition= in units generated + * by the xdg-autostart-generator. It does the appropriate checks against + * XDG_CURRENT_DESKTOP that are too advanced for simple ConditionEnvironment= + * matches. + */ + +static int run(int argc, char *argv[]) { + _cleanup_strv_free_ char **only_show_in = NULL, **not_show_in = NULL, **desktops = NULL; + const char *xdg_current_desktop; + char **d; + + if (argc != 3) + return log_error_errno(SYNTHETIC_ERRNO(EINVAL), + "Wrong argument count. Expected the OnlyShowIn= and NotShowIn= sets, each colon separated."); + + xdg_current_desktop = getenv("XDG_CURRENT_DESKTOP"); + if (xdg_current_desktop) { + desktops = strv_split(xdg_current_desktop, ":"); + if (!desktops) + return log_oom(); + } + + only_show_in = strv_split(argv[1], ":"); + not_show_in = strv_split(argv[2], ":"); + if (!only_show_in || !not_show_in) + return log_oom(); + + /* Each desktop in XDG_CURRENT_DESKTOP needs to be matched in order. */ + STRV_FOREACH(d, desktops) { + if (strv_contains(only_show_in, *d)) + return 0; + if (strv_contains(not_show_in, *d)) + return 1; + } + + /* non-zero exit code when only_show_in has a proper value */ + return !strv_isempty(only_show_in); +} + +DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run); diff --git a/src/xdg-autostart-generator/xdg-autostart-generator.c b/src/xdg-autostart-generator/xdg-autostart-generator.c new file mode 100644 index 0000000000..53366a31ec --- /dev/null +++ b/src/xdg-autostart-generator/xdg-autostart-generator.c @@ -0,0 +1,116 @@ +/* SPDX-License-Identifier: LGPL-2.1+ */ + +#include +#include +#include + +#include "dirent-util.h" +#include "fd-util.h" +#include "generator.h" +#include "hashmap.h" +#include "log.h" +#include "main-func.h" +#include "nulstr-util.h" +#include "path-lookup.h" +#include "stat-util.h" +#include "string-util.h" +#include "strv.h" +#include "xdg-autostart-service.h" + +DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(xdgautostartservice_hash_ops, char, string_hash_func, string_compare_func, XdgAutostartService, xdg_autostart_service_free); + +static int enumerate_xdg_autostart(Hashmap *all_services) { + _cleanup_strv_free_ char **autostart_dirs = NULL; + _cleanup_strv_free_ char **config_dirs = NULL; + _unused_ _cleanup_strv_free_ char **data_dirs = NULL; + _cleanup_free_ char *user_config_autostart_dir = NULL; + char **path; + int r; + + r = xdg_user_config_dir(&user_config_autostart_dir, "/autostart"); + if (r < 0) + return r; + r = strv_extend(&autostart_dirs, user_config_autostart_dir); + if (r < 0) + return r; + + r = xdg_user_dirs(&config_dirs, &data_dirs); + if (r < 0) + return r; + r = strv_extend_strv_concat(&autostart_dirs, config_dirs, "/autostart"); + if (r < 0) + return r; + + STRV_FOREACH(path, autostart_dirs) { + _cleanup_closedir_ DIR *d = NULL; + struct dirent *de; + + d = opendir(*path); + if (!d) { + if (errno != ENOENT) + log_warning_errno(errno, "Opening %s failed, ignoring: %m", *path); + continue; + } + + FOREACH_DIRENT(de, d, log_warning_errno(errno, "Failed to enumerate directory %s, ignoring: %m", *path)) { + _cleanup_free_ char *fpath = NULL, *name = NULL; + _cleanup_(xdg_autostart_service_freep) XdgAutostartService *service = NULL; + struct stat st; + + if (fstatat(dirfd(d), de->d_name, &st, 0) < 0) { + log_warning_errno(errno, "stat() failed on %s/%s, ignoring: %m", *path, de->d_name); + continue; + } + + if (!S_ISREG(st.st_mode)) + continue; + + name = xdg_autostart_service_translate_name(de->d_name); + if (!name) + return log_oom(); + + if (hashmap_contains(all_services, name)) + continue; + + fpath = path_join(*path, de->d_name); + if (!fpath) + return log_oom(); + + service = xdg_autostart_service_parse_desktop(fpath); + if (!service) + return log_oom(); + service->name = TAKE_PTR(name); + + r = hashmap_put(all_services, service->name, service); + if (r < 0) + return log_oom(); + TAKE_PTR(service); + } + } + + return 0; +} + +static int run(const char *dest, const char *dest_early, const char *dest_late) { + _cleanup_(hashmap_freep) Hashmap *all_services = NULL; + XdgAutostartService *service; + Iterator j; + int r; + + assert_se(dest_late); + + all_services = hashmap_new(&xdgautostartservice_hash_ops); + if (!all_services) + return log_oom(); + + r = enumerate_xdg_autostart(all_services); + if (r < 0) + return r; + + HASHMAP_FOREACH(service, all_services, j) + (void) xdg_autostart_service_generate_unit(service, dest_late); + + return 0; +} + +DEFINE_MAIN_GENERATOR_FUNCTION(run); diff --git a/src/xdg-autostart-generator/xdg-autostart-service.c b/src/xdg-autostart-generator/xdg-autostart-service.c new file mode 100644 index 0000000000..9ff80c5bb0 --- /dev/null +++ b/src/xdg-autostart-generator/xdg-autostart-service.c @@ -0,0 +1,618 @@ +/* SPDX-License-Identifier: LGPL-2.1+ */ + +#include +#include +#include + +#include "xdg-autostart-service.h" + +#include "conf-parser.h" +#include "escape.h" +#include "unit-name.h" +#include "path-util.h" +#include "fd-util.h" +#include "generator.h" +#include "log.h" +#include "specifier.h" +#include "string-util.h" +#include "nulstr-util.h" +#include "strv.h" + +XdgAutostartService* xdg_autostart_service_free(XdgAutostartService *s) { + if (!s) + return NULL; + + free(s->name); + free(s->path); + free(s->description); + + free(s->type); + free(s->exec_string); + + strv_free(s->only_show_in); + strv_free(s->not_show_in); + + free(s->try_exec); + free(s->autostart_condition); + free(s->kde_autostart_condition); + + free(s->gnome_autostart_phase); + + return mfree(s); +} + +char *xdg_autostart_service_translate_name(const char *name) { + _cleanup_free_ char *c = NULL, *escaped = NULL; + char *res; + + c = strdup(name); + if (!c) + return NULL; + + res = endswith(c, ".desktop"); + if (res) + *res = '\0'; + + escaped = unit_name_escape(c); + if (!escaped) + return NULL; + + return strjoin("app-", escaped, "-autostart.service"); +} + +static int xdg_config_parse_bool( + const char *unit, + const char *filename, + unsigned line, + const char *section, + unsigned section_line, + const char *lvalue, + int ltype, + const char *rvalue, + void *data, + void *userdata) { + + bool *b = data; + const char *value; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + if (streq(rvalue, "true")) + *b = true; + else if (streq(rvalue, "false")) + *b = false; + else + return log_syntax(unit, LOG_ERR, filename, line, SYNTHETIC_ERRNO(EINVAL), "Invalid value for boolean: %s", value); + + return 0; +} + +/* Unescapes the string in-place, returns non-zero status on error. */ +static int xdg_unescape_string( + const char *unit, + const char *filename, + int line, + char *str) { + + char *in; + char *out; + + assert(str); + + in = out = str; + + for (; *in; in++, out++) { + if (*in == '\\') { + /* Move forward, and ensure it is a valid escape. */ + in++; + + switch (*in) { + case 's': + *out = ' '; + break; + case 'n': + *out = '\n'; + break; + case 't': + *out = '\t'; + break; + case 'r': + *out = '\r'; + break; + case '\\': + *out = '\\'; + break; + case ';': + /* Technically only permitted for strv. */ + *out = ';'; + break; + default: + return log_syntax(unit, LOG_ERR, filename, line, SYNTHETIC_ERRNO(EINVAL), "Undefined escape sequence \\%c.", *in); + } + + continue; + } + + *out = *in; + } + *out = '\0'; + + return 0; +} + +/* Note: We do not bother with unescaping the strings, hence the _raw postfix. */ +static int xdg_config_parse_string( + const char *unit, + const char *filename, + unsigned line, + const char *section, + unsigned section_line, + const char *lvalue, + int ltype, + const char *rvalue, + void *data, + void *userdata) { + + _cleanup_free_ char *res = NULL; + char **out = data; + int r; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + /* XDG does not allow duplicate definitions. */ + if (*out) { + log_syntax(unit, LOG_ERR, filename, line, 0, "Key %s was defined multiple times, ignoring.", lvalue); + return 0; + } + + res = strdup(rvalue); + if (!res) + return log_oom(); + + r = xdg_unescape_string(unit, filename, line, res); + if (r < 0) + return r; + + *out = TAKE_PTR(res); + return 0; +} + +static int xdg_config_parse_strv( + const char *unit, + const char *filename, + unsigned line, + const char *section, + unsigned section_line, + const char *lvalue, + int ltype, + const char *rvalue, + void *data, + void *userdata) { + + char ***sv = data; + const char *start; + const char *end; + int r; + + assert(filename); + assert(lvalue); + assert(rvalue); + assert(data); + + /* XDG does not allow duplicate definitions. */ + if (*sv) { + log_syntax(unit, LOG_ERR, filename, line, 0, "Key %s was defined multiple times, ignoring.", lvalue); + return 0; + } + + *sv = strv_new(NULL); + if (!*sv) + return log_oom(); + + /* We cannot use strv_split because it does not handle escaping correctly. */ + start = rvalue; + + for (end = start; *end; end++) { + if (*end == '\\') { + /* Move forward, and ensure it is a valid escape. */ + end++; + if (strchr("sntr\\;", *end) == NULL) { + log_syntax(unit, LOG_ERR, filename, line, 0, "Undefined escape sequence \\%c.", *end); + return 0; + } + continue; + } + + if (*end == ';') { + _cleanup_free_ char *copy = NULL; + + copy = strndup(start, end - start); + if (!copy) + return log_oom(); + r = xdg_unescape_string(unit, filename, line, copy); + if (r < 0) + return r; + r = strv_consume(sv, TAKE_PTR(copy)); + if (r < 0) + return log_oom(); + + start = end + 1; + } + } + + /* Any trailing entry should be ignored if it is empty. */ + if (end > start) { + r = strv_extend(sv, start); + if (r < 0) + return log_oom(); + } + + return 0; +} + +static int xdg_config_item_table_lookup( + const void *table, + const char *section, + const char *lvalue, + ConfigParserCallback *func, + int *ltype, + void **data, + void *userdata) { + + assert(lvalue); + + /* Ignore any keys with [] as those are translations. */ + if (strchr(lvalue, '[')) { + *func = NULL; + *ltype = 0; + *data = NULL; + return 1; + } + + return config_item_table_lookup(table, section, lvalue, func, ltype, data, userdata); +} + +XdgAutostartService *xdg_autostart_service_parse_desktop(const char *path) { + _cleanup_(xdg_autostart_service_freep) XdgAutostartService *service = NULL; + int r; + + service = new0(XdgAutostartService, 1); + if (!service) + return NULL; + + service->path = strdup(path); + if (!service->path) + return NULL; + + const ConfigTableItem items[] = { + { "Desktop Entry", "Name", xdg_config_parse_string, 0, &service->description}, + { "Desktop Entry", "Exec", xdg_config_parse_string, 0, &service->exec_string}, + { "Desktop Entry", "TryExec", xdg_config_parse_string, 0, &service->try_exec}, + { "Desktop Entry", "Type", xdg_config_parse_string, 0, &service->type}, + { "Desktop Entry", "OnlyShowIn", xdg_config_parse_strv, 0, &service->only_show_in}, + { "Desktop Entry", "NotShowIn", xdg_config_parse_strv, 0, &service->not_show_in}, + { "Desktop Entry", "Hidden", xdg_config_parse_bool, 0, &service->hidden}, + { "Desktop Entry", "AutostartCondition", xdg_config_parse_string, 0, &service->autostart_condition}, + { "Desktop Entry", "X-KDE-autostart-condition", xdg_config_parse_string, 0, &service->kde_autostart_condition}, + { "Desktop Entry", "X-GNOME-Autostart-Phase", xdg_config_parse_string, 0, &service->gnome_autostart_phase}, + { "Desktop Entry", "X-systemd-skip", xdg_config_parse_bool, 0, &service->systemd_skip}, + + /* Common entries that we do not use currently. */ + { "Desktop Entry", "Categories", NULL, 0, NULL}, + { "Desktop Entry", "Comment", NULL, 0, NULL}, + { "Desktop Entry", "Encoding", NULL, 0, NULL}, + { "Desktop Entry", "GenericName", NULL, 0, NULL}, + { "Desktop Entry", "Icon", NULL, 0, NULL}, + { "Desktop Entry", "Keywords", NULL, 0, NULL}, + { "Desktop Entry", "NoDisplay", NULL, 0, NULL}, + { "Desktop Entry", "StartupNotify", NULL, 0, NULL}, + { "Desktop Entry", "Terminal", NULL, 0, NULL}, + { "Desktop Entry", "Version", NULL, 0, NULL}, + {} + }; + + r = config_parse(NULL, service->path, NULL, + "Desktop Entry\0", + xdg_config_item_table_lookup, items, + CONFIG_PARSE_WARN, service); + /* If parsing failed, only hide the file so it will still mask others. */ + if (r < 0) { + log_warning_errno(r, "Failed to parse %s, ignoring it", service->path); + service->hidden = true; + } + + return TAKE_PTR(service); +} + +int xdg_autostart_format_exec_start( + const char *exec, + char **ret_exec_start) { + + _cleanup_strv_free_ char **exec_split = NULL; + char *res; + size_t n, i; + bool first_arg; + int r; + + /* + * Unfortunately, there is a mismatch between systemd's idea of $PATH + * and XDGs. i.e. we need to ensure that we have an absolute path to + * support cases where $PATH has been modified from the default set. + * + * Note that this is only needed for development environments though; + * so while it is important, this should have no effect in production + * environments. + * + * To be compliant with the XDG specification, we also need to strip + * certain parameters and such. Doing so properly makes parsing the + * command line unavoidable. + * + * NOTE: Technically, XDG only specifies " as quotes, while this also + * accepts '. + */ + exec_split = strv_split_full(exec, WHITESPACE, SPLIT_QUOTES | SPLIT_RELAX); + if (!exec_split) + return -ENOMEM; + + if (strv_isempty(exec_split)) + return log_warning_errno(SYNTHETIC_ERRNO(EINVAL), "Exec line is empty"); + + first_arg = true; + for (i = n = 0; exec_split[i]; i++) { + _cleanup_free_ char *c = NULL, *raw = NULL, *p = NULL, *escaped = NULL, *quoted = NULL; + + r = cunescape(exec_split[i], 0, &c); + if (r < 0) + return log_debug_errno(r, "Failed to unescape '%s': %m", exec_split[i]); + + if (first_arg) { + _cleanup_free_ char *executable = NULL; + + /* This is the executable, find it in $PATH */ + first_arg = false; + r = find_binary(c, &executable); + if (r < 0) + return log_info_errno(r, "Exec binary '%s' does not exist: %m", c); + + escaped = cescape(executable); + if (!escaped) + return log_oom(); + + free(exec_split[n]); + exec_split[n++] = TAKE_PTR(escaped); + continue; + } + + /* + * Remove any standardised XDG fields; we assume they never appear as + * part of another argument as that just does not make any sense as + * they can be empty (GLib will e.g. turn "%f" into an empty argument). + * Other implementations may handle this differently. + */ + if (STR_IN_SET(c, + "%f", "%F", + "%u", "%U", + "%d", "%D", + "%n", "%N", + "%i", /* Location of icon, could be implemented. */ + "%c", /* Translated application name, could be implemented. */ + "%k", /* Location of desktop file, could be implemented. */ + "%v", + "%m" + )) + continue; + + /* + * %% -> % and then % -> %% means that we correctly quote any % + * and also quote any left over (and invalid) % specifier from + * the desktop file. + */ + raw = strreplace(c, "%%", "%"); + if (!raw) + return log_oom(); + p = strreplace(raw, "%", "%%"); + if (!p) + return log_oom(); + escaped = cescape(p); + if (!escaped) + return log_oom(); + + quoted = strjoin("\"", escaped, "\""); + if (!quoted) + return log_oom(); + + free(exec_split[n]); + exec_split[n++] = TAKE_PTR(quoted); + } + for (; exec_split[n]; n++) + exec_split[n] = mfree(exec_split[n]); + + res = strv_join(exec_split, " "); + if (!res) + return log_oom(); + + *ret_exec_start = res; + return 0; +} + +static int xdg_autostart_generate_desktop_condition( + FILE *f, + const char *test_binary, + const char *condition) { + + int r; + + /* Generate an ExecCondition for GNOME autostart condition */ + if (!isempty(condition)) { + _cleanup_free_ char *gnome_autostart_condition_path = NULL, *e_autostart_condition = NULL; + + r = find_binary(test_binary, &gnome_autostart_condition_path); + if (r < 0) { + log_full_errno(r == -ENOENT ? LOG_INFO : LOG_WARNING, r, + "%s not found: %m", test_binary); + fprintf(f, "# ExecCondition using %s skipped due to missing binary.\n", test_binary); + return r; + } + + e_autostart_condition = cescape(condition); + if (!e_autostart_condition) + return log_oom(); + + fprintf(f, + "ExecCondition=%s --condition \"%s\"\n", + gnome_autostart_condition_path, + e_autostart_condition); + } + + return 0; +} + +int xdg_autostart_service_generate_unit( + XdgAutostartService *service, + const char *dest) { + + _cleanup_free_ char *path_escaped = NULL, *exec_start = NULL, *unit = NULL; + _cleanup_fclose_ FILE *f = NULL; + int r; + + assert(service); + + /* Nothing to do for hidden services. */ + if (service->hidden) { + log_info("Not generating service for XDG autostart %s, it is hidden.", service->name); + return 0; + } + + if (service->systemd_skip) { + log_info("Not generating service for XDG autostart %s, should be skipped by generator.", service->name); + return 0; + } + + /* Nothing to do if type is not Application. */ + if (!streq_ptr(service->type, "Application")) { + log_info("Not generating service for XDG autostart %s, it is hidden.", service->name); + return 0; + } + + if (!service->exec_string) { + log_warning("Not generating service for XDG autostart %s, it is has no Exec= line.", service->name); + return 0; + } + + /* + * The TryExec key cannot be checked properly from the systemd unit, + * it is trivial to check using find_binary though. + */ + if (service->try_exec) { + r = find_binary(service->try_exec, NULL); + if (r < 0) { + log_full_errno(r == -ENOENT ? LOG_INFO : LOG_WARNING, r, + "Not generating service for XDG autostart %s, could not find TryExec= binary %s: %m", + service->name, service->try_exec); + return 0; + } + } + + r = xdg_autostart_format_exec_start(service->exec_string, &exec_start); + if (r < 0) { + log_warning_errno(r, + "Not generating service for XDG autostart %s, error parsing Exec= line: %m", + service->name); + return 0; + } + + if (streq_ptr(service->gnome_autostart_phase, "EarlyInitialization")) { + log_info("Not generating service for XDG autostart %s, EarlyInitialization needs to be handled separately.", + service->name); + return 0; + } + + path_escaped = specifier_escape(service->path); + if (!path_escaped) + return log_oom(); + + unit = path_join(dest, service->name); + if (!unit) + return log_oom(); + + f = fopen(unit, "wxe"); + if (!f) + return log_error_errno(errno, "Failed to create unit file %s: %m", unit); + + fprintf(f, + "# Automatically generated by systemd-xdg-autostart-generator\n\n" + "[Unit]\n" + "Documentation=man:systemd-xdg-autostart-generator(8)\n" + "SourcePath=%s\n" + "PartOf=graphical-session.target\n\n", + path_escaped); + + if (service->description) { + _cleanup_free_ char *t = NULL; + + t = specifier_escape(service->description); + if (!t) + return log_oom(); + + fprintf(f, "Description=%s\n", t); + } + + /* Only start after the session is ready. + * XXX: GNOME has an autostart order which we may want to support. + * It is not clear how this can be implemented reliably, which + * is why it is skipped for now. */ + fprintf(f, + "After=graphical-session.target\n"); + + fprintf(f, + "\n[Service]\n" + "Type=simple\n" + "ExecStart=:%s\n" + "Restart=no\n" + "TimeoutSec=5s\n" + "Slice=app.slice\n", + exec_start); + + /* Generate an ExecCondition to check $XDG_CURRENT_DESKTOP */ + if (!strv_isempty(service->only_show_in) || !strv_isempty(service->not_show_in)) { + _cleanup_free_ char *only_show_in = NULL, *not_show_in = NULL, *e_only_show_in = NULL, *e_not_show_in = NULL; + + only_show_in = strv_join(service->only_show_in, ":"); + not_show_in = strv_join(service->not_show_in, ":"); + if (!only_show_in || !not_show_in) + return log_oom(); + + e_only_show_in = cescape(only_show_in); + e_not_show_in = cescape(not_show_in); + if (!e_only_show_in || !e_not_show_in) + return log_oom(); + + /* Just assume the values are reasonably sane */ + fprintf(f, + "ExecCondition=" ROOTLIBEXECDIR "/systemd-xdg-autostart-condition \"%s\" \"%s\"\n", + e_only_show_in, + e_not_show_in); + } + + r = xdg_autostart_generate_desktop_condition(f, + "gnome-systemd-autostart-condition", + service->autostart_condition); + if (r < 0) + return r; + + r = xdg_autostart_generate_desktop_condition(f, + "kde-systemd-start-condition", + service->kde_autostart_condition); + if (r < 0) + return r; + + (void) generator_add_symlink(dest, "xdg-desktop-autostart.target", "wants", service->name); + + return 0; +} diff --git a/src/xdg-autostart-generator/xdg-autostart-service.h b/src/xdg-autostart-generator/xdg-autostart-service.h new file mode 100644 index 0000000000..685f97824e --- /dev/null +++ b/src/xdg-autostart-generator/xdg-autostart-service.h @@ -0,0 +1,36 @@ +/* SPDX-License-Identifier: LGPL-2.1+ */ +#pragma once + +#include "macro.h" + +typedef struct XdgAutostartService { + char *name; + char *path; + char *description; /* Name in XDG desktop file */ + + char *type; /* Purely as an assertion check */ + char *exec_string; + + char **only_show_in; + char **not_show_in; + + char *try_exec; + char *autostart_condition; /* This is mostly GNOME specific */ + char *kde_autostart_condition; + + char *gnome_autostart_phase; + + bool hidden; + bool systemd_skip; + +} XdgAutostartService; + + +XdgAutostartService * xdg_autostart_service_free(XdgAutostartService *s); +DEFINE_TRIVIAL_CLEANUP_FUNC(XdgAutostartService*, xdg_autostart_service_free); + +char *xdg_autostart_service_translate_name(const char *name); +int xdg_autostart_format_exec_start(const char *exec, char **ret_exec_start); + +XdgAutostartService *xdg_autostart_service_parse_desktop(const char *path); +int xdg_autostart_service_generate_unit(XdgAutostartService *service, const char *dest); diff --git a/units/user/meson.build b/units/user/meson.build index cb8f630b8c..33732e7d59 100644 --- a/units/user/meson.build +++ b/units/user/meson.build @@ -20,6 +20,10 @@ units = [ 'timers.target', ] +if conf.get('ENABLE_XDG_AUTOSTART') == 1 + units += [ 'xdg-desktop-autostart.target', ] +endif + foreach file : units install_data(file, install_dir : userunitdir) diff --git a/units/user/xdg-desktop-autostart.target b/units/user/xdg-desktop-autostart.target new file mode 100644 index 0000000000..22df5a35d3 --- /dev/null +++ b/units/user/xdg-desktop-autostart.target @@ -0,0 +1,14 @@ +# SPDX-License-Identifier: LGPL-2.1+ +# +# This file is part of systemd. +# +# systemd is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as published by +# the Free Software Foundation; either version 2.1 of the License, or +# (at your option) any later version. + +[Unit] +Description=Startup of XDG autostart applications +Documentation=man:systemd.special(7) +RefuseManualStart=yes +StopWhenUnneeded=yes