mirror of
https://github.com/caddyserver/caddy.git
synced 2025-11-04 03:27:23 -05:00
f5db41ce1d
Followup to #4150, #4151 /cc @ueffel @polarathene After a bit of discussion with @mholt, we decided to remove `prefer` as a subdirective and just go with using the order implicitly always. Simpler config, simpler docs, etc. Effectively changes 7776471 and reverts a small part of f35a7fa.
124 lines
3.4 KiB
Go
124 lines
3.4 KiB
Go
// 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 encode
|
|
|
|
import (
|
|
"strconv"
|
|
|
|
"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"
|
|
)
|
|
|
|
func init() {
|
|
httpcaddyfile.RegisterHandlerDirective("encode", parseCaddyfile)
|
|
}
|
|
|
|
func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
|
|
enc := new(Encode)
|
|
err := enc.UnmarshalCaddyfile(h.Dispenser)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return enc, nil
|
|
}
|
|
|
|
// UnmarshalCaddyfile sets up the handler from Caddyfile tokens. Syntax:
|
|
//
|
|
// encode [<matcher>] <formats...> {
|
|
// gzip [<level>]
|
|
// zstd
|
|
// minimum_length <length>
|
|
// # response matcher block
|
|
// match {
|
|
// status <code...>
|
|
// header <field> [<value>]
|
|
// }
|
|
// # or response matcher single line syntax
|
|
// match [header <field> [<value>]] | [status <code...>]
|
|
// }
|
|
//
|
|
// Specifying the formats on the first line will use those formats' defaults.
|
|
func (enc *Encode) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
|
|
var prefer []string
|
|
|
|
responseMatchers := make(map[string]caddyhttp.ResponseMatcher)
|
|
|
|
for d.Next() {
|
|
for _, arg := range d.RemainingArgs() {
|
|
mod, err := caddy.GetModule("http.encoders." + arg)
|
|
if err != nil {
|
|
return d.Errf("finding encoder module '%s': %v", mod, err)
|
|
}
|
|
encoding, ok := mod.New().(Encoding)
|
|
if !ok {
|
|
return d.Errf("module %s is not an HTTP encoding", mod)
|
|
}
|
|
if enc.EncodingsRaw == nil {
|
|
enc.EncodingsRaw = make(caddy.ModuleMap)
|
|
}
|
|
enc.EncodingsRaw[arg] = caddyconfig.JSON(encoding, nil)
|
|
prefer = append(prefer, arg)
|
|
}
|
|
|
|
for d.NextBlock(0) {
|
|
switch d.Val() {
|
|
case "minimum_length":
|
|
if !d.NextArg() {
|
|
return d.ArgErr()
|
|
}
|
|
minLength, err := strconv.Atoi(d.Val())
|
|
if err != nil {
|
|
return err
|
|
}
|
|
enc.MinLength = minLength
|
|
case "match":
|
|
err := caddyhttp.ParseNamedResponseMatcher(d.NewFromNextSegment(), responseMatchers)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
matcher := responseMatchers["match"]
|
|
enc.Matcher = &matcher
|
|
default:
|
|
name := d.Val()
|
|
modID := "http.encoders." + name
|
|
unm, err := caddyfile.UnmarshalModule(d, modID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
encoding, ok := unm.(Encoding)
|
|
if !ok {
|
|
return d.Errf("module %s is not an HTTP encoding; is %T", modID, unm)
|
|
}
|
|
if enc.EncodingsRaw == nil {
|
|
enc.EncodingsRaw = make(caddy.ModuleMap)
|
|
}
|
|
enc.EncodingsRaw[name] = caddyconfig.JSON(encoding, nil)
|
|
prefer = append(prefer, name)
|
|
}
|
|
}
|
|
}
|
|
|
|
// use the order in which the encoders were defined.
|
|
enc.Prefer = prefer
|
|
|
|
return nil
|
|
}
|
|
|
|
// Interface guard
|
|
var _ caddyfile.Unmarshaler = (*Encode)(nil)
|