Bumps version number for patch; Adds comments to static module

brendensoares · brendensoares · commit a6fc660c7ed1 · 2015-01-04T00:04:45.000-08:00
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 A high productivity, full-stack web framework for the [Go language](http://www.golang.org).
 
-Current Version: 0.11.2 (Nov 23, 2014)
+Current Version: 0.11.3 (Jan 3, 2015)
 
 **As of Revel 0.11.0, Go 1.3+ is required.**
 
diff --git a/modules/static/app/controllers/static.go b/modules/static/app/controllers/static.go
@@ -51,6 +51,31 @@ func (c Static) Serve(prefix, filepath string) revel.Result {
 
 	return serve(c, prefix, filepath)
 }
+
+// This method allows modules to serve binary files. The parameters are the same
+// as Static.Serve with the additional module name pre-pended to the list of
+// arguments.
+func (c Static) ServeModule(moduleName, prefix, filepath string) revel.Result {
+	// Fix for #503.
+	prefix = c.Params.Fixed.Get("prefix")
+	if prefix == "" {
+		return c.NotFound("")
+	}
+
+	var basePath string
+	for _, module := range revel.Modules {
+		if module.Name == moduleName {
+			basePath = module.Path
+		}
+	}
+
+	absPath := fpath.Join(basePath, fpath.FromSlash(prefix))
+
+	return serve(c, absPath, filepath)
+}
+
+
+// This method allows static serving of application files in a verified manner.
 func serve(c Static, prefix, filepath string) revel.Result {
 	var basePath string
 	if !fpath.IsAbs(prefix) {
@@ -59,11 +84,13 @@ func serve(c Static, prefix, filepath string) revel.Result {
 
 	basePathPrefix := fpath.Join(basePath, fpath.FromSlash(prefix))
 	fname := fpath.Join(basePathPrefix, fpath.FromSlash(filepath))
+	// Verify the request file path is within the application's scope of access
 	if !strings.HasPrefix(fname, basePathPrefix) {
 		revel.WARN.Printf("Attempted to read file outside of base path: %s", fname)
 		return c.NotFound("")
 	}
 
+	// Verify file path is accessible
 	finfo, err := os.Stat(fname)
 	if err != nil {
 		if os.IsNotExist(err) || err.(*os.PathError).Err == syscall.ENOTDIR {
@@ -74,11 +101,13 @@ func serve(c Static, prefix, filepath string) revel.Result {
 		return c.RenderError(err)
 	}
 
+	// Disallow directory listing
 	if finfo.Mode().IsDir() {
 		revel.WARN.Printf("Attempted directory listing of %s", fname)
 		return c.Forbidden("Directory listing not allowed")
 	}
 
+	// Open request file path
 	file, err := os.Open(fname)
 	if err != nil {
 		if os.IsNotExist(err) {
@@ -90,25 +119,3 @@ func serve(c Static, prefix, filepath string) revel.Result {
 	}
 	return c.RenderFile(file, revel.Inline)
 }
-
-// This method allows modules to serve binary files. The parameters are the same
-// as Static.Serve with the additional module name pre-pended to the list of
-// arguments.
-func (c Static) ServeModule(moduleName, prefix, filepath string) revel.Result {
-	// Fix for #503.
-	prefix = c.Params.Fixed.Get("prefix")
-	if prefix == "" {
-		return c.NotFound("")
-	}
-
-	var basePath string
-	for _, module := range revel.Modules {
-		if module.Name == moduleName {
-			basePath = module.Path
-		}
-	}
-
-	absPath := fpath.Join(basePath, fpath.FromSlash(prefix))
-
-	return serve(c, absPath, filepath)
-}
