Cutlery/caddy
1
0
Fork 0
mirror of https://github.com/caddyserver/caddy.git synced 2025-07-08 18:55:03 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

httpcaddyfile: Unify strip_prefix, strip_suffix, uri_replace directives (#3157)

Browse Source 
* rewrite: strip_prefix, strip_suffix, uri_replace -> uri (closes #3140)

* Add period, to satisfy @whitestrake :) and my own OCD

* Restore implied / prefix
This commit is contained in:
Matt Holt 2020-03-19 11:51:28 -06:00 committed by GitHub
parent 31c6ac097e
commit aa6c5fde07
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 53 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
caddyconfig/httpcaddyfile/directives.go
View File

@ -33,9 +33,7 @@ var directiveOrder = []string{
"root", "root",
"strip_prefix", "uri",
"strip_suffix",
"uri_replace",
"try_files", "try_files",
// middleware handlers that typically wrap responses // middleware handlers that typically wrap responses

85
modules/caddyhttp/rewrite/caddyfile.go
View File

@ -24,9 +24,7 @@ import (
func init() { func init() {
httpcaddyfile.RegisterHandlerDirective("rewrite", parseCaddyfileRewrite) httpcaddyfile.RegisterHandlerDirective("rewrite", parseCaddyfileRewrite)
httpcaddyfile.RegisterHandlerDirective("strip_prefix", parseCaddyfileStripPrefix) httpcaddyfile.RegisterHandlerDirective("uri", parseCaddyfileURI)
httpcaddyfile.RegisterHandlerDirective("strip_suffix", parseCaddyfileStripSuffix)
httpcaddyfile.RegisterHandlerDirective("uri_replace", parseCaddyfileURIReplace)
} }
// parseCaddyfileRewrite sets up a basic rewrite handler from Caddyfile tokens. Syntax: // parseCaddyfileRewrite sets up a basic rewrite handler from Caddyfile tokens. Syntax:
@ -49,68 +47,45 @@ func parseCaddyfileRewrite(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler,
return rewr, nil return rewr, nil
} }
// parseCaddyfileStripPrefix sets up a handler from Caddyfile tokens. Syntax: // parseCaddyfileURI sets up a handler for manipulating (but not "rewriting") the
// URI from Caddyfile tokens. Syntax:
// //
// strip_prefix [<matcher>] <prefix> // uri [<matcher>] strip_prefix|strip_suffix|replace <target> [<replacement> [<limit>]]
// //
// The request path will be stripped the given prefix. // If strip_prefix or strip_suffix are used, then <target> will be stripped
func parseCaddyfileStripPrefix(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) { // only if it is the beginning or the end, respectively, of the URI path. If
// replace is used, then <target> will be replaced with <replacement> across
// the whole URI, up to <limit> times (or unlimited if unspecified).
func parseCaddyfileURI(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
var rewr Rewrite var rewr Rewrite
for h.Next() { for h.Next() {
if !h.NextArg() { args := h.RemainingArgs()
if len(args) < 2 {
return nil, h.ArgErr() return nil, h.ArgErr()
} }
rewr.StripPathPrefix = h.Val() switch args[0] {
case "strip_prefix":
if len(args) > 2 {
return nil, h.ArgErr()
}
rewr.StripPathPrefix = args[1]
if !strings.HasPrefix(rewr.StripPathPrefix, "/") { if !strings.HasPrefix(rewr.StripPathPrefix, "/") {
rewr.StripPathPrefix = "/" + rewr.StripPathPrefix rewr.StripPathPrefix = "/" + rewr.StripPathPrefix
} }
if h.NextArg() { case "strip_suffix":
if len(args) > 2 {
return nil, h.ArgErr() return nil, h.ArgErr()
} }
} rewr.StripPathSuffix = args[1]
return rewr, nil case "replace":
}
// parseCaddyfileStripSuffix sets up a handler from Caddyfile tokens. Syntax:
//
// strip_suffix [<matcher>] <suffix>
//
// The request path will be stripped the given suffix.
func parseCaddyfileStripSuffix(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
var rewr Rewrite
for h.Next() {
if !h.NextArg() {
return nil, h.ArgErr()
}
rewr.StripPathSuffix = h.Val()
if h.NextArg() {
return nil, h.ArgErr()
}
}
return rewr, nil
}
// parseCaddyfileURIReplace sets up a handler from Caddyfile tokens. Syntax:
//
// uri_replace [<matcher>] <find> <replace> [<limit>]
//
// Substring replacements will be performed on the request URI up to the
// number specified by limit, if any (default = 0, or no limit).
func parseCaddyfileURIReplace(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
var rewr Rewrite
var repls []replacer
for h.Next() {
args := h.RemainingArgs()
var find, replace, lim string var find, replace, lim string
switch len(args) { switch len(args) {
case 3: case 4:
lim = args[2] lim = args[3]
fallthrough fallthrough
case 2: case 3:
find = args[0] find = args[1]
replace = args[1] replace = args[2]
default: default:
return nil, h.ArgErr() return nil, h.ArgErr()
} }
@ -124,14 +99,14 @@ func parseCaddyfileURIReplace(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandl
} }
} }
repls = append(repls, replacer{ rewr.URISubstring = append(rewr.URISubstring, replacer{
Find: find, Find: find,
Replace: replace, Replace: replace,
Limit: limInt, Limit: limInt,
}) })
default:
return nil, h.Errf("unrecognized URI manipulation '%s'", args[0])
}
} }
rewr.URISubstring = repls
return rewr, nil return rewr, nil
} }