From f1c3b6d76f0c97e1ab927c288bb94891ae4c253b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Tue, 23 Sep 2014 16:43:29 +0300 Subject: 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. --- .../chunked_hello_world/src/toppage_handler.erl | 12 ++++----- examples/compress_response/src/toppage_handler.erl | 2 +- examples/cookie/src/toppage_handler.erl | 10 ++++---- examples/echo_get/src/toppage_handler.erl | 8 +++--- examples/echo_post/src/toppage_handler.erl | 8 +++--- examples/error_hook/src/error_hook_app.erl | 8 +++--- examples/eventsource/src/eventsource_handler.erl | 4 +-- examples/hello_world/src/toppage_handler.erl | 2 +- .../markdown_middleware/src/markdown_converter.erl | 4 +-- examples/rest_basic_auth/src/toppage_handler.erl | 7 +++-- examples/rest_pastebin/src/toppage_handler.erl | 30 +++++++++++----------- .../rest_stream_response/src/toppage_handler.erl | 4 +-- examples/ssl_hello_world/src/toppage_handler.erl | 2 +- examples/web_server/src/directory_lister.erl | 6 ++--- 14 files changed, 52 insertions(+), 55 deletions(-) (limited to 'examples') 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 <- 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) -> -- cgit v1.2.3