diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml
index 41014abc73..f61c07ae9d 100644
--- a/man/systemd-escape.xml
+++ b/man/systemd-escape.xml
@@ -76,9 +76,12 @@
Inserts the escaped strings in a unit name
template. Takes a unit name template such as
- foobar@.service. May not be used in
- conjunction with ,
- or
+ foobar@.service. With
+ , expects instantiated unit names
+ for this template and extracts and unescapes just the instance
+ part. May not be used in conjunction with
+ ,
+ or
.
@@ -100,8 +103,7 @@
Instead of escaping the specified strings,
undo the escaping, reversing the operation. May not be used in
- conjunction with ,
- or
+ conjunction with or
.
@@ -117,6 +119,19 @@
.
+
+
+
+ With , unescape
+ and print only the instance part of an instantiated unit name
+ template. Results in an error for an uninstantiated template
+ like ssh@.service or a non-template name
+ like ssh.service.
+ Must be used in conjunction with
+ and may not be used in conjunction with
+ .
+
+
@@ -141,6 +156,14 @@ tmp-waldi-foobar.mount
To generate instance names of three strings:$ systemd-escape --template=systemd-nspawn@.service 'My Container 1' 'containerb' 'container/III'
systemd-nspawn@My\x20Container\x201.service systemd-nspawn@containerb.service systemd-nspawn@container-III.service
+
+ To extract the instance part of an instantiated unit:
+ $ systemd-escape -u --instance 'systemd-nspawn@My\x20Container\x201.service'
+My Container 1
+
+ To extract the instance part of an instance of a particular template:
+ $ systemd-escape -u --template=systemd-nspawn@.service 'systemd-nspawn@My\x20Container\x201.service'
+My Container 1
diff --git a/src/escape/escape.c b/src/escape/escape.c
index 371ddbe02b..eaf0a9a7af 100644
--- a/src/escape/escape.c
+++ b/src/escape/escape.c
@@ -21,6 +21,7 @@ static enum {
static const char *arg_suffix = NULL;
static const char *arg_template = NULL;
static bool arg_path = false;
+static bool arg_instance = false;
static void help(void) {
printf("%s [OPTIONS...] [NAME...]\n\n"
@@ -29,6 +30,7 @@ static void help(void) {
" --version Show package version\n"
" --suffix=SUFFIX Unit suffix to append to escaped strings\n"
" --template=TEMPLATE Insert strings as instance into template\n"
+ " --instance With --unescape, show just the instance part\n"
" -u --unescape Unescape strings\n"
" -m --mangle Mangle strings\n"
" -p --path When escaping/unescaping assume the string is a path\n"
@@ -51,6 +53,7 @@ static int parse_argv(int argc, char *argv[]) {
{ "unescape", no_argument, NULL, 'u' },
{ "mangle", no_argument, NULL, 'm' },
{ "path", no_argument, NULL, 'p' },
+ { "instance", no_argument, NULL, 'i' },
{}
};
@@ -102,6 +105,10 @@ static int parse_argv(int argc, char *argv[]) {
arg_path = true;
break;
+ case 'i':
+ arg_instance = true;
+ break;
+
case '?':
return -EINVAL;
@@ -119,8 +126,13 @@ static int parse_argv(int argc, char *argv[]) {
return -EINVAL;
}
- if ((arg_template || arg_suffix) && arg_action != ACTION_ESCAPE) {
- log_error("--suffix= and --template= are not compatible with --unescape or --mangle.");
+ if ((arg_template || arg_suffix) && arg_action == ACTION_MANGLE) {
+ log_error("--suffix= and --template= are not compatible with --mangle.");
+ return -EINVAL;
+ }
+
+ if (arg_suffix && arg_action == ACTION_UNESCAPE) {
+ log_error("--suffix is not compatible with --unescape.");
return -EINVAL;
}
@@ -129,6 +141,16 @@ static int parse_argv(int argc, char *argv[]) {
return -EINVAL;
}
+ if (arg_instance && arg_action != ACTION_UNESCAPE) {
+ log_error("--instance must be used in conjunction with --unescape.");
+ return -EINVAL;
+ }
+
+ if (arg_instance && arg_template) {
+ log_error("--instance may not be combined with --template.");
+ return -EINVAL;
+ }
+
return 1;
}
@@ -189,17 +211,51 @@ int main(int argc, char *argv[]) {
break;
- case ACTION_UNESCAPE:
+ case ACTION_UNESCAPE: {
+ _cleanup_free_ char *name = NULL;
+
+ if (arg_template || arg_instance) {
+ _cleanup_free_ char *template = NULL;
+
+ r = unit_name_to_instance(*i, &name);
+ if (r < 0) {
+ log_error_errno(r, "Failed to extract instance: %m");
+ goto finish;
+ }
+ if (isempty(name)) {
+ log_error("Unit %s is missing the instance name.", *i);
+ r = -EINVAL;
+ goto finish;
+ }
+ r = unit_name_template(*i, &template);
+ if (r < 0) {
+ log_error_errno(r, "Failed to extract template: %m");
+ goto finish;
+ }
+ if (arg_template && !streq(arg_template, template)) {
+ log_error("Unit %s template %s does not match specified template %s.", *i, template, arg_template);
+ r = -EINVAL;
+ goto finish;
+ }
+ } else {
+ name = strdup(*i);
+ if (!name) {
+ r = log_oom();
+ goto finish;
+ }
+ }
+
if (arg_path)
- r = unit_name_path_unescape(*i, &e);
+ r = unit_name_path_unescape(name, &e);
else
- r = unit_name_unescape(*i, &e);
+ r = unit_name_unescape(name, &e);
if (r < 0) {
log_error_errno(r, "Failed to unescape string: %m");
goto finish;
}
break;
+ }
case ACTION_MANGLE:
r = unit_name_mangle(*i, 0, &e);