Merge branch 'metafex-symlink-walk' into develop

jeevatkm · jeevatkm · commit ff67cb975265 · 2016-05-27T23:00:18.000-07:00
diff --git a/i18n.go b/i18n.go
@@ -104,19 +104,18 @@ func getUnknownValueFormat() string {
 func loadMessages(path string) {
 	messages = make(map[string]*config.Config)
 
-	// Read in messages from the modules
-	// Load the module messges first,
+	// Read in messages from the modules. Load the module messges first,
 	// so that it can be override in parent application
 	for _, module := range Modules {
 		TRACE.Println("Importing messages from ", filepath.Join(module.Path, messageFilesDirectory))
-		if err := filepath.Walk(filepath.Join(module.Path, messageFilesDirectory), loadMessageFile); err != nil &&
+		if err := Walk(filepath.Join(module.Path, messageFilesDirectory), loadMessageFile); err != nil &&
 			!os.IsNotExist(err) {
 			ERROR.Println("Error reading messages files from module:", err)
 		}
 	}
 
-	if error := filepath.Walk(path, loadMessageFile); error != nil && !os.IsNotExist(error) {
-		ERROR.Println("Error reading messages files:", error)
+	if err := Walk(path, loadMessageFile); err != nil && !os.IsNotExist(err) {
+		ERROR.Println("Error reading messages files:", err)
 	}
 }
 
diff --git a/template.go b/template.go
@@ -231,33 +231,6 @@ func (loader *TemplateLoader) Refresh() *Error {
 				return nil
 			}
 
-			// is it a symlinked template?
-			link, err := os.Lstat(path)
-			if err == nil && link.Mode()&os.ModeSymlink == os.ModeSymlink {
-				TRACE.Println("symlink template:", path)
-				// lookup the actual target & check for goodness
-				targetPath, err := filepath.EvalSymlinks(path)
-				if err != nil {
-					ERROR.Println("Failed to read symlink", err)
-					return err
-				}
-				targetInfo, err := os.Stat(targetPath)
-				if err != nil {
-					ERROR.Println("Failed to stat symlink target", err)
-					return err
-				}
-
-				// set the template path to the target of the symlink
-				path = targetPath
-				info = targetInfo
-
-				// need to save state and restore for recursive call to Walk on symlink
-				tmp := fullSrcDir
-				fullSrcDir = filepath.Dir(targetPath)
-				filepath.Walk(targetPath, templateWalker)
-				fullSrcDir = tmp
-			}
-
 			// Walk into watchable directories
 			if info.IsDir() {
 				if !loader.WatchDir(info) {
@@ -361,13 +334,13 @@ func (loader *TemplateLoader) Refresh() *Error {
 			return nil
 		}
 
-		if _, err = os.Stat(fullSrcDir); os.IsNotExist(err) {
+		if _, err = os.Lstat(fullSrcDir); os.IsNotExist(err) {
 			// #1058 Given views/template path is not exists
 			// so no need to walk, move on to next path
 			continue
 		}
 
-		funcErr := filepath.Walk(fullSrcDir, templateWalker)
+		funcErr := Walk(fullSrcDir, templateWalker)
 
 		// If there was an error with the Funcs, set it and return immediately.
 		if funcErr != nil {
diff --git a/util.go b/util.go
@@ -9,6 +9,7 @@ import (
 	"net/http"
 	"net/url"
 	"os"
+	"path/filepath"
 	"reflect"
 	"regexp"
 	"strings"
@@ -208,6 +209,12 @@ func ClientIP(r *http.Request) string {
 	return ""
 }
 
+// Walk method extends filepath.Walk to also follow symlinks.
+// Always returns the path of the file or directory.
+func Walk(root string, walkFn filepath.WalkFunc) error {
+	return fsWalk(root, root, root, walkFn)
+}
+
 // createDir method creates nested directories if not exists
 func createDir(path string) error {
 	if _, err := os.Stat(path); err != nil {
@@ -222,6 +229,44 @@ func createDir(path string) error {
 	return nil
 }
 
+func fsWalk(path string, dirName string, linkDirName string, walkFn filepath.WalkFunc) error {
+	fsWalkFunc := func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+
+		var name string
+		name, err = filepath.Rel(dirName, path)
+		if err != nil {
+			return err
+		}
+
+		path = filepath.Join(linkDirName, name)
+
+		if err == nil && info.Mode()&os.ModeSymlink == os.ModeSymlink {
+			var symlinkPath string
+			symlinkPath, err = filepath.EvalSymlinks(path)
+			if err != nil {
+				return err
+			}
+
+			// https://github.com/golang/go/blob/master/src/path/filepath/path.go#L392
+			info, err = os.Lstat(symlinkPath)
+			if err != nil {
+				return walkFn(path, info, err)
+			}
+
+			if info.IsDir() {
+				return fsWalk(symlinkPath, symlinkPath, path, walkFn)
+			}
+		}
+
+		return walkFn(path, info, err)
+	}
+
+	return filepath.Walk(path, fsWalkFunc)
+}
+
 func init() {
 	OnAppStart(LoadMimeConfig)
 }
diff --git a/watcher.go b/watcher.go
@@ -1,12 +1,13 @@
 package revel
 
 import (
-	"gopkg.in/fsnotify.v1"
 	"os"
 	"path"
 	"path/filepath"
 	"strings"
 	"sync"
+
+	"gopkg.in/fsnotify.v1"
 )
 
 // Listener is an interface for receivers of filesystem events.
@@ -90,28 +91,6 @@ func (w *Watcher) Listen(listener Listener, roots ...string) {
 				return nil
 			}
 
-			// is it a symlinked template?
-			link, err := os.Lstat(path)
-			if err == nil && link.Mode()&os.ModeSymlink == os.ModeSymlink {
-				TRACE.Println("Watcher symlink: ", path)
-				// lookup the actual target & check for goodness
-				targetPath, err := filepath.EvalSymlinks(path)
-				if err != nil {
-					ERROR.Println("Failed to read symlink", err)
-					return err
-				}
-				targetInfo, err := os.Stat(targetPath)
-				if err != nil {
-					ERROR.Println("Failed to stat symlink target", err)
-					return err
-				}
-
-				// set the template path to the target of the symlink
-				path = targetPath
-				info = targetInfo
-				filepath.Walk(path, watcherWalker)
-			}
-
 			if info.IsDir() {
 				if dl, ok := listener.(DiscerningListener); ok {
 					if !dl.WatchDir(info) {
@@ -128,7 +107,10 @@ func (w *Watcher) Listen(listener Listener, roots ...string) {
 		}
 
 		// Else, walk the directory tree.
-		filepath.Walk(p, watcherWalker)
+		err = Walk(p, watcherWalker)
+		if err != nil {
+			ERROR.Println("Failed to walk directory", p, ":", err)
+		}
 	}
 
 	if w.eagerRebuildEnabled() {

Original file line number	Diff line number	Diff line change
`@@ -104,19 +104,18 @@ func getUnknownValueFormat() string {`
`104`	`104`	`func loadMessages(path string) {`
`105`	`105`	`messages = make(map[string]*config.Config)`
`106`	`106`
`107`		`- // Read in messages from the modules`
`108`		`- // Load the module messges first,`
	`107`	`+ // Read in messages from the modules. Load the module messges first,`
`109`	`108`	`// so that it can be override in parent application`
`110`	`109`	`for _, module := range Modules {`
`111`	`110`	`TRACE.Println("Importing messages from ", filepath.Join(module.Path, messageFilesDirectory))`
`112`		`- if err := filepath.Walk(filepath.Join(module.Path, messageFilesDirectory), loadMessageFile); err != nil &&`
	`111`	`+ if err := Walk(filepath.Join(module.Path, messageFilesDirectory), loadMessageFile); err != nil &&`
`113`	`112`	`!os.IsNotExist(err) {`
`114`	`113`	`ERROR.Println("Error reading messages files from module:", err)`
`115`	`114`	`}`
`116`	`115`	`}`
`117`	`116`
`118`		`- if error := filepath.Walk(path, loadMessageFile); error != nil && !os.IsNotExist(error) {`
`119`		`- ERROR.Println("Error reading messages files:", error)`
	`117`	`+ if err := Walk(path, loadMessageFile); err != nil && !os.IsNotExist(err) {`
	`118`	`+ ERROR.Println("Error reading messages files:", err)`
`120`	`119`	`}`
`121`	`120`	`}`
`122`	`121`