mirror of
https://github.com/caddyserver/caddy.git
synced 2025-01-06 22:40:31 -05:00
redir: Allows replacements; defaults to exact match redirects
This is a breaking change for those who expect catch-all redirects to preserve path; use {uri} variable explicitly now
This commit is contained in:
Matthew Holt
parent
04571ff393
commit
74b758034e
2 changed files with 80 additions and 102 deletions
|
|
@ -6,9 +6,6 @@ import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"html"
|
"html"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
|
||||||
"path"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/mholt/caddy/middleware"
|
"github.com/mholt/caddy/middleware"
|
||||||
)
|
)
|
||||||
|
|
@ -22,36 +19,13 @@ type Redirect struct {
|
||||||
// ServeHTTP implements the middleware.Handler interface.
|
// ServeHTTP implements the middleware.Handler interface.
|
||||||
func (rd Redirect) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) {
|
func (rd Redirect) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error) {
|
||||||
for _, rule := range rd.Rules {
|
for _, rule := range rd.Rules {
|
||||||
if rule.From == "/" {
|
if rule.From == "/" || r.URL.Path == rule.From {
|
||||||
// Catchall redirect preserves path and query string
|
to := middleware.NewReplacer(r, nil, "").Replace(rule.To)
|
||||||
toURL, err := url.Parse(rule.To)
|
|
||||||
if err != nil {
|
|
||||||
return http.StatusInternalServerError, err
|
|
||||||
}
|
|
||||||
newPath := path.Join(toURL.Host, toURL.Path, r.URL.Path)
|
|
||||||
if strings.HasSuffix(r.URL.Path, "/") {
|
|
||||||
newPath = newPath + "/"
|
|
||||||
}
|
|
||||||
newPath = toURL.Scheme + "://" + newPath
|
|
||||||
parameters := toURL.Query()
|
|
||||||
for k, v := range r.URL.Query() {
|
|
||||||
parameters.Set(k, v[0])
|
|
||||||
}
|
|
||||||
if len(parameters) > 0 {
|
|
||||||
newPath = newPath + "?" + parameters.Encode()
|
|
||||||
}
|
|
||||||
if rule.Meta {
|
if rule.Meta {
|
||||||
fmt.Fprintf(w, metaRedir, html.EscapeString(newPath))
|
safeTo := html.EscapeString(to)
|
||||||
|
fmt.Fprintf(w, metaRedir, safeTo, safeTo)
|
||||||
} else {
|
} else {
|
||||||
http.Redirect(w, r, newPath, rule.Code)
|
http.Redirect(w, r, to, rule.Code)
|
||||||
}
|
|
||||||
return 0, nil
|
|
||||||
}
|
|
||||||
if r.URL.Path == rule.From {
|
|
||||||
if rule.Meta {
|
|
||||||
fmt.Fprintf(w, metaRedir, html.EscapeString(rule.To))
|
|
||||||
} else {
|
|
||||||
http.Redirect(w, r, rule.To, rule.Code)
|
|
||||||
}
|
}
|
||||||
return 0, nil
|
return 0, nil
|
||||||
}
|
}
|
||||||
|
|
@ -66,9 +40,13 @@ type Rule struct {
|
||||||
Meta bool
|
Meta bool
|
||||||
}
|
}
|
||||||
|
|
||||||
var metaRedir = `<html>
|
// Script tag comes first since that will better imitate a redirect in the browser's
|
||||||
<head>
|
// history, but the meta tag is a fallback for most non-JS clients.
|
||||||
<meta http-equiv="refresh" content="0;URL='%s'">
|
const metaRedir = `<!DOCTYPE html>
|
||||||
</head>
|
<html>
|
||||||
<body>redirecting...</body>
|
<head>
|
||||||
|
<script>window.location.replace("%s");</script>
|
||||||
|
<meta http-equiv="refresh" content="0; URL='%s'">
|
||||||
|
</head>
|
||||||
|
<body>Redirecting...</body>
|
||||||
</html>`
|
</html>`
|
||||||
|
|
|
||||||
|
|
@ -10,72 +10,6 @@ import (
|
||||||
"github.com/mholt/caddy/middleware"
|
"github.com/mholt/caddy/middleware"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestMetaRedirect(t *testing.T) {
|
|
||||||
re := Redirect{
|
|
||||||
Rules: []Rule{
|
|
||||||
{From: "/", Meta: true, To: "https://example.com/"},
|
|
||||||
{From: "/whatever", Meta: true, To: "https://example.com/whatever"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for i, test := range re.Rules {
|
|
||||||
req, err := http.NewRequest("GET", test.From, nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Test %d: Could not create HTTP request: %v", i, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
re.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
body, err := ioutil.ReadAll(rec.Body)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Test %d: Could not read HTTP response body: %v", i, err)
|
|
||||||
}
|
|
||||||
expectedSnippet := `<meta http-equiv="refresh" content="0;URL='` + test.To + `'">`
|
|
||||||
if !bytes.Contains(body, []byte(expectedSnippet)) {
|
|
||||||
t.Errorf("Test %d: Expected Response Body to contain %q but was %q",
|
|
||||||
i, expectedSnippet, body)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestParametersRedirect(t *testing.T) {
|
|
||||||
re := Redirect{
|
|
||||||
Rules: []Rule{
|
|
||||||
{From: "/", Meta: false, To: "http://example.com/"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err := http.NewRequest("GET", "/a?b=c", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Test: Could not create HTTP request: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
rec := httptest.NewRecorder()
|
|
||||||
re.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if "http://example.com/a?b=c" != rec.Header().Get("Location") {
|
|
||||||
t.Fatalf("Test: expected location header %q but was %q", "http://example.com/a?b=c", rec.Header().Get("Location"))
|
|
||||||
}
|
|
||||||
|
|
||||||
re = Redirect{
|
|
||||||
Rules: []Rule{
|
|
||||||
{From: "/", Meta: false, To: "http://example.com/a?b=c"},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err = http.NewRequest("GET", "/d?e=f", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Test: Could not create HTTP request: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
re.ServeHTTP(rec, req)
|
|
||||||
|
|
||||||
if "http://example.com/a/d?b=c&e=f" != rec.Header().Get("Location") {
|
|
||||||
t.Fatalf("Test: expected location header %q but was %q", "http://example.com/a/d?b=c&e=f", rec.Header().Get("Location"))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRedirect(t *testing.T) {
|
func TestRedirect(t *testing.T) {
|
||||||
for i, test := range []struct {
|
for i, test := range []struct {
|
||||||
from string
|
from string
|
||||||
|
|
@ -121,3 +55,69 @@ func TestRedirect(t *testing.T) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestParametersRedirect(t *testing.T) {
|
||||||
|
re := Redirect{
|
||||||
|
Rules: []Rule{
|
||||||
|
{From: "/", Meta: false, To: "http://example.com{uri}"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequest("GET", "/a?b=c", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Test: Could not create HTTP request: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
re.ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if rec.Header().Get("Location") != "http://example.com/a?b=c" {
|
||||||
|
t.Fatalf("Test: expected location header %q but was %q", "http://example.com/a?b=c", rec.Header().Get("Location"))
|
||||||
|
}
|
||||||
|
|
||||||
|
re = Redirect{
|
||||||
|
Rules: []Rule{
|
||||||
|
{From: "/", Meta: false, To: "http://example.com/a{path}?b=c&{query}"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err = http.NewRequest("GET", "/d?e=f", nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Test: Could not create HTTP request: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
re.ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
if "http://example.com/a/d?b=c&e=f" != rec.Header().Get("Location") {
|
||||||
|
t.Fatalf("Test: expected location header %q but was %q", "http://example.com/a/d?b=c&e=f", rec.Header().Get("Location"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMetaRedirect(t *testing.T) {
|
||||||
|
re := Redirect{
|
||||||
|
Rules: []Rule{
|
||||||
|
{From: "/whatever", Meta: true, To: "/something"},
|
||||||
|
{From: "/", Meta: true, To: "https://example.com/"},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for i, test := range re.Rules {
|
||||||
|
req, err := http.NewRequest("GET", test.From, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Test %d: Could not create HTTP request: %v", i, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
re.ServeHTTP(rec, req)
|
||||||
|
|
||||||
|
body, err := ioutil.ReadAll(rec.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Test %d: Could not read HTTP response body: %v", i, err)
|
||||||
|
}
|
||||||
|
expectedSnippet := `<meta http-equiv="refresh" content="0; URL='` + test.To + `'">`
|
||||||
|
if !bytes.Contains(body, []byte(expectedSnippet)) {
|
||||||
|
t.Errorf("Test %d: Expected Response Body to contain %q but was %q",
|
||||||
|
i, expectedSnippet, body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue