git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH v2 1/1] worktree add: sanitize worktree names

From
Ramsay Jones <ramsay@ramsayjones.plus.com>
Date
Feb 21, 2019, 17:41 UTC
Message-ID
<6fe399f0-98ad-37e6-f4b1-3a3f6e4bce03@ramsayjones.plus.com>
In-Reply-To
<20190221121943.19778-2-pclouds@gmail.com>
On 21/02/2019 12:19, Nguyễn Thái Ngọc Duy wrote:
Show 48 quoted lines
> 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: Konstantin Kharlamov <hi-angel@yandex.ru>
> Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
> ---
>  builtin/worktree.c      | 51 ++++++++++++++++++++++++++++++++++++++++-
>  t/t2025-worktree-add.sh |  7 ++++++
>  2 files changed, 57 insertions(+), 1 deletion(-)
> 
> diff --git a/builtin/worktree.c b/builtin/worktree.c
> index 3f9907fcc9..53e41db229 100644
> --- a/builtin/worktree.c
> +++ b/builtin/worktree.c
> @@ -262,6 +262,50 @@ 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)
> +{
> +	char *orig_name = xstrdup(name->buf);
> +	int i;
> +
> +	/*
> +	 * All special chars replaced with dashes. See
> +	 * check_refname_component() for reference.
> +	 * Note that .lock is also turned to -lock, removing its
> +	 * special status.
> +	 */
> +	for (i = 0; i < name->len; i++) {
> +		if (strchr(":?[]\\~ \t@{}*/.", name->buf[i]))
> +			name->buf[i] = '-';
> +	}
> +
> +	/* remove consecutive dashes, leading or trailing dashes */
Why? So, '[fred]' will be 'sanitized' to 'fred' (rather than '-fred-'),
which would increase the chance of a 'collision' with the 'fred'
worktree (not very likely, but still). Is that useful? How about
'x86_64-*-gnu' which now becomes 'x86_64-gnu'?
 
Show 13 quoted lines
> +	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);
> +	}
> +
> +	/*
> +	 * a worktree name of only special chars would be reduced to
> +	 * an empty string
> +	 */> +	if (name->len == 0)
> +		strbuf_addstr(name, "worktree");

If you didn't 'collapse' the name above, you could check for an empty name at the top and wouldn't need this (presumably an empty name would not be valid).

ATB, Ramsay Jones

Previous: Jeff KingNext: Duy Nguyen
Message 15 of 41 in “git gc fails with "unable to resolve reference" for worktree”
  1. hi-angel@yandex.ruFeb 18, 2019
  2. Duy NguyenFeb 18, 2019
  3. hi-angel@yandex.ruFeb 18, 2019
  4. Duy NguyenFeb 18, 2019
  5. hi-angel@yandex.ruFeb 20, 2019
  6. worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Feb 21, 2019
  7. Konstantin KharlamovFeb 21, 2019
  8. Duy NguyenFeb 21, 2019
  9. Konstantin KharlamovFeb 21, 2019
  10. Duy NguyenFeb 21, 2019
  11. Jeff KingFeb 21, 2019
  12. 0/1 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Feb 21, 2019
  13. 1/1 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Feb 21, 2019
  14. Jeff KingFeb 21, 2019
  15. Ramsay JonesFeb 21, 2019
  16. Duy NguyenFeb 22, 2019
  17. 0/1 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Feb 26, 2019
  18. 1/1 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Feb 26, 2019
  19. Jeff KingFeb 27, 2019
  20. Eric SunshineFeb 27, 2019
  21. Jeff KingFeb 27, 2019
  22. Junio C HamanoMar 3, 2019
  23. Duy NguyenMar 4, 2019
  24. Duy NguyenMar 4, 2019
  25. Johannes SchindelinMar 4, 2019
  26. 0/2 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Mar 5, 2019
  27. 1/2 refs.c: refactor check_refname_component()Nguyễn Thái Ngọc Duy, Mar 5, 2019
  28. Jeff KingMar 6, 2019
  29. Eric SunshineMar 7, 2019
  30. 2/2 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Mar 5, 2019
  31. 0/1 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Mar 8, 2019
  32. 1/1 worktree add: sanitize worktree namesNguyễn Thái Ngọc Duy, Mar 8, 2019
  33. Eric SunshineMar 10, 2019
  34. Junio C HamanoMar 11, 2019
  35. Duy NguyenMar 11, 2019
  36. Jeff KingMar 11, 2019
  37. Junio C HamanoMar 12, 2019
  38. Junio C HamanoMar 11, 2019
  39. Duy NguyenMar 11, 2019
  40. Johannes SchindelinMar 11, 2019
  41. Junio C HamanoMar 12, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.