Started browse middleware to list directory contents

config/middleware.go

@@ -2,6 +2,7 @@ package config
 
 import (
 	"github.com/mholt/caddy/middleware"
+	"github.com/mholt/caddy/middleware/browse"
 	"github.com/mholt/caddy/middleware/extensionless"
 	"github.com/mholt/caddy/middleware/fastcgi"
 	"github.com/mholt/caddy/middleware/gzip"
@@ -29,6 +30,7 @@ func init() {
 	register("fastcgi", fastcgi.New)
 	register("websocket", websockets.New)
 	register("markdown", markdown.New)
+	register("browse", browse.New)
 }
 
 // registry stores the registered middleware:

middleware/browse/browse.go

+// Package browse provides middleware for listing files in a directory
+// when directory path is requested instead of a specific file.
+package browse
+
+import (
+	"fmt"
+	"html/template"
+	"io/ioutil"
+	"net/http"
+	"net/url"
+	"os"
+	"path"
+	"strings"
+	"time"
+
+	"github.com/mholt/caddy/middleware"
+)
+
+// Browse is an http.Handler that can show a file listing when
+// directories in the given paths are specified.
+type Browse struct {
+	Next    http.HandlerFunc
+	Root    string
+	Configs []BrowseConfig
+}
+
+// BrowseConfig is a configuration for browsing in a particular path.
+type BrowseConfig struct {
+	PathScope string
+	Template  *template.Template
+}
+
+// A Listing is used to fill out a template.
+type Listing struct {
+	// The name of the directory (the last element of the path)
+	Name string
+
+	// The full path of the request
+	Path string
+
+	// Whether the parent directory is browsable
+	CanGoUp bool
+
+	// The items (files and folders) in the path
+	Items []FileInfo
+}
+
+// FileInfo is the info about a particular file or directory
+type FileInfo struct {
+	IsDir   bool
+	Name    string
+	Size    int64
+	URL     string
+	ModTime time.Time
+	Mode    os.FileMode
+}
+
+// New creates a new instance of browse middleware.
+func New(c middleware.Controller) (middleware.Middleware, error) {
+	configs, err := parse(c)
+	if err != nil {
+		return nil, err
+	}
+
+	browse := Browse{
+		Root:    c.Root(),
+		Configs: configs,
+	}
+
+	return func(next http.HandlerFunc) http.HandlerFunc {
+		browse.Next = next
+		return browse.ServeHTTP
+	}, nil
+}
+
+// ServeHTTP implements the http.Handler interface.
+func (b Browse) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	filename := b.Root + r.URL.Path
+
+	info, err := os.Stat(filename)
+	if err != nil {
+		// TODO: 404 Not Found
+		b.Next(w, r)
+		return
+	}
+
+	if !info.IsDir() {
+		b.Next(w, r)
+		return
+	}
+
+	for _, bc := range b.Configs {
+		if !middleware.Path(r.URL.Path).Matches(bc.PathScope) {
+			continue
+		}
+
+		file, err := os.Open(b.Root + r.URL.Path)
+		if err != nil {
+			panic(err) // TODO
+		}
+		defer file.Close()
+
+		w.Header().Set("Content-Type", "text/html; charset=utf-8")
+
+		files, err := file.Readdir(-1)
+		if err != nil || len(files) == 0 {
+			// TODO - second condition may not be necessary? See docs...
+		}
+
+		// Assemble listing of directory contents
+		var fileinfos []FileInfo
+		for _, f := range files {
+			name := f.Name()
+			if f.IsDir() {
+				name += "/"
+			}
+			url := url.URL{Path: name}
+
+			fileinfos = append(fileinfos, FileInfo{
+				IsDir:   f.IsDir(),
+				Name:    f.Name(),
+				Size:    f.Size(),
+				URL:     url.String(),
+				ModTime: f.ModTime(),
+				Mode:    f.Mode(),
+			})
+		}
+
+		// Determine if user can browse up another folder
+		var canGoUp bool
+		curPath := strings.TrimSuffix(r.URL.Path, "/")
+		for _, other := range b.Configs {
+			if strings.HasPrefix(path.Dir(curPath), other.PathScope) {
+				canGoUp = true
+				break
+			}
+		}
+
+		listing := Listing{
+			Name:    path.Base(r.URL.Path),
+			Path:    r.URL.Path,
+			CanGoUp: canGoUp,
+			Items:   fileinfos,
+		}
+
+		err = bc.Template.Execute(w, listing)
+		if err != nil {
+			panic(err) // TODO
+		}
+
+		return
+	}
+
+	// Didn't qualify; pass-thru
+	b.Next(w, r)
+}
+
+// parse returns a list of browsing configurations
+func parse(c middleware.Controller) ([]BrowseConfig, error) {
+	var configs []BrowseConfig
+
+	appendCfg := func(bc BrowseConfig) error {
+		for _, c := range configs {
+			if c.PathScope == bc.PathScope {
+				return fmt.Errorf("Duplicate browsing config for %s", c.PathScope)
+			}
+		}
+		configs = append(configs, bc)
+		return nil
+	}
+
+	for c.Next() {
+		var bc BrowseConfig
+
+		if !c.NextArg() {
+			bc.PathScope = "/"
+			err := appendCfg(bc)
+			if err != nil {
+				return configs, err
+			}
+			continue
+		}
+
+		bc.PathScope = c.Val()
+
+		if !c.NextArg() {
+			err := appendCfg(bc)
+			if err != nil {
+				return configs, err
+			}
+			continue
+		}
+
+		tplFile := c.Val()
+		var tplText string
+
+		if tplFile != "" {
+			tplBytes, err := ioutil.ReadFile(tplFile)
+			if err != nil {
+				return configs, err
+			}
+			tplText = string(tplBytes)
+		} else {
+			tplText = defaultTemplate
+		}
+
+		tpl, err := template.New("listing").Parse(tplText)
+		if err != nil {
+			return configs, err
+		}
+		bc.Template = tpl
+
+		err = appendCfg(bc)
+		if err != nil {
+			return configs, err
+		}
+	}
+
+	return configs, nil
+}
+
+const defaultTemplate = `
+{{range .}}
+	{{.Name}}<br>
+{{end}}
+`