feat: support selfh.st icons, support homepage config overriding

internal/list-icons.go

@@ -4,10 +4,13 @@ import (
 	"encoding/json"
 	"io"
 	"net/http"
+	"os"
 	"sync"
 	"time"
 
+	"github.com/yusing/go-proxy/internal/common"
 	"github.com/yusing/go-proxy/internal/logging"
+	"github.com/yusing/go-proxy/internal/utils"
 )
 
 type GitHubContents struct { //! keep this, may reuse in future
@@ -18,53 +21,136 @@ type GitHubContents struct { //! keep this, may reuse in future
 	Size int    `json:"size"`
 }
 
-type Icons map[string]map[string]struct{}
+type (
+	IconsMap map[string]map[string]struct{}
+	Cache    struct {
+		WalkxCode, Selfhst IconsMap
+		DisplayNames       ReferenceDisplayNameMap
+	}
+	ReferenceDisplayNameMap map[string]string
+)
 
-// no longer cache for `godoxy ls-icons`
+func (icons *Cache) isEmpty() bool {
+	return len(icons.WalkxCode) == 0 && len(icons.Selfhst) == 0
+}
+
+func (icons *Cache) MarshalJSON() ([]byte, error) {
+	return json.Marshal(map[string]any{
+		"walkxcode": icons.WalkxCode,
+		"selfhst":   icons.Selfhst,
+	})
+}
 
 const updateInterval = 1 * time.Hour
 
 var (
-	iconsCache   = make(Icons)
+	iconsCache   *Cache
 	iconsCahceMu sync.Mutex
 	lastUpdate   time.Time
 )
 
-const walkxcodeIcons = "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/tree.json"
+const (
+	walkxcodeIcons = "https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons@master/tree.json"
+	selfhstIcons   = "https://cdn.selfh.st/directory/icons.json"
+)
 
-func ListAvailableIcons() (Icons, error) {
+func InitIconListCache() {
+	iconsCache = &Cache{
+		WalkxCode:    make(IconsMap),
+		Selfhst:      make(IconsMap),
+		DisplayNames: make(ReferenceDisplayNameMap),
+	}
+	err := utils.LoadJSON(common.IconListCachePath, iconsCache)
+	if err != nil && !os.IsNotExist(err) {
+		logging.Fatal().Err(err).Msg("failed to load icon list cache config")
+	} else if err == nil {
+		if stats, err := os.Stat(common.IconListCachePath); err != nil {
+			logging.Fatal().Err(err).Msg("failed to load icon list cache config")
+		} else {
+			lastUpdate = stats.ModTime()
+		}
+	}
+}
+
+func ListAvailableIcons() (*Cache, error) {
 	iconsCahceMu.Lock()
 	defer iconsCahceMu.Unlock()
 
 	if time.Since(lastUpdate) < updateInterval {
-		if len(iconsCache) > 0 {
+		if !iconsCache.isEmpty() {
 			return iconsCache, nil
 		}
 	}
 
-	icons, err := getIcons()
+	icons, err := fetchIconData()
 	if err != nil {
 		return nil, err
 	}
 
 	iconsCache = icons
 	lastUpdate = time.Now()
+
+	err = utils.SaveJSON(common.IconListCachePath, iconsCache, 0o644)
+	if err != nil {
+		logging.Warn().Err(err).Msg("failed to save icon list cache")
+	}
 	return icons, nil
 }
 
-func HasIcon(name string, filetype string) bool {
+func HasWalkxCodeIcon(name string, filetype string) bool {
 	icons, err := ListAvailableIcons()
 	if err != nil {
 		logging.Error().Err(err).Msg("failed to list icons")
 		return false
 	}
-	if _, ok := icons[filetype]; !ok {
+	if _, ok := icons.WalkxCode[filetype]; !ok {
 		return false
 	}
-	_, ok := icons[filetype][name+"."+filetype]
+	_, ok := icons.WalkxCode[filetype][name+"."+filetype]
 	return ok
 }
 
+func HasSelfhstIcon(name string, filetype string) bool {
+	icons, err := ListAvailableIcons()
+	if err != nil {
+		logging.Error().Err(err).Msg("failed to list icons")
+		return false
+	}
+	if _, ok := icons.Selfhst[filetype]; !ok {
+		return false
+	}
+	_, ok := icons.Selfhst[filetype][name+"."+filetype]
+	return ok
+}
+
+func GetDisplayName(reference string) (string, bool) {
+	icons, err := ListAvailableIcons()
+	if err != nil {
+		logging.Error().Err(err).Msg("failed to list icons")
+		return "", false
+	}
+	displayName, ok := icons.DisplayNames[reference]
+	return displayName, ok
+}
+
+func fetchIconData() (*Cache, error) {
+	walkxCodeIcons, err := fetchWalkxCodeIcons()
+	if err != nil {
+		return nil, err
+	}
+
+	selfhstIcons, referenceToNames, err := fetchSelfhstIcons()
+	if err != nil {
+		return nil, err
+	}
+
+	return &Cache{
+		WalkxCode:    walkxCodeIcons,
+		Selfhst:      selfhstIcons,
+		DisplayNames: referenceToNames,
+	}, nil
+}
+
 /*
 format:
 
@@ -74,10 +160,13 @@ format:
 		],
 		"svg": [
 			"*.svg",
+		],
+		"webp": [
+			"*.webp",
 		]
 	}
 */
-func getIcons() (Icons, error) {
+func fetchWalkxCodeIcons() (IconsMap, error) {
 	req, err := http.NewRequest(http.MethodGet, walkxcodeIcons, nil)
 	if err != nil {
 		return nil, err
@@ -98,7 +187,7 @@ func getIcons() (Icons, error) {
 	if err != nil {
 		return nil, err
 	}
-	icons := make(Icons, len(data))
+	icons := make(IconsMap, len(data))
 	for fileType, files := range data {
 		icons[fileType] = make(map[string]struct{}, len(files))
 		for _, icon := range files {
@@ -107,3 +196,73 @@ func getIcons() (Icons, error) {
 	}
 	return icons, nil
 }
+
+/*
+format:
+
+	{
+			"Name": "2FAuth",
+			"Reference": "2fauth",
+			"SVG": "Yes",
+			"PNG": "Yes",
+			"WebP": "Yes",
+			"Light": "Yes",
+			"Category": "Self-Hosted",
+			"CreatedAt": "2024-08-16 00:27:23+00:00"
+	}
+*/
+func fetchSelfhstIcons() (IconsMap, ReferenceDisplayNameMap, error) {
+	type SelfhStIcon struct {
+		Name      string `json:"Name"`
+		Reference string `json:"Reference"`
+		SVG       string `json:"SVG"`
+		PNG       string `json:"PNG"`
+		WebP      string `json:"WebP"`
+		// Light          string
+		// Category       string
+		// CreatedAt      string
+	}
+
+	req, err := http.NewRequest(http.MethodGet, selfhstIcons, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+	resp, err := http.DefaultClient.Do(req)
+	if err != nil {
+		return nil, nil, err
+	}
+	defer resp.Body.Close()
+
+	body, err := io.ReadAll(resp.Body)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	data := make([]SelfhStIcon, 0, 2000)
+	err = json.Unmarshal(body, &data)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	icons := make(IconsMap)
+	icons["svg"] = make(map[string]struct{}, len(data))
+	icons["png"] = make(map[string]struct{}, len(data))
+	icons["webp"] = make(map[string]struct{}, len(data))
+
+	referenceToNames := make(ReferenceDisplayNameMap, len(data))
+
+	for _, item := range data {
+		if item.SVG == "Yes" {
+			icons["svg"][item.Reference+".svg"] = struct{}{}
+		}
+		if item.PNG == "Yes" {
+			icons["png"][item.Reference+".png"] = struct{}{}
+		}
+		if item.WebP == "Yes" {
+			icons["webp"][item.Reference+".webp"] = struct{}{}
+		}
+		referenceToNames[item.Reference] = item.Name
+	}
+
+	return icons, referenceToNames, nil
+}