diff options
author | Matthew Holt <mholt@users.noreply.github.com> | 2021-06-16 14:28:34 -0600 |
---|---|---|
committer | Matthew Holt <mholt@users.noreply.github.com> | 2021-06-16 14:28:34 -0600 |
commit | e8ae80adca5db7102e646954fcc53827732ceb83 (patch) | |
tree | 8c41b80806dee6ffc1a84bfca3d57e576add0d22 /modules/caddyhttp/fileserver/browse.go | |
parent | 32c284b54a77b6c4d3b38485ac2b6484c783b825 (diff) |
fileserver: Don't persist parsed template (fix #4202)
Templates are parsed at request-time (like they are in the templates middleware) to allow live changes to the template while the server is running. Fixes race condition.
Also refactored use of a buffer so a buffer put back in the pool will not continue to be used (written to client) in the meantime.
A couple of benchmarks removed due to refactor, which is fine, since we know pooling helps here.
Diffstat (limited to 'modules/caddyhttp/fileserver/browse.go')
-rw-r--r-- | modules/caddyhttp/fileserver/browse.go | 48 |
1 files changed, 20 insertions, 28 deletions
diff --git a/modules/caddyhttp/fileserver/browse.go b/modules/caddyhttp/fileserver/browse.go index fc8bddb..750eb14 100644 --- a/modules/caddyhttp/fileserver/browse.go +++ b/modules/caddyhttp/fileserver/browse.go @@ -22,6 +22,7 @@ import ( "os" "path" "strings" + "sync" "text/template" "github.com/caddyserver/caddy/v2" @@ -34,8 +35,6 @@ import ( type Browse struct { // Use this template file instead of the default browse template. TemplateFile string `json:"template_file,omitempty"` - - template *template.Template } func (fsrv *FileServer) serveBrowse(root, dirPath string, w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error { @@ -75,11 +74,14 @@ func (fsrv *FileServer) serveBrowse(root, dirPath string, w http.ResponseWriter, fsrv.browseApplyQueryParams(w, r, &listing) - // write response as either JSON or HTML - var buf *bytes.Buffer + buf := bufPool.Get().(*bytes.Buffer) + defer bufPool.Put(buf) + acceptHeader := strings.ToLower(strings.Join(r.Header["Accept"], ",")) + + // write response as either JSON or HTML if strings.Contains(acceptHeader, "application/json") { - if buf, err = fsrv.browseWriteJSON(listing); err != nil { + if err := json.NewEncoder(buf).Encode(listing.Items); err != nil { return caddyhttp.Error(http.StatusInternalServerError, err) } w.Header().Set("Content-Type", "application/json; charset=utf-8") @@ -98,12 +100,11 @@ func (fsrv *FileServer) serveBrowse(root, dirPath string, w http.ResponseWriter, browseTemplateContext: listing, } - err = fsrv.makeBrowseTemplate(tplCtx) + tpl, err := fsrv.makeBrowseTemplate(tplCtx) if err != nil { return fmt.Errorf("parsing browse template: %v", err) } - - if buf, err = fsrv.browseWriteHTML(tplCtx); err != nil { + if err := tpl.Execute(buf, tplCtx); err != nil { return caddyhttp.Error(http.StatusInternalServerError, err) } w.Header().Set("Content-Type", "text/html; charset=utf-8") @@ -161,7 +162,7 @@ func (fsrv *FileServer) browseApplyQueryParams(w http.ResponseWriter, r *http.Re } // makeBrowseTemplate creates the template to be used for directory listings. -func (fsrv *FileServer) makeBrowseTemplate(tplCtx *templateContext) error { +func (fsrv *FileServer) makeBrowseTemplate(tplCtx *templateContext) (*template.Template, error) { var tpl *template.Template var err error @@ -169,33 +170,17 @@ func (fsrv *FileServer) makeBrowseTemplate(tplCtx *templateContext) error { tpl = tplCtx.NewTemplate(path.Base(fsrv.Browse.TemplateFile)) tpl, err = tpl.ParseFiles(fsrv.Browse.TemplateFile) if err != nil { - return fmt.Errorf("parsing browse template file: %v", err) + return nil, fmt.Errorf("parsing browse template file: %v", err) } } else { tpl = tplCtx.NewTemplate("default_listing") tpl, err = tpl.Parse(defaultBrowseTemplate) if err != nil { - return fmt.Errorf("parsing default browse template: %v", err) + return nil, fmt.Errorf("parsing default browse template: %v", err) } } - fsrv.Browse.template = tpl - - return nil -} - -func (fsrv *FileServer) browseWriteJSON(listing browseTemplateContext) (*bytes.Buffer, error) { - buf := bufPool.Get().(*bytes.Buffer) - defer bufPool.Put(buf) - err := json.NewEncoder(buf).Encode(listing.Items) - return buf, err -} - -func (fsrv *FileServer) browseWriteHTML(tplCtx *templateContext) (*bytes.Buffer, error) { - buf := bufPool.Get().(*bytes.Buffer) - defer bufPool.Put(buf) - err := fsrv.Browse.template.Execute(buf, tplCtx) - return buf, err + return tpl, nil } // isSymlink return true if f is a symbolic link @@ -224,3 +209,10 @@ type templateContext struct { templates.TemplateContext browseTemplateContext } + +// bufPool is used to increase the efficiency of file listings. +var bufPool = sync.Pool{ + New: func() interface{} { + return new(bytes.Buffer) + }, +} |