summaryrefslogtreecommitdiff
path: root/modules/caddyhttp/fileserver/caddyfile.go
blob: 7d9ddd9d2d2aca9c446180af07d861471895e9cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
// 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 (
	"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
	"github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
)

// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:
//
//     file_server [<matcher>] [browse] {
//         hide <files...>
//         index <files...>
//         browse [<template_file>]
//         root <path>
//     }
//
// If browse is given on the first line, it can't be used in the block also.
// The default root is the one given by the root directive.
func (fsrv *FileServer) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
	for d.Next() {
		args := d.RemainingArgs()
		switch len(args) {
		case 0:
		case 1:
			if args[0] != "browse" {
				return d.ArgErr()
			}
			fsrv.Browse = new(Browse)
		default:
			return d.ArgErr()
		}

		for d.NextBlock() {
			switch d.Val() {
			case "hide":
				fsrv.Hide = d.RemainingArgs()
				if len(fsrv.Hide) == 0 {
					return d.ArgErr()
				}
			case "index":
				fsrv.IndexNames = d.RemainingArgs()
				if len(fsrv.Hide) == 0 {
					return d.ArgErr()
				}
			case "root":
				if !d.Args(&fsrv.Root) {
					return d.ArgErr()
				}
			case "browse":
				if fsrv.Browse != nil {
					return d.Err("browsing is already configured")
				}
				fsrv.Browse = new(Browse)
				d.Args(&fsrv.Browse.TemplateFile)
			default:
				return d.Errf("unknown subdirective '%s'", d.Val())
			}
		}
	}

	// if no root was configured explicitly, use site root
	if fsrv.Root == "" {
		fsrv.Root = "{http.var.root}"
	}

	return nil
}

// Bucket returns the HTTP Caddyfile handler bucket number.
func (fsrv FileServer) Bucket() int { return 7 }

// Interface guard
var _ httpcaddyfile.HandlerDirective = (*FileServer)(nil)