From patchwork Tue Mar 5 12:08:33 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Duy Nguyen X-Patchwork-Id: 10839385 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 56969180E for ; Tue, 5 Mar 2019 12:08:54 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 44D8C2B8E7 for ; Tue, 5 Mar 2019 12:08:54 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 396402BAEC; Tue, 5 Mar 2019 12:08:54 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C01622B8E7 for ; Tue, 5 Mar 2019 12:08:53 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728028AbfCEMIw (ORCPT ); Tue, 5 Mar 2019 07:08:52 -0500 Received: from mail-pf1-f195.google.com ([209.85.210.195]:42489 "EHLO mail-pf1-f195.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726150AbfCEMIw (ORCPT ); Tue, 5 Mar 2019 07:08:52 -0500 Received: by mail-pf1-f195.google.com with SMTP id n74so5542065pfi.9 for ; Tue, 05 Mar 2019 04:08:51 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=+SpRpoyuCvPOUAW9J9c5ZDi9NaLC6SQncNkAuMgYlOE=; b=HzX8KTrOIih2V/1tNxEB9+S9HPeWcWcTZqcVw8HqDTJc+LyKVVSfbiZh5KOJeIvG6l 8Rw94ZCnZteGB9jvgJpk3WrT5OUElNKH7s5y5OujV4RM3v+2t89AhfLgVtN+0iUjlU2S 7U+ukEoDFRF9UbiaCHJMWC4aIs9sDA04/uvvFdP81DRWLu0M5rEenrm9PzkoKxi0zoRz 7Kokfu3qCjmbmz2ZI/EiDMEnEMNIVpJmilypNuh7XyevTSefXz1qlTDk5vtkJu8LE4jU pzSRqB8RrkutIGGT3/k3H4nOKx11H97n9oN11Y19FA6qFTyFkz4ZJDnIW0iYs9Fj80bD /zwQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=+SpRpoyuCvPOUAW9J9c5ZDi9NaLC6SQncNkAuMgYlOE=; b=j7vI+WBS1MAkDWFt23TRv01c6dsjoW2VZuwicGblGId5xLJSFIY7QVja37aQ2t93ZW 1ouhRgVdLoa9/6DBzUEQljyxTVQTZuaABdiFK7GfS64nwf7rvfqls6CEBsCZrVG2S66z PHIQXUffpTZBV+F7CcvPGoaXYOV7YoogWsJImH0ZfVWc5dPX9dsOXyyQgAfGxagHqnRG fVDQTaUUKisSGQ8vgk01dU2slPmDqW8WIYdg7jkgBWV1CRfSEtmFp0UEg5N6DxdKx0AE PEfs+ztzJkdXFuP5+mniC9Mwumla8LPTUPX4HOBc6edpKsaRGgBJAnvoIZZODRTQAhlU Am6A== X-Gm-Message-State: APjAAAWhRRdmBqXCeVyPMQSGbCNVJLs4q0uGgHZVkZoTjZA3ERsCh12o EYXAjU8YiaCGTTF1PKM/JbI= X-Google-Smtp-Source: APXvYqzqe7Xu2PST14tl2DWFqUkWXq/fFW1T9s8jgvVWyYCYw4uLiJ6y0KfFpOzHmyuhXWNLDgtPvA== X-Received: by 2002:a17:902:59c1:: with SMTP id d1mr868479plj.324.1551787731416; Tue, 05 Mar 2019 04:08:51 -0800 (PST) Received: from ash ([171.226.148.85]) by smtp.gmail.com with ESMTPSA id y70sm12517300pgd.6.2019.03.05.04.08.47 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 04:08:50 -0800 (PST) Received: by ash (sSMTP sendmail emulation); Tue, 05 Mar 2019 19:08:45 +0700 From: =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmfhu41jIER1eQ==?= To: pclouds@gmail.com Cc: git@vger.kernel.org, hi-angel@yandex.ru, peff@peff.net, ramsay@ramsayjones.plus.com, sunshine@sunshineco.com, Junio C Hamano , Johannes Schindelin Subject: [PATCH v4 1/2] refs.c: refactor check_refname_component() Date: Tue, 5 Mar 2019 19:08:33 +0700 Message-Id: <20190305120834.7284-2-pclouds@gmail.com> X-Mailer: git-send-email 2.21.0.rc1.337.gdf7f8d0522 In-Reply-To: <20190305120834.7284-1-pclouds@gmail.com> References: <20190226105851.32273-1-pclouds@gmail.com> <20190305120834.7284-1-pclouds@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The core logic of this function is factored out to provide more information when the refname is invalid: what part that is and exact what is wrong with it. This will be useful for a coming function that has to turn a string into a valid refname component. Signed-off-by: Nguyễn Thái Ngọc Duy --- refs.c | 78 ++++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 62 insertions(+), 16 deletions(-) diff --git a/refs.c b/refs.c index 142888a40a..70c55ea1b6 100644 --- a/refs.c +++ b/refs.c @@ -57,10 +57,21 @@ static unsigned char refname_disposition[256] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4 }; +enum refname_check_code { + refname_ok = 0, + refname_contains_dotdot, + refname_contains_atopen, + refname_has_badchar, + refname_contains_wildcard, + refname_starts_with_dot, + refname_ends_with_dotlock, + refname_component_has_zero_length +}; + /* * Try to read one refname component from the front of refname. - * Return the length of the component found, or -1 if the component is - * not legal. It is legal if it is something reasonable to have under + * If the component is legal, return the end of the component in cp_out. + * It is legal if it is something reasonable to have under * ".git/refs/"; We do not like it if: * * - any path component of it begins with ".", or @@ -71,11 +82,15 @@ static unsigned char refname_disposition[256] = { * - it ends with a "/", or * - it ends with ".lock", or * - it contains a "@{" portion + * + * in which case cp_out points to the beginning of the illegal part. */ -static int check_refname_component(const char *refname, int *flags) +static enum refname_check_code do_check_refname_component( + const char *refname, int *flags, const char **cp_out) { const char *cp; char last = '\0'; + enum refname_check_code ret = refname_ok; for (cp = refname; ; cp++) { int ch = *cp & 255; @@ -84,18 +99,28 @@ static int check_refname_component(const char *refname, int *flags) case 1: goto out; case 2: - if (last == '.') - return -1; /* Refname contains "..". */ + if (last == '.') { + cp--; + ret = refname_contains_dotdot; + goto done; + } break; case 3: - if (last == '@') - return -1; /* Refname contains "@{". */ + if (last == '@') { + cp--; + ret = refname_contains_atopen; /* @{ */ + goto done; + } break; case 4: - return -1; + ret = refname_has_badchar; + goto done; case 5: - if (!(*flags & REFNAME_REFSPEC_PATTERN)) - return -1; /* refspec can't be a pattern */ + if (!(*flags & REFNAME_REFSPEC_PATTERN)) { + /* refspec can't be a pattern */ + ret = refname_contains_wildcard; + goto done; + } /* * Unset the pattern flag so that we only accept @@ -107,13 +132,34 @@ static int check_refname_component(const char *refname, int *flags) last = ch; } out: - if (cp == refname) - return 0; /* Component has zero length. */ - if (refname[0] == '.') - return -1; /* Component starts with '.'. */ + if (cp == refname) { + ret = refname_component_has_zero_length; + goto done; + } + if (refname[0] == '.') { + cp = refname; + ret = refname_starts_with_dot; + goto done; + } if (cp - refname >= LOCK_SUFFIX_LEN && - !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) - return -1; /* Refname ends with ".lock". */ + !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN)) { + cp -= LOCK_SUFFIX_LEN; + ret = refname_ends_with_dotlock; + } +done: + *cp_out = cp; + return ret; +} + +/* Return the length of the component if it's legal otherwise -1 */ +static int check_refname_component(const char *refname, int *flags) +{ + const char *cp; + enum refname_check_code ret; + + ret = do_check_refname_component(refname, flags, &cp); + if (ret) + return -1; return cp - refname; } From patchwork Tue Mar 5 12:08:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Duy Nguyen X-Patchwork-Id: 10839387 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 41509139A for ; Tue, 5 Mar 2019 12:09:00 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2F6052AD31 for ; Tue, 5 Mar 2019 12:09:00 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 236FE2AD46; Tue, 5 Mar 2019 12:09:00 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 90A652ACF9 for ; Tue, 5 Mar 2019 12:08:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728040AbfCEMI6 (ORCPT ); Tue, 5 Mar 2019 07:08:58 -0500 Received: from mail-pg1-f194.google.com ([209.85.215.194]:42335 "EHLO mail-pg1-f194.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726150AbfCEMI6 (ORCPT ); Tue, 5 Mar 2019 07:08:58 -0500 Received: by mail-pg1-f194.google.com with SMTP id b2so5498488pgl.9 for ; Tue, 05 Mar 2019 04:08:57 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=rosw+fnajiGRuBzEWCYWUtpKOh3sZwyKA0/SAgQTFIs=; b=Btw1iAEIziKIMBjTLxkcOlwAIUUR6MXbxNxNn8mLtXHSLB3lOYbzS//6I3HndQb7ym 1lbC7R921NGK2ifFvdN3cNeVq/oS2VPf3edzQXE1Ptd9wy84iy2NjTpB30aMPsJELrEG 60MbRxUIiIp4oKC8m5bsptG4rtse2Jg687ifirM0yoqygZnJjW1zX3TTYZzVrUrVexEU WzP58cOxD7XnifsNQ1nJr3s0IaMbKizd/MP0h+9jPcEIueRjqp3Qopto0hDEseZLhv+y O9NcASHaPxSBtzGblNAdxnJd+u0jqXyvZMj6WnPPCJ+v3/gnVrer5ORg/MEoNzuRN013 dGsQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=rosw+fnajiGRuBzEWCYWUtpKOh3sZwyKA0/SAgQTFIs=; b=DEniQNT3qzSXMuBLwTfVA6T75gqW7VBQnPa69FkteRkcnGClA9rkaohAW2Iu6cBLsR fhTdeobNX3z3pTGmQJd7TqrxaIP4XCTtg9UAeiFoWPgN4DOzsU0y0S9flBRaGbO89j8D fgpyXhpYRa2Om9lS5r1rQwU3yJ2MXao0zAMB7us6gcocgaTR1WAxANUE9G1MnDaAGFT0 06LtpbHQ233gEba0PgDGwSRHeDfB1Sq0tLiTHZu3og6KTOTxg1M/YnIfLO1dLfv4xobX wFLcMlojFrxDjpHfIOmX6FDWLIkD4enTctNJXstSFWpCDsvFqlmCdQGq6kZFmL7n+hE6 X7hg== X-Gm-Message-State: APjAAAXyCIgxVqmDf8ie4n6hWzP3hoPipe5TfkH3ukxGSvi23iJRlG+b jyanOY5E5eIpy6x+puC1X5w= X-Google-Smtp-Source: APXvYqxeXs+LUJEggW09gEjwP4TagXHDErQcijawnHz4Mb+VuiNhkZOZ70VoybUuE0Z3HO0bunJD1w== X-Received: by 2002:a63:4a4d:: with SMTP id j13mr1127250pgl.16.1551787737275; Tue, 05 Mar 2019 04:08:57 -0800 (PST) Received: from ash ([171.226.148.85]) by smtp.gmail.com with ESMTPSA id n15sm19012361pgc.92.2019.03.05.04.08.53 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 04:08:56 -0800 (PST) Received: by ash (sSMTP sendmail emulation); Tue, 05 Mar 2019 19:08:51 +0700 From: =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmfhu41jIER1eQ==?= To: pclouds@gmail.com Cc: git@vger.kernel.org, hi-angel@yandex.ru, peff@peff.net, ramsay@ramsayjones.plus.com, sunshine@sunshineco.com, Junio C Hamano , Johannes Schindelin Subject: [PATCH v4 2/2] worktree add: sanitize worktree names Date: Tue, 5 Mar 2019 19:08:34 +0700 Message-Id: <20190305120834.7284-3-pclouds@gmail.com> X-Mailer: git-send-email 2.21.0.rc1.337.gdf7f8d0522 In-Reply-To: <20190305120834.7284-1-pclouds@gmail.com> References: <20190226105851.32273-1-pclouds@gmail.com> <20190305120834.7284-1-pclouds@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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. 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 Signed-off-by: Nguyễn Thái Ngọc Duy --- builtin/worktree.c | 7 ++++++- refs.c | 36 ++++++++++++++++++++++++++++++++++++ refs.h | 1 + t/t2025-worktree-add.sh | 5 +++++ 4 files changed, 48 insertions(+), 1 deletion(-) diff --git a/builtin/worktree.c b/builtin/worktree.c index 3f9907fcc9..ca63dd3df6 100644 --- a/builtin/worktree.c +++ b/builtin/worktree.c @@ -275,6 +275,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 +291,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_refname(&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 +419,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/refs.c b/refs.c index 70c55ea1b6..a23a84e431 100644 --- a/refs.c +++ b/refs.c @@ -163,6 +163,42 @@ static int check_refname_component(const char *refname, int *flags) return cp - refname; } +void sanitize_worktree_refname(struct strbuf *name) +{ + int flags = 0, i, max_tries; + const char *cp; + enum refname_check_code ret; + + /* + * name->len should be enough because we should never need to + * substitute any position more than once, but let's just add + * a couple more to be on the safe side. + */ + max_tries = name->len + 10; + for (i = 0; i < max_tries; i++) { + ret = do_check_refname_component(name->buf, &flags, &cp); + switch (ret) { + case refname_ok: + strbuf_setlen(name, cp - name->buf); + return; + + case refname_component_has_zero_length: + strbuf_addstr(name, "worktree"); + return; + + case refname_contains_dotdot: + case refname_contains_atopen: + case refname_has_badchar: + case refname_contains_wildcard: + case refname_ends_with_dotlock: + case refname_starts_with_dot: + *(char *)cp = '-'; + break; + } + } + BUG("stuck in infinite loop! buf = %s", name->buf); +} + int check_refname_format(const char *refname, int flags) { int component_len, component_count = 0; diff --git a/refs.h b/refs.h index 308fa1f03b..3b65b8d27a 100644 --- a/refs.h +++ b/refs.h @@ -459,6 +459,7 @@ int for_each_reflog(each_ref_fn fn, void *cb_data); * repeated slashes are accepted. */ int check_refname_format(const char *refname, int flags); +void sanitize_worktree_refname(struct strbuf *name); const char *prettify_refname(const char *refname); diff --git a/t/t2025-worktree-add.sh b/t/t2025-worktree-add.sh index 286bba35d8..6e2b90c84f 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 FUNNYNAMES 'sanitize generated worktree name' ' + git worktree add --detach ". weird*..?.lock.lock" && + test -d .git/worktrees/---weird--.-.lock-lock +' + test_done