123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631 |
- %% Copyright (c) 2015, Loïc Hoguin <essen@ninenines.eu>
- %%
- %% 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_http2).
- -export([init/6]).
- -export([init/8]).
- -export([init/10]).
- -export([system_continue/3]).
- -export([system_terminate/4]).
- -export([system_code_change/4]).
- -record(stream, {
- id = undefined :: cowboy_stream:streamid(),
- state = undefined :: any(),
- %% Whether we finished sending data.
- local = idle :: idle | cowboy_stream:fin(),
- %% Whether we finished receiving data.
- remote = nofin :: cowboy_stream:fin(),
- %% Request body length.
- body_length = 0 :: non_neg_integer()
- }).
- -type stream() :: #stream{}.
- %% @todo priority: if we receive a message for a stream, do a selective receive
- %% to get all messages in the mailbox and prioritize them. (later)
- -record(state, {
- parent = undefined :: pid(),
- ref :: ranch:ref(),
- socket = undefined :: inet:socket(),
- transport :: module(),
- opts = #{} :: map(),
- handler :: module(),
- %% Remote address and port for the connection.
- peer = undefined :: {inet:ip_address(), inet:port_number()},
- %% Settings are separate for each endpoint. In addition, settings
- %% must be acknowledged before they can be expected to be applied.
- %%
- %% @todo Since the ack is required, we must timeout if we don't receive it.
- %% @todo I haven't put as much thought as I should have on this,
- %% the final settings handling will be very different.
- local_settings = #{} :: map(),
- %% @todo We need a TimerRef to do SETTINGS_TIMEOUT errors.
- %% We need to be careful there. It's well possible that we send
- %% two SETTINGS frames before we receive a SETTINGS ack.
- next_settings = #{} :: undefined | map(), %% @todo perhaps set to undefined by default
- remote_settings = #{} :: map(),
- %% Stream identifiers.
- server_streamid = 2 :: pos_integer(),
- %% @todo last known good streamid
- %% Currently active HTTP/2 streams. Streams may be initiated either
- %% by the client or by the server through PUSH_PROMISE frames.
- streams = [] :: [stream()],
- %% Streams can spawn zero or more children which are then managed
- %% by this module if operating as a supervisor.
- children = [] :: [{pid(), cowboy_stream:streamid()}],
- %% The client starts by sending a sequence of bytes as a preface,
- %% followed by a potentially empty SETTINGS frame. Then the connection
- %% is established and continues normally. An exception is when a HEADERS
- %% frame is sent followed by CONTINUATION frames: no other frame can be
- %% sent in between.
- parse_state = undefined :: {preface, sequence, reference()}
- | {preface, settings, reference()}
- | normal
- | {continuation, cowboy_stream:streamid(), cowboy_stream:fin(), binary()},
- %% HPACK decoding and encoding state.
- decode_state = cow_hpack:init() :: cow_hpack:state(),
- encode_state = cow_hpack:init() :: cow_hpack:state()
- }).
- -spec init(pid(), ranch:ref(), inet:socket(), module(), cowboy:opts(), module()) -> ok.
- init(Parent, Ref, Socket, Transport, Opts, Handler) ->
- case Transport:peername(Socket) of
- {ok, Peer} ->
- init(Parent, Ref, Socket, Transport, Opts, Handler, Peer, <<>>);
- {error, Reason} ->
- %% Couldn't read the peer address; connection is gone.
- terminate(undefined, {socket_error, Reason, 'An error has occurred on the socket.'})
- end.
- -spec init(pid(), ranch:ref(), inet:socket(), module(), cowboy:opts(), module(),
- {inet:ip_address(), inet:port_number()}, binary()) -> ok.
- init(Parent, Ref, Socket, Transport, Opts, Handler, Peer, Buffer) ->
- State = #state{parent=Parent, ref=Ref, socket=Socket,
- transport=Transport, opts=Opts, handler=Handler, peer=Peer,
- parse_state={preface, sequence, preface_timeout(Opts)}},
- preface(State),
- case Buffer of
- <<>> -> before_loop(State, Buffer);
- _ -> parse(State, Buffer)
- end.
- %% @todo Add an argument for the request body.
- -spec init(pid(), ranch:ref(), inet:socket(), module(), cowboy:opts(), module(),
- {inet:ip_address(), inet:port_number()}, binary(), binary() | undefined, cowboy_req:req()) -> ok.
- init(Parent, Ref, Socket, Transport, Opts, Handler, Peer, Buffer, _Settings, Req) ->
- State0 = #state{parent=Parent, ref=Ref, socket=Socket,
- transport=Transport, opts=Opts, handler=Handler, peer=Peer,
- parse_state={preface, sequence, preface_timeout(Opts)}},
- preface(State0),
- %% @todo Apply settings.
- %% StreamID from HTTP/1.1 Upgrade requests is always 1.
- %% The stream is always in the half-closed (remote) state.
- State = stream_handler_init(State0, 1, fin, Req),
- case Buffer of
- <<>> -> before_loop(State, Buffer);
- _ -> parse(State, Buffer)
- end.
- preface(#state{socket=Socket, transport=Transport, next_settings=Settings}) ->
- %% We send next_settings and use defaults until we get a ack.
- ok = Transport:send(Socket, cow_http2:settings(Settings)).
- preface_timeout(Opts) ->
- PrefaceTimeout = maps:get(preface_timeout, Opts, 5000),
- erlang:start_timer(PrefaceTimeout, self(), preface_timeout).
- %% @todo Add the timeout for last time since we heard of connection.
- before_loop(State, Buffer) ->
- loop(State, Buffer).
- loop(State=#state{parent=Parent, socket=Socket, transport=Transport,
- children=Children, parse_state=PS}, Buffer) ->
- Transport:setopts(Socket, [{active, once}]),
- {OK, Closed, Error} = Transport:messages(),
- receive
- %% Socket messages.
- {OK, Socket, Data} ->
- parse(State, << Buffer/binary, Data/binary >>);
- {Closed, Socket} ->
- terminate(State, {socket_error, closed, 'The socket has been closed.'});
- {Error, Socket, Reason} ->
- terminate(State, {socket_error, Reason, 'An error has occurred on the socket.'});
- %% System messages.
- {'EXIT', Parent, Reason} ->
- exit(Reason);
- {system, From, Request} ->
- sys:handle_system_msg(Request, From, Parent, ?MODULE, [], {State, Buffer});
- {timeout, TRef, preface_timeout} ->
- case PS of
- {preface, _, TRef} ->
- terminate(State, {connection_error, protocol_error,
- 'The preface was not received in a reasonable amount of time.'});
- _ ->
- loop(State, Buffer)
- end;
- %% Messages pertaining to a stream.
- {{Pid, StreamID}, Msg} when Pid =:= self() ->
- loop(info(State, StreamID, Msg), Buffer);
- %% Exit signal from children.
- Msg = {'EXIT', Pid, _} ->
- loop(down(State, Pid, Msg), Buffer);
- %% Calls from supervisor module.
- {'$gen_call', {From, Tag}, which_children} ->
- Workers = [{?MODULE, Pid, worker, [?MODULE]} || {Pid, _} <- Children],
- From ! {Tag, Workers},
- loop(State, Buffer);
- {'$gen_call', {From, Tag}, count_children} ->
- NbChildren = length(Children),
- Counts = [{specs, 1}, {active, NbChildren},
- {supervisors, 0}, {workers, NbChildren}],
- From ! {Tag, Counts},
- loop(State, Buffer);
- {'$gen_call', {From, Tag}, _} ->
- From ! {Tag, {error, ?MODULE}},
- loop(State, Buffer);
- Msg ->
- error_logger:error_msg("Received stray message ~p.", [Msg]),
- loop(State, Buffer)
- %% @todo Configurable timeout.
- after 60000 ->
- terminate(State, {internal_error, timeout, 'No message or data received before timeout.'})
- end.
- parse(State=#state{socket=Socket, transport=Transport, parse_state={preface, sequence, TRef}}, Data) ->
- case Data of
- << "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n", Rest/bits >> ->
- parse(State#state{parse_state={preface, settings, TRef}}, Rest);
- _ when byte_size(Data) >= 24 ->
- Transport:close(Socket),
- exit({shutdown, {connection_error, protocol_error,
- 'The connection preface was invalid. (RFC7540 3.5)'}});
- _ ->
- Len = byte_size(Data),
- << Preface:Len/binary, _/bits >> = <<"PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n">>,
- case Data of
- Preface ->
- %% @todo OK we should have a timeout when waiting for the preface.
- before_loop(State, Data);
- _ ->
- Transport:close(Socket),
- exit({shutdown, {connection_error, protocol_error,
- 'The connection preface was invalid. (RFC7540 3.5)'}})
- end
- end;
- %% @todo Perhaps instead of just more we can have {more, Len} to avoid all the checks.
- parse(State=#state{parse_state=ParseState}, Data) ->
- case cow_http2:parse(Data) of
- {ok, Frame, Rest} ->
- case ParseState of
- normal ->
- parse(frame(State, Frame), Rest);
- {preface, settings, TRef} ->
- parse_settings_preface(State, Frame, Rest, TRef);
- {continuation, _, _, _} ->
- parse(continuation_frame(State, Frame), Rest)
- end;
- {stream_error, StreamID, Reason, Human, Rest} ->
- parse(stream_reset(State, StreamID, {stream_error, Reason, Human}), Rest);
- Error = {connection_error, _, _} ->
- terminate(State, Error);
- more ->
- before_loop(State, Data)
- end.
- parse_settings_preface(State, Frame={settings, _}, Rest, TRef) ->
- erlang:cancel_timer(TRef, [{async, true}, {info, false}]),
- parse(frame(State#state{parse_state=normal}, Frame), Rest);
- parse_settings_preface(State, _, _, _) ->
- terminate(State, {connection_error, protocol_error,
- 'The preface sequence must be followed by a SETTINGS frame. (RFC7540 3.5)'}).
- %% @todo When we get a 'fin' we need to check if the stream had a 'fin' sent back
- %% and terminate the stream if this is the end of it.
- %% DATA frame.
- frame(State=#state{handler=Handler, streams=Streams}, {data, StreamID, IsFin0, Data}) ->
- case lists:keyfind(StreamID, #stream.id, Streams) of
- Stream = #stream{state=StreamState0, remote=nofin, body_length=Len0} ->
- Len = Len0 + byte_size(Data),
- IsFin = case IsFin0 of
- fin -> {fin, Len};
- nofin -> nofin
- end,
- try Handler:data(StreamID, IsFin, Data, StreamState0) of
- {Commands, StreamState} ->
- commands(State, Stream#stream{state=StreamState, body_length=Len}, Commands)
- catch Class:Reason ->
- error_logger:error_msg("Exception occurred in ~s:data(~p, ~p, ~p, ~p) with reason ~p:~p.",
- [Handler, StreamID, IsFin0, Data, StreamState0, Class, Reason]),
- stream_reset(State, StreamID, {internal_error, {Class, Reason},
- 'Exception occurred in StreamHandler:data/4 call.'})
- end;
- _ ->
- stream_reset(State, StreamID, {stream_error, stream_closed,
- 'DATA frame received for a closed or non-existent stream. (RFC7540 6.1)'})
- end;
- %% Single HEADERS frame headers block.
- frame(State, {headers, StreamID, IsFin, head_fin, HeaderBlock}) ->
- %% @todo We probably need to validate StreamID here and in 4 next clauses.
- stream_init(State, StreamID, IsFin, HeaderBlock);
- %% HEADERS frame starting a headers block. Enter continuation mode.
- frame(State, {headers, StreamID, IsFin, head_nofin, HeaderBlockFragment}) ->
- State#state{parse_state={continuation, StreamID, IsFin, HeaderBlockFragment}};
- %% Single HEADERS frame headers block with priority.
- frame(State, {headers, StreamID, IsFin, head_fin,
- _IsExclusive, _DepStreamID, _Weight, HeaderBlock}) ->
- %% @todo Handle priority.
- stream_init(State, StreamID, IsFin, HeaderBlock);
- %% HEADERS frame starting a headers block. Enter continuation mode.
- frame(State, {headers, StreamID, IsFin, head_nofin,
- _IsExclusive, _DepStreamID, _Weight, HeaderBlockFragment}) ->
- %% @todo Handle priority.
- State#state{parse_state={continuation, StreamID, IsFin, HeaderBlockFragment}};
- %% PRIORITY frame.
- frame(State, {priority, _StreamID, _IsExclusive, _DepStreamID, _Weight}) ->
- %% @todo Validate StreamID?
- %% @todo Handle priority.
- State;
- %% RST_STREAM frame.
- frame(State, {rst_stream, StreamID, Reason}) ->
- stream_reset(State, StreamID, {stream_error, Reason, 'Stream reset requested by client.'});
- %% SETTINGS frame.
- frame(State=#state{socket=Socket, transport=Transport}, {settings, _Settings}) ->
- %% @todo Apply SETTINGS.
- Transport:send(Socket, cow_http2:settings_ack()),
- State;
- %% Ack for a previously sent SETTINGS frame.
- frame(State=#state{next_settings=_NextSettings}, settings_ack) ->
- %% @todo Apply SETTINGS that require synchronization.
- State;
- %% Unexpected PUSH_PROMISE frame.
- frame(State, {push_promise, _, _, _, _}) ->
- terminate(State, {connection_error, protocol_error,
- 'PUSH_PROMISE frames MUST only be sent on a peer-initiated stream. (RFC7540 6.6)'});
- %% PING frame.
- frame(State=#state{socket=Socket, transport=Transport}, {ping, Opaque}) ->
- Transport:send(Socket, cow_http2:ping_ack(Opaque)),
- State;
- %% Ack for a previously sent PING frame.
- %%
- %% @todo Might want to check contents but probably a waste of time.
- frame(State, {ping_ack, _Opaque}) ->
- State;
- %% GOAWAY frame.
- frame(State, Frame={goaway, _, _, _}) ->
- terminate(State, {stop, Frame, 'Client is going away.'});
- %% Connection-wide WINDOW_UPDATE frame.
- frame(State, {window_update, _Increment}) ->
- %% @todo control flow
- State;
- %% Stream-specific WINDOW_UPDATE frame.
- frame(State, {window_update, _StreamID, _Increment}) ->
- %% @todo stream-specific control flow
- State;
- %% Unexpected CONTINUATION frame.
- frame(State, {continuation, _, _, _}) ->
- terminate(State, {connection_error, protocol_error,
- 'CONTINUATION frames MUST be preceded by a HEADERS frame. (RFC7540 6.10)'}).
- continuation_frame(State=#state{parse_state={continuation, StreamID, IsFin, HeaderBlockFragment0}},
- {continuation, StreamID, fin, HeaderBlockFragment1}) ->
- stream_init(State#state{parse_state=normal}, StreamID, IsFin,
- << HeaderBlockFragment0/binary, HeaderBlockFragment1/binary >>);
- continuation_frame(State=#state{parse_state={continuation, StreamID, IsFin, HeaderBlockFragment0}},
- {continuation, StreamID, nofin, HeaderBlockFragment1}) ->
- State#state{parse_state={continuation, StreamID, IsFin,
- << HeaderBlockFragment0/binary, HeaderBlockFragment1/binary >>}};
- continuation_frame(State, _) ->
- terminate(State, {connection_error, protocol_error,
- 'An invalid frame was received while expecting a CONTINUATION frame. (RFC7540 6.2)'}).
- down(State=#state{children=Children0}, Pid, Msg) ->
- case lists:keytake(Pid, 1, Children0) of
- {value, {_, StreamID}, Children} ->
- info(State#state{children=Children}, StreamID, Msg);
- false ->
- error_logger:error_msg("Received EXIT signal ~p for unknown process ~p.", [Msg, Pid]),
- State
- end.
- info(State=#state{handler=Handler, streams=Streams}, StreamID, Msg) ->
- case lists:keyfind(StreamID, #stream.id, Streams) of
- Stream = #stream{state=StreamState0} ->
- try Handler:info(StreamID, Msg, StreamState0) of
- {Commands, StreamState} ->
- commands(State, Stream#stream{state=StreamState}, Commands)
- catch Class:Reason ->
- error_logger:error_msg("Exception occurred in ~s:info(~p, ~p, ~p) with reason ~p:~p.",
- [Handler, StreamID, Msg, StreamState0, Class, Reason]),
- stream_reset(State, StreamID, {internal_error, {Class, Reason},
- 'Exception occurred in StreamHandler:info/3 call.'})
- end;
- false ->
- error_logger:error_msg("Received message ~p for unknown stream ~p.", [Msg, StreamID]),
- State
- end.
- commands(State, Stream, []) ->
- after_commands(State, Stream);
- %% Send response headers.
- %%
- %% @todo Kill the stream if it sent a response when one has already been sent.
- %% @todo Keep IsFin in the state.
- %% @todo Same two things above apply to DATA, possibly promise too.
- commands(State=#state{socket=Socket, transport=Transport, encode_state=EncodeState0},
- Stream=#stream{id=StreamID, local=idle}, [{response, StatusCode, Headers0, Body}|Tail]) ->
- Headers = Headers0#{<<":status">> => integer_to_binary(StatusCode)},
- {HeaderBlock, EncodeState} = headers_encode(Headers, EncodeState0),
- case Body of
- <<>> ->
- Transport:send(Socket, cow_http2:headers(StreamID, fin, HeaderBlock)),
- commands(State#state{encode_state=EncodeState}, Stream#stream{local=fin}, Tail);
- {sendfile, O, B, P} ->
- Transport:send(Socket, cow_http2:headers(StreamID, nofin, HeaderBlock)),
- commands(State#state{encode_state=EncodeState}, Stream#stream{local=nofin},
- [{sendfile, fin, O, B, P}|Tail]);
- _ ->
- Transport:send(Socket, [
- cow_http2:headers(StreamID, nofin, HeaderBlock),
- cow_http2:data(StreamID, fin, Body)
- ]),
- commands(State#state{encode_state=EncodeState}, Stream#stream{local=fin}, Tail)
- end;
- %% @todo response when local!=idle
- %% Send response headers and initiate chunked encoding.
- commands(State=#state{socket=Socket, transport=Transport, encode_state=EncodeState0},
- Stream=#stream{id=StreamID, local=idle}, [{headers, StatusCode, Headers0}|Tail]) ->
- Headers = Headers0#{<<":status">> => integer_to_binary(StatusCode)},
- {HeaderBlock, EncodeState} = headers_encode(Headers, EncodeState0),
- Transport:send(Socket, cow_http2:headers(StreamID, nofin, HeaderBlock)),
- commands(State#state{encode_state=EncodeState}, Stream#stream{local=nofin}, Tail);
- %% @todo headers when local!=idle
- %% Send a response body chunk.
- %%
- %% @todo WINDOW_UPDATE stuff require us to buffer some data.
- %%
- %% When the body is sent using sendfile, the current solution is not
- %% very good. The body could be too large, blocking the connection.
- %% Also sendfile technically only works over TCP, so it's not that
- %% useful for HTTP/2. At the very least the sendfile call should be
- %% split into multiple calls and flow control should be used to make
- %% sure we only send as fast as the client can receive and don't block
- %% anything.
- commands(State=#state{socket=Socket, transport=Transport}, Stream=#stream{id=StreamID, local=nofin},
- [{data, IsFin, Data}|Tail]) ->
- Transport:send(Socket, cow_http2:data(StreamID, IsFin, Data)),
- commands(State, Stream#stream{local=IsFin}, Tail);
- %% @todo data when local!=nofin
- %% Send a file.
- %%
- %% @todo This implementation is terrible. A good implementation would
- %% need to check that Bytes is exact (or we need to document that we
- %% trust it to be exact), and would need to send the file asynchronously
- %% in many data frames. Perhaps a sendfile call should result in a
- %% process being created specifically for this purpose. Or perhaps
- %% the protocol should be "dumb" and the stream handler be the one
- %% to ensure the file is sent in chunks (which would require a better
- %% flow control at the stream handler level). One thing for sure, the
- %% implementation necessarily varies between HTTP/1.1 and HTTP/2.
- commands(State=#state{socket=Socket, transport=Transport}, Stream=#stream{id=StreamID, local=nofin},
- [{sendfile, IsFin, Offset, Bytes, Path}|Tail]) ->
- Transport:send(Socket, cow_http2:data_header(StreamID, IsFin, Bytes)),
- Transport:sendfile(Socket, Path, Offset, Bytes),
- commands(State, Stream#stream{local=IsFin}, Tail);
- %% @todo sendfile when local!=nofin
- %% Send a push promise.
- %%
- %% @todo We need to keep track of what promises we made so that we don't
- %% end up with an infinite loop of promises.
- commands(State0=#state{socket=Socket, transport=Transport, server_streamid=PromisedStreamID,
- encode_state=EncodeState0}, Stream=#stream{id=StreamID},
- [{promise, Method, Scheme, Authority, Path, Headers0}|Tail]) ->
- Headers = Headers0#{<<":method">> => Method,
- <<":scheme">> => Scheme,
- <<":authority">> => Authority,
- <<":path">> => Path},
- {HeaderBlock, EncodeState} = headers_encode(Headers, EncodeState0),
- Transport:send(Socket, cow_http2:push_promise(StreamID, PromisedStreamID, HeaderBlock)),
- %% @todo iolist_to_binary(HeaderBlock) isn't optimal. Need a shortcut.
- State = stream_init(State0#state{server_streamid=PromisedStreamID + 2, encode_state=EncodeState},
- PromisedStreamID, fin, iolist_to_binary(HeaderBlock)),
- commands(State, Stream, Tail);
- %% @todo Update the flow control state.
- commands(State, Stream, [{flow, _Size}|Tail]) ->
- commands(State, Stream, Tail);
- %% Supervise a child process.
- commands(State=#state{children=Children}, Stream=#stream{id=StreamID},
- [{spawn, Pid, _Shutdown}|Tail]) -> %% @todo Shutdown
- commands(State#state{children=[{Pid, StreamID}|Children]}, Stream, Tail);
- %% Error handling.
- commands(State, Stream=#stream{id=StreamID}, [Error = {internal_error, _, _}|_Tail]) ->
- %% @todo Do we want to run the commands after an internal_error?
- %% @todo Do we even allow commands after?
- %% @todo Only reset when the stream still exists.
- stream_reset(after_commands(State, Stream), StreamID, Error);
- %% Upgrade to a new protocol.
- %%
- %% @todo Implementation.
- %% @todo Can only upgrade if: there are no other streams and there are no children left alive.
- %% @todo For HTTP/1.1 we should reject upgrading if pipelining is used.
- commands(State, Stream, [{upgrade, _Mod, _ModState}]) ->
- commands(State, Stream, []);
- commands(State, Stream, [{upgrade, _Mod, _ModState}|Tail]) ->
- %% @todo This is an error. Not sure what to do here yet.
- commands(State, Stream, Tail);
- commands(State, Stream=#stream{id=StreamID}, [stop|_Tail]) ->
- %% @todo Do we want to run the commands after a stop?
- %% @todo Do we even allow commands after?
- stream_terminate(after_commands(State, Stream), StreamID, normal).
- after_commands(State=#state{streams=Streams0}, Stream=#stream{id=StreamID}) ->
- Streams = lists:keystore(StreamID, #stream.id, Streams0, Stream),
- State#state{streams=Streams}.
- terminate(#state{socket=Socket, transport=Transport, handler=Handler,
- streams=Streams, children=Children}, Reason) ->
- %% @todo Send GOAWAY frame; need to keep track of last good stream id; how?
- terminate_all_streams(Streams, Reason, Handler, Children),
- Transport:close(Socket),
- exit({shutdown, Reason}).
- terminate_all_streams([], _, _, []) ->
- ok;
- terminate_all_streams([#stream{id=StreamID, state=StreamState}|Tail], Reason, Handler, Children0) ->
- stream_call_terminate(StreamID, Reason, Handler, StreamState),
- Children = stream_terminate_children(Children0, StreamID, []),
- terminate_all_streams(Tail, Reason, Handler, Children).
- %% Stream functions.
- stream_init(State0=#state{ref=Ref, socket=Socket, transport=Transport, peer=Peer, decode_state=DecodeState0},
- StreamID, IsFin, HeaderBlock) ->
- %% @todo Add clause for CONNECT requests (no scheme/path).
- try headers_decode(HeaderBlock, DecodeState0) of
- {Headers0=#{
- <<":method">> := Method,
- <<":scheme">> := Scheme,
- <<":authority">> := Authority,
- <<":path">> := PathWithQs}, DecodeState} ->
- State = State0#state{decode_state=DecodeState},
- Headers = maps:without([<<":method">>, <<":scheme">>, <<":authority">>, <<":path">>], Headers0),
- {Host, Port} = cow_http_hd:parse_host(Authority),
- {Path, Qs} = cow_http:parse_fullpath(PathWithQs),
- Req = #{
- ref => Ref,
- pid => self(),
- streamid => StreamID,
- peer => Peer,
- method => Method,
- scheme => Scheme,
- host => Host,
- port => Port,
- path => Path,
- qs => Qs,
- version => 'HTTP/2',
- headers => Headers,
- has_body => IsFin =:= nofin
- %% @todo multipart? keep state separate
- %% meta values (cowboy_websocket, cowboy_rest)
- },
- stream_handler_init(State, StreamID, IsFin, Req);
- {_, DecodeState} ->
- Transport:send(Socket, cow_http2:rst_stream(StreamID, protocol_error)),
- State0#state{decode_state=DecodeState}
- catch _:_ ->
- terminate(State0, {connection_error, compression_error,
- 'Error while trying to decode HPACK-encoded header block. (RFC7540 4.3)'})
- end.
- stream_handler_init(State=#state{handler=Handler, opts=Opts}, StreamID, IsFin, Req) ->
- try Handler:init(StreamID, Req, Opts) of
- {Commands, StreamState} ->
- commands(State, #stream{id=StreamID, state=StreamState, remote=IsFin}, Commands)
- catch Class:Reason ->
- error_logger:error_msg("Exception occurred in ~s:init(~p, ~p, ~p) "
- "with reason ~p:~p.",
- [Handler, StreamID, IsFin, Req, Class, Reason]),
- stream_reset(State, StreamID, {internal_error, {Class, Reason},
- 'Exception occurred in StreamHandler:init/7 call.'}) %% @todo Check final arity.
- end.
- %% @todo We might need to keep track of which stream has been reset so we don't send lots of them.
- stream_reset(State=#state{socket=Socket, transport=Transport}, StreamID,
- StreamError={internal_error, _, _}) ->
- Transport:send(Socket, cow_http2:rst_stream(StreamID, internal_error)),
- stream_terminate(State, StreamID, StreamError);
- stream_reset(State=#state{socket=Socket, transport=Transport}, StreamID,
- StreamError={stream_error, Reason, _}) ->
- Transport:send(Socket, cow_http2:rst_stream(StreamID, Reason)),
- stream_terminate(State, StreamID, StreamError).
- stream_terminate(State=#state{socket=Socket, transport=Transport, handler=Handler,
- streams=Streams0, children=Children0, encode_state=EncodeState0}, StreamID, Reason) ->
- case lists:keytake(StreamID, #stream.id, Streams0) of
- {value, #stream{state=StreamState, local=idle}, Streams} when Reason =:= normal ->
- Headers = #{<<":status">> => <<"204">>},
- {HeaderBlock, EncodeState} = headers_encode(Headers, EncodeState0),
- Transport:send(Socket, cow_http2:headers(StreamID, fin, HeaderBlock)),
- stream_call_terminate(StreamID, Reason, Handler, StreamState),
- Children = stream_terminate_children(Children0, StreamID, []),
- State#state{streams=Streams, children=Children, encode_state=EncodeState};
- {value, #stream{state=StreamState, local=nofin}, Streams} when Reason =:= normal ->
- Transport:send(Socket, cow_http2:data(StreamID, fin, <<>>)),
- stream_call_terminate(StreamID, Reason, Handler, StreamState),
- Children = stream_terminate_children(Children0, StreamID, []),
- State#state{streams=Streams, children=Children};
- {value, #stream{state=StreamState}, Streams} ->
- stream_call_terminate(StreamID, Reason, Handler, StreamState),
- Children = stream_terminate_children(Children0, StreamID, []),
- State#state{streams=Streams, children=Children};
- false ->
- %% @todo Unknown stream. Not sure what to do here. Check again once all
- %% terminate calls have been written.
- State
- end.
- stream_call_terminate(StreamID, Reason, Handler, StreamState) ->
- try
- Handler:terminate(StreamID, Reason, StreamState),
- ok
- catch Class:Reason ->
- error_logger:error_msg("Exception occurred in ~s:terminate(~p, ~p, ~p) with reason ~p:~p.",
- [Handler, StreamID, Reason, StreamState, Class, Reason])
- end.
- stream_terminate_children([], _, Acc) ->
- Acc;
- stream_terminate_children([{Pid, StreamID}|Tail], StreamID, Acc) ->
- exit(Pid, kill),
- stream_terminate_children(Tail, StreamID, Acc);
- stream_terminate_children([Child|Tail], StreamID, Acc) ->
- stream_terminate_children(Tail, StreamID, [Child|Acc]).
- %% Headers encode/decode.
- headers_decode(HeaderBlock, DecodeState0) ->
- {Headers, DecodeState} = cow_hpack:decode(HeaderBlock, DecodeState0),
- {maps:from_list(Headers), DecodeState}.
- %% @todo We will need to special-case the set-cookie header here.
- headers_encode(Headers0, EncodeState) ->
- Headers = maps:to_list(Headers0),
- cow_hpack:encode(Headers, EncodeState).
- %% System callbacks.
- -spec system_continue(_, _, #state{}) -> ok.
- system_continue(_, _, {State, Buffer}) ->
- loop(State, Buffer).
- -spec system_terminate(any(), _, _, _) -> no_return().
- system_terminate(Reason, _, _, _) ->
- exit(Reason).
- -spec system_code_change(Misc, _, _, _) -> {ok, Misc} when Misc::{#state{}, binary()}.
- system_code_change(Misc, _, _, _) ->
- {ok, Misc}.
|