Add icon cache, get icon theme from config

Author: anbraten

custom/conf/app.example.ini

@@ -1262,6 +1262,9 @@ LEVEL = Info
 ;; Leave it empty to allow users to select any theme from "{CustomPath}/public/assets/css/theme-*.css"
 ;THEMES =
 ;;
+;; Icon theme used by the file tree. Icons have to be place in data/icons/<iconpack>/. Default is "".
+;FILE_ICON_THEME =
+;;
 ;; All available reactions users can choose on issues/prs and comments.
 ;; Values can be emoji alias (:smile:) or a unicode emoji.
 ;; For custom reactions, add a tightly cropped square image to public/assets/img/emoji/reaction_name.png

modules/fileicon/icon.go renamed to modules/fileicon/fileicon.go

@@ -11,8 +11,19 @@ import (
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/svg"
+	lru "github.com/hashicorp/golang-lru/v2"
 )
 
+var fileIconCache *lru.Cache[string, string]
+
+func init() {
+	var err error
+	fileIconCache, err = lru.New[string, string](1000)
+	if err != nil {
+		log.Fatal("Failed to create file icon cache: %v", err)
+	}
+}
+
 func getBasicFileIconName(entry *git.TreeEntry) string {
 	switch {
 	case entry.IsLink():
@@ -35,49 +46,53 @@ func getBasicFileIconName(entry *git.TreeEntry) string {
 }
 
 func getFileIconNames(entry *git.TreeEntry) []string {
+	fileName := strings.ToLower(path.Base(entry.Name()))
+
 	if entry.IsDir() {
-		fileName := strings.ToLower(path.Base(entry.Name()))
-		return []string{fileName, "directory"}
+		return []string{"folder_" + fileName, "folder"}
 	}
 
 	if entry.IsRegular() {
-		fileName := strings.ToLower(path.Base(entry.Name()))
 		ext := strings.ToLower(strings.TrimPrefix(path.Ext(fileName), "."))
-		return []string{fileName, ext, "file"}
+		return []string{"file_" + fileName, "file_" + ext, "file"}
 	}
 
 	return nil
 }
 
 func loadCustomIcon(iconPath string) (string, error) {
+	log.Info("Loading custom icon from %s", iconPath)
+
+	if icon, ok := fileIconCache.Get(iconPath); ok {
+		return icon, nil
+	}
+
 	// Try to load the icon from the filesystem
 	if _, err := os.Stat(iconPath); err != nil {
 		return "", err
 	}
 
-	// Read the SVG file
 	iconData, err := os.ReadFile(iconPath)
 	if err != nil {
 		return "", err
 	}
 
+	fileIconCache.Add(iconPath, string(iconData))
+
 	return string(iconData), nil
 }
 
 // FileIcon returns a custom icon from a folder or the default octicon for displaying files/directories
 func FileIcon(ctx context.Context, entry *git.TreeEntry) template.HTML {
-	iconPack, ok := ctx.Value("icon-pack").(string) // TODO: allow user to select an icon pack from a list
-	iconPack = "demo"
-	ok = true
-
-	if ok && iconPack != "" {
+	iconTheme := setting.UI.FileIconTheme
+	if iconTheme != "" {
 		iconNames := getFileIconNames(entry)
 
 		// Try to load the custom icon
 		for _, iconName := range iconNames {
-			iconPath := path.Join(setting.AppDataPath, "icons", iconPack, iconName+".svg")
+			iconPath := path.Join(setting.AppDataPath, "icons", iconTheme, iconName+".svg")
 			if icon, err := loadCustomIcon(iconPath); err == nil {
-				return template.HTML(icon)
+				return svg.RenderHTMLFromString(icon)
 			}
 		}
 	}

modules/setting/ui.go

@@ -28,6 +28,7 @@ var UI = struct {
 	DefaultShowFullName     bool
 	DefaultTheme            string
 	Themes                  []string
+	FileIconTheme           string
 	Reactions               []string
 	ReactionsLookup         container.Set[string] `ini:"-"`
 	CustomEmojis            []string

modules/svg/svg.go

@@ -60,16 +60,26 @@ func MockIcon(icon string) func() {
 func RenderHTML(icon string, others ...any) template.HTML {
 	size, class := gitea_html.ParseSizeAndClass(defaultSize, "", others...)
 	if svgStr, ok := svgIcons[icon]; ok {
-		// the code is somewhat hacky, but it just works, because the SVG contents are all normalized
-		if size != defaultSize {
-			svgStr = strings.Replace(svgStr, fmt.Sprintf(`width="%d"`, defaultSize), fmt.Sprintf(`width="%d"`, size), 1)
-			svgStr = strings.Replace(svgStr, fmt.Sprintf(`height="%d"`, defaultSize), fmt.Sprintf(`height="%d"`, size), 1)
-		}
-		if class != "" {
-			svgStr = strings.Replace(svgStr, `class="`, fmt.Sprintf(`class="%s `, class), 1)
-		}
-		return template.HTML(svgStr)
+		return RenderHTMLFromString(svgStr, size, class)
 	}
+
 	// during test (or something wrong happens), there is no SVG loaded, so use a dummy span to tell that the icon is missing
 	return template.HTML(fmt.Sprintf("<span>%s(%d/%s)</span>", template.HTMLEscapeString(icon), size, template.HTMLEscapeString(class)))
 }
+
+// RenderHTMLFromString renders icons from a string - arguments SVG string (string), size (int), class (string)
+func RenderHTMLFromString(svgStr string, others ...any) template.HTML {
+	svgStr = string(Normalize([]byte(svgStr), defaultSize))
+
+	size, class := gitea_html.ParseSizeAndClass(defaultSize, "", others...)
+
+	// the code is somewhat hacky, but it just works, because the SVG contents are all normalized
+	if size != defaultSize {
+		svgStr = strings.Replace(svgStr, fmt.Sprintf(`width="%d"`, defaultSize), fmt.Sprintf(`width="%d"`, size), 1)
+		svgStr = strings.Replace(svgStr, fmt.Sprintf(`height="%d"`, defaultSize), fmt.Sprintf(`height="%d"`, size), 1)
+	}
+	if class != "" {
+		svgStr = strings.Replace(svgStr, `class="`, fmt.Sprintf(`class="%s `, class), 1)
+	}
+	return template.HTML(svgStr)
+}