2019-08-10 02:05:47 +08:00
|
|
|
// 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 (
|
2022-08-01 11:41:26 +08:00
|
|
|
"io/fs"
|
2020-11-03 05:20:12 +08:00
|
|
|
"path/filepath"
|
2019-12-13 06:27:09 +08:00
|
|
|
"strings"
|
|
|
|
|
2019-12-11 04:36:46 +08:00
|
|
|
"github.com/caddyserver/caddy/v2"
|
2021-03-30 08:47:19 +08:00
|
|
|
"github.com/caddyserver/caddy/v2/caddyconfig"
|
2022-08-01 11:41:26 +08:00
|
|
|
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
|
2019-08-10 02:19:56 +08:00
|
|
|
"github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
|
2019-08-22 00:46:35 +08:00
|
|
|
"github.com/caddyserver/caddy/v2/modules/caddyhttp"
|
2021-03-30 08:47:19 +08:00
|
|
|
"github.com/caddyserver/caddy/v2/modules/caddyhttp/encode"
|
2019-08-28 04:38:24 +08:00
|
|
|
"github.com/caddyserver/caddy/v2/modules/caddyhttp/rewrite"
|
2019-08-10 02:05:47 +08:00
|
|
|
)
|
|
|
|
|
2019-08-22 00:46:35 +08:00
|
|
|
func init() {
|
|
|
|
httpcaddyfile.RegisterHandlerDirective("file_server", parseCaddyfile)
|
|
|
|
httpcaddyfile.RegisterDirective("try_files", parseTryFiles)
|
|
|
|
}
|
|
|
|
|
2019-11-28 02:51:32 +08:00
|
|
|
// parseCaddyfile parses the file_server directive. It enables the static file
|
|
|
|
// server and configures it with this syntax:
|
|
|
|
//
|
|
|
|
// file_server [<matcher>] [browse] {
|
2022-08-01 11:41:26 +08:00
|
|
|
// fs <backend...>
|
2021-03-30 08:47:19 +08:00
|
|
|
// root <path>
|
|
|
|
// hide <files...>
|
|
|
|
// index <files...>
|
|
|
|
// browse [<template_file>]
|
|
|
|
// precompressed <formats...>
|
2021-04-09 01:09:12 +08:00
|
|
|
// status <status>
|
2021-07-02 07:22:16 +08:00
|
|
|
// disable_canonical_uris
|
2019-11-28 02:51:32 +08:00
|
|
|
// }
|
|
|
|
//
|
2019-08-22 00:46:35 +08:00
|
|
|
func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
|
|
|
|
var fsrv FileServer
|
|
|
|
|
|
|
|
for h.Next() {
|
|
|
|
args := h.RemainingArgs()
|
2019-08-10 02:05:47 +08:00
|
|
|
switch len(args) {
|
|
|
|
case 0:
|
|
|
|
case 1:
|
|
|
|
if args[0] != "browse" {
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.ArgErr()
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
|
|
|
fsrv.Browse = new(Browse)
|
|
|
|
default:
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.ArgErr()
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
|
|
|
|
2019-09-11 09:21:52 +08:00
|
|
|
for h.NextBlock(0) {
|
2019-08-22 00:46:35 +08:00
|
|
|
switch h.Val() {
|
2022-08-01 11:41:26 +08:00
|
|
|
case "fs":
|
|
|
|
if !h.NextArg() {
|
|
|
|
return nil, h.ArgErr()
|
|
|
|
}
|
|
|
|
if fsrv.FileSystemRaw != nil {
|
|
|
|
return nil, h.Err("file system module already specified")
|
|
|
|
}
|
|
|
|
name := h.Val()
|
|
|
|
modID := "caddy.fs." + name
|
|
|
|
unm, err := caddyfile.UnmarshalModule(h.Dispenser, modID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
statFS, ok := unm.(fs.StatFS)
|
|
|
|
if !ok {
|
|
|
|
return nil, h.Errf("module %s (%T) is not a supported file system implementation (requires fs.StatFS)", modID, unm)
|
|
|
|
}
|
|
|
|
fsrv.FileSystemRaw = caddyconfig.JSONModuleObject(statFS, "backend", name, nil)
|
|
|
|
|
2019-08-10 02:05:47 +08:00
|
|
|
case "hide":
|
2019-08-22 00:46:35 +08:00
|
|
|
fsrv.Hide = h.RemainingArgs()
|
2019-08-10 02:05:47 +08:00
|
|
|
if len(fsrv.Hide) == 0 {
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.ArgErr()
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
2021-04-09 01:09:12 +08:00
|
|
|
|
2019-08-10 02:05:47 +08:00
|
|
|
case "index":
|
2019-08-22 00:46:35 +08:00
|
|
|
fsrv.IndexNames = h.RemainingArgs()
|
2020-03-25 06:48:04 +08:00
|
|
|
if len(fsrv.IndexNames) == 0 {
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.ArgErr()
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
2021-04-09 01:09:12 +08:00
|
|
|
|
2019-08-10 02:05:47 +08:00
|
|
|
case "root":
|
2019-08-22 00:46:35 +08:00
|
|
|
if !h.Args(&fsrv.Root) {
|
|
|
|
return nil, h.ArgErr()
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
2021-04-09 01:09:12 +08:00
|
|
|
|
2019-08-10 02:05:47 +08:00
|
|
|
case "browse":
|
|
|
|
if fsrv.Browse != nil {
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.Err("browsing is already configured")
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
|
|
|
fsrv.Browse = new(Browse)
|
2019-08-22 00:46:35 +08:00
|
|
|
h.Args(&fsrv.Browse.TemplateFile)
|
2021-04-09 01:09:12 +08:00
|
|
|
|
2021-03-30 08:47:19 +08:00
|
|
|
case "precompressed":
|
|
|
|
var order []string
|
|
|
|
for h.NextArg() {
|
|
|
|
modID := "http.precompressed." + h.Val()
|
|
|
|
mod, err := caddy.GetModule(modID)
|
|
|
|
if err != nil {
|
|
|
|
return nil, h.Errf("getting module named '%s': %v", modID, err)
|
|
|
|
}
|
|
|
|
inst := mod.New()
|
|
|
|
precompress, ok := inst.(encode.Precompressed)
|
|
|
|
if !ok {
|
|
|
|
return nil, h.Errf("module %s is not a precompressor; is %T", modID, inst)
|
|
|
|
}
|
|
|
|
if fsrv.PrecompressedRaw == nil {
|
|
|
|
fsrv.PrecompressedRaw = make(caddy.ModuleMap)
|
|
|
|
}
|
|
|
|
fsrv.PrecompressedRaw[h.Val()] = caddyconfig.JSON(precompress, nil)
|
|
|
|
order = append(order, h.Val())
|
|
|
|
}
|
|
|
|
fsrv.PrecompressedOrder = order
|
2021-04-09 01:09:12 +08:00
|
|
|
|
|
|
|
case "status":
|
|
|
|
if !h.NextArg() {
|
|
|
|
return nil, h.ArgErr()
|
|
|
|
}
|
|
|
|
fsrv.StatusCode = caddyhttp.WeakString(h.Val())
|
|
|
|
|
2021-07-02 07:22:16 +08:00
|
|
|
case "disable_canonical_uris":
|
|
|
|
if h.NextArg() {
|
|
|
|
return nil, h.ArgErr()
|
|
|
|
}
|
|
|
|
falseBool := false
|
|
|
|
fsrv.CanonicalURIs = &falseBool
|
|
|
|
|
2022-03-05 11:50:05 +08:00
|
|
|
case "pass_thru":
|
|
|
|
if h.NextArg() {
|
|
|
|
return nil, h.ArgErr()
|
|
|
|
}
|
|
|
|
fsrv.PassThru = true
|
|
|
|
|
2019-08-10 02:05:47 +08:00
|
|
|
default:
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.Errf("unknown subdirective '%s'", h.Val())
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-22 05:50:02 +08:00
|
|
|
// hide the Caddyfile (and any imported Caddyfiles)
|
|
|
|
if configFiles := h.Caddyfiles(); len(configFiles) > 0 {
|
|
|
|
for _, file := range configFiles {
|
2020-11-03 05:20:12 +08:00
|
|
|
file = filepath.Clean(file)
|
2019-08-22 05:50:02 +08:00
|
|
|
if !fileHidden(file, fsrv.Hide) {
|
2020-11-03 05:20:12 +08:00
|
|
|
// if there's no path separator, the file server module will hide all
|
|
|
|
// files by that name, rather than a specific one; but we want to hide
|
|
|
|
// only this specific file, so ensure there's always a path separator
|
|
|
|
if !strings.Contains(file, separator) {
|
|
|
|
file = "." + separator + file
|
|
|
|
}
|
2019-08-22 05:50:02 +08:00
|
|
|
fsrv.Hide = append(fsrv.Hide, file)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-08-22 00:46:35 +08:00
|
|
|
return &fsrv, nil
|
2019-08-10 02:05:47 +08:00
|
|
|
}
|
|
|
|
|
2019-11-16 03:47:38 +08:00
|
|
|
// parseTryFiles parses the try_files directive. It combines a file matcher
|
|
|
|
// with a rewrite directive, so this is not a standard handler directive.
|
|
|
|
// A try_files directive has this syntax (notice no matcher tokens accepted):
|
|
|
|
//
|
|
|
|
// try_files <files...>
|
|
|
|
//
|
2019-12-13 06:27:09 +08:00
|
|
|
// and is basically shorthand for:
|
2019-11-16 03:47:38 +08:00
|
|
|
//
|
2020-01-10 05:38:59 +08:00
|
|
|
// @try_files {
|
2019-11-16 03:47:38 +08:00
|
|
|
// file {
|
|
|
|
// try_files <files...>
|
|
|
|
// }
|
|
|
|
// }
|
2020-01-12 04:47:42 +08:00
|
|
|
// rewrite @try_files {http.matchers.file.relative}
|
2019-11-16 03:47:38 +08:00
|
|
|
//
|
2020-01-12 04:47:42 +08:00
|
|
|
// This directive rewrites request paths only, preserving any other part
|
|
|
|
// of the URI, unless the part is explicitly given in the file list. For
|
|
|
|
// example, if any of the files in the list have a query string:
|
|
|
|
//
|
|
|
|
// try_files {path} index.php?{query}&p={path}
|
|
|
|
//
|
|
|
|
// then the query string will not be treated as part of the file name; and
|
|
|
|
// if that file matches, the given query string will replace any query string
|
|
|
|
// that already exists on the request URI.
|
2019-08-22 00:46:35 +08:00
|
|
|
func parseTryFiles(h httpcaddyfile.Helper) ([]httpcaddyfile.ConfigValue, error) {
|
|
|
|
if !h.Next() {
|
|
|
|
return nil, h.ArgErr()
|
|
|
|
}
|
|
|
|
|
2019-12-13 06:27:09 +08:00
|
|
|
tryFiles := h.RemainingArgs()
|
|
|
|
if len(tryFiles) == 0 {
|
2019-08-22 00:46:35 +08:00
|
|
|
return nil, h.ArgErr()
|
|
|
|
}
|
|
|
|
|
2019-12-13 06:27:09 +08:00
|
|
|
// makeRoute returns a route that tries the files listed in try
|
2020-01-12 04:47:42 +08:00
|
|
|
// and then rewrites to the matched file; userQueryString is
|
|
|
|
// appended to the rewrite rule.
|
|
|
|
makeRoute := func(try []string, userQueryString string) []httpcaddyfile.ConfigValue {
|
2019-12-13 06:27:09 +08:00
|
|
|
handler := rewrite.Rewrite{
|
2020-01-12 04:47:42 +08:00
|
|
|
URI: "{http.matchers.file.relative}" + userQueryString,
|
2019-12-13 06:27:09 +08:00
|
|
|
}
|
|
|
|
matcherSet := caddy.ModuleMap{
|
2020-01-12 04:47:42 +08:00
|
|
|
"file": h.JSON(MatchFile{TryFiles: try}),
|
2019-12-13 06:27:09 +08:00
|
|
|
}
|
|
|
|
return h.NewRoute(matcherSet, handler)
|
2019-08-22 00:46:35 +08:00
|
|
|
}
|
2019-08-10 02:05:47 +08:00
|
|
|
|
2019-12-13 06:27:09 +08:00
|
|
|
var result []httpcaddyfile.ConfigValue
|
|
|
|
|
|
|
|
// if there are query strings in the list, we have to split into
|
|
|
|
// a separate route for each item with a query string, because
|
|
|
|
// the rewrite is different for that item
|
2020-04-09 05:31:51 +08:00
|
|
|
try := make([]string, 0, len(tryFiles))
|
2019-12-13 06:27:09 +08:00
|
|
|
for _, item := range tryFiles {
|
|
|
|
if idx := strings.Index(item, "?"); idx >= 0 {
|
|
|
|
if len(try) > 0 {
|
|
|
|
result = append(result, makeRoute(try, "")...)
|
|
|
|
try = []string{}
|
|
|
|
}
|
2020-01-12 04:47:42 +08:00
|
|
|
result = append(result, makeRoute([]string{item[:idx]}, item[idx:])...)
|
2019-12-13 06:27:09 +08:00
|
|
|
continue
|
|
|
|
}
|
|
|
|
// accumulate consecutive non-query-string parameters
|
|
|
|
try = append(try, item)
|
|
|
|
}
|
|
|
|
if len(try) > 0 {
|
|
|
|
result = append(result, makeRoute(try, "")...)
|
2019-08-22 00:46:35 +08:00
|
|
|
}
|
|
|
|
|
2020-01-17 02:29:20 +08:00
|
|
|
// ensure that multiple routes (possible if rewrite targets
|
|
|
|
// have query strings, for example) are grouped together
|
|
|
|
// so only the first matching rewrite is performed (#2891)
|
|
|
|
h.GroupRoutes(result)
|
|
|
|
|
2019-12-13 06:27:09 +08:00
|
|
|
return result, nil
|
2019-08-22 00:46:35 +08:00
|
|
|
}
|