mirror of
https://github.com/processone/ejabberd.git
synced 2024-12-22 17:28:25 +01:00
8b2d308498
Now 'From' and 'To' arguments must be omitted in functions
and structures related to routing.
The commit deprecates the following functions:
ejabberd_router:route/3 in favor of ejabberd_router:route/1
ejabberd_router:route_error/4 in favor of ejabberd_router:route_error/2
ejabberd_local:route_iq/4 in favor of ejabberd_local:route_iq/2
ejabberd_local:route_iq/5 in favor of ejabberd_local:route_iq/3
The format of {route, From, To, Packet} is changed in favor of {route, Packet}
185 lines
7.3 KiB
Erlang
185 lines
7.3 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : mod_echo.erl
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
|
%%% Purpose : Simple ejabberd module.
|
|
%%% Created : 15 Jan 2003 by Alexey Shchepin <alexey@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2017 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.,
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
%%%
|
|
%%%----------------------------------------------------------------------
|
|
|
|
-module(mod_echo).
|
|
|
|
-author('alexey@process-one.net').
|
|
|
|
-behaviour(gen_server).
|
|
|
|
-behaviour(gen_mod).
|
|
|
|
%% API
|
|
-export([start/2, stop/1, do_client_version/3]).
|
|
|
|
-export([init/1, handle_call/3, handle_cast/2,
|
|
handle_info/2, terminate/2, code_change/3,
|
|
mod_opt_type/1, depends/2]).
|
|
|
|
-include("ejabberd.hrl").
|
|
-include("logger.hrl").
|
|
|
|
-include("xmpp.hrl").
|
|
|
|
-record(state, {host = <<"">> :: binary()}).
|
|
|
|
%%====================================================================
|
|
%% gen_mod API
|
|
%%====================================================================
|
|
start(Host, Opts) ->
|
|
gen_mod:start_child(?MODULE, Host, Opts).
|
|
|
|
stop(Host) ->
|
|
gen_mod:stop_child(?MODULE, Host).
|
|
|
|
depends(_Host, _Opts) ->
|
|
[].
|
|
|
|
mod_opt_type(host) -> fun iolist_to_binary/1;
|
|
mod_opt_type(_) -> [host].
|
|
|
|
%%====================================================================
|
|
%% gen_server callbacks
|
|
%%====================================================================
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: init(Args) -> {ok, State} |
|
|
%% {ok, State, Timeout} |
|
|
%% ignore |
|
|
%% {stop, Reason}
|
|
%% Description: Initiates the server
|
|
%%--------------------------------------------------------------------
|
|
init([Host, Opts]) ->
|
|
process_flag(trap_exit, true),
|
|
MyHost = gen_mod:get_opt_host(Host, Opts,
|
|
<<"echo.@HOST@">>),
|
|
ejabberd_router:register_route(MyHost, Host),
|
|
{ok, #state{host = MyHost}}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% 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(stop, _From, State) ->
|
|
{stop, normal, ok, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: handle_cast(Msg, State) -> {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling cast messages
|
|
%%--------------------------------------------------------------------
|
|
handle_cast(_Msg, State) -> {noreply, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Function: handle_info(Info, State) -> {noreply, State} |
|
|
%% {noreply, State, Timeout} |
|
|
%% {stop, Reason, State}
|
|
%% Description: Handling all non call/cast messages
|
|
%%--------------------------------------------------------------------
|
|
handle_info({route, Packet}, State) ->
|
|
From = xmpp:get_from(Packet),
|
|
To = xmpp:get_to(Packet),
|
|
Packet2 = case From#jid.user of
|
|
<<"">> ->
|
|
Lang = xmpp:get_lang(Packet),
|
|
Txt = <<"User part of JID in 'from' is empty">>,
|
|
xmpp:make_error(
|
|
Packet, xmpp:err_bad_request(Txt, Lang));
|
|
_ ->
|
|
xmpp:set_from_to(Packet, To, From)
|
|
end,
|
|
do_client_version(disabled, To, From),
|
|
ejabberd_router:route(Packet2),
|
|
{noreply, State};
|
|
handle_info(_Info, State) -> {noreply, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% 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) ->
|
|
ejabberd_router:unregister_route(State#state.host), ok.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Func: code_change(OldVsn, State, Extra) -> {ok, NewState}
|
|
%% Description: Convert process state when code is changed
|
|
%%--------------------------------------------------------------------
|
|
code_change(_OldVsn, State, _Extra) -> {ok, State}.
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Example of routing XMPP packets using Erlang's message passing
|
|
%%--------------------------------------------------------------------
|
|
|
|
%% To enable this educational example, edit the function handle_info:
|
|
%% replace the argument 'disabled' with 'enabled' in the call to the
|
|
%% function do_client_version.
|
|
|
|
%% ejabberd provides a method to receive XMPP packets using Erlang's
|
|
%% message passing mechanism.
|
|
%%
|
|
%% The packets received by ejabberd are sent
|
|
%% to the local destination process by sending an Erlang message.
|
|
%% This means that you can receive XMPP stanzas in an Erlang process
|
|
%% using Erlang's Receive, as long as this process is registered in
|
|
%% ejabberd as the process which handles the destination JID.
|
|
%%
|
|
%% This example function is called when a client queries the echo service.
|
|
%% This function then sends a query to the client, and waits 5 seconds to
|
|
%% receive an answer. The answer will only be accepted if it was sent
|
|
%% using exactly the same JID. We add a (mostly) random resource to
|
|
%% try to guarantee that the received response matches the request sent.
|
|
%% Finally, the received response is printed in the ejabberd log file.
|
|
|
|
%% THIS IS **NOT** HOW TO WRITE ejabberd CODE. THIS CODE IS RETARDED.
|
|
|
|
do_client_version(disabled, _From, _To) -> ok;
|
|
do_client_version(enabled, From, To) ->
|
|
Random_resource = randoms:get_string(),
|
|
From2 = From#jid{resource = Random_resource,
|
|
lresource = Random_resource},
|
|
ID = randoms:get_string(),
|
|
Packet = #iq{from = From2, to = To, type = get,
|
|
id = randoms:get_string(),
|
|
sub_els = [#version{}]},
|
|
ejabberd_router:route(Packet),
|
|
receive
|
|
{route,
|
|
#iq{to = To, from = From2,
|
|
id = ID, type = result, sub_els = [#version{} = V]}} ->
|
|
?INFO_MSG("Version of the client ~s:~n~s",
|
|
[jid:to_string(To), xmpp:pp(V)])
|
|
after 5000 -> % Timeout in miliseconds: 5 seconds
|
|
[]
|
|
end.
|