faa28b5a44
Move `public/*` to `public/assets/*` Some old PRs (like #15219) introduced inconsistent directory system. For example: why the local directory "public" is accessed by `http://site/assets`? How to serve the ".well-known" files properly in the public directory? For convention rules, the "public" directory is widely used for the website's root directory. It shouldn't be an exception for Gitea. So, this PR makes the things consistent: * `http://site/assets/foo` means `{CustomPath}/public/assets/foo`. * `{CustomPath}/public/.well-known` and `{CustomPath}/public/robots.txt` can be used in the future. This PR is also a prerequisite for a clear solution for: * #21942 * #25892 * discourse.gitea.io: [.well-known path serving custom files behind proxy?](https://discourse.gitea.io/t/well-known-path-serving-custom-files-behind-proxy/5445/1) This PR is breaking for users who have custom "public" files (CSS/JS). After getting approvals, I will update the documents. ---- ## ⚠️ BREAKING ⚠️ If you have files in your "custom/public/" folder, please move them to "custom/public/assets/". --------- Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Giteabot <teabot@gitea.io>
66 lines
1.6 KiB
Go
66 lines
1.6 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package svg
|
|
|
|
import (
|
|
"fmt"
|
|
"html/template"
|
|
"path"
|
|
"regexp"
|
|
"strings"
|
|
|
|
"code.gitea.io/gitea/modules/html"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/public"
|
|
)
|
|
|
|
var (
|
|
// SVGs contains discovered SVGs
|
|
SVGs = map[string]string{}
|
|
|
|
widthRe = regexp.MustCompile(`width="[0-9]+?"`)
|
|
heightRe = regexp.MustCompile(`height="[0-9]+?"`)
|
|
)
|
|
|
|
const defaultSize = 16
|
|
|
|
// Init discovers SVGs and populates the `SVGs` variable
|
|
func Init() error {
|
|
files, err := public.AssetFS().ListFiles("assets/img/svg")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Remove `xmlns` because inline SVG does not need it
|
|
reXmlns := regexp.MustCompile(`(<svg\b[^>]*?)\s+xmlns="[^"]*"`)
|
|
for _, file := range files {
|
|
if path.Ext(file) != ".svg" {
|
|
continue
|
|
}
|
|
bs, err := public.AssetFS().ReadFile("assets/img/svg", file)
|
|
if err != nil {
|
|
log.Error("Failed to read SVG file %s: %v", file, err)
|
|
} else {
|
|
SVGs[file[:len(file)-4]] = reXmlns.ReplaceAllString(string(bs), "$1")
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// RenderHTML renders icons - arguments icon name (string), size (int), class (string)
|
|
func RenderHTML(icon string, others ...any) template.HTML {
|
|
size, class := html.ParseSizeAndClass(defaultSize, "", others...)
|
|
|
|
if svgStr, ok := SVGs[icon]; ok {
|
|
if size != defaultSize {
|
|
svgStr = widthRe.ReplaceAllString(svgStr, fmt.Sprintf(`width="%d"`, size))
|
|
svgStr = heightRe.ReplaceAllString(svgStr, fmt.Sprintf(`height="%d"`, size))
|
|
}
|
|
if class != "" {
|
|
svgStr = strings.Replace(svgStr, `class="`, fmt.Sprintf(`class="%s `, class), 1)
|
|
}
|
|
return template.HTML(svgStr)
|
|
}
|
|
return ""
|
|
}
|