15986406979

Committed 30 Jun 2025 05:03PM UTC coverage: 72.045% (-0.09%) from 72.13%

Build # 15986406979

Build Type

push

github

Committed by

bluca

Commit Message

man/systemd-sysext: list ephemeral/ephemeral-import in the list of options

ephemeral/ephemeral-import are described as possible '--mutable' options but
not present in the list. Note, "systemd-sysext --help" lists them correctly.

Run Details

300514 of 417119 relevant lines covered (72.05%)

708586.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.12

/src/shared/edit-util.c

/* SPDX-License-Identifier: LGPL-2.1-or-later */

#include <stdio.h>
#include <stdlib.h>
#include <sys/stat.h>
#include <unistd.h>

#include "alloc-util.h"
#include "copy.h"
#include "edit-util.h"
#include "errno-util.h"
#include "fd-util.h"
#include "fileio.h"
#include "fs-util.h"
#include "log.h"
#include "mkdir-label.h"
#include "path-util.h"
#include "process-util.h"
#include "string-util.h"
#include "strv.h"
#include "tmpfile-util-label.h"

typedef struct EditFile {
        EditFileContext *context;
        char *path;
        char *original_path;
        char **comment_paths;
        char *temp;
        unsigned line;
} EditFile;

void edit_file_context_done(EditFileContext *context) {
        int r;

        assert(context);

        FOREACH_ARRAY(i, context->files, context->n_files) {
                unlink_and_free(i->temp);

                if (context->remove_parent) {
                        _cleanup_free_ char *parent = NULL;

                        r = path_extract_directory(i->path, &parent);
                        if (r < 0)
                                log_debug_errno(r, "Failed to extract directory from '%s', ignoring: %m", i->path);
                        else if (rmdir(parent) < 0 && !IN_SET(errno, ENOENT, ENOTEMPTY))
                                log_debug_errno(errno, "Failed to remove parent directory '%s', ignoring: %m", parent);
                }

                free(i->path);
                free(i->original_path);
                strv_free(i->comment_paths);
        }

        context->files = mfree(context->files);
        context->n_files = 0;
}

bool edit_files_contains(const EditFileContext *context, const char *path) {
        assert(context);
        assert(path);

        FOREACH_ARRAY(i, context->files, context->n_files)
                if (path_equal(i->path, path))
                        return true;

        return false;
}

int edit_files_add(
                EditFileContext *context,
                const char *path,
                const char *original_path,
                char * const *comment_paths) {

        _cleanup_free_ char *new_path = NULL, *new_original_path = NULL;
        _cleanup_strv_free_ char **new_comment_paths = NULL;

        assert(context);
        assert(path);

        if (edit_files_contains(context, path))
                return 0;

        if (!GREEDY_REALLOC(context->files, context->n_files + 1))
                return log_oom();

        new_path = strdup(path);
        if (!new_path)
                return log_oom();

        if (original_path) {
                new_original_path = strdup(original_path);
                if (!new_original_path)
                        return log_oom();
        }

        if (comment_paths) {
                new_comment_paths = strv_copy(comment_paths);
                if (!new_comment_paths)
                        return log_oom();
        }

        context->files[context->n_files] = (EditFile) {
                .context = context,
                .path = TAKE_PTR(new_path),
                .original_path = TAKE_PTR(new_original_path),
                .comment_paths = TAKE_PTR(new_comment_paths),
                .line = 1,
        };
        context->n_files++;

        return 1;
}

static int populate_edit_temp_file(EditFile *e, FILE *f, const char *filename) {
        assert(e);
        assert(e->context);
        assert(!e->context->read_from_stdin);
        assert(e->path);
        assert(f);
        assert(filename);

        bool has_original = e->original_path && access(e->original_path, F_OK) >= 0;
        bool has_target = access(e->path, F_OK) >= 0;
        const char *source;
        int r;

        if (has_original && (!has_target || e->context->overwrite_with_origin))
                /* We are asked to overwrite target with original_path or target doesn't exist. */
                source = e->original_path;
        else if (has_target)
                /* Target exists and shouldn't be overwritten. */
                source = e->path;
        else
                source = NULL;

        if (e->comment_paths) {
                _cleanup_free_ char *source_contents = NULL;

                if (source) {
                        r = read_full_file(source, &source_contents, NULL);
                        if (r < 0)
                                return log_error_errno(r, "Failed to read source file '%s': %m", source);
                }

                fprintf(f,
                        "### Editing %s\n"
                        "%s\n"
                        "\n"
                        "%s%s"
                        "\n"
                        "%s\n",
                        e->path,
                        e->context->marker_start,
                        strempty(source_contents),
                        source_contents && endswith(source_contents, "\n") ? "" : "\n",
                        e->context->marker_end);

                e->line = 4; /* Start editing at the contents area */

                STRV_FOREACH(path, e->comment_paths) {
                        _cleanup_free_ char *comment = NULL;

                        /* Skip the file which is being edited and the source file (can be the same) */
                        if (PATH_IN_SET(*path, e->path, source))
                                continue;

                        r = read_full_file(*path, &comment, NULL);
                        if (r < 0)
                                return log_error_errno(r, "Failed to read comment file '%s': %m", *path);

                        fprintf(f, "\n\n### %s", *path);

                        if (!isempty(comment)) {
                                _cleanup_free_ char *c = NULL;

                                c = strreplace(strstrip(comment), "\n", "\n# ");
                                if (!c)
                                        return log_oom();

                                fprintf(f, "\n# %s", c);
                        }
                }
        } else if (source) {
                r = copy_file_fd(source, fileno(f), COPY_REFLINK);
                if (r < 0) {
                        assert(r != -ENOENT);
                        return log_error_errno(r, "Failed to copy file '%s' to temporary file '%s': %m",
                                               source, filename);
                }
        }

        return 0;
}

static int create_edit_temp_file(EditFile *e, const char *contents, size_t contents_size) {
        _cleanup_(unlink_and_freep) char *temp = NULL;
        _cleanup_fclose_ FILE *f = NULL;
        int r;

        assert(e);
        assert(e->context);
        assert(e->path);
        assert(!e->comment_paths || (e->context->marker_start && e->context->marker_end));
        assert(contents || contents_size == 0);
        assert(e->context->read_from_stdin == !!contents);

        if (e->temp)
                return 0;

        r = mkdir_parents_label(e->path, 0755);
        if (r < 0)
                return log_error_errno(r, "Failed to create parent directories for '%s': %m", e->path);

        r = fopen_temporary_label(e->path, e->path, &f, &temp);
        if (r < 0)
                return log_error_errno(r, "Failed to create temporary file for '%s': %m", e->path);

        if (fchmod(fileno(f), 0644) < 0)
                return log_error_errno(errno, "Failed to change mode of temporary file '%s': %m", temp);

        if (e->context->read_from_stdin) {
                if (fwrite(contents, 1, contents_size, f) != contents_size)
                        return log_error_errno(SYNTHETIC_ERRNO(EIO),
                                               "Failed to write stdin data to temporary file '%s'.", temp);
        } else {
                r = populate_edit_temp_file(e, f, temp);
                if (r < 0)
                        return r;
        }

        r = fflush_and_check(f);
        if (r < 0)
                return log_error_errno(r, "Failed to write to temporary file '%s': %m", temp);

        e->temp = TAKE_PTR(temp);

        return 0;
}

static int run_editor_child(const EditFileContext *context) {
        _cleanup_strv_free_ char **args = NULL, **editor = NULL;
        int r;

        assert(context);
        assert(context->n_files >= 1);

        /* SYSTEMD_EDITOR takes precedence over EDITOR which takes precedence over VISUAL.
         * If neither SYSTEMD_EDITOR nor EDITOR nor VISUAL are present, we try to execute
         * well known editors. */
        FOREACH_STRING(e, "SYSTEMD_EDITOR", "EDITOR", "VISUAL") {
                const char *m = empty_to_null(getenv(e));
                if (m) {
                        editor = strv_split(m, WHITESPACE);
                        if (!editor)
                                return log_oom();

                        break;
                }
        }

        if (context->n_files == 1 && context->files[0].line > 1) {
                /* If editing a single file only, use the +LINE syntax to put cursor on the right line */
                r = strv_extendf(&args, "+%u", context->files[0].line);
                if (r < 0)
                        return log_oom();
        }

        FOREACH_ARRAY(i, context->files, context->n_files) {
                r = strv_extend(&args, i->temp);
                if (r < 0)
                        return log_oom();
        }

        size_t editor_n = strv_length(editor);
        if (editor_n > 0) {
                /* Strings are owned by 'editor' and 'args' */
                _cleanup_free_ char **cmdline = new(char*, editor_n + strv_length(args) + 1);
                if (!cmdline)
                        return log_oom();

                *mempcpy_typesafe(mempcpy_typesafe(cmdline, editor, editor_n), args, strv_length(args)) = NULL;

                execvp(cmdline[0], cmdline);
                log_warning_errno(errno, "Specified editor '%s' not available, trying fallbacks: %m", editor[0]);
        }

        bool prepended = false;
        FOREACH_STRING(name, "editor", "nano", "vim", "vi") {
                if (!prepended) {
                        r = strv_prepend(&args, name);
                        prepended = true;
                } else
                        r = free_and_strdup(&args[0], name);
                if (r < 0)
                        return log_oom();

                execvp(args[0], (char* const*) args);

                /* We do not fail if the editor doesn't exist because we want to try each one of them
                 * before failing. */
                if (errno != ENOENT)
                        return log_error_errno(errno, "Failed to execute '%s': %m", name);
        }

        return log_error_errno(SYNTHETIC_ERRNO(ENOENT),
                               "Cannot edit files, no editor available. Please set either $SYSTEMD_EDITOR, $EDITOR or $VISUAL.");
}

static int run_editor(const EditFileContext *context) {
        int r;

        assert(context);

        r = safe_fork("(editor)", FORK_RESET_SIGNALS|FORK_DEATHSIG_SIGTERM|FORK_RLIMIT_NOFILE_SAFE|FORK_CLOSE_ALL_FDS|FORK_REOPEN_LOG|FORK_LOG|FORK_WAIT, NULL);
        if (r < 0)
                return r;
        if (r == 0) { /* Child */
                r = run_editor_child(context);
                _exit(r < 0 ? EXIT_FAILURE : EXIT_SUCCESS);
        }

        return 0;
}

static int strip_edit_temp_file(EditFile *e) {
        _cleanup_free_ char *old_contents = NULL, *tmp = NULL, *new_contents = NULL;
        const char *stripped;
        bool with_marker;
        int r;

        assert(e);
        assert(e->context);
        assert(!e->context->marker_start == !e->context->marker_end);
        assert(e->temp);

        r = read_full_file(e->temp, &old_contents, NULL);
        if (r < 0)
                return log_error_errno(r, "Failed to read temporary file '%s': %m", e->temp);

        tmp = strdup(old_contents);
        if (!tmp)
                return log_oom();

        with_marker = e->context->marker_start && !e->context->read_from_stdin;

        if (with_marker) {
                /* Trim out the lines between the two markers */
                char *contents_start, *contents_end;

                contents_start = strstrafter(tmp, e->context->marker_start) ?: tmp;

                contents_end = strstr(contents_start, e->context->marker_end);
                if (contents_end)
                        *contents_end = '\0';

                stripped = strstrip(contents_start);
        } else
                stripped = strstrip(tmp);

        if (isempty(stripped)) {
                /* People keep coming back to #24208 due to edits outside of markers. Let's detect this
                 * and point them in the right direction. */
                if (with_marker)
                        for (const char *p = old_contents;;) {
                                p = skip_leading_chars(p, WHITESPACE);
                                if (*p == '\0')
                                        break;
                                if (*p != '#') {
                                        log_warning("Found modifications outside of the staging area, which would be discarded.");
                                        break;
                                }

                                /* Skip the whole line if commented out */
                                p = strchr(p, '\n');
                                if (!p)
                                        break;
                                p++;
                        }

                return 0; /* File is empty (has no real changes) */
        }

        /* Trim prefix and suffix, but ensure suffixed by single newline */
        new_contents = strjoin(stripped, "\n");
        if (!new_contents)
                return log_oom();

        if (streq(old_contents, new_contents)) /* Don't touch the file if the above didn't change a thing */
                return 1; /* Contents have real changes */

        r = write_string_file(e->temp, new_contents,
                              WRITE_STRING_FILE_TRUNCATE | WRITE_STRING_FILE_AVOID_NEWLINE);
        if (r < 0)
                return log_error_errno(r, "Failed to strip temporary file '%s': %m", e->temp);

        return 1; /* Contents have real changes */
}

static int edit_file_install_one(EditFile *e) {
        int r;

        assert(e);
        assert(e->path);
        assert(e->temp);

        r = strip_edit_temp_file(e);
        if (r <= 0)
                return r;

        r = RET_NERRNO(rename(e->temp, e->path));
        if (r < 0)
                return log_error_errno(r,
                                       "Failed to rename temporary file '%s' to target file '%s': %m",
                                       e->temp, e->path);
        e->temp = mfree(e->temp);

        return 1;
}

static int edit_file_install_one_stdin(EditFile *e, const char *contents, size_t contents_size, int *fd) {
        int r;

        assert(e);
        assert(e->path);
        assert(contents || contents_size == 0);
        assert(fd);

        if (contents_size == 0)
                return 0;

        if (*fd >= 0) {
                r = mkdir_parents_label(e->path, 0755);
                if (r < 0)
                        return log_error_errno(r, "Failed to create parent directories for '%s': %m", e->path);

                r = copy_file_atomic_at(*fd, NULL, AT_FDCWD, e->path, 0644, COPY_REFLINK|COPY_REPLACE|COPY_MAC_CREATE);
                if (r < 0)
                        return log_error_errno(r, "Failed to copy stdin contents to '%s': %m", e->path);

                return 1;
        }

        r = create_edit_temp_file(e, contents, contents_size);
        if (r < 0)
                return r;

        _cleanup_close_ int tfd = open(e->temp, O_PATH|O_CLOEXEC);
        if (tfd < 0)
                return log_error_errno(errno, "Failed to pin temporary file '%s': %m", e->temp);

        r = edit_file_install_one(e);
        if (r <= 0)
                return r;

        *fd = TAKE_FD(tfd);

        return 1;
}

int do_edit_files_and_install(EditFileContext *context) {
        _cleanup_free_ char *stdin_data = NULL;
        size_t stdin_size = 0;
        int r;

        assert(context);

        if (context->n_files == 0)
                return log_debug_errno(SYNTHETIC_ERRNO(ENOENT), "Got no files to edit.");

        if (context->read_from_stdin) {
                r = read_full_stream(stdin, &stdin_data, &stdin_size);
                if (r < 0)
                        return log_error_errno(r, "Failed to read stdin: %m");
        } else {
                FOREACH_ARRAY(editfile, context->files, context->n_files) {
                        r = create_edit_temp_file(editfile, /* contents = */ NULL, /* contents_size = */ 0);
                        if (r < 0)
                                return r;
                }

                r = run_editor(context);
                if (r < 0)
                        return r;
        }

        _cleanup_close_ int stdin_data_fd = -EBADF;

        FOREACH_ARRAY(editfile, context->files, context->n_files) {
                if (context->read_from_stdin) {
                        r = edit_file_install_one_stdin(editfile, stdin_data, stdin_size, &stdin_data_fd);
                        if (r == 0) {
                                log_notice("Stripped stdin content is empty, not writing file.");
                                return 0;
                        }
                } else {
                        r = edit_file_install_one(editfile);
                        if (r == 0) {
                                log_notice("%s: after editing, new contents are empty, not writing file.",
                                           editfile->path);
                                continue;
                        }
                }
                if (r < 0)
                        return r;

                log_info("Successfully installed edited file '%s'.", editfile->path);
        }

        return 0;
}

1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3	#include <stdio.h>
4	#include <stdlib.h>
5	#include <sys/stat.h>
6	#include <unistd.h>
7
8	#include "alloc-util.h"
9	#include "copy.h"
10	#include "edit-util.h"
11	#include "errno-util.h"
12	#include "fd-util.h"
13	#include "fileio.h"
14	#include "fs-util.h"
15	#include "log.h"
16	#include "mkdir-label.h"
17	#include "path-util.h"
18	#include "process-util.h"
19	#include "string-util.h"
20	#include "strv.h"
21	#include "tmpfile-util-label.h"
22
23	typedef struct EditFile {
24	EditFileContext *context;
25	char *path;
26	char *original_path;
27	char **comment_paths;
28	char *temp;
29	unsigned line;
30	} EditFile;
31
32	void edit_file_context_done(EditFileContext *context) {	28✔
33	int r;	28✔
34
35	assert(context);	28✔
36
37	FOREACH_ARRAY(i, context->files, context->n_files) {	52✔
38	unlink_and_free(i->temp);	24✔
39
40	if (context->remove_parent) {	24✔
41	_cleanup_free_ char *parent = NULL;	16✔
42
43	r = path_extract_directory(i->path, &parent);	16✔
44	if (r < 0)	16✔
45	log_debug_errno(r, "Failed to extract directory from '%s', ignoring: %m", i->path);	×
46	else if (rmdir(parent) < 0 && !IN_SET(errno, ENOENT, ENOTEMPTY))	16✔
47	log_debug_errno(errno, "Failed to remove parent directory '%s', ignoring: %m", parent);	16✔
48	}
49
50	free(i->path);	24✔
51	free(i->original_path);	24✔
52	strv_free(i->comment_paths);	24✔
53	}
54
55	context->files = mfree(context->files);	28✔
56	context->n_files = 0;	28✔
57	}	28✔
58
59	bool edit_files_contains(const EditFileContext context, const char path) {	24✔
60	assert(context);	24✔
61	assert(path);	24✔
62
63	FOREACH_ARRAY(i, context->files, context->n_files)	25✔
64	if (path_equal(i->path, path))	1✔
65	return true;
66
67	return false;
68	}
69
70	int edit_files_add(	24✔
71	EditFileContext *context,
72	const char *path,
73	const char *original_path,
74	char * const *comment_paths) {
75
76	_cleanup_free_ char new_path = NULL, new_original_path = NULL;	24✔
77	_cleanup_strv_free_ char **new_comment_paths = NULL;	24✔
78
79	assert(context);	24✔
80	assert(path);	24✔
81
82	if (edit_files_contains(context, path))	24✔
83	return 0;
84
85	if (!GREEDY_REALLOC(context->files, context->n_files + 1))	24✔
86	return log_oom();	×
87
88	new_path = strdup(path);	24✔
89	if (!new_path)	24✔
90	return log_oom();	×
91
92	if (original_path) {	24✔
93	new_original_path = strdup(original_path);	4✔
94	if (!new_original_path)	4✔
95	return log_oom();	×
96	}
97
98	if (comment_paths) {	24✔
99	new_comment_paths = strv_copy(comment_paths);	15✔
100	if (!new_comment_paths)	15✔
101	return log_oom();	×
102	}
103
104	context->files[context->n_files] = (EditFile) {	24✔
105	.context = context,
106	.path = TAKE_PTR(new_path),	24✔
107	.original_path = TAKE_PTR(new_original_path),	24✔
108	.comment_paths = TAKE_PTR(new_comment_paths),	24✔
109	.line = 1,
110	};
111	context->n_files++;	24✔
112
113	return 1;	24✔
114	}
115
116	static int populate_edit_temp_file(EditFile e, FILE f, const char *filename) {	11✔
117	assert(e);	11✔
118	assert(e->context);	11✔
119	assert(!e->context->read_from_stdin);	11✔
120	assert(e->path);	11✔
121	assert(f);	11✔
122	assert(filename);	11✔
123
124	bool has_original = e->original_path && access(e->original_path, F_OK) >= 0;	11✔
125	bool has_target = access(e->path, F_OK) >= 0;	11✔
126	const char *source;	11✔
127	int r;	11✔
128
129	if (has_original && (!has_target \|\| e->context->overwrite_with_origin))	11✔
130	/* We are asked to overwrite target with original_path or target doesn't exist. */
131	source = e->original_path;	4✔
132	else if (has_target)	7✔
133	/* Target exists and shouldn't be overwritten. */
134	source = e->path;	2✔
135	else
136	source = NULL;
137
138	if (e->comment_paths) {	11✔
139	_cleanup_free_ char *source_contents = NULL;	6✔
140
141	if (source) {	6✔
142	r = read_full_file(source, &source_contents, NULL);	1✔
143	if (r < 0)	1✔
144	return log_error_errno(r, "Failed to read source file '%s': %m", source);	×
145	}
146
147	fprintf(f,	11✔
148	"### Editing %s\n"
149	"%s\n"
150	"\n"
151	"%s%s"
152	"\n"
153	"%s\n",
154	e->path,
155	e->context->marker_start,
156	strempty(source_contents),
157	source_contents && endswith(source_contents, "\n") ? "" : "\n",	1✔
158	e->context->marker_end);	6✔
159
160	e->line = 4; /* Start editing at the contents area */	6✔
161
162	STRV_FOREACH(path, e->comment_paths) {	20✔
163	_cleanup_free_ char *comment = NULL;	14✔
164
165	/* Skip the file which is being edited and the source file (can be the same) */
166	if (PATH_IN_SET(*path, e->path, source))	14✔
167	continue;	1✔
168
169	r = read_full_file(*path, &comment, NULL);	13✔
170	if (r < 0)	13✔
171	return log_error_errno(r, "Failed to read comment file '%s': %m", *path);	×
172
173	fprintf(f, "\n\n### %s", *path);	13✔
174
175	if (!isempty(comment)) {	26✔
176	_cleanup_free_ char *c = NULL;	13✔
177
178	c = strreplace(strstrip(comment), "\n", "\n# ");	13✔
179	if (!c)	13✔
180	return log_oom();	×
181
182	fprintf(f, "\n# %s", c);	13✔
183	}
184	}
185	} else if (source) {	5✔
186	r = copy_file_fd(source, fileno(f), COPY_REFLINK);	5✔
187	if (r < 0) {	5✔
188	assert(r != -ENOENT);	×
189	return log_error_errno(r, "Failed to copy file '%s' to temporary file '%s': %m",	×
190	source, filename);
191	}
192	}
193
194	return 0;
195	}
196
197	static int create_edit_temp_file(EditFile e, const char contents, size_t contents_size) {	23✔
198	_cleanup_(unlink_and_freep) char *temp = NULL;	×
199	_cleanup_fclose_ FILE *f = NULL;	23✔
200	int r;	23✔
201
202	assert(e);	23✔
203	assert(e->context);	23✔
204	assert(e->path);	23✔
205	assert(!e->comment_paths \|\| (e->context->marker_start && e->context->marker_end));	23✔
206	assert(contents \|\| contents_size == 0);	23✔
207	assert(e->context->read_from_stdin == !!contents);	23✔
208
209	if (e->temp)	23✔
210	return 0;
211
212	r = mkdir_parents_label(e->path, 0755);	23✔
213	if (r < 0)	23✔
214	return log_error_errno(r, "Failed to create parent directories for '%s': %m", e->path);	×
215
216	r = fopen_temporary_label(e->path, e->path, &f, &temp);	23✔
217	if (r < 0)	23✔
218	return log_error_errno(r, "Failed to create temporary file for '%s': %m", e->path);	×
219
220	if (fchmod(fileno(f), 0644) < 0)	23✔
221	return log_error_errno(errno, "Failed to change mode of temporary file '%s': %m", temp);	×
222
223	if (e->context->read_from_stdin) {	23✔
224	if (fwrite(contents, 1, contents_size, f) != contents_size)	12✔
225	return log_error_errno(SYNTHETIC_ERRNO(EIO),	×
226	"Failed to write stdin data to temporary file '%s'.", temp);
227	} else {
228	r = populate_edit_temp_file(e, f, temp);	11✔
229	if (r < 0)	11✔
230	return r;
231	}
232
233	r = fflush_and_check(f);	23✔
234	if (r < 0)	23✔
235	return log_error_errno(r, "Failed to write to temporary file '%s': %m", temp);	×
236
237	e->temp = TAKE_PTR(temp);	23✔
238
239	return 0;	23✔
240	}
241
242	static int run_editor_child(const EditFileContext *context) {	11✔
243	_cleanup_strv_free_ char args = NULL, editor = NULL;	×
244	int r;	11✔
245
246	assert(context);	11✔
247	assert(context->n_files >= 1);	11✔
248
249	/* SYSTEMD_EDITOR takes precedence over EDITOR which takes precedence over VISUAL.
250	* If neither SYSTEMD_EDITOR nor EDITOR nor VISUAL are present, we try to execute
251	* well known editors. */
252	FOREACH_STRING(e, "SYSTEMD_EDITOR", "EDITOR", "VISUAL") {	22✔
253	const char *m = empty_to_null(getenv(e));	22✔
254	if (m) {	11✔
255	editor = strv_split(m, WHITESPACE);	11✔
256	if (!editor)	11✔
257	return log_oom();	×
258
259	break;
260	}
261	}
262
263	if (context->n_files == 1 && context->files[0].line > 1) {	11✔
264	/* If editing a single file only, use the +LINE syntax to put cursor on the right line */
265	r = strv_extendf(&args, "+%u", context->files[0].line);	6✔
266	if (r < 0)	6✔
267	return log_oom();	×
268	}
269
270	FOREACH_ARRAY(i, context->files, context->n_files) {	22✔
271	r = strv_extend(&args, i->temp);	11✔
272	if (r < 0)	11✔
273	return log_oom();	×
274	}
275
276	size_t editor_n = strv_length(editor);	11✔
277	if (editor_n > 0) {	11✔
278	/* Strings are owned by 'editor' and 'args' */
279	_cleanup_free_ char *cmdline = new(char, editor_n + strv_length(args) + 1);	11✔
280	if (!cmdline)	11✔
281	return log_oom();	×
282
283	*mempcpy_typesafe(mempcpy_typesafe(cmdline, editor, editor_n), args, strv_length(args)) = NULL;	11✔
284
285	execvp(cmdline[0], cmdline);	×
286	log_warning_errno(errno, "Specified editor '%s' not available, trying fallbacks: %m", editor[0]);	×
287	}
288
289	bool prepended = false;	×
290	FOREACH_STRING(name, "editor", "nano", "vim", "vi") {	×
291	if (!prepended) {	×
292	r = strv_prepend(&args, name);	×
293	prepended = true;
294	} else
295	r = free_and_strdup(&args[0], name);	×
296	if (r < 0)	×
297	return log_oom();	×
298
299	execvp(args[0], (char* const*) args);	×
300
301	/* We do not fail if the editor doesn't exist because we want to try each one of them
302	* before failing. */
303	if (errno != ENOENT)	×
304	return log_error_errno(errno, "Failed to execute '%s': %m", name);	×
305	}
306
307	return log_error_errno(SYNTHETIC_ERRNO(ENOENT),	×
308	"Cannot edit files, no editor available. Please set either $SYSTEMD_EDITOR, $EDITOR or $VISUAL.");
309	}
310
311	static int run_editor(const EditFileContext *context) {	11✔
312	int r;	11✔
313
314	assert(context);	11✔
315
316	r = safe_fork("(editor)", FORK_RESET_SIGNALS\|FORK_DEATHSIG_SIGTERM\|FORK_RLIMIT_NOFILE_SAFE\|FORK_CLOSE_ALL_FDS\|FORK_REOPEN_LOG\|FORK_LOG\|FORK_WAIT, NULL);	11✔
317	if (r < 0)	22✔
318	return r;
319	if (r == 0) { /* Child */	22✔
320	r = run_editor_child(context);	11✔
321	_exit(r < 0 ? EXIT_FAILURE : EXIT_SUCCESS);	×
322	}
323
324	return 0;
325	}
326
327	static int strip_edit_temp_file(EditFile *e) {	23✔
328	_cleanup_free_ char old_contents = NULL, tmp = NULL, *new_contents = NULL;	23✔
329	const char *stripped;	23✔
330	bool with_marker;	23✔
331	int r;	23✔
332
333	assert(e);	23✔
334	assert(e->context);	23✔
335	assert(!e->context->marker_start == !e->context->marker_end);	23✔
336	assert(e->temp);	23✔
337
338	r = read_full_file(e->temp, &old_contents, NULL);	23✔
339	if (r < 0)	23✔
340	return log_error_errno(r, "Failed to read temporary file '%s': %m", e->temp);	×
341
342	tmp = strdup(old_contents);	23✔
343	if (!tmp)	23✔
344	return log_oom();	×
345
346	with_marker = e->context->marker_start && !e->context->read_from_stdin;	23✔
347
348	if (with_marker) {	23✔
349	/* Trim out the lines between the two markers */
350	char contents_start, contents_end;	9✔
351
352	contents_start = strstrafter(tmp, e->context->marker_start) ?: tmp;	9✔
353
354	contents_end = strstr(contents_start, e->context->marker_end);	9✔
355	if (contents_end)	9✔
356	*contents_end = '\0';	2✔
357
358	stripped = strstrip(contents_start);	9✔
359	} else
360	stripped = strstrip(tmp);	14✔
361
362	if (isempty(stripped)) {	23✔
363	/* People keep coming back to #24208 due to edits outside of markers. Let's detect this
364	* and point them in the right direction. */
365	if (with_marker)	2✔
366	for (const char *p = old_contents;;) {	2✔
367	p = skip_leading_chars(p, WHITESPACE);	84✔
368	if (*p == '\0')	84✔
369	break;
370	if (*p != '#') {	84✔
371	log_warning("Found modifications outside of the staging area, which would be discarded.");	×
372	break;
373	}
374
375	/* Skip the whole line if commented out */
376	p = strchr(p, '\n');	84✔
377	if (!p)	84✔
378	break;
379	p++;	82✔
380	}
381
382	return 0; /* File is empty (has no real changes) */	2✔
383	}
384
385	/* Trim prefix and suffix, but ensure suffixed by single newline */
386	new_contents = strjoin(stripped, "\n");	21✔
387	if (!new_contents)	21✔
388	return log_oom();	×
389
390	if (streq(old_contents, new_contents)) /* Don't touch the file if the above didn't change a thing */	21✔
391	return 1; /* Contents have real changes */
392
393	r = write_string_file(e->temp, new_contents,	3✔
394	WRITE_STRING_FILE_TRUNCATE \| WRITE_STRING_FILE_AVOID_NEWLINE);
395	if (r < 0)	3✔
396	return log_error_errno(r, "Failed to strip temporary file '%s': %m", e->temp);	×
397
398	return 1; /* Contents have real changes */
399	}
400
401	static int edit_file_install_one(EditFile *e) {	23✔
402	int r;	23✔
403
404	assert(e);	23✔
405	assert(e->path);	23✔
406	assert(e->temp);	23✔
407
408	r = strip_edit_temp_file(e);	23✔
409	if (r <= 0)	23✔
410	return r;
411
412	r = RET_NERRNO(rename(e->temp, e->path));	21✔
413	if (r < 0)	×
414	return log_error_errno(r,	×
415	"Failed to rename temporary file '%s' to target file '%s': %m",
416	e->temp, e->path);
417	e->temp = mfree(e->temp);	21✔
418
419	return 1;	21✔
420	}
421
422	static int edit_file_install_one_stdin(EditFile e, const char contents, size_t contents_size, int *fd) {	13✔
423	int r;	13✔
424
425	assert(e);	13✔
426	assert(e->path);	13✔
427	assert(contents \|\| contents_size == 0);	13✔
428	assert(fd);	13✔
429
430	if (contents_size == 0)	13✔
431	return 0;	13✔
432
433	if (*fd >= 0) {	13✔
434	r = mkdir_parents_label(e->path, 0755);	1✔
435	if (r < 0)	1✔
436	return log_error_errno(r, "Failed to create parent directories for '%s': %m", e->path);	×
437
438	r = copy_file_atomic_at(*fd, NULL, AT_FDCWD, e->path, 0644, COPY_REFLINK\|COPY_REPLACE\|COPY_MAC_CREATE);	1✔
439	if (r < 0)	1✔
440	return log_error_errno(r, "Failed to copy stdin contents to '%s': %m", e->path);	×
441
442	return 1;
443	}
444
445	r = create_edit_temp_file(e, contents, contents_size);	12✔
446	if (r < 0)	12✔
447	return r;
448
449	_cleanup_close_ int tfd = open(e->temp, O_PATH\|O_CLOEXEC);	25✔
450	if (tfd < 0)	12✔
451	return log_error_errno(errno, "Failed to pin temporary file '%s': %m", e->temp);	×
452
453	r = edit_file_install_one(e);	12✔
454	if (r <= 0)	12✔
455	return r;
456
457	*fd = TAKE_FD(tfd);	12✔
458
459	return 1;	12✔
460	}
461
462	int do_edit_files_and_install(EditFileContext *context) {	23✔
463	_cleanup_free_ char *stdin_data = NULL;	23✔
464	size_t stdin_size = 0;	23✔
465	int r;	23✔
466
467	assert(context);	23✔
468
469	if (context->n_files == 0)	23✔
470	return log_debug_errno(SYNTHETIC_ERRNO(ENOENT), "Got no files to edit.");	×
471
472	if (context->read_from_stdin) {	23✔
473	r = read_full_stream(stdin, &stdin_data, &stdin_size);	12✔
474	if (r < 0)	12✔
475	return log_error_errno(r, "Failed to read stdin: %m");	×
476	} else {
477	FOREACH_ARRAY(editfile, context->files, context->n_files) {	22✔
478	r = create_edit_temp_file(editfile, /* contents = / NULL, / contents_size = */ 0);	11✔
479	if (r < 0)	11✔
480	return r;
481	}
482
483	r = run_editor(context);	11✔
484	if (r < 0)	11✔
485	return r;
486	}
487
488	_cleanup_close_ int stdin_data_fd = -EBADF;	23✔
489
490	FOREACH_ARRAY(editfile, context->files, context->n_files) {	47✔
491	if (context->read_from_stdin) {	24✔
492	r = edit_file_install_one_stdin(editfile, stdin_data, stdin_size, &stdin_data_fd);	13✔
493	if (r == 0) {	13✔
494	log_notice("Stripped stdin content is empty, not writing file.");	×
495	return 0;	×
496	}
497	} else {
498	r = edit_file_install_one(editfile);	11✔
499	if (r == 0) {	11✔
500	log_notice("%s: after editing, new contents are empty, not writing file.",	2✔
501	editfile->path);
502	continue;	2✔
503	}
504	}
505	if (r < 0)	22✔
506	return r;
507
508	log_info("Successfully installed edited file '%s'.", editfile->path);	22✔
509	}
510
511	return 0;
512	}

systemd / systemd / 15986406979

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous