Skip to content

Commit

Permalink
🚀 Added possibility to work with urlencoded special characters in the…
Browse files Browse the repository at this point in the history
… route
  • Loading branch information
ReneWerner87 committed Jun 25, 2020
1 parent 09e9915 commit cf4836c
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
5 changes: 5 additions & 0 deletions app.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ type Settings struct {
// Default: false
Immutable bool

// Converts all encoded characters in the route back before setting the path for the context,
// so that the routing can also work with urlencoded special characters
// Default: false
UnescapePath bool

// Enable or disable ETag header generation, since both weak and strong etags are generated
// using the same hashing method (CRC-32). Weak ETags are the default when enabled.
// Default value false
Expand Down
8 changes: 7 additions & 1 deletion ctx.go
Original file line number Diff line number Diff line change
Expand Up @@ -987,10 +987,16 @@ func (ctx *Ctx) XHR() bool {

// prettifyPath ...
func (ctx *Ctx) prettifyPath() {
// If UnescapePath enabled, we decode the path
if ctx.app.Settings.UnescapePath {
pathBytes := getBytes(ctx.path)
pathBytes = fasthttp.AppendUnquotedArg(pathBytes[:0], pathBytes)
ctx.path = getString(pathBytes)
}
// If CaseSensitive is disabled, we lowercase the original path
if !ctx.app.Settings.CaseSensitive {
// We are making a copy here to keep access to the original path
ctx.path = utils.ToLower(ctx.pathOriginal)
ctx.path = utils.ToLower(ctx.path)
}
// If StrictRouting is disabled, we strip all trailing slashes
if !ctx.app.Settings.StrictRouting && len(ctx.path) > 1 && ctx.path[len(ctx.path)-1] == '/' {
Expand Down
22 changes: 22 additions & 0 deletions router_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,28 @@ func Test_Route_Match_Middleware(t *testing.T) {
utils.AssertEqual(t, "bar/fasel", getString(body))
}

func Test_Route_Match_UnescapedPath(t *testing.T) {
app := New(&Settings{UnescapePath: true})

app.Use("/créer", func(ctx *Ctx) {
ctx.Send("test")
})

resp, err := app.Test(httptest.NewRequest(MethodGet, "/cr%C3%A9er", nil))
utils.AssertEqual(t, nil, err, "app.Test(req)")
utils.AssertEqual(t, StatusOK, resp.StatusCode, "Status code")

body, err := ioutil.ReadAll(resp.Body)
utils.AssertEqual(t, nil, err, "app.Test(req)")
utils.AssertEqual(t, "test", getString(body))

// check deactivated behavior
app.Settings.UnescapePath = false
resp, err = app.Test(httptest.NewRequest(MethodGet, "/cr%C3%A9er", nil))
utils.AssertEqual(t, nil, err, "app.Test(req)")
utils.AssertEqual(t, StatusNotFound, resp.StatusCode, "Status code")
}

func Test_Route_Match_Middleware_HasPrefix(t *testing.T) {
app := New()

Expand Down

0 comments on commit cf4836c

Please sign in to comment.