unindexed.go

package unindexed

import (
	"net/http"
	"os"
	"strings"
)

// FileSystem is an implementation of a standard http.FileSystem
// without the ability to list files in the directory.
// This implementation is largely inspired by
// https://www.alexedwards.net/blog/disable-http-fileserver-directory-listings
type FileSystem struct {
	fs http.FileSystem
}

// Open returns a file from the static directory. If the requested path ends
// with a slash, there is a check for an index.html file. If none exists, then
// an os.ErrPermission error is returned, causing a 403 Forbidden error to be
// returned to the client
func (ufs FileSystem) Open(name string) (http.File, error) {
	f, err := ufs.fs.Open(name)
	if err != nil {
		return nil, err
	}
	// Check to see if what we opened was a directory. If it was, we will
	// return an error
	s, err := f.Stat()
	if s.IsDir() {
		index := strings.TrimSuffix(name, "/") + "/index.html"
		_, err := ufs.fs.Open(index)
		if err != nil {
			return nil, os.ErrPermission
		}
	}
	return f, nil
}

// Dir is a drop-in replacement for http.Dir, providing an unindexed
// filesystem for serving static files.
func Dir(filepath string) http.FileSystem {
	return FileSystem{
		fs: http.Dir(filepath),
	}
}