Ensure that legacy formats within customPath still override builtins

Signed-off-by: Andrew Thornton <[email protected]>

Author: zeripath

modules/label/parser.go

@@ -37,21 +37,16 @@ func (err ErrTemplateLoad) Error() string {
 // then parses and returns a list of name-color pairs and optionally description.
 func GetTemplateFile(name string) ([]*Label, error) {
 	// Always check if <name>.yaml or <name>.yml exists and prefer those
-	data, err := options.Labels(name + ".yaml")
-	if err == nil && len(data) > 0 {
-		return parseYamlFormat(name+".yaml", data)
+	data, extension, err := options.Labels(name, ".yaml", ".yml", "")
+	if err != nil {
+		return nil, ErrTemplateLoad{name, fmt.Errorf("GetRepoInitFile: %w", err)}
 	}
 
-	data, err = options.Labels(name + ".yml")
-	if err == nil && len(data) > 0 {
+	// because we only handle .yaml/.yml we can simply test if the extension is not empty
+	if len(extension) > 0 && len(data) > 0 {
 		return parseYamlFormat(name+".yml", data)
 	}
 
-	data, err = options.Labels(name)
-	if err != nil {
-		return nil, ErrTemplateLoad{name, fmt.Errorf("GetRepoInitFile: %w", err)}
-	}
-
 	return parseLegacyFormat(name, data)
 }
 

modules/options/base.go

@@ -37,8 +37,8 @@ func License(name string) ([]byte, error) {
 }
 
 // Labels reads the content of a specific labels from static/bindata or custom path.
-func Labels(name string) ([]byte, error) {
-	return fileFromOptionsDir("label", name)
+func Labels(name string, exts ...string) ([]byte, string, error) {
+	return fileFromOptionsDirExtensions([]string{"label", name}, exts...)
 }
 
 // WalkLocales reads the content of a specific locale
@@ -132,3 +132,20 @@ func readLocalFile(baseDirs []string, subDir string, elems ...string) ([]byte, e
 	}
 	return nil, os.ErrNotExist
 }
+
+func readLocalFileExtensions(baseDirs []string, subDir string, elems []string, extensions ...string) ([]byte, string, error) {
+	if len(extensions) == 0 {
+		extensions = append(extensions, "")
+	}
+	for _, localPath := range joinLocalPaths(baseDirs, subDir, elems...) {
+		for _, extension := range extensions {
+			data, err := os.ReadFile(localPath + extension)
+			if err == nil {
+				return data, extension, nil
+			} else if !os.IsNotExist(err) {
+				log.Error("Unable to read file %q. Error: %v", localPath, err)
+			}
+		}
+	}
+	return nil, "", os.ErrNotExist
+}

modules/options/dynamic.go

@@ -28,6 +28,11 @@ func fileFromOptionsDir(elems ...string) ([]byte, error) {
 	return readLocalFile([]string{setting.CustomPath, setting.StaticRootPath}, "options", elems...)
 }
 
+// fileFromOptionsDirExtensions is a helper to read files from custom or static path.
+func fileFromOptionsDirExtensions(elems []string, extensions ...string) ([]byte, string, error) {
+	return readLocalFileExtensions([]string{setting.CustomPath, setting.StaticRootPath}, "options", elems, extensions...)
+}
+
 // IsDynamic will return false when using embedded data (-tags bindata)
 func IsDynamic() bool {
 	return true

modules/options/static.go

@@ -8,6 +8,7 @@ package options
 import (
 	"fmt"
 	"io"
+	"os"
 
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
@@ -66,6 +67,30 @@ func fileFromOptionsDir(elems ...string) ([]byte, error) {
 	return io.ReadAll(f)
 }
 
+// fileFromOptionsDir is a helper to read files from custom path or bindata.
+func fileFromOptionsDirExtensions(elem string, extensions ...string) ([]byte, error) {
+	// only try custom dir, no static dir
+	if data, err := readLocalFileExtensions([]string{setting.CustomPath}, "options", elem, extensions...); err == nil {
+		return data, nil
+	}
+
+	if len(extensions) == 0 {
+		extensions = append(extensions, "")
+	}
+
+	for _, extension := range extensions {
+		f, err := Assets.Open(util.PathJoinRelX(elems...))
+		if err != nil {
+			if os.IsNotExist(err) {
+				continue
+			}
+			return nil, err
+		}
+		defer f.Close()
+		return io.ReadAll(f)
+	}
+}
+
 func Asset(name string) ([]byte, error) {
 	f, err := Assets.Open("/" + name)
 	if err != nil {