diff options
| author | Loïc Hoguin <[email protected]> | 2014-09-23 16:43:29 +0300 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2014-09-23 16:43:29 +0300 |
| commit | f1c3b6d76f0c97e1ab927c288bb94891ae4c253b (patch) | |
| tree | 5a14c007cdcb487032162b3ca96df648f521321a | |
| parent | b57f94661f5fd186f55eb0fead49849e0b1399d1 (diff) | |
| download | cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.tar.gz cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.tar.bz2 cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.zip | |
Breaking update of the cowboy_req interface
Simplify the interface for most cowboy_req functions. They all return
a single value except the four body reading functions. The reply functions
now only return a Req value.
Access functions do not return a Req anymore.
Functions that used to cache results do not have a cache anymore.
The interface for accessing query string and cookies has therefore
been changed.
There are now three query string functions: qs/1 provides access
to the raw query string value; parse_qs/1 returns the query string
as a list of key/values; match_qs/2 returns a map containing the
values requested in the second argument, after applying constraints
and default value.
Similarly, there are two cookie functions: parse_cookies/1 and
match_cookies/2. More match functions will be added in future commits.
None of the functions return an error tuple anymore. It either works
or crashes. Cowboy will attempt to provide an appropriate status code
in the response of crashed handlers.
As a result, the content decode function has its return value changed
to a simple binary, and the body reading functions only return on success.
61 files changed, 820 insertions, 773 deletions
@@ -20,38 +20,6 @@ A number of backward incompatible changes are planned. These changes are individually small, but together should result in a large improvement in usability. -### cowboy_req - -The interface of `cowboy_req` will be largely changed. The -number one complaint about Cowboy today is that you have -to keep track of the Req whenever you do anything. The new -interface will minimize that. - -All functions will return a single term, excluding the body -reading functions `body/{1,2}`, `body_qs/{1,2}`, `part/{1,2}`, -`part_body/{1,2}`. - -Of the functions returning a single term, some of them will -return a Req object. This includes the functions that already -return Req: `compact/1`, `delete_resp_header/2`, `set_meta/3`, -`set_resp_body/2`, `set_resp_body_fun/{2,3}`, `set_resp_cookie/4`, -`set_resp_header/3`, and adds the `chunked_reply/{2,3}` and -`reply/{2,3,4}` functions to the list. - -Of note is that this will allow chaining all the response -functions if that's what you fancy. - -The `parse_header/{2,3}` function will now only return the -parsed header value, and crash on error. It will also not -cache the parsed value anymore, except for headers that Cowboy -requires, like the connection header. - -It is unsure what will become of the `qs_val`, `qs_vals`, -`cookie` and `cookies` functions. The main idea at this point -is to replace them with a `parse_qs/2` and `parse_cookies/2` -that would return the parsed list, and let the user decide -how to access it. - ### init/terminate unification The first argument of the `init/3` function is too rarely used. diff --git a/doc/src/guide/broken_clients.ezdoc b/doc/src/guide/broken_clients.ezdoc index 26568a3..c508358 100644 --- a/doc/src/guide/broken_clients.ezdoc +++ b/doc/src/guide/broken_clients.ezdoc @@ -28,8 +28,7 @@ that will format the header names with the expected case. capitalize_hook(Status, Headers, Body, Req) -> Headers2 = [{cowboy_bstr:capitalize_token(N), V} || {N, V} <- Headers], - {ok, Req2} = cowboy_req:reply(Status, Headers2, Body, Req), - Req2. + cowboy_req:reply(Status, Headers2, Body, Req). ``` Note that SPDY clients do not have that particular issue diff --git a/doc/src/guide/constraints.ezdoc b/doc/src/guide/constraints.ezdoc new file mode 100644 index 0000000..a05f489 --- /dev/null +++ b/doc/src/guide/constraints.ezdoc @@ -0,0 +1,51 @@ +::: Constraints + +Cowboy provides an optional constraints based validation feature +when interacting with user input. + +Constraints are first used during routing. The router uses +constraints to more accurately match bound values, allowing +to create routes where a segment is an integer for example, +and rejecting the others. + +Constraints are also used when performing a match operation +on input data, like the query string or cookies. There, a +default value can also be provided for optional values. + +Finally, constraints can be used to not only validate input, +but also convert said input into proper Erlang terms, all in +one step. + +:: Structure + +Constraints are provided as a list of fields and for each +field a list of constraints for that field can be provided. + +Fields are either the name of the field; the name and +one or more constraints; or the name, one or more constraints +and a default value. + +When no default value is provided then the field is required. +Otherwise the default value is used. + +All constraints for a field will be used to match its value +in the order they are given. If the value is modified by a +constraint, the next constraint receives the updated value. + +:: Built-in constraints + +|| Constraint Description +| +| int Convert binary value to integer +| nonempty Ensures the binary value is non-empty + +:: Custom constraint + +In addition to the predefined constraints, Cowboy will accept +a fun. This fun must accept one argument and return one of +`true`, `{true, NewValue}` or `false`. The result indicates +whether the value matches the constraint, and if it does it +can optionally be modified. This allows converting the value +to a more appropriate Erlang term. + +Note that constraint functions SHOULD be pure and MUST NOT crash. diff --git a/doc/src/guide/cookies.ezdoc b/doc/src/guide/cookies.ezdoc index fe9246c..459d4d8 100644 --- a/doc/src/guide/cookies.ezdoc +++ b/doc/src/guide/cookies.ezdoc @@ -116,22 +116,47 @@ As we said, the client sends cookies with every request. But unlike the server, the client only sends the cookie name and value. -You can read the value of a cookie. +Cowboy provides two different ways to read cookies. You +can either parse them as a list of key/value pairs, or +match them into a map, optionally applying constraints +to the values or providing a default if they are missing. + +You can parse the cookies and then use standard library +functions to access individual values. + +``` erlang +Cookies = cowboy_req:parse_cookies(Req), +{_, Lang} = lists:keyfind(<<"lang">>, 1, Cookies). +``` + +You can match the cookies into a map. ``` erlang -{CookieVal, Req2} = cowboy_req:cookie(<<"lang">>, Req). +#{id := ID, lang := Lang} = cowboy_req:match_cookies(Req, [id, lang]). ``` -You can also get a default value returned when the cookie -isn't set. +You can use constraints to validate the values while matching +them. The following snippet will crash if the `id` cookie is +not an integer number or if the `lang` cookie is empty. Additionally +the `id` cookie value will be converted to an integer term, saving +you a conversion step. ``` erlang -{CookieVal, Req2} = cowboy_req:cookie(<<"lang">>, Req, <<"fr">>). +CookiesMap = cowboy_req:match_cookies(Req, [{id, int}, {lang, nonempty}]). ``` -And you can obtain all cookies at once as a list of -key/value tuples. +Note that if two cookies share the same name, then the map value +will be a list of the two cookie values. + +Read more about ^constraints^. + +A default value can be provided. The default will be used +if the `lang` cookie is not found. It will not be used if +the cookie is found but has an empty value. ``` erlang -{AllCookies, Req2} = cowboy_req:cookies(Req). +#{lang := Lang} = cowboy_req:match_cookies(Req, [{lang, [], <<"en-US">>}]). ``` + +If no default is provided and the value is missing, the +query string is deemed invalid and the process will crash. diff --git a/doc/src/guide/getting_started.ezdoc b/doc/src/guide/getting_started.ezdoc index f0a701d..34f02dc 100644 --- a/doc/src/guide/getting_started.ezdoc +++ b/doc/src/guide/getting_started.ezdoc @@ -154,7 +154,7 @@ the `handle/2` function like this to send a reply. ``` erlang handle(Req, State=#state{}) -> - {ok, Req2} = cowboy_req:reply(200, + Req2 = cowboy_req:reply(200, [{<<"content-type">>, <<"text/plain">>}], <<"Hello Erlang!">>, Req), diff --git a/doc/src/guide/hooks.ezdoc b/doc/src/guide/hooks.ezdoc index edef971..e835a6f 100644 --- a/doc/src/guide/hooks.ezdoc +++ b/doc/src/guide/hooks.ezdoc @@ -73,8 +73,7 @@ custom_404_hook(404, Headers, <<>>, Req) -> Body = <<"404 Not Found.">>, Headers2 = lists:keyreplace(<<"content-length">>, 1, Headers, {<<"content-length">>, integer_to_list(byte_size(Body))}), - {ok, Req2} = cowboy_req:reply(404, Headers2, Body, Req), - Req2; + cowboy_req:reply(404, Headers2, Body, Req); custom_404_hook(_, _, _, Req) -> Req. ``` diff --git a/doc/src/guide/http_handlers.ezdoc b/doc/src/guide/http_handlers.ezdoc index 9a450a6..9c6e41d 100644 --- a/doc/src/guide/http_handlers.ezdoc +++ b/doc/src/guide/http_handlers.ezdoc @@ -61,7 +61,7 @@ continue with the handler code, so we use the init(_Type, Req, Opts) -> case lists:keyfind(lang, 1, Opts) of false -> - {ok, Req2} = cowboy_req:reply(500, [ + Req2 = cowboy_req:reply(500, [ {<<"content-type">>, <<"text/plain">>} ], "Missing option 'lang'.", Req), {shutdown, Req2, no_state}; @@ -110,7 +110,7 @@ The following handle function will send a fairly original response. ``` erlang handle(Req, State) -> - {ok, Req2} = cowboy_req:reply(200, [ + Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/plain">>} ], <<"Hello World!">>, Req), {ok, Req2, State}. diff --git a/doc/src/guide/http_req_life.ezdoc b/doc/src/guide/http_req_life.ezdoc index 5fd8486..ffe5dfa 100644 --- a/doc/src/guide/http_req_life.ezdoc +++ b/doc/src/guide/http_req_life.ezdoc @@ -80,7 +80,7 @@ as the reply is sent. This snippet will force Cowboy to close the connection. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"connection">>, <<"close">>}, ], <<"Closing the socket in 3.. 2.. 1..">>, Req). ``` diff --git a/doc/src/guide/index.ezdoc b/doc/src/guide/index.ezdoc index 38b2ac0..300cea8 100644 --- a/doc/src/guide/index.ezdoc +++ b/doc/src/guide/index.ezdoc @@ -15,6 +15,7 @@ best use of Cowboy for writing powerful web applications. * ^"The life of a request^http_req_life * ^"Routing^routing +* ^"Constraints^constraints * ^"Handling plain HTTP requests^http_handlers * ^"The Req object^req * ^"Reading the request body^req_body diff --git a/doc/src/guide/loop_handlers.ezdoc b/doc/src/guide/loop_handlers.ezdoc index fba4feb..b1c033f 100644 --- a/doc/src/guide/loop_handlers.ezdoc +++ b/doc/src/guide/loop_handlers.ezdoc @@ -60,7 +60,7 @@ message otherwise. ``` erlang info({reply, Body}, Req, State) -> - {ok, Req2} = cowboy_req:reply(200, [], Body, Req), + Req2 = cowboy_req:reply(200, [], Body, Req), {ok, Req2, State}; info(_Msg, Req, State) -> {loop, Req, State, hibernate}. @@ -95,13 +95,13 @@ and the loop is stopped by sending an `eof` message. ``` erlang init(_Type, Req, _Opts) -> - {ok, Req2} = cowboy_req:chunked_reply(200, [], Req), + Req2 = cowboy_req:chunked_reply(200, [], Req), {loop, Req2, undefined_state}. info(eof, Req, State) -> {ok, Req, State}; info({chunk, Chunk}, Req, State) -> - ok = cowboy_req:chunk(Chunk, Req), + cowboy_req:chunk(Chunk, Req), {loop, Req, State}; info(_Msg, Req, State) -> {loop, Req, State}. diff --git a/doc/src/guide/multipart_req.ezdoc b/doc/src/guide/multipart_req.ezdoc index a807e48..21762f6 100644 --- a/doc/src/guide/multipart_req.ezdoc +++ b/doc/src/guide/multipart_req.ezdoc @@ -17,7 +17,7 @@ You can quickly figure out if a multipart message has been sent by parsing the `content-type` header. ``` erlang -{ok, {<<"multipart">>, <<"form-data">>, _}, Req2} +{<<"multipart">>, <<"form-data">>, _} = cowboy_req:parse_header(<<"content-type">>, Req). ``` diff --git a/doc/src/guide/req.ezdoc b/doc/src/guide/req.ezdoc index 9501158..1349af3 100644 --- a/doc/src/guide/req.ezdoc +++ b/doc/src/guide/req.ezdoc @@ -27,47 +27,22 @@ For example, when streaming the request body, the function will return the body by chunks, one at a time, until there is none left. -It also caches the result of operations performed -on the immutable state. That means that some calls -will give a result much faster when called many times. - :: Overview of the cowboy_req interface -The `cowboy_req` interface is divided in four groups -of functions, each having a well defined return type -signature common to the entire group. - -The first group, access functions, will always return -`{Value, Req}`. The group includes all the following -functions: `binding/{2,3}`, `bindings/1`, `body_length/1`, -`cookie/{2,3}`, `cookies/1`, `header/{2,3}`, `headers/1`, -`host/1`, `host_info/1`, `host_url/1`, `meta/{2,3}`, -`method/1`, `path/1`, `path_info/1`, `peer/1`, `port/1`, -`qs/1`, `qs_val/{2,3}`, `qs_vals/1`, `url/1`, `version/1`. - -The second group, question functions, will always return -a `boolean()`. The group includes the following three -functions: `has_body/1`, `has_resp_body/1`, `has_resp_header/2`. - -The third group contains the functions that manipulate -the socket or perform operations that may legitimately fail. -They may return `{Result, Req}`, `{Result, Value, Req}` -or `{error, atom()}`. This includes the following functions: -`body/{1,2}`, `body_qs/{1,2}`, `chunked_reply/{2,3}`, -`parse_header/{2,3}`, `part/{1,2}`, `part_body/{1,2}` -and `reply/{2,3,4}`. Finally, the group also includes the -`chunk/2` and `continue/1` functions which always return `ok`. - -The final group modifies the Req object state without -performing any immediate operations. As these functions -can't fail, they always return a new `Req` directly. -This includes the following functions: `compact/1`, -`delete_resp_header/2`, `set_meta/3`, `set_resp_body/2`, -`set_resp_body_fun/{2,3}`, `set_resp_cookie/4`, `set_resp_header/3`. - -This chapter covers most of the first group, plus a few other -functions. The next few chapters cover cookies handling, reading -the request body and sending a response. +With the exception of functions manipulating the request +body, all functions return a single value. Depending on +the function this can be the requested value (method, +host, path, ...), a boolean (has_body, has_resp_header...) +a new Req object (set_resp_body, set_resp_header...), or +simply the atom `ok` (chunk, continue, ...). + +The request body reading functions may return `{Result, Req}` +or `{Result, Value, Req}`. The functions in this category +are `body/{1,2}`, `body_qs/{1,2}`, `part/{1,2}`, `part_body/{1,2}`. + +This chapter covers the access functions mainly. Cookies, +request body and response functions are covered in their +own chapters. :: Request @@ -82,7 +57,7 @@ GET, HEAD, OPTIONS, PATCH, POST, PUT, DELETE. Method names are case sensitive. ``` erlang -{Method, Req2} = cowboy_req:method(Req). +Method = cowboy_req:method(Req). ``` The host, port and path parts of the URL identify the resource @@ -90,15 +65,15 @@ being accessed. The host and port information may not be available if the client uses HTTP/1.0. ``` erlang -{Host, Req2} = cowboy_req:host(Req), -{Port, Req3} = cowboy_req:port(Req2), -{Path, Req4} = cowboy_req:path(Req3). +Host = cowboy_req:host(Req), +Port = cowboy_req:port(Req), +Path = cowboy_req:path(Req). ``` The version used by the client can of course also be obtained. ``` erlang -{Version, Req2} = cowboy_req:version(Req). +Version = cowboy_req:version(Req). ``` Do note however that clients claiming to implement one version @@ -115,21 +90,21 @@ You can fetch a single binding. The value will be `undefined` if the binding doesn't exist. ``` erlang -{Binding, Req2} = cowboy_req:binding(my_binding, Req). +Binding = cowboy_req:binding(my_binding, Req). ``` If you need a different value when the binding doesn't exist, you can change the default. ``` erlang -{Binding, Req2} = cowboy_req:binding(my_binding, Req, 42). +Binding = cowboy_req:binding(my_binding, Req, 42). ``` You can also obtain all bindings in one call. They will be returned as a list of key/value tuples. ``` erlang -{AllBindings, Req2} = cowboy_req:bindings(Req). +AllBindings = cowboy_req:bindings(Req). ``` If you used `...` at the beginning of the route's pattern @@ -137,7 +112,7 @@ for the host, you can retrieve the matched part of the host. The value will be `undefined` otherwise. ``` erlang -{HostInfo, Req2} = cowboy_req:host_info(Req). +HostInfo = cowboy_req:host_info(Req). ``` Similarly, if you used `...` at the end of the route's @@ -145,49 +120,70 @@ pattern for the path, you can retrieve the matched part, or get `undefined` otherwise. ``` erlang -{PathInfo, Req2} = cowboy_req:path_info(Req). +PathInfo = cowboy_req:path_info(Req). ``` :: Query string -The query string can be obtained directly. +The raw query string can be obtained directly. + +``` erlang +Qs = cowboy_req:qs(Req). +``` + +You can parse the query string and then use standard library +functions to access individual values. ``` erlang -{Qs, Req2} = cowboy_req:qs(Req). +QsVals = cowboy_req:parse_qs(Req), +{_, Lang} = lists:keyfind(<<"lang">>, 1, QsVals). ``` -You can also requests only one value. +You can match the query string into a map. ``` erlang -{QsVal, Req2} = cowboy_req:qs_val(<<"lang">>, Req). +#{id := ID, lang := Lang} = cowboy_req:match_qs(Req, [id, lang]). ``` -If that value is optional, you can define a default to simplify -your task. +You can use constraints to validate the values while matching +them. The following snippet will crash if the `id` value is +not an integer number or if the `lang` value is empty. Additionally +the `id` value will be converted to an integer term, saving +you a conversion step. ``` erlang -{QsVal, Req2} = cowboy_req:qs_val(<<"lang">>, Req, <<"en">>). +QsMap = cowboy_req:match_qs(Req, [{id, int}, {lang, nonempty}]). ``` -Finally, you can obtain all query string values. +Note that in the case of duplicate query string keys, the map +value will become a list of the different values. + +Read more about ^constraints^. + +A default value can be provided. The default will be used +if the `lang` key is not found. It will not be used if +the key is found but has an empty value. ``` erlang -{AllValues, Req2} = cowboy_req:qs_vals(Req). +#{lang := Lang} = cowboy_req:match_qs(Req, [{lang, [], <<"en-US">>}]). ``` +If no default is provided and the value is missing, the +query string is deemed invalid and the process will crash. + :: Request URL You can reconstruct the full URL of the resource. ``` erlang -{URL, Req2} = cowboy_req:url(Req). +URL = cowboy_req:url(Req). ``` You can also obtain only the base of the URL, excluding the path and query string. ``` erlang -{BaseURL, Req2} = cowboy_req:host_url(Req). +BaseURL = cowboy_req:host_url(Req). ``` :: Headers @@ -198,57 +194,43 @@ or parsed into a more meaningful representation. This will get the string value of a header. ``` erlang -{HeaderVal, Req2} = cowboy_req:header(<<"content-type">>, Req). +HeaderVal = cowboy_req:header(<<"content-type">>, Req). ``` You can of course set a default in case the header is missing. ``` erlang -{HeaderVal, Req2} +HeaderVal = cowboy_req:header(<<"content-type">>, Req, <<"text/plain">>). ``` And also obtain all headers. ``` erlang -{AllHeaders, Req2} = cowboy_req:headers(Req). +AllHeaders = cowboy_req:headers(Req). ``` To parse the previous header, simply call `parse_header/{2,3}` -where you would call `header/{2,3}` otherwise. Note that the -return value changes and includes the result of the operation -as the first element of the returned tuple. A successful parse -returns `ok`. - -``` erlang -{ok, ParsedVal, Req2} = cowboy_req:parse_header(<<"content-type">>, Req). -``` - -When Cowboy doesn't know how to parse the given header, the -result of the operation will be `undefined` and the string value -will be returned instead. +where you would call `header/{2,3}` otherwise. ``` erlang -{undefined, HeaderVal, Req2} - = cowboy_req:parse_header(<<"unicorn-header">>, Req). +ParsedVal = cowboy_req:parse_header(<<"content-type">>, Req). ``` -When parsing fails, `{error, Reason}` is returned instead. +Cowboy will crash if it doesn't know how to parse the given +header, or if the value is invalid. You can of course define a default value. Note that the default value you specify here is the parsed value you'd like to get by default. ``` erlang -{ok, ParsedVal, Req2} - = cowboy_req:parse_header(<<"content-type">>, Req, - {<<"text">>, <<"plain">>, []}). +ParsedVal = cowboy_req:parse_header(<<"content-type">>, Req, + {<<"text">>, <<"plain">>, []}). ``` The list of known headers and default values is defined in the -manual. Also note that the result of parsing is cached, so -calling this function multiple times for the same values will -not have a significant performance impact. +manual. :: Meta @@ -260,13 +242,13 @@ This will get a meta value. The returned value will be `undefined` if it isn't defined. ``` erlang -{MetaVal, Req2} = cowboy_req:meta(websocket_version, Req). +MetaVal = cowboy_req:meta(websocket_version, Req). ``` You can change the default value if needed. ``` erlang -{MetaVal, Req2} = cowboy_req:meta(websocket_version, Req, 13). +MetaVal = cowboy_req:meta(websocket_version, Req, 13). ``` You can also define your own meta values. The name must be @@ -283,7 +265,7 @@ not necessarily the actual IP and port of the client, but rather the one of the machine that connected to the server. ``` erlang -{{IP, Port}, Req2} = cowboy_req:peer(Req). +{IP, Port} = cowboy_req:peer(Req). ``` :: Reducing the memory footprint diff --git a/doc/src/guide/req_body.ezdoc b/doc/src/guide/req_body.ezdoc index 44f32f8..8864035 100644 --- a/doc/src/guide/req_body.ezdoc +++ b/doc/src/guide/req_body.ezdoc @@ -37,7 +37,7 @@ You can obtain the body length if it was sent with the request. ``` erlang -{Length, Req2} = cowboy_req:body_length(Req). +Length = cowboy_req:body_length(Req). ``` The value returned will be `undefined` if the length @@ -123,7 +123,7 @@ ignored. The following example shows how to set both options. ``` erlang -{ok, Req2} = cowboy_req:body(Req, [ +{ok, Data, Req2} = cowboy_req:body(Req, [ {transfer_decode, fun transfer_decode/2, TransferState}, {content_decode, fun content_decode/1} ]). diff --git a/doc/src/guide/resp.ezdoc b/doc/src/guide/resp.ezdoc index 28f2544..009756a 100644 --- a/doc/src/guide/resp.ezdoc +++ b/doc/src/guide/resp.ezdoc @@ -16,7 +16,7 @@ Cowboy will make sure to send the mandatory headers with the response. ``` erlang -{ok, Req2} = cowboy_req:reply(200, Req). +Req2 = cowboy_req:reply(200, Req). ``` You can define headers to be sent with the response. Note @@ -24,7 +24,7 @@ that header names must be lowercase. Again, Cowboy will make sure to send the mandatory headers with the response. ``` erlang -{ok, Req2} = cowboy_req:reply(303, [ +Req2 = cowboy_req:reply(303, [ {<<"location">>, <<"http://ninenines.eu">>} ], Req). ``` @@ -35,7 +35,7 @@ by Cowboy. For example, you can advertise yourself as a different server. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"server">>, <<"yaws">>} ], Req). ``` @@ -49,7 +49,7 @@ We recommend that you set the content-type header so the client may know how to read the body. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/plain">>} ], "Hello world!", Req). ``` @@ -57,7 +57,7 @@ client may know how to read the body. Here is the same example but sending HTML this time. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/html">>} ], "<html><head>Hello world!</head><body><p>Hats off!</p></body></html>", Req). ``` @@ -71,10 +71,10 @@ initiate the reply by sending the response status code. Then you can send the body in chunks of arbitrary size. ``` erlang -{ok, Req2} = cowboy_req:chunked_reply(200, Req), -ok = cowboy_req:chunk("Hello...", Req2), -ok = cowboy_req:chunk("chunked...", Req2), -ok = cowboy_req:chunk("world!!", Req2). +Req2 = cowboy_req:chunked_reply(200, Req), +cowboy_req:chunk("Hello...", Req2), +cowboy_req:chunk("chunked...", Req2), +cowboy_req:chunk("world!!", Req2). ``` You should make sure to match on `ok` as an error may be @@ -85,11 +85,11 @@ a content-type header, it is still recommended. You can set this header or any other just like for normal replies. ``` erlang -{ok, Req2} = cowboy_req:chunked_reply(200, [ +Req2 = cowboy_req:chunked_reply(200, [ {<<"content-type">>, <<"text/html">>} ], Req), -ok = cowboy_req:chunk("<html><head>Hello world!</head>", Req2), -ok = cowboy_req:chunk("<body><p>Hats off!</p></body></html>", Req2). +cowboy_req:chunk("<html><head>Hello world!</head>", Req2), +cowboy_req:chunk("<body><p>Hats off!</p></body></html>", Req2). ``` Note that the reply and each chunk following it are sent diff --git a/doc/src/guide/ws_handlers.ezdoc b/doc/src/guide/ws_handlers.ezdoc index 9c3e2b7..1c84b98 100644 --- a/doc/src/guide/ws_handlers.ezdoc +++ b/doc/src/guide/ws_handlers.ezdoc @@ -68,16 +68,16 @@ the connection, assuming no correct subprotocol was found. ``` erlang websocket_init(_Type, Req, _Opts) -> case cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req) of - {ok, undefined, Req2} -> + undefined -> {ok, Req, #state{}}; - {ok, Subprotocols, Req2} -> + Subprotocols -> case lists:keymember(<<"mychat2">>, 1, Subprotocols) of true -> - Req3 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, - <<"mychat2">>, Req2), - {ok, Req3, #state{}}; + Req2 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, + <<"mychat2">>, Req), + {ok, Req2, #state{}}; false -> - {shutdown, Req2} + {shutdown, Req} end end. ``` diff --git a/doc/src/manual/cowboy.ezdoc b/doc/src/manual/cowboy.ezdoc index a207afe..209d473 100644 --- a/doc/src/manual/cowboy.ezdoc +++ b/doc/src/manual/cowboy.ezdoc @@ -5,6 +5,12 @@ manipulating Ranch listeners. :: Types +: fields() = [atom() + | {atom(), cowboy_constraints:constraint() | [cowboy_constraints:constraint()]} + | {atom(), cowboy_constraints:constraint() | [cowboy_constraints:constraint()], any()}] + +Fields for match operations. Constraint(s) and default value are optional. + : http_headers() = [{binary(), iodata()}] HTTP headers as a list of key/values. diff --git a/doc/src/manual/cowboy_req.ezdoc b/doc/src/manual/cowboy_req.ezdoc index beac1f4..94556b2 100644 --- a/doc/src/manual/cowboy_req.ezdoc +++ b/doc/src/manual/cowboy_req.ezdoc @@ -6,21 +6,19 @@ and respond to requests. The functions in this module follow patterns for their return types, based on the kind of function. -* access: `{Value, Req}` -* action: `{Result, Req} | {Result, Value, Req} | {error, atom()}` +* access: `Value` +* action: `ok | {Result, Req} | {Result, Value, Req}` * modification: `Req` * question: `boolean()` -The only exception is the `chunk/2` function which may return `ok`. - Whenever `Req` is returned, you must use this returned value and ignore any previous you may have had. This value contains various -state informations which are necessary for Cowboy to do some lazy -evaluation or cache results where appropriate. +values which are necessary for Cowboy to keep track of the request +and response states. All functions which perform an action should only be called once. This includes reading the request body or replying. Cowboy will -generally throw an error on the second call. +throw an error on the second call when it detects suspicious behavior. It is highly discouraged to pass the Req object to another process. Doing so and calling `cowboy_req` functions from it leads to @@ -54,7 +52,7 @@ the function descriptions below. :: Request related exports : binding(Name, Req) -> binding(Name, Req, undefined) -: binding(Name, Req, Default) -> {Value, Req2} +: binding(Name, Req, Default) -> Value Types: @@ -68,7 +66,7 @@ By default the value is a binary, however constraints may change the type of this value (for example automatically converting numbers to integer). -: bindings(Req) -> {[{Name, Value}], Req2} +: bindings(Req) -> [{Name, Value}] Types: @@ -81,30 +79,8 @@ By default the value is a binary, however constraints may change the type of this value (for example automatically converting numbers to integer). -: cookie(Name, Req) -> cookie(Name, Req, undefined) -: cookie(Name, Req, Default) -> {Value, Req2} - -Types: - -* Name = binary() -* Default = any() -* Value = binary() | Default - -Return the value for the given cookie. - -Cookie names are case sensitive. - -: cookies(Req) -> {[{Name, Value}], Req2} - -Types: - -* Name = binary() -* Value = binary() - -Return all cookies. - : header(Name, Req) -> header(Name, Req, undefined) -: header(Name, Req, Default) -> {Value, Req2} +: header(Name, Req, Default) -> Value Types: @@ -117,7 +93,7 @@ Return the value for the given header. While header names are case insensitive, this function expects the name to be a lowercase binary. -: headers(Req) -> {Headers, Req2} +: headers(Req) -> Headers Types: @@ -125,7 +101,7 @@ Types: Return all headers. -: host(Req) -> {Host, Req2} +: host(Req) -> Host Types: @@ -133,7 +109,7 @@ Types: Return the requested host. -: host_info(Req) -> {HostInfo, Req2} +: host_info(Req) -> HostInfo Types: @@ -141,7 +117,7 @@ Types: Return the extra tokens from matching against `...` during routing. -: host_url(Req) -> {HostURL, Req2} +: host_url(Req) -> HostURL Types: @@ -153,8 +129,57 @@ This function will always return `undefined` until the `cowboy_router` middleware has been executed. This includes the `onrequest` hook. +: match_cookies(Req, Fields) -> Map + +Types: + +* Fields = cowboy:fields() +* Map = map() + +Match cookies against the given fields. + +Cowboy will only return the cookie values specified in the +fields list, and ignore all others. Fields can be either +the name of the cookie requested; the name along with a +list of constraints; or the name, a list of constraints +and a default value in case the cookie is missing. + +This function will crash if the cookie is missing and no +default value is provided. This function will also crash +if a constraint fails. + +The name of the cookie must be provided as an atom. The +key of the returned map will be that atom. The value may +be converted through the use of constraints, making this +function able to extract, validate and convert values all +in one step. + +: match_qs(Req, Fields) -> Map + +Types: + +* Fields = cowboy:fields() +* Map = map() + +Match the query string against the given fields. + +Cowboy will only return the query string values specified +in the fields list, and ignore all others. Fields can be +either the key requested; the key along with a list of +constraints; or the key, a list of constraints and a +default value in case the key is missing. + +This function will crash if the key is missing and no +default value is provided. This function will also crash +if a constraint fails. + +The key must be provided as an atom. The key of the +returned map will be that atom. The value may be converted +through the use of constraints, making this function able +to extract, validate and convert values all in one step. + : meta(Name, Req) -> meta(Name, Req, undefined) -: meta(Name, Req, Default) -> {Value, Req2} +: meta(Name, Req, Default) -> Value Types: @@ -164,7 +189,7 @@ Types: Return metadata about the request. -: method(Req) -> {Method, Req2} +: method(Req) -> Method Types: @@ -174,16 +199,25 @@ Return the method. Methods are case sensitive. Standard methods are always uppercase. -: parse_header(Name, Req) -> -: parse_header(Name, Req, Default) -> {ok, ParsedValue, Req2} - | {undefined, Value, Req2} | {error, badarg} +: parse_cookies(Req) -> [{Name, Value}] + +Types: + +* Name = binary() +* Value = binary() + +Parse and return all cookies. + +Cookie names are case sensitive. + +: parse_header(Name, Req) -> see below +: parse_header(Name, Req, Default) -> ParsedValue | Default Types: * Name = binary() * Default = any() * ParsedValue - see below -* Value = any() Parse the given header. @@ -196,6 +230,8 @@ following table summarizes the default values used. || Header name Default value | +| content-length `0` +| cookie `[]` | transfer-encoding `[<<"identity">>]` | Any other header `undefined` @@ -241,8 +277,8 @@ except the value of the charset parameter, which is case insensitive. All other values are case insensitive and will be returned as lowercase. The headers accept, accept-encoding and cookie headers can return -an empty list. Others will return `{error, badarg}` if the header -value is empty. +an empty list. Some other headers are expected to have a value if provided +and may crash if the value is missing. The authorization header parsing code currently only supports basic HTTP authentication. The `Credentials` type is thus `{Username, Password}` @@ -257,7 +293,21 @@ The range header value `Range` can take three forms: An `undefined` tuple will be returned if Cowboy doesn't know how to parse the requested header. -: path(Req) -> {Path, Req2} +: parse_qs(Req) -> [{Name, Value}] + +Types: + +* Name = binary() +* Value = binary() | true + +Return the request's query string as a list of tuples. + +The atom `true` is returned for keys which have no value. +Keys with no value are different from keys with an empty +value in that they do not have a `=` indicating the presence +of a value. + +: path(Req) -> Path Types: @@ -265,7 +315,7 @@ Types: Return the requested path. -: path_info(Req) -> {PathInfo, Req2} +: path_info(Req) -> PathInfo Types: @@ -273,7 +323,7 @@ Types: Return the extra tokens from matching against `...` during routing. -: peer(Req) -> {Peer, Req2} +: peer(Req) -> Peer Types: @@ -281,7 +331,7 @@ Types: Return the client's IP address and port number. -: port(Req) -> {Port, Req2} +: port(Req) -> Port Types: @@ -293,7 +343,7 @@ The port returned by this function is obtained by parsing the host header. It may be different than the actual port the client used to connect to the Cowboy server. -: qs(Req) -> {QueryString, Req2} +: qs(Req) -> QueryString Types: @@ -301,32 +351,6 @@ Types: Return the request's query string. -: qs_val(Name, Req) -> qs_val(Name, Req, undefined) -: qs_val(Name, Req, Default) -> {Value, Req2} - -Types: - -* Name = binary() -* Default = any() -* Value = binary() | true - -Return a value from the request's query string. - -The value `true` will be returned when the name was found -in the query string without an associated value. - -: qs_vals(Req) -> {[{Name, Value}], Req2} - -Types: - -* Name = binary() -* Value = binary() | true - -Return the request's query string as a list of tuples. - -The value `true` will be returned when a name was found -in the query string without an associated value. - : set_meta(Name, Value, Req) -> Req2 Types: @@ -338,7 +362,7 @@ Set metadata about the request. An existing value will be overwritten. -: url(Req) -> {URL, Req2} +: url(Req) -> URL Types: @@ -350,7 +374,7 @@ This function will always return `undefined` until the `cowboy_router` middleware has been executed. This includes the `onrequest` hook. -: version(Req) -> {Version, Req2} +: version(Req) -> Version Types: @@ -361,7 +385,7 @@ Return the HTTP version used for this request. :: Request body related exports : body(Req) -> body(Req, []) -: body(Req, Opts) -> {ok, Data, Req2} | {more, Data, Req2} | {error, Reason} +: body(Req, Opts) -> {ok, Data, Req2} | {more, Data, Req2} Types: @@ -400,7 +424,7 @@ the content-length header if it wasn't already there. This function can only be called once. Cowboy will not cache the result of this call. -: body_length(Req) -> {Length, Req2} +: body_length(Req) -> Length Types: @@ -414,8 +438,7 @@ is present. : body_qs(Req) -> body_qs(Req, [{length, 64000}, {read_length, 64000}, {read_timeout, 5000}]) -: body_qs(Req, Opts) -> {ok, [{Name, Value}], Req2} - | {badlength, Req2} | {error, Reason} +: body_qs(Req, Opts) -> {ok, [{Name, Value}], Req2} | {badlength, Req2} Types: @@ -501,7 +524,7 @@ it cannot be read again. :: Response related exports -: chunk(Data, Req) -> ok | {error, Reason} +: chunk(Data, Req) -> ok Types: @@ -520,7 +543,7 @@ without wrapping it in an HTTP/1.1 chunk, providing compatibility with older clients. : chunked_reply(StatusCode, Req) -> chunked_reply(StatusCode, [], Req) -: chunked_reply(StatusCode, Headers, Req) -> {ok, Req2} +: chunked_reply(StatusCode, Headers, Req) -> Req2 Types: @@ -543,7 +566,7 @@ compatibility with older clients. This function can only be called once, with the exception of overriding the response in the `onresponse` hook. -: continue(Req) -> ok | {error, Reason} +: continue(Req) -> ok Types: @@ -591,7 +614,7 @@ the name to be a lowercase binary. : reply(StatusCode, Req) -> reply(StatusCode, [], Req) : reply(StatusCode, Headers, Req) - see below -: reply(StatusCode, Headers, Body, Req) -> {ok, Req2} +: reply(StatusCode, Headers, Body, Req) -> Req2 Types: @@ -657,7 +680,7 @@ arguments. Only send and sendfile operations are supported. Types: * Fun = fun((ChunkFun) -> ok) -* ChunkFun = fun((iodata()) -> ok | {error, atom()}) +* ChunkFun = fun((iodata()) -> ok) Set a fun for sending the response body using chunked transfer-encoding. diff --git a/examples/chunked_hello_world/src/toppage_handler.erl b/examples/chunked_hello_world/src/toppage_handler.erl index b6f2d04..4e6b4e4 100644 --- a/examples/chunked_hello_world/src/toppage_handler.erl +++ b/examples/chunked_hello_world/src/toppage_handler.erl @@ -11,12 +11,12 @@ init(_Transport, Req, []) -> {ok, Req, undefined}. handle(Req, State) -> - {ok, Req2} = cowboy_req:chunked_reply(200, Req), - ok = cowboy_req:chunk("Hello\r\n", Req2), - ok = timer:sleep(1000), - ok = cowboy_req:chunk("World\r\n", Req2), - ok = timer:sleep(1000), - ok = cowboy_req:chunk("Chunked!\r\n", Req2), + Req2 = cowboy_req:chunked_reply(200, Req), + cowboy_req:chunk("Hello\r\n", Req2), + timer:sleep(1000), + cowboy_req:chunk("World\r\n", Req2), + timer:sleep(1000), + cowboy_req:chunk("Chunked!\r\n", Req2), {ok, Req2, State}. terminate(_Reason, _Req, _State) -> diff --git a/examples/compress_response/src/toppage_handler.erl b/examples/compress_response/src/toppage_handler.erl index 3558a9c..7c1569a 100644 --- a/examples/compress_response/src/toppage_handler.erl +++ b/examples/compress_response/src/toppage_handler.erl @@ -24,7 +24,7 @@ have established the ability to work at virtually identical tasks and obtained considerable respect for their achievements. There are also cattle handlers in many other parts of the world, particularly South America and Australia, who perform work similar to the cowboy in their respective nations.\n">>, - {ok, Req2} = cowboy_req:reply(200, [], BigBody, Req), + Req2 = cowboy_req:reply(200, [], BigBody, Req), {ok, Req2, State}. terminate(_Reason, _Req, _State) -> diff --git a/examples/cookie/src/toppage_handler.erl b/examples/cookie/src/toppage_handler.erl index b107d5a..837f83b 100644 --- a/examples/cookie/src/toppage_handler.erl +++ b/examples/cookie/src/toppage_handler.erl @@ -14,16 +14,16 @@ handle(Req, State) -> NewValue = integer_to_list(random:uniform(1000000)), Req2 = cowboy_req:set_resp_cookie( <<"server">>, NewValue, [{path, <<"/">>}], Req), - {ClientCookie, Req3} = cowboy_req:cookie(<<"client">>, Req2), - {ServerCookie, Req4} = cowboy_req:cookie(<<"server">>, Req3), + #{client := ClientCookie, server := ServerCookie} + = cowboy_req:match_cookies(Req2, [client, server]), {ok, Body} = toppage_dtl:render([ {client, ClientCookie}, {server, ServerCookie} ]), - {ok, Req5} = cowboy_req:reply(200, + Req3 = cowboy_req:reply(200, [{<<"content-type">>, <<"text/html">>}], - Body, Req4), - {ok, Req5, State}. + Body, Req2), + {ok, Req3, State}. terminate(_Reason, _Req, _State) -> ok. diff --git a/examples/echo_get/src/toppage_handler.erl b/examples/echo_get/src/toppage_handler.erl index 1187dc6..50c5985 100644 --- a/examples/echo_get/src/toppage_handler.erl +++ b/examples/echo_get/src/toppage_handler.erl @@ -11,10 +11,10 @@ init(_Transport, Req, []) -> {ok, Req, undefined}. handle(Req, State) -> - {Method, Req2} = cowboy_req:method(Req), - {Echo, Req3} = cowboy_req:qs_val(<<"echo">>, Req2), - {ok, Req4} = echo(Method, Echo, Req3), - {ok, Req4, State}. + Method = cowboy_req:method(Req), + #{echo := Echo} = cowboy_req:match_qs(Req, [echo]), + Req2 = echo(Method, Echo, Req), + {ok, Req2, State}. echo(<<"GET">>, undefined, Req) -> cowboy_req:reply(400, [], <<"Missing echo parameter.">>, Req); diff --git a/examples/echo_post/src/toppage_handler.erl b/examples/echo_post/src/toppage_handler.erl index e9fab15..de1f2ad 100644 --- a/examples/echo_post/src/toppage_handler.erl +++ b/examples/echo_post/src/toppage_handler.erl @@ -11,10 +11,10 @@ init(_Transport, Req, []) -> {ok, Req, undefined}. handle(Req, State) -> - {Method, Req2} = cowboy_req:method(Req), - HasBody = cowboy_req:has_body(Req2), - {ok, Req3} = maybe_echo(Method, HasBody, Req2), - {ok, Req3, State}. + Method = cowboy_req:method(Req), + HasBody = cowboy_req:has_body(Req), + Req2 = maybe_echo(Method, HasBody, Req), + {ok, Req2, State}. maybe_echo(<<"POST">>, true, Req) -> {ok, PostVals, Req2} = cowboy_req:body_qs(Req), diff --git a/examples/error_hook/src/error_hook_app.erl b/examples/error_hook/src/error_hook_app.erl index 7525cbe..5f8ee15 100644 --- a/examples/error_hook/src/error_hook_app.erl +++ b/examples/error_hook/src/error_hook_app.erl @@ -24,18 +24,16 @@ stop(_State) -> ok. error_hook(404, Headers, <<>>, Req) -> - {Path, Req2} = cowboy_req:path(Req), + Path = cowboy_req:path(Req), Body = ["404 Not Found: \"", Path, "\" is not the path you are looking for.\n"], Headers2 = lists:keyreplace(<<"content-length">>, 1, Headers, {<<"content-length">>, integer_to_list(iolist_size(Body))}), - {ok, Req3} = cowboy_req:reply(404, Headers2, Body, Req2), - Req3; + cowboy_req:reply(404, Headers2, Body, Req); error_hook(Code, Headers, <<>>, Req) when is_integer(Code), Code >= 400 -> Body = ["HTTP Error ", integer_to_list(Code), $\n], Headers2 = lists:keyreplace(<<"content-length">>, 1, Headers, {<<"content-length">>, integer_to_list(iolist_size(Body))}), - {ok, Req2} = cowboy_req:reply(Code, Headers2, Body, Req), - Req2; + cowboy_req:reply(Code, Headers2, Body, Req); error_hook(_Code, _Headers, _Body, Req) -> Req. diff --git a/examples/eventsource/src/eventsource_handler.erl b/examples/eventsource/src/eventsource_handler.erl index 661057c..a184807 100644 --- a/examples/eventsource/src/eventsource_handler.erl +++ b/examples/eventsource/src/eventsource_handler.erl @@ -9,12 +9,12 @@ init(_Transport, Req, []) -> Headers = [{<<"content-type">>, <<"text/event-stream">>}], - {ok, Req2} = cowboy_req:chunked_reply(200, Headers, Req), + Req2 = cowboy_req:chunked_reply(200, Headers, Req), erlang:send_after(1000, self(), {message, "Tick"}), {loop, Req2, undefined, 5000}. info({message, Msg}, Req, State) -> - ok = cowboy_req:chunk(["id: ", id(), "\ndata: ", Msg, "\n\n"], Req), + cowboy_req:chunk(["id: ", id(), "\ndata: ", Msg, "\n\n"], Req), erlang:send_after(1000, self(), {message, "Tick"}), {loop, Req, State}. diff --git a/examples/hello_world/src/toppage_handler.erl b/examples/hello_world/src/toppage_handler.erl index 4839991..1b82cb2 100644 --- a/examples/hello_world/src/toppage_handler.erl +++ b/examples/hello_world/src/toppage_handler.erl @@ -11,7 +11,7 @@ init(_Type, Req, []) -> {ok, Req, undefined}. handle(Req, State) -> - {ok, Req2} = cowboy_req:reply(200, [ + Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/plain">>} ], <<"Hello world!">>, Req), {ok, Req2, State}. diff --git a/examples/markdown_middleware/src/markdown_converter.erl b/examples/markdown_middleware/src/markdown_converter.erl index f380332..988de9d 100644 --- a/examples/markdown_middleware/src/markdown_converter.erl +++ b/examples/markdown_middleware/src/markdown_converter.erl @@ -6,12 +6,12 @@ -export([execute/2]). execute(Req, Env) -> - {[Path], Req1} = cowboy_req:path_info(Req), + [Path] = cowboy_req:path_info(Req), case filename:extension(Path) of <<".html">> -> maybe_generate_markdown(resource_path(Path)); _Ext -> ok end, - {ok, Req1, Env}. + {ok, Req, Env}. maybe_generate_markdown(Path) -> ModifiedAt = filelib:last_modified(source_path(Path)), diff --git a/examples/rest_basic_auth/src/toppage_handler.erl b/examples/rest_basic_auth/src/toppage_handler.erl index 2914064..f5544f8 100644 --- a/examples/rest_basic_auth/src/toppage_handler.erl +++ b/examples/rest_basic_auth/src/toppage_handler.erl @@ -12,12 +12,11 @@ init(_Transport, _Req, []) -> {upgrade, protocol, cowboy_rest}. is_authorized(Req, State) -> - {ok, Auth, Req1} = cowboy_req:parse_header(<<"authorization">>, Req), - case Auth of + case cowboy_req:parse_header(<<"authorization">>, Req) of {<<"basic">>, {User = <<"Alladin">>, <<"open sesame">>}} -> - {true, Req1, User}; + {true, Req, User}; _ -> - {{false, <<"Basic realm=\"cowboy\"">>}, Req1, State} + {{false, <<"Basic realm=\"cowboy\"">>}, Req, State} end. content_types_provided(Req, State) -> diff --git a/examples/rest_pastebin/src/toppage_handler.erl b/examples/rest_pastebin/src/toppage_handler.erl index be2b803..506fc82 100644 --- a/examples/rest_pastebin/src/toppage_handler.erl +++ b/examples/rest_pastebin/src/toppage_handler.erl @@ -36,37 +36,37 @@ content_types_accepted(Req, State) -> resource_exists(Req, _State) -> case cowboy_req:binding(paste_id, Req) of - {undefined, Req2} -> - {true, Req2, index}; - {PasteID, Req2} -> + undefined -> + {true, Req, index}; + PasteID -> case valid_path(PasteID) and file_exists(PasteID) of - true -> {true, Req2, PasteID}; - false -> {false, Req2, PasteID} + true -> {true, Req, PasteID}; + false -> {false, Req, PasteID} end end. create_paste(Req, State) -> PasteID = new_paste_id(), - {ok, [{<<"paste">>, Paste}], Req3} = cowboy_req:body_qs(Req), + {ok, [{<<"paste">>, Paste}], Req2} = cowboy_req:body_qs(Req), ok = file:write_file(full_path(PasteID), Paste), - case cowboy_req:method(Req3) of - {<<"POST">>, Req4} -> - {{true, <<$/, PasteID/binary>>}, Req4, State}; - {_, Req4} -> - {true, Req4, State} + case cowboy_req:method(Req2) of + <<"POST">> -> + {{true, <<$/, PasteID/binary>>}, Req2, State}; + _ -> + {true, Req2, State} end. paste_html(Req, index) -> {read_file("index.html"), Req, index}; paste_html(Req, Paste) -> - {Style, Req2} = cowboy_req:qs_val(<<"lang">>, Req, plain), - {format_html(Paste, Style), Req2, Paste}. + #{lang := Lang} = cowboy_req:match_qs(Req, [lang]), + {format_html(Paste, Lang), Req, Paste}. paste_text(Req, index) -> {read_file("index.txt"), Req, index}; paste_text(Req, Paste) -> - {Style, Req2} = cowboy_req:qs_val(<<"lang">>, Req, plain), - {format_text(Paste, Style), Req2, Paste}. + #{lang := Lang} = cowboy_req:match_qs(Req, [lang]), + {format_text(Paste, Lang), Req, Paste}. % Private diff --git a/examples/rest_stream_response/src/toppage_handler.erl b/examples/rest_stream_response/src/toppage_handler.erl index 224446a..71e0d50 100644 --- a/examples/rest_stream_response/src/toppage_handler.erl +++ b/examples/rest_stream_response/src/toppage_handler.erl @@ -20,9 +20,9 @@ content_types_provided(Req, State) -> ], Req, State}. streaming_csv(Req, Table) -> - {N, Req1} = cowboy_req:binding(v1, Req, 1), + N = cowboy_req:binding(v1, Req, 1), MS = [{{'$1', '$2', '$3'}, [{'==', '$2', N}], ['$$']}], - {{stream, result_streamer(Table, MS)}, Req1, Table}. + {{stream, result_streamer(Table, MS)}, Req, Table}. result_streamer(Table, MS) -> fun (Socket, Transport) -> diff --git a/examples/ssl_hello_world/src/toppage_handler.erl b/examples/ssl_hello_world/src/toppage_handler.erl index f0fa806..80fe1d5 100644 --- a/examples/ssl_hello_world/src/toppage_handler.erl +++ b/examples/ssl_hello_world/src/toppage_handler.erl @@ -11,7 +11,7 @@ init(_Transport, Req, []) -> {ok, Req, undefined}. handle(Req, State) -> - {ok, Req2} = cowboy_req:reply(200, [ + Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/plain">>} ], <<"Hello world!">>, Req), {ok, Req2, State}. diff --git a/examples/web_server/src/directory_lister.erl b/examples/web_server/src/directory_lister.erl index 79d5ea3..bc34073 100644 --- a/examples/web_server/src/directory_lister.erl +++ b/examples/web_server/src/directory_lister.erl @@ -12,14 +12,14 @@ execute(Req, Env) -> end. redirect_directory(Req, Env) -> - {Path, Req1} = cowboy_req:path_info(Req), + Path = cowboy_req:path_info(Req), Path1 = << <<S/binary, $/>> || S <- Path >>, {handler_opts, {_, _, _, Extra}} = lists:keyfind(handler_opts, 1, Env), {dir_handler, DirHandler} = lists:keyfind(dir_handler, 1, Extra), FullPath = resource_path(Path1), case valid_path(Path) and filelib:is_dir(FullPath) of - true -> handle_directory(Req1, Env, Path1, FullPath, DirHandler); - false -> {ok, Req1, Env} + true -> handle_directory(Req, Env, Path1, FullPath, DirHandler); + false -> {ok, Req, Env} end. handle_directory(Req, Env, Prefix, Path, DirHandler) -> diff --git a/src/cowboy.erl b/src/cowboy.erl index 2b50dfb..8e9232f 100644 --- a/src/cowboy.erl +++ b/src/cowboy.erl @@ -20,6 +20,11 @@ -export([stop_listener/1]). -export([set_env/3]). +-type fields() :: [atom() + | {atom(), cowboy_constraints:constraint() | [cowboy_constraints:constraint()]} + | {atom(), cowboy_constraints:constraint() | [cowboy_constraints:constraint()], any()}]. +-export_type([fields/0]). + -type http_headers() :: [{binary(), iodata()}]. -export_type([http_headers/0]). diff --git a/src/cowboy_constraints.erl b/src/cowboy_constraints.erl new file mode 100644 index 0000000..9a379e1 --- /dev/null +++ b/src/cowboy_constraints.erl @@ -0,0 +1,60 @@ +%% Copyright (c) 2014, Loïc Hoguin <[email protected]> +%% +%% Permission to use, copy, modify, and/or distribute this software for any +%% purpose with or without fee is hereby granted, provided that the above +%% copyright notice and this permission notice appear in all copies. +%% +%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +-module(cowboy_constraints). + +-export([validate/2]). + +-type constraint() :: int | nonempty | fun(). +-export_type([constraint/0]). + +-spec validate(binary(), [constraint()]) -> true | {true, any()} | false. +validate(Value, [Constraint]) -> + apply_constraint(Value, Constraint); +validate(Value, Constraints) when is_list(Constraints) -> + validate_list(Value, Constraints, original); +validate(Value, Constraint) -> + apply_constraint(Value, Constraint). + +validate_list(_, [], original) -> + true; +validate_list(Value, [], modified) -> + {true, Value}; +validate_list(Value, [Constraint|Tail], State) -> + case apply_constraint(Value, Constraint) of + true -> + validate_list(Value, Tail, State); + {true, Value2} -> + validate_list(Value2, Tail, modified); + false -> + false + end. + +%% @todo {int, From, To}, etc. +apply_constraint(Value, int) -> + int(Value); +apply_constraint(Value, nonempty) -> + nonempty(Value); +apply_constraint(Value, F) when is_function(F) -> + F(Value). + +%% Constraint functions. + +int(Value) when is_binary(Value) -> + try {true, list_to_integer(binary_to_list(Value))} + catch _:_ -> false + end. + +nonempty(<<>>) -> false; +nonempty(Value) when is_binary(Value) -> true. diff --git a/src/cowboy_http.erl b/src/cowboy_http.erl index 1cf73bf..177787f 100644 --- a/src/cowboy_http.erl +++ b/src/cowboy_http.erl @@ -852,9 +852,9 @@ parameterized_tokens_param(Data, Fun) -> %% Decoding. %% @todo Move this to cowlib too I suppose. :-) --spec ce_identity(binary()) -> {ok, binary()}. +-spec ce_identity(Data) -> Data when Data::binary(). ce_identity(Data) -> - {ok, Data}. + Data. %% Tests. diff --git a/src/cowboy_req.erl b/src/cowboy_req.erl index 27c59cf..23a3868 100644 --- a/src/cowboy_req.erl +++ b/src/cowboy_req.erl @@ -26,9 +26,8 @@ -export([path/1]). -export([path_info/1]). -export([qs/1]). --export([qs_val/2]). --export([qs_val/3]). --export([qs_vals/1]). +-export([parse_qs/1]). +-export([match_qs/2]). -export([host_url/1]). -export([url/1]). -export([binding/2]). @@ -39,9 +38,8 @@ -export([headers/1]). -export([parse_header/2]). -export([parse_header/3]). --export([cookie/2]). --export([cookie/3]). --export([cookies/1]). +-export([parse_cookies/1]). +-export([match_cookies/2]). -export([meta/2]). -export([meta/3]). -export([set_meta/3]). @@ -94,9 +92,7 @@ -type cookie_opts() :: cow_cookie:cookie_opts(). -export_type([cookie_opts/0]). --type content_decode_fun() :: fun((binary()) - -> {ok, binary()} - | {error, atom()}). +-type content_decode_fun() :: fun((binary()) -> binary()). -type transfer_decode_fun() :: fun((binary(), any()) -> cow_http_te:decode_ret()). @@ -109,7 +105,7 @@ -export_type([body_opts/0]). -type resp_body_fun() :: fun((any(), module()) -> ok). --type send_chunk_fun() :: fun((iodata()) -> ok | {error, atom()}). +-type send_chunk_fun() :: fun((iodata()) -> ok). -type resp_chunked_fun() :: fun((send_chunk_fun()) -> ok). -record(http_req, { @@ -129,11 +125,8 @@ path = undefined :: binary(), path_info = undefined :: undefined | cowboy_router:tokens(), qs = undefined :: binary(), - qs_vals = undefined :: undefined | list({binary(), binary() | true}), bindings = undefined :: undefined | cowboy_router:bindings(), headers = [] :: cowboy:http_headers(), - p_headers = [] :: [any()], - cookies = undefined :: undefined | [{binary(), binary()}], meta = [] :: [{atom(), any()}], %% Request body. @@ -179,89 +172,67 @@ new(Socket, Transport, Peer, Method, Path, Query, false -> Req#http_req{connection=close}; true -> - case lists:keyfind(<<"connection">>, 1, Headers) of - false -> + case parse_header(<<"connection">>, Req) of + undefined -> case Version of 'HTTP/1.1' -> Req; %% keepalive 'HTTP/1.0' -> Req#http_req{connection=close} end; - {_, ConnectionHeader} -> - Tokens = cow_http_hd:parse_connection(ConnectionHeader), + Tokens -> Connection = connection_to_atom(Tokens), - Req#http_req{connection=Connection, - p_headers=[{<<"connection">>, Tokens}]} + Req#http_req{connection=Connection} end end. --spec method(Req) -> {binary(), Req} when Req::req(). +-spec method(req()) -> binary(). method(Req) -> - {Req#http_req.method, Req}. + Req#http_req.method. --spec version(Req) -> {cowboy:http_version(), Req} when Req::req(). +-spec version(req()) -> cowboy:http_version(). version(Req) -> - {Req#http_req.version, Req}. + Req#http_req.version. --spec peer(Req) - -> {{inet:ip_address(), inet:port_number()}, Req} - when Req::req(). +-spec peer(req()) -> {inet:ip_address(), inet:port_number()}. peer(Req) -> - {Req#http_req.peer, Req}. + Req#http_req.peer. --spec host(Req) -> {binary(), Req} when Req::req(). +-spec host(req()) -> binary(). host(Req) -> - {Req#http_req.host, Req}. + Req#http_req.host. --spec host_info(Req) - -> {cowboy_router:tokens() | undefined, Req} when Req::req(). +-spec host_info(req()) -> cowboy_router:tokens() | undefined. host_info(Req) -> - {Req#http_req.host_info, Req}. + Req#http_req.host_info. --spec port(Req) -> {inet:port_number(), Req} when Req::req(). +-spec port(req()) -> inet:port_number(). port(Req) -> - {Req#http_req.port, Req}. + Req#http_req.port. --spec path(Req) -> {binary(), Req} when Req::req(). +-spec path(req()) -> binary(). path(Req) -> - {Req#http_req.path, Req}. + Req#http_req.path. --spec path_info(Req) - -> {cowboy_router:tokens() | undefined, Req} when Req::req(). +-spec path_info(req()) -> cowboy_router:tokens() | undefined. path_info(Req) -> - {Req#http_req.path_info, Req}. + Req#http_req.path_info. --spec qs(Req) -> {binary(), Req} when Req::req(). +-spec qs(req()) -> binary(). qs(Req) -> - {Req#http_req.qs, Req}. - --spec qs_val(binary(), Req) - -> {binary() | true | undefined, Req} when Req::req(). -qs_val(Name, Req) when is_binary(Name) -> - qs_val(Name, Req, undefined). - --spec qs_val(binary(), Req, Default) - -> {binary() | true | Default, Req} when Req::req(), Default::any(). -qs_val(Name, Req=#http_req{qs=RawQs, qs_vals=undefined}, Default) - when is_binary(Name) -> - QsVals = cow_qs:parse_qs(RawQs), - qs_val(Name, Req#http_req{qs_vals=QsVals}, Default); -qs_val(Name, Req, Default) -> - case lists:keyfind(Name, 1, Req#http_req.qs_vals) of - {Name, Value} -> {Value, Req}; - false -> {Default, Req} - end. + Req#http_req.qs. + +-spec parse_qs(req()) -> [{binary(), binary() | true}]. +parse_qs(#http_req{qs=Qs}) -> + cow_qs:parse_qs(Qs). --spec qs_vals(Req) -> {list({binary(), binary() | true}), Req} when Req::req(). -qs_vals(Req=#http_req{qs=RawQs, qs_vals=undefined}) -> - QsVals = cow_qs:parse_qs(RawQs), - qs_vals(Req#http_req{qs_vals=QsVals}); -qs_vals(Req=#http_req{qs_vals=QsVals}) -> - {QsVals, Req}. +-spec match_qs(req(), cowboy:fields()) -> map(). +match_qs(Req, Fields) -> + filter(kvlist_to_map(parse_qs(Req), Fields), Fields). %% The URL includes the scheme, host and port only. --spec host_url(Req) -> {undefined | binary(), Req} when Req::req(). -host_url(Req=#http_req{port=undefined}) -> - {undefined, Req}; -host_url(Req=#http_req{transport=Transport, host=Host, port=Port}) -> +-spec host_url(req()) -> undefined | binary(). +host_url(#http_req{port=undefined}) -> + undefined; +host_url(#http_req{transport=Transport, host=Host, port=Port}) -> TransportName = Transport:name(), Secure = case TransportName of ssl -> <<"s">>; @@ -272,108 +243,101 @@ host_url(Req=#http_req{transport=Transport, host=Host, port=Port}) -> {tcp, 80} -> <<>>; _ -> << ":", (integer_to_binary(Port))/binary >> end, - {<< "http", Secure/binary, "://", Host/binary, PortBin/binary >>, Req}. + << "http", Secure/binary, "://", Host/binary, PortBin/binary >>. %% The URL includes the scheme, host, port, path and query string. --spec url(Req) -> {undefined | binary(), Req} when Req::req(). +-spec url(req()) -> undefined | binary(). url(Req=#http_req{}) -> - {HostURL, Req2} = host_url(Req), - url(HostURL, Req2). + HostURL = host_url(Req), + url(Req, HostURL). -url(undefined, Req=#http_req{}) -> - {undefined, Req}; -url(HostURL, Req=#http_req{path=Path, qs=QS}) -> +url(_, undefined) -> + undefined; +url(#http_req{path=Path, qs=QS}, HostURL) -> QS2 = case QS of <<>> -> <<>>; _ -> << "?", QS/binary >> end, - {<< HostURL/binary, Path/binary, QS2/binary >>, Req}. + << HostURL/binary, Path/binary, QS2/binary >>. --spec binding(atom(), Req) -> {any() | undefined, Req} when Req::req(). -binding(Name, Req) when is_atom(Name) -> +-spec binding(atom(), req()) -> any() | undefined. +binding(Name, Req) -> binding(Name, Req, undefined). --spec binding(atom(), Req, Default) - -> {any() | Default, Req} when Req::req(), Default::any(). +-spec binding(atom(), req(), Default) -> any() | Default when Default::any(). binding(Name, Req, Default) when is_atom(Name) -> case lists:keyfind(Name, 1, Req#http_req.bindings) of - {Name, Value} -> {Value, Req}; - false -> {Default, Req} + {_, Value} -> Value; + false -> Default end. --spec bindings(Req) -> {[{atom(), any()}], Req} when Req::req(). +-spec bindings(req()) -> [{atom(), any()}]. bindings(Req) -> - {Req#http_req.bindings, Req}. + Req#http_req.bindings. --spec header(binary(), Req) - -> {binary() | undefined, Req} when Req::req(). +-spec header(binary(), req()) -> binary() | undefined. header(Name, Req) -> header(Name, Req, undefined). --spec header(binary(), Req, Default) - -> {binary() | Default, Req} when Req::req(), Default::any(). +-spec header(binary(), req(), Default) -> binary() | Default when Default::any(). header(Name, Req, Default) -> case lists:keyfind(Name, 1, Req#http_req.headers) of - {Name, Value} -> {Value, Req}; - false -> {Default, Req} + {Name, Value} -> Value; + false -> Default end. --spec headers(Req) -> {cowboy:http_headers(), Req} when Req::req(). +-spec headers(req()) -> cowboy:http_headers(). headers(Req) -> - {Req#http_req.headers, Req}. - --spec parse_header(binary(), Req) - -> {ok, any(), Req} | {undefined, binary(), Req} - | {error, badarg} when Req::req(). -parse_header(Name, Req=#http_req{p_headers=PHeaders}) -> - case lists:keyfind(Name, 1, PHeaders) of - false -> parse_header(Name, Req, parse_header_default(Name)); - {Name, Value} -> {ok, Value, Req} - end. - --spec parse_header_default(binary()) -> any(). -parse_header_default(<<"transfer-encoding">>) -> [<<"identity">>]; -parse_header_default(_Name) -> undefined. - --spec parse_header(binary(), Req, any()) - -> {ok, any(), Req} | {undefined, binary(), Req} - | {error, badarg} when Req::req(). + Req#http_req.headers. + +-spec parse_header(binary(), Req) -> any() when Req::req(). +parse_header(Name = <<"content-length">>, Req) -> + parse_header(Name, Req, 0); +parse_header(Name = <<"cookie">>, Req) -> + parse_header(Name, Req, []); +parse_header(Name = <<"transfer-encoding">>, Req) -> + parse_header(Name, Req, [<<"identity">>]); +parse_header(Name, Req) -> + parse_header(Name, Req, undefined). + +-spec parse_header(binary(), Req, any()) -> any() when Req::req(). parse_header(Name = <<"accept">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:list(Value, fun cowboy_http:media_range/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:list(Value, fun cowboy_http:media_range/2) end); parse_header(Name = <<"accept-charset">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:nonempty_list(Value, fun cowboy_http:conneg/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:nonempty_list(Value, fun cowboy_http:conneg/2) end); parse_header(Name = <<"accept-encoding">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:list(Value, fun cowboy_http:conneg/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:list(Value, fun cowboy_http:conneg/2) end); parse_header(Name = <<"accept-language">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:nonempty_list(Value, fun cowboy_http:language_range/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:nonempty_list(Value, fun cowboy_http:language_range/2) end); parse_header(Name = <<"authorization">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:token_ci(Value, fun cowboy_http:authorization/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:token_ci(Value, fun cowboy_http:authorization/2) end); +parse_header(Name = <<"connection">>, Req, Default) -> + case header(Name, Req) of + undefined -> Default; + Value -> cow_http_hd:parse_connection(Value) + end; parse_header(Name = <<"content-length">>, Req, Default) -> - parse_header(Name, Req, Default, fun cow_http_hd:parse_content_length/1); + case header(Name, Req) of + undefined -> Default; + Value -> cow_http_hd:parse_content_length(Value) + end; parse_header(Name = <<"content-type">>, Req, Default) -> parse_header(Name, Req, Default, fun cowboy_http:content_type/1); parse_header(Name = <<"cookie">>, Req, Default) -> - parse_header(Name, Req, Default, fun cow_cookie:parse_cookie/1); + case header(Name, Req) of + undefined -> Default; + %% Flash player incorrectly sends an empty Cookie header. + <<>> -> Default; + Value -> cow_cookie:parse_cookie(Value) + end; parse_header(Name = <<"expect">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:nonempty_list(Value, fun cowboy_http:expectation/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:nonempty_list(Value, fun cowboy_http:expectation/2) end); parse_header(Name, Req, Default) when Name =:= <<"if-match">>; Name =:= <<"if-none-match">> -> @@ -387,80 +351,51 @@ parse_header(Name = <<"range">>, Req, Default) -> parse_header(Name, Req, Default) when Name =:= <<"sec-websocket-protocol">>; Name =:= <<"x-forwarded-for">> -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:nonempty_list(Value, fun cowboy_http:token/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:nonempty_list(Value, fun cowboy_http:token/2) end); parse_header(Name = <<"transfer-encoding">>, Req, Default) -> - parse_header(Name, Req, Default, fun cow_http_hd:parse_transfer_encoding/1); + case header(Name, Req) of + undefined -> Default; + Value -> cow_http_hd:parse_transfer_encoding(Value) + end; %% @todo Product version. parse_header(Name = <<"upgrade">>, Req, Default) -> - parse_header(Name, Req, Default, - fun (Value) -> - cowboy_http:nonempty_list(Value, fun cowboy_http:token_ci/2) - end); + parse_header(Name, Req, Default, fun (Value) -> + cowboy_http:nonempty_list(Value, fun cowboy_http:token_ci/2) end); parse_header(Name = <<"sec-websocket-extensions">>, Req, Default) -> - parse_header(Name, Req, Default, fun cowboy_http:parameterized_tokens/1); -parse_header(Name, Req, Default) -> - {Value, Req2} = header(Name, Req, Default), - {undefined, Value, Req2}. + parse_header(Name, Req, Default, fun cowboy_http:parameterized_tokens/1). -parse_header(Name, Req=#http_req{p_headers=PHeaders}, Default, Fun) -> +%% @todo Remove this function when everything moved to cowlib. +parse_header(Name, Req, Default, ParseFun) -> case header(Name, Req) of - {undefined, Req2} -> - {ok, Default, Req2#http_req{p_headers=[{Name, Default}|PHeaders]}}; - {Value, Req2} -> - case Fun(Value) of + undefined -> + Default; + Value -> + case ParseFun(Value) of {error, badarg} -> - {error, badarg}; - P -> - {ok, P, Req2#http_req{p_headers=[{Name, P}|PHeaders]}} + error(badarg); + ParsedValue -> + ParsedValue end end. --spec cookie(binary(), Req) - -> {binary() | undefined, Req} when Req::req(). -cookie(Name, Req) when is_binary(Name) -> - cookie(Name, Req, undefined). - --spec cookie(binary(), Req, Default) - -> {binary() | Default, Req} when Req::req(), Default::any(). -cookie(Name, Req=#http_req{cookies=undefined}, Default) when is_binary(Name) -> - case parse_header(<<"cookie">>, Req) of - {ok, undefined, Req2} -> - {Default, Req2#http_req{cookies=[]}}; - {ok, Cookies, Req2} -> - cookie(Name, Req2#http_req{cookies=Cookies}, Default) - end; -cookie(Name, Req, Default) -> - case lists:keyfind(Name, 1, Req#http_req.cookies) of - {Name, Value} -> {Value, Req}; - false -> {Default, Req} - end. +-spec parse_cookies(req()) -> [{binary(), binary()}]. +parse_cookies(Req) -> + parse_header(<<"cookie">>, Req). --spec cookies(Req) -> {list({binary(), binary()}), Req} when Req::req(). -cookies(Req=#http_req{cookies=undefined}) -> - case parse_header(<<"cookie">>, Req) of - {ok, undefined, Req2} -> - {[], Req2#http_req{cookies=[]}}; - {ok, Cookies, Req2} -> - cookies(Req2#http_req{cookies=Cookies}); - %% Flash player incorrectly sends an empty Cookie header. - {error, badarg} -> - {[], Req#http_req{cookies=[]}} - end; -cookies(Req=#http_req{cookies=Cookies}) -> - {Cookies, Req}. +-spec match_cookies(req(), cowboy:fields()) -> map(). +match_cookies(Req, Fields) -> + filter(kvlist_to_map(parse_cookies(Req), Fields), Fields). --spec meta(atom(), Req) -> {any() | undefined, Req} when Req::req(). +-spec meta(atom(), req()) -> any() | undefined. meta(Name, Req) -> meta(Name, Req, undefined). --spec meta(atom(), Req, any()) -> {any(), Req} when Req::req(). +-spec meta(atom(), req(), any()) -> any(). meta(Name, Req, Default) -> case lists:keyfind(Name, 1, Req#http_req.meta) of - {Name, Value} -> {Value, Req}; - false -> {Default, Req} + {Name, Value} -> Value; + false -> Default end. -spec set_meta(atom(), any(), Req) -> Req when Req::req(). @@ -482,37 +417,31 @@ has_body(Req) -> %% The length may not be known if Transfer-Encoding is not identity, %% and the body hasn't been read at the time of the call. --spec body_length(Req) -> {undefined | non_neg_integer(), Req} when Req::req(). +-spec body_length(req()) -> undefined | non_neg_integer(). body_length(Req) -> case parse_header(<<"transfer-encoding">>, Req) of - {ok, [<<"identity">>], Req2} -> - {ok, Length, Req3} = parse_header(<<"content-length">>, Req2, 0), - {Length, Req3}; - {ok, _, Req2} -> - {undefined, Req2} + [<<"identity">>] -> + parse_header(<<"content-length">>, Req); + _ -> + undefined end. --spec body(Req) - -> {ok, binary(), Req} | {more, binary(), Req} - | {error, atom()} when Req::req(). +-spec body(Req) -> {ok, binary(), Req} | {more, binary(), Req} when Req::req(). body(Req) -> body(Req, []). --spec body(Req, body_opts()) - -> {ok, binary(), Req} | {more, binary(), Req} - | {error, atom()} when Req::req(). +-spec body(Req, body_opts()) -> {ok, binary(), Req} | {more, binary(), Req} when Req::req(). body(Req=#http_req{body_state=waiting}, Opts) -> %% Send a 100 continue if needed (enabled by default). - Req1 = case lists:keyfind(continue, 1, Opts) of + case lists:keyfind(continue, 1, Opts) of {_, false} -> - Req; + ok; _ -> - {ok, ExpectHeader, Req0} = parse_header(<<"expect">>, Req), + ExpectHeader = parse_header(<<"expect">>, Req), ok = case ExpectHeader of - [<<"100-continue">>] -> continue(Req0); + [<<"100-continue">>] -> continue(Req); _ -> ok - end, - Req0 + end end, %% Initialize body streaming state. CFun = case lists:keyfind(content_decode, 1, Opts) of @@ -523,23 +452,22 @@ body(Req=#http_req{body_state=waiting}, Opts) -> end, case lists:keyfind(transfer_decode, 1, Opts) of false -> - case parse_header(<<"transfer-encoding">>, Req1) of - {ok, [<<"chunked">>], Req2} -> - body(Req2#http_req{body_state={stream, 0, + case parse_header(<<"transfer-encoding">>, Req) of + [<<"chunked">>] -> + body(Req#http_req{body_state={stream, 0, fun cow_http_te:stream_chunked/2, {0, 0}, CFun}}, Opts); - {ok, [<<"identity">>], Req2} -> - {Len, Req3} = body_length(Req2), - case Len of + [<<"identity">>] -> + case body_length(Req) of 0 -> - {ok, <<>>, Req3#http_req{body_state=done}}; - _ -> - body(Req3#http_req{body_state={stream, Len, + {ok, <<>>, Req#http_req{body_state=done}}; + Len -> + body(Req#http_req{body_state={stream, Len, fun cow_http_te:stream_identity/2, {0, Len}, CFun}}, Opts) end end; {_, TFun, TState} -> - body(Req1#http_req{body_state={stream, 0, + body(Req#http_req{body_state={stream, 0, TFun, TState, CFun}}, Opts) end; body(Req=#http_req{body_state=done}, _) -> @@ -568,27 +496,20 @@ body_loop(Req=#http_req{buffer=Buffer, body_state={stream, Length, _, _, _}}, body_decode(Req, ReadTimeout) end, case {Tag, Res} of - {ok, {ok, Data}} -> + {ok, Data} -> {ok, << Acc/binary, Data/binary >>, Req2}; - {more, {ok, Data}} -> + {more, Data} -> Acc2 = << Acc/binary, Data/binary >>, case byte_size(Acc2) >= ChunkLength of true -> {more, Acc2, Req2}; false -> body_loop(Req2, ReadTimeout, ReadLength, ChunkLength, Acc2) - end; - _ -> %% Error. - Res + end end. body_recv(Req=#http_req{transport=Transport, socket=Socket, buffer=Buffer}, ReadTimeout, ReadLength) -> - case Transport:recv(Socket, ReadLength, ReadTimeout) of - {ok, Data} -> - body_decode(Req#http_req{buffer= << Buffer/binary, Data/binary >>}, - ReadTimeout); - Error = {error, _} -> - {error, Error, Req} - end. + {ok, Data} = Transport:recv(Socket, ReadLength, ReadTimeout), + body_decode(Req#http_req{buffer= << Buffer/binary, Data/binary >>}, ReadTimeout). %% Two decodings happen. First a decoding function is applied to the %% transferred data, and then another is applied to the actual content. @@ -617,26 +538,20 @@ body_decode(Req=#http_req{buffer=Data, body_state={stream, _, {more, CDecode(Data2), Req#http_req{body_state={stream, 0, TDecode, TState2, CDecode}, buffer=Rest}}; {done, TotalLength, Rest} -> - {ok, {ok, <<>>}, body_decode_end(Req, TotalLength, Rest)}; + {ok, <<>>, body_decode_end(Req, TotalLength, Rest)}; {done, Data2, TotalLength, Rest} -> {ok, CDecode(Data2), body_decode_end(Req, TotalLength, Rest)} end. -body_decode_end(Req=#http_req{headers=Headers, p_headers=PHeaders}, - TotalLength, Rest) -> +body_decode_end(Req=#http_req{headers=Headers}, TotalLength, Rest) -> Headers2 = lists:keystore(<<"content-length">>, 1, Headers, {<<"content-length">>, integer_to_binary(TotalLength)}), %% At this point we just assume TEs were all decoded. Headers3 = lists:keydelete(<<"transfer-encoding">>, 1, Headers2), - PHeaders2 = lists:keystore(<<"content-length">>, 1, PHeaders, - {<<"content-length">>, TotalLength}), - PHeaders3 = lists:keydelete(<<"transfer-encoding">>, 1, PHeaders2), - Req#http_req{buffer=Rest, body_state=done, - headers=Headers3, p_headers=PHeaders3}. - --spec body_qs(Req) - -> {ok, [{binary(), binary() | true}], Req} | {error, atom()} - when Req::req(). + Req#http_req{buffer=Rest, body_state=done, headers=Headers3}. + +-spec body_qs(Req) -> {ok, [{binary(), binary() | true}], Req} + | {badlength, Req} when Req::req(). body_qs(Req) -> body_qs(Req, [ {length, 64000}, @@ -644,15 +559,13 @@ body_qs(Req) -> {read_timeout, 5000}]). -spec body_qs(Req, body_opts()) -> {ok, [{binary(), binary() | true}], Req} - | {badlength, Req} | {error, atom()} when Req::req(). + | {badlength, Req} when Req::req(). body_qs(Req, Opts) -> case body(Req, Opts) of {ok, Body, Req2} -> {ok, cow_qs:parse_qs(Body), Req2}; {more, _, Req2} -> - {badlength, Req2}; - {error, Reason} -> - {error, Reason} + {badlength, Req2} end. %% Multipart API. @@ -730,10 +643,9 @@ part_body(Buffer, Opts, Req=#http_req{multipart={Boundary, _}}, Acc) -> end. init_multipart(Req) -> - {ok, {<<"multipart">>, _, Params}, Req2} - = parse_header(<<"content-type">>, Req), + {<<"multipart">>, _, Params} = parse_header(<<"content-type">>, Req), {_, Boundary} = lists:keyfind(<<"boundary">>, 1, Params), - Req2#http_req{multipart={Boundary, <<>>}}. + Req#http_req{multipart={Boundary, <<>>}}. stream_multipart(Req=#http_req{body_state=BodyState, multipart={_, <<>>}}, Opts) -> true = BodyState =/= done, @@ -801,18 +713,18 @@ delete_resp_header(Name, Req=#http_req{resp_headers=RespHeaders}) -> RespHeaders2 = lists:keydelete(Name, 1, RespHeaders), Req#http_req{resp_headers=RespHeaders2}. --spec reply(cowboy:http_status(), Req) -> {ok, Req} when Req::req(). +-spec reply(cowboy:http_status(), Req) -> Req when Req::req(). reply(Status, Req=#http_req{resp_body=Body}) -> reply(Status, [], Body, Req). -spec reply(cowboy:http_status(), cowboy:http_headers(), Req) - -> {ok, Req} when Req::req(). + -> Req when Req::req(). reply(Status, Headers, Req=#http_req{resp_body=Body}) -> reply(Status, Headers, Body, Req). -spec reply(cowboy:http_status(), cowboy:http_headers(), iodata() | {non_neg_integer() | resp_body_fun()}, Req) - -> {ok, Req} when Req::req(). + -> Req when Req::req(). reply(Status, Headers, Body, Req=#http_req{ socket=Socket, transport=Transport, version=Version, connection=Connection, @@ -887,13 +799,13 @@ reply(Status, Headers, Body, Req=#http_req{ RespHeaders, HTTP11Headers, Method, iolist_size(Body)), Req2#http_req{connection=RespConn} end, - {ok, Req3#http_req{resp_state=done, resp_headers=[], resp_body= <<>>}}. + Req3#http_req{resp_state=done, resp_headers=[], resp_body= <<>>}. reply_may_compress(Status, Headers, Body, Req, RespHeaders, HTTP11Headers, Method) -> BodySize = iolist_size(Body), - case parse_header(<<"accept-encoding">>, Req) of - {ok, Encodings, Req2} -> + try parse_header(<<"accept-encoding">>, Req) of + Encodings -> CanGzip = (BodySize > 300) andalso (false =:= lists:keyfind(<<"content-encoding">>, 1, Headers)) @@ -908,22 +820,22 @@ reply_may_compress(Status, Headers, Body, Req, case CanGzip of true -> GzBody = zlib:gzip(Body), - {_, Req3} = response(Status, Headers, RespHeaders, [ + {_, Req2} = response(Status, Headers, RespHeaders, [ {<<"content-length">>, integer_to_list(byte_size(GzBody))}, {<<"content-encoding">>, <<"gzip">>}, {<<"date">>, cowboy_clock:rfc1123()}, {<<"server">>, <<"Cowboy">>} |HTTP11Headers], case Method of <<"HEAD">> -> <<>>; _ -> GzBody end, - Req2), - Req3; + Req), + Req2; false -> reply_no_compress(Status, Headers, Body, Req, RespHeaders, HTTP11Headers, Method, BodySize) - end; - {error, badarg} -> - reply_no_compress(Status, Headers, Body, Req, - RespHeaders, HTTP11Headers, Method, BodySize) + end + catch _:_ -> + reply_no_compress(Status, Headers, Body, Req, + RespHeaders, HTTP11Headers, Method, BodySize) end. reply_no_compress(Status, Headers, Body, Req, @@ -937,17 +849,17 @@ reply_no_compress(Status, Headers, Body, Req, Req), Req2. --spec chunked_reply(cowboy:http_status(), Req) -> {ok, Req} when Req::req(). +-spec chunked_reply(cowboy:http_status(), Req) -> Req when Req::req(). chunked_reply(Status, Req) -> chunked_reply(Status, [], Req). -spec chunked_reply(cowboy:http_status(), cowboy:http_headers(), Req) - -> {ok, Req} when Req::req(). + -> Req when Req::req(). chunked_reply(Status, Headers, Req) -> {_, Req2} = chunked_response(Status, Headers, Req), - {ok, Req2}. + Req2. --spec chunk(iodata(), req()) -> ok | {error, atom()}. +-spec chunk(iodata(), req()) -> ok. chunk(_Data, #http_req{method= <<"HEAD">>}) -> ok; chunk(Data, #http_req{socket=Socket, transport=cowboy_spdy, @@ -955,10 +867,10 @@ chunk(Data, #http_req{socket=Socket, transport=cowboy_spdy, cowboy_spdy:stream_data(Socket, Data); chunk(Data, #http_req{socket=Socket, transport=Transport, resp_state=stream}) -> - Transport:send(Socket, Data); + ok = Transport:send(Socket, Data); chunk(Data, #http_req{socket=Socket, transport=Transport, resp_state=chunks}) -> - Transport:send(Socket, [integer_to_list(iolist_size(Data), 16), + ok = Transport:send(Socket, [integer_to_list(iolist_size(Data), 16), <<"\r\n">>, Data, <<"\r\n">>]). %% If ever made public, need to send nothing if HEAD. @@ -971,20 +883,20 @@ last_chunk(Req=#http_req{socket=Socket, transport=Transport}) -> Req#http_req{resp_state=done}. -spec upgrade_reply(cowboy:http_status(), cowboy:http_headers(), Req) - -> {ok, Req} when Req::req(). + -> Req when Req::req(). upgrade_reply(Status, Headers, Req=#http_req{transport=Transport, resp_state=waiting, resp_headers=RespHeaders}) when Transport =/= cowboy_spdy -> {_, Req2} = response(Status, Headers, RespHeaders, [ {<<"connection">>, <<"Upgrade">>} ], <<>>, Req), - {ok, Req2#http_req{resp_state=done, resp_headers=[], resp_body= <<>>}}. + Req2#http_req{resp_state=done, resp_headers=[], resp_body= <<>>}. --spec continue(req()) -> ok | {error, atom()}. +-spec continue(req()) -> ok. continue(#http_req{socket=Socket, transport=Transport, version=Version}) -> HTTPVer = atom_to_binary(Version, latin1), - Transport:send(Socket, + ok = Transport:send(Socket, << HTTPVer/binary, " ", (status(100))/binary, "\r\n\r\n" >>). %% Meant to be used internally for sending errors after crashes. @@ -997,9 +909,7 @@ maybe_reply(Stacktrace, Req) -> ok end. -do_maybe_reply([ - {cow_http_hd, _, _, _}, - {cowboy_req, parse_header, _, _}|_], Req) -> +do_maybe_reply([{cow_http_hd, _, _, _}|_], Req) -> cowboy_req:reply(400, Req); do_maybe_reply(_, Req) -> cowboy_req:reply(500, Req). @@ -1039,7 +949,6 @@ g(bindings, #http_req{bindings=Ret}) -> Ret; g(body_state, #http_req{body_state=Ret}) -> Ret; g(buffer, #http_req{buffer=Ret}) -> Ret; g(connection, #http_req{connection=Ret}) -> Ret; -g(cookies, #http_req{cookies=Ret}) -> Ret; g(headers, #http_req{headers=Ret}) -> Ret; g(host, #http_req{host=Ret}) -> Ret; g(host_info, #http_req{host_info=Ret}) -> Ret; @@ -1047,14 +956,12 @@ g(meta, #http_req{meta=Ret}) -> Ret; g(method, #http_req{method=Ret}) -> Ret; g(multipart, #http_req{multipart=Ret}) -> Ret; g(onresponse, #http_req{onresponse=Ret}) -> Ret; -g(p_headers, #http_req{p_headers=Ret}) -> Ret; g(path, #http_req{path=Ret}) -> Ret; g(path_info, #http_req{path_info=Ret}) -> Ret; g(peer, #http_req{peer=Ret}) -> Ret; g(pid, #http_req{pid=Ret}) -> Ret; g(port, #http_req{port=Ret}) -> Ret; g(qs, #http_req{qs=Ret}) -> Ret; -g(qs_vals, #http_req{qs_vals=Ret}) -> Ret; g(resp_body, #http_req{resp_body=Ret}) -> Ret; g(resp_compress, #http_req{resp_compress=Ret}) -> Ret; g(resp_headers, #http_req{resp_headers=Ret}) -> Ret; @@ -1069,7 +976,6 @@ set([{bindings, Val}|Tail], Req) -> set(Tail, Req#http_req{bindings=Val}); set([{body_state, Val}|Tail], Req) -> set(Tail, Req#http_req{body_state=Val}); set([{buffer, Val}|Tail], Req) -> set(Tail, Req#http_req{buffer=Val}); set([{connection, Val}|Tail], Req) -> set(Tail, Req#http_req{connection=Val}); -set([{cookies, Val}|Tail], Req) -> set(Tail, Req#http_req{cookies=Val}); set([{headers, Val}|Tail], Req) -> set(Tail, Req#http_req{headers=Val}); set([{host, Val}|Tail], Req) -> set(Tail, Req#http_req{host=Val}); set([{host_info, Val}|Tail], Req) -> set(Tail, Req#http_req{host_info=Val}); @@ -1077,14 +983,12 @@ set([{meta, Val}|Tail], Req) -> set(Tail, Req#http_req{meta=Val}); set([{method, Val}|Tail], Req) -> set(Tail, Req#http_req{method=Val}); set([{multipart, Val}|Tail], Req) -> set(Tail, Req#http_req{multipart=Val}); set([{onresponse, Val}|Tail], Req) -> set(Tail, Req#http_req{onresponse=Val}); -set([{p_headers, Val}|Tail], Req) -> set(Tail, Req#http_req{p_headers=Val}); set([{path, Val}|Tail], Req) -> set(Tail, Req#http_req{path=Val}); set([{path_info, Val}|Tail], Req) -> set(Tail, Req#http_req{path_info=Val}); set([{peer, Val}|Tail], Req) -> set(Tail, Req#http_req{peer=Val}); set([{pid, Val}|Tail], Req) -> set(Tail, Req#http_req{pid=Val}); set([{port, Val}|Tail], Req) -> set(Tail, Req#http_req{port=Val}); set([{qs, Val}|Tail], Req) -> set(Tail, Req#http_req{qs=Val}); -set([{qs_vals, Val}|Tail], Req) -> set(Tail, Req#http_req{qs_vals=Val}); set([{resp_body, Val}|Tail], Req) -> set(Tail, Req#http_req{resp_body=Val}); set([{resp_headers, Val}|Tail], Req) -> set(Tail, Req#http_req{resp_headers=Val}); set([{resp_state, Val}|Tail], Req) -> set(Tail, Req#http_req{resp_state=Val}); @@ -1102,10 +1006,8 @@ set_bindings(HostInfo, PathInfo, Bindings, Req) -> -spec compact(Req) -> Req when Req::req(). compact(Req) -> - Req#http_req{host_info=undefined, - path_info=undefined, qs_vals=undefined, - bindings=undefined, headers=[], - p_headers=[], cookies=[]}. + Req#http_req{host_info=undefined, path_info=undefined, + bindings=undefined, headers=[]}. -spec lock(Req) -> Req when Req::req(). lock(Req) -> @@ -1193,7 +1095,7 @@ response(Status, Headers, RespHeaders, DefaultHeaders, Body, Req=#http_req{ (status(Status2))/binary, "\r\n" >>, HeaderLines = [[Key, <<": ">>, Value, <<"\r\n">>] || {Key, Value} <- FullHeaders2], - Transport:send(Socket, [StatusLine, HeaderLines, <<"\r\n">>, Body2]), + ok = Transport:send(Socket, [StatusLine, HeaderLines, <<"\r\n">>, Body2]), ReqPid ! {?MODULE, resp_sent}, normal; _ -> @@ -1319,32 +1221,94 @@ status(510) -> <<"510 Not Extended">>; status(511) -> <<"511 Network Authentication Required">>; status(B) when is_binary(B) -> B. +%% Create map, convert keys to atoms and group duplicate keys into lists. +%% Keys that are not found in the user provided list are entirely skipped. +%% @todo Can probably be done directly while parsing. +kvlist_to_map(KvList, Fields) -> + Keys = [case K of + {Key, _} -> Key; + {Key, _, _} -> Key; + Key -> Key + end || K <- Fields], + kvlist_to_map(KvList, Keys, #{}). + +kvlist_to_map([], _, Map) -> + Map; +kvlist_to_map([{Key, Value}|Tail], Keys, Map) -> + try binary_to_existing_atom(Key, utf8) of + Atom -> + case lists:member(Atom, Keys) of + true -> + case maps:find(Atom, Map) of + {ok, MapValue} when is_list(MapValue) -> + kvlist_to_map(Tail, Keys, + maps:put(Atom, [Value|MapValue], Map)); + {ok, MapValue} -> + kvlist_to_map(Tail, Keys, + maps:put(Atom, [Value, MapValue], Map)); + error -> + kvlist_to_map(Tail, Keys, + maps:put(Atom, Value, Map)) + end; + false -> + kvlist_to_map(Tail, Keys, Map) + end + catch error:badarg -> + kvlist_to_map(Tail, Keys, Map) + end. + +%% Loop through fields, if value is missing and no default, crash; +%% else if value is missing and has a default, set default; +%% otherwise apply constraints. If constraint fails, crash. +filter(Map, []) -> + Map; +filter(Map, [{Key, Constraints}|Tail]) -> + filter_constraints(Map, Tail, Key, maps:get(Key, Map), Constraints); +filter(Map, [{Key, Constraints, Default}|Tail]) -> + case maps:find(Key, Map) of + {ok, Value} -> + filter_constraints(Map, Tail, Key, Value, Constraints); + error -> + filter(maps:put(Key, Default, Map), Tail) + end; +filter(Map, [Key|Tail]) -> + true = maps:is_key(Key, Map), + filter(Map, Tail). + +filter_constraints(Map, Tail, Key, Value, Constraints) -> + case cowboy_constraints:validate(Value, Constraints) of + true -> + filter(Map, Tail); + {true, Value2} -> + filter(maps:put(Key, Value2, Map), Tail) + end. + %% Tests. -ifdef(TEST). url_test() -> - {undefined, _} = + undefined = url(#http_req{transport=ranch_tcp, host= <<>>, port= undefined, path= <<>>, qs= <<>>, pid=self()}), - {<<"http://localhost/path">>, _ } = + <<"http://localhost/path">> = url(#http_req{transport=ranch_tcp, host= <<"localhost">>, port=80, path= <<"/path">>, qs= <<>>, pid=self()}), - {<<"http://localhost:443/path">>, _} = + <<"http://localhost:443/path">> = url(#http_req{transport=ranch_tcp, host= <<"localhost">>, port=443, path= <<"/path">>, qs= <<>>, pid=self()}), - {<<"http://localhost:8080/path">>, _} = + <<"http://localhost:8080/path">> = url(#http_req{transport=ranch_tcp, host= <<"localhost">>, port=8080, path= <<"/path">>, qs= <<>>, pid=self()}), - {<<"http://localhost:8080/path?dummy=2785">>, _} = + <<"http://localhost:8080/path?dummy=2785">> = url(#http_req{transport=ranch_tcp, host= <<"localhost">>, port=8080, path= <<"/path">>, qs= <<"dummy=2785">>, pid=self()}), - {<<"https://localhost/path">>, _} = + <<"https://localhost/path">> = url(#http_req{transport=ranch_ssl, host= <<"localhost">>, port=443, path= <<"/path">>, qs= <<>>, pid=self()}), - {<<"https://localhost:8443/path">>, _} = + <<"https://localhost:8443/path">> = url(#http_req{transport=ranch_ssl, host= <<"localhost">>, port=8443, path= <<"/path">>, qs= <<>>, pid=self()}), - {<<"https://localhost:8443/path?dummy=2785">>, _} = + <<"https://localhost:8443/path?dummy=2785">> = url(#http_req{transport=ranch_ssl, host= <<"localhost">>, port=8443, path= <<"/path">>, qs= <<"dummy=2785">>, pid=self()}), ok. diff --git a/src/cowboy_rest.erl b/src/cowboy_rest.erl index f779612..4ea3010 100644 --- a/src/cowboy_rest.erl +++ b/src/cowboy_rest.erl @@ -58,7 +58,7 @@ -spec upgrade(Req, Env, module(), any()) -> {ok, Req, Env} when Req::cowboy_req:req(), Env::cowboy_middleware:env(). upgrade(Req, Env, Handler, HandlerOpts) -> - Method = cowboy_req:get(method, Req), + Method = cowboy_req:method(Req), case erlang:function_exported(Handler, rest_init, 2) of true -> try Handler:rest_init(Req, HandlerOpts) of @@ -215,16 +215,15 @@ content_types_provided(Req, State) -> no_call -> State2 = State#state{ content_types_p=[{{<<"text">>, <<"html">>, '*'}, to_html}]}, - case cowboy_req:parse_header(<<"accept">>, Req) of - {error, badarg} -> - respond(Req, State2, 400); - {ok, undefined, Req2} -> + try cowboy_req:parse_header(<<"accept">>, Req) of + undefined -> languages_provided( - cowboy_req:set_meta(media_type, {<<"text">>, <<"html">>, []}, Req2), + cowboy_req:set_meta(media_type, {<<"text">>, <<"html">>, []}, Req), State2#state{content_type_a={{<<"text">>, <<"html">>, []}, to_html}}); - {ok, Accept, Req2} -> - Accept2 = prioritize_accept(Accept), - choose_media_type(Req2, State2, Accept2) + Accept -> + choose_media_type(Req, State2, prioritize_accept(Accept)) + catch _:_ -> + respond(Req, State2, 400) end; {halt, Req2, HandlerState} -> terminate(Req2, State#state{handler_state=HandlerState}); @@ -234,17 +233,16 @@ content_types_provided(Req, State) -> CTP2 = [normalize_content_types(P) || P <- CTP], State2 = State#state{ handler_state=HandlerState, content_types_p=CTP2}, - case cowboy_req:parse_header(<<"accept">>, Req2) of - {error, badarg} -> - respond(Req2, State2, 400); - {ok, undefined, Req3} -> + try cowboy_req:parse_header(<<"accept">>, Req2) of + undefined -> {PMT, _Fun} = HeadCTP = hd(CTP2), languages_provided( - cowboy_req:set_meta(media_type, PMT, Req3), + cowboy_req:set_meta(media_type, PMT, Req2), State2#state{content_type_a=HeadCTP}); - {ok, Accept, Req3} -> - Accept2 = prioritize_accept(Accept), - choose_media_type(Req3, State2, Accept2) + Accept -> + choose_media_type(Req2, State2, prioritize_accept(Accept)) + catch _:_ -> + respond(Req2, State2, 400) end end. @@ -335,14 +333,12 @@ languages_provided(Req, State) -> not_acceptable(Req2, State#state{handler_state=HandlerState}); {LP, Req2, HandlerState} -> State2 = State#state{handler_state=HandlerState, languages_p=LP}, - {ok, AcceptLanguage, Req3} = - cowboy_req:parse_header(<<"accept-language">>, Req2), - case AcceptLanguage of + case cowboy_req:parse_header(<<"accept-language">>, Req2) of undefined -> - set_language(Req3, State2#state{language_a=hd(LP)}); + set_language(Req2, State2#state{language_a=hd(LP)}); AcceptLanguage -> AcceptLanguage2 = prioritize_languages(AcceptLanguage), - choose_language(Req3, State2, AcceptLanguage2) + choose_language(Req2, State2, AcceptLanguage2) end end. @@ -397,14 +393,12 @@ charsets_provided(Req, State) -> not_acceptable(Req2, State#state{handler_state=HandlerState}); {CP, Req2, HandlerState} -> State2 = State#state{handler_state=HandlerState, charsets_p=CP}, - {ok, AcceptCharset, Req3} = - cowboy_req:parse_header(<<"accept-charset">>, Req2), - case AcceptCharset of + case cowboy_req:parse_header(<<"accept-charset">>, Req2) of undefined -> - set_content_type(Req3, State2#state{charset_a=hd(CP)}); + set_content_type(Req2, State2#state{charset_a=hd(CP)}); AcceptCharset -> AcceptCharset2 = prioritize_charsets(AcceptCharset), - choose_charset(Req3, State2, AcceptCharset2) + choose_charset(Req2, State2, AcceptCharset2) end end. @@ -524,12 +518,12 @@ resource_exists(Req, State) -> if_match_exists(Req, State) -> State2 = State#state{exists=true}, case cowboy_req:parse_header(<<"if-match">>, Req) of - {ok, undefined, Req2} -> - if_unmodified_since_exists(Req2, State2); - {ok, '*', Req2} -> - if_unmodified_since_exists(Req2, State2); - {ok, ETagsList, Req2} -> - if_match(Req2, State2, ETagsList) + undefined -> + if_unmodified_since_exists(Req, State2); + '*' -> + if_unmodified_since_exists(Req, State2); + ETagsList -> + if_match(Req, State2, ETagsList) end. if_match(Req, State, EtagsList) -> @@ -546,18 +540,18 @@ if_match(Req, State, EtagsList) -> if_match_must_not_exist(Req, State) -> case cowboy_req:header(<<"if-match">>, Req) of - {undefined, Req2} -> is_put_to_missing_resource(Req2, State); - {_Any, Req2} -> precondition_failed(Req2, State) + undefined -> is_put_to_missing_resource(Req, State); + _ -> precondition_failed(Req, State) end. if_unmodified_since_exists(Req, State) -> - case cowboy_req:parse_header(<<"if-unmodified-since">>, Req) of - {ok, undefined, Req2} -> - if_none_match_exists(Req2, State); - {ok, IfUnmodifiedSince, Req2} -> - if_unmodified_since(Req2, State, IfUnmodifiedSince); - {error, badarg} -> - if_none_match_exists(Req, State) + try cowboy_req:parse_header(<<"if-unmodified-since">>, Req) of + undefined -> + if_none_match_exists(Req, State); + IfUnmodifiedSince -> + if_unmodified_since(Req, State, IfUnmodifiedSince) + catch _:_ -> + if_none_match_exists(Req, State) end. %% If LastModified is the atom 'no_call', we continue. @@ -574,12 +568,12 @@ if_unmodified_since(Req, State, IfUnmodifiedSince) -> if_none_match_exists(Req, State) -> case cowboy_req:parse_header(<<"if-none-match">>, Req) of - {ok, undefined, Req2} -> - if_modified_since_exists(Req2, State); - {ok, '*', Req2} -> - precondition_is_head_get(Req2, State); - {ok, EtagsList, Req2} -> - if_none_match(Req2, State, EtagsList) + undefined -> + if_modified_since_exists(Req, State); + '*' -> + precondition_is_head_get(Req, State); + EtagsList -> + if_none_match(Req, State, EtagsList) end. if_none_match(Req, State, EtagsList) -> @@ -605,13 +599,13 @@ precondition_is_head_get(Req, State) -> precondition_failed(Req, State). if_modified_since_exists(Req, State) -> - case cowboy_req:parse_header(<<"if-modified-since">>, Req) of - {ok, undefined, Req2} -> - method(Req2, State); - {ok, IfModifiedSince, Req2} -> - if_modified_since_now(Req2, State, IfModifiedSince); - {error, badarg} -> - method(Req, State) + try cowboy_req:parse_header(<<"if-modified-since">>, Req) of + undefined -> + method(Req, State); + IfModifiedSince -> + if_modified_since_now(Req, State, IfModifiedSince) + catch _:_ -> + method(Req, State) end. if_modified_since_now(Req, State, IfModifiedSince) -> @@ -741,11 +735,11 @@ accept_resource(Req, State) -> {CTA, Req2, HandlerState} -> CTA2 = [normalize_content_types(P) || P <- CTA], State2 = State#state{handler_state=HandlerState}, - case cowboy_req:parse_header(<<"content-type">>, Req2) of - {ok, ContentType, Req3} -> - choose_content_type(Req3, State2, ContentType, CTA2); - {error, badarg} -> - respond(Req2, State2, 415) + try cowboy_req:parse_header(<<"content-type">>, Req2) of + ContentType -> + choose_content_type(Req2, State2, ContentType, CTA2) + catch _:_ -> + respond(Req2, State2, 415) end end. @@ -990,8 +984,7 @@ next(Req, State, StatusCode) when is_integer(StatusCode) -> respond(Req, State, StatusCode). respond(Req, State, StatusCode) -> - {ok, Req2} = cowboy_req:reply(StatusCode, Req), - terminate(Req2, State). + terminate(cowboy_req:reply(StatusCode, Req), State). terminate(Req, State=#state{env=Env}) -> rest_terminate(Req, State), diff --git a/src/cowboy_router.erl b/src/cowboy_router.erl index ef91c6d..f5b2f26 100644 --- a/src/cowboy_router.erl +++ b/src/cowboy_router.erl @@ -165,7 +165,8 @@ compile_brackets_split(<< C, Rest/binary >>, Acc, N) -> when Req::cowboy_req:req(), Env::cowboy_middleware:env(). execute(Req, Env) -> {_, Dispatch} = lists:keyfind(dispatch, 1, Env), - [Host, Path] = cowboy_req:get([host, path], Req), + Host = cowboy_req:host(Req), + Path = cowboy_req:path(Req), case match(Dispatch, Host, Path) of {ok, Handler, HandlerOpts, Bindings, HostInfo, PathInfo} -> Req2 = cowboy_req:set_bindings(HostInfo, PathInfo, Bindings, Req), @@ -316,7 +317,7 @@ split_host(Host, Acc) -> %% Following RFC2396, this function may return path segments containing any %% character, including <em>/</em> if, and only if, a <em>/</em> was escaped %% and part of a path segment. --spec split_path(binary()) -> tokens(). +-spec split_path(binary()) -> tokens() | badrequest. split_path(<< $/, Path/bits >>) -> split_path(Path, []); split_path(_) -> diff --git a/src/cowboy_static.erl b/src/cowboy_static.erl index fae4568..1d5286e 100644 --- a/src/cowboy_static.erl +++ b/src/cowboy_static.erl @@ -87,14 +87,14 @@ rest_init_dir(Req, Path, Extra) when is_list(Path) -> rest_init_dir(Req, list_to_binary(Path), Extra); rest_init_dir(Req, Path, Extra) -> Dir = fullpath(filename:absname(Path)), - {PathInfo, Req2} = cowboy_req:path_info(Req), + PathInfo = cowboy_req:path_info(Req), Filepath = filename:join([Dir|PathInfo]), Len = byte_size(Dir), case fullpath(Filepath) of << Dir:Len/binary, $/, _/binary >> -> - rest_init_info(Req2, Filepath, Extra); + rest_init_info(Req, Filepath, Extra); _ -> - {ok, Req2, error} + {ok, Req, error} end. fullpath(Path) -> diff --git a/src/cowboy_websocket.erl b/src/cowboy_websocket.erl index c0f94c4..1c115b5 100644 --- a/src/cowboy_websocket.erl +++ b/src/cowboy_websocket.erl @@ -78,26 +78,26 @@ upgrade(Req, Env, Handler, HandlerOpts) -> -spec websocket_upgrade(#state{}, Req) -> {ok, #state{}, Req} when Req::cowboy_req:req(). websocket_upgrade(State, Req) -> - {ok, ConnTokens, Req2} - = cowboy_req:parse_header(<<"connection">>, Req), + ConnTokens = cowboy_req:parse_header(<<"connection">>, Req), true = lists:member(<<"upgrade">>, ConnTokens), %% @todo Should probably send a 426 if the Upgrade header is missing. - {ok, [<<"websocket">>], Req3} - = cowboy_req:parse_header(<<"upgrade">>, Req2), - {Version, Req4} = cowboy_req:header(<<"sec-websocket-version">>, Req3), + [<<"websocket">>] = cowboy_req:parse_header(<<"upgrade">>, Req), + Version = cowboy_req:header(<<"sec-websocket-version">>, Req), IntVersion = list_to_integer(binary_to_list(Version)), true = (IntVersion =:= 7) orelse (IntVersion =:= 8) orelse (IntVersion =:= 13), - {Key, Req5} = cowboy_req:header(<<"sec-websocket-key">>, Req4), + Key = cowboy_req:header(<<"sec-websocket-key">>, Req), false = Key =:= undefined, websocket_extensions(State#state{key=Key}, - cowboy_req:set_meta(websocket_version, IntVersion, Req5)). + cowboy_req:set_meta(websocket_version, IntVersion, Req)). -spec websocket_extensions(#state{}, Req) -> {ok, #state{}, Req} when Req::cowboy_req:req(). websocket_extensions(State, Req) -> case cowboy_req:parse_header(<<"sec-websocket-extensions">>, Req) of - {ok, Extensions, Req2} when Extensions =/= undefined -> + undefined -> + {ok, State, cowboy_req:set_meta(websocket_compress, false, Req)}; + Extensions -> [Compress] = cowboy_req:get([resp_compress], Req), case lists:keyfind(<<"x-webkit-deflate-frame">>, 1, Extensions) of {<<"x-webkit-deflate-frame">>, []} when Compress =:= true -> @@ -115,12 +115,10 @@ websocket_extensions(State, Req) -> deflate_frame = true, inflate_state = Inflate, deflate_state = Deflate - }, cowboy_req:set_meta(websocket_compress, true, Req2)}; + }, cowboy_req:set_meta(websocket_compress, true, Req)}; _ -> - {ok, State, cowboy_req:set_meta(websocket_compress, false, Req2)} - end; - _ -> - {ok, State, cowboy_req:set_meta(websocket_compress, false, Req)} + {ok, State, cowboy_req:set_meta(websocket_compress, false, Req)} + end end. -spec handler_init(#state{}, Req, any()) @@ -168,12 +166,8 @@ websocket_handshake(State=#state{ false -> []; true -> [{<<"sec-websocket-extensions">>, <<"x-webkit-deflate-frame">>}] end, - {ok, Req2} = cowboy_req:upgrade_reply( - 101, - [{<<"upgrade">>, <<"websocket">>}, - {<<"sec-websocket-accept">>, Challenge}| - Extensions], - Req), + Req2 = cowboy_req:upgrade_reply(101, [{<<"upgrade">>, <<"websocket">>}, + {<<"sec-websocket-accept">>, Challenge}|Extensions], Req), %% Flush the resp_sent message before moving on. receive {cowboy_req, resp_sent} -> ok after 0 -> ok end, State2 = handler_loop_timeout(State), diff --git a/test/handlers/long_polling_h.erl b/test/handlers/long_polling_h.erl index 21f1d4d..1c86aed 100644 --- a/test/handlers/long_polling_h.erl +++ b/test/handlers/long_polling_h.erl @@ -15,8 +15,7 @@ init(_, Req, _) -> {loop, Req, 2, 5000, hibernate}. info(timeout, Req, 0) -> - {ok, Req2} = cowboy_req:reply(102, Req), - {ok, Req2, 0}; + {ok, cowboy_req:reply(102, Req), 0}; info(timeout, Req, Count) -> erlang:send_after(200, self(), timeout), {loop, Req, Count - 1, hibernate}. diff --git a/test/handlers/loop_handler_body_h.erl b/test/handlers/loop_handler_body_h.erl index db69b02..559ef90 100644 --- a/test/handlers/loop_handler_body_h.erl +++ b/test/handlers/loop_handler_body_h.erl @@ -17,8 +17,7 @@ init(_, Req, _) -> info(timeout, Req, State) -> {ok, Body, Req2} = cowboy_req:body(Req), 100000 = byte_size(Body), - {ok, Req3} = cowboy_req:reply(200, Req2), - {ok, Req3, State}. + {ok, cowboy_req:reply(200, Req2), State}. terminate({normal, shutdown}, _, _) -> ok. diff --git a/test/handlers/loop_handler_timeout_h.erl b/test/handlers/loop_handler_timeout_h.erl index 1125046..3b158bf 100644 --- a/test/handlers/loop_handler_timeout_h.erl +++ b/test/handlers/loop_handler_timeout_h.erl @@ -16,8 +16,7 @@ init(_, Req, _) -> {loop, Req, undefined, 200, hibernate}. info(timeout, Req, State) -> - {ok, Req2} = cowboy_req:reply(500, Req), - {ok, Req2, State}. + {ok, cowboy_req:reply(500, Req), State}. terminate({normal, timeout}, _, _) -> ok. diff --git a/test/http_SUITE.erl b/test/http_SUITE.erl index 0417ad0..1bc13c1 100644 --- a/test/http_SUITE.erl +++ b/test/http_SUITE.erl @@ -592,13 +592,11 @@ onrequest_reply(Config) -> %% Hook for the above onrequest tests. do_onrequest_hook(Req) -> - case cowboy_req:qs_val(<<"reply">>, Req) of - {undefined, Req2} -> - cowboy_req:set_resp_header(<<"server">>, <<"Serenity">>, Req2); - {_, Req2} -> - {ok, Req3} = cowboy_req:reply( - 200, [], <<"replied!">>, Req2), - Req3 + case cowboy_req:match_qs(Req, [{reply, [], noreply}]) of + #{reply := noreply} -> + cowboy_req:set_resp_header(<<"server">>, <<"Serenity">>, Req); + _ -> + cowboy_req:reply(200, [], <<"replied!">>, Req) end. onresponse_capitalize(Config) -> @@ -612,8 +610,7 @@ onresponse_capitalize(Config) -> do_onresponse_capitalize_hook(Status, Headers, Body, Req) -> Headers2 = [{cowboy_bstr:capitalize_token(N), V} || {N, V} <- Headers], - {ok, Req2} = cowboy_req:reply(Status, Headers2, Body, Req), - Req2. + cowboy_req:reply(Status, Headers2, Body, Req). onresponse_crash(Config) -> ConnPid = gun_open(Config), @@ -630,9 +627,7 @@ onresponse_reply(Config) -> %% Hook for the above onresponse tests. do_onresponse_hook(_, Headers, _, Req) -> - {ok, Req2} = cowboy_req:reply( - <<"777 Lucky">>, [{<<"x-hook">>, <<"onresponse">>}|Headers], Req), - Req2. + cowboy_req:reply(<<"777 Lucky">>, [{<<"x-hook">>, <<"onresponse">>}|Headers], Req). parse_host(Config) -> ConnPid = gun_open(Config), diff --git a/test/http_SUITE_data/http_body_qs.erl b/test/http_SUITE_data/http_body_qs.erl index 8a438e6..09eebdb 100644 --- a/test/http_SUITE_data/http_body_qs.erl +++ b/test/http_SUITE_data/http_body_qs.erl @@ -8,10 +8,9 @@ init({_, http}, Req, _) -> {ok, Req, undefined}. handle(Req, State) -> - {Method, Req2} = cowboy_req:method(Req), - HasBody = cowboy_req:has_body(Req2), - {ok, Req3} = maybe_echo(Method, HasBody, Req2), - {ok, Req3, State}. + Method = cowboy_req:method(Req), + HasBody = cowboy_req:has_body(Req), + {ok, maybe_echo(Method, HasBody, Req), State}. maybe_echo(<<"POST">>, true, Req) -> case cowboy_req:body_qs(Req) of @@ -20,7 +19,6 @@ maybe_echo(<<"POST">>, true, Req) -> {ok, PostVals, Req2} -> echo(proplists:get_value(<<"echo">>, PostVals), Req2) end; - maybe_echo(<<"POST">>, false, Req) -> cowboy_req:reply(400, [], <<"Missing body.">>, Req); maybe_echo(_, _, Req) -> diff --git a/test/http_SUITE_data/http_chunked.erl b/test/http_SUITE_data/http_chunked.erl index 447c0f6..7f0d749 100644 --- a/test/http_SUITE_data/http_chunked.erl +++ b/test/http_SUITE_data/http_chunked.erl @@ -8,7 +8,7 @@ init({_Transport, http}, Req, _Opts) -> {ok, Req, undefined}. handle(Req, State) -> - {ok, Req2} = cowboy_req:chunked_reply(200, Req), + Req2 = cowboy_req:chunked_reply(200, Req), timer:sleep(100), cowboy_req:chunk("chunked_handler\r\n", Req2), timer:sleep(100), diff --git a/test/http_SUITE_data/http_echo_body.erl b/test/http_SUITE_data/http_echo_body.erl index 3334b95..986015a 100644 --- a/test/http_SUITE_data/http_echo_body.erl +++ b/test/http_SUITE_data/http_echo_body.erl @@ -9,21 +9,19 @@ init({_, http}, Req, _) -> handle(Req, State) -> true = cowboy_req:has_body(Req), - {ok, Req3} = case cowboy_req:body(Req, [{length, 1000000}]) of + Req3 = case cowboy_req:body(Req, [{length, 1000000}]) of {ok, Body, Req2} -> handle_body(Req2, Body); {more, _, Req2} -> handle_badlength(Req2) end, {ok, Req3, State}. handle_badlength(Req) -> - {ok, Req2} = cowboy_req:reply(413, [], <<"Request entity too large">>, Req), - {ok, Req2}. + cowboy_req:reply(413, [], <<"Request entity too large">>, Req). handle_body(Req, Body) -> - {Size, Req2} = cowboy_req:body_length(Req), + Size = cowboy_req:body_length(Req), Size = byte_size(Body), - {ok, Req3} = cowboy_req:reply(200, [], Body, Req2), - {ok, Req3}. + cowboy_req:reply(200, [], Body, Req). terminate(_, _, _) -> ok. diff --git a/test/http_SUITE_data/http_errors.erl b/test/http_SUITE_data/http_errors.erl index 35ac3bd..57fd684 100644 --- a/test/http_SUITE_data/http_errors.erl +++ b/test/http_SUITE_data/http_errors.erl @@ -5,18 +5,18 @@ -export([init/3, handle/2, terminate/3]). init({_Transport, http}, Req, _Opts) -> - {Case, Req1} = cowboy_req:qs_val(<<"case">>, Req), - case_init(Case, Req1). + #{'case' := Case} = cowboy_req:match_qs(Req, ['case']), + case_init(Case, Req). case_init(<<"init_before_reply">> = Case, _Req) -> cowboy_error_h:ignore(?MODULE, case_init, 2), erlang:error(Case); case_init(<<"init_after_reply">> = Case, Req) -> cowboy_error_h:ignore(?MODULE, case_init, 2), - {ok, _Req1} = cowboy_req:reply(200, [], "http_handler_crashes", Req), + _ = cowboy_req:reply(200, [], "http_handler_crashes", Req), erlang:error(Case); case_init(<<"init_reply_handle_error">> = Case, Req) -> - {ok, Req1} = cowboy_req:reply(200, [], "http_handler_crashes", Req), + Req1 = cowboy_req:reply(200, [], "http_handler_crashes", Req), {ok, Req1, Case}; case_init(<<"handle_before_reply">> = Case, Req) -> {ok, Req, Case}; @@ -31,7 +31,7 @@ handle(_Req, <<"handle_before_reply">> = Case) -> erlang:error(Case); handle(Req, <<"handle_after_reply">> = Case) -> cowboy_error_h:ignore(?MODULE, handle, 2), - {ok, _Req1} = cowboy_req:reply(200, [], "http_handler_crashes", Req), + _ = cowboy_req:reply(200, [], "http_handler_crashes", Req), erlang:error(Case). terminate(_, _, _) -> diff --git a/test/http_SUITE_data/http_handler.erl b/test/http_SUITE_data/http_handler.erl index e1f1665..296c918 100644 --- a/test/http_SUITE_data/http_handler.erl +++ b/test/http_SUITE_data/http_handler.erl @@ -12,8 +12,7 @@ init({_Transport, http}, Req, Opts) -> {ok, Req, #state{headers=Headers, body=Body}}. handle(Req, State=#state{headers=Headers, body=Body}) -> - {ok, Req2} = cowboy_req:reply(200, Headers, Body, Req), - {ok, Req2, State}. + {ok, cowboy_req:reply(200, Headers, Body, Req), State}. terminate(_, _, _) -> ok. diff --git a/test/http_SUITE_data/http_init_shutdown.erl b/test/http_SUITE_data/http_init_shutdown.erl index 1445569..512132e 100644 --- a/test/http_SUITE_data/http_init_shutdown.erl +++ b/test/http_SUITE_data/http_init_shutdown.erl @@ -5,12 +5,12 @@ -export([init/3, handle/2, terminate/3]). init({_Transport, http}, Req, _Opts) -> - {ok, Req2} = cowboy_req:reply(<<"666 Init Shutdown Testing">>, + Req2 = cowboy_req:reply(<<"666 Init Shutdown Testing">>, [{<<"connection">>, <<"close">>}], Req), {shutdown, Req2, undefined}. handle(Req, State) -> - {ok, Req2} = cowboy_req:reply(200, [], "Hello world!", Req), + Req2 = cowboy_req:reply(200, [], "Hello world!", Req), {ok, Req2, State}. terminate(_, _, _) -> diff --git a/test/http_SUITE_data/http_loop_stream_recv.erl b/test/http_SUITE_data/http_loop_stream_recv.erl index ce0d1da..77a339b 100644 --- a/test/http_SUITE_data/http_loop_stream_recv.erl +++ b/test/http_SUITE_data/http_loop_stream_recv.erl @@ -16,8 +16,7 @@ info(stream, Req, undefined) -> stream(Req, ID, Acc) -> case cowboy_req:body(Req) of {ok, <<>>, Req2} -> - {ok, Req3} = cowboy_req:reply(200, Req2), - {ok, Req3, undefined}; + {ok, cowboy_req:reply(200, Req2), undefined}; {_, Data, Req2} -> parse_id(Req2, ID, << Acc/binary, Data/binary >>) end. diff --git a/test/http_SUITE_data/http_multipart.erl b/test/http_SUITE_data/http_multipart.erl index 79bfeb8..43ff6ab 100644 --- a/test/http_SUITE_data/http_multipart.erl +++ b/test/http_SUITE_data/http_multipart.erl @@ -9,8 +9,7 @@ init({_Transport, http}, Req, []) -> handle(Req, State) -> {Result, Req2} = acc_multipart(Req, []), - {ok, Req3} = cowboy_req:reply(200, [], term_to_binary(Result), Req2), - {ok, Req3, State}. + {ok, cowboy_req:reply(200, [], term_to_binary(Result), Req2), State}. terminate(_, _, _) -> ok. diff --git a/test/http_SUITE_data/http_multipart_stream.erl b/test/http_SUITE_data/http_multipart_stream.erl index 926d150..bde7531 100644 --- a/test/http_SUITE_data/http_multipart_stream.erl +++ b/test/http_SUITE_data/http_multipart_stream.erl @@ -9,8 +9,7 @@ init(_, Req, []) -> handle(Req, State) -> Req2 = multipart(Req), - {ok, Req3} = cowboy_req:reply(200, Req2), - {ok, Req3, State}. + {ok, cowboy_req:reply(200, Req2), State}. terminate(_, _, _) -> ok. diff --git a/test/http_SUITE_data/http_req_attr.erl b/test/http_SUITE_data/http_req_attr.erl index eb5e70e..2a4a55d 100644 --- a/test/http_SUITE_data/http_req_attr.erl +++ b/test/http_SUITE_data/http_req_attr.erl @@ -5,15 +5,14 @@ -export([init/3, handle/2, terminate/3]). init({_, http}, Req, _) -> - {Attr, Req2} = cowboy_req:qs_val(<<"attr">>, Req), - {ok, Req2, Attr}. + #{attr := Attr} = cowboy_req:match_qs(Req, [attr]), + {ok, Req, Attr}. handle(Req, <<"host_and_port">> = Attr) -> - {Host, Req2} = cowboy_req:host(Req), - {Port, Req3} = cowboy_req:port(Req2), + Host = cowboy_req:host(Req), + Port = cowboy_req:port(Req), Value = [Host, "\n", integer_to_list(Port)], - {ok, Req4} = cowboy_req:reply(200, [], Value, Req3), - {ok, Req4, Attr}. + {ok, cowboy_req:reply(200, [], Value, Req), Attr}. terminate(_, _, _) -> ok. diff --git a/test/http_SUITE_data/http_set_resp.erl b/test/http_SUITE_data/http_set_resp.erl index 821cc1d..628f745 100644 --- a/test/http_SUITE_data/http_set_resp.erl +++ b/test/http_SUITE_data/http_set_resp.erl @@ -20,10 +20,10 @@ handle(Req, State) -> false -> {ok, Req, State}; true -> case cowboy_req:has_resp_body(Req) of - false -> {ok, Req, State}; + false -> + {ok, Req, State}; true -> - {ok, Req2} = cowboy_req:reply(200, Req), - {ok, Req2, State} + {ok, cowboy_req:reply(200, Req), State} end end. diff --git a/test/http_SUITE_data/http_stream_body.erl b/test/http_SUITE_data/http_stream_body.erl index d896797..9be79a1 100644 --- a/test/http_SUITE_data/http_stream_body.erl +++ b/test/http_SUITE_data/http_stream_body.erl @@ -25,8 +25,7 @@ handle(Req, State=#state{headers=_Headers, body=Body, reply=Reply}) -> SFun2 = fun(SendFun) -> lists:foreach(SendFun, Body) end, cowboy_req:set_resp_body_fun(chunked, SFun2, Req) end, - {ok, Req3} = cowboy_req:reply(200, Req2), - {ok, Req3, State}. + {ok, cowboy_req:reply(200, Req2), State}. terminate(_, _, _) -> ok. diff --git a/test/http_SUITE_data/http_streamed.erl b/test/http_SUITE_data/http_streamed.erl index 674cc40..5f90077 100644 --- a/test/http_SUITE_data/http_streamed.erl +++ b/test/http_SUITE_data/http_streamed.erl @@ -9,7 +9,7 @@ init({_Transport, http}, Req, _Opts) -> handle(Req, State) -> Req2 = cowboy_req:set([{resp_state, waiting_stream}], Req), - {ok, Req3} = cowboy_req:chunked_reply(200, Req2), + Req3 = cowboy_req:chunked_reply(200, Req2), timer:sleep(100), cowboy_req:chunk("streamed_handler\r\n", Req3), timer:sleep(100), diff --git a/test/http_SUITE_data/rest_forbidden_resource.erl b/test/http_SUITE_data/rest_forbidden_resource.erl index 920ba31..d055193 100644 --- a/test/http_SUITE_data/rest_forbidden_resource.erl +++ b/test/http_SUITE_data/rest_forbidden_resource.erl @@ -27,5 +27,4 @@ to_text(Req, State) -> {<<"This is REST!">>, Req, State}. from_text(Req, State) -> - {Path, Req2} = cowboy_req:path(Req), - {{true, Path}, Req2, State}. + {{true, cowboy_req:path(Req)}, Req, State}. diff --git a/test/http_SUITE_data/rest_param_all.erl b/test/http_SUITE_data/rest_param_all.erl index 09b8cd3..22daac7 100644 --- a/test/http_SUITE_data/rest_param_all.erl +++ b/test/http_SUITE_data/rest_param_all.erl @@ -17,17 +17,16 @@ content_types_provided(Req, State) -> {[{{<<"text">>, <<"plain">>, '*'}, get_text_plain}], Req, State}. get_text_plain(Req, State) -> - {{_, _, Param}, Req2} = - cowboy_req:meta(media_type, Req, {{<<"text">>, <<"plain">>}, []}), + {_, _, Param} = cowboy_req:meta(media_type, Req, {{<<"text">>, <<"plain">>}, []}), Body = if - Param == '*' -> - <<"'*'">>; - Param == [] -> - <<"[]">>; - Param /= [] -> - iolist_to_binary([[Key, $=, Value] || {Key, Value} <- Param]) + Param == '*' -> + <<"'*'">>; + Param == [] -> + <<"[]">>; + Param /= [] -> + iolist_to_binary([[Key, $=, Value] || {Key, Value} <- Param]) end, - {Body, Req2, State}. + {Body, Req, State}. content_types_accepted(Req, State) -> {[{{<<"text">>, <<"plain">>, '*'}, put_text_plain}], Req, State}. diff --git a/test/http_SUITE_data/rest_patch_resource.erl b/test/http_SUITE_data/rest_patch_resource.erl index e265f6f..7b9b76e 100644 --- a/test/http_SUITE_data/rest_patch_resource.erl +++ b/test/http_SUITE_data/rest_patch_resource.erl @@ -16,17 +16,16 @@ get_text_plain(Req, State) -> content_types_accepted(Req, State) -> case cowboy_req:method(Req) of - {<<"PATCH">>, Req0} -> - {[{{<<"text">>, <<"plain">>, []}, patch_text_plain}], Req0, State}; - {_, Req0} -> - {[], Req0, State} + <<"PATCH">> -> + {[{{<<"text">>, <<"plain">>, []}, patch_text_plain}], Req, State}; + _ -> + {[], Req, State} end. patch_text_plain(Req, State) -> case cowboy_req:body(Req) of {ok, <<"halt">>, Req0} -> - {ok, Req1} = cowboy_req:reply(400, Req0), - {halt, Req1, State}; + {halt, cowboy_req:reply(400, Req0), State}; {ok, <<"false">>, Req0} -> {false, Req0, State}; {ok, _Body, Req0} -> diff --git a/test/http_SUITE_data/rest_resource_etags.erl b/test/http_SUITE_data/rest_resource_etags.erl index 2652f57..fb266d1 100644 --- a/test/http_SUITE_data/rest_resource_etags.erl +++ b/test/http_SUITE_data/rest_resource_etags.erl @@ -5,24 +5,25 @@ init(_Transport, _Req, _Opts) -> {upgrade, protocol, cowboy_rest}. generate_etag(Req, State) -> - case cowboy_req:qs_val(<<"type">>, Req) of + #{type := Type} = cowboy_req:match_qs(Req, [type]), + case Type of %% Correct return values from generate_etag/2. - {<<"tuple-weak">>, Req2} -> - {{weak, <<"etag-header-value">>}, Req2, State}; - {<<"tuple-strong">>, Req2} -> - {{strong, <<"etag-header-value">>}, Req2, State}; + <<"tuple-weak">> -> + {{weak, <<"etag-header-value">>}, Req, State}; + <<"tuple-strong">> -> + {{strong, <<"etag-header-value">>}, Req, State}; %% Backwards compatible return values from generate_etag/2. - {<<"binary-weak-quoted">>, Req2} -> - {<<"W/\"etag-header-value\"">>, Req2, State}; - {<<"binary-strong-quoted">>, Req2} -> - {<<"\"etag-header-value\"">>, Req2, State}; + <<"binary-weak-quoted">> -> + {<<"W/\"etag-header-value\"">>, Req, State}; + <<"binary-strong-quoted">> -> + {<<"\"etag-header-value\"">>, Req, State}; %% Invalid return values from generate_etag/2. - {<<"binary-strong-unquoted">>, Req2} -> + <<"binary-strong-unquoted">> -> cowboy_error_h:ignore(cowboy_http, quoted_string, 2), - {<<"etag-header-value">>, Req2, State}; - {<<"binary-weak-unquoted">>, Req2} -> + {<<"etag-header-value">>, Req, State}; + <<"binary-weak-unquoted">> -> cowboy_error_h:ignore(cowboy_http, quoted_string, 2), - {<<"W/etag-header-value">>, Req2, State} + {<<"W/etag-header-value">>, Req, State} end. content_types_provided(Req, State) -> diff --git a/test/ws_SUITE_data/ws_init_shutdown.erl b/test/ws_SUITE_data/ws_init_shutdown.erl index 2b1dd99..30bf66e 100644 --- a/test/ws_SUITE_data/ws_init_shutdown.erl +++ b/test/ws_SUITE_data/ws_init_shutdown.erl @@ -10,8 +10,7 @@ init(_Any, _Req, _Opts) -> {upgrade, protocol, cowboy_websocket}. websocket_init(_TransportName, Req, _Opts) -> - {ok, Req2} = cowboy_req:reply(403, Req), - {shutdown, Req2}. + {shutdown, cowboy_req:reply(403, Req)}. websocket_handle(_Frame, _Req, _State) -> exit(badarg). |