1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
7 #include "xdg-autostart-service.h"
9 #include "conf-parser.h"
11 #include "unit-name.h"
12 #include "path-util.h"
14 #include "generator.h"
16 #include "specifier.h"
17 #include "string-util.h"
18 #include "nulstr-util.h"
21 XdgAutostartService
* xdg_autostart_service_free(XdgAutostartService
*s
) {
31 free(s
->working_directory
);
33 strv_free(s
->only_show_in
);
34 strv_free(s
->not_show_in
);
37 free(s
->autostart_condition
);
38 free(s
->kde_autostart_condition
);
40 free(s
->gnome_autostart_phase
);
45 char *xdg_autostart_service_translate_name(const char *name
) {
46 _cleanup_free_
char *c
= NULL
, *escaped
= NULL
;
53 res
= endswith(c
, ".desktop");
57 escaped
= unit_name_escape(c
);
61 return strjoin("app-", escaped
, "@autostart.service");
64 static int xdg_config_parse_bool(
69 unsigned section_line
,
76 bool *b
= ASSERT_PTR(data
);
82 if (streq(rvalue
, "true"))
84 else if (streq(rvalue
, "false"))
87 return log_syntax(unit
, LOG_ERR
, filename
, line
, SYNTHETIC_ERRNO(EINVAL
), "Invalid value for boolean: %s", rvalue
);
92 /* Unescapes the string in-place, returns non-zero status on error. */
93 static int xdg_unescape_string(
106 for (; *in
; in
++, out
++) {
108 /* Move forward, and ensure it is a valid escape. */
128 /* Technically only permitted for strv. */
132 return log_syntax(unit
, LOG_ERR
, filename
, line
, SYNTHETIC_ERRNO(EINVAL
), "Undefined escape sequence \\%c.", *in
);
145 /* Note: We do not bother with unescaping the strings, hence the _raw postfix. */
146 static int xdg_config_parse_string(
148 const char *filename
,
151 unsigned section_line
,
158 _cleanup_free_
char *res
= NULL
;
159 char **out
= ASSERT_PTR(data
);
166 /* XDG does not allow duplicate definitions. */
168 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Key %s was defined multiple times, ignoring.", lvalue
);
172 res
= strdup(rvalue
);
176 r
= xdg_unescape_string(unit
, filename
, line
, res
);
180 *out
= TAKE_PTR(res
);
184 static int strv_strndup_unescape_and_push(
186 const char *filename
,
196 _cleanup_free_
char *copy
= NULL
;
199 copy
= strndup(start
, end
- start
);
203 r
= xdg_unescape_string(unit
, filename
, line
, copy
);
207 if (!GREEDY_REALLOC(*sv
, *n
+ 2)) /* One extra for NULL */
210 (*sv
)[*n
] = TAKE_PTR(copy
);
211 (*sv
)[*n
+ 1] = NULL
;
217 static int xdg_config_parse_strv(
219 const char *filename
,
222 unsigned section_line
,
229 char ***ret_sv
= ASSERT_PTR(data
);
236 /* XDG does not allow duplicate definitions. */
238 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Key %s was already defined, ignoring.", lvalue
);
243 _cleanup_strv_free_
char **sv
= NULL
;
245 if (!GREEDY_REALLOC0(sv
, 1))
248 /* We cannot use strv_split because it does not handle escaping correctly. */
249 const char *start
= rvalue
, *end
;
251 for (end
= start
; *end
; end
++) {
253 /* Move forward, and ensure it is a valid escape. */
255 if (!strchr("sntr\\;", *end
)) {
256 log_syntax(unit
, LOG_WARNING
, filename
, line
, 0, "Undefined escape sequence \\%c.", *end
);
263 r
= strv_strndup_unescape_and_push(unit
, filename
, line
,
273 /* Handle the trailing entry after the last separator */
274 r
= strv_strndup_unescape_and_push(unit
, filename
, line
,
280 *ret_sv
= TAKE_PTR(sv
);
284 static int xdg_config_item_table_lookup(
288 ConfigParserCallback
*ret_func
,
295 /* Ignore any keys with [] as those are translations. */
296 if (strchr(lvalue
, '[')) {
303 return config_item_table_lookup(table
, section
, lvalue
, ret_func
, ret_ltype
, ret_data
, userdata
);
306 XdgAutostartService
*xdg_autostart_service_parse_desktop(const char *path
) {
307 _cleanup_(xdg_autostart_service_freep
) XdgAutostartService
*service
= NULL
;
310 service
= new0(XdgAutostartService
, 1);
314 service
->path
= strdup(path
);
318 const ConfigTableItem items
[] = {
319 { "Desktop Entry", "Name", xdg_config_parse_string
, 0, &service
->description
},
320 { "Desktop Entry", "Exec", xdg_config_parse_string
, 0, &service
->exec_string
},
321 { "Desktop Entry", "Path", xdg_config_parse_string
, 0, &service
->working_directory
},
322 { "Desktop Entry", "TryExec", xdg_config_parse_string
, 0, &service
->try_exec
},
323 { "Desktop Entry", "Type", xdg_config_parse_string
, 0, &service
->type
},
324 { "Desktop Entry", "OnlyShowIn", xdg_config_parse_strv
, 0, &service
->only_show_in
},
325 { "Desktop Entry", "NotShowIn", xdg_config_parse_strv
, 0, &service
->not_show_in
},
326 { "Desktop Entry", "Hidden", xdg_config_parse_bool
, 0, &service
->hidden
},
327 { "Desktop Entry", "AutostartCondition", xdg_config_parse_string
, 0, &service
->autostart_condition
},
328 { "Desktop Entry", "X-KDE-autostart-condition", xdg_config_parse_string
, 0, &service
->kde_autostart_condition
},
329 { "Desktop Entry", "X-GNOME-Autostart-Phase", xdg_config_parse_string
, 0, &service
->gnome_autostart_phase
},
330 { "Desktop Entry", "X-systemd-skip", xdg_config_parse_bool
, 0, &service
->systemd_skip
},
332 /* Common entries that we do not use currently. */
333 { "Desktop Entry", "Categories", NULL
, 0, NULL
},
334 { "Desktop Entry", "Comment", NULL
, 0, NULL
},
335 { "Desktop Entry", "DBusActivatable", NULL
, 0, NULL
},
336 { "Desktop Entry", "Encoding", NULL
, 0, NULL
},
337 { "Desktop Entry", "GenericName", NULL
, 0, NULL
},
338 { "Desktop Entry", "Icon", NULL
, 0, NULL
},
339 { "Desktop Entry", "Keywords", NULL
, 0, NULL
},
340 { "Desktop Entry", "MimeType", NULL
, 0, NULL
},
341 { "Desktop Entry", "NoDisplay", NULL
, 0, NULL
},
342 { "Desktop Entry", "StartupNotify", NULL
, 0, NULL
},
343 { "Desktop Entry", "StartupWMClass", NULL
, 0, NULL
},
344 { "Desktop Entry", "Terminal", NULL
, 0, NULL
},
345 { "Desktop Entry", "URL", NULL
, 0, NULL
},
346 { "Desktop Entry", "Version", NULL
, 0, NULL
},
350 r
= config_parse(NULL
, service
->path
, NULL
,
352 xdg_config_item_table_lookup
, items
,
353 CONFIG_PARSE_WARN
, service
,
355 /* If parsing failed, only hide the file so it will still mask others. */
357 log_warning_errno(r
, "Failed to parse %s, ignoring it", service
->path
);
358 service
->hidden
= true;
361 return TAKE_PTR(service
);
364 int xdg_autostart_format_exec_start(
366 char **ret_exec_start
) {
368 _cleanup_strv_free_
char **exec_split
= NULL
;
375 * Unfortunately, there is a mismatch between systemd's idea of $PATH and XDGs. I.e. we need to
376 * ensure that we have an absolute path to support cases where $PATH has been modified from the
379 * Note that this is only needed for development environments though; so while it is important, this
380 * should have no effect in production environments.
382 * To be compliant with the XDG specification, we also need to strip certain parameters and
383 * such. Doing so properly makes parsing the command line unavoidable.
385 * NOTE: Technically, XDG only specifies " as quotes, while this also accepts '.
387 r
= strv_split_full(&exec_split
, exec
, NULL
, EXTRACT_UNQUOTE
| EXTRACT_RELAX
);
391 if (strv_isempty(exec_split
))
392 return log_warning_errno(SYNTHETIC_ERRNO(EINVAL
), "Exec line is empty");
395 for (i
= n
= 0; exec_split
[i
]; i
++) {
396 _cleanup_free_
char *c
= NULL
, *raw
= NULL
, *percent
= NULL
;
399 l
= cunescape(exec_split
[i
], 0, &c
);
401 return log_debug_errno(l
, "Failed to unescape '%s': %m", exec_split
[i
]);
404 _cleanup_free_
char *executable
= NULL
;
406 /* This is the executable, find it in $PATH */
408 r
= find_executable(c
, &executable
);
410 return log_info_errno(r
, "Exec binary '%s' does not exist: %m", c
);
412 free_and_replace(exec_split
[n
++], executable
);
417 * Remove any standardised XDG fields; we assume they never appear as part of another
418 * argument as that just does not make any sense as they can be empty (GLib will e.g. turn
419 * "%f" into an empty argument). Other implementations may handle this differently.
426 "%i", /* Location of icon, could be implemented. */
427 "%c", /* Translated application name, could be implemented. */
428 "%k", /* Location of desktop file, could be implemented. */
435 * %% -> % and then % -> %% means that we correctly quote any % and also quote any left over
436 * (and invalid) % specifier from the desktop file.
438 raw
= strreplace(c
, "%%", "%");
441 percent
= strreplace(raw
, "%", "%%");
445 free_and_replace(exec_split
[n
++], percent
);
447 for (; exec_split
[n
]; n
++)
448 exec_split
[n
] = mfree(exec_split
[n
]);
450 res
= quote_command_line(exec_split
, SHELL_ESCAPE_EMPTY
);
454 *ret_exec_start
= res
;
458 static int xdg_autostart_generate_desktop_condition(
459 const XdgAutostartService
*service
,
461 const char *test_binary
,
462 const char *condition
) {
466 /* Generate an ExecCondition for GNOME autostart condition */
467 if (!isempty(condition
)) {
468 _cleanup_free_
char *gnome_autostart_condition_path
= NULL
, *e_autostart_condition
= NULL
;
470 r
= find_executable(test_binary
, &gnome_autostart_condition_path
);
472 log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
473 "%s: ExecCondition executable %s not found, unit will not be started automatically: %m",
474 service
->path
, test_binary
);
475 fprintf(f
, "# ExecCondition using %s skipped due to missing binary.\n", test_binary
);
479 e_autostart_condition
= cescape(condition
);
480 if (!e_autostart_condition
)
483 log_debug("%s: ExecCondition converted to %s --condition \"%s\"%s",
484 service
->path
, gnome_autostart_condition_path
, e_autostart_condition
,
485 special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
488 "ExecCondition=%s --condition \"%s\"\n",
489 gnome_autostart_condition_path
,
490 e_autostart_condition
);
496 int xdg_autostart_service_generate_unit(
497 const XdgAutostartService
*service
,
500 _cleanup_free_
char *path_escaped
= NULL
, *exec_start
= NULL
, *unit
= NULL
;
501 _cleanup_fclose_
FILE *f
= NULL
;
506 /* Nothing to do for hidden services. */
507 if (service
->hidden
) {
508 log_debug("%s: not generating unit, entry is hidden.", service
->path
);
512 if (service
->systemd_skip
) {
513 log_debug("%s: not generating unit, marked as skipped by generator.", service
->path
);
517 /* Nothing to do if type is not Application. */
518 if (!streq_ptr(service
->type
, "Application")) {
519 log_debug("%s: not generating unit, Type=%s is not supported.", service
->path
, service
->type
);
523 if (!service
->exec_string
) {
524 log_warning("%s: not generating unit, no Exec= line.", service
->path
);
528 /* The TryExec key cannot be checked properly from the systemd unit, it is trivial to check using
529 * find_executable though. */
530 if (service
->try_exec
) {
531 r
= find_executable(service
->try_exec
, NULL
);
533 log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_WARNING
, r
,
534 "%s: not generating unit, could not find TryExec= binary %s: %m",
535 service
->path
, service
->try_exec
);
540 r
= xdg_autostart_format_exec_start(service
->exec_string
, &exec_start
);
542 log_warning_errno(r
, "%s: not generating unit, error parsing Exec= line: %m", service
->path
);
546 if (service
->gnome_autostart_phase
) {
547 /* There is no explicit value for the "Application" phase. */
548 log_debug("%s: not generating unit, startup phases are not supported.", service
->path
);
552 path_escaped
= specifier_escape(service
->path
);
556 unit
= path_join(dest
, service
->name
);
560 f
= fopen(unit
, "wxe");
562 return log_error_errno(errno
, "%s: failed to create unit file %s: %m", service
->path
, unit
);
565 "# Automatically generated by systemd-xdg-autostart-generator\n\n"
567 "Documentation=man:systemd-xdg-autostart-generator(8)\n"
569 "PartOf=graphical-session.target\n\n",
572 if (service
->description
) {
573 _cleanup_free_
char *t
= NULL
;
575 t
= specifier_escape(service
->description
);
579 fprintf(f
, "Description=%s\n", t
);
582 /* Only start after the session is ready. */
584 "After=graphical-session.target\n");
596 if (service
->working_directory
) {
597 _cleanup_free_
char *e_working_directory
= NULL
;
599 e_working_directory
= cescape(service
->working_directory
);
600 if (!e_working_directory
)
603 fprintf(f
, "WorkingDirectory=-%s\n", e_working_directory
);
606 /* Generate an ExecCondition to check $XDG_CURRENT_DESKTOP */
607 if (!strv_isempty(service
->only_show_in
) || !strv_isempty(service
->not_show_in
)) {
608 _cleanup_free_
char *only_show_in
= NULL
, *not_show_in
= NULL
, *e_only_show_in
= NULL
, *e_not_show_in
= NULL
;
610 only_show_in
= strv_join(service
->only_show_in
, ":");
611 not_show_in
= strv_join(service
->not_show_in
, ":");
612 if (!only_show_in
|| !not_show_in
)
615 e_only_show_in
= cescape(only_show_in
);
616 e_not_show_in
= cescape(not_show_in
);
617 if (!e_only_show_in
|| !e_not_show_in
)
620 /* Just assume the values are reasonably sane */
622 "ExecCondition=" ROOTLIBEXECDIR
"/systemd-xdg-autostart-condition \"%s\" \"%s\"\n",
627 r
= xdg_autostart_generate_desktop_condition(service
, f
,
628 "gnome-systemd-autostart-condition",
629 service
->autostart_condition
);
633 r
= xdg_autostart_generate_desktop_condition(service
, f
,
634 "kde-systemd-start-condition",
635 service
->kde_autostart_condition
);
639 log_debug("%s: symlinking %s in xdg-desktop-autostart.target/.wants%s",
640 service
->path
, service
->name
, special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
641 return generator_add_symlink(dest
, "xdg-desktop-autostart.target", "wants", service
->name
);