mirror of
https://github.com/processone/ejabberd.git
synced 2024-10-13 15:16:49 +02:00
fd8e07af47
The header consisted of too many unrelated stuff and macros misuse. Some stuff is moved into scram.hrl and type_compat.hrl. All macros have been replaced with the corresponding function calls. TODO: probably type_compat.hrl is not even needed anymore since we support only Erlang >= OTP 17.5
1106 lines
35 KiB
Erlang
1106 lines
35 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : mod_multicast.erl
|
|
%%% Author : Badlop <badlop@process-one.net>
|
|
%%% Purpose : Extended Stanza Addressing (XEP-0033) support
|
|
%%% Created : 29 May 2007 by Badlop <badlop@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2018 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_multicast).
|
|
|
|
-author('badlop@process-one.net').
|
|
|
|
-protocol({xep, 33, '1.1'}).
|
|
|
|
-behaviour(gen_server).
|
|
|
|
-behaviour(gen_mod).
|
|
|
|
%% API
|
|
-export([start/2, stop/1, reload/3]).
|
|
|
|
%% gen_server callbacks
|
|
-export([init/1, handle_info/2, handle_call/3,
|
|
handle_cast/2, terminate/2, code_change/3]).
|
|
|
|
-export([purge_loop/1, mod_opt_type/1, mod_options/1, depends/2]).
|
|
|
|
-include("logger.hrl").
|
|
-include("translate.hrl").
|
|
-include("xmpp.hrl").
|
|
|
|
-record(multicastc, {rserver :: binary(),
|
|
response,
|
|
ts :: integer()}).
|
|
|
|
-record(dest, {jid_string :: binary() | none,
|
|
jid_jid :: xmpp:jid(),
|
|
type :: to | cc | bcc,
|
|
address :: address()}).
|
|
|
|
-type limit_value() :: {default | custom, integer()}.
|
|
-record(limits, {message :: limit_value(),
|
|
presence :: limit_value()}).
|
|
|
|
-record(service_limits, {local :: #limits{},
|
|
remote :: #limits{}}).
|
|
|
|
-type routing() :: route_single | {route_multicast, binary(), #service_limits{}}.
|
|
|
|
-record(group, {server :: binary(),
|
|
dests :: [#dest{}],
|
|
multicast :: routing(),
|
|
others :: [#address{}],
|
|
addresses :: [#address{}]}).
|
|
|
|
-record(state, {lserver :: binary(),
|
|
lservice :: binary(),
|
|
access :: atom(),
|
|
service_limits :: #service_limits{}}).
|
|
-type state() :: #state{}.
|
|
|
|
%% All the elements are of type value()
|
|
|
|
-define(VERSION_MULTICAST, <<"$Revision: 440 $ ">>).
|
|
|
|
-define(PURGE_PROCNAME,
|
|
ejabberd_mod_multicast_purgeloop).
|
|
|
|
-define(MAXTIME_CACHE_POSITIVE, 86400).
|
|
|
|
-define(MAXTIME_CACHE_NEGATIVE, 86400).
|
|
|
|
-define(MAXTIME_CACHE_NEGOTIATING, 600).
|
|
|
|
-define(CACHE_PURGE_TIMER, 86400000).
|
|
|
|
-define(DISCO_QUERY_TIMEOUT, 10000).
|
|
|
|
-define(DEFAULT_LIMIT_LOCAL_MESSAGE, 100).
|
|
|
|
-define(DEFAULT_LIMIT_LOCAL_PRESENCE, 100).
|
|
|
|
-define(DEFAULT_LIMIT_REMOTE_MESSAGE, 20).
|
|
|
|
-define(DEFAULT_LIMIT_REMOTE_PRESENCE, 20).
|
|
|
|
start(LServerS, Opts) ->
|
|
gen_mod:start_child(?MODULE, LServerS, Opts).
|
|
|
|
stop(LServerS) ->
|
|
gen_mod:stop_child(?MODULE, LServerS).
|
|
|
|
reload(LServerS, NewOpts, OldOpts) ->
|
|
Proc = gen_mod:get_module_proc(LServerS, ?MODULE),
|
|
gen_server:cast(Proc, {reload, NewOpts, OldOpts}).
|
|
|
|
%%====================================================================
|
|
%% gen_server callbacks
|
|
%%====================================================================
|
|
|
|
-spec init(list()) -> {ok, state()}.
|
|
init([LServerS, Opts]) ->
|
|
process_flag(trap_exit, true),
|
|
[LServiceS|_] = gen_mod:get_opt_hosts(LServerS, Opts),
|
|
Access = gen_mod:get_opt(access, Opts),
|
|
SLimits = build_service_limit_record(gen_mod:get_opt(limits, Opts)),
|
|
create_cache(),
|
|
try_start_loop(),
|
|
ejabberd_router_multicast:register_route(LServerS),
|
|
ejabberd_router:register_route(LServiceS, LServerS),
|
|
{ok,
|
|
#state{lservice = LServiceS, lserver = LServerS,
|
|
access = Access, service_limits = SLimits}}.
|
|
|
|
handle_call(stop, _From, State) ->
|
|
try_stop_loop(), {stop, normal, ok, State}.
|
|
|
|
handle_cast({reload, NewOpts, NewOpts},
|
|
#state{lserver = LServerS, lservice = OldLServiceS} = State) ->
|
|
Access = gen_mod:get_opt(access, NewOpts),
|
|
SLimits = build_service_limit_record(gen_mod:get_opt(limits, NewOpts)),
|
|
[NewLServiceS|_] = gen_mod:get_opt_hosts(LServerS, NewOpts),
|
|
if NewLServiceS /= OldLServiceS ->
|
|
ejabberd_router:register_route(NewLServiceS, LServerS),
|
|
ejabberd_router:unregister_route(OldLServiceS);
|
|
true ->
|
|
ok
|
|
end,
|
|
{noreply, State#state{lservice = NewLServiceS,
|
|
access = Access, service_limits = SLimits}};
|
|
handle_cast(Msg, State) ->
|
|
?WARNING_MSG("unexpected cast: ~p", [Msg]),
|
|
{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, #iq{} = Packet}, State) ->
|
|
case catch handle_iq(Packet, State) of
|
|
{'EXIT', Reason} ->
|
|
?ERROR_MSG("Error when processing IQ stanza: ~p",
|
|
[Reason]);
|
|
_ -> ok
|
|
end,
|
|
{noreply, State};
|
|
%% XEP33 allows only 'message' and 'presence' stanza type
|
|
handle_info({route, Packet},
|
|
#state{lservice = LServiceS, lserver = LServerS,
|
|
access = Access, service_limits = SLimits} =
|
|
State) when ?is_stanza(Packet) ->
|
|
route_untrusted(LServiceS, LServerS, Access, SLimits, Packet),
|
|
{noreply, State};
|
|
%% Handle multicast packets sent by trusted local services
|
|
handle_info({route_trusted, Destinations, Packet},
|
|
#state{lservice = LServiceS, lserver = LServerS} =
|
|
State) ->
|
|
From = xmpp:get_from(Packet),
|
|
case catch route_trusted(LServiceS, LServerS, From, Destinations,
|
|
Packet) of
|
|
{'EXIT', Reason} ->
|
|
?ERROR_MSG("Error in route_trusted: ~p", [Reason]);
|
|
_ -> ok
|
|
end,
|
|
{noreply, State};
|
|
handle_info({get_host, Pid}, State) ->
|
|
Pid ! {my_host, State#state.lservice},
|
|
{noreply, State};
|
|
handle_info(_Info, State) -> {noreply, State}.
|
|
|
|
terminate(_Reason, State) ->
|
|
ejabberd_router_multicast:unregister_route(State#state.lserver),
|
|
ejabberd_router:unregister_route(State#state.lservice),
|
|
ok.
|
|
|
|
code_change(_OldVsn, State, _Extra) -> {ok, State}.
|
|
|
|
%%====================================================================
|
|
%%% Internal functions
|
|
%%====================================================================
|
|
|
|
%%%------------------------
|
|
%%% IQ Request Processing
|
|
%%%------------------------
|
|
|
|
handle_iq(Packet, State) ->
|
|
try
|
|
IQ = xmpp:decode_els(Packet),
|
|
case process_iq(IQ, State) of
|
|
{result, SubEl} ->
|
|
ejabberd_router:route(xmpp:make_iq_result(Packet, SubEl));
|
|
{error, Error} ->
|
|
ejabberd_router:route_error(Packet, Error);
|
|
reply ->
|
|
To = xmpp:get_to(IQ),
|
|
LServiceS = jid:encode(To),
|
|
case Packet#iq.type of
|
|
result ->
|
|
process_iqreply_result(LServiceS, IQ);
|
|
error ->
|
|
process_iqreply_error(LServiceS, IQ)
|
|
end
|
|
end
|
|
catch _:{xmpp_codec, Why} ->
|
|
Lang = xmpp:get_lang(Packet),
|
|
Err = xmpp:err_bad_request(xmpp:io_format_error(Why), Lang),
|
|
ejabberd_router:route_error(Packet, Err)
|
|
end.
|
|
|
|
-spec process_iq(iq(), state()) -> {result, xmpp_element()} |
|
|
{error, stanza_error()} | reply.
|
|
process_iq(#iq{type = get, lang = Lang, from = From,
|
|
sub_els = [#disco_info{}]}, State) ->
|
|
{result, iq_disco_info(From, Lang, State)};
|
|
process_iq(#iq{type = get, sub_els = [#disco_items{}]}, _) ->
|
|
{result, #disco_items{}};
|
|
process_iq(#iq{type = get, lang = Lang, sub_els = [#vcard_temp{}]}, _) ->
|
|
{result, iq_vcard(Lang)};
|
|
process_iq(#iq{type = T}, _) when T == set; T == get ->
|
|
{error, xmpp:err_service_unavailable()};
|
|
process_iq(_, _) ->
|
|
reply.
|
|
|
|
-define(FEATURE(Feat), Feat).
|
|
|
|
iq_disco_info(From, Lang, State) ->
|
|
Name = gen_mod:get_module_opt(State#state.lserver, ?MODULE, name),
|
|
#disco_info{
|
|
identities = [#identity{category = <<"service">>,
|
|
type = <<"multicast">>,
|
|
name = translate:translate(Lang, Name)}],
|
|
features = [?NS_DISCO_INFO, ?NS_DISCO_ITEMS, ?NS_VCARD, ?NS_ADDRESS],
|
|
xdata = iq_disco_info_extras(From, State)}.
|
|
|
|
iq_vcard(Lang) ->
|
|
#vcard_temp{fn = <<"ejabberd/mod_multicast">>,
|
|
url = ejabberd_config:get_uri(),
|
|
desc = misc:get_descr(Lang, <<"ejabberd Multicast service">>)}.
|
|
|
|
%%%-------------------------
|
|
%%% Route
|
|
%%%-------------------------
|
|
|
|
-spec route_trusted(binary(), binary(), jid(), [jid()], stanza()) -> 'ok'.
|
|
route_trusted(LServiceS, LServerS, FromJID,
|
|
Destinations, Packet) ->
|
|
Packet_stripped = Packet,
|
|
Delivereds = [],
|
|
Dests2 = lists:map(
|
|
fun(D) ->
|
|
#dest{jid_string = jid:encode(D),
|
|
jid_jid = D, type = bcc,
|
|
address = #address{type = bcc, jid = D}}
|
|
end, Destinations),
|
|
Groups = group_dests(Dests2),
|
|
route_common(LServerS, LServiceS, FromJID, Groups,
|
|
Delivereds, Packet_stripped).
|
|
|
|
-spec route_untrusted(binary(), binary(), atom(), #service_limits{}, stanza()) -> 'ok'.
|
|
route_untrusted(LServiceS, LServerS, Access, SLimits, Packet) ->
|
|
try route_untrusted2(LServiceS, LServerS, Access,
|
|
SLimits, Packet)
|
|
catch
|
|
adenied ->
|
|
route_error(Packet, forbidden,
|
|
<<"Access denied by service policy">>);
|
|
eadsele ->
|
|
route_error(Packet, bad_request,
|
|
<<"No addresses element found">>);
|
|
eadeles ->
|
|
route_error(Packet, bad_request,
|
|
<<"No address elements found">>);
|
|
ewxmlns ->
|
|
route_error(Packet, bad_request,
|
|
<<"Wrong xmlns">>);
|
|
etoorec ->
|
|
route_error(Packet, not_acceptable,
|
|
<<"Too many receiver fields were specified">>);
|
|
edrelay ->
|
|
route_error(Packet, forbidden,
|
|
<<"Packet relay is denied by service policy">>);
|
|
EType:EReason ->
|
|
?ERROR_MSG("Multicast unknown error: Type: ~p~nReason: ~p",
|
|
[EType, EReason]),
|
|
route_error(Packet, internal_server_error,
|
|
<<"Unknown problem">>)
|
|
end.
|
|
|
|
-spec route_untrusted2(binary(), binary(), atom(), #service_limits{}, stanza()) -> 'ok'.
|
|
route_untrusted2(LServiceS, LServerS, Access, SLimits, Packet) ->
|
|
FromJID = xmpp:get_from(Packet),
|
|
ok = check_access(LServerS, Access, FromJID),
|
|
{ok, Packet_stripped, Addresses} = strip_addresses_element(Packet),
|
|
{To_deliver, Delivereds} = split_addresses_todeliver(Addresses),
|
|
Dests = convert_dest_record(To_deliver),
|
|
{Dests2, Not_jids} = split_dests_jid(Dests),
|
|
report_not_jid(FromJID, Packet, Not_jids),
|
|
ok = check_limit_dests(SLimits, FromJID, Packet, Dests2),
|
|
Groups = group_dests(Dests2),
|
|
ok = check_relay(FromJID#jid.server, LServerS, Groups),
|
|
route_common(LServerS, LServiceS, FromJID, Groups,
|
|
Delivereds, Packet_stripped).
|
|
|
|
-spec route_common(binary(), binary(), jid(), [#group{}],
|
|
[address()], stanza()) -> 'ok'.
|
|
route_common(LServerS, LServiceS, FromJID, Groups,
|
|
Delivereds, Packet_stripped) ->
|
|
Groups2 = look_cached_servers(LServerS, LServiceS, Groups),
|
|
Groups3 = build_others_xml(Groups2),
|
|
Groups4 = add_addresses(Delivereds, Groups3),
|
|
AGroups = decide_action_groups(Groups4),
|
|
act_groups(FromJID, Packet_stripped, LServiceS,
|
|
AGroups).
|
|
|
|
-spec act_groups(jid(), stanza(), binary(), [{routing(), #group{}}]) -> 'ok'.
|
|
act_groups(FromJID, Packet_stripped, LServiceS, AGroups) ->
|
|
lists:foreach(
|
|
fun(AGroup) ->
|
|
perform(FromJID, Packet_stripped, LServiceS,
|
|
AGroup)
|
|
end, AGroups).
|
|
|
|
-spec perform(jid(), stanza(), binary(),
|
|
{routing(), #group{}}) -> 'ok'.
|
|
perform(From, Packet, _,
|
|
{route_single, Group}) ->
|
|
lists:foreach(
|
|
fun(ToUser) ->
|
|
route_packet(From, ToUser, Packet,
|
|
Group#group.others, Group#group.addresses)
|
|
end, Group#group.dests);
|
|
perform(From, Packet, _,
|
|
{{route_multicast, JID, RLimits}, Group}) ->
|
|
route_packet_multicast(From, JID, Packet,
|
|
Group#group.dests, Group#group.addresses, RLimits).
|
|
|
|
%%%-------------------------
|
|
%%% Check access permission
|
|
%%%-------------------------
|
|
|
|
check_access(LServerS, Access, From) ->
|
|
case acl:match_rule(LServerS, Access, From) of
|
|
allow -> ok;
|
|
_ -> throw(adenied)
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Strip 'addresses' XML element
|
|
%%%-------------------------
|
|
|
|
-spec strip_addresses_element(stanza()) -> {ok, stanza(), [address()]}.
|
|
strip_addresses_element(Packet) ->
|
|
case xmpp:get_subtag(Packet, #addresses{}) of
|
|
#addresses{list = Addrs} ->
|
|
PacketStripped = xmpp:remove_subtag(Packet, #addresses{}),
|
|
{ok, PacketStripped, Addrs};
|
|
false ->
|
|
throw(eadsele)
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Split Addresses
|
|
%%%-------------------------
|
|
|
|
-spec split_addresses_todeliver([address()]) -> {[address()], [address()]}.
|
|
split_addresses_todeliver(Addresses) ->
|
|
lists:partition(
|
|
fun(#address{delivered = true}) ->
|
|
false;
|
|
(#address{type = Type}) ->
|
|
case Type of
|
|
to -> true;
|
|
cc -> true;
|
|
bcc -> true;
|
|
_ -> false
|
|
end
|
|
end, Addresses).
|
|
|
|
%%%-------------------------
|
|
%%% Check does not exceed limit of destinations
|
|
%%%-------------------------
|
|
|
|
-spec check_limit_dests(#service_limits{}, jid(), stanza(), [address()]) -> ok.
|
|
check_limit_dests(SLimits, FromJID, Packet,
|
|
Addresses) ->
|
|
SenderT = sender_type(FromJID),
|
|
Limits = get_slimit_group(SenderT, SLimits),
|
|
Type_of_stanza = type_of_stanza(Packet),
|
|
{_Type, Limit_number} = get_limit_number(Type_of_stanza,
|
|
Limits),
|
|
case length(Addresses) > Limit_number of
|
|
false -> ok;
|
|
true -> throw(etoorec)
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Convert Destination XML to record
|
|
%%%-------------------------
|
|
|
|
-spec convert_dest_record([address()]) -> [#dest{}].
|
|
convert_dest_record(Addrs) ->
|
|
lists:map(
|
|
fun(#address{jid = undefined} = Addr) ->
|
|
#dest{jid_string = none, address = Addr};
|
|
(#address{jid = JID, type = Type} = Addr) ->
|
|
#dest{jid_string = jid:encode(JID), jid_jid = JID,
|
|
type = Type, address = Addr}
|
|
end, Addrs).
|
|
|
|
%%%-------------------------
|
|
%%% Split destinations by existence of JID
|
|
%%% and send error messages for other dests
|
|
%%%-------------------------
|
|
|
|
-spec split_dests_jid([#dest{}]) -> {[#dest{}], [#dest{}]}.
|
|
split_dests_jid(Dests) ->
|
|
lists:partition(fun (Dest) ->
|
|
case Dest#dest.jid_string of
|
|
none -> false;
|
|
_ -> true
|
|
end
|
|
end,
|
|
Dests).
|
|
|
|
-spec report_not_jid(jid(), stanza(), [#dest{}]) -> any().
|
|
report_not_jid(From, Packet, Dests) ->
|
|
Dests2 = [fxml:element_to_binary(xmpp:encode(Dest#dest.address))
|
|
|| Dest <- Dests],
|
|
[route_error(xmpp:set_from_to(Packet, From, From), jid_malformed,
|
|
<<"This service can not process the address: ",
|
|
D/binary>>)
|
|
|| D <- Dests2].
|
|
|
|
%%%-------------------------
|
|
%%% Group destinations by their servers
|
|
%%%-------------------------
|
|
|
|
-spec group_dests([#dest{}]) -> [#group{}].
|
|
group_dests(Dests) ->
|
|
D = lists:foldl(fun (Dest, Dict) ->
|
|
ServerS = (Dest#dest.jid_jid)#jid.server,
|
|
dict:append(ServerS, Dest, Dict)
|
|
end,
|
|
dict:new(), Dests),
|
|
Keys = dict:fetch_keys(D),
|
|
[#group{server = Key, dests = dict:fetch(Key, D)}
|
|
|| Key <- Keys].
|
|
|
|
%%%-------------------------
|
|
%%% Look for cached responses
|
|
%%%-------------------------
|
|
|
|
look_cached_servers(LServerS, LServiceS, Groups) ->
|
|
[look_cached(LServerS, LServiceS, Group) || Group <- Groups].
|
|
|
|
look_cached(LServerS, LServiceS, G) ->
|
|
Maxtime_positive = (?MAXTIME_CACHE_POSITIVE),
|
|
Maxtime_negative = (?MAXTIME_CACHE_NEGATIVE),
|
|
Cached_response = search_server_on_cache(G#group.server,
|
|
LServerS, LServiceS,
|
|
{Maxtime_positive,
|
|
Maxtime_negative}),
|
|
G#group{multicast = Cached_response}.
|
|
|
|
%%%-------------------------
|
|
%%% Build delivered XML element
|
|
%%%-------------------------
|
|
|
|
build_others_xml(Groups) ->
|
|
[Group#group{others =
|
|
build_other_xml(Group#group.dests)}
|
|
|| Group <- Groups].
|
|
|
|
build_other_xml(Dests) ->
|
|
lists:foldl(fun (Dest, R) ->
|
|
XML = Dest#dest.address,
|
|
case Dest#dest.type of
|
|
to -> [add_delivered(XML) | R];
|
|
cc -> [add_delivered(XML) | R];
|
|
bcc -> R;
|
|
_ -> [XML | R]
|
|
end
|
|
end,
|
|
[], Dests).
|
|
|
|
-spec add_delivered(address()) -> address().
|
|
add_delivered(Addr) ->
|
|
Addr#address{delivered = true}.
|
|
|
|
%%%-------------------------
|
|
%%% Add preliminary packets
|
|
%%%-------------------------
|
|
|
|
add_addresses(Delivereds, Groups) ->
|
|
Ps = [Group#group.others || Group <- Groups],
|
|
add_addresses2(Delivereds, Groups, [], [], Ps).
|
|
|
|
add_addresses2(_, [], Res, _, []) -> Res;
|
|
add_addresses2(Delivereds, [Group | Groups], Res, Pa,
|
|
[Pi | Pz]) ->
|
|
Addresses = lists:append([Delivereds] ++ Pa ++ Pz),
|
|
Group2 = Group#group{addresses = Addresses},
|
|
add_addresses2(Delivereds, Groups, [Group2 | Res],
|
|
[Pi | Pa], Pz).
|
|
|
|
%%%-------------------------
|
|
%%% Decide action groups
|
|
%%%-------------------------
|
|
|
|
-spec decide_action_groups([#group{}]) -> [{routing(), #group{}}].
|
|
decide_action_groups(Groups) ->
|
|
[{Group#group.multicast, Group}
|
|
|| Group <- Groups].
|
|
|
|
%%%-------------------------
|
|
%%% Route packet
|
|
%%%-------------------------
|
|
|
|
-spec route_packet(jid(), #dest{}, xmpp:stanza(), [addresses()], [addresses()]) -> 'ok'.
|
|
route_packet(From, ToDest, Packet, Others, Addresses) ->
|
|
Dests = case ToDest#dest.type of
|
|
bcc -> [];
|
|
_ -> [ToDest]
|
|
end,
|
|
route_packet2(From, ToDest#dest.jid_string, Dests,
|
|
Packet, {Others, Addresses}).
|
|
|
|
-spec route_packet_multicast(jid(), binary(), xmpp:stanza(), [#dest{}], [address()], #limits{}) -> 'ok'.
|
|
route_packet_multicast(From, ToS, Packet, Dests,
|
|
Addresses, Limits) ->
|
|
Type_of_stanza = type_of_stanza(Packet),
|
|
{_Type, Limit_number} = get_limit_number(Type_of_stanza,
|
|
Limits),
|
|
Fragmented_dests = fragment_dests(Dests, Limit_number),
|
|
lists:foreach(fun(DFragment) ->
|
|
route_packet2(From, ToS, DFragment, Packet,
|
|
Addresses)
|
|
end, Fragmented_dests).
|
|
|
|
-spec route_packet2(jid(), binary(), [#dest{}], xmpp:stanza(), {[address()], [address()]} | [address()]) -> 'ok'.
|
|
route_packet2(From, ToS, Dests, Packet, Addresses) ->
|
|
Els = case append_dests(Dests, Addresses) of
|
|
[] ->
|
|
xmpp:get_els(Packet);
|
|
ACs ->
|
|
[#addresses{list = ACs}|xmpp:get_els(Packet)]
|
|
end,
|
|
Packet2 = xmpp:set_els(Packet, Els),
|
|
ToJID = stj(ToS),
|
|
ejabberd_router:route(xmpp:set_from_to(Packet2, From, ToJID)).
|
|
|
|
-spec append_dests([#dest{}], {[address()], [address()]} | [address()]) -> [address()].
|
|
append_dests(_Dests, {Others, Addresses}) ->
|
|
Addresses ++ Others;
|
|
append_dests([], Addresses) -> Addresses;
|
|
append_dests([Dest | Dests], Addresses) ->
|
|
append_dests(Dests, [Dest#dest.address | Addresses]).
|
|
|
|
%%%-------------------------
|
|
%%% Check relay
|
|
%%%-------------------------
|
|
|
|
-spec check_relay(binary(), binary(), [#group{}]) -> ok.
|
|
check_relay(RS, LS, Gs) ->
|
|
case check_relay_required(RS, LS, Gs) of
|
|
false -> ok;
|
|
true -> throw(edrelay)
|
|
end.
|
|
|
|
-spec check_relay_required(binary(), binary(), [#group{}]) -> boolean().
|
|
check_relay_required(RServer, LServerS, Groups) ->
|
|
case lists:suffix(str:tokens(LServerS, <<".">>),
|
|
str:tokens(RServer, <<".">>)) of
|
|
true -> false;
|
|
false -> check_relay_required(LServerS, Groups)
|
|
end.
|
|
|
|
-spec check_relay_required(binary(), [#group{}]) -> boolean().
|
|
check_relay_required(LServerS, Groups) ->
|
|
lists:any(fun (Group) -> Group#group.server /= LServerS
|
|
end,
|
|
Groups).
|
|
|
|
%%%-------------------------
|
|
%%% Check protocol support: Send request
|
|
%%%-------------------------
|
|
|
|
-spec send_query_info(binary(), binary(), binary()) -> ok.
|
|
send_query_info(RServerS, LServiceS, ID) ->
|
|
case str:str(RServerS, <<"echo.">>) of
|
|
1 -> ok;
|
|
_ -> send_query(RServerS, LServiceS, ID, #disco_info{})
|
|
end.
|
|
|
|
-spec send_query_items(binary(), binary(), binary()) -> ok.
|
|
send_query_items(RServerS, LServiceS, ID) ->
|
|
send_query(RServerS, LServiceS, ID, #disco_items{}).
|
|
|
|
-spec send_query(binary(), binary(), binary(), disco_info()|disco_items()) -> ok.
|
|
send_query(RServerS, LServiceS, ID, SubEl) ->
|
|
Packet = #iq{from = stj(LServiceS),
|
|
to = stj(RServerS),
|
|
id = ID,
|
|
type = get, sub_els = [SubEl]},
|
|
ejabberd_router:route(Packet).
|
|
|
|
%%%-------------------------
|
|
%%% Check protocol support: Receive response: Error
|
|
%%%-------------------------
|
|
|
|
process_iqreply_error(LServiceS, Packet) ->
|
|
FromS = jts(xmpp:get_from(Packet)),
|
|
ID = Packet#iq.id,
|
|
case str:tokens(ID, <<"/">>) of
|
|
[RServer, _] ->
|
|
case look_server(RServer) of
|
|
{cached, {_Response, {wait_for_info, ID}}, _TS}
|
|
when RServer == FromS ->
|
|
add_response(RServer, not_supported, cached);
|
|
{cached, {_Response, {wait_for_items, ID}}, _TS}
|
|
when RServer == FromS ->
|
|
add_response(RServer, not_supported, cached);
|
|
{cached, {Response, {wait_for_items_info, ID, Items}},
|
|
_TS} ->
|
|
case lists:member(FromS, Items) of
|
|
true ->
|
|
received_awaiter(
|
|
FromS, RServer, Response, ID, Items,
|
|
LServiceS);
|
|
false ->
|
|
ok
|
|
end;
|
|
_ ->
|
|
ok
|
|
end;
|
|
_ ->
|
|
ok
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Check protocol support: Receive response: Disco
|
|
%%%-------------------------
|
|
|
|
-spec process_iqreply_result(binary(), iq()) -> any().
|
|
process_iqreply_result(LServiceS, #iq{from = From, id = ID, sub_els = [SubEl]}) ->
|
|
case SubEl of
|
|
#disco_info{} ->
|
|
process_discoinfo_result(From, LServiceS, ID, SubEl);
|
|
#disco_items{} ->
|
|
process_discoitems_result(From, LServiceS, ID, SubEl);
|
|
_ ->
|
|
ok
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Check protocol support: Receive response: Disco Info
|
|
%%%-------------------------
|
|
|
|
process_discoinfo_result(From, LServiceS, ID, DiscoInfo) ->
|
|
FromS = jts(From),
|
|
case str:tokens(ID, <<"/">>) of
|
|
[RServer, _] ->
|
|
case look_server(RServer) of
|
|
{cached, {Response, {wait_for_info, ID} = ST}, _TS}
|
|
when RServer == FromS ->
|
|
process_discoinfo_result2(
|
|
From, FromS, LServiceS, DiscoInfo,
|
|
RServer, Response, ST);
|
|
{cached, {Response, {wait_for_items_info, ID, Items} = ST},
|
|
_TS} ->
|
|
case lists:member(FromS, Items) of
|
|
true ->
|
|
process_discoinfo_result2(
|
|
From, FromS, LServiceS, DiscoInfo,
|
|
RServer, Response, ST);
|
|
false ->
|
|
ok
|
|
end;
|
|
_ ->
|
|
ok
|
|
end;
|
|
_ ->
|
|
ok
|
|
end.
|
|
|
|
process_discoinfo_result2(From, FromS, LServiceS,
|
|
#disco_info{features = Feats} = DiscoInfo,
|
|
RServer, Response, ST) ->
|
|
Multicast_support = lists:member(?NS_ADDRESS, Feats),
|
|
case Multicast_support of
|
|
true ->
|
|
SenderT = sender_type(From),
|
|
RLimits = get_limits_xml(DiscoInfo, SenderT),
|
|
add_response(RServer, {multicast_supported, FromS, RLimits}, cached);
|
|
false ->
|
|
case ST of
|
|
{wait_for_info, _ID} ->
|
|
Random = randoms:get_string(),
|
|
ID = <<RServer/binary, $/, Random/binary>>,
|
|
send_query_items(FromS, LServiceS, ID),
|
|
add_response(RServer, Response, {wait_for_items, ID});
|
|
%% We asked a component, and it does not support XEP33
|
|
{wait_for_items_info, ID, Items} ->
|
|
received_awaiter(FromS, RServer, Response, ID, Items, LServiceS)
|
|
end
|
|
end.
|
|
|
|
get_limits_xml(DiscoInfo, SenderT) ->
|
|
LimitOpts = get_limits_els(DiscoInfo),
|
|
build_remote_limit_record(LimitOpts, SenderT).
|
|
|
|
-spec get_limits_els(disco_info()) -> [{atom(), integer()}].
|
|
get_limits_els(DiscoInfo) ->
|
|
lists:flatmap(
|
|
fun(#xdata{type = result} = X) ->
|
|
get_limits_fields(X);
|
|
(_) ->
|
|
[]
|
|
end, DiscoInfo#disco_info.xdata).
|
|
|
|
-spec get_limits_fields(xdata()) -> [{atom(), integer()}].
|
|
get_limits_fields(X) ->
|
|
{Head, Tail} = lists:partition(
|
|
fun(#xdata_field{var = Var, type = Type}) ->
|
|
Var == <<"FORM_TYPE">> andalso Type == hidden
|
|
end, X#xdata.fields),
|
|
case Head of
|
|
[] -> [];
|
|
_ -> get_limits_values(Tail)
|
|
end.
|
|
|
|
-spec get_limits_values([xdata_field()]) -> [{atom(), integer()}].
|
|
get_limits_values(Fields) ->
|
|
lists:flatmap(
|
|
fun(#xdata_field{var = Name, values = [Number]}) ->
|
|
try
|
|
[{binary_to_atom(Name, utf8), binary_to_integer(Number)}]
|
|
catch _:badarg ->
|
|
[]
|
|
end;
|
|
(_) ->
|
|
[]
|
|
end, Fields).
|
|
|
|
%%%-------------------------
|
|
%%% Check protocol support: Receive response: Disco Items
|
|
%%%-------------------------
|
|
|
|
process_discoitems_result(From, LServiceS, ID, #disco_items{items = Items}) ->
|
|
FromS = jts(From),
|
|
case str:tokens(ID, <<"/">>) of
|
|
[FromS = RServer, _] ->
|
|
case look_server(RServer) of
|
|
{cached, {Response, {wait_for_items, ID}}, _TS} ->
|
|
List = lists:flatmap(
|
|
fun(#disco_item{jid = #jid{luser = <<"">>,
|
|
lserver = LServer,
|
|
lresource = <<"">>}}) ->
|
|
[LServer];
|
|
(_) ->
|
|
[]
|
|
end, Items),
|
|
case List of
|
|
[] ->
|
|
add_response(RServer, not_supported, cached);
|
|
_ ->
|
|
Random = randoms:get_string(),
|
|
ID2 = <<RServer/binary, $/, Random/binary>>,
|
|
[send_query_info(Item, LServiceS, ID2) || Item <- List],
|
|
add_response(RServer, Response,
|
|
{wait_for_items_info, ID2, List})
|
|
end;
|
|
_ ->
|
|
ok
|
|
end;
|
|
_ ->
|
|
ok
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Check protocol support: Receive response: Received awaiter
|
|
%%%-------------------------
|
|
|
|
received_awaiter(JID, RServer, Response, ID, JIDs, _LServiceS) ->
|
|
case lists:delete(JID, JIDs) of
|
|
[] ->
|
|
add_response(RServer, not_supported, cached);
|
|
JIDs2 ->
|
|
add_response(RServer, Response, {wait_for_items_info, ID, JIDs2})
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Cache
|
|
%%%-------------------------
|
|
|
|
create_cache() ->
|
|
ejabberd_mnesia:create(?MODULE, multicastc,
|
|
[{ram_copies, [node()]},
|
|
{attributes, record_info(fields, multicastc)}]).
|
|
|
|
add_response(RServer, Response, State) ->
|
|
Secs = calendar:datetime_to_gregorian_seconds(calendar:local_time()),
|
|
mnesia:dirty_write(#multicastc{rserver = RServer,
|
|
response = {Response, State}, ts = Secs}).
|
|
|
|
search_server_on_cache(RServer, LServerS, _LServiceS, _Maxmins)
|
|
when RServer == LServerS ->
|
|
route_single;
|
|
search_server_on_cache(RServer, _LServerS, LServiceS, Maxmins) ->
|
|
case look_server(RServer) of
|
|
not_cached ->
|
|
query_info(RServer, LServiceS, not_supported),
|
|
route_single;
|
|
{cached, {Response, State}, TS} ->
|
|
Now = calendar:datetime_to_gregorian_seconds(calendar:local_time()),
|
|
Response2 =
|
|
case State of
|
|
cached ->
|
|
case is_obsolete(Response, TS, Now, Maxmins) of
|
|
false -> ok;
|
|
true ->
|
|
query_info(RServer, LServiceS, Response)
|
|
end,
|
|
Response;
|
|
_ ->
|
|
if
|
|
Now - TS > ?MAXTIME_CACHE_NEGOTIATING ->
|
|
query_info(RServer, LServiceS, not_supported),
|
|
not_supported;
|
|
true ->
|
|
Response
|
|
end
|
|
end,
|
|
case Response2 of
|
|
not_supported -> route_single;
|
|
{multicast_supported, Service, Limits} ->
|
|
{route_multicast, Service, Limits}
|
|
end
|
|
end.
|
|
|
|
query_info(RServer, LServiceS, Response) ->
|
|
Random = randoms:get_string(),
|
|
ID = <<RServer/binary, $/, Random/binary>>,
|
|
send_query_info(RServer, LServiceS, ID),
|
|
add_response(RServer, Response, {wait_for_info, ID}).
|
|
|
|
look_server(RServer) ->
|
|
case mnesia:dirty_read(multicastc, RServer) of
|
|
[] -> not_cached;
|
|
[M] -> {cached, M#multicastc.response, M#multicastc.ts}
|
|
end.
|
|
|
|
is_obsolete(Response, Ts, Now, {Max_pos, Max_neg}) ->
|
|
Max = case Response of
|
|
multicast_not_supported -> Max_neg;
|
|
_ -> Max_pos
|
|
end,
|
|
Now - Ts > Max.
|
|
|
|
%%%-------------------------
|
|
%%% Purge cache
|
|
%%%-------------------------
|
|
|
|
purge() ->
|
|
Maxmins_positive = (?MAXTIME_CACHE_POSITIVE),
|
|
Maxmins_negative = (?MAXTIME_CACHE_NEGATIVE),
|
|
Now =
|
|
calendar:datetime_to_gregorian_seconds(calendar:local_time()),
|
|
purge(Now, {Maxmins_positive, Maxmins_negative}).
|
|
|
|
purge(Now, Maxmins) ->
|
|
F = fun () ->
|
|
mnesia:foldl(fun (R, _) ->
|
|
#multicastc{response = Response, ts = Ts} =
|
|
R,
|
|
case is_obsolete(Response, Ts, Now,
|
|
Maxmins)
|
|
of
|
|
true -> mnesia:delete_object(R);
|
|
false -> ok
|
|
end
|
|
end,
|
|
none, multicastc)
|
|
end,
|
|
mnesia:transaction(F).
|
|
|
|
%%%-------------------------
|
|
%%% Purge cache loop
|
|
%%%-------------------------
|
|
|
|
try_start_loop() ->
|
|
case lists:member(?PURGE_PROCNAME, registered()) of
|
|
true -> ok;
|
|
false -> start_loop()
|
|
end,
|
|
(?PURGE_PROCNAME) ! new_module.
|
|
|
|
start_loop() ->
|
|
register(?PURGE_PROCNAME,
|
|
spawn(?MODULE, purge_loop, [0])),
|
|
(?PURGE_PROCNAME) ! purge_now.
|
|
|
|
try_stop_loop() -> (?PURGE_PROCNAME) ! try_stop.
|
|
|
|
purge_loop(NM) ->
|
|
receive
|
|
purge_now ->
|
|
purge(),
|
|
timer:send_after(?CACHE_PURGE_TIMER, ?PURGE_PROCNAME,
|
|
purge_now),
|
|
purge_loop(NM);
|
|
new_module -> purge_loop(NM + 1);
|
|
try_stop when NM > 1 -> purge_loop(NM - 1);
|
|
try_stop -> purge_loop_finished
|
|
end.
|
|
|
|
%%%-------------------------
|
|
%%% Limits: utils
|
|
%%%-------------------------
|
|
|
|
%% Type definitions for data structures related with XEP33 limits
|
|
%% limit() = {Name, Value}
|
|
%% Name = atom()
|
|
%% Value = {Type, Number}
|
|
%% Type = default | custom
|
|
%% Number = integer() | infinite
|
|
|
|
list_of_limits(local) ->
|
|
[{message, ?DEFAULT_LIMIT_LOCAL_MESSAGE},
|
|
{presence, ?DEFAULT_LIMIT_LOCAL_PRESENCE}];
|
|
list_of_limits(remote) ->
|
|
[{message, ?DEFAULT_LIMIT_REMOTE_MESSAGE},
|
|
{presence, ?DEFAULT_LIMIT_REMOTE_PRESENCE}].
|
|
|
|
build_service_limit_record(LimitOpts) ->
|
|
LimitOptsL = get_from_limitopts(LimitOpts, local),
|
|
LimitOptsR = get_from_limitopts(LimitOpts, remote),
|
|
{service_limits, build_limit_record(LimitOptsL, local),
|
|
build_limit_record(LimitOptsR, remote)}.
|
|
|
|
get_from_limitopts(LimitOpts, SenderT) ->
|
|
case lists:keyfind(SenderT, 1, LimitOpts) of
|
|
false -> [];
|
|
{SenderT, Result} -> Result
|
|
end.
|
|
|
|
build_remote_limit_record(LimitOpts, SenderT) ->
|
|
build_limit_record(LimitOpts, SenderT).
|
|
|
|
-spec build_limit_record(any(), local | remote) -> #limits{}.
|
|
build_limit_record(LimitOpts, SenderT) ->
|
|
Limits = [get_limit_value(Name, Default, LimitOpts)
|
|
|| {Name, Default} <- list_of_limits(SenderT)],
|
|
list_to_tuple([limits | Limits]).
|
|
|
|
-spec get_limit_value(atom(), integer(), any()) -> limit_value().
|
|
get_limit_value(Name, Default, LimitOpts) ->
|
|
case lists:keysearch(Name, 1, LimitOpts) of
|
|
{value, {Name, Number}} -> {custom, Number};
|
|
false -> {default, Default}
|
|
end.
|
|
|
|
type_of_stanza(Stanza) -> element(1, Stanza).
|
|
|
|
-spec get_limit_number(message | presence, #limits{}) -> limit_value().
|
|
get_limit_number(message, Limits) ->
|
|
Limits#limits.message;
|
|
get_limit_number(presence, Limits) ->
|
|
Limits#limits.presence.
|
|
|
|
-spec get_slimit_group(local | remote, #service_limits{}) -> #limits{}.
|
|
get_slimit_group(local, SLimits) ->
|
|
SLimits#service_limits.local;
|
|
get_slimit_group(remote, SLimits) ->
|
|
SLimits#service_limits.remote.
|
|
|
|
fragment_dests(Dests, Limit_number) ->
|
|
{R, _} = lists:foldl(fun (Dest, {Res, Count}) ->
|
|
case Count of
|
|
Limit_number ->
|
|
Head2 = [Dest], {[Head2 | Res], 0};
|
|
_ ->
|
|
[Head | Tail] = Res,
|
|
Head2 = [Dest | Head],
|
|
{[Head2 | Tail], Count + 1}
|
|
end
|
|
end,
|
|
{[[]], 0}, Dests),
|
|
R.
|
|
|
|
%%%-------------------------
|
|
%%% Limits: XEP-0128 Service Discovery Extensions
|
|
%%%-------------------------
|
|
|
|
%% Some parts of code are borrowed from mod_muc_room.erl
|
|
|
|
-define(RFIELDT(Type, Var, Val),
|
|
#xdata_field{type = Type, var = Var, values = [Val]}).
|
|
|
|
-define(RFIELDV(Var, Val),
|
|
#xdata_field{var = Var, values = [Val]}).
|
|
|
|
iq_disco_info_extras(From, State) ->
|
|
SenderT = sender_type(From),
|
|
Service_limits = State#state.service_limits,
|
|
case iq_disco_info_extras2(SenderT, Service_limits) of
|
|
[] -> [];
|
|
List_limits_xmpp ->
|
|
#xdata{type = result,
|
|
fields = [?RFIELDT(hidden, <<"FORM_TYPE">>, ?NS_ADDRESS)
|
|
| List_limits_xmpp]}
|
|
end.
|
|
|
|
sender_type(From) ->
|
|
Local_hosts = ejabberd_config:get_myhosts(),
|
|
case lists:member(From#jid.lserver, Local_hosts) of
|
|
true -> local;
|
|
false -> remote
|
|
end.
|
|
|
|
iq_disco_info_extras2(SenderT, SLimits) ->
|
|
Limits = get_slimit_group(SenderT, SLimits),
|
|
Stanza_types = [message, presence],
|
|
lists:foldl(fun (Type_of_stanza, R) ->
|
|
case get_limit_number(Type_of_stanza, Limits) of
|
|
{custom, Number} ->
|
|
[?RFIELDV((to_binary(Type_of_stanza)),
|
|
(to_binary(Number)))
|
|
| R];
|
|
{default, _} -> R
|
|
end
|
|
end,
|
|
[], Stanza_types).
|
|
|
|
to_binary(A) -> list_to_binary(hd(io_lib:format("~p", [A]))).
|
|
|
|
%%%-------------------------
|
|
%%% Error report
|
|
%%%-------------------------
|
|
|
|
route_error(Packet, ErrType, ErrText) ->
|
|
Lang = xmpp:get_lang(Packet),
|
|
Err = make_reply(ErrType, Lang, ErrText),
|
|
ejabberd_router:route_error(Packet, Err).
|
|
|
|
make_reply(bad_request, Lang, ErrText) ->
|
|
xmpp:err_bad_request(ErrText, Lang);
|
|
make_reply(jid_malformed, Lang, ErrText) ->
|
|
xmpp:err_jid_malformed(ErrText, Lang);
|
|
make_reply(not_acceptable, Lang, ErrText) ->
|
|
xmpp:err_not_acceptable(ErrText, Lang);
|
|
make_reply(internal_server_error, Lang, ErrText) ->
|
|
xmpp:err_internal_server_error(ErrText, Lang);
|
|
make_reply(forbidden, Lang, ErrText) ->
|
|
xmpp:err_forbidden(ErrText, Lang).
|
|
|
|
stj(String) -> jid:decode(String).
|
|
|
|
jts(String) -> jid:encode(String).
|
|
|
|
depends(_Host, _Opts) ->
|
|
[].
|
|
|
|
mod_opt_type(access) ->
|
|
fun acl:access_rules_validator/1;
|
|
mod_opt_type(host) -> fun iolist_to_binary/1;
|
|
mod_opt_type(hosts) ->
|
|
fun(L) -> lists:map(fun iolist_to_binary/1, L) end;
|
|
mod_opt_type(name) -> fun iolist_to_binary/1;
|
|
mod_opt_type({limits, Type}) when (Type == local) or (Type == remote) ->
|
|
fun(L) ->
|
|
lists:map(
|
|
fun ({message, infinite} = O) -> O;
|
|
({presence, infinite} = O) -> O;
|
|
({message, I} = O) when is_integer(I) -> O;
|
|
({presence, I} = O) when is_integer(I) -> O
|
|
end, L)
|
|
end.
|
|
|
|
mod_options(_Host) ->
|
|
[{access, all},
|
|
{host, <<"multicast.@HOST@">>},
|
|
{hosts, []},
|
|
{limits, [{local, []}, {remote, []}]},
|
|
{name, ?T("Multicast")}].
|