451 lines
15 KiB
Erlang
451 lines
15 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : ejabberd_receiver.erl
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
|
%%% Purpose : Socket receiver for C2S and S2S connections
|
|
%%% Created : 10 Nov 2003 by Alexey Shchepin <alexey@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2012 ProcessOne
|
|
%%%
|
|
%%% This program is free software; you can redistribute it and/or
|
|
%%% modify it under the terms of the GNU General Public License as
|
|
%%% published by the Free Software Foundation; either version 2 of the
|
|
%%% License, or (at your option) any later version.
|
|
%%%
|
|
%%% This program is distributed in the hope that it will be useful,
|
|
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
%%% General Public License for more details.
|
|
%%%
|
|
%%% You should have received a copy of the GNU General Public License
|
|
%%% along with this program; if not, write to the Free Software
|
|
%%% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
|
|
%%% 02111-1307 USA
|
|
%%%
|
|
%%%----------------------------------------------------------------------
|
|
|
|
-module(ejabberd_receiver).
|
|
-author('alexey@process-one.net').
|
|
|
|
-behaviour(gen_server).
|
|
|
|
%% API
|
|
-export([start_link/4,
|
|
start/3,
|
|
start/4,
|
|
change_shaper/2,
|
|
reset_stream/1,
|
|
starttls/2,
|
|
starttls/3,
|
|
compress/2,
|
|
send/2,
|
|
become_controller/2,
|
|
change_controller/2,
|
|
setopts/2,
|
|
close/1]).
|
|
|
|
%% gen_server callbacks
|
|
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
|
|
terminate/2, code_change/3]).
|
|
|
|
-include("ejabberd.hrl").
|
|
|
|
-record(state, {socket,
|
|
sock_mod,
|
|
shaper_state,
|
|
c2s_pid,
|
|
max_stanza_size,
|
|
xml_stream_state,
|
|
tref,
|
|
timeout}).
|
|
|
|
-define(HIBERNATE_TIMEOUT, 90000).
|
|
|
|
%%====================================================================
|
|
%% API
|
|
%%====================================================================
|
|
%%--------------------------------------------------------------------
|
|
%% Function: start_link() -> {ok,Pid} | ignore | {error,Error}
|
|
%% Description: Starts the server
|
|
%%--------------------------------------------------------------------
|
|
start_link(Socket, SockMod, Shaper, MaxStanzaSize) ->
|
|
gen_server:start_link(
|
|
?MODULE, [Socket, SockMod, Shaper, MaxStanzaSize], []).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: start() -> {ok,Pid} | ignore | {error,Error}
|
|
%% Description: Starts the server
|
|
%%--------------------------------------------------------------------
|
|
start(Socket, SockMod, Shaper) ->
|
|
start(Socket, SockMod, Shaper, infinity).
|
|
|
|
start(Socket, SockMod, Shaper, MaxStanzaSize) ->
|
|
{ok, Pid} = supervisor:start_child(
|
|
ejabberd_receiver_sup,
|
|
[Socket, SockMod, Shaper, MaxStanzaSize]),
|
|
Pid.
|
|
|
|
change_shaper(Pid, Shaper) ->
|
|
gen_server:cast(Pid, {change_shaper, Shaper}).
|
|
|
|
reset_stream(Pid) ->
|
|
gen_server:call(Pid, reset_stream).
|
|
|
|
starttls(Pid, TLSOpts) ->
|
|
starttls(Pid, TLSOpts, undefined).
|
|
|
|
starttls(Pid, TLSOpts, Data) ->
|
|
gen_server:call(Pid, {starttls, TLSOpts, Data}).
|
|
|
|
compress(Pid, Data) ->
|
|
gen_server:call(Pid, {compress, Data}).
|
|
|
|
become_controller(Pid, C2SPid) ->
|
|
gen_server:call(Pid, {become_controller, C2SPid}).
|
|
|
|
change_controller(Pid, C2SPid) ->
|
|
gen_server:call(Pid, {change_controller, C2SPid}).
|
|
|
|
setopts(Pid, Opts) ->
|
|
case lists:member({active, false}, Opts) of
|
|
true ->
|
|
gen_server:call(Pid, deactivate_socket);
|
|
false ->
|
|
ok
|
|
end.
|
|
|
|
send(Pid, Data) ->
|
|
gen_server:call(Pid, {send, Data}).
|
|
|
|
close(Pid) ->
|
|
gen_server:cast(Pid, close).
|
|
|
|
%%====================================================================
|
|
%% gen_server callbacks
|
|
%%====================================================================
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: init(Args) -> {ok, State} |
|
|
%% {ok, State, Timeout} |
|
|
%% ignore |
|
|
%% {stop, Reason}
|
|
%% Description: Initiates the server
|
|
%%--------------------------------------------------------------------
|
|
init([Socket, SockMod, Shaper, MaxStanzaSize]) ->
|
|
ShaperState = shaper:new(Shaper),
|
|
Timeout = case SockMod of
|
|
ssl ->
|
|
20;
|
|
_ ->
|
|
infinity
|
|
end,
|
|
{ok, #state{socket = Socket,
|
|
sock_mod = SockMod,
|
|
shaper_state = ShaperState,
|
|
max_stanza_size = MaxStanzaSize,
|
|
timeout = Timeout}}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: %% handle_call(Request, From, State) -> {reply, Reply, State} |
|
|
%% {reply, Reply, State, Timeout} |
|
|
%% {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, Reply, State} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling call messages
|
|
%%--------------------------------------------------------------------
|
|
handle_call({starttls, TLSOpts, Data}, _From, State) ->
|
|
{ok, TLSSocket} = tls:tcp_to_tls(State#state.socket, TLSOpts),
|
|
if Data /= undefined ->
|
|
do_send(State, Data);
|
|
true ->
|
|
ok
|
|
end,
|
|
NewXMLStreamState = do_reset_stream(State),
|
|
NewState = State#state{socket = TLSSocket,
|
|
sock_mod = tls,
|
|
xml_stream_state = NewXMLStreamState},
|
|
case tls:recv_data(TLSSocket, "") of
|
|
{ok, TLSData} ->
|
|
{NextState, Hib} = process_data(TLSData, NewState),
|
|
{reply, {ok, TLSSocket}, NextState, Hib};
|
|
{error, _Reason} ->
|
|
{stop, normal, ok, NewState}
|
|
end;
|
|
handle_call({compress, Data}, _From,
|
|
#state{xml_stream_state = XMLStreamState,
|
|
sock_mod = SockMod,
|
|
socket = Socket} = State) ->
|
|
{ok, ZlibSocket} = ejabberd_zlib:enable_zlib(SockMod, Socket),
|
|
if Data /= undefined ->
|
|
do_send(State, Data);
|
|
true ->
|
|
ok
|
|
end,
|
|
NewXMLStreamState = exmpp_xmlstream:reset(XMLStreamState),
|
|
NewState = State#state{socket = ZlibSocket,
|
|
sock_mod = ejabberd_zlib,
|
|
xml_stream_state = NewXMLStreamState},
|
|
case ejabberd_zlib:recv_data(ZlibSocket, "") of
|
|
{ok, ZlibData} ->
|
|
{NextState, Hib} = process_data(ZlibData, NewState),
|
|
{reply, {ok, ZlibSocket}, NextState, Hib};
|
|
{error, _Reason} ->
|
|
{stop, normal, ok, NewState}
|
|
end;
|
|
handle_call(reset_stream, _From,
|
|
#state{xml_stream_state = XMLStreamState} = State) ->
|
|
NewXMLStreamState = exmpp_xmlstream:reset(XMLStreamState),
|
|
Reply = ok,
|
|
{reply, Reply, State#state{xml_stream_state = NewXMLStreamState},
|
|
?HIBERNATE_TIMEOUT};
|
|
handle_call({become_controller, C2SPid}, _From, State) ->
|
|
erlang:monitor(process, C2SPid),
|
|
close_stream(State#state.xml_stream_state),
|
|
XMLStreamState = new_xmlstream(C2SPid, State#state.max_stanza_size),
|
|
NewState = State#state{c2s_pid = C2SPid,
|
|
xml_stream_state = XMLStreamState},
|
|
activate_socket(NewState),
|
|
Reply = ok,
|
|
{reply, Reply, NewState, ?HIBERNATE_TIMEOUT};
|
|
handle_call({change_controller, C2SPid}, _From, State) ->
|
|
erlang:monitor(process, C2SPid),
|
|
NewXMLStreamState = exmpp_xmlstream:change_callback(
|
|
State#state.xml_stream_state, {gen_fsm, C2SPid}),
|
|
NewState = State#state{c2s_pid = C2SPid,
|
|
xml_stream_state = NewXMLStreamState},
|
|
activate_socket(NewState),
|
|
{reply, ok, NewState, ?HIBERNATE_TIMEOUT};
|
|
handle_call({send, Data}, _From, State) ->
|
|
case do_send(State, Data) of
|
|
ok ->
|
|
{reply, ok, State, ?HIBERNATE_TIMEOUT};
|
|
{error, _Reason} = Err ->
|
|
{stop, normal, Err, State}
|
|
end;
|
|
handle_call(deactivate_socket, _From, State) ->
|
|
deactivate_socket(State),
|
|
{reply, ok, State, ?HIBERNATE_TIMEOUT};
|
|
handle_call(_Request, _From, State) ->
|
|
Reply = ok,
|
|
{reply, Reply, State, ?HIBERNATE_TIMEOUT}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: handle_cast(Msg, State) -> {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling cast messages
|
|
%%--------------------------------------------------------------------
|
|
handle_cast({change_shaper, Shaper}, State) ->
|
|
NewShaperState = shaper:new(Shaper),
|
|
{noreply, State#state{shaper_state = NewShaperState}, ?HIBERNATE_TIMEOUT};
|
|
handle_cast(close, State) ->
|
|
{stop, normal, State};
|
|
handle_cast(_Msg, State) ->
|
|
{noreply, State, ?HIBERNATE_TIMEOUT}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: handle_info(Info, State) -> {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling all non call/cast messages
|
|
%%--------------------------------------------------------------------
|
|
handle_info({Tag, _TCPSocket, Data},
|
|
#state{socket = Socket,
|
|
sock_mod = SockMod} = State)
|
|
when (Tag == tcp) or (Tag == ssl) or (Tag == ejabberd_xml) ->
|
|
case SockMod of
|
|
tls ->
|
|
case tls:recv_data(Socket, Data) of
|
|
{ok, TLSData} ->
|
|
{NextState, Hib} = process_data(TLSData, State),
|
|
{noreply, NextState, Hib};
|
|
{error, _Reason} ->
|
|
{stop, normal, State}
|
|
end;
|
|
ejabberd_zlib ->
|
|
case ejabberd_zlib:recv_data(Socket, Data) of
|
|
{ok, ZlibData} ->
|
|
{NextState, Hib} = process_data(ZlibData, State),
|
|
{noreply, NextState, Hib};
|
|
{error, _Reason} ->
|
|
{stop, normal, State}
|
|
end;
|
|
_ ->
|
|
{NextState, Hib} = process_data(Data, State),
|
|
{noreply, NextState, Hib}
|
|
end;
|
|
handle_info({Tag, _TCPSocket}, State)
|
|
when (Tag == tcp_closed) or (Tag == ssl_closed) ->
|
|
{stop, normal, State};
|
|
handle_info({Tag, _TCPSocket, Reason}, State)
|
|
when (Tag == tcp_error) or (Tag == ssl_error) ->
|
|
case Reason of
|
|
timeout ->
|
|
{noreply, State, ?HIBERNATE_TIMEOUT};
|
|
_ ->
|
|
{stop, normal, State}
|
|
end;
|
|
handle_info({'DOWN', _MRef, process, C2SPid, _},
|
|
#state{c2s_pid = C2SPid} = State) ->
|
|
{stop, normal, State};
|
|
handle_info({timeout, _Ref, activate}, State) ->
|
|
activate_socket(State),
|
|
{noreply, State, ?HIBERNATE_TIMEOUT};
|
|
handle_info(timeout, State) ->
|
|
{noreply, State, hibernate};
|
|
|
|
handle_info(_Info, State) ->
|
|
{noreply, State, ?HIBERNATE_TIMEOUT}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: terminate(Reason, State) -> void()
|
|
%% Description: This function is called by a gen_server when it is about to
|
|
%% terminate. It should be the opposite of Module:init/1 and do any necessary
|
|
%% cleaning up. When it returns, the gen_server terminates with Reason.
|
|
%% The return value is ignored.
|
|
%%--------------------------------------------------------------------
|
|
terminate(_Reason, #state{xml_stream_state = XMLStreamState,
|
|
c2s_pid = C2SPid} = State) ->
|
|
close_stream(XMLStreamState),
|
|
if
|
|
C2SPid /= undefined ->
|
|
gen_fsm:send_event(C2SPid, closed);
|
|
true ->
|
|
ok
|
|
end,
|
|
catch (State#state.sock_mod):close(State#state.socket),
|
|
ok.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
|
|
%% Description: Convert process state when code is changed
|
|
%%--------------------------------------------------------------------
|
|
code_change(_OldVsn, State, _Extra) ->
|
|
{ok, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%%% Internal functions
|
|
%%--------------------------------------------------------------------
|
|
|
|
activate_socket(#state{socket = Socket,
|
|
sock_mod = SockMod}) ->
|
|
PeerName =
|
|
case SockMod of
|
|
gen_tcp ->
|
|
inet:setopts(Socket, [{active, once}]),
|
|
inet:peername(Socket);
|
|
_ ->
|
|
SockMod:setopts(Socket, [{active, once}]),
|
|
SockMod:peername(Socket)
|
|
end,
|
|
case PeerName of
|
|
{error, _Reason} ->
|
|
self() ! {tcp_closed, Socket};
|
|
{ok, _} ->
|
|
ok
|
|
end.
|
|
|
|
deactivate_socket(#state{socket = Socket,
|
|
tref = TRef,
|
|
sock_mod = SockMod}) ->
|
|
cancel_timer(TRef),
|
|
case SockMod of
|
|
gen_tcp ->
|
|
inet:setopts(Socket, [{active, false}]);
|
|
_ ->
|
|
SockMod:setopts(Socket, [{active, false}])
|
|
end.
|
|
|
|
%% Data processing for connectors directly generating xmlel in
|
|
%% Erlang data structure.
|
|
%% WARNING: Shaper does not work with Erlang data structure.
|
|
process_data([], State) ->
|
|
activate_socket(State),
|
|
State;
|
|
process_data([Element|Els], #state{c2s_pid = C2SPid} = State)
|
|
when element(1, Element) == xmlel;
|
|
element(1, Element) == xmlstreamstart;
|
|
element(1, Element) == xmlstreamelement;
|
|
element(1, Element) == xmlstreamend ->
|
|
if
|
|
C2SPid == undefined ->
|
|
State;
|
|
true ->
|
|
catch gen_fsm:send_event(C2SPid, element_wrapper(Element)),
|
|
process_data(Els, State)
|
|
end;
|
|
%% Data processing for connectors receivind data as string.
|
|
process_data(Data,
|
|
#state{xml_stream_state = XMLStreamState,
|
|
tref = TRef,
|
|
shaper_state = ShaperState,
|
|
c2s_pid = C2SPid} = State) ->
|
|
?DEBUG("Received XML on stream = ~p", [Data]),
|
|
{ok, XMLStreamState1} = exmpp_xmlstream:parse(XMLStreamState, Data),
|
|
{NewShaperState, Pause} = shaper:update(ShaperState, size(Data)),
|
|
{NewTRef, HibTimeout} =
|
|
if
|
|
C2SPid == undefined ->
|
|
{TRef, infinity};
|
|
Pause > 0 ->
|
|
{erlang:start_timer(Pause, self(), activate), hibernate};
|
|
true ->
|
|
activate_socket(State),
|
|
{TRef, ?HIBERNATE_TIMEOUT}
|
|
end,
|
|
{State#state{xml_stream_state = XMLStreamState1,
|
|
tref = NewTRef,
|
|
shaper_state = NewShaperState}, HibTimeout}.
|
|
|
|
%% Element coming from XML parser are wrapped inside xmlstreamelement
|
|
%% When we receive directly xmlel tuple (from a socket module
|
|
%% speaking directly Erlang XML), we wrap it inside the same
|
|
%% xmlstreamelement coming from the XML parser.
|
|
element_wrapper(XmlEl)
|
|
when element(1, XmlEl) == xmlel ->
|
|
{xmlstreamelement, XmlEl};
|
|
element_wrapper(Element) ->
|
|
Element.
|
|
|
|
close_stream(undefined) ->
|
|
ok;
|
|
close_stream(XMLStreamState) ->
|
|
exmpp_xml:stop_parser(exmpp_xmlstream:get_parser(XMLStreamState)),
|
|
exmpp_xmlstream:stop(XMLStreamState).
|
|
|
|
do_send(State, Data) ->
|
|
(State#state.sock_mod):send(State#state.socket, Data).
|
|
|
|
cancel_timer(TRef) when is_reference(TRef) ->
|
|
case erlang:cancel_timer(TRef) of
|
|
false ->
|
|
receive
|
|
{timeout, TRef, _} ->
|
|
ok
|
|
after 0 ->
|
|
ok
|
|
end;
|
|
_ ->
|
|
ok
|
|
end;
|
|
cancel_timer(_) ->
|
|
ok.
|
|
|
|
do_reset_stream(#state{xml_stream_state = undefined, c2s_pid = C2SPid, max_stanza_size = MaxStanzaSize}) ->
|
|
new_xmlstream(C2SPid, MaxStanzaSize);
|
|
|
|
do_reset_stream(#state{xml_stream_state = XMLStreamState}) ->
|
|
exmpp_xmlstream:reset(XMLStreamState).
|
|
|
|
|
|
new_xmlstream(C2SPid, MaxStanzaSize) ->
|
|
Parser = exmpp_xml:start_parser([{names_as_atom, true},
|
|
{check_nss, xmpp},
|
|
{check_elems, xmpp},
|
|
{max_size, MaxStanzaSize}
|
|
]),
|
|
exmpp_xmlstream:start({gen_fsm, C2SPid}, Parser,
|
|
[{xmlstreamstart, new}]
|
|
).
|