use SafeFilePathAbs instead of path.Join for local file accessing

Author: wxiaoguang

modules/options/base.go

@@ -7,36 +7,36 @@ import (
 	"fmt"
 	"io/fs"
 	"os"
-	"path"
 	"path/filepath"
 
+	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
 )
 
 // Locale reads the content of a specific locale from static/bindata or custom path.
 func Locale(name string) ([]byte, error) {
-	return fileFromDir(path.Join("locale", util.SafePathRel(name)))
+	return fileFromOptionsDir("locale", name)
 }
 
 // Readme reads the content of a specific readme from static/bindata or custom path.
 func Readme(name string) ([]byte, error) {
-	return fileFromDir(path.Join("readme", util.SafePathRel(name)))
+	return fileFromOptionsDir("readme", name)
 }
 
 // Gitignore reads the content of a gitignore locale from static/bindata or custom path.
 func Gitignore(name string) ([]byte, error) {
-	return fileFromDir(path.Join("gitignore", util.SafePathRel(name)))
+	return fileFromOptionsDir("gitignore", name)
 }
 
 // License reads the content of a specific license from static/bindata or custom path.
 func License(name string) ([]byte, error) {
-	return fileFromDir(path.Join("license", util.SafePathRel(name)))
+	return fileFromOptionsDir("license", name)
 }
 
 // Labels reads the content of a specific labels from static/bindata or custom path.
 func Labels(name string) ([]byte, error) {
-	return fileFromDir(path.Join("label", util.SafePathRel(name)))
+	return fileFromOptionsDir("label", name)
 }
 
 // WalkLocales reads the content of a specific locale
@@ -93,3 +93,21 @@ func statDirIfExist(dir string) ([]string, error) {
 	}
 	return files, nil
 }
+
+func readFileFromLocal(base []string, sub string, elems ...string) ([]byte, error) {
+	localPathElems := make([]string, len(elems)+2) // path[0] will be used for the custom path prefix
+	localPathElems[1] = sub
+	copy(localPathElems[2:], elems)
+
+	for _, dir := range base {
+		localPathElems[0] = dir
+		localPath := util.SafeFilePathAbs(localPathElems...)
+		isFile, err := util.IsFile(localPath)
+		if err != nil {
+			log.Error("Unable to check if %s is a file. Error: %v", localPath, err)
+		} else if isFile {
+			return os.ReadFile(localPath)
+		}
+	}
+	return nil, fmt.Errorf("asset file does not exist: %v", elems)
+}

modules/options/dynamic.go

@@ -6,11 +6,6 @@
 package options
 
 import (
-	"fmt"
-	"os"
-	"path"
-
-	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
 )
@@ -26,8 +21,8 @@ func Dir(name string) ([]string, error) {
 	var result []string
 
 	for _, dir := range []string{
-		path.Join(setting.CustomPath, "options", name),     // custom dir
-		path.Join(setting.StaticRootPath, "options", name), // static dir
+		util.SafeFilePathAbs(setting.CustomPath, "options", name),     // custom dir
+		util.SafeFilePathAbs(setting.StaticRootPath, "options", name), // static dir
 	} {
 		files, err := statDirIfExist(dir)
 		if err != nil {
@@ -39,29 +34,9 @@ func Dir(name string) ([]string, error) {
 	return directories.AddAndGet(name, result), nil
 }
 
-// fileFromDir is a helper to read files from static or custom path.
-func fileFromDir(name string) ([]byte, error) {
-	customPath := path.Join(setting.CustomPath, "options", name)
-
-	isFile, err := util.IsFile(customPath)
-	if err != nil {
-		log.Error("Unable to check if %s is a file. Error: %v", customPath, err)
-	}
-	if isFile {
-		return os.ReadFile(customPath)
-	}
-
-	staticPath := path.Join(setting.StaticRootPath, "options", name)
-
-	isFile, err = util.IsFile(staticPath)
-	if err != nil {
-		log.Error("Unable to check if %s is a file. Error: %v", staticPath, err)
-	}
-	if isFile {
-		return os.ReadFile(staticPath)
-	}
-
-	return []byte{}, fmt.Errorf("Asset file does not exist: %s", name)
+// fileFromOptionsDir is a helper to read files from static or custom path.
+func fileFromOptionsDir(elems ...string) ([]byte, error) {
+	return readFileFromLocal([]string{setting.CustomPath, setting.StaticRootPath}, "options", elems...)
 }
 
 // IsDynamic will return false when using embedded data (-tags bindata)

modules/options/static.go

@@ -8,17 +8,13 @@ package options
 import (
 	"fmt"
 	"io"
-	"os"
-	"path"
 
-	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
-	"code.gitea.io/gitea/modules/util"
 )
 
 var directories = make(directorySet)
 
-// Dir returns all files from bindata or custom directory.
+// Dir returns all files from custom directory or bindata.
 func Dir(name string) ([]string, error) {
 	if directories.Filled(name) {
 		return directories.Get(name), nil
@@ -27,7 +23,7 @@ func Dir(name string) ([]string, error) {
 	var result []string
 
 	for _, dir := range []string{
-		path.Join(setting.CustomPath, "options", name), // custom dir
+		filepath.Join(setting.CustomPath, "options", name), // custom dir
 		// no static dir
 	} {
 		files, err := statDirIfExist(dir)
@@ -64,24 +60,17 @@ func AssetDir(dirName string) ([]string, error) {
 	return results, nil
 }
 
-// fileFromDir is a helper to read files from bindata or custom path.
-func fileFromDir(name string) ([]byte, error) {
-	customPath := path.Join(setting.CustomPath, "options", name)
-
-	isFile, err := util.IsFile(customPath)
-	if err != nil {
-		log.Error("Unable to check if %s is a file. Error: %v", customPath, err)
-	}
-	if isFile {
-		return os.ReadFile(customPath)
+// fileFromOptionsDir is a helper to read files from custom path or bindata.
+func fileFromOptionsDir(elems ...string) ([]byte, error) {
+	if data, err := readFileFromLocal([]string{setting.CustomPath}, "options", elems...); err == nil {
+		return data, nil
 	}
 
 	f, err := Assets.Open(name)
 	if err != nil {
 		return nil, err
 	}
 	defer f.Close()
-
 	return io.ReadAll(f)
 }