Skip to content

Adding the option to use an fs.FS for the file server middleware #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adding the option to use an fs.FS for the file server middleware #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae6a549
add .gitattributes
zekroTJA May 8, 2022
a11742b
add `FS` option to `ServerOptions`
zekroTJA May 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
file/testdata/*.* eol=lf
file/testdata/*/*.* eol=lf
24 changes: 16 additions & 8 deletions file/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,20 @@
package file

import (
"io/fs"
"net/http"
"os"
"path/filepath"
"sort"
"strings"

"github.com/go-ozzo/ozzo-routing/v2"
routing "github.com/go-ozzo/ozzo-routing/v2"
)

// ServerOptions defines the possible options for the Server handler.
type ServerOptions struct {
// The FS to be used to serve files from. When set, this overrides RootPath.
FS fs.FS
// The path that all files to be served should be located within. The path map passed to the Server method
// are all relative to this path. This property can be specified as an absolute file path or a path relative
// to the current working path. If not set, this property defaults to the current working path.
Expand Down Expand Up @@ -76,8 +79,13 @@ func Server(pathMap PathMap, opts ...ServerOptions) routing.Handler {
}
from, to := parsePathMap(pathMap)

// security measure: limit the files within options.RootPath
dir := http.Dir(options.RootPath)
var fsys http.FileSystem
if options.FS != nil {
fsys = http.FS(options.FS)
} else {
// security measure: limit the files within options.RootPath
fsys = http.FS(os.DirFS(options.RootPath))
}

return func(c *routing.Context) error {
if c.Request.Method != "GET" && c.Request.Method != "HEAD" {
Expand All @@ -94,9 +102,9 @@ func Server(pathMap PathMap, opts ...ServerOptions) routing.Handler {
err error
)

if file, err = dir.Open(path); err != nil {
if file, err = fsys.Open(path); err != nil {
if options.CatchAllFile != "" {
return serveFile(c, dir, options.CatchAllFile)
return serveFile(c, fsys, options.CatchAllFile)
}
return routing.NewHTTPError(http.StatusNotFound, err.Error())
}
Expand All @@ -110,7 +118,7 @@ func Server(pathMap PathMap, opts ...ServerOptions) routing.Handler {
if options.IndexFile == "" {
return routing.NewHTTPError(http.StatusNotFound)
}
return serveFile(c, dir, filepath.Join(path, options.IndexFile))
return serveFile(c, fsys, filepath.Join(path, options.IndexFile))
}

c.Response.Header().Del("Content-Type")
Expand All @@ -119,8 +127,8 @@ func Server(pathMap PathMap, opts ...ServerOptions) routing.Handler {
}
}

func serveFile(c *routing.Context, dir http.Dir, path string) error {
file, err := dir.Open(path)
func serveFile(c *routing.Context, fsys http.FileSystem, path string) error {
file, err := fsys.Open(path)
if err != nil {
return routing.NewHTTPError(http.StatusNotFound, err.Error())
}
Expand Down