forgejo-federation/routers/web/repo
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>
2022-11-22 20:58:49 +08:00
..
activity.go Respect user's locale when rendering the date range in the repo activity page (#21410) 2022-10-13 00:14:14 +03:00
attachment.go Move some repository related code into sub package (#19711) 2022-06-06 16:01:49 +08:00
blame.go Show syntax lexer name in file view/blame (#21814) 2022-11-19 13:08:06 +02:00
branch.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
cherry_pick.go Remove RequireHighlightJS field, update plantuml example. (#19615) 2022-05-05 10:53:38 +03:00
commit.go Fix pagination limit parameter problem (#21109) 2022-09-08 11:56:14 -04:00
compare.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
download.go Slightly simplify LastCommitCache (#20444) 2022-07-25 16:39:42 +01:00
editor.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
editor_test.go Add more linters to improve code readability (#19989) 2022-06-20 12:02:49 +02:00
find.go Feature: Find files in repo (#15028) 2022-06-09 14:15:08 +03:00
http.go Refactor git command arguments and make all arguments to be safe to be used (#21535) 2022-10-23 22:44:45 +08:00
http_test.go Fix http path bug (#16117) 2021-06-09 14:53:12 +02:00
issue.go Prepend refs/heads/ to issue template refs (#20461) 2022-11-22 20:58:49 +08:00
issue_content_history.go Make better use of i18n (#20096) 2022-06-26 22:19:22 +08:00
issue_dependency.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_label.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
issue_label_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_lock.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_stopwatch.go Stop spurious APIFormat stopwatches logs (#20008) 2022-06-17 22:47:15 +01:00
issue_test.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_timetrack.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
issue_watch.go Move issues related files into models/issues (#19931) 2022-06-13 17:37:59 +08:00
lfs.go Adjust gitea doctor --run storages to check all storage types (#21785) 2022-11-15 16:08:59 +08:00
main_test.go Use a struct as test options (#19393) 2022-04-14 21:58:21 +08:00
middlewares.go Add system setting table with cache and also add cache supports for user setting (#18058) 2022-10-17 07:29:26 +08:00
migrate.go Unify repo settings & show better error (#19828) 2022-06-12 13:43:27 +08:00
milestone.go Move milestone to models/issues/ (#19278) 2022-04-08 17:11:15 +08:00
packages.go Show hint to link package to repo when viewing empty repo package list (#20504) 2022-07-27 19:58:21 +08:00
patch.go Remove RequireHighlightJS field, update plantuml example. (#19615) 2022-05-05 10:53:38 +03:00
projects.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
projects_test.go Decouple unit test code from business code (#17623) 2021-11-12 22:36:47 +08:00
pull.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
pull_review.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
release.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
release_test.go Move some files into models' sub packages (#20262) 2022-08-25 10:31:57 +08:00
render.go Allow render HTML with css/js external links (#19017) 2022-06-16 11:33:23 +08:00
repo.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
search.go Add user/organization code search (#19977) 2022-10-11 00:12:03 +01:00
setting.go Replace all instances of fmt.Errorf(%v) with fmt.Errorf(%w) (#21551) 2022-10-24 20:29:17 +01:00
setting_protected_branch.go Move some code into models/git (#19879) 2022-06-12 23:51:54 +08:00
settings_test.go test: use T.TempDir to create temporary test directory (#21043) 2022-09-04 16:14:53 +01:00
tag.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
topic.go Renamed ctx.User to ctx.Doer. (#19161) 2022-03-22 15:03:22 +08:00
treelist.go Refactor parseTreeEntries, speed up tree list (#21368) 2022-10-08 01:20:53 +08:00
view.go Improvements for Content Copy (#21842) 2022-11-21 17:59:42 +08:00
view_test.go adapt README_{Country}.md stype name in localizedExtensions (#21486) 2022-10-24 14:12:15 +08:00
webhook.go Add Webhook authorization header (#20926) 2022-11-03 20:23:20 +02:00
wiki.go Add context.Context to more methods (#21546) 2022-11-19 16:12:33 +08:00
wiki_test.go Make git.OpenRepository accept Context (#19260) 2022-03-30 03:13:41 +08:00