go/imgproxy
1
0
Fork 0
mirror of https://github.com/imgproxy/imgproxy.git synced 2024-11-24 08:12:38 +02:00
Code Releases Activity

AVIF support detection & AVIF enforcement

Browse Source
This commit is contained in:
DarthSim 2021-01-18 21:56:36 +06:00
parent c6ec148516
commit bac349558c
4 changed files with 25 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config.go
View File

@ -233,6 +233,8 @@ type config struct {
EnableWebpDetection bool
EnforceWebp bool
EnableAvifDetection bool
EnforceAvif bool
EnableClientHints bool
SkipProcessingFormats []imageType
@ -389,6 +391,8 @@ func configure() error {
boolEnvConfig(&conf.EnableWebpDetection, "IMGPROXY_ENABLE_WEBP_DETECTION")
boolEnvConfig(&conf.EnforceWebp, "IMGPROXY_ENFORCE_WEBP")
boolEnvConfig(&conf.EnableAvifDetection, "IMGPROXY_ENABLE_AVIF_DETECTION")
boolEnvConfig(&conf.EnforceAvif, "IMGPROXY_ENFORCE_AVIF")
boolEnvConfig(&conf.EnableClientHints, "IMGPROXY_ENABLE_CLIENT_HINTS")
imageTypesEnvConfig(&conf.SkipProcessingFormats, "IMGPROXY_SKIP_PROCESSING_FORMATS")

10
docs/configuration.md
View File

@ -121,14 +121,18 @@ Also you may want imgproxy to respond with the same error message that it writes
* `IMGPROXY_GIF_OPTIMIZE_FRAMES`: <img class='pro-badge' src='assets/pro.svg' alt='pro' /> when true, enables GIF frames optimization. This may produce a smaller result, but may increase compression time.
* `IMGPROXY_GIF_OPTIMIZE_TRANSPARENCY`: <img class='pro-badge' src='assets/pro.svg' alt='pro' /> when true, enables GIF transparency optimization. This may produce a smaller result, but may increase compression time.
## WebP support detection
## AVIF/WebP support detection
imgproxy can use the `Accept` HTTP header to detect if the browser supports WebP and use it as the default format. This feature is disabled by default and can be enabled by the following options:
imgproxy can use the `Accept` HTTP header to detect if the browser supports AVIF or WebP and use it as the default format. This feature is disabled by default and can be enabled by the following options:
* `IMGPROXY_ENABLE_WEBP_DETECTION`: enables WebP support detection. When the file extension is omitted in the imgproxy URL and browser supports WebP, imgproxy will use it as the resulting format;
* `IMGPROXY_ENFORCE_WEBP`: enables WebP support detection and enforces WebP usage. If the browser supports WebP, it will be used as resulting format even if another extension is specified in the imgproxy URL.
* `IMGPROXY_ENABLE_AVIF_DETECTION`: enables AVIF support detection. When the file extension is omitted in the imgproxy URL and browser supports AVIF, imgproxy will use it as the resulting format;
* `IMGPROXY_ENFORCE_AVIF`: enables AVIF support detection and enforces AVIF usage. If the browser supports AVIF, it will be used as resulting format even if another extension is specified in the imgproxy URL.
When WebP support detection is enabled, please take care to configure your CDN or caching proxy to take the `Accept` HTTP header into account while caching.
**📝Note:** imgproxy prefers AVIF over WebP. This means that if both AVIF and WebP detection/enforcement are enabled and the browser supports both of them, AVIF will be used.
**📝Note:** When AVIF/WebP support detection is enabled, please take care to configure your CDN or caching proxy to take the `Accept` HTTP header into account while caching.
**⚠️Warning:** Headers cannot be signed. This means that an attacker can bypass your CDN cache by changing the `Accept` HTTP headers. Have this in mind when configuring your production caching setup.

9
process.go
View File

@ -742,8 +742,11 @@ func processImage(ctx context.Context) ([]byte, context.CancelFunc, error) {
po := getProcessingOptions(ctx)
imgdata := getImageData(ctx)
if po.Format == imageTypeUnknown {
switch {
case po.Format == imageTypeUnknown:
switch {
case po.PreferAvif && imageTypeSaveSupport(imageTypeAVIF):
po.Format = imageTypeAVIF
case po.PreferWebP && imageTypeSaveSupport(imageTypeWEBP):
po.Format = imageTypeWEBP
case imageTypeSaveSupport(imgdata.Type) && imageTypeGoodForWeb(imgdata.Type):
@ -751,7 +754,9 @@ func processImage(ctx context.Context) ([]byte, context.CancelFunc, error) {
default:
po.Format = imageTypeJPEG
}
} else if po.EnforceWebP && imageTypeSaveSupport(imageTypeWEBP) {
case po.EnforceAvif && imageTypeSaveSupport(imageTypeAVIF):
po.Format = imageTypeAVIF
case po.EnforceWebP && imageTypeSaveSupport(imageTypeWEBP):
po.Format = imageTypeWEBP
}

7
processing_options.go
View File

@ -154,6 +154,8 @@ type processingOptions struct {
PreferWebP bool
EnforceWebP bool
PreferAvif bool
EnforceAvif bool
Filename string
@ -1033,6 +1035,11 @@ func defaultProcessingOptions(headers *processingHeaders) (*processingOptions, e
po.EnforceWebP = conf.EnforceWebp
}
if strings.Contains(headers.Accept, "image/avif") {
po.PreferAvif = conf.EnableAvifDetection || conf.EnforceAvif
po.EnforceAvif = conf.EnforceAvif
}
if conf.EnableClientHints && len(headers.ViewportWidth) > 0 {
if vw, err := strconv.Atoi(headers.ViewportWidth); err == nil {
po.Width = vw