From b8e7453fef3dac6036403bc384eec96becff5114 Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Thu, 13 Jun 2019 11:20:43 -0600
Subject: Implement brotli encoder; improve validation of other encoders

---
 modules/caddyhttp/encode/brotli/brotli.go | 51 +++++++++++++++++++++++++++++++
 modules/caddyhttp/encode/gzip/gzip.go     | 29 +++++++++++++++---
 modules/caddyhttp/encode/zstd/zstd.go     |  5 ++-
 3 files changed, 80 insertions(+), 5 deletions(-)
 create mode 100644 modules/caddyhttp/encode/brotli/brotli.go

(limited to 'modules/caddyhttp')

diff --git a/modules/caddyhttp/encode/brotli/brotli.go b/modules/caddyhttp/encode/brotli/brotli.go
new file mode 100644
index 0000000..3289f0c
--- /dev/null
+++ b/modules/caddyhttp/encode/brotli/brotli.go
@@ -0,0 +1,51 @@
+package caddybrotli
+
+import (
+	"fmt"
+
+	"github.com/andybalholm/brotli"
+	"github.com/caddyserver/caddy2"
+	"github.com/caddyserver/caddy2/modules/caddyhttp/encode"
+)
+
+func init() {
+	caddy2.RegisterModule(caddy2.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
+}
+
+// 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)
+	_ caddy2.Validator = (*Brotli)(nil)
+)
diff --git a/modules/caddyhttp/encode/gzip/gzip.go b/modules/caddyhttp/encode/gzip/gzip.go
index 0da5fc3..b08385a 100644
--- a/modules/caddyhttp/encode/gzip/gzip.go
+++ b/modules/caddyhttp/encode/gzip/gzip.go
@@ -3,6 +3,7 @@ package caddygzip
 import (
 	"compress/flate"
 	"compress/gzip" // TODO: consider using https://github.com/klauspost/compress/gzip
+	"fmt"
 
 	"github.com/caddyserver/caddy2"
 	"github.com/caddyserver/caddy2/modules/caddyhttp/encode"
@@ -20,17 +21,37 @@ type Gzip struct {
 	Level int `json:"level,omitempty"`
 }
 
-// NewEncoder returns a new gzip writer.
-func (g Gzip) NewEncoder() encode.Encoder {
-	if g.Level <= flate.NoCompression {
+// Provision provisions g's configuration.
+func (g *Gzip) Provision(ctx caddy2.Context) error {
+	if g.Level == 0 {
 		g.Level = defaultGzipLevel
 	}
+	return nil
+}
+
+// Validate validates g's configuration.
+func (g Gzip) Validate() error {
+	if g.Level < flate.NoCompression {
+		return fmt.Errorf("quality too low; must be >= %d", flate.NoCompression)
+	}
 	if g.Level > flate.BestCompression {
-		g.Level = flate.BestCompression
+		return fmt.Errorf("quality too high; must be <= %d", flate.BestCompression)
 	}
+	return nil
+}
+
+// NewEncoder returns a new gzip writer.
+func (g Gzip) NewEncoder() encode.Encoder {
 	writer, _ := gzip.NewWriterLevel(nil, g.Level)
 	return writer
 }
 
 // Informed from http://blog.klauspost.com/gzip-performance-for-go-webservers/
 var defaultGzipLevel = 5
+
+// Interface guards
+var (
+	_ encode.Encoding    = (*Gzip)(nil)
+	_ caddy2.Provisioner = (*Gzip)(nil)
+	_ caddy2.Validator   = (*Gzip)(nil)
+)
diff --git a/modules/caddyhttp/encode/zstd/zstd.go b/modules/caddyhttp/encode/zstd/zstd.go
index 6afe53e..eb66ad8 100644
--- a/modules/caddyhttp/encode/zstd/zstd.go
+++ b/modules/caddyhttp/encode/zstd/zstd.go
@@ -1,4 +1,4 @@
-package caddystd
+package caddyzstd
 
 import (
 	"github.com/caddyserver/caddy2"
@@ -21,3 +21,6 @@ func (z Zstd) NewEncoder() encode.Encoder {
 	writer, _ := zstd.NewWriter(nil)
 	return writer
 }
+
+// Interface guard
+var _ encode.Encoding = (*Zstd)(nil)
-- 
cgit v1.2.3