caddy/modules/caddyhttp/encode/brotli/brotli.go

70 lines
1.9 KiB
Go
Raw Normal View History

2019-07-01 06:07:58 +08:00
// 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 caddybrotli
import (
"fmt"
"github.com/andybalholm/brotli"
"github.com/caddyserver/caddy/v2"
"github.com/caddyserver/caddy/v2/modules/caddyhttp/encode"
)
func init() {
caddy.RegisterModule(caddy.Module{
Name: "http.encoders.brotli",
New: func() interface{} { return new(Brotli) },
})
}
// Brotli can create brotli encoders. Note that brotli
// is not known for great encoding performance.
type Brotli struct {
Quality *int `json:"quality,omitempty"`
}
// Validate validates b's configuration.
func (b Brotli) Validate() error {
if b.Quality != nil {
quality := *b.Quality
if quality < brotli.BestSpeed {
return fmt.Errorf("quality too low; must be >= %d", brotli.BestSpeed)
}
if quality > brotli.BestCompression {
return fmt.Errorf("quality too high; must be <= %d", brotli.BestCompression)
}
}
return nil
}
// AcceptEncoding returns the name of the encoding as
// used in the Accept-Encoding request headers.
func (Brotli) AcceptEncoding() string { return "br" }
// NewEncoder returns a new brotli writer.
func (b Brotli) NewEncoder() encode.Encoder {
quality := brotli.DefaultCompression
if b.Quality != nil {
quality = *b.Quality
}
return brotli.NewWriterLevel(nil, quality)
}
// Interface guards
var (
_ encode.Encoding = (*Brotli)(nil)
_ caddy.Validator = (*Brotli)(nil)
)