We have already introduced "files_fsck_symref_target". We should reuse
this function to handle the symrefs which are legacy symbolic links. We
should not check the trailing garbage for symbolic links. Add a new
parameter "symbolic_link" to disable some checks which should only be
used for symbolic ref.
We firstly use the "strbuf_add_real_path" to resolve the symlinks and
get the absolute path "pointee_path" which the symlink ref points to.
Then we can get the absolute path "abs_gitdir" of the "gitdir". By
combining "pointee_path" and "abs_gitdir", we can extract the
"referent". Thus, we can reuse "files_fsck_symref_target" function to
seamlessly check the symlink refs.
Mentored-by: Patrick Steinhardt <ps@xxxxxx>
Mentored-by: Karthik Nayak <karthik.188@xxxxxxxxx>
Signed-off-by: shejialuo <shejialuo@xxxxxxxxx>
---
refs/files-backend.c | 82 ++++++++++++++++++++++++++++------------
t/t0602-reffiles-fsck.sh | 44 +++++++++++++++++++++
2 files changed, 101 insertions(+), 25 deletions(-)
diff --git a/refs/files-backend.c b/refs/files-backend.c
index bfb8d338d2..398afedaf0 100644
--- a/refs/files-backend.c
+++ b/refs/files-backend.c
@@ -1,4 +1,5 @@
#include "../git-compat-util.h"
+#include "../abspath.h"
#include "../copy.h"
#include "../environment.h"
#include "../gettext.h"
@@ -3437,13 +3438,15 @@ typedef int (*files_fsck_refs_fn)(struct ref_store *ref_store,
/*
* Check the symref "pointee_name" and "pointee_path". The caller should
* make sure that "pointee_path" is absolute. For symbolic ref, "pointee_name"
- * would be the content after "refs:".
+ * would be the content after "refs:". For symblic link, "pointee_name" would
+ * be the relative path agaignst "gitdir".
*/
static int files_fsck_symref_target(struct fsck_options *o,
struct fsck_ref_report *report,
const char *refname,
struct strbuf *pointee_name,
- struct strbuf *pointee_path)
+ struct strbuf *pointee_path,
+ unsigned int symbolic_link)
{
unsigned int newline_num = 0;
unsigned int space_num = 0;
@@ -3459,34 +3462,36 @@ static int files_fsck_symref_target(struct fsck_options *o,
goto out;
}
- while (*p != '\0') {
- if ((space_num || newline_num) && !isspace(*p)) {
- ret = fsck_report_ref(o, report,
- FSCK_MSG_BAD_REF_CONTENT,
- "contains non-null garbage");
- goto out;
+ if (!symbolic_link) {
+ while (*p != '\0') {
+ if ((space_num || newline_num) && !isspace(*p)) {
+ ret = fsck_report_ref(o, report,
+ FSCK_MSG_BAD_REF_CONTENT,
+ "contains non-null garbage");
+ goto out;
+ }
+
+ if (*p == '\n') {
+ newline_num++;
+ } else if (*p == ' ') {
+ space_num++;
+ }
+ p++;
}
- if (*p == '\n') {
- newline_num++;
- } else if (*p == ' ') {
- space_num++;
+ if (space_num || newline_num > 1) {
+ ret = fsck_report_ref(o, report,
+ FSCK_MSG_TRAILING_REF_CONTENT,
+ "trailing null-garbage");
+ } else if (!newline_num) {
+ ret = fsck_report_ref(o, report,
+ FSCK_MSG_REF_MISSING_NEWLINE,
+ "missing newline");
}
- p++;
- }
- if (space_num || newline_num > 1) {
- ret = fsck_report_ref(o, report,
- FSCK_MSG_TRAILING_REF_CONTENT,
- "trailing null-garbage");
- } else if (!newline_num) {
- ret = fsck_report_ref(o, report,
- FSCK_MSG_REF_MISSING_NEWLINE,
- "missing newline");
+ strbuf_rtrim(pointee_name);
}
- strbuf_rtrim(pointee_name);
-
if (check_refname_format(pointee_name->buf, 0)) {
ret = fsck_report_ref(o, report,
FSCK_MSG_BAD_SYMREF_POINTEE,
@@ -3521,8 +3526,10 @@ static int files_fsck_refs_content(struct ref_store *ref_store,
struct fsck_ref_report report = FSCK_REF_REPORT_DEFAULT;
struct strbuf pointee_path = STRBUF_INIT;
struct strbuf ref_content = STRBUF_INIT;
+ struct strbuf abs_gitdir = STRBUF_INIT;
struct strbuf referent = STRBUF_INIT;
struct strbuf refname = STRBUF_INIT;
+ unsigned int symbolic_link = 0;
const char *trailing = NULL;
unsigned int type = 0;
int failure_errno = 0;
@@ -3567,8 +3574,32 @@ static int files_fsck_refs_content(struct ref_store *ref_store,
ref_store->gitdir, referent.buf);
ret = files_fsck_symref_target(o, &report, refname.buf,
&referent,
- &pointee_path);
+ &pointee_path,
+ symbolic_link);
+ }
+ } else if (S_ISLNK(iter->st.st_mode)) {
+ const char *pointee_name = NULL;
+
+ symbolic_link = 1;
+
+ strbuf_add_real_path(&pointee_path, iter->path.buf);
+ strbuf_add_absolute_path(&abs_gitdir, ref_store->gitdir);
+ strbuf_normalize_path(&abs_gitdir);
+ if (!is_dir_sep(abs_gitdir.buf[abs_gitdir.len - 1]))
+ strbuf_addch(&abs_gitdir, '/');
+
+ if (!skip_prefix(pointee_path.buf,
+ abs_gitdir.buf, &pointee_name)) {
+ ret = fsck_report_ref(o, &report,
+ FSCK_MSG_BAD_SYMREF_POINTEE,
+ "point to target outside gitdir");
+ goto cleanup;
}
+
+ strbuf_addstr(&referent, pointee_name);
+ ret = files_fsck_symref_target(o, &report, refname.buf,
+ &referent, &pointee_path,
+ symbolic_link);
}
cleanup:
@@ -3576,6 +3607,7 @@ static int files_fsck_refs_content(struct ref_store *ref_store,
strbuf_release(&ref_content);
strbuf_release(&referent);
strbuf_release(&pointee_path);
+ strbuf_release(&abs_gitdir);
return ret;
}
diff --git a/t/t0602-reffiles-fsck.sh b/t/t0602-reffiles-fsck.sh
index e8fc2ef015..c6e93e4757 100755
--- a/t/t0602-reffiles-fsck.sh
+++ b/t/t0602-reffiles-fsck.sh
@@ -228,4 +228,48 @@ test_expect_success 'symbolic ref content should be checked' '
test_cmp expect err
'
+test_expect_success SYMLINKS 'symbolic ref (symbolic link) content should be checked' '
+ test_when_finished "rm -rf repo" &&
+ git init repo &&
+ branch_dir_prefix=.git/refs/heads &&
+ tag_dir_prefix=.git/refs/tags &&
+ cd repo &&
+ git commit --allow-empty -m initial &&
+ git checkout -b branch-1 &&
+ git tag tag-1 &&
+ git checkout -b a/b/branch-2 &&
+
+ ln -sf ../../../../branch $branch_dir_prefix/branch-symbolic &&
+ test_must_fail git refs verify 2>err &&
+ cat >expect <<-EOF &&
+ error: refs/heads/branch-symbolic: badSymrefPointee: point to target outside gitdir
+ EOF
+ rm $branch_dir_prefix/branch-symbolic &&
+ test_cmp expect err &&
+
+ ln -sf ../../logs/branch-bad $branch_dir_prefix/branch-symbolic &&
+ test_must_fail git refs verify 2>err &&
+ cat >expect <<-EOF &&
+ error: refs/heads/branch-symbolic: badSymrefPointee: points to ref outside the refs directory
+ EOF
+ rm $branch_dir_prefix/branch-symbolic &&
+ test_cmp expect err &&
+
+ ln -sf ./"branch space" $branch_dir_prefix/branch-symbolic &&
+ test_must_fail git refs verify 2>err &&
+ cat >expect <<-EOF &&
+ error: refs/heads/branch-symbolic: badSymrefPointee: points to refname with invalid format
+ EOF
+ rm $branch_dir_prefix/branch-symbolic &&
+ test_cmp expect err &&
+
+ ln -sf ./".branch" $branch_dir_prefix/branch-symbolic &&
+ test_must_fail git refs verify 2>err &&
+ cat >expect <<-EOF &&
+ error: refs/heads/branch-symbolic: badSymrefPointee: points to refname with invalid format
+ EOF
+ rm $branch_dir_prefix/branch-symbolic &&
+ test_cmp expect err
+'
+
test_done
--
2.46.0
