You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zeripath e77b76425e
Prepend refs/heads/ to issue template refs (#20461)
Fix #20456

At some point during the 1.17 cycle abbreviated refishs to issue
branches started breaking. This is likely due serious inconsistencies in
our management of refs throughout Gitea - which is a bug needing to be
addressed in a different PR. (Likely more than one)

We should try to use non-abbreviated `fullref`s as much as possible.
That is where a user has inputted a abbreviated `refish` we should add
`refs/heads/` if it is `branch` etc. I know people keep writing and
merging PRs that remove prefixes from stored content but it is just
wrong and it keeps causing problems like this. We should only remove the
prefix at the time of
presentation as the prefix is the only way of knowing umambiguously and
permanently if the `ref` is referring to a `branch`, `tag` or `commit` /
`SHA`. We need to make it so that every ref has the appropriate prefix,
and probably also need to come up with some definitely unambiguous way
of storing `SHA`s if they're used in a `ref` or `refish` field. We must
not store a potentially
ambiguous `refish` as a `ref`. (Especially when referring a `tag` -
there is no reason why users cannot create a `branch` with the same
short name as a `tag` and vice versa and any attempt to prevent this
will fail. You can even create a `branch` and a
`tag` that matches the `SHA` pattern.)

To that end in order to fix this bug, when parsing issue templates check
the provided `Ref` (here a `refish` because almost all users do not know
or understand the subtly), if it does not start with `refs/` add the
`BranchPrefix` to it. This allows people to make their templates refer
to a `tag` but not to a `SHA` directly. (I don't think that is
particularly unreasonable but if people disagree I can make the `refish`
be checked to see if it matches the `SHA` pattern.)

Next we need to handle the issue links that are already written. The
links here are created with `git.RefURL`

Here we see there is a bug introduced in #17551 whereby the provided
`ref` argument can be double-escaped so we remove the incorrect external
escape. (The escape added in #17551 is in the right place -
unfortunately I missed that the calling function was doing the wrong
thing.)

Then within `RefURL()` we check if an unprefixed `ref` (therefore
potentially a `refish`) matches the `SHA` pattern before assuming that
is actually a `commit` - otherwise is assumed to be a `branch`. This
will handle most of the problem cases excepting the very unusual cases
where someone has deliberately written a `branch` to look like a `SHA1`.

But please if something is called a `ref` or interpreted as a `ref` make
it a full-ref before storing or using it. By all means if something is a
`branch` assume the prefix is removed but always add it back in if you
are using it as a `ref`. Stop storing abbreviated `branch` names and
`tag` names - which are `refish` as a `ref`. It will keep on causing
problems like this.

Fix #20456

Signed-off-by: Andrew Thornton <art27@cantab.net>
Co-authored-by: Lauris BH <lauris@nix.lv>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
2 years ago
..
activity.go Respect user's locale when rendering the date range in the repo activity page (#21410) 2 years ago
attachment.go Move some repository related code into sub package (#19711) 2 years ago
blame.go Show syntax lexer name in file view/blame (#21814) 2 years ago
branch.go Add `context.Context` to more methods (#21546) 2 years ago
cherry_pick.go Remove `RequireHighlightJS` field, update plantuml example. (#19615) 2 years ago
commit.go Fix pagination limit parameter problem (#21109) 2 years ago
compare.go Add `context.Context` to more methods (#21546) 2 years ago
download.go Slightly simplify LastCommitCache (#20444) 2 years ago
editor.go Move some files into models' sub packages (#20262) 2 years ago
editor_test.go Add more linters to improve code readability (#19989) 2 years ago
find.go Feature: Find files in repo (#15028) 2 years ago
http.go Refactor git command arguments and make all arguments to be safe to be used (#21535) 2 years ago
http_test.go Fix http path bug (#16117) 3 years ago
issue.go Prepend refs/heads/ to issue template refs (#20461) 2 years ago
issue_content_history.go Make better use of i18n (#20096) 2 years ago
issue_dependency.go Move issues related files into models/issues (#19931) 2 years ago
issue_label.go Add `context.Context` to more methods (#21546) 2 years ago
issue_label_test.go Move issues related files into models/issues (#19931) 2 years ago
issue_lock.go Move issues related files into models/issues (#19931) 2 years ago
issue_stopwatch.go Stop spurious APIFormat stopwatches logs (#20008) 2 years ago
issue_test.go Move issues related files into models/issues (#19931) 2 years ago
issue_timetrack.go Move issues related files into models/issues (#19931) 2 years ago
issue_watch.go Move issues related files into models/issues (#19931) 2 years ago
lfs.go Adjust gitea doctor --run storages to check all storage types (#21785) 2 years ago
main_test.go Use a struct as test options (#19393) 2 years ago
middlewares.go Add system setting table with cache and also add cache supports for user setting (#18058) 2 years ago
migrate.go Unify repo settings & show better error (#19828) 2 years ago
milestone.go Move milestone to models/issues/ (#19278) 2 years ago
packages.go Show hint to link package to repo when viewing empty repo package list (#20504) 2 years ago
patch.go Remove `RequireHighlightJS` field, update plantuml example. (#19615) 2 years ago
projects.go Add `context.Context` to more methods (#21546) 2 years ago
projects_test.go Decouple unit test code from business code (#17623) 3 years ago
pull.go Add `context.Context` to more methods (#21546) 2 years ago
pull_review.go Add `context.Context` to more methods (#21546) 2 years ago
release.go Add `context.Context` to more methods (#21546) 2 years ago
release_test.go Move some files into models' sub packages (#20262) 2 years ago
render.go Allow render HTML with css/js external links (#19017) 2 years ago
repo.go Add `context.Context` to more methods (#21546) 2 years ago
search.go Add user/organization code search (#19977) 2 years ago
setting.go Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) (#21551) 2 years ago
setting_protected_branch.go Move some code into models/git (#19879) 2 years ago
settings_test.go test: use `T.TempDir` to create temporary test directory (#21043) 2 years ago
tag.go Add `context.Context` to more methods (#21546) 2 years ago
topic.go Renamed ctx.User to ctx.Doer. (#19161) 2 years ago
treelist.go Refactor parseTreeEntries, speed up tree list (#21368) 2 years ago
view.go Improvements for Content Copy (#21842) 2 years ago
view_test.go adapt README_{Country}.md stype name in localizedExtensions (#21486) 2 years ago
webhook.go Add Webhook authorization header (#20926) 2 years ago
wiki.go Add `context.Context` to more methods (#21546) 2 years ago
wiki_test.go Make git.OpenRepository accept Context (#19260) 2 years ago