Zbigniew Jędrzejewski-Szmek
607f032858
Fixes #6308: people want to be able to link a unit file via 'systemctl enable' from a git checkout or such and refer to other files in the same repo. The new specifiers make that easy. %y/%Y is used because other more obvious choices like %d/%D or %p/%P are not available because at least on of the two letters is already used. The new specifiers are only available in units. Technically it would be trivial to add then in [Install] too, but I don't see how they could be useful, so I didn't do that. I added both %y and %Y because both were requested in the issue, and because I think both could be useful, depending on the case. %Y to refer to other files in the same repo, and %y in the case where a single repo has multiple unit files, and e.g. each unit has some corresponding asset named after the unit file.
248 lines
8.9 KiB
C
248 lines
8.9 KiB
C
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
|
|
#include "alloc-util.h"
|
|
#include "cgroup-util.h"
|
|
#include "format-util.h"
|
|
#include "macro.h"
|
|
#include "specifier.h"
|
|
#include "string-util.h"
|
|
#include "strv.h"
|
|
#include "unit-name.h"
|
|
#include "unit-printf.h"
|
|
#include "unit.h"
|
|
#include "user-util.h"
|
|
|
|
static int specifier_prefix_and_instance(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
|
|
return unit_name_to_prefix_and_instance(u->id, ret);
|
|
}
|
|
|
|
static int specifier_prefix(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
|
|
return unit_name_to_prefix(u->id, ret);
|
|
}
|
|
|
|
static int specifier_prefix_unescaped(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
_cleanup_free_ char *p = NULL;
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
int r;
|
|
|
|
r = unit_name_to_prefix(u->id, &p);
|
|
if (r < 0)
|
|
return r;
|
|
|
|
return unit_name_unescape(p, ret);
|
|
}
|
|
|
|
static int specifier_instance_unescaped(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
|
|
return unit_name_unescape(strempty(u->instance), ret);
|
|
}
|
|
|
|
static int specifier_last_component(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
_cleanup_free_ char *prefix = NULL;
|
|
char *dash;
|
|
int r;
|
|
|
|
r = unit_name_to_prefix(u->id, &prefix);
|
|
if (r < 0)
|
|
return r;
|
|
|
|
dash = strrchr(prefix, '-');
|
|
if (dash)
|
|
return specifier_string(specifier, dash + 1, root, userdata, ret);
|
|
|
|
*ret = TAKE_PTR(prefix);
|
|
return 0;
|
|
}
|
|
|
|
static int specifier_last_component_unescaped(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
_cleanup_free_ char *p = NULL;
|
|
int r;
|
|
|
|
r = specifier_last_component(specifier, data, root, userdata, &p);
|
|
if (r < 0)
|
|
return r;
|
|
|
|
return unit_name_unescape(p, ret);
|
|
}
|
|
|
|
static int specifier_filename(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
|
|
if (u->instance)
|
|
return unit_name_path_unescape(u->instance, ret);
|
|
else
|
|
return unit_name_to_path(u->id, ret);
|
|
}
|
|
|
|
static void bad_specifier(const Unit *u, char specifier) {
|
|
log_unit_warning(u, "Specifier '%%%c' used in unit configuration, which is deprecated. Please update your unit file, as it does not work as intended.", specifier);
|
|
}
|
|
|
|
static int specifier_cgroup(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
char *n;
|
|
|
|
bad_specifier(u, specifier);
|
|
|
|
if (u->cgroup_path)
|
|
n = strdup(u->cgroup_path);
|
|
else
|
|
n = unit_default_cgroup_path(u);
|
|
if (!n)
|
|
return -ENOMEM;
|
|
|
|
*ret = n;
|
|
return 0;
|
|
}
|
|
|
|
static int specifier_cgroup_root(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
char *n;
|
|
|
|
bad_specifier(u, specifier);
|
|
|
|
n = strdup(u->manager->cgroup_root);
|
|
if (!n)
|
|
return -ENOMEM;
|
|
|
|
*ret = n;
|
|
return 0;
|
|
}
|
|
|
|
static int specifier_cgroup_slice(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata), *slice;
|
|
char *n;
|
|
|
|
bad_specifier(u, specifier);
|
|
|
|
slice = UNIT_GET_SLICE(u);
|
|
if (slice) {
|
|
if (slice->cgroup_path)
|
|
n = strdup(slice->cgroup_path);
|
|
else
|
|
n = unit_default_cgroup_path(slice);
|
|
} else
|
|
n = strdup(u->manager->cgroup_root);
|
|
if (!n)
|
|
return -ENOMEM;
|
|
|
|
*ret = n;
|
|
return 0;
|
|
}
|
|
|
|
static int specifier_special_directory(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
|
|
const Unit *u = ASSERT_PTR(userdata);
|
|
char *n = NULL;
|
|
|
|
n = strdup(u->manager->prefix[PTR_TO_UINT(data)]);
|
|
if (!n)
|
|
return -ENOMEM;
|
|
|
|
*ret = n;
|
|
return 0;
|
|
}
|
|
|
|
int unit_name_printf(const Unit *u, const char* format, char **ret) {
|
|
/*
|
|
* This will use the passed string as format string and replace the following specifiers (which should all be
|
|
* safe for inclusion in unit names):
|
|
*
|
|
* %n: the full id of the unit (foo-aaa@bar.waldo)
|
|
* %N: the id of the unit without the suffix (foo-aaa@bar)
|
|
* %p: the prefix (foo-aaa)
|
|
* %i: the instance (bar)
|
|
* %j: the last component of the prefix (aaa)
|
|
*/
|
|
|
|
const Specifier table[] = {
|
|
{ 'i', specifier_string, u->instance },
|
|
{ 'j', specifier_last_component, NULL },
|
|
{ 'n', specifier_string, u->id },
|
|
{ 'N', specifier_prefix_and_instance, NULL },
|
|
{ 'p', specifier_prefix, NULL },
|
|
|
|
COMMON_SYSTEM_SPECIFIERS,
|
|
|
|
COMMON_CREDS_SPECIFIERS,
|
|
{}
|
|
};
|
|
|
|
assert(u);
|
|
assert(format);
|
|
assert(ret);
|
|
|
|
return specifier_printf(format, UNIT_NAME_MAX, table, NULL, u, ret);
|
|
}
|
|
|
|
int unit_full_printf_full(const Unit *u, const char *format, size_t max_length, char **ret) {
|
|
/* This is similar to unit_name_printf() but also supports unescaping. Also, adds a couple of additional codes
|
|
* (which are likely not suitable for unescaped inclusion in unit names):
|
|
*
|
|
* %f: the unescaped instance if set, otherwise the id unescaped as path
|
|
*
|
|
* %c: cgroup path of unit (deprecated)
|
|
* %r: where units in this slice are placed in the cgroup tree (deprecated)
|
|
* %R: the root of this systemd's instance tree (deprecated)
|
|
*
|
|
* %C: the cache directory root (e.g. /var/cache or $XDG_CACHE_HOME)
|
|
* %E: the configuration directory root (e.g. /etc or $XDG_CONFIG_HOME)
|
|
* %L: the log directory root (e.g. /var/log or $XDG_CONFIG_HOME/log)
|
|
* %S: the state directory root (e.g. /var/lib or $XDG_CONFIG_HOME)
|
|
* %t: the runtime directory root (e.g. /run or $XDG_RUNTIME_DIR)
|
|
*
|
|
* %h: the homedir of the running user
|
|
* %s: the shell of the running user
|
|
*
|
|
* NOTICE: When you add new entries here, please be careful: specifiers which depend on settings of the unit
|
|
* file itself are broken by design, as they would resolve differently depending on whether they are used
|
|
* before or after the relevant configuration setting. Hence: don't add them.
|
|
*/
|
|
|
|
assert(u);
|
|
assert(format);
|
|
assert(ret);
|
|
|
|
const Specifier table[] = {
|
|
{ 'i', specifier_string, u->instance },
|
|
{ 'I', specifier_instance_unescaped, NULL },
|
|
{ 'j', specifier_last_component, NULL },
|
|
{ 'J', specifier_last_component_unescaped, NULL },
|
|
{ 'n', specifier_string, u->id },
|
|
{ 'N', specifier_prefix_and_instance, NULL },
|
|
{ 'p', specifier_prefix, NULL },
|
|
{ 'P', specifier_prefix_unescaped, NULL },
|
|
|
|
{ 'f', specifier_filename, NULL },
|
|
{ 'y', specifier_real_path, u->fragment_path },
|
|
{ 'Y', specifier_real_directory, u->fragment_path },
|
|
|
|
{ 'c', specifier_cgroup, NULL },
|
|
{ 'r', specifier_cgroup_slice, NULL },
|
|
{ 'R', specifier_cgroup_root, NULL },
|
|
|
|
{ 'C', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_CACHE) },
|
|
{ 'E', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_CONFIGURATION) },
|
|
{ 'L', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_LOGS) },
|
|
{ 'S', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_STATE) },
|
|
{ 't', specifier_special_directory, UINT_TO_PTR(EXEC_DIRECTORY_RUNTIME) },
|
|
|
|
{ 'h', specifier_user_home, NULL },
|
|
{ 's', specifier_user_shell, NULL },
|
|
|
|
COMMON_SYSTEM_SPECIFIERS,
|
|
|
|
COMMON_CREDS_SPECIFIERS,
|
|
|
|
COMMON_TMP_SPECIFIERS,
|
|
{}
|
|
};
|
|
|
|
return specifier_printf(format, max_length, table, NULL, u, ret);
|
|
}
|