serv/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-01-28 04:45:56 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fileserver: stop listing dir when request context is cancelled (#5131)

Browse source 
Prevents caddy from performing disk IO needlessly when the request is cancelled before the listing is finished.

Closes #5129
This commit is contained in:
Abdussamet Koçak 2022-10-08 21:56:35 +03:00 committed by GitHub
parent b4e28af953
commit 33f60da9f2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
modules/caddyhttp/fileserver/browse.go
View file

@ -16,6 +16,7 @@ package fileserver
import ( import (
"bytes" "bytes"
"context"
_ "embed" _ "embed"
"encoding/json" "encoding/json"
"fmt" "fmt"
@ -82,7 +83,7 @@ func (fsrv *FileServer) serveBrowse(root, dirPath string, w http.ResponseWriter,
repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer) repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer)
// calling path.Clean here prevents weird breadcrumbs when URL paths are sketchy like /%2e%2e%2f // calling path.Clean here prevents weird breadcrumbs when URL paths are sketchy like /%2e%2e%2f
listing, err := fsrv.loadDirectoryContents(dir.(fs.ReadDirFile), root, path.Clean(r.URL.Path), repl) listing, err := fsrv.loadDirectoryContents(r.Context(), dir.(fs.ReadDirFile), root, path.Clean(r.URL.Path), repl)
switch { switch {
case os.IsPermission(err): case os.IsPermission(err):
return caddyhttp.Error(http.StatusForbidden, err) return caddyhttp.Error(http.StatusForbidden, err)
@ -136,7 +137,7 @@ func (fsrv *FileServer) serveBrowse(root, dirPath string, w http.ResponseWriter,
return nil return nil
} }
func (fsrv *FileServer) loadDirectoryContents(dir fs.ReadDirFile, root, urlPath string, repl *caddy.Replacer) (browseTemplateContext, error) { func (fsrv *FileServer) loadDirectoryContents(ctx context.Context, dir fs.ReadDirFile, root, urlPath string, repl *caddy.Replacer) (browseTemplateContext, error) {
files, err := dir.ReadDir(10000) // TODO: this limit should probably be configurable files, err := dir.ReadDir(10000) // TODO: this limit should probably be configurable
if err != nil && err != io.EOF { if err != nil && err != io.EOF {
return browseTemplateContext{}, err return browseTemplateContext{}, err
@ -145,7 +146,7 @@ func (fsrv *FileServer) loadDirectoryContents(dir fs.ReadDirFile, root, urlPath
// user can presumably browse "up" to parent folder if path is longer than "/" // user can presumably browse "up" to parent folder if path is longer than "/"
canGoUp := len(urlPath) > 1 canGoUp := len(urlPath) > 1
return fsrv.directoryListing(files, canGoUp, root, urlPath, repl), nil return fsrv.directoryListing(ctx, files, canGoUp, root, urlPath, repl), nil
} }
// browseApplyQueryParams applies query parameters to the listing. // browseApplyQueryParams applies query parameters to the listing.

7
modules/caddyhttp/fileserver/browsetplcontext.go
View file

@ -15,6 +15,7 @@
package fileserver package fileserver
import ( import (
"context"
"io/fs" "io/fs"
"net/url" "net/url"
"os" "os"
@ -30,13 +31,17 @@ import (
"go.uber.org/zap" "go.uber.org/zap"
) )
func (fsrv *FileServer) directoryListing(entries []fs.DirEntry, canGoUp bool, root, urlPath string, repl *caddy.Replacer) browseTemplateContext { func (fsrv *FileServer) directoryListing(ctx context.Context, entries []fs.DirEntry, canGoUp bool, root, urlPath string, repl *caddy.Replacer) browseTemplateContext {
filesToHide := fsrv.transformHidePaths(repl) filesToHide := fsrv.transformHidePaths(repl)
var dirCount, fileCount int var dirCount, fileCount int
fileInfos := []fileInfo{} fileInfos := []fileInfo{}
for _, entry := range entries { for _, entry := range entries {
if err := ctx.Err(); err != nil {
break
}
name := entry.Name() name := entry.Name()
if fileHidden(name, filesToHide) { if fileHidden(name, filesToHide) {