From: Mike Yuan <me@yhndnzj.com>
Date: Sat, 17 Aug 2024 20:36:19 +0000 (+0200)
Subject: edit-util: catch and warn about edits outside of markers
X-Git-Tag: v257-rc1~684^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e65b07293c4e2d69f231e63db98e5ec002182548;p=thirdparty%2Fsystemd.git

edit-util: catch and warn about edits outside of markers

The users still periodically come back to #24208.
Let's add a detection for this hence.
---

diff --git a/src/shared/edit-util.c b/src/shared/edit-util.c
index 5dd8595a369..89ca9459e06 100644
--- a/src/shared/edit-util.c
+++ b/src/shared/edit-util.c
@@ -315,10 +315,12 @@ static int run_editor(const EditFileContext *context) {
 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);
@@ -329,12 +331,12 @@ static int strip_edit_temp_file(EditFile *e) {
         if (!tmp)
                 return log_oom();
 
-        if (e->context->marker_start && !e->context->stdin) {
+        with_marker = e->context->marker_start && !e->context->stdin;
+
+        if (with_marker) {
                 /* Trim out the lines between the two markers */
                 char *contents_start, *contents_end;
 
-                assert(e->context->marker_end);
-
                 contents_start = strstrafter(tmp, e->context->marker_start) ?: tmp;
 
                 contents_end = strstr(contents_start, e->context->marker_end);
@@ -345,8 +347,28 @@ static int strip_edit_temp_file(EditFile *e) {
         } else
                 stripped = strstrip(tmp);
 
-        if (isempty(stripped))
+        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");