From e7ef94e00f1319e5fb876f47fee28728bd671f07 Mon Sep 17 00:00:00 2001 From: wxiaoguang Date: Fri, 17 Feb 2023 22:02:20 +0800 Subject: [PATCH] Introduce customized HTML elements, fix incorrect AppUrl usages in templates (#22861) This PR follows: * #21986 * #22831 This PR also introduce customized HTML elements, which would also help problems like: * #17760 * #21429 * #21440 With customized HTML elements, there won't be any load-search-replace operations, and it can avoid page flicking (which @silverwind cares a lot). Browser support: https://developer.mozilla.org/en-US/docs/Web/API/Window/customElements # FAQ ## Why the component has the prefix? As usual, I would strongly suggest to add prefixes for our own/private names. The dedicated prefix will avoid conflicts in the future, and it makes it easier to introduce various 3rd components, like GitHub's `relative-time` component. If there is no prefix, it's impossible to introduce another public component with the same name in the future. ## Why the `custcomp.js` is loaded before HTML body? The `index.js` is after HTML body. Customized components must be registered before the content loading. Otherwise there would be still some flicking. `custcomp.js` should have its own dependencies and should be very light, so it won't affect the page loading time too much. ## Why use `data-url` attribute but not use the `textContent`? According to the standard, the `connectedCallback` occurs on the tag-opening moment. The element's children are not ready yet. ## Why not use `{{.GuessCurrentOrigin $.ctx ...}}` to let backend decide the absolute URL? It's difficult for backend to guess the correct protocol(scheme) correctly with zero configuration. Generating the absolute URL from frontend can guarantee that the URL is 100% correct -- since the user is visiting it. # Screenshot
![image](https://user-images.githubusercontent.com/2114189/218256757-a267c8ba-3108-4755-9ae5-329f1b08f615.png)
--- templates/base/head_script.tmpl | 1 + templates/package/content/cargo.tmpl | 2 +- templates/package/content/chef.tmpl | 2 +- templates/package/content/composer.tmpl | 2 +- templates/package/content/conan.tmpl | 2 +- templates/package/content/conda.tmpl | 6 +++--- templates/package/content/generic.tmpl | 7 +++++-- templates/package/content/helm.tmpl | 2 +- templates/package/content/maven.tmpl | 8 ++++---- templates/package/content/npm.tmpl | 2 +- templates/package/content/nuget.tmpl | 2 +- templates/package/content/pub.tmpl | 2 +- templates/package/content/pypi.tmpl | 2 +- templates/package/content/rubygems.tmpl | 4 ++-- templates/package/content/vagrant.tmpl | 2 +- templates/post-install.tmpl | 2 +- .../view_content/pull_merge_instruction.tmpl | 3 +-- templates/repo/view_list.tmpl | 2 +- templates/swagger/ui.tmpl | 4 ++-- web_src/js/webcomponents/GiteaOriginUrl.js | 17 +++++++++++++++++ webpack.config.js | 3 +++ 21 files changed, 50 insertions(+), 27 deletions(-) create mode 100644 web_src/js/webcomponents/GiteaOriginUrl.js diff --git a/templates/base/head_script.tmpl b/templates/base/head_script.tmpl index 1b130d9cb49..ca8c7e6a773 100644 --- a/templates/base/head_script.tmpl +++ b/templates/base/head_script.tmpl @@ -46,3 +46,4 @@ If you introduce mistakes in it, Gitea JavaScript code wouldn't run correctly. {{/* in case some pages don't render the pageData, we make sure it is an object to prevent null access */}} window.config.pageData = window.config.pageData || {}; + diff --git a/templates/package/content/cargo.tmpl b/templates/package/content/cargo.tmpl index 54c40a5b0dc..f78647ca69c 100644 --- a/templates/package/content/cargo.tmpl +++ b/templates/package/content/cargo.tmpl @@ -8,7 +8,7 @@ default = "gitea" [registries.gitea] -index = "{{AppUrl}}{{.PackageDescriptor.Owner.Name}}/_cargo-index.git" +index = "" [net] git-fetch-with-cli = true diff --git a/templates/package/content/chef.tmpl b/templates/package/content/chef.tmpl index f0f8de7bd55..edc175f9bed 100644 --- a/templates/package/content/chef.tmpl +++ b/templates/package/content/chef.tmpl @@ -4,7 +4,7 @@
- 
knife[:supermarket_site] = '{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/chef'
+ 
knife[:supermarket_site] = ''
diff --git a/templates/package/content/composer.tmpl b/templates/package/content/composer.tmpl index 8cc18f8ba8f..9acf20955c8 100644 --- a/templates/package/content/composer.tmpl +++ b/templates/package/content/composer.tmpl @@ -7,7 +7,7 @@ 
{
 	"repositories": [{
 			"type": "composer",
-			"url": "{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/composer"
+			"url": ""
 		}
 	]
 }
diff --git a/templates/package/content/conan.tmpl b/templates/package/content/conan.tmpl index c496cee55cf..138890f334c 100644 --- a/templates/package/content/conan.tmpl +++ b/templates/package/content/conan.tmpl @@ -4,7 +4,7 @@
- 
conan remote add gitea {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/conan
+ 
conan remote add gitea
diff --git a/templates/package/content/conda.tmpl b/templates/package/content/conda.tmpl index ecc26bce98e..3c79d3902fa 100644 --- a/templates/package/content/conda.tmpl +++ b/templates/package/content/conda.tmpl @@ -4,11 +4,11 @@
- 
channel_alias: {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/conda
+				
channel_alias: 
 channels:
-  - {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/conda
+  - 
 default_channels:
-  - {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/conda

+  -
diff --git a/templates/package/content/generic.tmpl b/templates/package/content/generic.tmpl index 2948d9eb02c..eae4d670f9c 100644 --- a/templates/package/content/generic.tmpl +++ b/templates/package/content/generic.tmpl @@ -4,8 +4,11 @@
- 
{{range .PackageDescriptor.Files}}curl {{AppUrl}}api/packages/{{$.PackageDescriptor.Owner.Name}}/generic/{{$.PackageDescriptor.Package.Name}}/{{$.PackageDescriptor.Version.Version}}/{{.File.Name}}
-{{end}}
+ 

+					{{- range .PackageDescriptor.Files -}}
+curl 

+					{{- end -}}
+
diff --git a/templates/package/content/helm.tmpl b/templates/package/content/helm.tmpl index 59cdc157b40..fc190e0e459 100644 --- a/templates/package/content/helm.tmpl +++ b/templates/package/content/helm.tmpl @@ -4,7 +4,7 @@
- 
helm repo add gitea {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/helm
+				
helm repo add gitea 
 helm repo update
diff --git a/templates/package/content/maven.tmpl b/templates/package/content/maven.tmpl index 0b5612151c5..ff89145fd00 100644 --- a/templates/package/content/maven.tmpl +++ b/templates/package/content/maven.tmpl @@ -7,19 +7,19 @@ 
<repositories>
 	<repository>
 		<id>gitea</id>
-		<url>{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/maven</url>
+			<url></url>
 	</repository>
 </repositories>
 
 <distributionManagement>
 	<repository>
 		<id>gitea</id>
-		<url>{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/maven</url>
+		<url></url>
 	</repository>
 
 	<snapshotRepository>
 		<id>gitea</id>
-		<url>{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/maven</url>
+		<url></url>
 	</snapshotRepository>
 </distributionManagement>
@@ -37,7 +37,7 @@
- 
mvn dependency:get -DremoteRepositories={{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/maven -Dartifact={{.PackageDescriptor.Metadata.GroupID}}:{{.PackageDescriptor.Metadata.ArtifactID}}:{{.PackageDescriptor.Version.Version}}
+ 
mvn dependency:get -DremoteRepositories= -Dartifact={{.PackageDescriptor.Metadata.GroupID}}:{{.PackageDescriptor.Metadata.ArtifactID}}:{{.PackageDescriptor.Version.Version}}
diff --git a/templates/package/content/npm.tmpl b/templates/package/content/npm.tmpl index 33d51d4dfd8..ea514c5263a 100644 --- a/templates/package/content/npm.tmpl +++ b/templates/package/content/npm.tmpl @@ -4,7 +4,7 @@
- 
{{if .PackageDescriptor.Metadata.Scope}}{{.PackageDescriptor.Metadata.Scope}}:{{end}}registry={{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/npm/
+ 
{{if .PackageDescriptor.Metadata.Scope}}{{.PackageDescriptor.Metadata.Scope}}:{{end}}registry=
diff --git a/templates/package/content/nuget.tmpl b/templates/package/content/nuget.tmpl index 4ea41fa826a..8ed2f04e4a5 100644 --- a/templates/package/content/nuget.tmpl +++ b/templates/package/content/nuget.tmpl @@ -4,7 +4,7 @@
- 
dotnet nuget add source --name Gitea --username your_username --password your_token {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/nuget/index.json
+ 
dotnet nuget add source --name Gitea --username your_username --password your_token
diff --git a/templates/package/content/pub.tmpl b/templates/package/content/pub.tmpl index 999e48ce820..e81439d4dae 100644 --- a/templates/package/content/pub.tmpl +++ b/templates/package/content/pub.tmpl @@ -4,7 +4,7 @@
- 
dart pub add {{.PackageDescriptor.Package.Name}}:{{.PackageDescriptor.Version.Version}} --hosted-url={{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/pub/
+ 
dart pub add {{.PackageDescriptor.Package.Name}}:{{.PackageDescriptor.Version.Version}} --hosted-url=
diff --git a/templates/package/content/pypi.tmpl b/templates/package/content/pypi.tmpl index 1ae243813de..830ba9bd67e 100644 --- a/templates/package/content/pypi.tmpl +++ b/templates/package/content/pypi.tmpl @@ -4,7 +4,7 @@
- 
pip install --index-url {{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/pypi/simple {{.PackageDescriptor.Package.Name}}
+ 
pip install --index-url
diff --git a/templates/package/content/rubygems.tmpl b/templates/package/content/rubygems.tmpl index 0cb7b670b1d..d8190ba4f59 100644 --- a/templates/package/content/rubygems.tmpl +++ b/templates/package/content/rubygems.tmpl @@ -4,11 +4,11 @@
- 
gem install {{.PackageDescriptor.Package.Name}} --version "{{.PackageDescriptor.Version.Version}}" --source "{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/rubygems"
+ 
gem install {{.PackageDescriptor.Package.Name}} --version "{{.PackageDescriptor.Version.Version}}" --source ""
- 
source "{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/rubygems" do
+				
source "" do
 	gem "{{.PackageDescriptor.Package.Name}}", "{{.PackageDescriptor.Version.Version}}"
 end
diff --git a/templates/package/content/vagrant.tmpl b/templates/package/content/vagrant.tmpl index 7bd686e6ab6..a6a92f5ecd8 100644 --- a/templates/package/content/vagrant.tmpl +++ b/templates/package/content/vagrant.tmpl @@ -4,7 +4,7 @@
- 
vagrant box add --box-version {{.PackageDescriptor.Version.Version}} "{{AppUrl}}api/packages/{{.PackageDescriptor.Owner.Name}}/vagrant/{{.PackageDescriptor.Package.Name}}"
+ 
vagrant box add --box-version {{.PackageDescriptor.Version.Version}} ""
diff --git a/templates/post-install.tmpl b/templates/post-install.tmpl index e098f43fda8..0d6cd3082c1 100644 --- a/templates/post-install.tmpl +++ b/templates/post-install.tmpl @@ -13,7 +13,7 @@
-

{{AppUrl}}user/login

+

{{AppSubUrl}}/user/login

diff --git a/templates/repo/issue/view_content/pull_merge_instruction.tmpl b/templates/repo/issue/view_content/pull_merge_instruction.tmpl index 39349d6ca42..5a7f6e867b5 100644 --- a/templates/repo/issue/view_content/pull_merge_instruction.tmpl +++ b/templates/repo/issue/view_content/pull_merge_instruction.tmpl @@ -5,8 +5,7 @@
{{if eq $.Issue.PullRequest.Flow 0}}
git checkout -b {{if ne $.Issue.PullRequest.HeadRepo.ID $.Issue.PullRequest.BaseRepo.ID}}{{$.Issue.PullRequest.HeadRepo.OwnerName}}-{{end}}{{$.Issue.PullRequest.HeadBranch}} {{$.Issue.PullRequest.BaseBranch}}
- {{/* the only legacy HTMLURL used in template, which doesn't affect users too much and is very diffcult to fix, it should be fixed together with other AppUrl usages*/}} -
git pull {{if ne $.Issue.PullRequest.HeadRepo.ID $.Issue.PullRequest.BaseRepo.ID}}{{$.Issue.PullRequest.HeadRepo.HTMLURL}}{{else}}origin{{end}} {{$.Issue.PullRequest.HeadBranch}}
+
git pull {{if ne $.Issue.PullRequest.HeadRepo.ID $.Issue.PullRequest.BaseRepo.ID}}{{else}}origin{{end}} {{$.Issue.PullRequest.HeadBranch}}
{{else}}
git fetch origin {{$.Issue.PullRequest.GetGitRefName}}:{{$.Issue.PullRequest.HeadBranch}}
{{end}} diff --git a/templates/repo/view_list.tmpl b/templates/repo/view_list.tmpl index 45d098d3c54..ab7065015c1 100644 --- a/templates/repo/view_list.tmpl +++ b/templates/repo/view_list.tmpl @@ -52,7 +52,7 @@ {{if $entry.IsSubModule}} {{svg "octicon-file-submodule"}} - {{$refURL := $subModuleFile.RefURL AppUrl $.Repository.FullName $.SSHDomain}} + {{$refURL := $subModuleFile.RefURL AppUrl $.Repository.FullName $.SSHDomain}} {{/* FIXME: the usage of AppUrl seems incorrect, it would be fixed in the future, use AppSubUrl instead */}} {{if $refURL}} {{$entry.Name}}@{{ShortSha $subModuleFile.RefID}} {{else}} diff --git a/templates/swagger/ui.tmpl b/templates/swagger/ui.tmpl index d4d0889f9d4..57b560bc159 100644 --- a/templates/swagger/ui.tmpl +++ b/templates/swagger/ui.tmpl @@ -6,8 +6,8 @@ - {{svg "octicon-reply"}}{{.locale.Tr "return_to_gitea"}} -
+ {{svg "octicon-reply"}}{{.locale.Tr "return_to_gitea"}} +
diff --git a/web_src/js/webcomponents/GiteaOriginUrl.js b/web_src/js/webcomponents/GiteaOriginUrl.js new file mode 100644 index 00000000000..47fd13bfc1d --- /dev/null +++ b/web_src/js/webcomponents/GiteaOriginUrl.js @@ -0,0 +1,17 @@ +// this is a Gitea's private HTML component, it converts an absolute or relative URL to an absolute URL with the current origin +window.customElements.define('gitea-origin-url', class extends HTMLElement { + connectedCallback() { + const urlStr = this.getAttribute('data-url'); + try { + // only process absolute HTTP/HTTPS URL or relative URLs ('/xxx' or '//host/xxx') + if (urlStr.startsWith('http://') || urlStr.startsWith('https://') || urlStr.startsWith('/')) { + const url = new URL(urlStr, window.origin); + url.protocol = window.location.protocol; + url.host = window.location.host; + this.textContent = url.toString(); + return; + } + } catch {} + this.textContent = urlStr; + } +}); diff --git a/webpack.config.js b/webpack.config.js index e5e592052e1..2ac463abef2 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -59,6 +59,9 @@ export default { fileURLToPath(new URL('web_src/fomantic/build/semantic.css', import.meta.url)), fileURLToPath(new URL('web_src/less/index.less', import.meta.url)), ], + webcomponents: [ + fileURLToPath(new URL('web_src/js/webcomponents/GiteaOriginUrl.js', import.meta.url)), + ], swagger: [ fileURLToPath(new URL('web_src/js/standalone/swagger.js', import.meta.url)), fileURLToPath(new URL('web_src/less/standalone/swagger.less', import.meta.url)),