Rework markup link rendering #26745

KN4CK3R · 2023-08-26T13:40:22Z

This PR refactors the rendering of markup links. The old code uses strings.Replace to change some urls while the new code uses more context to decide which link should be generated.

The added tests should ensure the same output for the old and new behaviour (besides the bug).

We may need to refactor the rendering a bit more to make it clear how the different helper methods render the input string. There are lots of options (resolve links / images / mentions / git hashes / emojis / ...) but you don't really know what helper uses which options. For example, we currently support images in the user description which should not be allowed I think:

Profile

https://try.gitea.io/KN4CK3R

…o-links

modules/markup/html.go

KN4CK3R · 2023-08-26T13:44:39Z

modules/markup/markdown/markdown.go

-	pc.Set(urlPrefixKey, ctx.URLPrefix)
-	pc.Set(isWikiKey, ctx.IsWiki)
-	pc.Set(renderMetasKey, ctx.Metas)


No need to put them into own keys if we already pass the whole render context. Makes the other code more readable.

modules/markup/orgmode/orgmode.go

KN4CK3R · 2023-08-26T13:46:05Z

modules/templates/util_render.go

 // the provided default url, handling for special links without email to links.
-func RenderCommitMessageLinkSubject(ctx context.Context, msg, urlPrefix, urlDefault string, metas map[string]string) template.HTML {
+func RenderCommitMessageLinkSubject(ctx context.Context, msg, urlDefault string, metas map[string]string) template.HTML {


Removed urlPrefix because RenderCommitMessageSubject does not render links at all.

CaiCandong · 2023-08-26T14:04:13Z

Thank you very much for your work. I remember another bug that may be relevant to this PR, maybe it can be fixed together.
Bug #25632
Related #15075

CaiCandong · 2023-08-28T07:27:18Z

By tested locally, overall LGTM, but I need some time to review this PR

modules/markup/renderer.go

services/mailer/mail_release.go

wxiaoguang · 2023-09-03T04:14:10Z

Resolved a conflict caused by my PR 67bc21d

wxiaoguang · 2023-09-24T23:26:17Z

It has been stable for long time. I will do some work (new PRs) without considering about conflict with these changes ......

routers/web/shared/user/header.go

modules/markup/markdown/goldmark.go

modules/markup/markdown/markdown_test.go

modules/markup/orgmode/orgmode.go

routers/web/org/home.go

modules/templates/util_render.go

…o-links

…o fix-repo-links

…o-links

wxiaoguang · 2024-01-15T01:09:45Z

routers/web/repo/commit.go

+			Metas:   ctx.Repo.Repository.ComposeMetas(ctx),
+			GitRepo: ctx.Repo.GitRepo,
+			Ctx:     ctx,
+		}, template.HTMLEscapeString(string(charset.ToUTF8WithFallback(note.Message))))


~~template.HTMLEscapeString( doesn't seem right here.~~

Hmm ... OK, it seems that it's intentionally to escape the HTML tags.

wxiaoguang

Big enough and good enough

templates/repo/branch/list.tmpl

…o-links

GiteaBot · 2024-01-15T08:49:29Z

I was unable to create a backport for 1.21. @KN4CK3R, please send one manually. 🍵

go run ./contrib/backport 26745
...  // fix git conflicts if any
go run ./contrib/backport --continue

Fixes go-gitea#26548 This PR refactors the rendering of markup links. The old code uses `strings.Replace` to change some urls while the new code uses more context to decide which link should be generated. The added tests should ensure the same output for the old and new behaviour (besides the bug). We may need to refactor the rendering a bit more to make it clear how the different helper methods render the input string. There are lots of options (resolve links / images / mentions / git hashes / emojis / ...) but you don't really know what helper uses which options. For example, we currently support images in the user description which should not be allowed I think: <details> <summary>Profile</summary> https://try.gitea.io/KN4CK3R ![grafik](https://github.com/go-gitea/gitea/assets/1666336/109ae422-496d-4200-b52e-b3a528f553e5) </details>

Backport #26745 Fixes #26548 This PR refactors the rendering of markup links. The old code uses `strings.Replace` to change some urls while the new code uses more context to decide which link should be generated. The added tests should ensure the same output for the old and new behaviour (besides the bug). We may need to refactor the rendering a bit more to make it clear how the different helper methods render the input string. There are lots of options (resolve links / images / mentions / git hashes / emojis / ...) but you don't really know what helper uses which options. For example, we currently support images in the user description which should not be allowed I think: <details> <summary>Profile</summary> https://try.gitea.io/KN4CK3R ![grafik](https://github.com/go-gitea/gitea/assets/1666336/109ae422-496d-4200-b52e-b3a528f553e5) </details>

* giteaofficial/main: (34 commits) Use refname:strip-2 instead of refname:short when syncing tags (go-gitea#28797) Add gist to comparison (go-gitea#28809) Fix links in issue card (go-gitea#28806) Show latest commit for file (go-gitea#28067) Add ability to see open and closed issues at the same time (go-gitea#28757) Display latest sync time for pull mirrors on the repo page (go-gitea#28712) Fix `GetCommitStatuses` (go-gitea#28787) Caller should check the ResponseExtra.HasError() first to see whether the request fails (go-gitea#28796) Rework markup link rendering (go-gitea#26745) Fix nil pointer panic when exec some gitea cli command (go-gitea#28791) Add branch protection setting for ignoring stale approvals (go-gitea#28498) Forbid removing the last admin user (go-gitea#28337) Fix when private user following user, private user will not be counted in his own view (go-gitea#28037) Update github.com/cloudflare/circl (go-gitea#28789) Move more functions to db.Find (go-gitea#28419) Add non-JS fallback for reaction tooltips (go-gitea#28785) Modernize merge button (go-gitea#28140) Warn that `DISABLE_QUERY_AUTH_TOKEN` is false only if it's explicitly defined (go-gitea#28783) Speed up loading the dashboard on mysql/mariadb (go-gitea#28546) Fix schedule tasks bugs (go-gitea#28691) ...

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker.io/gitea/gitea](https://github.com/go-gitea/gitea) | patch | `1.21.3` -> `1.21.4` | --- ### Release Notes <details> <summary>go-gitea/gitea (docker.io/gitea/gitea)</summary> ### [`v1.21.4`](https://github.com/go-gitea/gitea/releases/tag/v1.21.4) [Compare Source](go-gitea/gitea@v1.21.3...v1.21.4) - SECURITY - Update github.com/cloudflare/circl ([#28789](go-gitea/gitea#28789)) ([#28790](go-gitea/gitea#28790)) - Require token for GET subscription endpoint ([#28765](go-gitea/gitea#28765)) ([#28768](go-gitea/gitea#28768)) - BUGFIXES - Use refname:strip-2 instead of refname:short when syncing tags ([#28797](go-gitea/gitea#28797)) ([#28811](go-gitea/gitea#28811)) - Fix links in issue card ([#28806](go-gitea/gitea#28806)) ([#28807](go-gitea/gitea#28807)) - Fix nil pointer panic when exec some gitea cli command ([#28791](go-gitea/gitea#28791)) ([#28795](go-gitea/gitea#28795)) - Require token for GET subscription endpoint ([#28765](go-gitea/gitea#28765)) ([#28778](go-gitea/gitea#28778)) - Fix button size in "attached header right" ([#28770](go-gitea/gitea#28770)) ([#28774](go-gitea/gitea#28774)) - Fix `convert.ToTeams` on empty input ([#28426](go-gitea/gitea#28426)) ([#28767](go-gitea/gitea#28767)) - Hide code related setting options in repository when code unit is disabled ([#28631](go-gitea/gitea#28631)) ([#28749](go-gitea/gitea#28749)) - Fix incorrect URL for "Reference in New Issue" ([#28716](go-gitea/gitea#28716)) ([#28723](go-gitea/gitea#28723)) - Fix panic when parsing empty pgsql host ([#28708](go-gitea/gitea#28708)) ([#28709](go-gitea/gitea#28709)) - Upgrade xorm to new version which supported update join for all supported databases ([#28590](go-gitea/gitea#28590)) ([#28668](go-gitea/gitea#28668)) - Fix alpine package files are not rebuilt ([#28638](go-gitea/gitea#28638)) ([#28665](go-gitea/gitea#28665)) - Avoid cycle-redirecting user/login page ([#28636](go-gitea/gitea#28636)) ([#28658](go-gitea/gitea#28658)) - Fix empty ref for cron workflow runs ([#28640](go-gitea/gitea#28640)) ([#28647](go-gitea/gitea#28647)) - Remove unnecessary syncbranchToDB with tests ([#28624](go-gitea/gitea#28624)) ([#28629](go-gitea/gitea#28629)) - Use known issue IID to generate new PR index number when migrating from GitLab ([#28616](go-gitea/gitea#28616)) ([#28618](go-gitea/gitea#28618)) - Fix flex container width ([#28603](go-gitea/gitea#28603)) ([#28605](go-gitea/gitea#28605)) - Fix the scroll behavior for emoji/mention list ([#28597](go-gitea/gitea#28597)) ([#28601](go-gitea/gitea#28601)) - Fix wrong due date rendering in issue list page ([#28588](go-gitea/gitea#28588)) ([#28591](go-gitea/gitea#28591)) - Fix `status_check_contexts` matching bug ([#28582](go-gitea/gitea#28582)) ([#28589](go-gitea/gitea#28589)) - Fix 500 error of searching commits ([#28576](go-gitea/gitea#28576)) ([#28579](go-gitea/gitea#28579)) - Use information from previous blame parts ([#28572](go-gitea/gitea#28572)) ([#28577](go-gitea/gitea#28577)) - Update mermaid for 1.21 ([#28571](go-gitea/gitea#28571)) - Fix 405 method not allowed CORS / OIDC ([#28583](go-gitea/gitea#28583)) ([#28586](go-gitea/gitea#28586)) ([#28587](go-gitea/gitea#28587)) ([#28611](go-gitea/gitea#28611)) - Fix `GetCommitStatuses` ([#28787](go-gitea/gitea#28787)) ([#28804](go-gitea/gitea#28804)) - Forbid removing the last admin user ([#28337](go-gitea/gitea#28337)) ([#28793](go-gitea/gitea#28793)) - Fix schedule tasks bugs ([#28691](go-gitea/gitea#28691)) ([#28780](go-gitea/gitea#28780)) - Fix issue dependencies ([#27736](go-gitea/gitea#27736)) ([#28776](go-gitea/gitea#28776)) - Fix system webhooks API bug ([#28531](go-gitea/gitea#28531)) ([#28666](go-gitea/gitea#28666)) - Fix when private user following user, private user will not be counted in his own view ([#28037](go-gitea/gitea#28037)) ([#28792](go-gitea/gitea#28792)) - Render code block in activity tab ([#28816](go-gitea/gitea#28816)) ([#28818](go-gitea/gitea#28818)) - ENHANCEMENTS - Rework markup link rendering ([#26745](go-gitea/gitea#26745)) ([#28803](go-gitea/gitea#28803)) - Modernize merge button ([#28140](go-gitea/gitea#28140)) ([#28786](go-gitea/gitea#28786)) - Speed up loading the dashboard on mysql/mariadb ([#28546](go-gitea/gitea#28546)) ([#28784](go-gitea/gitea#28784)) - Assign pull request to project during creation ([#28227](go-gitea/gitea#28227)) ([#28775](go-gitea/gitea#28775)) - Show description as tooltip instead of title for labels ([#28754](go-gitea/gitea#28754)) ([#28766](go-gitea/gitea#28766)) - Make template `DateTime` show proper tooltip ([#28677](go-gitea/gitea#28677)) ([#28683](go-gitea/gitea#28683)) - Switch destination directory for apt signing keys ([#28639](go-gitea/gitea#28639)) ([#28642](go-gitea/gitea#28642)) - Include heap pprof in diagnosis report to help debugging memory leaks ([#28596](go-gitea/gitea#28596)) ([#28599](go-gitea/gitea#28599)) - DOCS - Suggest to use Type=simple for systemd service ([#28717](go-gitea/gitea#28717)) ([#28722](go-gitea/gitea#28722)) - Extend description for ARTIFACT_RETENTION_DAYS ([#28626](go-gitea/gitea#28626)) ([#28630](go-gitea/gitea#28630)) - MISC - Add -F to commit search to treat keywords as strings ([#28744](go-gitea/gitea#28744)) ([#28748](go-gitea/gitea#28748)) - Add download attribute to release attachments ([#28739](go-gitea/gitea#28739)) ([#28740](go-gitea/gitea#28740)) - Concatenate error in `checkIfPRContentChanged` ([#28731](go-gitea/gitea#28731)) ([#28737](go-gitea/gitea#28737)) - Improve 1.21 document for Database Preparation ([#28643](go-gitea/gitea#28643)) ([#28644](go-gitea/gitea#28644)) Instances on **[Gitea Cloud](https://cloud.gitea.com)** will be automatically upgraded to this version during the specified maintenance window. </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.home/nrdufour/home-ops/pulls/316 Co-authored-by: Renovate <renovate@ptinem.io> Co-committed-by: Renovate <renovate@ptinem.io>

Fixes go-gitea#26548 This PR refactors the rendering of markup links. The old code uses `strings.Replace` to change some urls while the new code uses more context to decide which link should be generated. The added tests should ensure the same output for the old and new behaviour (besides the bug). We may need to refactor the rendering a bit more to make it clear how the different helper methods render the input string. There are lots of options (resolve links / images / mentions / git hashes / emojis / ...) but you don't really know what helper uses which options. For example, we currently support images in the user description which should not be allowed I think: <details> <summary>Profile</summary> https://try.gitea.io/KN4CK3R ![grafik](https://github.com/go-gitea/gitea/assets/1666336/109ae422-496d-4200-b52e-b3a528f553e5) </details> --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>

KN4CK3R added 2 commits August 26, 2023 13:27

Refactor link rendering.

77b5402

Merge branch 'main' of https://github.com/go-gitea/gitea into fix-rep…

cbb54ce

…o-links

KN4CK3R added type/bug type/refactoring Existing code has been cleaned up. There should be no new functionality. labels Aug 26, 2023

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Aug 26, 2023

pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 26, 2023

KN4CK3R commented Aug 26, 2023

View reviewed changes

This was referenced Aug 26, 2023

markdown image links are wrong if repo is called 'src' #26548

Closed

Fix incorrect replacement in markdown image links #26562

Closed

lunny added this to the 1.21.0 milestone Aug 28, 2023

CaiCandong approved these changes Aug 28, 2023

View reviewed changes

GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Aug 28, 2023

KN4CK3R mentioned this pull request Aug 28, 2023

Fix joined urls #26774

Closed

wxiaoguang reviewed Aug 30, 2023

View reviewed changes

modules/markup/renderer.go Outdated Show resolved Hide resolved

services/mailer/mail_release.go Outdated Show resolved Hide resolved

Merge branch 'main' into fix-repo-links

67bc21d

wxiaoguang and others added 2 commits September 5, 2023 00:47

Merge branch 'main' into fix-repo-links

08f58b0

Merge branch 'main' into fix-repo-links

7142344

wxiaoguang mentioned this pull request Sep 16, 2023

Next round of db.DefaultContext refactor #27089

Merged

lunny modified the milestones: 1.21.0, 1.22.0 Sep 21, 2023

delvh reviewed Oct 1, 2023

View reviewed changes

KN4CK3R added 4 commits November 7, 2023 23:29

Merge branch 'main' of https://github.com/go-gitea/gitea into fix-rep…

710d32e

…o-links

Merge branch 'fix-repo-links' of https://github.com/KN4CK3R/gitea int…

a8c22b9

…o fix-repo-links

Merge branch 'main' of https://github.com/go-gitea/gitea into fix-rep…

f5acb11

…o-links

Apply suggestions.

3aa6d10

KN4CK3R added 3 commits November 12, 2023 13:35

-

a6ecd18

Fix tests.

65243dc

Merge branch 'main' of https://github.com/go-gitea/gitea into fix-rep…

b917bb4

…o-links

wxiaoguang reviewed Jan 15, 2024

View reviewed changes

wxiaoguang approved these changes Jan 15, 2024

View reviewed changes

GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 15, 2024

wxiaoguang reviewed Jan 15, 2024

View reviewed changes

templates/repo/branch/list.tmpl Outdated Show resolved Hide resolved

KN4CK3R added 2 commits January 15, 2024 08:12

Fix locale error.

778347a

Merge branch 'main' of https://github.com/go-gitea/gitea into fix-rep…

3c376c7

…o-links

lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jan 15, 2024

lunny enabled auto-merge (squash) January 15, 2024 08:29

lunny added the backport/v1.21 This PR should be backported to Gitea 1.21 label Jan 15, 2024

lunny merged commit 637451a into go-gitea:main Jan 15, 2024
25 checks passed

GiteaBot added backport/manual No power to the bots! Create your backport yourself! and removed reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. labels Jan 15, 2024

KN4CK3R deleted the fix-repo-links branch January 15, 2024 12:53

KN4CK3R mentioned this pull request Jan 15, 2024

Rework markup link rendering (#26745) #28803

Merged

KN4CK3R added the backport/done All backports for this PR have been created label Jan 16, 2024

MGChecker mentioned this pull request Jan 23, 2024

Links in Markdown files are not evaluated relative to the (relevant / main) branch #28904

Closed

lunny mentioned this pull request Jan 25, 2024

Error when pasting an attachment #28915

Closed

github-actions bot locked as resolved and limited conversation to collaborators Mar 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rework markup link rendering #26745

Rework markup link rendering #26745

KN4CK3R commented Aug 26, 2023 •

edited

Loading

KN4CK3R Aug 26, 2023

KN4CK3R Aug 26, 2023

CaiCandong commented Aug 26, 2023 •

edited

Loading

CaiCandong commented Aug 28, 2023 •

edited

Loading

wxiaoguang commented Sep 3, 2023 •

edited

Loading

wxiaoguang commented Sep 24, 2023 •

edited

Loading

wxiaoguang Jan 15, 2024 •

edited

Loading

wxiaoguang left a comment

GiteaBot commented Jan 15, 2024

Rework markup link rendering #26745

Rework markup link rendering #26745

Conversation

KN4CK3R commented Aug 26, 2023 • edited Loading

KN4CK3R Aug 26, 2023

Choose a reason for hiding this comment

KN4CK3R Aug 26, 2023

Choose a reason for hiding this comment

CaiCandong commented Aug 26, 2023 • edited Loading

CaiCandong commented Aug 28, 2023 • edited Loading

wxiaoguang commented Sep 3, 2023 • edited Loading

wxiaoguang commented Sep 24, 2023 • edited Loading

wxiaoguang Jan 15, 2024 • edited Loading

Choose a reason for hiding this comment

wxiaoguang left a comment

Choose a reason for hiding this comment

GiteaBot commented Jan 15, 2024

KN4CK3R commented Aug 26, 2023 •

edited

Loading

CaiCandong commented Aug 26, 2023 •

edited

Loading

CaiCandong commented Aug 28, 2023 •

edited

Loading

wxiaoguang commented Sep 3, 2023 •

edited

Loading

wxiaoguang commented Sep 24, 2023 •

edited

Loading

wxiaoguang Jan 15, 2024 •

edited

Loading