You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			
		
			
				
					
					
						
							167 lines
						
					
					
						
							5.1 KiB
						
					
					
				
			
		
		
		
			
			
			
				
					
				
				
					
				
			
		
		
	
	
							167 lines
						
					
					
						
							5.1 KiB
						
					
					
				| // Copyright 2015 Matthew Holt and The Caddy Authors | |
| // | |
| // Licensed under the Apache License, Version 2.0 (the "License"); | |
| // you may not use this file except in compliance with the License. | |
| // You may obtain a copy of the License at | |
| // | |
| //     http://www.apache.org/licenses/LICENSE-2.0 | |
| // | |
| // Unless required by applicable law or agreed to in writing, software | |
| // distributed under the License is distributed on an "AS IS" BASIS, | |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| // See the License for the specific language governing permissions and | |
| // limitations under the License. | |
|  | |
| package fileserver | |
| 
 | |
| import ( | |
| 	"bytes" | |
| 	"encoding/json" | |
| 	"html/template" | |
| 	"net/http" | |
| 	"os" | |
| 	"path" | |
| 	"strings" | |
| 
 | |
| 	"github.com/caddyserver/caddy/v2" | |
| 	"github.com/caddyserver/caddy/v2/modules/caddyhttp" | |
| ) | |
| 
 | |
| // Browse configures directory browsing. | |
| 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(dirPath string, w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error { | |
| 	// navigation on the client-side gets messed up if the | |
| 	// URL doesn't end in a trailing slash because hrefs like | |
| 	// "/b/c" on a path like "/a" end up going to "/b/c" instead | |
| 	// of "/a/b/c" - so we have to redirect in this case | |
| 	if !strings.HasSuffix(r.URL.Path, "/") { | |
| 		r.URL.Path += "/" | |
| 		http.Redirect(w, r, r.URL.String(), http.StatusMovedPermanently) | |
| 		return nil | |
| 	} | |
| 
 | |
| 	dir, err := fsrv.openFile(dirPath, w) | |
| 	if err != nil { | |
| 		return err | |
| 	} | |
| 	defer dir.Close() | |
| 
 | |
| 	repl := r.Context().Value(caddy.ReplacerCtxKey).(*caddy.Replacer) | |
| 
 | |
| 	// calling path.Clean here prevents weird breadcrumbs when URL paths are sketchy like /%2e%2e%2f | |
| 	listing, err := fsrv.loadDirectoryContents(dir, path.Clean(r.URL.Path), repl) | |
| 	switch { | |
| 	case os.IsPermission(err): | |
| 		return caddyhttp.Error(http.StatusForbidden, err) | |
| 	case os.IsNotExist(err): | |
| 		return fsrv.notFound(w, r, next) | |
| 	case err != nil: | |
| 		return caddyhttp.Error(http.StatusInternalServerError, err) | |
| 	} | |
| 
 | |
| 	fsrv.browseApplyQueryParams(w, r, &listing) | |
| 
 | |
| 	// write response as either JSON or HTML | |
| 	var buf *bytes.Buffer | |
| 	acceptHeader := strings.ToLower(strings.Join(r.Header["Accept"], ",")) | |
| 	if strings.Contains(acceptHeader, "application/json") { | |
| 		if buf, err = fsrv.browseWriteJSON(listing); err != nil { | |
| 			return caddyhttp.Error(http.StatusInternalServerError, err) | |
| 		} | |
| 		w.Header().Set("Content-Type", "application/json; charset=utf-8") | |
| 	} else { | |
| 		if buf, err = fsrv.browseWriteHTML(listing); err != nil { | |
| 			return caddyhttp.Error(http.StatusInternalServerError, err) | |
| 		} | |
| 		w.Header().Set("Content-Type", "text/html; charset=utf-8") | |
| 	} | |
| 
 | |
| 	buf.WriteTo(w) | |
| 
 | |
| 	return nil | |
| } | |
| 
 | |
| func (fsrv *FileServer) loadDirectoryContents(dir *os.File, urlPath string, repl *caddy.Replacer) (browseListing, error) { | |
| 	files, err := dir.Readdir(-1) | |
| 	if err != nil { | |
| 		return browseListing{}, err | |
| 	} | |
| 
 | |
| 	// determine if user can browse up another folder | |
| 	curPathDir := path.Dir(strings.TrimSuffix(urlPath, "/")) | |
| 	canGoUp := strings.HasPrefix(curPathDir, fsrv.Root) | |
| 
 | |
| 	return fsrv.directoryListing(files, canGoUp, urlPath, repl), nil | |
| } | |
| 
 | |
| // browseApplyQueryParams applies query parameters to the listing. | |
| // It mutates the listing and may set cookies. | |
| func (fsrv *FileServer) browseApplyQueryParams(w http.ResponseWriter, r *http.Request, listing *browseListing) { | |
| 	sortParam := r.URL.Query().Get("sort") | |
| 	orderParam := r.URL.Query().Get("order") | |
| 	limitParam := r.URL.Query().Get("limit") | |
| 
 | |
| 	// first figure out what to sort by | |
| 	switch sortParam { | |
| 	case "": | |
| 		sortParam = sortByNameDirFirst | |
| 		if sortCookie, sortErr := r.Cookie("sort"); sortErr == nil { | |
| 			sortParam = sortCookie.Value | |
| 		} | |
| 	case sortByName, sortByNameDirFirst, sortBySize, sortByTime: | |
| 		http.SetCookie(w, &http.Cookie{Name: "sort", Value: sortParam, Secure: r.TLS != nil}) | |
| 	} | |
| 
 | |
| 	// then figure out the order | |
| 	switch orderParam { | |
| 	case "": | |
| 		orderParam = "asc" | |
| 		if orderCookie, orderErr := r.Cookie("order"); orderErr == nil { | |
| 			orderParam = orderCookie.Value | |
| 		} | |
| 	case "asc", "desc": | |
| 		http.SetCookie(w, &http.Cookie{Name: "order", Value: orderParam, Secure: r.TLS != nil}) | |
| 	} | |
| 
 | |
| 	// finally, apply the sorting and limiting | |
| 	listing.applySortAndLimit(sortParam, orderParam, limitParam) | |
| } | |
| 
 | |
| func (fsrv *FileServer) browseWriteJSON(listing browseListing) (*bytes.Buffer, error) { | |
| 	buf := bufPool.Get().(*bytes.Buffer) | |
| 	err := json.NewEncoder(buf).Encode(listing.Items) | |
| 	bufPool.Put(buf) | |
| 	return buf, err | |
| } | |
| 
 | |
| func (fsrv *FileServer) browseWriteHTML(listing browseListing) (*bytes.Buffer, error) { | |
| 	buf := bufPool.Get().(*bytes.Buffer) | |
| 	err := fsrv.Browse.template.Execute(buf, listing) | |
| 	bufPool.Put(buf) | |
| 	return buf, err | |
| } | |
| 
 | |
| // isSymlink return true if f is a symbolic link | |
| func isSymlink(f os.FileInfo) bool { | |
| 	return f.Mode()&os.ModeSymlink != 0 | |
| } | |
| 
 | |
| // isSymlinkTargetDir returns true if f's symbolic link target | |
| // is a directory. | |
| func isSymlinkTargetDir(f os.FileInfo, root, urlPath string) bool { | |
| 	if !isSymlink(f) { | |
| 		return false | |
| 	} | |
| 	target := sanitizedPathJoin(root, path.Join(urlPath, f.Name())) | |
| 	targetInfo, err := os.Stat(target) | |
| 	if err != nil { | |
| 		return false | |
| 	} | |
| 	return targetInfo.IsDir() | |
| }
 | |
| 
 |