mirror of
				https://gitee.com/gitea/gitea
				synced 2025-11-04 08:30:25 +08:00 
			
		
		
		
	Use a general approach to access custom/static/builtin assets (#24022)
The idea is to use a Layered Asset File-system (modules/assetfs/layered.go) For example: when there are 2 layers: "custom", "builtin", when access to asset "my/page.tmpl", the Layered Asset File-system will first try to use "custom" assets, if not found, then use "builtin" assets. This approach will hugely simplify a lot of code, make them testable. Other changes: * Simplify the AssetsHandlerFunc code * Simplify the `gitea embedded` sub-command code --------- Co-authored-by: Jason Song <i@wolfogre.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
This commit is contained in:
		@@ -1,30 +0,0 @@
 | 
			
		||||
// Copyright 2020 The Gitea Authors. All rights reserved.
 | 
			
		||||
// SPDX-License-Identifier: MIT
 | 
			
		||||
 | 
			
		||||
//go:build bindata
 | 
			
		||||
 | 
			
		||||
package svg
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"path/filepath"
 | 
			
		||||
 | 
			
		||||
	"code.gitea.io/gitea/modules/public"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Discover returns a map of discovered SVG icons in bindata
 | 
			
		||||
func Discover() map[string]string {
 | 
			
		||||
	svgs := make(map[string]string)
 | 
			
		||||
 | 
			
		||||
	for _, file := range public.AssetNames() {
 | 
			
		||||
		matched, _ := filepath.Match("img/svg/*.svg", file)
 | 
			
		||||
		if matched {
 | 
			
		||||
			content, err := public.Asset(file)
 | 
			
		||||
			if err == nil {
 | 
			
		||||
				filename := filepath.Base(file)
 | 
			
		||||
				svgs[filename[:len(filename)-4]] = string(content)
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return svgs
 | 
			
		||||
}
 | 
			
		||||
@@ -1,29 +0,0 @@
 | 
			
		||||
// Copyright 2020 The Gitea Authors. All rights reserved.
 | 
			
		||||
// SPDX-License-Identifier: MIT
 | 
			
		||||
 | 
			
		||||
//go:build !bindata
 | 
			
		||||
 | 
			
		||||
package svg
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"os"
 | 
			
		||||
	"path/filepath"
 | 
			
		||||
 | 
			
		||||
	"code.gitea.io/gitea/modules/setting"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
// Discover returns a map of discovered SVG icons in the file system
 | 
			
		||||
func Discover() map[string]string {
 | 
			
		||||
	svgs := make(map[string]string)
 | 
			
		||||
 | 
			
		||||
	files, _ := filepath.Glob(filepath.Join(setting.StaticRootPath, "public", "img", "svg", "*.svg"))
 | 
			
		||||
	for _, file := range files {
 | 
			
		||||
		content, err := os.ReadFile(file)
 | 
			
		||||
		if err == nil {
 | 
			
		||||
			filename := filepath.Base(file)
 | 
			
		||||
			svgs[filename[:len(filename)-4]] = string(content)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	return svgs
 | 
			
		||||
}
 | 
			
		||||
@@ -6,15 +6,18 @@ 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
 | 
			
		||||
	SVGs = map[string]string{}
 | 
			
		||||
 | 
			
		||||
	widthRe  = regexp.MustCompile(`width="[0-9]+?"`)
 | 
			
		||||
	heightRe = regexp.MustCompile(`height="[0-9]+?"`)
 | 
			
		||||
@@ -23,17 +26,29 @@ var (
 | 
			
		||||
const defaultSize = 16
 | 
			
		||||
 | 
			
		||||
// Init discovers SVGs and populates the `SVGs` variable
 | 
			
		||||
func Init() {
 | 
			
		||||
	SVGs = Discover()
 | 
			
		||||
func Init() error {
 | 
			
		||||
	files, err := public.AssetFS().ListFiles("img/svg")
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return err
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	// Remove `xmlns` because inline SVG does not need it
 | 
			
		||||
	r := regexp.MustCompile(`(<svg\b[^>]*?)\s+xmlns="[^"]*"`)
 | 
			
		||||
	for name, svg := range SVGs {
 | 
			
		||||
		SVGs[name] = r.ReplaceAllString(svg, "$1")
 | 
			
		||||
	reXmlns := regexp.MustCompile(`(<svg\b[^>]*?)\s+xmlns="[^"]*"`)
 | 
			
		||||
	for _, file := range files {
 | 
			
		||||
		if path.Ext(file) != ".svg" {
 | 
			
		||||
			continue
 | 
			
		||||
		}
 | 
			
		||||
		bs, err := public.AssetFS().ReadFile("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
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Render render icons - arguments icon name (string), size (int), class (string)
 | 
			
		||||
// RenderHTML renders icons - arguments icon name (string), size (int), class (string)
 | 
			
		||||
func RenderHTML(icon string, others ...interface{}) template.HTML {
 | 
			
		||||
	size, class := html.ParseSizeAndClass(defaultSize, "", others...)
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user