Add StatDir and replace com.StatDir (#14099)

* Add StatDir and replace com.StatDir

* a nit

* Remove wrong file

Co-authored-by: 6543 <6543@obermui.de>

6 files changed, 88 insertions, 14 deletions

diff --git a/models/repo.go b/models/repo.go
index 3df850a3ba..d791b6cbd2 100644
--- a/models/repo.go
+++ b/models/repo.go
@@ -79,7 +79,7 @@ func loadRepoConfig() {
 			log.Fatal("Failed to get custom %s files: %v", t, err)
 		}
 		if isDir {
-			customFiles, err := com.StatDir(customPath)
+			customFiles, err := util.StatDir(customPath)
 			if err != nil {
 				log.Fatal("Failed to get custom %s files: %v", t, err)
 			}
diff --git a/modules/options/dynamic.go b/modules/options/dynamic.go
index 060ca12bb0..ffb89df882 100644
--- a/modules/options/dynamic.go
+++ b/modules/options/dynamic.go
@@ -14,8 +14,6 @@ import (
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
-
-	"github.com/unknwon/com"
 )
 
 var (
@@ -39,7 +37,7 @@ func Dir(name string) ([]string, error) {
 		return []string{}, fmt.Errorf("Unabe to check if custom directory %s is a directory. %v", customDir, err)
 	}
 	if isDir {
-		files, err := com.StatDir(customDir, true)
+		files, err := util.StatDir(customDir, true)
 
 		if err != nil {
 			return []string{}, fmt.Errorf("Failed to read custom directory. %v", err)
@@ -55,7 +53,7 @@ func Dir(name string) ([]string, error) {
 		return []string{}, fmt.Errorf("Unabe to check if static directory %s is a directory. %v", staticDir, err)
 	}
 	if isDir {
-		files, err := com.StatDir(staticDir, true)
+		files, err := util.StatDir(staticDir, true)
 
 		if err != nil {
 			return []string{}, fmt.Errorf("Failed to read static directory. %v", err)
diff --git a/modules/options/static.go b/modules/options/static.go
index ff1e6b2332..5f4ffdda78 100644
--- a/modules/options/static.go
+++ b/modules/options/static.go
@@ -14,8 +14,6 @@ import (
 	"code.gitea.io/gitea/modules/log"
 	"code.gitea.io/gitea/modules/setting"
 	"code.gitea.io/gitea/modules/util"
-
-	"github.com/unknwon/com"
 )
 
 var (
@@ -38,7 +36,7 @@ func Dir(name string) ([]string, error) {
 		return []string{}, fmt.Errorf("Failed to check if custom directory %s is a directory. %v", err)
 	}
 	if isDir {
-		files, err := com.StatDir(customDir, true)
+		files, err := util.StatDir(customDir, true)
 
 		if err != nil {
 			return []string{}, fmt.Errorf("Failed to read custom directory. %v", err)
diff --git a/modules/templates/dynamic.go b/modules/templates/dynamic.go
index 5eda948034..7f1a36e0b7 100644
--- a/modules/templates/dynamic.go
+++ b/modules/templates/dynamic.go
@@ -18,7 +18,6 @@ import (
 	"code.gitea.io/gitea/modules/util"
 
 	"gitea.com/macaron/macaron"
-	"github.com/unknwon/com"
 )
 
 var (
@@ -65,7 +64,7 @@ func Mailer() (*texttmpl.Template, *template.Template) {
 		log.Warn("Unable to check if templates dir %s is a directory. Error: %v", staticDir, err)
 	}
 	if isDir {
-		files, err := com.StatDir(staticDir)
+		files, err := util.StatDir(staticDir)
 
 		if err != nil {
 			log.Warn("Failed to read %s templates dir. %v", staticDir, err)
@@ -94,7 +93,7 @@ func Mailer() (*texttmpl.Template, *template.Template) {
 		log.Warn("Unable to check if templates dir %s is a directory. Error: %v", customDir, err)
 	}
 	if isDir {
-		files, err := com.StatDir(customDir)
+		files, err := util.StatDir(customDir)
 
 		if err != nil {
 			log.Warn("Failed to read %s templates dir. %v", customDir, err)
diff --git a/modules/templates/static.go b/modules/templates/static.go
index fd8e79a783..0c3d65ccf2 100644
--- a/modules/templates/static.go
+++ b/modules/templates/static.go
@@ -21,7 +21,6 @@ import (
 	"code.gitea.io/gitea/modules/util"
 
 	"gitea.com/macaron/macaron"
-	"github.com/unknwon/com"
 )
 
 var (
@@ -83,7 +82,7 @@ func NewTemplateFileSystem() templateFileSystem {
 		log.Warn("Unable to check if templates dir %s is a directory. Error: %v", customDir, err)
 	}
 	if isDir {
-		files, err := com.StatDir(customDir)
+		files, err := util.StatDir(customDir)
 
 		if err != nil {
 			log.Warn("Failed to read %s templates dir. %v", customDir, err)
@@ -179,7 +178,7 @@ func Mailer() (*texttmpl.Template, *template.Template) {
 		log.Warn("Failed to check if custom directory %s is a directory. %v", err)
 	}
 	if isDir {
-		files, err := com.StatDir(customDir)
+		files, err := util.StatDir(customDir)
 
 		if err != nil {
 			log.Warn("Failed to read %s templates dir. %v", customDir, err)
diff --git a/modules/util/path.go b/modules/util/path.go
index fbcefb83b6..aa3d009899 100644
--- a/modules/util/path.go
+++ b/modules/util/path.go
@@ -5,8 +5,11 @@
 package util
 
 import (
+	"errors"
 	"os"
+	"path"
 	"path/filepath"
+	"strings"
 )
 
 // EnsureAbsolutePath ensure that a path is absolute, making it
@@ -70,3 +73,80 @@ func IsExist(path string) (bool, error) {
 	}
 	return false, err
 }
+
+func statDir(dirPath, recPath string, includeDir, isDirOnly, followSymlinks bool) ([]string, error) {
+	dir, err := os.Open(dirPath)
+	if err != nil {
+		return nil, err
+	}
+	defer dir.Close()
+
+	fis, err := dir.Readdir(0)
+	if err != nil {
+		return nil, err
+	}
+
+	statList := make([]string, 0)
+	for _, fi := range fis {
+		if strings.Contains(fi.Name(), ".DS_Store") {
+			continue
+		}
+
+		relPath := path.Join(recPath, fi.Name())
+		curPath := path.Join(dirPath, fi.Name())
+		if fi.IsDir() {
+			if includeDir {
+				statList = append(statList, relPath+"/")
+			}
+			s, err := statDir(curPath, relPath, includeDir, isDirOnly, followSymlinks)
+			if err != nil {
+				return nil, err
+			}
+			statList = append(statList, s...)
+		} else if !isDirOnly {
+			statList = append(statList, relPath)
+		} else if followSymlinks && fi.Mode()&os.ModeSymlink != 0 {
+			link, err := os.Readlink(curPath)
+			if err != nil {
+				return nil, err
+			}
+
+			isDir, err := IsDir(link)
+			if err != nil {
+				return nil, err
+			}
+			if isDir {
+				if includeDir {
+					statList = append(statList, relPath+"/")
+				}
+				s, err := statDir(curPath, relPath, includeDir, isDirOnly, followSymlinks)
+				if err != nil {
+					return nil, err
+				}
+				statList = append(statList, s...)
+			}
+		}
+	}
+	return statList, nil
+}
+
+// StatDir gathers information of given directory by depth-first.
+// It returns slice of file list and includes subdirectories if enabled;
+// it returns error and nil slice when error occurs in underlying functions,
+// or given path is not a directory or does not exist.
+//
+// Slice does not include given path itself.
+// If subdirectories is enabled, they will have suffix '/'.
+func StatDir(rootPath string, includeDir ...bool) ([]string, error) {
+	if isDir, err := IsDir(rootPath); err != nil {
+		return nil, err
+	} else if !isDir {
+		return nil, errors.New("not a directory or does not exist: " + rootPath)
+	}
+
+	isIncludeDir := false
+	if len(includeDir) != 0 {
+		isIncludeDir = includeDir[0]
+	}
+	return statDir(rootPath, "", isIncludeDir, false, false)
+}