caddy/server/fileserver.go at master · miko-code/caddy · GitHub

History

136 lines (122 loc) · 3.89 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

package server

import (

"net/http"

"os"

"path"

"strings"

"github.com/mholt/caddy/middleware"

"github.com/mholt/caddy/middleware/browse"

)

// FileServer is adapted from the one in net/http by

// the Go authors. Significant modifications have been made.

// License:

// Use of this source code is governed by a BSD-style

// license that can be found in the LICENSE file.

func FileServer(root http.FileSystem, hide []string) middleware.Handler {

return &fileHandler{root: root, hide: hide}

}

type fileHandler struct {

root http.FileSystem

hide []string // list of files to treat as "Not Found"

}

func (fh *fileHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) {

upath := r.URL.Path

if !strings.HasPrefix(upath, "/") {

upath = "/" + upath

r.URL.Path = upath

}

return fh.serveFile(w, r, path.Clean(upath))

}

// serveFile writes the specified file to the HTTP response.

// name is '/'-separated, not filepath.Separator.

func (fh *fileHandler) serveFile(w http.ResponseWriter, r *http.Request, name string) (int, error) {

f, err := fh.root.Open(name)

if err != nil {

if os.IsNotExist(err) {

return http.StatusNotFound, nil

} else if os.IsPermission(err) {

return http.StatusForbidden, err

}

// Likely the server is under load and ran out of file descriptors

w.Header().Set("Retry-After", "5") // TODO: 5 seconds enough delay? Or too much?

return http.StatusServiceUnavailable, err

}

defer f.Close()

d, err1 := f.Stat()

if err1 != nil {

if os.IsNotExist(err) {

return http.StatusNotFound, nil

} else if os.IsPermission(err) {

return http.StatusForbidden, err

}

// Return a different status code than above so as to distinguish these cases

return http.StatusInternalServerError, err

}

// redirect to canonical path

url := r.URL.Path

if d.IsDir() {

// Ensure / at end of directory url

if url[len(url)-1] != '/' {

redirect(w, r, path.Base(url)+"/")

return http.StatusMovedPermanently, nil

}

} else {

// Ensure no / at end of file url

if url[len(url)-1] == '/' {

redirect(w, r, "../"+path.Base(url))

return http.StatusMovedPermanently, nil

}

// use contents of an index file, if present, for directory

if d.IsDir() {

for _, indexPage := range browse.IndexPages {

index := strings.TrimSuffix(name, "/") + "/" + indexPage

ff, err := fh.root.Open(index)

if err == nil {

defer ff.Close()

dd, err := ff.Stat()

if err == nil {

name = index

d = dd

f = ff

break

}

// Still a directory? (we didn't find an index file)

// Return 404 to hide the fact that the folder exists

if d.IsDir() {

return http.StatusNotFound, nil

}

// If the file is supposed to be hidden, return a 404

// (TODO: If the slice gets large, a set may be faster)

for _, hiddenPath := range fh.hide {

// Case-insensitive file systems may have loaded "CaddyFile" when

// we think we got "Caddyfile", which poses a security risk if we

// aren't careful here: case-insensitive comparison is required!

// TODO: This matches file NAME only, regardless of path. In other

// words, trying to serve another file with the same name as the

// active config file will result in a 404 when it shouldn't.

if strings.EqualFold(d.Name(), path.Base(hiddenPath)) {

return http.StatusNotFound, nil

}

// Note: Errors generated by ServeContent are written immediately

// to the response. This usually only happens if seeking fails (rare).

http.ServeContent(w, r, d.Name(), d.ModTime(), f)

return http.StatusOK, nil

}

// redirect is taken from http.localRedirect of the std lib. It

// sends an HTTP redirect to the client but will preserve the

// query string for the new path.

func redirect(w http.ResponseWriter, r *http.Request, newPath string) {

if q := r.URL.RawQuery; q != "" {

newPath += "?" + q

}

http.Redirect(w, r, newPath, http.StatusMovedPermanently)

}

caddy/server/fileserver.go at master · miko-code/caddy · GitHub

Expand file tree

Breadcrumbs

fileserver.go

Latest commit

History

Breadcrumbs

fileserver.go

File metadata and controls