forked from sillygod/cdp-cache
-
Notifications
You must be signed in to change notification settings - Fork 0
/
caddyfile.go
285 lines (245 loc) · 8.45 KB
/
caddyfile.go
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
package httpcache
import (
"encoding/json"
"fmt"
"strconv"
"time"
"github.com/caddyserver/caddy/v2"
"github.com/caddyserver/caddy/v2/caddyconfig"
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
"github.com/caddyserver/caddy/v2/caddyconfig/httpcaddyfile"
"github.com/caddyserver/caddy/v2/modules/caddyhttp"
)
// CacheType is the type of cache which means the backend for storing
// cache content.
type CacheType string
const (
file CacheType = "file"
inMemory CacheType = "in_memory"
)
// BYTE represents the num of byte
// 1MB = 2^10 BYTE
// 1GB = 2^10 MB
const (
BYTE = 1 << (iota * 10)
KB
MB
GB
)
var (
defaultStatusHeader = "X-Cache-Status"
defaultLockTimeout = time.Duration(5) * time.Minute
defaultMaxAge = time.Duration(5) * time.Minute
defaultPath = "/tmp/caddy_cache"
defaultMatchMethods = []string{"GET", "HEAD"}
defaultCacheType = file
defaultcacheBucketsNum = 256
defaultCacheMaxMemorySize = GB // default is 1 GB
defaultStaleMaxAge = time.Duration(0)
defaultCacheKeyTemplate = "{http.request.method} {http.request.host}{http.request.uri.path}?{http.request.uri.query}"
// Note: prevent character space in the key
// the key is refereced from github.com/caddyserver/caddy/v2/modules/caddyhttp.addHTTPVarsToReplacer
)
const (
keyStatusHeader = "status_header"
keyLockTimeout = "lock_timeout"
keyDefaultMaxAge = "default_max_age"
keyPath = "path"
keyMatchHeader = "match_header"
keyMatchPath = "match_path"
keyMatchMethod = "match_methods"
keyCacheKey = "cache_key"
keyCacheBucketsNum = "cache_bucket_num"
keyCacheMaxMemorySize = "cache_max_memory_size"
keyCacheType = "cache_type"
keyDistributed = "distributed"
keyInfluxLog = "influxlog"
keyStaleMaxAge = "stale_max_age"
)
func init() {
httpcaddyfile.RegisterHandlerDirective("http_cache", parseCaddyfile)
}
// Config is the configuration for cache process
type Config struct {
Type CacheType `json:"type,omitempty"`
StatusHeader string `json:"status_header,omitempty"`
DefaultMaxAge time.Duration `json:"default_max_age,omitempty"`
LockTimeout time.Duration `json:"lock_timeout,omitempty"`
RuleMatchersRaws []RuleMatcherRawWithType `json:"rule_matcher_raws,omitempty"`
RuleMatchers []RuleMatcher `json:"-"`
MatchMethods []string `json:"match_methods,omitempty"`
CacheBucketsNum int `json:"cache_buckets_num,omitempty"`
CacheMaxMemorySize int `json:"cache_max_memory_size,omitempty"`
Path string `json:"path,omitempty"`
CacheKeyTemplate string `json:"cache_key_template,omitempty"`
StaleMaxAge time.Duration `json:"stale_max_age,omitempty"`
}
func getDefaultConfig() *Config {
return &Config{
StatusHeader: defaultStatusHeader,
DefaultMaxAge: defaultMaxAge,
LockTimeout: defaultLockTimeout,
RuleMatchersRaws: []RuleMatcherRawWithType{},
RuleMatchers: []RuleMatcher{},
MatchMethods: defaultMatchMethods,
CacheBucketsNum: defaultcacheBucketsNum,
CacheMaxMemorySize: defaultCacheMaxMemorySize,
Path: defaultPath,
Type: defaultCacheType,
CacheKeyTemplate: defaultCacheKeyTemplate,
StaleMaxAge: defaultStaleMaxAge,
}
}
func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
// call Handler UnmarshalCaddyfile
hr := new(Handler)
err := hr.UnmarshalCaddyfile(h.Dispenser)
if err != nil {
return nil, err
}
return hr, nil
}
// UnmarshalCaddyfile sets up the handler from Caddyfile
//
// :4000 {
// reverse_proxy yourserver:5000
// http_cache {
// match_path /assets
// match_header Content-Type image/jpg image/png
// status_header X-Cache-Status
// default_max_age 15m
// path /tmp/caddy-cache
//
// distributed consul {
// service_name
// addr
// }
// }
// }
func (h *Handler) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
config := getDefaultConfig()
for d.Next() {
for d.NextBlock(0) {
parameter := d.Val()
args := d.RemainingArgs()
switch parameter {
case keyStatusHeader:
if len(args) != 1 {
return d.Err("Invalid usage of status_header in cache config.")
}
config.StatusHeader = args[0]
case keyCacheType:
if len(args) != 1 {
return d.Err("Invalid usage of cache_type in cache config.")
}
config.Type = CacheType(args[0])
case keyLockTimeout:
if len(args) != 1 {
return d.Err("Invalid usage of lock_timeout in cache config")
}
duration, err := time.ParseDuration(args[0])
if err != nil {
return d.Err(fmt.Sprintf("%s:%s , %s", keyLockTimeout, "invalid duration", parameter))
}
config.LockTimeout = duration
case keyDefaultMaxAge:
if len(args) != 1 {
return d.Err("Invalid usage of default_max_age in cache config.")
}
duration, err := time.ParseDuration(args[0])
if err != nil {
return d.Err(fmt.Sprintf("%s:%s, %s", keyDefaultMaxAge, "Invalid duration ", parameter))
}
config.DefaultMaxAge = duration
case keyPath:
if len(args) != 1 {
return d.Err("Invalid usage of path in cache config.")
}
config.Path = args[0]
case keyMatchHeader:
if len(args) < 2 {
return d.Err("Invalid usage of match_header in cache config.")
}
cacheRule := &HeaderRuleMatcher{Header: args[0], Value: args[1:]}
data, _ := json.Marshal(cacheRule)
config.RuleMatchersRaws = append(config.RuleMatchersRaws, RuleMatcherRawWithType{
Type: MatcherTypeHeader,
Data: data,
})
case keyMatchPath:
if len(args) != 1 {
return d.Err("Invalid usage of match_path in cache config.")
}
cacheRule := &PathRuleMatcher{Path: args[0]}
data, _ := json.Marshal(cacheRule)
config.RuleMatchersRaws = append(config.RuleMatchersRaws, RuleMatcherRawWithType{
Type: MatcherTypePath,
Data: data,
})
case keyMatchMethod:
if len(args) < 2 {
return d.Err("Invalid usage of match_method in cache config.")
}
config.MatchMethods = append(config.MatchMethods, args...)
case keyCacheKey:
if len(args) != 1 {
return d.Err(fmt.Sprintf("Invalid usage of %s in cache config.", keyCacheKey))
}
config.CacheKeyTemplate = args[0]
case keyCacheBucketsNum:
if len(args) != 1 {
return d.Err(fmt.Sprintf("Invalid usage of %s in cache config.", keyCacheBucketsNum))
}
num, err := strconv.Atoi(args[0])
if err != nil {
return d.Err(fmt.Sprintf("Invalid usage of %s, %s", keyCacheBucketsNum, err.Error()))
}
config.CacheBucketsNum = num
case keyCacheMaxMemorySize:
if len(args) != 1 {
return d.Err(fmt.Sprintf("Invalid usage of %s in cache config.", keyCacheMaxMemorySize))
}
num, err := strconv.Atoi(args[0])
if err != nil {
return d.Err(fmt.Sprintf("Invalid usage of %s, %s", keyCacheMaxMemorySize, err.Error()))
}
config.CacheMaxMemorySize = num
case keyDistributed:
if len(args) != 1 {
return d.Err(fmt.Sprintf("Invalid usage of %s in cache config.", keyDistributed))
}
solution := args[0]
mod, err := caddy.GetModule("distributed." + solution)
if err != nil {
return d.Errf("getting distributed module '%s': '%v'", mod, err)
}
unm, ok := mod.New().(caddyfile.Unmarshaler)
if !ok {
return d.Errf("distributed module '%s' is not a Caddyfile unmarshaler", mod)
}
err = unm.UnmarshalCaddyfile(d.NewFromNextSegment())
if err != nil {
return err
}
h.DistributedRaw = caddyconfig.JSONModuleObject(unm, "distributed", "consul", nil)
case keyStaleMaxAge:
if len(args) != 1 {
return d.Err("Invalid usage of stale_max_age in cache config.")
}
duration, err := time.ParseDuration(args[0])
if err != nil {
return d.Err(fmt.Sprintf("%s:%s, %s", keyStaleMaxAge, "Invalid duration ", parameter))
}
config.StaleMaxAge = duration
default:
return d.Err("Unknown cache parameter: " + parameter)
}
}
}
h.Config = config
return nil
}
// Interface guards
var (
_ caddyfile.Unmarshaler = (*Handler)(nil)
)