summaryrefslogtreecommitdiff
path: root/plugins/http/config/static.go
blob: 4b7b3a9b315bbfb94906fe2830e0c6f10dd5ed72 (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
package config

import (
	"os"

	"github.com/spiral/errors"
)

// Static describes file location and controls access to them.
type Static struct {
	// Dir contains name of directory to control access to.
	// Default - "."
	Dir string

	// HTTP pattern, where to serve static files
	// for example - `/static/`, `/my-files/static/`, etc
	// Default - /static/
	Pattern string

	// CalculateEtag can be true/false and used to calculate etag for the static
	CalculateEtag bool `mapstructure:"calculate_etag"`

	// Weak etag `W/`
	Weak bool

	// forbid specifies list of file extensions which are forbidden for access.
	// example: .php, .exe, .bat, .htaccess and etc.
	Forbid []string

	// Allow specifies list of file extensions which are allowed for access.
	// example: .php, .exe, .bat, .htaccess and etc.
	Allow []string

	// Request headers to add to every static.
	Request map[string]string

	// Response headers to add to every static.
	Response map[string]string
}

// Valid returns nil if config is valid.
func (c *Static) Valid() error {
	const op = errors.Op("static_plugin_valid")
	st, err := os.Stat(c.Dir)
	if err != nil {
		if os.IsNotExist(err) {
			return errors.E(op, errors.Errorf("root directory '%s' does not exists", c.Dir))
		}

		return err
	}

	if !st.IsDir() {
		return errors.E(op, errors.Errorf("invalid root directory '%s'", c.Dir))
	}

	return nil
}