processone / ejabberd / 341

Build # 341

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/processone/ejabberd/commit/<a class=hub.com/processone/ejabberd/commit/<a class="double-link" href="https://git"><a class=hub.com/processone/ejabberd/commit/<a class="double-link" href="https://git"><a class=hub.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc2295600a42f">926ac3abf<a href="https://github.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc2295600a42f">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/processone/ejabberd/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/processone/ejabberd/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc2295600a42f&quot;&gt;926ac3abf&lt;/a&gt;&lt;a href=&quot;https://github.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc2295600a42f&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc229&lt;/a&gt;5600a42f">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/processone/ejabberd/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/processone/ejabberd/commit/<a class="double-link" href="https://github.com/processone/ejabberd/commit/6e18a9cb5e0d3c71bf4f73f03a99fd8fd432751a">6e18a9cb5</a><a href="https://github.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc2295600a42f">&amp;quot;&amp;gt;6e18a9cb5&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;6e18a9cb5&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/processone/ejabberd/commit/926ac3abf85a03347a7fd008d2fcc2295600a&lt;/a&gt;42f&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/processone/ejabberd/commit/<a class="double-link" href="https://github.com/processone/ejabberd/commit/43f36205b">43f36205b">43f36205b</a>

Pull Request Pull Request #3846: mod_mix_pam: Provide MIX channels as roster entries via hook

Run Details

43 of 43 new or added lines in 2 files covered. (100.0%)

13432 of 40000 relevant lines covered (33.58%)

680.57 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/mod_mix_pam.erl

%%%-------------------------------------------------------------------
%%% Author  : Evgeny Khramtsov <ekhramtsov@process-one.net>
%%% Created :  4 Dec 2018 by Evgeny Khramtsov <ekhramtsov@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_mix_pam).
-behaviour(gen_mod).
-protocol({xep, 405, '0.3.0'}).

%% gen_mod callbacks
-export([start/2, stop/1, reload/3, depends/2, mod_opt_type/1, mod_options/1]).
-export([mod_doc/0]).
%% Hooks and handlers
-export([bounce_sm_packet/1,
         disco_sm_features/5,
         remove_user/2,
         process_iq/1,
         get_mix_roster_items/2,
         webadmin_user/4,
         webadmin_page/3]).

-include_lib("xmpp/include/xmpp.hrl").
-include("logger.hrl").
-include("mod_roster.hrl").
-include("translate.hrl").
-include("ejabberd_http.hrl").
-include("ejabberd_web_admin.hrl").

-define(MIX_PAM_CACHE, mix_pam_cache).

-callback init(binary(), gen_mod:opts()) -> ok | {error, db_failure}.
-callback add_channel(jid(), jid(), binary()) -> ok | {error, db_failure}.
-callback del_channel(jid(), jid()) -> ok | {error, db_failure}.
-callback get_channel(jid(), jid()) -> {ok, binary()} | {error, notfound | db_failure}.
-callback get_channels(jid()) -> {ok, [{jid(), binary()}]} | {error, db_failure}.
-callback del_channels(jid()) -> ok | {error, db_failure}.
-callback use_cache(binary()) -> boolean().
-callback cache_nodes(binary()) -> [node()].

-optional_callbacks([use_cache/1, cache_nodes/1]).

%%%===================================================================
%%% API
%%%===================================================================
start(Host, Opts) ->
    Mod = gen_mod:db_mod(Opts, ?MODULE),
    case Mod:init(Host, Opts) of
        ok ->
            init_cache(Mod, Host, Opts),
            ejabberd_hooks:add(bounce_sm_packet, Host, ?MODULE, bounce_sm_packet, 50),
            ejabberd_hooks:add(disco_sm_features, Host, ?MODULE, disco_sm_features, 50),
            ejabberd_hooks:add(remove_user, Host, ?MODULE, remove_user, 50),
            ejabberd_hooks:add(roster_get, Host, ?MODULE, get_mix_roster_items, 50),
            ejabberd_hooks:add(webadmin_user, Host, ?MODULE, webadmin_user, 50),
            ejabberd_hooks:add(webadmin_page_host, Host, ?MODULE, webadmin_page, 50),
            gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_MIX_PAM_0,
                                          ?MODULE, process_iq);
        Err ->
            Err
    end.

stop(Host) ->
    ejabberd_hooks:delete(bounce_sm_packet, Host, ?MODULE, bounce_sm_packet, 50),
    ejabberd_hooks:delete(disco_sm_features, Host, ?MODULE, disco_sm_features, 50),
    ejabberd_hooks:delete(remove_user, Host, ?MODULE, remove_user, 50),
    ejabberd_hooks:delete(roster_get, Host, ?MODULE, get_mix_roster_items, 50),
    ejabberd_hooks:delete(webadmin_user, Host, ?MODULE, webadmin_user, 50),
    ejabberd_hooks:delete(webadmin_page_host, Host, ?MODULE, webadmin_page, 50),
    gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_MIX_PAM_0).

reload(Host, NewOpts, OldOpts) ->
    NewMod = gen_mod:db_mod(NewOpts, ?MODULE),
    OldMod = gen_mod:db_mod(OldOpts, ?MODULE),
    if NewMod /= OldMod ->
            NewMod:init(Host, NewOpts);
       true ->
            ok
    end,
    init_cache(NewMod, Host, NewOpts).

depends(_Host, _Opts) ->
    [].

mod_opt_type(db_type) ->
    econf:db_type(?MODULE);
mod_opt_type(use_cache) ->
    econf:bool();
mod_opt_type(cache_size) ->
    econf:pos_int(infinity);
mod_opt_type(cache_missed) ->
    econf:bool();
mod_opt_type(cache_life_time) ->
    econf:timeout(second, infinity).

mod_options(Host) ->
    [{db_type, ejabberd_config:default_db(Host, ?MODULE)},
     {use_cache, ejabberd_option:use_cache(Host)},
     {cache_size, ejabberd_option:cache_size(Host)},
     {cache_missed, ejabberd_option:cache_missed(Host)},
     {cache_life_time, ejabberd_option:cache_life_time(Host)}].

mod_doc() ->
    #{desc =>
          [?T("This module implements "
              "https://xmpp.org/extensions/xep-0405.html"
              "[XEP-0405: Mediated Information eXchange (MIX): "
              "Participant Server Requirements]. "
              "The module is needed if MIX compatible clients "
              "on your server are going to join MIX channels "
              "(either on your server or on any remote servers)."), "",
           ?T("NOTE: 'mod_mix' is not required for this module "
              "to work, however, without 'mod_mix_pam' the MIX "
              "functionality of your local XMPP clients will be impaired.")],
      opts =>
          [{db_type,
            #{value => "mnesia | sql",
              desc =>
                  ?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
           {use_cache,
            #{value => "true | false",
              desc =>
                  ?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
           {cache_size,
            #{value => "pos_integer() | infinity",
              desc =>
                  ?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
           {cache_missed,
            #{value => "true | false",
              desc =>
                  ?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
           {cache_life_time,
            #{value => "timeout()",
              desc =>
                  ?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.

-spec bounce_sm_packet({term(), stanza()}) -> {term(), stanza()}.
bounce_sm_packet({_, #message{to = #jid{lresource = <<>>} = To,
                              from = From,
                              type = groupchat} = Msg} = Acc) ->
    case xmpp:has_subtag(Msg, #mix{}) of
        true ->
            {LUser, LServer, _} = jid:tolower(To),
            case get_channel(To, From) of
                {ok, _} ->
                    lists:foreach(
                      fun(R) ->
                              To1 = jid:replace_resource(To, R),
                              ejabberd_router:route(xmpp:set_to(Msg, To1))
                      end, ejabberd_sm:get_user_resources(LUser, LServer)),
                    {pass, Msg};
                _ ->
                    Acc
            end;
        false ->
            Acc
    end;
bounce_sm_packet(Acc) ->
    Acc.

-spec disco_sm_features({error, stanza_error()} | empty | {result, [binary()]},
                        jid(), jid(), binary(), binary()) ->
                               {error, stanza_error()} | empty | {result, [binary()]}.
disco_sm_features({error, _Error} = Acc, _From, _To, _Node, _Lang) ->
    Acc;
disco_sm_features(Acc, _From, _To, <<"">>, _Lang) ->
    {result, [?NS_MIX_PAM_0 |
              case Acc of
                  {result, Features} -> Features;
                  empty -> []
              end]};
disco_sm_features(Acc, _From, _To, _Node, _Lang) ->
    Acc.

-spec process_iq(iq()) -> iq() | ignore.
process_iq(#iq{from = #jid{luser = U1, lserver = S1},
               to = #jid{luser = U2, lserver = S2}} = IQ)
  when {U1, S1} /= {U2, S2} ->
    xmpp:make_error(IQ, forbidden_query_error(IQ));
process_iq(#iq{type = set,
               sub_els = [#mix_client_join{} = Join]} = IQ) ->
    case Join#mix_client_join.channel of
        undefined ->
            xmpp:make_error(IQ, missing_channel_error(IQ));
        _ ->
            process_join(IQ)
    end;
process_iq(#iq{type = set,
               sub_els = [#mix_client_leave{} = Leave]} = IQ) ->
    case Leave#mix_client_leave.channel of
        undefined ->
            xmpp:make_error(IQ, missing_channel_error(IQ));
        _ ->
            process_leave(IQ)
    end;
process_iq(IQ) ->
    xmpp:make_error(IQ, unsupported_query_error(IQ)).

-spec get_mix_roster_items([#roster{}], {binary(), binary()}) -> [#roster{}].
get_mix_roster_items(Acc, {LUser, LServer}) ->
    JID = jid:make(LUser, LServer),
    case get_channels(JID) of
        {ok, Channels} ->
            lists:map(
                fun({#jid{luser=Channel, lserver=Service}, Id}) ->
                    #roster{
                        jid = {Channel, Service, <<>>},
                        name = <<>>,
                        subscription = both,
                        ask = none,
                        groups = [<<"Channels">>],
                        askmessage = <<>>,
                        xs = [],
                        mix_participant_id = Id
                    }
                end, Channels);
        _ ->
            []
    end ++ Acc.

-spec remove_user(binary(), binary()) -> ok | {error, db_failure}.
remove_user(LUser, LServer) ->
    Mod = gen_mod:db_mod(LServer, ?MODULE),
    JID = jid:make(LUser, LServer),
    Chans = case Mod:get_channels(JID) of
                {ok, Channels} ->
                    lists:map(
                      fun({Channel, _}) ->
                              ejabberd_router:route(
                                #iq{from = JID,
                                    to = Channel,
                                    id = p1_rand:get_string(),
                                    type = set,
                                    sub_els = [#mix_leave{}]}),
                              Channel
                      end, Channels);
                _ ->
                    []
            end,
    Mod:del_channels(jid:make(LUser, LServer)),
    lists:foreach(
      fun(Chan) ->
              delete_cache(Mod, JID, Chan)
      end, Chans).

%%%===================================================================
%%% Internal functions
%%%===================================================================
-spec process_join(iq()) -> ignore.
process_join(#iq{from = From,
                 sub_els = [#mix_client_join{channel = Channel,
                                             join = Join}]} = IQ) ->
    ejabberd_router:route_iq(
      #iq{from = jid:remove_resource(From),
          to = Channel, type = set, sub_els = [Join]},
      fun(ResIQ) -> process_join_result(ResIQ, IQ) end),
    ignore.

-spec process_leave(iq()) -> iq() | error.
process_leave(#iq{from = From,
                  sub_els = [#mix_client_leave{channel = Channel,
                                               leave = Leave}]} = IQ) ->
    case del_channel(From, Channel) of
        ok ->
            ejabberd_router:route_iq(
              #iq{from = jid:remove_resource(From),
                  to = Channel, type = set, sub_els = [Leave]},
              fun(ResIQ) -> process_leave_result(ResIQ, IQ) end),
            ignore;
        {error, db_failure} ->
            xmpp:make_error(IQ, db_error(IQ))
    end.

-spec process_join_result(iq(), iq()) -> ok.
process_join_result(#iq{from = Channel,
                        type = result, sub_els = [#mix_join{id = ID} = Join]},
                    #iq{to = To} = IQ) ->
    case add_channel(To, Channel, ID) of
        ok ->
            % Do roster push
            #jid{luser = ChannelName, lserver = Service} = Channel,
            mod_roster:push_item(To, #roster{}, #roster{
                jid = {ChannelName, Service, <<>>},
                name = <<>>,
                subscription = none,
                ask = none,
                groups = [],
                askmessage = <<>>,
                mix_participant_id = ID
            }),
            % send IQ result
            ChanID = make_channel_id(Channel, ID),
            Join1 = Join#mix_join{id = <<"">>, jid = ChanID},
            ResIQ = xmpp:make_iq_result(IQ, #mix_client_join{join = Join1}),
            ejabberd_router:route(ResIQ);
        {error, db_failure} ->
            ejabberd_router:route_error(IQ, db_error(IQ))
    end;
process_join_result(Err, IQ) ->
    process_iq_error(Err, IQ).

-spec process_leave_result(iq(), iq()) -> ok.
process_leave_result(#iq{from = Channel, type = result, sub_els = [#mix_leave{} = Leave]},
                     #iq{to = User} = IQ) ->
    % Do roster push
    #jid{luser = ChannelName, lserver = Service} = Channel,
    mod_roster:push_item(User,
        #roster{jid = {ChannelName, Service, <<>>}, subscription = none},
        #roster{jid = {ChannelName, Service, <<>>},
                subscription = remove}),
    % send iq result
    ResIQ = xmpp:make_iq_result(IQ, #mix_client_leave{leave = Leave}),
    ejabberd_router:route(ResIQ);
process_leave_result(Err, IQ) ->
    process_iq_error(Err, IQ).

-spec process_iq_error(iq(), iq()) -> ok.
process_iq_error(#iq{type = error} = ErrIQ, #iq{sub_els = [El]} = IQ) ->
    case xmpp:get_error(ErrIQ) of
        undefined ->
            %% Not sure if this stuff is correct because
            %% RFC6120 section 8.3.1 bullet 4 states that
            %% an error stanza MUST contain an <error/> child element
            IQ1 = xmpp:make_iq_result(IQ, El),
            ejabberd_router:route(IQ1#iq{type = error});
        Err ->
            ejabberd_router:route_error(IQ, Err)
    end;
process_iq_error(timeout, IQ) ->
    Txt = ?T("Request has timed out"),
    Err = xmpp:err_recipient_unavailable(Txt, IQ#iq.lang),
    ejabberd_router:route_error(IQ, Err).

-spec make_channel_id(jid(), binary()) -> jid().
make_channel_id(JID, ID) ->
    {U, S, R} = jid:split(JID),
    jid:make(<<ID/binary, $#, U/binary>>, S, R).

%%%===================================================================
%%% Error generators
%%%===================================================================
-spec missing_channel_error(stanza()) -> stanza_error().
missing_channel_error(Pkt) ->
    Txt = ?T("Attribute 'channel' is required for this request"),
    xmpp:err_bad_request(Txt, xmpp:get_lang(Pkt)).

-spec forbidden_query_error(stanza()) -> stanza_error().
forbidden_query_error(Pkt) ->
    Txt = ?T("Query to another users is forbidden"),
    xmpp:err_forbidden(Txt, xmpp:get_lang(Pkt)).

-spec unsupported_query_error(stanza()) -> stanza_error().
unsupported_query_error(Pkt) ->
    Txt = ?T("No module is handling this query"),
    xmpp:err_service_unavailable(Txt, xmpp:get_lang(Pkt)).

-spec db_error(stanza()) -> stanza_error().
db_error(Pkt) ->
    Txt = ?T("Database failure"),
    xmpp:err_internal_server_error(Txt, xmpp:get_lang(Pkt)).

%%%===================================================================
%%% Database queries
%%%===================================================================
get_channel(JID, Channel) ->
    {LUser, LServer, _} = jid:tolower(JID),
    {Chan, Service, _} = jid:tolower(Channel),
    Mod = gen_mod:db_mod(LServer, ?MODULE),
    case use_cache(Mod, LServer) of
        false -> Mod:get_channel(JID, Channel);
        true ->
            case ets_cache:lookup(
                   ?MIX_PAM_CACHE, {LUser, LServer, Chan, Service},
                   fun() -> Mod:get_channel(JID, Channel) end) of
                error -> {error, notfound};
                Ret -> Ret
            end
    end.

get_channels(JID) ->
    {_, LServer, _} = jid:tolower(JID),
    Mod = gen_mod:db_mod(LServer, ?MODULE),
    Mod:get_channels(JID).

add_channel(JID, Channel, ID) ->
    Mod = gen_mod:db_mod(JID#jid.lserver, ?MODULE),
    case Mod:add_channel(JID, Channel, ID) of
        ok -> delete_cache(Mod, JID, Channel);
        Err -> Err
    end.

del_channel(JID, Channel) ->
    Mod = gen_mod:db_mod(JID#jid.lserver, ?MODULE),
    case Mod:del_channel(JID, Channel) of
        ok -> delete_cache(Mod, JID, Channel);
        Err -> Err
    end.

%%%===================================================================
%%% Cache management
%%%===================================================================
-spec init_cache(module(), binary(), gen_mod:opts()) -> ok.
init_cache(Mod, Host, Opts) ->
    case use_cache(Mod, Host) of
        true ->
            CacheOpts = cache_opts(Opts),
            ets_cache:new(?MIX_PAM_CACHE, CacheOpts);
        false ->
            ets_cache:delete(?MIX_PAM_CACHE)
    end.

-spec cache_opts(gen_mod:opts()) -> [proplists:property()].
cache_opts(Opts) ->
    MaxSize = mod_mix_pam_opt:cache_size(Opts),
    CacheMissed = mod_mix_pam_opt:cache_missed(Opts),
    LifeTime = mod_mix_pam_opt:cache_life_time(Opts),
    [{max_size, MaxSize}, {cache_missed, CacheMissed}, {life_time, LifeTime}].

-spec use_cache(module(), binary()) -> boolean().
use_cache(Mod, Host) ->
    case erlang:function_exported(Mod, use_cache, 1) of
        true -> Mod:use_cache(Host);
        false -> mod_mix_pam_opt:use_cache(Host)
    end.

-spec cache_nodes(module(), binary()) -> [node()].
cache_nodes(Mod, Host) ->
    case erlang:function_exported(Mod, cache_nodes, 1) of
        true -> Mod:cache_nodes(Host);
        false -> ejabberd_cluster:get_nodes()
    end.

-spec delete_cache(module(), jid(), jid()) -> ok.
delete_cache(Mod, JID, Channel) ->
    {LUser, LServer, _} = jid:tolower(JID),
    {Chan, Service, _} = jid:tolower(Channel),
    case use_cache(Mod, LServer) of
        true ->
            ets_cache:delete(?MIX_PAM_CACHE,
                             {LUser, LServer, Chan, Service},
                             cache_nodes(Mod, LServer));
        false ->
            ok
    end.

%%%===================================================================
%%% Webadmin interface
%%%===================================================================
webadmin_user(Acc, User, Server, Lang) ->
    QueueLen = case get_channels({jid:nodeprep(User), jid:nameprep(Server), <<>>}) of
        {ok, Channels} -> length(Channels);
        error -> -1
    end,
    FQueueLen = ?C(integer_to_binary(QueueLen)),
    FQueueView = ?AC(<<"mix_channels/">>, ?T("View joined MIX channels")),
    Acc ++
        [?XCT(<<"h3">>, ?T("Joined MIX channels:")),
         FQueueLen,
         ?C(<<"  |   ">>),
         FQueueView].

webadmin_page(_, Host,
              #request{us = _US, path = [<<"user">>, U, <<"mix_channels">>],
                       lang = Lang} = _Request) ->
    Res = web_mix_channels(U, Host, Lang),
    {stop, Res};
webadmin_page(Acc, _, _) -> Acc.

web_mix_channels(User, Server, Lang) ->
    LUser = jid:nodeprep(User),
    LServer = jid:nameprep(Server),
    US = {LUser, LServer},
    Items = case get_channels({jid:nodeprep(User), jid:nameprep(Server), <<>>}) of
        {ok, Channels} -> Channels;
        error -> []
    end,
    SItems = lists:sort(Items),
    FItems = case SItems of
        [] -> [?CT(?T("None"))];
        _ ->
            THead = ?XE(<<"thead">>, [?XE(<<"tr">>, [?XCT(<<"td">>, ?T("Channel JID")),
                                                     ?XCT(<<"td">>, ?T("Participant ID"))])]),
            Entries = lists:map(fun ({JID, ID}) ->
                                    ?XE(<<"tr">>, [
                                        ?XAC(<<"td">>, [{<<"class">>, <<"valign">>}], jid:encode(JID)),
                                        ?XAC(<<"td">>, [{<<"class">>, <<"valign">>}], ID)
                                    ])
                                end, SItems),
            [?XE(<<"table">>, [THead, ?XE(<<"tbody">>, Entries)])]
    end,
    PageTitle = str:translate_and_format(Lang, ?T("Joined MIX channels of ~ts"), [us_to_list(US)]),
    (?H1GL(PageTitle, <<"modules/#mod-mix-pam">>, <<"mod_mix_pam">>))
        ++ FItems.

us_to_list({User, Server}) ->
    jid:encode({User, Server, <<"">>}).

1	%%%-------------------------------------------------------------------
2	%%% Author : Evgeny Khramtsov <ekhramtsov@process-one.net>
3	%%% Created : 4 Dec 2018 by Evgeny Khramtsov <ekhramtsov@process-one.net>
4	%%%
5	%%%
6	%%% ejabberd, Copyright (C) 2002-2018 ProcessOne
7	%%%
8	%%% This program is free software; you can redistribute it and/or
9	%%% modify it under the terms of the GNU General Public License as
10	%%% published by the Free Software Foundation; either version 2 of the
11	%%% License, or (at your option) any later version.
12	%%%
13	%%% This program is distributed in the hope that it will be useful,
14	%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
15	%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16	%%% General Public License for more details.
17	%%%
18	%%% You should have received a copy of the GNU General Public License along
19	%%% with this program; if not, write to the Free Software Foundation, Inc.,
20	%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21	%%%
22	%%%----------------------------------------------------------------------
23	-module(mod_mix_pam).
24	-behaviour(gen_mod).
25	-protocol({xep, 405, '0.3.0'}).
26
27	%% gen_mod callbacks
28	-export([start/2, stop/1, reload/3, depends/2, mod_opt_type/1, mod_options/1]).
29	-export([mod_doc/0]).
30	%% Hooks and handlers
31	-export([bounce_sm_packet/1,
32	disco_sm_features/5,
33	remove_user/2,
34	process_iq/1,
35	get_mix_roster_items/2,
36	webadmin_user/4,
37	webadmin_page/3]).
38
39	-include_lib("xmpp/include/xmpp.hrl").
40	-include("logger.hrl").
41	-include("mod_roster.hrl").
42	-include("translate.hrl").
43	-include("ejabberd_http.hrl").
44	-include("ejabberd_web_admin.hrl").
45
46	-define(MIX_PAM_CACHE, mix_pam_cache).
47
48	-callback init(binary(), gen_mod:opts()) -> ok \| {error, db_failure}.
49	-callback add_channel(jid(), jid(), binary()) -> ok \| {error, db_failure}.
50	-callback del_channel(jid(), jid()) -> ok \| {error, db_failure}.
51	-callback get_channel(jid(), jid()) -> {ok, binary()} \| {error, notfound \| db_failure}.
52	-callback get_channels(jid()) -> {ok, [{jid(), binary()}]} \| {error, db_failure}.
53	-callback del_channels(jid()) -> ok \| {error, db_failure}.
54	-callback use_cache(binary()) -> boolean().
55	-callback cache_nodes(binary()) -> [node()].
56
57	-optional_callbacks([use_cache/1, cache_nodes/1]).
58
59	%%%===================================================================
60	%%% API
61	%%%===================================================================
62	start(Host, Opts) ->
63	Mod = gen_mod:db_mod(Opts, ?MODULE),	×
64	case Mod:init(Host, Opts) of	×
65	ok ->
66	init_cache(Mod, Host, Opts),	×
67	ejabberd_hooks:add(bounce_sm_packet, Host, ?MODULE, bounce_sm_packet, 50),	×
68	ejabberd_hooks:add(disco_sm_features, Host, ?MODULE, disco_sm_features, 50),	×
69	ejabberd_hooks:add(remove_user, Host, ?MODULE, remove_user, 50),	×
70	ejabberd_hooks:add(roster_get, Host, ?MODULE, get_mix_roster_items, 50),	×
71	ejabberd_hooks:add(webadmin_user, Host, ?MODULE, webadmin_user, 50),	×
72	ejabberd_hooks:add(webadmin_page_host, Host, ?MODULE, webadmin_page, 50),	×
73	gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_MIX_PAM_0,	×
74	?MODULE, process_iq);
75	Err ->
76	Err	×
77	end.
78
79	stop(Host) ->
80	ejabberd_hooks:delete(bounce_sm_packet, Host, ?MODULE, bounce_sm_packet, 50),	×
81	ejabberd_hooks:delete(disco_sm_features, Host, ?MODULE, disco_sm_features, 50),	×
82	ejabberd_hooks:delete(remove_user, Host, ?MODULE, remove_user, 50),	×
83	ejabberd_hooks:delete(roster_get, Host, ?MODULE, get_mix_roster_items, 50),	×
84	ejabberd_hooks:delete(webadmin_user, Host, ?MODULE, webadmin_user, 50),	×
85	ejabberd_hooks:delete(webadmin_page_host, Host, ?MODULE, webadmin_page, 50),	×
86	gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_MIX_PAM_0).	×
87
88	reload(Host, NewOpts, OldOpts) ->
89	NewMod = gen_mod:db_mod(NewOpts, ?MODULE),	×
90	OldMod = gen_mod:db_mod(OldOpts, ?MODULE),	×
91	if NewMod /= OldMod ->	×
92	NewMod:init(Host, NewOpts);	×
93	true ->
94	ok	×
95	end,
96	init_cache(NewMod, Host, NewOpts).	×
97
98	depends(_Host, _Opts) ->
99	[].	×
100
101	mod_opt_type(db_type) ->
102	econf:db_type(?MODULE);	×
103	mod_opt_type(use_cache) ->
104	econf:bool();	×
105	mod_opt_type(cache_size) ->
106	econf:pos_int(infinity);	×
107	mod_opt_type(cache_missed) ->
108	econf:bool();	×
109	mod_opt_type(cache_life_time) ->
110	econf:timeout(second, infinity).	×
111
112	mod_options(Host) ->
113	[{db_type, ejabberd_config:default_db(Host, ?MODULE)},	×
114	{use_cache, ejabberd_option:use_cache(Host)},
115	{cache_size, ejabberd_option:cache_size(Host)},
116	{cache_missed, ejabberd_option:cache_missed(Host)},
117	{cache_life_time, ejabberd_option:cache_life_time(Host)}].
118
119	mod_doc() ->
120	#{desc =>	×
121	[?T("This module implements "
122	"https://xmpp.org/extensions/xep-0405.html"
123	"[XEP-0405: Mediated Information eXchange (MIX): "
124	"Participant Server Requirements]. "
125	"The module is needed if MIX compatible clients "
126	"on your server are going to join MIX channels "
127	"(either on your server or on any remote servers)."), "",
128	?T("NOTE: 'mod_mix' is not required for this module "
129	"to work, however, without 'mod_mix_pam' the MIX "
130	"functionality of your local XMPP clients will be impaired.")],
131	opts =>
132	[{db_type,
133	#{value => "mnesia \| sql",
134	desc =>
135	?T("Same as top-level _`default_db`_ option, but applied to this module only.")}},
136	{use_cache,
137	#{value => "true \| false",
138	desc =>
139	?T("Same as top-level _`use_cache`_ option, but applied to this module only.")}},
140	{cache_size,
141	#{value => "pos_integer() \| infinity",
142	desc =>
143	?T("Same as top-level _`cache_size`_ option, but applied to this module only.")}},
144	{cache_missed,
145	#{value => "true \| false",
146	desc =>
147	?T("Same as top-level _`cache_missed`_ option, but applied to this module only.")}},
148	{cache_life_time,
149	#{value => "timeout()",
150	desc =>
151	?T("Same as top-level _`cache_life_time`_ option, but applied to this module only.")}}]}.
152
153	-spec bounce_sm_packet({term(), stanza()}) -> {term(), stanza()}.
154	bounce_sm_packet({_, #message{to = #jid{lresource = <<>>} = To,
155	from = From,
156	type = groupchat} = Msg} = Acc) ->
157	case xmpp:has_subtag(Msg, #mix{}) of	×
158	true ->
159	{LUser, LServer, _} = jid:tolower(To),	×
160	case get_channel(To, From) of	×
161	{ok, _} ->
162	lists:foreach(	×
163	fun(R) ->
164	To1 = jid:replace_resource(To, R),	×
165	ejabberd_router:route(xmpp:set_to(Msg, To1))	×
166	end, ejabberd_sm:get_user_resources(LUser, LServer)),
167	{pass, Msg};	×
168	_ ->
169	Acc	×
170	end;
171	false ->
172	Acc	×
173	end;
174	bounce_sm_packet(Acc) ->
175	Acc.	×
176
177	-spec disco_sm_features({error, stanza_error()} \| empty \| {result, [binary()]},
178	jid(), jid(), binary(), binary()) ->
179	{error, stanza_error()} \| empty \| {result, [binary()]}.
180	disco_sm_features({error, _Error} = Acc, _From, _To, _Node, _Lang) ->
181	Acc;	×
182	disco_sm_features(Acc, _From, _To, <<"">>, _Lang) ->
183	{result, [?NS_MIX_PAM_0 \|	×
184	case Acc of
185	{result, Features} -> Features;	×
186	empty -> []	×
187	end]};
188	disco_sm_features(Acc, _From, _To, _Node, _Lang) ->
189	Acc.	×
190
191	-spec process_iq(iq()) -> iq() \| ignore.
192	process_iq(#iq{from = #jid{luser = U1, lserver = S1},
193	to = #jid{luser = U2, lserver = S2}} = IQ)
194	when {U1, S1} /= {U2, S2} ->
195	xmpp:make_error(IQ, forbidden_query_error(IQ));	×
196	process_iq(#iq{type = set,
197	sub_els = [#mix_client_join{} = Join]} = IQ) ->
198	case Join#mix_client_join.channel of	×
199	undefined ->
200	xmpp:make_error(IQ, missing_channel_error(IQ));	×
201	_ ->
202	process_join(IQ)	×
203	end;
204	process_iq(#iq{type = set,
205	sub_els = [#mix_client_leave{} = Leave]} = IQ) ->
206	case Leave#mix_client_leave.channel of	×
207	undefined ->
208	xmpp:make_error(IQ, missing_channel_error(IQ));	×
209	_ ->
210	process_leave(IQ)	×
211	end;
212	process_iq(IQ) ->
213	xmpp:make_error(IQ, unsupported_query_error(IQ)).	×
214
215	-spec get_mix_roster_items([#roster{}], {binary(), binary()}) -> [#roster{}].
216	get_mix_roster_items(Acc, {LUser, LServer}) ->
217	JID = jid:make(LUser, LServer),	×
218	case get_channels(JID) of
219	{ok, Channels} ->
220	lists:map(	×
221	fun({#jid{luser=Channel, lserver=Service}, Id}) ->
222	#roster{	×
223	jid = {Channel, Service, <<>>},
224	name = <<>>,
225	subscription = both,
226	ask = none,
227	groups = [<<"Channels">>],
228	askmessage = <<>>,
229	xs = [],
230	mix_participant_id = Id
231	}
232	end, Channels);
233	_ ->
234	[]	×
235	end ++ Acc.	×
236
237	-spec remove_user(binary(), binary()) -> ok \| {error, db_failure}.
238	remove_user(LUser, LServer) ->
239	Mod = gen_mod:db_mod(LServer, ?MODULE),	×
240	JID = jid:make(LUser, LServer),	×
241	Chans = case Mod:get_channels(JID) of	×
242	{ok, Channels} ->
243	lists:map(	×
244	fun({Channel, _}) ->
245	ejabberd_router:route(	×
246	#iq{from = JID,
247	to = Channel,
248	id = p1_rand:get_string(),
249	type = set,
250	sub_els = [#mix_leave{}]}),
251	Channel	×
252	end, Channels);
253	_ ->
254	[]	×
255	end,
256	Mod:del_channels(jid:make(LUser, LServer)),	×
257	lists:foreach(	×
258	fun(Chan) ->
259	delete_cache(Mod, JID, Chan)	×
260	end, Chans).
261
262	%%%===================================================================
263	%%% Internal functions
264	%%%===================================================================
265	-spec process_join(iq()) -> ignore.
266	process_join(#iq{from = From,
267	sub_els = [#mix_client_join{channel = Channel,
268	join = Join}]} = IQ) ->
269	ejabberd_router:route_iq(	×
270	#iq{from = jid:remove_resource(From),
271	to = Channel, type = set, sub_els = [Join]},
272	fun(ResIQ) -> process_join_result(ResIQ, IQ) end),	×
273	ignore.	×
274
275	-spec process_leave(iq()) -> iq() \| error.
276	process_leave(#iq{from = From,
277	sub_els = [#mix_client_leave{channel = Channel,
278	leave = Leave}]} = IQ) ->
279	case del_channel(From, Channel) of	×
280	ok ->
281	ejabberd_router:route_iq(	×
282	#iq{from = jid:remove_resource(From),
283	to = Channel, type = set, sub_els = [Leave]},
284	fun(ResIQ) -> process_leave_result(ResIQ, IQ) end),	×
285	ignore;	×
286	{error, db_failure} ->
287	xmpp:make_error(IQ, db_error(IQ))	×
288	end.
289
290	-spec process_join_result(iq(), iq()) -> ok.
291	process_join_result(#iq{from = Channel,
292	type = result, sub_els = [#mix_join{id = ID} = Join]},
293	#iq{to = To} = IQ) ->
294	case add_channel(To, Channel, ID) of	×
295	ok ->
296	% Do roster push
297	#jid{luser = ChannelName, lserver = Service} = Channel,	×
298	mod_roster:push_item(To, #roster{}, #roster{	×
299	jid = {ChannelName, Service, <<>>},
300	name = <<>>,
301	subscription = none,
302	ask = none,
303	groups = [],
304	askmessage = <<>>,
305	mix_participant_id = ID
306	}),
307	% send IQ result
308	ChanID = make_channel_id(Channel, ID),	×
309	Join1 = Join#mix_join{id = <<"">>, jid = ChanID},	×
310	ResIQ = xmpp:make_iq_result(IQ, #mix_client_join{join = Join1}),	×
311	ejabberd_router:route(ResIQ);	×
312	{error, db_failure} ->
313	ejabberd_router:route_error(IQ, db_error(IQ))	×
314	end;
315	process_join_result(Err, IQ) ->
316	process_iq_error(Err, IQ).	×
317
318	-spec process_leave_result(iq(), iq()) -> ok.
319	process_leave_result(#iq{from = Channel, type = result, sub_els = [#mix_leave{} = Leave]},
320	#iq{to = User} = IQ) ->
321	% Do roster push
322	#jid{luser = ChannelName, lserver = Service} = Channel,	×
323	mod_roster:push_item(User,	×
324	#roster{jid = {ChannelName, Service, <<>>}, subscription = none},
325	#roster{jid = {ChannelName, Service, <<>>},
326	subscription = remove}),
327	% send iq result
328	ResIQ = xmpp:make_iq_result(IQ, #mix_client_leave{leave = Leave}),	×
329	ejabberd_router:route(ResIQ);	×
330	process_leave_result(Err, IQ) ->
331	process_iq_error(Err, IQ).	×
332
333	-spec process_iq_error(iq(), iq()) -> ok.
334	process_iq_error(#iq{type = error} = ErrIQ, #iq{sub_els = [El]} = IQ) ->
335	case xmpp:get_error(ErrIQ) of	×
336	undefined ->
337	%% Not sure if this stuff is correct because
338	%% RFC6120 section 8.3.1 bullet 4 states that
339	%% an error stanza MUST contain an <error/> child element
340	IQ1 = xmpp:make_iq_result(IQ, El),	×
341	ejabberd_router:route(IQ1#iq{type = error});	×
342	Err ->
343	ejabberd_router:route_error(IQ, Err)	×
344	end;
345	process_iq_error(timeout, IQ) ->
346	Txt = ?T("Request has timed out"),	×
347	Err = xmpp:err_recipient_unavailable(Txt, IQ#iq.lang),	×
348	ejabberd_router:route_error(IQ, Err).	×
349
350	-spec make_channel_id(jid(), binary()) -> jid().
351	make_channel_id(JID, ID) ->
352	{U, S, R} = jid:split(JID),	×
353	jid:make(<<ID/binary, $#, U/binary>>, S, R).	×
354
355	%%%===================================================================
356	%%% Error generators
357	%%%===================================================================
358	-spec missing_channel_error(stanza()) -> stanza_error().
359	missing_channel_error(Pkt) ->
360	Txt = ?T("Attribute 'channel' is required for this request"),	×
361	xmpp:err_bad_request(Txt, xmpp:get_lang(Pkt)).	×
362
363	-spec forbidden_query_error(stanza()) -> stanza_error().
364	forbidden_query_error(Pkt) ->
365	Txt = ?T("Query to another users is forbidden"),	×
366	xmpp:err_forbidden(Txt, xmpp:get_lang(Pkt)).	×
367
368	-spec unsupported_query_error(stanza()) -> stanza_error().
369	unsupported_query_error(Pkt) ->
370	Txt = ?T("No module is handling this query"),	×
371	xmpp:err_service_unavailable(Txt, xmpp:get_lang(Pkt)).	×
372
373	-spec db_error(stanza()) -> stanza_error().
374	db_error(Pkt) ->
375	Txt = ?T("Database failure"),	×
376	xmpp:err_internal_server_error(Txt, xmpp:get_lang(Pkt)).	×
377
378	%%%===================================================================
379	%%% Database queries
380	%%%===================================================================
381	get_channel(JID, Channel) ->
382	{LUser, LServer, _} = jid:tolower(JID),	×
383	{Chan, Service, _} = jid:tolower(Channel),	×
384	Mod = gen_mod:db_mod(LServer, ?MODULE),	×
385	case use_cache(Mod, LServer) of	×
386	false -> Mod:get_channel(JID, Channel);	×
387	true ->
388	case ets_cache:lookup(	×
389	?MIX_PAM_CACHE, {LUser, LServer, Chan, Service},
390	fun() -> Mod:get_channel(JID, Channel) end) of	×
391	error -> {error, notfound};	×
392	Ret -> Ret	×
393	end
394	end.
395
396	get_channels(JID) ->
397	{_, LServer, _} = jid:tolower(JID),	×
398	Mod = gen_mod:db_mod(LServer, ?MODULE),	×
399	Mod:get_channels(JID).	×
400
401	add_channel(JID, Channel, ID) ->
402	Mod = gen_mod:db_mod(JID#jid.lserver, ?MODULE),	×
403	case Mod:add_channel(JID, Channel, ID) of	×
404	ok -> delete_cache(Mod, JID, Channel);	×
405	Err -> Err	×
406	end.
407
408	del_channel(JID, Channel) ->
409	Mod = gen_mod:db_mod(JID#jid.lserver, ?MODULE),	×
410	case Mod:del_channel(JID, Channel) of	×
411	ok -> delete_cache(Mod, JID, Channel);	×
412	Err -> Err	×
413	end.
414
415	%%%===================================================================
416	%%% Cache management
417	%%%===================================================================
418	-spec init_cache(module(), binary(), gen_mod:opts()) -> ok.
419	init_cache(Mod, Host, Opts) ->
420	case use_cache(Mod, Host) of	×
421	true ->
422	CacheOpts = cache_opts(Opts),	×
423	ets_cache:new(?MIX_PAM_CACHE, CacheOpts);	×
424	false ->
425	ets_cache:delete(?MIX_PAM_CACHE)	×
426	end.
427
428	-spec cache_opts(gen_mod:opts()) -> [proplists:property()].
429	cache_opts(Opts) ->
430	MaxSize = mod_mix_pam_opt:cache_size(Opts),	×
431	CacheMissed = mod_mix_pam_opt:cache_missed(Opts),	×
432	LifeTime = mod_mix_pam_opt:cache_life_time(Opts),	×
433	[{max_size, MaxSize}, {cache_missed, CacheMissed}, {life_time, LifeTime}].	×
434
435	-spec use_cache(module(), binary()) -> boolean().
436	use_cache(Mod, Host) ->
437	case erlang:function_exported(Mod, use_cache, 1) of	×
438	true -> Mod:use_cache(Host);	×
439	false -> mod_mix_pam_opt:use_cache(Host)	×
440	end.
441
442	-spec cache_nodes(module(), binary()) -> [node()].
443	cache_nodes(Mod, Host) ->
444	case erlang:function_exported(Mod, cache_nodes, 1) of	×
445	true -> Mod:cache_nodes(Host);	×
446	false -> ejabberd_cluster:get_nodes()	×
447	end.
448
449	-spec delete_cache(module(), jid(), jid()) -> ok.
450	delete_cache(Mod, JID, Channel) ->
451	{LUser, LServer, _} = jid:tolower(JID),	×
452	{Chan, Service, _} = jid:tolower(Channel),	×
453	case use_cache(Mod, LServer) of	×
454	true ->
455	ets_cache:delete(?MIX_PAM_CACHE,	×
456	{LUser, LServer, Chan, Service},
457	cache_nodes(Mod, LServer));
458	false ->
459	ok	×
460	end.
461
462	%%%===================================================================
463	%%% Webadmin interface
464	%%%===================================================================
465	webadmin_user(Acc, User, Server, Lang) ->
466	QueueLen = case get_channels({jid:nodeprep(User), jid:nameprep(Server), <<>>}) of	×
467	{ok, Channels} -> length(Channels);	×
468	error -> -1	×
469	end,
470	FQueueLen = ?C(integer_to_binary(QueueLen)),	×
471	FQueueView = ?AC(<<"mix_channels/">>, ?T("View joined MIX channels")),	×
472	Acc ++	×
473	[?XCT(<<"h3">>, ?T("Joined MIX channels:")),
474	FQueueLen,
475	?C(<<" \| ">>),
476	FQueueView].
477
478	webadmin_page(_, Host,
479	#request{us = _US, path = [<<"user">>, U, <<"mix_channels">>],
480	lang = Lang} = _Request) ->
481	Res = web_mix_channels(U, Host, Lang),	×
482	{stop, Res};	×
483	webadmin_page(Acc, _, _) -> Acc.	×
484
485	web_mix_channels(User, Server, Lang) ->
486	LUser = jid:nodeprep(User),	×
487	LServer = jid:nameprep(Server),	×
488	US = {LUser, LServer},	×
489	Items = case get_channels({jid:nodeprep(User), jid:nameprep(Server), <<>>}) of	×
490	{ok, Channels} -> Channels;	×
491	error -> []	×
492	end,
493	SItems = lists:sort(Items),	×
494	FItems = case SItems of	×
495	[] -> [?CT(?T("None"))];	×
496	_ ->
497	THead = ?XE(<<"thead">>, [?XE(<<"tr">>, [?XCT(<<"td">>, ?T("Channel JID")),	×
498	?XCT(<<"td">>, ?T("Participant ID"))])]),
499	Entries = lists:map(fun ({JID, ID}) ->	×
500	?XE(<<"tr">>, [	×
501	?XAC(<<"td">>, [{<<"class">>, <<"valign">>}], jid:encode(JID)),
502	?XAC(<<"td">>, [{<<"class">>, <<"valign">>}], ID)
503	])
504	end, SItems),
505	[?XE(<<"table">>, [THead, ?XE(<<"tbody">>, Entries)])]	×
506	end,
507	PageTitle = str:translate_and_format(Lang, ?T("Joined MIX channels of ~ts"), [us_to_list(US)]),	×
508	(?H1GL(PageTitle, <<"modules/#mod-mix-pam">>, <<"mod_mix_pam">>))
509	++ FItems.	×
510
511	us_to_list({User, Server}) ->
512	jid:encode({User, Server, <<"">>}).	×

processone / ejabberd / 341

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous