From: Konstantin Kharlamov <hi-angel@yandex.ru>
To: "Nguyễn Thái Ngọc Duy" <pclouds@gmail.com>
Cc: git@vger.kernel.org, Eric Sunshine <sunshine@sunshineco.com>
Subject: Re: [PATCH] worktree add: sanitize worktree names
Date: Thu, 21 Feb 2019 14:28:45 +0300 [thread overview]
Message-ID: <1550748525.30307.1@yandex.ru> (raw)
In-Reply-To: <20190221110026.23135-1-pclouds@gmail.com>
On Чт, Feb 21, 2019 at 2:00 PM,
=?UTF-8?b?Tmd1eeG7hW4gVGjDoWkgTmfhu41j?= Duy <pclouds@gmail.com> wrote:
> Worktree names are based on $(basename $GIT_WORK_TREE). They aren't
> significant until 3a3b9d8cde (refs: new ref types to make per-worktree
> refs visible to all worktrees - 2018-10-21), where worktree name could
> be part of a refname and must follow refname rules.
>
> Update 'worktree add' code to remove special characters to follow
> these rules. The code could replace chars with '-' more than
> necessary, but it keeps the code simple. In the future the user will
> be able to specify the worktree name by themselves if they're not
> happy with this dumb character substitution.
>
> Reported-by: hi-angel@yandex.ru
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
> builtin/worktree.c | 47
> ++++++++++++++++++++++++++++++++++++++++-
> t/t2025-worktree-add.sh | 5 +++++
> 2 files changed, 51 insertions(+), 1 deletion(-)
>
> diff --git a/builtin/worktree.c b/builtin/worktree.c
> index 3f9907fcc9..ff36838a33 100644
> --- a/builtin/worktree.c
> +++ b/builtin/worktree.c
> @@ -262,6 +262,46 @@ static void validate_worktree_add(const char
> *path, const struct add_opts *opts)
> free_worktrees(worktrees);
> }
>
> +/*
> + * worktree name is part of refname and has to pass
> + * check_refname_component(). Remove unallowed characters to make it
> + * valid.
> + */
> +static void sanitize_worktree_name(struct strbuf *name)
> +{
> + int i;
> +
> + /* no ending with .lock */
> + if (ends_with(name->buf, ".lock"))
> + strbuf_remove(name, name->len - strlen(".lock"),
> + strlen(".lock"));
> +
> + /*
> + * All special chars replaced with dashes. See
> + * check_refname_component() for reference.
> + */
> + for (i = 0; i < name->len; i++) {
> + if (strchr(":?[]\\~ \t@{}*/.", name->buf[i]))
> + name->buf[i] = '-';
> + }
> +
> + /* remove consecutive dashes, leading or trailing dashes */
> + for (i = 0; i < name->len; i++) {
> + while (name->buf[i] == '-' &&
> + (i == 0 ||
> + i == name->len - 1 ||
> + (i < name->len - 1 && name->buf[i + 1] == '-')))
> + strbuf_remove(name, i, 1);
> + }
> +
> + /* last resort, should never ever happen in practice */
> + if (name->len == 0)
> + strbuf_addstr(name, "worktree");
I assume this means a user have passed a zero-sized worktree name? But
zero-sized file/directory names are not possible anyway, would it make
sense to just return an error in this case?
> +
> + if (check_refname_format(name->buf, REFNAME_ALLOW_ONELEVEL))
> + BUG("worktree name '%s' is not a valid refname", name->buf);
> +}
> +
> static int add_worktree(const char *path, const char *refname,
> const struct add_opts *opts)
> {
> @@ -275,6 +315,7 @@ static int add_worktree(const char *path, const
> char *refname,
> struct strbuf symref = STRBUF_INIT;
> struct commit *commit = NULL;
> int is_branch = 0;
> + struct strbuf sb_name = STRBUF_INIT;
>
> validate_worktree_add(path, opts);
>
> @@ -290,7 +331,10 @@ static int add_worktree(const char *path, const
> char *refname,
> die(_("invalid reference: %s"), refname);
>
> name = worktree_basename(path, &len);
> - git_path_buf(&sb_repo, "worktrees/%.*s", (int)(path + len - name),
> name);
> + strbuf_add(&sb_name, name, path + len - name);
> + sanitize_worktree_name(&sb_name);
> + name = sb_name.buf;
> + git_path_buf(&sb_repo, "worktrees/%s", name);
> len = sb_repo.len;
> if (safe_create_leading_directories_const(sb_repo.buf))
> die_errno(_("could not create leading directories of '%s'"),
> @@ -415,6 +459,7 @@ static int add_worktree(const char *path, const
> char *refname,
> strbuf_release(&symref);
> strbuf_release(&sb_repo);
> strbuf_release(&sb_git);
> + strbuf_release(&sb_name);
> return ret;
> }
>
> diff --git a/t/t2025-worktree-add.sh b/t/t2025-worktree-add.sh
> index 286bba35d8..0d465adb54 100755
> --- a/t/t2025-worktree-add.sh
> +++ b/t/t2025-worktree-add.sh
> @@ -570,4 +570,9 @@ test_expect_success '"add" an existing locked but
> missing worktree' '
> git worktree add --force --force --detach gnoo
> '
>
> +test_expect_success 'sanitize generated worktree name' '
> + git worktree add --detach ". weird*..?.lock" &&
> + test -d .git/worktrees/weird
> +'
> +
> test_done
> --
> 2.21.0.rc1.337.gdf7f8d0522
>
next prev parent reply other threads:[~2019-02-21 11:28 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-18 14:36 git gc fails with "unable to resolve reference" for worktree hi-angel
2019-02-18 15:02 ` Duy Nguyen
2019-02-18 15:09 ` hi-angel
2019-02-18 15:18 ` Duy Nguyen
2019-02-20 14:34 ` hi-angel
2019-02-21 11:00 ` [PATCH] worktree add: sanitize worktree names Nguyễn Thái Ngọc Duy
2019-02-21 11:28 ` Konstantin Kharlamov [this message]
2019-02-21 11:38 ` Duy Nguyen
2019-02-21 11:44 ` Konstantin Kharlamov
2019-02-21 11:52 ` Duy Nguyen
2019-02-21 13:23 ` Jeff King
2019-02-21 12:19 ` [PATCH v2 0/1] " Nguyễn Thái Ngọc Duy
2019-02-21 12:19 ` [PATCH v2 1/1] " Nguyễn Thái Ngọc Duy
2019-02-21 13:22 ` Jeff King
2019-02-21 17:41 ` Ramsay Jones
2019-02-22 9:21 ` Duy Nguyen
2019-02-26 10:58 ` [PATCH v3 0/1] " Nguyễn Thái Ngọc Duy
2019-02-26 10:58 ` [PATCH v3 1/1] " Nguyễn Thái Ngọc Duy
2019-02-27 12:08 ` Jeff King
2019-02-27 14:23 ` Eric Sunshine
2019-02-27 16:04 ` Jeff King
2019-03-03 1:22 ` Junio C Hamano
2019-03-04 11:19 ` Duy Nguyen
2019-03-04 12:04 ` Duy Nguyen
2019-03-04 15:06 ` Johannes Schindelin
2019-03-05 12:08 ` [PATCH v4 0/2] " Nguyễn Thái Ngọc Duy
2019-03-05 12:08 ` [PATCH v4 1/2] refs.c: refactor check_refname_component() Nguyễn Thái Ngọc Duy
2019-03-06 21:49 ` Jeff King
2019-03-07 23:24 ` Eric Sunshine
2019-03-05 12:08 ` [PATCH v4 2/2] worktree add: sanitize worktree names Nguyễn Thái Ngọc Duy
2019-03-08 9:28 ` [PATCH v5 0/1] " Nguyễn Thái Ngọc Duy
2019-03-08 9:28 ` [PATCH v5 1/1] " Nguyễn Thái Ngọc Duy
2019-03-10 2:02 ` Eric Sunshine
2019-03-11 6:20 ` Junio C Hamano
2019-03-11 9:24 ` Duy Nguyen
2019-03-11 22:39 ` Jeff King
2019-03-12 6:32 ` Junio C Hamano
2019-03-11 6:36 ` Junio C Hamano
2019-03-11 9:27 ` Duy Nguyen
2019-03-11 13:05 ` Johannes Schindelin
2019-03-12 6:45 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1550748525.30307.1@yandex.ru \
--to=hi-angel@yandex.ru \
--cc=git@vger.kernel.org \
--cc=pclouds@gmail.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).