mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-27 21:03:56 +01:00
e77b76425e
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> |
||
|---|---|---|
| .. | ||
| activity.go | ||
| attachment.go | ||
| blame.go | ||
| branch.go | ||
| cherry_pick.go | ||
| commit.go | ||
| compare.go | ||
| download.go | ||
| editor.go | ||
| editor_test.go | ||
| find.go | ||
| http.go | ||
| http_test.go | ||
| issue.go | ||
| issue_content_history.go | ||
| issue_dependency.go | ||
| issue_label.go | ||
| issue_label_test.go | ||
| issue_lock.go | ||
| issue_stopwatch.go | ||
| issue_test.go | ||
| issue_timetrack.go | ||
| issue_watch.go | ||
| lfs.go | ||
| main_test.go | ||
| middlewares.go | ||
| migrate.go | ||
| milestone.go | ||
| packages.go | ||
| patch.go | ||
| projects.go | ||
| projects_test.go | ||
| pull.go | ||
| pull_review.go | ||
| release.go | ||
| release_test.go | ||
| render.go | ||
| repo.go | ||
| search.go | ||
| setting.go | ||
| setting_protected_branch.go | ||
| settings_test.go | ||
| tag.go | ||
| topic.go | ||
| treelist.go | ||
| view.go | ||
| view_test.go | ||
| webhook.go | ||
| wiki.go | ||
| wiki_test.go | ||