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

import (
	"os"

	"github.com/spiral/errors"
)

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

		// 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

		// Always specifies list of extensions which must always be served by static
		// service, even if file not found.
		Always []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 *Config) Valid() error {
	const op = errors.Op("static_plugin_valid")
	st, err := os.Stat(c.Static.Dir)
	if err != nil {
		if os.IsNotExist(err) {
			return errors.E(op, errors.Errorf("root directory '%s' does not exists", c.Static.Dir))
		}

		return err
	}

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

	return nil
}