mirror of
https://github.com/caddyserver/caddy.git
synced 2025-11-04 03:27:23 -05:00
03e0a010d1
* Add zstd compression level support * Refactored zstd levels to string arguments fastest, default, better, best * Add comment with list of all available levels * Corrected data types for config --------- Co-authored-by: Evgeny Blinov <e.a.blinov@gmail.com> Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
109 lines
3.0 KiB
Go
109 lines
3.0 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 caddyzstd
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/klauspost/compress/zstd"
|
|
|
|
"github.com/caddyserver/caddy/v2"
|
|
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
|
|
"github.com/caddyserver/caddy/v2/modules/caddyhttp/encode"
|
|
)
|
|
|
|
func init() {
|
|
caddy.RegisterModule(Zstd{})
|
|
}
|
|
|
|
// Zstd can create Zstandard encoders.
|
|
type Zstd struct {
|
|
// The compression level. Accepted values: fastest, better, best, default.
|
|
Level string `json:"level,omitempty"`
|
|
|
|
// Compression level refer to type constants value from zstd.SpeedFastest to zstd.SpeedBestCompression
|
|
level zstd.EncoderLevel
|
|
}
|
|
|
|
// CaddyModule returns the Caddy module information.
|
|
func (Zstd) CaddyModule() caddy.ModuleInfo {
|
|
return caddy.ModuleInfo{
|
|
ID: "http.encoders.zstd",
|
|
New: func() caddy.Module { return new(Zstd) },
|
|
}
|
|
}
|
|
|
|
// UnmarshalCaddyfile sets up the handler from Caddyfile tokens.
|
|
func (z *Zstd) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
|
|
d.Next() // consume option name
|
|
if !d.NextArg() {
|
|
return nil
|
|
}
|
|
levelStr := d.Val()
|
|
if ok, _ := zstd.EncoderLevelFromString(levelStr); !ok {
|
|
return d.Errf("unexpected compression level, use one of '%s', '%s', '%s', '%s'",
|
|
zstd.SpeedFastest,
|
|
zstd.SpeedBetterCompression,
|
|
zstd.SpeedBestCompression,
|
|
zstd.SpeedDefault,
|
|
)
|
|
}
|
|
z.Level = levelStr
|
|
return nil
|
|
}
|
|
|
|
// Provision provisions z's configuration.
|
|
func (z *Zstd) Provision(ctx caddy.Context) error {
|
|
if z.Level == "" {
|
|
z.Level = zstd.SpeedDefault.String()
|
|
}
|
|
var ok bool
|
|
if ok, z.level = zstd.EncoderLevelFromString(z.Level); !ok {
|
|
return fmt.Errorf("unexpected compression level, use one of '%s', '%s', '%s', '%s'",
|
|
zstd.SpeedFastest,
|
|
zstd.SpeedDefault,
|
|
zstd.SpeedBetterCompression,
|
|
zstd.SpeedBestCompression,
|
|
)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// AcceptEncoding returns the name of the encoding as
|
|
// used in the Accept-Encoding request headers.
|
|
func (Zstd) AcceptEncoding() string { return "zstd" }
|
|
|
|
// NewEncoder returns a new Zstandard writer.
|
|
func (z Zstd) NewEncoder() encode.Encoder {
|
|
// The default of 8MB for the window is
|
|
// too large for many clients, so we limit
|
|
// it to 128K to lighten their load.
|
|
writer, _ := zstd.NewWriter(
|
|
nil,
|
|
zstd.WithWindowSize(128<<10),
|
|
zstd.WithEncoderConcurrency(1),
|
|
zstd.WithZeroFrames(true),
|
|
zstd.WithEncoderLevel(z.level),
|
|
)
|
|
return writer
|
|
}
|
|
|
|
// Interface guards
|
|
var (
|
|
_ encode.Encoding = (*Zstd)(nil)
|
|
_ caddyfile.Unmarshaler = (*Zstd)(nil)
|
|
_ caddy.Provisioner = (*Zstd)(nil)
|
|
)
|