From 1bd43bbd2d475520a8a015453a581eade0bfc132 Mon Sep 17 00:00:00 2001 From: Evgeniy Khramtsov Date: Mon, 30 Aug 2010 14:02:47 +1000 Subject: [PATCH 01/34] implemented backend-independed key-value cacheing table; applied to mod_caps.erl first --- src/cache_tab.erl | 480 ++++++++++++++++++++++++++++++++++++++++++ src/cache_tab_sup.erl | 34 +++ src/ejabberd_sup.erl | 8 + src/mod_caps.erl | 58 +++-- 4 files changed, 567 insertions(+), 13 deletions(-) create mode 100644 src/cache_tab.erl create mode 100644 src/cache_tab_sup.erl diff --git a/src/cache_tab.erl b/src/cache_tab.erl new file mode 100644 index 000000000..e2551ec78 --- /dev/null +++ b/src/cache_tab.erl @@ -0,0 +1,480 @@ +%%%------------------------------------------------------------------- +%%% File : cache_tab.erl +%%% Author : Evgeniy Khramtsov +%%% Description : Caching key-value table +%%% +%%% Created : 29 Aug 2010 by Evgeniy Khramtsov +%%%------------------------------------------------------------------- +-module(cache_tab). + +-define(GEN_SERVER, gen_server). + +-behaviour(?GEN_SERVER). + +%% API +-export([start_link/4, new/2, delete/1, delete/3, lookup/3, + insert/4, info/2, tab2list/1, setopts/2, all/0, test/0]). + +%% 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, {tab = treap:empty(), + name, + size = 0, + owner, + max_size, + life_time, + warn, + hits = 0, + miss = 0, + procs_num, + cache_missed, + shrink_size}). + +-define(PROCNAME, ?MODULE). +-define(CALL_TIMEOUT, 60000). + +%% Defaults +-define(MAX_SIZE, 1000). +-define(WARN, true). +-define(CACHE_MISSED, true). +-define(LIFETIME, 600). %% 10 minutes + +%%==================================================================== +%% API +%%==================================================================== +start_link(Proc, Tab, Opts, Owner) -> + ?GEN_SERVER:start_link( + {local, Proc}, ?MODULE, [Tab, Opts, get_proc_num(), Owner], []). + +new(Tab, Opts) -> + Res = lists:flatmap( + fun(Proc) -> + Spec = {{Tab, Proc}, + {?MODULE, start_link, + [Proc, Tab, Opts, self()]}, + permanent, + brutal_kill, + worker, + [?MODULE]}, + case supervisor:start_child(cache_tab_sup, Spec) of + {ok, _Pid} -> + [ok]; + R -> + [R] + end + end, get_all_procs(Tab)), + case lists:filter(fun(ok) -> false; (_) -> true end, Res) of + [] -> + ok; + Err -> + {error, Err} + end. + +delete(Tab) -> + lists:foreach( + fun(Proc) -> + supervisor:terminate_child(cache_tab_sup, {Tab, Proc}), + supervisor:delete_child(cache_tab_sup, {Tab, Proc}) + end, get_all_procs(Tab)). + +delete(Tab, Key, F) -> + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {delete, Key, F}, ?CALL_TIMEOUT). + +lookup(Tab, Key, F) -> + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {lookup, Key, F}, ?CALL_TIMEOUT). + +insert(Tab, Key, Val, F) -> + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {insert, Key, Val, F}, ?CALL_TIMEOUT). + +info(Tab, Info) -> + case lists:map( + fun(Proc) -> + ?GEN_SERVER:call(Proc, {info, Info}, ?CALL_TIMEOUT) + end, get_all_procs(Tab)) of + Res when Info == size -> + {ok, lists:sum(Res)}; + Res when Info == all -> + {ok, Res}; + Res when Info == ratio -> + {H, M} = lists:foldl( + fun({Hits, Miss}, {HitsAcc, MissAcc}) -> + {HitsAcc + Hits, MissAcc + Miss} + end, {0, 0}, Res), + {ok, [{hits, H}, {miss, M}]}; + _ -> + {error, badarg} + end. + +setopts(Tab, Opts) -> + lists:foreach( + fun(Proc) -> + ?GEN_SERVER:call(Proc, {setopts, Opts}, ?CALL_TIMEOUT) + end, get_all_procs(Tab)). + +tab2list(Tab) -> + lists:flatmap( + fun(Proc) -> + ?GEN_SERVER:call(Proc, tab2list, ?CALL_TIMEOUT) + end, get_all_procs(Tab)). + +all() -> + lists:usort( + [Tab || {{Tab, _}, _, _, _} <- supervisor:which_children(cache_tab_sup)]). + +%%==================================================================== +%% gen_server callbacks +%%==================================================================== +init([Tab, Opts, N, Pid]) -> + State = #state{procs_num = N, + owner = Pid, + name = Tab}, + {ok, do_setopts(State, Opts)}. + +handle_call({lookup, Key, F}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + Hits = State#state.hits, + NewState = treap_update(Key, Val, State#state{hits = Hits + 1}), + case Val of + '$cached_mismatch' -> + {reply, error, NewState}; + _ -> + {reply, {ok, Val}, NewState} + end; + _ -> + case catch F() of + {ok, Val} -> + Miss = State#state.miss, + NewState = treap_insert(Key, Val, State), + {reply, {ok, Val}, NewState#state{miss = Miss + 1}}; + {'EXIT', Reason} -> + print_error(lookup, [Key], Reason, State), + {reply, error, State}; + _ -> + Miss = State#state.miss, + NewState = State#state{miss = Miss + 1}, + if State#state.cache_missed -> + {reply, error, + treap_insert(Key, '$cached_mismatch', NewState)}; + true -> + {reply, error, NewState} + end + end + end; +handle_call({insert, Key, Val, F}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + {reply, ok, State}; + Res -> + case catch F() of + {'EXIT', Reason} -> + print_error(insert, [Key, Val], Reason, State), + {reply, ok, State}; + _ -> + NewState = case Res of + {ok, _, _} -> + treap_update(Key, Val, State); + _ -> + treap_insert(Key, Val, State) + end, + {reply, ok, NewState} + end + end; +handle_call({delete, Key, F}, _From, State) -> + NewState = treap_delete(Key, State), + case catch F() of + {'EXIT', Reason} -> + print_error(delete, [Key], Reason, State); + _ -> + ok + end, + {reply, ok, NewState}; +handle_call({info, Info}, _From, State) -> + Res = case Info of + size -> + State#state.size; + ratio -> + {State#state.hits, State#state.miss}; + all -> + [{max_size, State#state.max_size}, + {life_time, State#state.life_time}, + {shrink_size, State#state.shrink_size}, + {size, State#state.size}, + {owner, State#state.owner}, + {hits, State#state.hits}, + {miss, State#state.miss}, + {cache_missed, State#state.cache_missed}, + {warn, State#state.warn}]; + _ -> + badarg + end, + {reply, Res, State}; +handle_call(tab2list, _From, #state{tab = T} = State) -> + Res = treap:fold( + fun({Key, _, Val}, Acc) -> + [{Key, Val}|Acc] + end, [], T), + {reply, Res, State}; +handle_call({setopts, Opts}, _From, State) -> + {reply, ok, do_setopts(State, Opts)}; +handle_call(_Request, _From, State) -> + Reply = ok, + {reply, Reply, State}. + +handle_cast(_Msg, State) -> + {noreply, State}. + +handle_info(_Info, State) -> + {noreply, State}. + +terminate(_Reason, _State) -> + ok. + +code_change(_OldVsn, State, _Extra) -> + {ok, State}. + +%%-------------------------------------------------------------------- +%%% Internal functions +%%-------------------------------------------------------------------- +do_setopts(#state{procs_num = N} = State, Opts) -> + MaxSize = case {proplists:get_value(max_size, Opts), + State#state.max_size} of + {MS, _} when is_integer(MS), MS > 0 -> + round(MS/N); + {unlimited, _} -> + unlimited; + {_, undefined} -> + round(?MAX_SIZE/N); + {_, MS} -> + MS + end, + LifeTime = case {proplists:get_value(life_time, Opts), + State#state.life_time} of + {LT, _} when is_integer(LT), LT > 0 -> + LT*1000; + {unlimited, _} -> + unlimited; + {_, undefined} -> + ?LIFETIME*1000; + {_, LT} -> + LT + end, + ShrinkSize = case {proplists:get_value(shrink_size, Opts), + State#state.shrink_size} of + {SS, _} when is_integer(SS), SS > 0 -> + round(SS/N); + _ when is_integer(MaxSize) -> + round(MaxSize/2); + _ -> + unlimited + end, + Warn = case {proplists:get_value(warn, Opts), + State#state.warn} of + {true, _} -> + true; + {false, _} -> + false; + {_, undefined} -> + ?WARN; + {_, W} -> + W + end, + CacheMissed = case proplists:get_value( + cache_missed, Opts, State#state.cache_missed) of + false -> + false; + true -> + true; + _ -> + ?CACHE_MISSED + end, + State#state{max_size = MaxSize, + warn = Warn, + life_time = LifeTime, + cache_missed = CacheMissed, + shrink_size = ShrinkSize}. + +get_proc_num() -> + erlang:system_info(logical_processors). + +get_proc_by_hash(Tab, Term) -> + N = erlang:phash2(Term, get_proc_num()) + 1, + get_proc(Tab, N). + +get_proc(Tab, N) -> + list_to_atom(atom_to_list(?PROCNAME) ++ "_" ++ + atom_to_list(Tab) ++ "_" ++ integer_to_list(N)). + +get_all_procs(Tab) -> + [get_proc(Tab, N) || N <- lists:seq(1, get_proc_num())]. + +now_priority() -> + {MSec, Sec, USec} = now(), + -((MSec*1000000 + Sec)*1000000 + USec). + +treap_update(Key, Val, #state{tab = T} = State) -> + Priority = now_priority(), + NewT = treap:insert(Key, Priority, Val, T), + State#state{tab = NewT}. + +treap_insert(Key, Val, State) -> + State1 = clean_treap(State), + #state{size = Size} = State2 = shrink_treap(State1), + treap_update(Key, Val, State2#state{size = Size+1}). + +treap_delete(Key, #state{tab = T, size = Size} = State) -> + case treap:lookup(Key, T) of + {ok, _, _} -> + NewT = treap:delete(Key, T), + clean_treap(State#state{tab = NewT, size = Size-1}); + _ -> + State + end. + +clean_treap(#state{tab = T, size = Size, life_time = LifeTime} = State) -> + if is_integer(LifeTime) -> + Priority = now_priority(), + {Cleaned, NewT} = clean_treap(T, Priority + LifeTime, 0), + State#state{size = Size - Cleaned, tab = NewT}; + true -> + State + end. + +clean_treap(Treap, CleanPriority, N) -> + case treap:is_empty(Treap) of + true -> + {N, Treap}; + false -> + {_Key, Priority, _Value} = treap:get_root(Treap), + if Priority > CleanPriority -> + clean_treap(treap:delete_root(Treap), CleanPriority, N+1); + true -> + {N, Treap} + end + end. + +shrink_treap(#state{tab = T, + max_size = MaxSize, + shrink_size = ShrinkSize, + warn = Warn, + size = Size} = State) when Size >= MaxSize -> + if Warn -> + ?WARNING_MSG("shrinking table:~n" + "** Table: ~p~n" + "** Processes Number: ~p~n" + "** Max Size: ~p items~n" + "** Shrink Size: ~p items~n" + "** Life Time: ~p microseconds~n" + "** Hits/Miss: ~p/~p~n" + "** Owner: ~p~n" + "** Cache Missed: ~p~n" + "** Instruction: you have to tune cacheing options" + " if this message repeats too frequently", + [State#state.name, State#state.procs_num, + MaxSize, ShrinkSize, State#state.life_time, + State#state.hits, State#state.miss, + State#state.owner, State#state.cache_missed]); + true -> + ok + end, + {Shrinked, NewT} = shrink_treap(T, ShrinkSize, 0), + State#state{tab = NewT, size = Size - Shrinked}; +shrink_treap(State) -> + State. + +shrink_treap(T, ShrinkSize, ShrinkSize) -> + {ShrinkSize, T}; +shrink_treap(T, ShrinkSize, N) -> + case treap:is_empty(T) of + true -> + {N, T}; + false -> + shrink_treap(treap:delete_root(T), ShrinkSize, N+1) + end. + +print_error(Operation, Args, Reason, State) -> + ?ERROR_MSG("callback failed:~n" + "** Tab: ~p~n" + "** Owner: ~p~n" + "** Operation: ~p~n" + "** Args: ~p~n" + "** Reason: ~p", + [State#state.name, State#state.owner, + Operation, Args, Reason]). + +%%-------------------------------------------------------------------- +%%% Tests +%%-------------------------------------------------------------------- +test() -> + LifeTime = 2, + ok = new(test_tbl, [{life_time, LifeTime}, {max_size, unlimited}]), + check([]), + ok = insert(test_tbl, "key", "value", fun() -> ok end), + check([{"key", "value"}]), + {ok, "value"} = lookup(test_tbl, "key", fun() -> error end), + check([{"key", "value"}]), + io:format("** waiting for ~p seconds to check if cleaner works fine...~n", + [LifeTime+1]), + timer:sleep(timer:seconds(LifeTime+1)), + ok = insert(test_tbl, "key1", "value1", fun() -> ok end), + check([{"key1", "value1"}]), + ok = delete(test_tbl, "key1", fun() -> ok end), + {ok, "value"} = lookup(test_tbl, "key", fun() -> {ok, "value"} end), + check([{"key", "value"}]), + ok = delete(test_tbl, "key", fun() -> ok end), + check([]), + %% io:format("** testing buggy callbacks...~n"), + %% delete(test_tbl, "key", fun() -> erlang:error(badarg) end), + %% insert(test_tbl, "key", "val", fun() -> erlang:error(badarg) end), + %% lookup(test_tbl, "key", fun() -> erlang:error(badarg) end), + check([]), + delete(test_tbl), + test1(). + +test1() -> + MaxSize = 10, + ok = new(test_tbl, [{max_size, MaxSize}, {shrink_size, 1}, {warn, false}]), + lists:foreach( + fun(N) -> + ok = insert(test_tbl, N, N, fun() -> ok end) + end, lists:seq(1, MaxSize*get_proc_num())), + {ok, MaxSize} = info(test_tbl, size), + delete(test_tbl), + success. +%% io:format("** testing speed, this may take a while...~n"), +%% test2(1000), +%% test2(10000), +%% test2(100000), +%% test2(1000000). + +%% test2(Iter) -> +%% ok = new(test_tbl, [{max_size, unlimited}, {life_time, unlimited}]), +%% L = lists:seq(1, Iter), +%% T1 = now(), +%% lists:foreach( +%% fun(N) -> +%% ok = insert(test_tbl, N, N, fun() -> ok end) +%% end, L), +%% io:format("** average insert (size = ~p): ~p usec~n", +%% [Iter, round(timer:now_diff(now(), T1)/Iter)]), +%% T2 = now(), +%% lists:foreach( +%% fun(N) -> +%% {ok, N} = lookup(test_tbl, N, fun() -> ok end) +%% end, L), +%% io:format("** average lookup (size = ~p): ~p usec~n", +%% [Iter, round(timer:now_diff(now(), T2)/Iter)]), +%% {ok, Iter} = info(test_tbl, size), +%% delete(test_tbl). + +check(List) -> + Size = length(List), + {ok, Size} = info(test_tbl, size), + List = tab2list(test_tbl). diff --git a/src/cache_tab_sup.erl b/src/cache_tab_sup.erl new file mode 100644 index 000000000..d417c5488 --- /dev/null +++ b/src/cache_tab_sup.erl @@ -0,0 +1,34 @@ +%%%------------------------------------------------------------------- +%%% File : cache_tab_sup.erl +%%% Author : Evgeniy Khramtsov +%%% Description : +%%% +%%% Created : 30 Aug 2010 by Evgeniy Khramtsov +%%%------------------------------------------------------------------- +-module(cache_tab_sup). + +-behaviour(supervisor). + +%% API +-export([start_link/0]). + +%% Supervisor callbacks +-export([init/1]). + +-define(SERVER, ?MODULE). + +%%==================================================================== +%% API functions +%%==================================================================== +start_link() -> + supervisor:start_link({local, ?SERVER}, ?MODULE, []). + +%%==================================================================== +%% Supervisor callbacks +%%==================================================================== +init([]) -> + {ok, {{one_for_one,10,1}, []}}. + +%%==================================================================== +%% Internal functions +%%==================================================================== diff --git a/src/ejabberd_sup.erl b/src/ejabberd_sup.erl index e088c032b..7523eed2d 100644 --- a/src/ejabberd_sup.erl +++ b/src/ejabberd_sup.erl @@ -191,6 +191,13 @@ init([]) -> brutal_kill, worker, [ejabberd_cluster]}, + CacheTabSupervisor = + {cache_tab_sup, + {cache_tab_sup, start_link, []}, + permanent, + infinity, + supervisor, + [cache_tab_sup]}, {ok, {{one_for_one, 10, 1}, [Hooks, GlobalRouter, @@ -212,6 +219,7 @@ init([]) -> IQSupervisor, STUNSupervisor, FrontendSocketSupervisor, + CacheTabSupervisor, Listener]}}. diff --git a/src/mod_caps.erl b/src/mod_caps.erl index b338243a7..27bdbcbdc 100644 --- a/src/mod_caps.erl +++ b/src/mod_caps.erl @@ -99,11 +99,12 @@ get_features(#caps{node = Node, version = Version, exts = Exts}) -> SubNodes = [Version | Exts], lists:foldl( fun(SubNode, Acc) -> - case mnesia:dirty_read({caps_features, - node_to_binary(Node, SubNode)}) of - [] -> + BinaryNode = node_to_binary(Node, SubNode), + case cache_tab:lookup(caps_features, BinaryNode, + caps_read_fun(BinaryNode)) of + error -> Acc; - [#caps_features{features = Features}] -> + {ok, Features} -> binary_to_features(Features) ++ Acc end end, [], SubNodes). @@ -189,13 +190,23 @@ disco_info(Acc, _Host, _Module, _Node, _Lang) -> %%==================================================================== %% gen_server callbacks %%==================================================================== - -init([Host, _Opts]) -> +init([Host, Opts]) -> + case catch mnesia:table_info(caps_features, storage_type) of + {'EXIT', _} -> + ok; + disc_only_copies -> + ok; + _ -> + mnesia:delete_table(caps_features) + end, mnesia:create_table(caps_features, - [{disc_copies, [node()]}, + [{disc_only_copies, [node()]}, {local_content, true}, {attributes, record_info(fields, caps_features)}]), - mnesia:add_table_copy(caps_features, node(), disc_copies), + mnesia:add_table_copy(caps_features, node(), disc_only_copies), + MaxSize = gen_mod:get_opt(cache_size, Opts, 1000), + LifeTime = gen_mod:get_opt(cache_life_time, Opts, timer:hours(24)), + cache_tab:new(caps_features, [{max_size, MaxSize}, {life_time, LifeTime}]), HostB = list_to_binary(Host), ejabberd_hooks:add(user_send_packet, HostB, ?MODULE, user_send_packet, 75), ejabberd_hooks:add(c2s_stream_features, HostB, @@ -245,8 +256,9 @@ code_change(_OldVsn, State, _Extra) -> feature_request(Host, From, Caps, [SubNode | Tail] = SubNodes) -> Node = Caps#caps.node, BinaryNode = node_to_binary(Node, SubNode), - case mnesia:dirty_read({caps_features, BinaryNode}) of - [] -> + case cache_tab:lookup(caps_features, BinaryNode, + caps_read_fun(BinaryNode)) of + error -> IQ = #iq{type = get, iq_ns = ?NS_JABBER_CLIENT, payload = #xmlel{ns = ?NS_DISCO_INFO, name = 'query', @@ -272,8 +284,10 @@ feature_response(#iq{type = result, payload = El}, [] end, El#xmlel.children), BinaryNode = node_to_binary(Caps#caps.node, SubNode), - mnesia:dirty_write(#caps_features{node_pair = BinaryNode, - features = features_to_binary(Features)}), + BinaryFeatures = features_to_binary(Features), + cache_tab:insert( + caps_features, BinaryNode, BinaryFeatures, + caps_write_fun(BinaryNode, BinaryFeatures)), feature_request(Host, From, Caps, SubNodes); feature_response(timeout, _Host, _From, _Caps, _SubNodes) -> ok; @@ -281,7 +295,8 @@ feature_response(_IQResult, Host, From, Caps, [SubNode | SubNodes]) -> %% We got type=error or invalid type=result stanza, so %% we cache empty feature not to probe the client permanently BinaryNode = node_to_binary(Caps#caps.node, SubNode), - mnesia:dirty_write(#caps_features{node_pair = BinaryNode}), + cache_tab:insert(caps_features, BinaryNode, [], + caps_write_fun(BinaryNode, [])), feature_request(Host, From, Caps, SubNodes). node_to_binary(Node, SubNode) -> @@ -290,6 +305,23 @@ node_to_binary(Node, SubNode) -> features_to_binary(L) -> [list_to_binary(I) || I <- L]. binary_to_features(L) -> [binary_to_list(I) || I <- L]. +caps_read_fun(Node) -> + fun() -> + case mnesia:dirty_read({caps_features, Node}) of + [#caps_features{features = Features}] -> + {ok, Features}; + _ -> + error + end + end. + +caps_write_fun(Node, Features) -> + fun() -> + mnesia:dirty_write( + #caps_features{node_pair = Node, + features = Features}) + end. + make_my_disco_hash(Host) -> JID = exmpp_jid:make(Host), case {ejabberd_hooks:run_fold(disco_local_features, From 7a3aa8f97dd0fd3cd933eab1c065e8d5d4584846 Mon Sep 17 00:00:00 2001 From: Evgeniy Khramtsov Date: Tue, 31 Aug 2010 18:06:02 +1000 Subject: [PATCH 02/34] Implemented dirty (non-atomic) functions; added copyright notice --- src/cache_tab.erl | 155 ++++++++++++++++++++++++++++++++---------- src/cache_tab_sup.erl | 21 +++++- 2 files changed, 139 insertions(+), 37 deletions(-) diff --git a/src/cache_tab.erl b/src/cache_tab.erl index e2551ec78..75ef6159a 100644 --- a/src/cache_tab.erl +++ b/src/cache_tab.erl @@ -4,6 +4,25 @@ %%% Description : Caching key-value table %%% %%% Created : 29 Aug 2010 by Evgeniy Khramtsov +%%% +%%% +%%% ejabberd, Copyright (C) 2002-2010 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(cache_tab). @@ -13,7 +32,9 @@ %% API -export([start_link/4, new/2, delete/1, delete/3, lookup/3, - insert/4, info/2, tab2list/1, setopts/2, all/0, test/0]). + insert/4, info/2, tab2list/1, setopts/2, + dirty_lookup/3, dirty_insert/4, dirty_delete/3, + all/0, test/0]). %% gen_server callbacks -export([init/1, handle_call/3, handle_cast/2, handle_info/2, @@ -83,15 +104,43 @@ delete(Tab) -> delete(Tab, Key, F) -> ?GEN_SERVER:call( - get_proc_by_hash(Tab, Key), {delete, Key, F}, ?CALL_TIMEOUT). + get_proc_by_hash(Tab, Key), {delete, Key, F}, ?CALL_TIMEOUT). + +dirty_delete(Tab, Key, F) -> + F(), + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {dirty_delete, Key}, ?CALL_TIMEOUT). lookup(Tab, Key, F) -> ?GEN_SERVER:call( - get_proc_by_hash(Tab, Key), {lookup, Key, F}, ?CALL_TIMEOUT). + get_proc_by_hash(Tab, Key), {lookup, Key, F}, ?CALL_TIMEOUT). + +dirty_lookup(Tab, Key, F) -> + Proc = get_proc_by_hash(Tab, Key), + case ?GEN_SERVER:call(Proc, {dirty_lookup, Key}, ?CALL_TIMEOUT) of + {ok, '$cached_mismatch'} -> + error; + {ok, Val} -> + {ok, Val}; + _ -> + case F() of + {ok, Val} -> + ?GEN_SERVER:call( + Proc, {dirty_insert, Key, Val}, ?CALL_TIMEOUT), + {ok, Val}; + _ -> + error + end + end. insert(Tab, Key, Val, F) -> ?GEN_SERVER:call( - get_proc_by_hash(Tab, Key), {insert, Key, Val, F}, ?CALL_TIMEOUT). + get_proc_by_hash(Tab, Key), {insert, Key, Val, F}, ?CALL_TIMEOUT). + +dirty_insert(Tab, Key, Val, F) -> + F(), + ?GEN_SERVER:call( + get_proc_by_hash(Tab, Key), {dirty_insert, Key, Val}, ?CALL_TIMEOUT). info(Tab, Info) -> case lists:map( @@ -168,6 +217,22 @@ handle_call({lookup, Key, F}, _From, #state{tab = T} = State) -> end end end; +handle_call({dirty_lookup, Key}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + Hits = State#state.hits, + NewState = treap_update(Key, Val, State#state{hits = Hits + 1}), + {reply, {ok, Val}, NewState}; + _ -> + Miss = State#state.miss, + NewState = State#state{miss = Miss + 1}, + if State#state.cache_missed -> + {reply, error, + treap_insert(Key, '$cached_mismatch', NewState)}; + true -> + {reply, error, NewState} + end + end; handle_call({insert, Key, Val, F}, _From, #state{tab = T} = State) -> case treap:lookup(Key, T) of {ok, _Prio, Val} -> @@ -187,6 +252,15 @@ handle_call({insert, Key, Val, F}, _From, #state{tab = T} = State) -> {reply, ok, NewState} end end; +handle_call({dirty_insert, Key, Val}, _From, #state{tab = T} = State) -> + case treap:lookup(Key, T) of + {ok, _Prio, Val} -> + {reply, ok, State}; + {ok, _, _} -> + {reply, ok, treap_update(Key, Val, State)}; + _ -> + {reply, ok, treap_insert(Key, Val, State)} + end; handle_call({delete, Key, F}, _From, State) -> NewState = treap_delete(Key, State), case catch F() of @@ -196,6 +270,9 @@ handle_call({delete, Key, F}, _From, State) -> ok end, {reply, ok, NewState}; +handle_call({dirty_delete, Key}, _From, State) -> + NewState = treap_delete(Key, State), + {reply, ok, NewState}; handle_call({info, Info}, _From, State) -> Res = case Info of size -> @@ -412,23 +489,30 @@ print_error(Operation, Args, Reason, State) -> %%-------------------------------------------------------------------- %%% Tests %%-------------------------------------------------------------------- +-define(lookup, dirty_lookup). +-define(delete, dirty_delete). +-define(insert, dirty_insert). +%% -define(lookup, lookup). +%% -define(delete, delete). +%% -define(insert, insert). + test() -> LifeTime = 2, ok = new(test_tbl, [{life_time, LifeTime}, {max_size, unlimited}]), check([]), - ok = insert(test_tbl, "key", "value", fun() -> ok end), + ok = ?insert(test_tbl, "key", "value", fun() -> ok end), check([{"key", "value"}]), - {ok, "value"} = lookup(test_tbl, "key", fun() -> error end), + {ok, "value"} = ?lookup(test_tbl, "key", fun() -> error end), check([{"key", "value"}]), io:format("** waiting for ~p seconds to check if cleaner works fine...~n", [LifeTime+1]), timer:sleep(timer:seconds(LifeTime+1)), - ok = insert(test_tbl, "key1", "value1", fun() -> ok end), + ok = ?insert(test_tbl, "key1", "value1", fun() -> ok end), check([{"key1", "value1"}]), - ok = delete(test_tbl, "key1", fun() -> ok end), - {ok, "value"} = lookup(test_tbl, "key", fun() -> {ok, "value"} end), + ok = ?delete(test_tbl, "key1", fun() -> ok end), + {ok, "value"} = ?lookup(test_tbl, "key", fun() -> {ok, "value"} end), check([{"key", "value"}]), - ok = delete(test_tbl, "key", fun() -> ok end), + ok = ?delete(test_tbl, "key", fun() -> ok end), check([]), %% io:format("** testing buggy callbacks...~n"), %% delete(test_tbl, "key", fun() -> erlang:error(badarg) end), @@ -443,36 +527,35 @@ test1() -> ok = new(test_tbl, [{max_size, MaxSize}, {shrink_size, 1}, {warn, false}]), lists:foreach( fun(N) -> - ok = insert(test_tbl, N, N, fun() -> ok end) + ok = ?insert(test_tbl, N, N, fun() -> ok end) end, lists:seq(1, MaxSize*get_proc_num())), {ok, MaxSize} = info(test_tbl, size), delete(test_tbl), - success. -%% io:format("** testing speed, this may take a while...~n"), -%% test2(1000), -%% test2(10000), -%% test2(100000), -%% test2(1000000). + io:format("** testing speed, this may take a while...~n"), + test2(1000), + test2(10000), + test2(100000), + test2(1000000). -%% test2(Iter) -> -%% ok = new(test_tbl, [{max_size, unlimited}, {life_time, unlimited}]), -%% L = lists:seq(1, Iter), -%% T1 = now(), -%% lists:foreach( -%% fun(N) -> -%% ok = insert(test_tbl, N, N, fun() -> ok end) -%% end, L), -%% io:format("** average insert (size = ~p): ~p usec~n", -%% [Iter, round(timer:now_diff(now(), T1)/Iter)]), -%% T2 = now(), -%% lists:foreach( -%% fun(N) -> -%% {ok, N} = lookup(test_tbl, N, fun() -> ok end) -%% end, L), -%% io:format("** average lookup (size = ~p): ~p usec~n", -%% [Iter, round(timer:now_diff(now(), T2)/Iter)]), -%% {ok, Iter} = info(test_tbl, size), -%% delete(test_tbl). +test2(Iter) -> + ok = new(test_tbl, [{max_size, unlimited}, {life_time, unlimited}]), + L = lists:seq(1, Iter), + T1 = now(), + lists:foreach( + fun(N) -> + ok = ?insert(test_tbl, N, N, fun() -> ok end) + end, L), + io:format("** average insert (size = ~p): ~p usec~n", + [Iter, round(timer:now_diff(now(), T1)/Iter)]), + T2 = now(), + lists:foreach( + fun(N) -> + {ok, N} = ?lookup(test_tbl, N, fun() -> ok end) + end, L), + io:format("** average lookup (size = ~p): ~p usec~n", + [Iter, round(timer:now_diff(now(), T2)/Iter)]), + {ok, Iter} = info(test_tbl, size), + delete(test_tbl). check(List) -> Size = length(List), diff --git a/src/cache_tab_sup.erl b/src/cache_tab_sup.erl index d417c5488..a49593f5e 100644 --- a/src/cache_tab_sup.erl +++ b/src/cache_tab_sup.erl @@ -1,9 +1,28 @@ %%%------------------------------------------------------------------- %%% File : cache_tab_sup.erl %%% Author : Evgeniy Khramtsov -%%% Description : +%%% Description : Cache tables supervisor %%% %%% Created : 30 Aug 2010 by Evgeniy Khramtsov +%%% +%%% +%%% ejabberd, Copyright (C) 2002-2010 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(cache_tab_sup). From 556892aebf0dcc33d8d921ca321bf1ed62b98f11 Mon Sep 17 00:00:00 2001 From: Evgeniy Khramtsov Date: Wed, 8 Sep 2010 02:33:49 +1000 Subject: [PATCH 03/34] cache lifetime should be converted in microseconds --- src/cache_tab.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/cache_tab.erl b/src/cache_tab.erl index 75ef6159a..b05e78b0e 100644 --- a/src/cache_tab.erl +++ b/src/cache_tab.erl @@ -335,11 +335,11 @@ do_setopts(#state{procs_num = N} = State, Opts) -> LifeTime = case {proplists:get_value(life_time, Opts), State#state.life_time} of {LT, _} when is_integer(LT), LT > 0 -> - LT*1000; + LT*1000*1000; {unlimited, _} -> unlimited; {_, undefined} -> - ?LIFETIME*1000; + ?LIFETIME*1000*1000; {_, LT} -> LT end, From 4b5b98b465b4bcd36bce9e6e8cf40af2f01afbf1 Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Fri, 10 Sep 2010 19:45:28 +0200 Subject: [PATCH 04/34] clean nodeid/nidx variables names (thanks to Karim)(EJAB-1000) --- src/mod_pubsub/mod_pubsub.erl | 428 ++++++++++---------- src/mod_pubsub/mod_pubsub_odbc.erl | 397 +++++++++--------- src/mod_pubsub/node.template | 4 +- src/mod_pubsub/node_buddy.erl | 4 +- src/mod_pubsub/node_club.erl | 4 +- src/mod_pubsub/node_dag.erl | 92 ++--- src/mod_pubsub/node_dispatch.erl | 4 +- src/mod_pubsub/node_flat.erl | 128 +++--- src/mod_pubsub/node_flat_odbc.erl | 153 ++++--- src/mod_pubsub/node_hometree.erl | 4 +- src/mod_pubsub/node_hometree_odbc.erl | 4 +- src/mod_pubsub/node_mb.erl | 4 +- src/mod_pubsub/node_pep.erl | 26 +- src/mod_pubsub/node_pep_odbc.erl | 6 +- src/mod_pubsub/node_private.erl | 4 +- src/mod_pubsub/node_public.erl | 4 +- src/mod_pubsub/nodetree_dag.erl | 132 +++--- src/mod_pubsub/nodetree_tree.erl | 64 +-- src/mod_pubsub/nodetree_tree_odbc.erl | 105 +++-- src/mod_pubsub/nodetree_virtual.erl | 23 +- src/mod_pubsub/pubsub.hrl | 64 +-- src/mod_pubsub/pubsub_db_odbc.erl | 14 +- src/mod_pubsub/pubsub_odbc.patch | 306 +++++++------- src/mod_pubsub/pubsub_subscription.erl | 36 +- src/mod_pubsub/pubsub_subscription_odbc.erl | 26 +- 25 files changed, 1017 insertions(+), 1019 deletions(-) diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index 9ece1fe53..adec996f0 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -296,18 +296,18 @@ update_node_database(Host, ServerHost) -> ?INFO_MSG("upgrade node pubsub tables",[]), F = fun() -> {Result, LastIdx} = lists:foldl( - fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, NodeIdx}) -> + fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, Nidx}) -> ItemsList = lists:foldl( - fun({item, IID, Publisher, Payload}, Acc) -> + fun({item, ItemName, Publisher, Payload}, Acc) -> C = {unknown, Publisher}, M = {now(), Publisher}, mnesia:write( - #pubsub_item{itemid = {IID, NodeIdx}, + #pubsub_item{id = {ItemName, Nidx}, creation = C, modification = M, payload = Payload}), - [{Publisher, IID} | Acc] + [{Publisher, ItemName} | Acc] end, [], Items), Owners = dict:fold( @@ -321,7 +321,7 @@ update_node_database(Host, ServerHost) -> end end, [], ItemsList), mnesia:write({pubsub_state, - {JID, NodeIdx}, + {JID, Nidx}, UsrItems, Aff, Sub}), @@ -331,12 +331,12 @@ update_node_database(Host, ServerHost) -> end end, [], Entities), mnesia:delete({pubsub_node, NodeId}), - {[#pubsub_node{nodeid = NodeId, - id = NodeIdx, + {[#pubsub_node{id = NodeId, + idx = Nidx, parents = [element(2, ParentId)], owners = Owners, options = Options} | - RecList], NodeIdx + 1} + RecList], Nidx + 1} end, {[], 1}, mnesia:match_object( {pubsub_node, {Host, '_'}, '_', '_'})), @@ -361,32 +361,33 @@ update_node_database(Host, ServerHost) -> [nodeid, parentid, type, owners, options] -> F = fun({pubsub_node, NodeId, {_, Parent}, Type, Owners, Options}) -> #pubsub_node{ - nodeid = NodeId, - id = 0, + id = NodeId, + idx = 0, parents = [Parent], type = Type, owners = Owners, options = Options} end, + %% TODO : to change nodeid/id and id/idx or not to change ? mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), FNew = fun() -> - LastIdx = lists:foldl(fun(#pubsub_node{nodeid = NodeId} = PubsubNode, NodeIdx) -> - mnesia:write(PubsubNode#pubsub_node{id = NodeIdx}), - lists:foreach(fun(#pubsub_state{stateid = StateId} = State) -> + LastIdx = lists:foldl(fun(#pubsub_node{id = NodeId} = PubsubNode, Nidx) -> + mnesia:write(PubsubNode#pubsub_node{idx = Nidx}), + lists:foreach(fun(#pubsub_state{id = StateId} = State) -> {JID, _} = StateId, mnesia:delete({pubsub_state, StateId}), - mnesia:write(State#pubsub_state{stateid = {JID, NodeIdx}}) - end, mnesia:match_object(#pubsub_state{stateid = {'_', NodeId}, _ = '_'})), - lists:foreach(fun(#pubsub_item{itemid = ItemId} = Item) -> - {IID, _} = ItemId, + mnesia:write(State#pubsub_state{id = {JID, Nidx}}) + end, mnesia:match_object(#pubsub_state{id = {'_', NodeId}, _ = '_'})), + lists:foreach(fun(#pubsub_item{id = ItemId} = Item) -> + {ItemName, _} = ItemId, {M1, M2} = Item#pubsub_item.modification, {C1, C2} = Item#pubsub_item.creation, mnesia:delete({pubsub_item, ItemId}), - mnesia:write(Item#pubsub_item{itemid = {IID, NodeIdx}, + mnesia:write(Item#pubsub_item{id = {ItemName, Nidx}, modification = {M2, M1}, creation = {C2, C1}}) - end, mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'})), - NodeIdx + 1 + end, mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'})), + Nidx + 1 end, 1, mnesia:match_object( {pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) ++ mnesia:match_object( @@ -403,13 +404,14 @@ update_node_database(Host, ServerHost) -> [nodeid, id, parent, type, owners, options] -> F = fun({pubsub_node, NodeId, Id, Parent, Type, Owners, Options}) -> #pubsub_node{ - nodeid = NodeId, - id = Id, + id = NodeId, + idx = Id, parents = [Parent], type = Type, owners = Owners, options = Options} end, + %% TODO : to change nodeid/id and id/idx or not to change ? mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), rename_default_nodeplugin(); _ -> @@ -427,7 +429,7 @@ update_node_database(Host, ServerHost) -> [<<>>] -> []; Parents -> Parents end, - mnesia:write(Node#pubsub_node{nodeid={H, BN}, parents=BP}), + mnesia:write(Node#pubsub_node{id={H, BN}, parents=BP}), mnesia:delete({pubsub_node, {H, N}}); (_) -> ok @@ -446,15 +448,15 @@ update_state_database(_Host, _ServerHost) -> case catch mnesia:table_info(pubsub_state, attributes) of [stateid, items, affiliation, subscription] -> ?INFO_MSG("upgrade state pubsub tables", []), - F = fun ({pubsub_state, {JID, NodeID}, Items, Aff, Sub}, Acc) -> + F = fun ({pubsub_state, {JID, NodeId}, Items, Aff, Sub}, Acc) -> Subs = case Sub of none -> []; _ -> - {result, SubID} = pubsub_subscription:subscribe_node(JID, NodeID, []), - [{Sub, SubID}] + {result, SubId} = pubsub_subscription:subscribe_node(JID, NodeId, []), + [{Sub, SubId}] end, - NewState = #pubsub_state{stateid = {JID, NodeID}, + NewState = #pubsub_state{id = {JID, NodeId}, items = Items, affiliation = Aff, subscriptions = Subs}, @@ -495,10 +497,10 @@ send_loop(State) -> lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> - #pubsub_node{nodeid = {H, N}, type = Type, id = NodeId, options = Options} = Node, + #pubsub_node{id = {H, N}, type = Type, idx = Nidx, options = Options} = Node, case get_option(Options, send_last_published_item) of on_sub_and_presence -> - send_items(H, N, NodeId, Type, LJID, last); + send_items(H, N, Nidx, Type, LJID, last); _ -> ok end; @@ -548,7 +550,7 @@ send_loop(State) -> spawn(fun() -> Host = State#state.host, Owner = jlib:short_prepd_bare_jid(JID), - lists:foreach(fun(#pubsub_node{nodeid = {_, Node}, type = Type, id = NodeId, options = Options}) -> + lists:foreach(fun(#pubsub_node{id = {_, Node}, type = Type, idx = Nidx, options = Options}) -> case get_option(Options, send_last_published_item) of on_sub_and_presence -> lists:foreach(fun(Resource) -> @@ -563,7 +565,7 @@ send_loop(State) -> {OU, OS, _} = Owner, element(2, get_roster_info(OU, OS, LJID, Grps)) end, - if Subscribed -> send_items(Owner, Node, NodeId, Type, LJID, last); + if Subscribed -> send_items(Owner, Node, Nidx, Type, LJID, last); true -> ok end end, Resources); @@ -616,8 +618,8 @@ disco_identity(_Host, <<>>, _From) -> [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, @@ -647,8 +649,8 @@ disco_features(_Host, <<>>, _From) -> [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s | [?NS_PUBSUB_s ++ "#" ++ Feature || Feature <- features("pep")]]}; @@ -666,12 +668,12 @@ disco_sm_items({result, OtherItems}, From, To, Node, _Lang) -> {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> - Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx, owners = Owners}, Acc) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx, owners = Owners}, Acc) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('node', NodeID) | + ?XMLATTR('node', NodeId) | case get_option(Options, title) of false -> []; [Title] -> [?XMLATTR('title', Title)] @@ -686,14 +688,14 @@ disco_items(Host, <<>>, From) -> end; disco_items(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('name', ItemID)]} - || #pubsub_item{itemid = {ItemID,_}} <- Items]}; + ?XMLATTR('name', ItemId)]} + || #pubsub_item{id = {ItemId,_}} <- Items]}; _ -> {result, []} end end, @@ -723,6 +725,7 @@ presence_probe(Peer, JID, Pid) -> presence(Host, {presence, User, Server, [Resource], JID}) end end. + presence(ServerHost, Presence) when is_binary(ServerHost) -> presence(binary_to_list(ServerHost), Presence); presence(ServerHost, Presence) -> @@ -771,12 +774,12 @@ unsubscribe_user(Entity, Owner) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{options = Options, owners = Owners, id = NodeId}, subscribed, _, JID}) -> + ({#pubsub_node{options = Options, owners = Owners, idx = Nidx}, subscribed, _, JID}) -> case get_option(Options, access_model) of presence -> case lists:member(BJID, Owners) of true -> - node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]); + node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> {result, ok} end; @@ -807,13 +810,13 @@ remove_user(UserB, ServerB) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{id = NodeId}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]) + ({#pubsub_node{idx = Nidx}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]) end, Subscriptions), {result, Affiliations} = node_action(Host, PType, get_entity_affiliations, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{nodeid = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); - ({#pubsub_node{nodeid = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); - ({#pubsub_node{id = NodeId}, publisher}) -> node_action(Host, PType, set_affiliation, [NodeId, Entity, none]); + ({#pubsub_node{id = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); + ({#pubsub_node{id = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); + ({#pubsub_node{idx = Nidx}, publisher}) -> node_action(Host, PType, set_affiliation, [Nidx, Entity, none]); (_) -> ok end, Affiliations) end, plugins(Host)) @@ -1079,7 +1082,7 @@ node_disco_info(Host, Node, From) -> node_disco_info(Host, Node, From, true, true). node_disco_info(Host, Node, From, Identity, Features) -> Action = - fun(#pubsub_node{type = Type, id = NodeId}) -> + fun(#pubsub_node{type = Type, idx = Nidx}) -> I = case Identity of false -> []; @@ -1089,7 +1092,7 @@ node_disco_info(Host, Node, From, Identity, Features) -> [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> - case node_call(Type, get_items, [NodeId, From]) of + case node_call(Type, get_items, [Nidx, From]) of {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] @@ -1150,7 +1153,7 @@ iq_disco_items(Host, [], From) -> case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = Options}) -> + fun(#pubsub_node{id = {_, SubNode}, options = Options}) -> Attrs = case get_option(Options, title) of false -> @@ -1177,17 +1180,17 @@ iq_disco_items(_Host, ?NS_PUBSUB_GET_PENDING, _From) -> {result, CommandItems}; iq_disco_items(Host, Item, From) -> case string:tokens(Item, "!") of - [_SNode, _ItemID] -> + [_SNode, _ItemId] -> {result, []}; [SNode] -> Node = string_to_node(SNode), - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> - NodeItems = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> + NodeItems = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, R} -> R; _ -> [] end, Nodes = lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = SubOptions}) -> + fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> Attrs = case get_option(SubOptions, title) of false -> @@ -1198,7 +1201,7 @@ iq_disco_items(Host, Item, From) -> #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = Attrs} end, tree_call(Host, get_subnodes, [Host, Node, From])), Items = lists:map( - fun(#pubsub_item{itemid = {RN, _}}) -> + fun(#pubsub_item{id = {RN, _}}) -> {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -1210,11 +1213,11 @@ iq_disco_items(Host, Item, From) -> end end. -get_allowed_items_call(Host, NodeIdx, From, Type, Options, Owners) -> +get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) -> AccessModel = get_option(Options, access_model), AllowedGroups = get_option(Options, roster_groups_allowed, []), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), - node_call(Type, get_items, [NodeIdx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). + node_call(Type, get_items, [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups) -> if (AccessModel == presence) or (AccessModel == roster) -> @@ -1324,28 +1327,28 @@ iq_pubsub(Host, ServerHost, From, IQType, SubEl, Lang, Access, Plugins) -> {get, 'items'} -> MaxItems = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'max_items', ""), SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), - ItemIDs = lists:foldl(fun + ItemIds = lists:foldl(fun (#xmlel{name = 'item', attrs = ItemAttrs}, Acc) -> case exmpp_xml:get_attribute_from_list_as_list(ItemAttrs, 'id', "") of "" -> Acc; - ItemID -> [ItemID|Acc] + ItemId -> [ItemId|Acc] end; (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), - get_items(Host, Node, From, SubId, MaxItems, ItemIDs); + get_items(Host, Node, From, SubId, MaxItems, ItemIds); {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> get_affiliations(Host, From, Plugins); {get, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - get_options(Host, Node, JID, SubID, Lang); + get_options(Host, Node, JID, SubId, Lang); {set, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - set_options(Host, Node, JID, SubID, Els); + set_options(Host, Node, JID, SubId, Els); _ -> {error, 'feature-not-implemented'} end; @@ -1503,12 +1506,12 @@ send_pending_auth_events(Host, Node, Owner) -> ?DEBUG("Sending pending auth events for ~s on ~s:~s", [exmpp_jid:to_list(Owner), Host, node_to_string(Node)]), Action = - fun(#pubsub_node{id = NodeID, type = Type}) -> + fun(#pubsub_node{idx = Nidx, type = Type}) -> case lists:member("get-pending", features(Type)) of true -> - case node_call(Type, get_affiliation, [NodeID, Owner]) of + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> - node_call(Type, get_node_subscriptions, [NodeID]); + node_call(Type, get_node_subscriptions, [Nidx]); _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')} end; @@ -1518,7 +1521,7 @@ send_pending_auth_events(Host, Node, Owner) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {N, Subscriptions}} -> - lists:foreach(fun({J, pending, _SubID}) -> + lists:foreach(fun({J, pending, _SubId}) -> {U, S, R} = J, send_authorization_request(N, exmpp_jid:make(U,S,R)); ({J, pending}) -> @@ -1534,7 +1537,7 @@ send_pending_auth_events(Host, Node, Owner) -> %%% authorization handling -send_authorization_request(#pubsub_node{owners = Owners, nodeid = {Host, Node}}, Subscriber) -> +send_authorization_request(#pubsub_node{owners = Owners, id = {Host, Node}}, Subscriber) -> Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = @@ -1623,14 +1626,14 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> "true" -> true; _ -> false end, - Action = fun(#pubsub_node{type = Type, owners = Owners, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, owners = Owners, idx = Nidx}) -> IsApprover = lists:member(jlib:short_prepd_bare_jid(From), Owners), - {result, Subscriptions} = node_call(Type, get_subscriptions, [NodeId, Subscriber]), + {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> {error, 'forbidden'}; true -> - update_auth(Host, SNode, Type, NodeId, + update_auth(Host, SNode, Type, Nidx, Subscriber, Allow, Subscriptions) end @@ -1650,19 +1653,19 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> exmpp_stanza:reply_with_error(Packet, 'not-acceptable')) end. -update_auth(Host, Node, Type, NodeId, Subscriber, +update_auth(Host, Node, Type, Nidx, Subscriber, Allow, Subscriptions) -> Subscription = lists:filter(fun({pending, _}) -> true; (_) -> false end, Subscriptions), case Subscription of - [{pending, SubID}] -> %% TODO does not work if several pending + [{pending, SubId}] -> %% TODO does not work if several pending NewSubscription = case Allow of true -> subscribed; false -> none end, node_call(Type, set_subscriptions, - [NodeId, Subscriber, NewSubscription, SubID]), + [Nidx, Subscriber, NewSubscription, SubId]), send_authorization_approval(Host, Subscriber, Node, NewSubscription), {result, ok}; @@ -1734,8 +1737,8 @@ update_auth(Host, Node, Type, NodeId, Subscriber, %%
  • The service does not support node creation.
    • %%
  • Only entities that are registered with the service are allowed to create nodes but the requesting entity is not registered.
    • %%
  • The requesting entity does not have sufficient privileges to create nodes.
    • -%%
  • The requested NodeID already exists.
    • -%%
  • The request did not include a NodeID and "instant nodes" are not supported.
    • +%%
  • The requested NodeId already exists.
    • +%%
  • The request did not include a NodeId and "instant nodes" are not supported.
    • %% %%

    ote: node creation is a particular case, error return code is evaluated at many places:

    %%
      @@ -1861,8 +1864,8 @@ delete_node(_Host, <<>>, _Owner) -> %% Node is the root {error, 'not-allowed'}; delete_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, Owner]) of + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> ParentTree = tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]), SubsByDepth = [{Depth, [{N, get_node_subs(N)} || N <- Nodes]} || {Depth, Nodes} <- ParentTree], @@ -1880,12 +1883,12 @@ delete_node(Host, Node, Owner) -> case transaction(Host, Node, Action, transaction) of {result, {_, {SubsByDepth, {Result, broadcast, Removed}}}} -> lists:foreach(fun({RNode, _RSubscriptions}) -> - {RH, RN} = RNode#pubsub_node.nodeid, - NodeId = RNode#pubsub_node.id, + {RH, RN} = RNode#pubsub_node.id, + Nidx = RNode#pubsub_node.idx, Type = RNode#pubsub_node.type, Options = RNode#pubsub_node.options, - broadcast_removed_node(RH, RN, NodeId, Type, Options, SubsByDepth), - unset_cached_item(RH, NodeId) + broadcast_removed_node(RH, RN, Nidx, Type, Options, SubsByDepth), + unset_cached_item(RH, Nidx) end, Removed), case Result of default -> {result, Reply}; @@ -1937,7 +1940,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> _:_ -> {undefined, undefined, undefined} end, - Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, idx = Nidx}) -> Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), @@ -1962,7 +1965,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> {error, extended_error('bad-request', "invalid-options")}; true -> node_call(Type, subscribe_node, - [NodeId, From, Subscriber, + [Nidx, From, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, SubOpts]) @@ -1984,9 +1987,9 @@ subscribe_node(Host, Node, From, JID, Configuration) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, subscribed, SubId, send_last}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, - send_items(Host, Node, NodeId, Type, Subscriber, last), + send_items(Host, Node, Nidx, Type, Subscriber, last), notify_owners(get_option(TNode#pubsub_node.options, notify_sub), Subscriber, Host, Node, TNode#pubsub_node.owners, "subscribed"), case Result of default -> {result, Reply({subscribed, SubId})}; @@ -2037,8 +2040,8 @@ unsubscribe_node(Host, Node, From, JID, SubId) when is_list(JID) -> end, unsubscribe_node(Host, Node, From, Subscriber, SubId); unsubscribe_node(Host, Node, From, Subscriber, SubId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, unsubscribe_node, [NodeId, From, Subscriber, SubId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, unsubscribe_node, [Nidx, From, Subscriber, SubId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, default}} -> @@ -2069,7 +2072,7 @@ publish_item(Host, ServerHost, Node, Publisher, "", Payload) -> %% if publisher does not specify an ItemId, the service MUST generate the ItemId publish_item(Host, ServerHost, Node, Publisher, uniqid(), Payload); publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PublishFeature = lists:member("publish", Features), PublishModel = get_option(Options, publish_model), @@ -2107,7 +2110,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> %% Publisher attempts to publish to persistent node with no item {error, extended_error('bad-request', "item-required")}; true -> - node_call(Type, publish_item, [NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload]) + node_call(Type, publish_item, [Nidx, Publisher, PublishModel, MaxItems, ItemId, Payload]) end end, ServerHostB = list_to_binary(ServerHost), @@ -2117,7 +2120,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> [#xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId)}]}]}, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, Broadcast, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, BroadcastPayload = case Broadcast of @@ -2125,25 +2128,25 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> broadcast -> Payload; PluginPayload -> PluginPayload end, - broadcast_publish_item(Host, Node, NodeId, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_publish_item(Host, Node, Nidx, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), case Result of default -> {result, Reply}; _ -> {result, Result} end; {result, {TNode, {default, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Reply}; {result, {TNode, {Result, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Result}; {result, {_, default}} -> {result, Reply}; @@ -2189,7 +2192,7 @@ delete_item(_, "", _, _, _) -> %% Request does not specify a node {error, extended_error('bad-request', "node-required")}; delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PersistentFeature = lists:member("persistent-items", Features), DeleteFeature = lists:member("delete-items", Features), @@ -2205,18 +2208,18 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %% Service does not support item deletion {error, extended_error('feature-not-implemented', unsupported, "delete-items")}; true -> - node_call(Type, delete_item, [NodeId, Publisher, PublishModel, ItemId]) + node_call(Type, delete_item, [Nidx, Publisher, PublishModel, ItemId]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, [ItemId], ForceNotify), - case get_cached_item(Host, NodeId) of - #pubsub_item{itemid = {ItemId, NodeId}, _ = '_'} -> unset_cached_item(Host, NodeId); + broadcast_retract_items(Host, Node, Nidx, Type, Options, [ItemId], ForceNotify), + case get_cached_item(Host, Nidx) of + #pubsub_item{id = {ItemId, Nidx}, _ = '_'} -> unset_cached_item(Host, Nidx); _ -> ok end, case Result of @@ -2246,7 +2249,7 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %%
    • The specified node does not exist.
      • %%
    purge_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PurgeFeature = lists:member("purge-nodes", Features), PersistentFeature = lists:member("persistent-items", Features), @@ -2262,17 +2265,17 @@ purge_node(Host, Node, Owner) -> %% Node is not configured for persistent items {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> - node_call(Type, purge_node, [NodeId, Owner]) + node_call(Type, purge_node, [Nidx, Owner]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_purge_node(Host, Node, NodeId, Type, Options), - unset_cached_item(Host, NodeId), + broadcast_purge_node(Host, Node, Nidx, Type, Options), + unset_cached_item(Host, Nidx), case Result of default -> {result, Reply}; _ -> {result, Result} @@ -2290,7 +2293,7 @@ purge_node(Host, Node, Owner) -> %%

    The permission are not checked in this function.

    %% @todo We probably need to check that the user doing the query has the right %% to read the items. -get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> +get_items(Host, Node, From, SubId, SMaxItems, ItemIds) -> MaxItems = if SMaxItems == "" -> get_max_items_node(Host); @@ -2304,7 +2307,7 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> {error, Error} -> {error, Error}; _ -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId, owners = Owners}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx, owners = Owners}) -> Features = features(Type), RetreiveFeature = lists:member("retrieve-items", Features), PersistentFeature = lists:member("persistent-items", Features), @@ -2320,19 +2323,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> node_call(Type, get_items, - [NodeId, From, + [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, SubId]) end end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> - SendItems = case ItemIDs of + SendItems = case ItemIds of [] -> Items; _ -> - lists:filter(fun(#pubsub_item{itemid = {ItemId, _}}) -> - lists:member(ItemId, ItemIDs) + lists:filter(fun(#pubsub_item{id = {ItemId, _}}) -> + lists:member(ItemId, ItemIds) end, Items) end, %% Generate the XML response (Item list), limiting the @@ -2344,17 +2347,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> Error end end. + get_items(Host, Node) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_items, [NodeId, service_jid(Host)]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; Error -> Error end. + get_item(Host, Node, ItemId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_item, [NodeId, ItemId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_item, [Nidx, ItemId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; @@ -2431,7 +2436,7 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> {ok, Affiliations} -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, Node}}, Affiliation}) -> + ({#pubsub_node{id = {_, Node}}, Affiliation}) -> [#xmlel{ns = ?NS_PUBSUB, name = 'affiliation', attrs = [?XMLATTR('node', node_to_string(Node)), ?XMLATTR('affiliation', affiliation_to_string(Affiliation))]}] @@ -2443,10 +2448,10 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> Error end; get_affiliations(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("modify-affiliations", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support modify affiliations @@ -2455,7 +2460,7 @@ get_affiliations(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_affiliations, [NodeId]) + node_call(Type, get_node_affiliations, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2507,7 +2512,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> error -> {error, 'bad-request'}; _ -> - Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}=N) -> + Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}=N) -> case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), @@ -2517,7 +2522,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end, lists:foreach( fun({JID, Affiliation}) -> - {result, _} = node_call(Type, set_affiliation, [NodeId, JID, Affiliation]), + {result, _} = node_call(Type, set_affiliation, [Nidx, JID, Affiliation]), case Affiliation of owner -> NewOwner = jlib:short_prepd_bare_jid(JID), @@ -2547,11 +2552,11 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end end. -get_options(Host, Node, JID, SubID, Lang) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +get_options(Host, Node, JID, SubId, Lang) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - get_options_helper(JID, Lang, Node, NodeID, SubID, Type); + get_options_helper(JID, Lang, Node, Nidx, SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2563,7 +2568,7 @@ get_options(Host, Node, JID, SubID, Lang) -> Error -> Error end. -get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> +get_options_helper(JID, Lang, Node, NodeId, SubId, Type) -> Subscriber = try exmpp_jid:parse(JID) of J -> jlib:short_jid(J) catch @@ -2571,43 +2576,43 @@ get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - read_sub(Subscriber, Node, NodeID, SID, Lang); + read_sub(Subscriber, Node, NodeId, SID, Lang); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - read_sub(Subscriber, Node, NodeID, SubID, Lang) + read_sub(Subscriber, Node, NodeId, SubId, Lang) end. -read_sub(Subscriber, Node, NodeID, SubID, Lang) -> - case pubsub_subscription:get_subscription(Subscriber, NodeID, SubID) of +read_sub(Subscriber, Node, NodeId, SubId, Lang) -> + case pubsub_subscription:get_subscription(Subscriber, NodeId, SubId) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, #pubsub_subscription{options = Options}} -> {result, XdataEl} = pubsub_subscription:get_options_xform(Lang, Options), OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), - ?XMLATTR('subid', SubID) | nodeAttr(Node)], + ?XMLATTR('subid', SubId) | nodeAttr(Node)], children = [XdataEl]}, PubsubEl = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [OptionsEl]}, {result, PubsubEl} end. -set_options(Host, Node, JID, SubID, Configuration) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +set_options(Host, Node, JID, SubId, Configuration) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - set_options_helper(Configuration, JID, NodeID, - SubID, Type); + set_options_helper(Configuration, JID, Nidx, + SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2619,7 +2624,7 @@ set_options(Host, Node, JID, SubID, Configuration) -> Error -> Error end. -set_options_helper(Configuration, JID, NodeID, SubID, Type) -> +set_options_helper(Configuration, JID, NodeId, SubId, Type) -> SubOpts = case pubsub_subscription:parse_options_xform(Configuration) of {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid @@ -2630,27 +2635,27 @@ set_options_helper(Configuration, JID, NodeID, SubID, Type) -> _ -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - write_sub(Subscriber, NodeID, SID, SubOpts); + write_sub(Subscriber, NodeId, SID, SubOpts); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - write_sub(Subscriber, NodeID, SubID, SubOpts) + write_sub(Subscriber, NodeId, SubId, SubOpts) end. -write_sub(_Subscriber, _NodeID, _SubID, invalid) -> +write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; -write_sub(Subscriber, NodeID, SubID, Options) -> - case pubsub_subscription:set_subscription(Subscriber, NodeID, SubID, Options) of +write_sub(Subscriber, NodeId, SubId, Options) -> + case pubsub_subscription:set_subscription(Subscriber, NodeId, SubId, Options) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> @@ -2685,7 +2690,7 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2699,22 +2704,22 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> end; ({_, none, _}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubID, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubId, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name='subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription)) | nodeAttr(SubsNode)]}]; SubsNode -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription))]}]; _ -> [] end; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2736,10 +2741,10 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Error end. get_subscriptions(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("manage-subscriptions", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support manage subscriptions @@ -2748,7 +2753,7 @@ get_subscriptions(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_subscriptions, [NodeId]) + node_call(Type, get_node_subscriptions, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2824,12 +2829,12 @@ set_subscriptions(Host, Node, From, EntitiesEls) -> ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, - Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}) -> case lists:member(Owner, Owners) of true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> - case node_call(Type, set_subscriptions, [NodeId, JID, Subscription, SubId]) of + case node_call(Type, set_subscriptions, [Nidx, JID, Subscription, SubId]) of {error, Err} -> [{error, Err} | Acc]; _ -> Notify(JID, Subscription, SubId), Acc end @@ -3179,18 +3184,17 @@ get_collection_subscriptions(Host, Node) -> _ -> [] end. -get_node_subs(#pubsub_node{type = Type, - id = NodeID}) -> - case node_call(Type, get_node_subscriptions, [NodeID]) of - {result, Subs} -> get_options_for_subs(NodeID, Subs); +get_node_subs(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_node_subscriptions, [Nidx]) of + {result, Subs} -> get_options_for_subs(Nidx, Subs); Other -> Other end. -get_options_for_subs(NodeID, Subs) -> - lists:foldl(fun({JID, subscribed, SubID}, Acc) -> - case pubsub_subscription:read_subscription(JID, NodeID, SubID) of - {error, notfound} -> [{JID, SubID, []} | Acc]; - #pubsub_subscription{options = Options} -> [{JID, SubID, Options} | Acc]; +get_options_for_subs(Nidx, Subs) -> + lists:foldl(fun({JID, subscribed, SubId}, Acc) -> + case pubsub_subscription:read_subscription(JID, Nidx, SubId) of + {error, notfound} -> [{JID, SubId, []} | Acc]; + #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc end; (_, Acc) -> @@ -3224,8 +3228,8 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy MsgType -> add_message_type(BaseStanza, atom_to_list(MsgType)) end, %% Handles explicit subscriptions - SubIDsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), - lists:foreach(fun ({LJID, NodeName, SubIDs}) -> + SubIdsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), + lists:foreach(fun ({LJID, NodeName, SubIds}) -> LJIDs = case BroadcastAll of true -> {U, S, _} = LJID, @@ -3233,19 +3237,19 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy false -> [LJID] end, - %% Determine if the stanza should have SHIM ('SubID' and 'name') headers - StanzaToSend = case {SHIM, SubIDs} of + %% Determine if the stanza should have SHIM ('SubId' and 'name') headers + StanzaToSend = case {SHIM, SubIds} of {false, _} -> Stanza; {true, [_]} -> add_shim_headers(Stanza, collection_shim(NodeName)); - {true, SubIDs} -> - add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIDs))) + {true, SubIds} -> + add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIds))) end, lists:foreach(fun(To) -> ejabberd_router:route(From, exmpp_jid:make(To), StanzaToSend) end, LJIDs) - end, SubIDsByJID). + end, SubIdsByJID). broadcast_stanza({LUser, LServer, LResource}, Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM) -> broadcast_stanza({LUser, LServer, LResource}, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM), @@ -3296,12 +3300,12 @@ broadcast_stanza(Host, _Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> NodesToDeliver = fun(Depth, Node, Subs, Acc) -> - NodeName = case Node#pubsub_node.nodeid of + NodeName = case Node#pubsub_node.id of {_, N} -> N; Other -> Other end, NodeOptions = Node#pubsub_node.options, - lists:foldl(fun({LJID, SubID, SubOptions}, {JIDs, Recipients}) -> + lists:foldl(fun({LJID, SubId, SubOptions}, {JIDs, Recipients}) -> case is_to_deliver(LJID, NotifyType, Depth, NodeOptions, SubOptions) of true -> %% If is to deliver : @@ -3311,26 +3315,26 @@ subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> lists:foldl( fun(JIDToDeliver, {JIDsAcc, RecipientsAcc}) -> case lists:member(JIDToDeliver, JIDs) of - %% check if the JIDs co-accumulator contains the Subscription Jid, + %% check if the JIDs co-accumulator contains the Subscription JID, false -> %% - if not, - %% - add the Jid to JIDs list co-accumulator ; - %% - create a tuple of the Jid, NodeId, and SubID (as list), + %% - add the JID to JIDs list co-accumulator ; + %% - create a tuple of the JID, NodeId, and SubId (as list), %% and add the tuple to the Recipients list co-accumulator - {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubID]} | RecipientsAcc]}; + {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubId]} | RecipientsAcc]}; true -> - %% - if the JIDs co-accumulator contains the Jid - %% get the tuple containing the Jid from the Recipient list co-accumulator - {_, {JIDToDeliver, NodeName1, SubIDs}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), + %% - if the JIDs co-accumulator contains the JID + %% get the tuple containing the JID from the Recipient list co-accumulator + {_, {JIDToDeliver, NodeName1, SubIds}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), %% delete the tuple from the Recipients list % v1 : Recipients1 = lists:keydelete(LJID, 1, Recipients), - % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubID | SubIDs]}), - %% add the SubID to the SubIDs list in the tuple, + % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubId | SubIds]}), + %% add the SubId to the SubIds list in the tuple, %% and add the tuple back to the Recipients list co-accumulator - % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIDs, [SubID])}])} - % v1.2 : {JIDs, [{LJID, NodeId1, [SubID | SubIDs]} | Recipients1]} + % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIds, [SubId])}])} + % v1.2 : {JIDs, [{LJID, NodeId1, [SubId | SubIds]} | Recipients1]} % v2: {JIDs, Recipients1} - {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubID | SubIDs]})} + {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubId | SubIds]})} end end, {JIDs, Recipients}, JIDsToDeliver) end; @@ -3360,8 +3364,8 @@ user_resources(User, Server) -> get_configure(Host, ServerHost, Node, From, Lang) -> ServerHostB = list_to_binary(ServerHost), Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> Groups = ejabberd_hooks:run_fold(roster_groups, ServerHostB, [], [ServerHostB]), {result, @@ -3518,8 +3522,8 @@ set_configure(Host, Node, From, Els, Lang) -> {result, []}; "submit" -> Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId} = N) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx} = N) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> case jlib:parse_xdata_submit(XEl) of invalid -> @@ -3545,10 +3549,10 @@ set_configure(Host, Node, From, Els, Lang) -> end, case transaction(Host, Node, Action, transaction) of {result, {TNode, ok}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_config_notification(Host, Node, NodeId, Type, Options, Lang), + broadcast_config_notification(Host, Node, Nidx, Type, Options, Lang), {result, []}; Other -> Other @@ -3695,7 +3699,7 @@ get_cached_item(Host, NodeId) -> true -> case mnesia:dirty_read({pubsub_last_item, NodeId}) of [{pubsub_last_item, NodeId, ItemId, Creation, Payload}] -> - #pubsub_item{itemid = {ItemId, NodeId}, payload = Payload, + #pubsub_item{id = {ItemId, NodeId}, payload = Payload, creation = Creation, modification = Creation}; _ -> undefined @@ -3906,7 +3910,7 @@ itemAttr(ItemId) -> [?XMLATTR('id', ItemId)]. % build item elements from item list itemsEls(Items) -> - lists:map(fun(#pubsub_item{itemid = {ItemId, _}, payload = Payload}) -> + lists:map(fun(#pubsub_item{id = {ItemId, _}, payload = Payload}) -> #xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId), children = Payload} end, Items). @@ -3946,17 +3950,17 @@ collection_shim(Node) -> attrs = [?XMLATTR('name', <<"Collection">>)], children = [?XMLCDATA(node_to_string(Node))]}]. -subid_shim(SubIDs) -> +subid_shim(SubIds) -> [#xmlel{ns = ?NS_PUBSUB, name ='header', - attrs = [?XMLATTR('name', <<"SubID">>)], - children = [?XMLCDATA(SubID)]} - || SubID <- SubIDs]. + attrs = [?XMLATTR('name', <<"SubId">>)], + children = [?XMLCDATA(SubId)]} + || SubId <- SubIds]. -extended_headers(Jids) -> +extended_headers(JIDs) -> [#xmlel{ns = ?NS_ADDRESS, name = 'address', - attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', Jid)]} - || Jid <- Jids]. + attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', JID)]} + || JID <- JIDs]. feature_check_packet(allow, _User, Server, Pres, {From, _To, El}, in) -> Host = list_to_binary(host(Server)), @@ -4012,10 +4016,10 @@ purge_offline({User, Server, _} = LJID) -> case Result of {ok, Affiliations} -> lists:foreach( - fun({#pubsub_node{nodeid = {_, NodeId}, options = Options, type = Type}, Affiliation}) + fun({#pubsub_node{id = {_, NodeId}, options = Options, type = Type}, Affiliation}) when Affiliation == 'owner' orelse Affiliation == 'publisher' -> - Action = fun(#pubsub_node{type = NType, id = NodeIdx}) -> - node_call(NType, get_items, [NodeIdx, service_jid(Host)]) + Action = fun(#pubsub_node{type = NType, idx = Nidx}) -> + node_call(NType, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, NodeId, Action, sync_dirty) of {result, {_, []}} -> @@ -4031,7 +4035,7 @@ purge_offline({User, Server, _} = LJID) -> {true, true, true, true} -> ForceNotify = get_option(Options, notify_retract), lists:foreach( - fun(#pubsub_item{itemid = {ItemId, _}, modification = {_, Modification}}) -> + fun(#pubsub_item{id = {ItemId, _}, modification = {_, Modification}}) -> case Modification of {User, Server, _} -> delete_item(Host, NodeId, LJID, ItemId, ForceNotify); diff --git a/src/mod_pubsub/mod_pubsub_odbc.erl b/src/mod_pubsub/mod_pubsub_odbc.erl index e49971c03..003262583 100644 --- a/src/mod_pubsub/mod_pubsub_odbc.erl +++ b/src/mod_pubsub/mod_pubsub_odbc.erl @@ -281,13 +281,11 @@ init_nodes(Host, ServerHost, _NodeTree, Plugins) -> case lists:member("hometree_odbc", Plugins) of true -> create_node(Host, ServerHost, string_to_node("/home"), service_jid(Host), "hometree_odbc"), - create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); + create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); false -> ok end. - - send_loop(State) -> receive {presence, JID, Pid} -> @@ -305,10 +303,10 @@ send_loop(State) -> lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> - #pubsub_node{nodeid = {H, N}, type = Type, id = NodeId, options = Options} = Node, + #pubsub_node{id = {H, N}, type = Type, idx = Nidx, options = Options} = Node, case get_option(Options, send_last_published_item) of on_sub_and_presence -> - send_items(H, N, NodeId, Type, LJID, last); + send_items(H, N, Nidx, Type, LJID, last); _ -> ok end; @@ -358,7 +356,7 @@ send_loop(State) -> spawn(fun() -> Host = State#state.host, Owner = jlib:short_prepd_bare_jid(JID), - lists:foreach(fun(#pubsub_node{nodeid = {_, Node}, type = Type, id = NodeId, options = Options}) -> + lists:foreach(fun(#pubsub_node{id = {_, Node}, type = Type, idx = Nidx, options = Options}) -> case get_option(Options, send_last_published_item) of on_sub_and_presence -> lists:foreach(fun(Resource) -> @@ -373,7 +371,7 @@ send_loop(State) -> {OU, OS, _} = Owner, element(2, get_roster_info(OU, OS, LJID, Grps)) end, - if Subscribed -> send_items(Owner, Node, NodeId, Type, LJID, last); + if Subscribed -> send_items(Owner, Node, Nidx, Type, LJID, last); true -> ok end end, Resources); @@ -426,9 +424,9 @@ disco_identity(_Host, <<>>, _From) -> [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, @@ -458,9 +456,9 @@ disco_features(_Host, <<>>, _From) -> [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s | [?NS_PUBSUB_s ++ "#" ++ Feature || Feature <- features("pep")]]}; @@ -478,13 +476,13 @@ disco_sm_items({result, OtherItems}, From, To, Node, _Lang) -> {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> - Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx}, Acc) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx}, Acc) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('node', NodeID) | + ?XMLATTR('node', NodeId) | case get_option(Options, title) of false -> []; [Title] -> [?XMLATTR('title', Title)] @@ -499,15 +497,15 @@ disco_items(Host, <<>>, From) -> end; disco_items(Host, Node, From) -> - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('jid', exmpp_jid:to_binary(Host)), - ?XMLATTR('name', ItemID)]} - || #pubsub_item{itemid = {ItemID,_}} <- Items]}; + ?XMLATTR('name', ItemId)]} + || #pubsub_item{id = {ItemId,_}} <- Items]}; _ -> {result, []} end end, @@ -537,6 +535,7 @@ presence_probe(Peer, JID, Pid) -> presence(Host, {presence, User, Server, [Resource], JID}) end end. + presence(ServerHost, Presence) when is_binary(ServerHost) -> presence(binary_to_list(ServerHost), Presence); presence(ServerHost, Presence) -> @@ -585,12 +584,12 @@ unsubscribe_user(Entity, Owner) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{options = Options, id = NodeId}, subscribed, _, JID}) -> + ({#pubsub_node{options = Options, idx = Nidx}, subscribed, _, JID}) -> case get_option(Options, access_model) of presence -> - case lists:member(BJID, node_owners(Host, PType, NodeId)) of + case lists:member(BJID, node_owners(Host, PType, Nidx)) of true -> - node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]); + node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> {result, ok} end; @@ -621,13 +620,13 @@ remove_user(UserB, ServerB) -> lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{id = NodeId}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]) + ({#pubsub_node{idx = Nidx}, _, _, JID}) -> node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]) end, Subscriptions), {result, Affiliations} = node_action(Host, PType, get_entity_affiliations, [Host, Entity]), lists:foreach(fun - ({#pubsub_node{nodeid = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); - ({#pubsub_node{nodeid = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); - ({#pubsub_node{id = NodeId}, publisher}) -> node_action(Host, PType, set_affiliation, [NodeId, Entity, none]); + ({#pubsub_node{id = {H, N}, parents = []}, owner}) -> delete_node(H, N, Entity); + ({#pubsub_node{id = {H, N}, type = "hometree"}, owner}) when N == HomeTreeBase -> delete_node(H, N, Entity); + ({#pubsub_node{idx = Nidx}, publisher}) -> node_action(Host, PType, set_affiliation, [Nidx, Entity, none]); (_) -> ok end, Affiliations) end, plugins(Host)) @@ -894,7 +893,7 @@ node_disco_info(Host, Node, From) -> node_disco_info(Host, Node, From, true, true). node_disco_info(Host, Node, From, Identity, Features) -> Action = - fun(#pubsub_node{type = Type, id = NodeId}) -> + fun(#pubsub_node{type = Type, idx = Nidx}) -> I = case Identity of false -> []; @@ -904,7 +903,7 @@ node_disco_info(Host, Node, From, Identity, Features) -> [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> - case node_call(Type, get_items, [NodeId, From, none]) of + case node_call(Type, get_items, [Nidx, From, none]) of {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] @@ -967,7 +966,7 @@ iq_disco_items(Host, [], From, _RSM) -> case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = Options}) -> + fun(#pubsub_node{id = {_, SubNode}, options = Options}) -> Attrs = case get_option(Options, title) of false -> @@ -994,18 +993,18 @@ iq_disco_items(_Host, ?NS_PUBSUB_GET_PENDING, _From, _RSM) -> {result, CommandItems}; iq_disco_items(Host, Item, From, RSM) -> case string:tokens(Item, "!") of - [_SNode, _ItemID] -> + [_SNode, _ItemId] -> {result, []}; [SNode] -> Node = string_to_node(SNode), - Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> - Owners = node_owners_call(Type, Idx), - {NodeItems, RsmOut} = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners, RSM) of + Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> + Owners = node_owners_call(Type, Nidx), + {NodeItems, RsmOut} = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners, RSM) of {result, R} -> R; _ -> {[], none} end, Nodes = lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = SubOptions}) -> + fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> Attrs = case get_option(SubOptions, title) of false -> @@ -1016,7 +1015,7 @@ iq_disco_items(Host, Item, From, RSM) -> #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = Attrs} end, tree_call(Host, get_subnodes, [Host, Node, From])), Items = lists:map( - fun(#pubsub_item{itemid = {RN, _}}) -> + fun(#pubsub_item{id = {RN, _}}) -> {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -1136,29 +1135,28 @@ iq_pubsub(Host, ServerHost, From, IQType, SubEl, Lang, Access, Plugins) -> {get, 'items'} -> MaxItems = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'max_items', ""), SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), - ItemIDs = lists:foldl(fun + ItemIds = lists:foldl(fun (#xmlel{name = 'item', attrs = ItemAttrs}, Acc) -> case exmpp_xml:get_attribute_from_list_as_list(ItemAttrs, 'id', "") of "" -> Acc; - ItemID -> [ItemID|Acc] + ItemId -> [ItemId|Acc] end; (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), - RSM = jlib:rsm_decode(SubEl), - get_items(Host, Node, From, SubId, MaxItems, ItemIDs, RSM); + get_items(Host, Node, From, SubId, MaxItems, ItemIds, jlib:rsm_decode(SubEl)); {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> get_affiliations(Host, From, Plugins); {get, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - get_options(Host, Node, JID, SubID, Lang); + get_options(Host, Node, JID, SubId, Lang); {set, 'options'} -> - SubID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), + SubId = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'subid', ""), JID = exmpp_xml:get_attribute_from_list_as_list(Attrs, 'jid', ""), - set_options(Host, Node, JID, SubID, Els); + set_options(Host, Node, JID, SubId, Els); _ -> {error, 'feature-not-implemented'} end; @@ -1317,12 +1315,12 @@ send_pending_auth_events(Host, Node, Owner) -> ?DEBUG("Sending pending auth events for ~s on ~s:~s", [exmpp_jid:to_list(Owner), Host, node_to_string(Node)]), Action = - fun(#pubsub_node{id = NodeID, type = Type}) -> + fun(#pubsub_node{idx = Nidx, type = Type}) -> case lists:member("get-pending", features(Type)) of true -> - case node_call(Type, get_affiliation, [NodeID, Owner]) of + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> - node_call(Type, get_node_subscriptions, [NodeID]); + node_call(Type, get_node_subscriptions, [Nidx]); _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')} end; @@ -1332,7 +1330,7 @@ send_pending_auth_events(Host, Node, Owner) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {N, Subscriptions}} -> - lists:foreach(fun({J, pending, _SubID}) -> + lists:foreach(fun({J, pending, _SubId}) -> {U, S, R} = J, send_authorization_request(N, exmpp_jid:make(U,S,R)); ({J, pending}) -> @@ -1348,7 +1346,7 @@ send_pending_auth_events(Host, Node, Owner) -> %%% authorization handling -send_authorization_request(#pubsub_node{nodeid = {Host, Node}, type = Type, id = NodeId}, Subscriber) -> +send_authorization_request(#pubsub_node{id = {Host, Node}, type = Type, idx = Nidx}, Subscriber) -> Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = @@ -1378,7 +1376,7 @@ send_authorization_request(#pubsub_node{nodeid = {Host, Node}, type = Type, id = lists:foreach(fun(Owner) -> {U, S, R} = Owner, ejabberd_router:route(service_jid(Host), exmpp_jid:make(U, S, R), Stanza) - end, node_owners(Host, Type, NodeId)). + end, node_owners(Host, Type, Nidx)). find_authorization_response(Packet) -> Els = Packet#xmlel.children, @@ -1437,14 +1435,14 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> "true" -> true; _ -> false end, - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, NodeId)), - {result, Subscriptions} = node_call(Type, get_subscriptions, [NodeId, Subscriber]), + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, Nidx)), + {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> {error, 'forbidden'}; true -> - update_auth(Host, SNode, Type, NodeId, + update_auth(Host, SNode, Type, Nidx, Subscriber, Allow, Subscriptions) end @@ -1464,19 +1462,19 @@ handle_authorization_response(Host, From, To, Packet, XFields) -> exmpp_stanza:reply_with_error(Packet, 'not-acceptable')) end. -update_auth(Host, Node, Type, NodeId, Subscriber, +update_auth(Host, Node, Type, Nidx, Subscriber, Allow, Subscriptions) -> Subscription = lists:filter(fun({pending, _}) -> true; (_) -> false end, Subscriptions), case Subscription of - [{pending, SubID}] -> %% TODO does not work if several pending + [{pending, SubId}] -> %% TODO does not work if several pending NewSubscription = case Allow of true -> subscribed; false -> none end, node_call(Type, set_subscriptions, - [NodeId, Subscriber, NewSubscription, SubID]), + [Nidx, Subscriber, NewSubscription, SubId]), send_authorization_approval(Host, Subscriber, Node, NewSubscription), {result, ok}; @@ -1548,8 +1546,8 @@ update_auth(Host, Node, Type, NodeId, Subscriber, %%
  • The service does not support node creation.
    • %%
  • Only entities that are registered with the service are allowed to create nodes but the requesting entity is not registered.
    • %%
  • The requesting entity does not have sufficient privileges to create nodes.
    • -%%
  • The requested NodeID already exists.
    • -%%
  • The request did not include a NodeID and "instant nodes" are not supported.
    • +%%
  • The requested NodeId already exists.
    • +%%
  • The request did not include a NodeId and "instant nodes" are not supported.
    • %% %%

    ote: node creation is a particular case, error return code is evaluated at many places:

    %%
      @@ -1675,8 +1673,8 @@ delete_node(_Host, <<>>, _Owner) -> %% Node is the root {error, 'not-allowed'}; delete_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, Owner]) of + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, Owner]) of {result, owner} -> ParentTree = tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]), SubsByDepth = [{Depth, [{N, get_node_subs(N)} || N <- Nodes]} || {Depth, Nodes} <- ParentTree], @@ -1694,12 +1692,12 @@ delete_node(Host, Node, Owner) -> case transaction(Host, Node, Action, transaction) of {result, {_, {SubsByDepth, {Result, broadcast, Removed}}}} -> lists:foreach(fun({RNode, _RSubscriptions}) -> - {RH, RN} = RNode#pubsub_node.nodeid, - NodeId = RNode#pubsub_node.id, + {RH, RN} = RNode#pubsub_node.id, + Nidx = RNode#pubsub_node.idx, Type = RNode#pubsub_node.type, Options = RNode#pubsub_node.options, - broadcast_removed_node(RH, RN, NodeId, Type, Options, SubsByDepth), - unset_cached_item(RH, NodeId) + broadcast_removed_node(RH, RN, Nidx, Type, Options, SubsByDepth), + unset_cached_item(RH, Nidx) end, Removed), case Result of default -> {result, Reply}; @@ -1751,7 +1749,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> _:_ -> {undefined, undefined, undefined} end, - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), @@ -1760,7 +1758,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> AccessModel = get_option(Options, access_model), SendLast = get_option(Options, send_last_published_item), AllowedGroups = get_option(Options, roster_groups_allowed, []), - Owners = node_owners_call(Type, NodeId), + Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, Subscriber, Owners, AccessModel, AllowedGroups), if not SubscribeFeature -> @@ -1777,7 +1775,7 @@ subscribe_node(Host, Node, From, JID, Configuration) -> {error, extended_error('bad-request', "invalid-options")}; true -> node_call(Type, subscribe_node, - [NodeId, From, Subscriber, + [Nidx, From, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, SubOpts]) @@ -1799,9 +1797,9 @@ subscribe_node(Host, Node, From, JID, Configuration) -> end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, subscribed, SubId, send_last}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, - send_items(Host, Node, NodeId, Type, Subscriber, last), + send_items(Host, Node, Nidx, Type, Subscriber, last), notify_owners(get_option(TNode#pubsub_node.options, notify_sub), Subscriber, Host, Node, TNode#pubsub_node.owners, "subscribed"), case Result of default -> {result, Reply({subscribed, SubId})}; @@ -1852,8 +1850,8 @@ unsubscribe_node(Host, Node, From, JID, SubId) when is_list(JID) -> end, unsubscribe_node(Host, Node, From, Subscriber, SubId); unsubscribe_node(Host, Node, From, Subscriber, SubId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, unsubscribe_node, [NodeId, From, Subscriber, SubId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, unsubscribe_node, [Nidx, From, Subscriber, SubId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, default}} -> @@ -1884,7 +1882,7 @@ publish_item(Host, ServerHost, Node, Publisher, "", Payload) -> %% if publisher does not specify an ItemId, the service MUST generate the ItemId publish_item(Host, ServerHost, Node, Publisher, uniqid(), Payload); publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PublishFeature = lists:member("publish", Features), PublishModel = get_option(Options, publish_model), @@ -1922,7 +1920,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> %% Publisher attempts to publish to persistent node with no item {error, extended_error('bad-request', "item-required")}; true -> - node_call(Type, publish_item, [NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload]) + node_call(Type, publish_item, [Nidx, Publisher, PublishModel, MaxItems, ItemId, Payload]) end end, ServerHostB = list_to_binary(ServerHost), @@ -1932,7 +1930,7 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> [#xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId)}]}]}, case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, Broadcast, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, BroadcastPayload = case Broadcast of @@ -1940,25 +1938,25 @@ publish_item(Host, ServerHost, Node, Publisher, ItemId, Payload) -> broadcast -> Payload; PluginPayload -> PluginPayload end, - broadcast_publish_item(Host, Node, NodeId, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_publish_item(Host, Node, Nidx, Type, Options, Removed, ItemId, jlib:short_prepd_jid(Publisher), BroadcastPayload), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), case Result of default -> {result, Reply}; _ -> {result, Result} end; {result, {TNode, {default, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Reply}; {result, {TNode, {Result, Removed}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, Removed), - set_cached_item(Host, NodeId, ItemId, Publisher, Payload), + broadcast_retract_items(Host, Node, Nidx, Type, Options, Removed), + set_cached_item(Host, Nidx, ItemId, Publisher, Payload), {result, Result}; {result, {_, default}} -> {result, Reply}; @@ -2004,7 +2002,7 @@ delete_item(_, "", _, _, _) -> %% Request does not specify a node {error, extended_error('bad-request', "node-required")}; delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PersistentFeature = lists:member("persistent-items", Features), DeleteFeature = lists:member("delete-items", Features), @@ -2020,18 +2018,18 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %% Service does not support item deletion {error, extended_error('feature-not-implemented', unsupported, "delete-items")}; true -> - node_call(Type, delete_item, [NodeId, Publisher, PublishModel, ItemId]) + node_call(Type, delete_item, [Nidx, Publisher, PublishModel, ItemId]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_retract_items(Host, Node, NodeId, Type, Options, [ItemId], ForceNotify), - case get_cached_item(Host, NodeId) of - #pubsub_item{itemid = {ItemId, NodeId}, _ = '_'} -> unset_cached_item(Host, NodeId); + broadcast_retract_items(Host, Node, Nidx, Type, Options, [ItemId], ForceNotify), + case get_cached_item(Host, Nidx) of + #pubsub_item{id = {ItemId, Nidx}, _ = '_'} -> unset_cached_item(Host, Nidx); _ -> ok end, case Result of @@ -2061,7 +2059,7 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> %%
    • The specified node does not exist.
      • %%
    purge_node(Host, Node, Owner) -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), PurgeFeature = lists:member("purge-nodes", Features), PersistentFeature = lists:member("persistent-items", Features), @@ -2077,17 +2075,17 @@ purge_node(Host, Node, Owner) -> %% Node is not configured for persistent items {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> - node_call(Type, purge_node, [NodeId, Owner]) + node_call(Type, purge_node, [Nidx, Owner]) end end, Reply = [], case transaction(Host, Node, Action, sync_dirty) of {result, {TNode, {Result, broadcast}}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_purge_node(Host, Node, NodeId, Type, Options), - unset_cached_item(Host, NodeId), + broadcast_purge_node(Host, Node, Nidx, Type, Options), + unset_cached_item(Host, Nidx), case Result of default -> {result, Reply}; _ -> {result, Result} @@ -2105,7 +2103,7 @@ purge_node(Host, Node, Owner) -> %%

    The permission are not checked in this function.

    %% @todo We probably need to check that the user doing the query has the right %% to read the items. -get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> +get_items(Host, Node, From, SubId, SMaxItems, ItemIds, RSM) -> MaxItems = if SMaxItems == "" -> get_max_items_node(Host); @@ -2119,13 +2117,13 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> {error, Error} -> {error, Error}; _ -> - Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), RetreiveFeature = lists:member("retrieve-items", Features), PersistentFeature = lists:member("persistent-items", Features), AccessModel = get_option(Options, access_model), AllowedGroups = get_option(Options, roster_groups_allowed, []), - Owners = node_owners_call(Type, NodeId), + Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), if not RetreiveFeature -> @@ -2136,19 +2134,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> {error, extended_error('feature-not-implemented', unsupported, "persistent-items")}; true -> node_call(Type, get_items, - [NodeId, From, + [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, SubId, RSM]) end end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items, RSMOut}} -> - SendItems = case ItemIDs of + SendItems = case ItemIds of [] -> Items; _ -> - lists:filter(fun(#pubsub_item{itemid = {ItemId, _}}) -> - lists:member(ItemId, ItemIDs) + lists:filter(fun(#pubsub_item{id = {ItemId, _}}) -> + lists:member(ItemId, ItemIds) end, Items) end, %% Generate the XML response (Item list), limiting the @@ -2160,17 +2158,19 @@ get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> Error end end. + get_items(Host, Node) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_items, [NodeId, service_jid(Host)]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; Error -> Error end. + get_item(Host, Node, ItemId) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - node_call(Type, get_item, [NodeId, ItemId]) + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + node_call(Type, get_item, [Nidx, ItemId]) end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Items}} -> Items; @@ -2271,7 +2271,7 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> {ok, Affiliations} -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, Node}}, Affiliation}) -> + ({#pubsub_node{id = {_, Node}}, Affiliation}) -> [#xmlel{ns = ?NS_PUBSUB, name = 'affiliation', attrs = [?XMLATTR('node', node_to_string(Node)), ?XMLATTR('affiliation', affiliation_to_string(Affiliation))]}] @@ -2283,10 +2283,10 @@ get_affiliations(Host, JID, Plugins) when is_list(Plugins) -> Error end; get_affiliations(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("modify-affiliations", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support modify affiliations @@ -2295,7 +2295,7 @@ get_affiliations(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_affiliations, [NodeId]) + node_call(Type, get_node_affiliations, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2347,8 +2347,8 @@ set_affiliations(Host, Node, From, EntitiesEls) -> error -> {error, 'bad-request'}; _ -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - Owners = node_owners_call(Type, NodeId), + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + Owners = node_owners_call(Type, Nidx), case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), @@ -2359,7 +2359,7 @@ set_affiliations(Host, Node, From, EntitiesEls) -> lists:foreach( fun({JID, Affiliation}) -> % TODO, check if nothing missing here about new owners - node_call(Type, set_affiliation, [NodeId, JID, Affiliation]) + node_call(Type, set_affiliation, [Nidx, JID, Affiliation]) end, FilteredEntities), {result, []}; _ -> @@ -2372,11 +2372,11 @@ set_affiliations(Host, Node, From, EntitiesEls) -> end end. -get_options(Host, Node, JID, SubID, Lang) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +get_options(Host, Node, JID, SubId, Lang) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - get_options_helper(JID, Lang, Node, NodeID, SubID, Type); + get_options_helper(JID, Lang, Node, Nidx, SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2388,7 +2388,7 @@ get_options(Host, Node, JID, SubID, Lang) -> Error -> Error end. -get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> +get_options_helper(JID, Lang, Node, NodeId, SubId, Type) -> Subscriber = try exmpp_jid:parse(JID) of J -> jlib:short_jid(J) catch @@ -2396,43 +2396,43 @@ get_options_helper(JID, Lang, Node, NodeID, SubID, Type) -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - read_sub(Subscriber, Node, NodeID, SID, Lang); + read_sub(Subscriber, Node, NodeId, SID, Lang); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - read_sub(Subscriber, Node, NodeID, SubID, Lang) + read_sub(Subscriber, Node, NodeId, SubId, Lang) end. -read_sub(Subscriber, Node, NodeID, SubID, Lang) -> - case pubsub_subscription_odbc:get_subscription(Subscriber, NodeID, SubID) of +read_sub(Subscriber, Node, NodeId, SubId, Lang) -> + case pubsub_subscription_odbc:get_subscription(Subscriber, NodeId, SubId) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, #pubsub_subscription{options = Options}} -> {result, XdataEl} = pubsub_subscription_odbc:get_options_xform(Lang, Options), OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), - ?XMLATTR('subid', SubID) | nodeAttr(Node)], + ?XMLATTR('subid', SubId) | nodeAttr(Node)], children = [XdataEl]}, PubsubEl = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [OptionsEl]}, {result, PubsubEl} end. -set_options(Host, Node, JID, SubID, Configuration) -> - Action = fun(#pubsub_node{type = Type, id = NodeID}) -> +set_options(Host, Node, JID, SubId, Configuration) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> case lists:member("subscription-options", features(Type)) of true -> - set_options_helper(Configuration, JID, NodeID, - SubID, Type); + set_options_helper(Configuration, JID, Nidx, + SubId, Type); false -> {error, extended_error( 'feature-not-implemented', @@ -2444,7 +2444,7 @@ set_options(Host, Node, JID, SubID, Configuration) -> Error -> Error end. -set_options_helper(Configuration, JID, NodeID, SubID, Type) -> +set_options_helper(Configuration, JID, NodeId, SubId, Type) -> SubOpts = case pubsub_subscription_odbc:parse_options_xform(Configuration) of {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid @@ -2455,27 +2455,27 @@ set_options_helper(Configuration, JID, NodeID, SubID, Type) -> _ -> exmpp_jid:make("", "", "") %% TODO, check if use <<>> instead of "" end, {result, Subs} = node_call(Type, get_subscriptions, - [NodeID, Subscriber]), - SubIDs = lists:foldl(fun({subscribed, SID}, Acc) -> + [NodeId, Subscriber]), + SubIds = lists:foldl(fun({subscribed, SID}, Acc) -> [SID | Acc]; (_, Acc) -> Acc end, [], Subs), - case {SubID, SubIDs} of + case {SubId, SubIds} of {_, []} -> {error, extended_error('not-acceptable', "not-subscribed")}; {[], [SID]} -> - write_sub(Subscriber, NodeID, SID, SubOpts); + write_sub(Subscriber, NodeId, SID, SubOpts); {[], _} -> {error, extended_error('not-acceptable', "subid-required")}; {_, _} -> - write_sub(Subscriber, NodeID, SubID, SubOpts) + write_sub(Subscriber, NodeId, SubId, SubOpts) end. -write_sub(_Subscriber, _NodeID, _SubID, invalid) -> +write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; -write_sub(Subscriber, NodeID, SubID, Options) -> - case pubsub_subscription_odbc:set_subscription(Subscriber, NodeID, SubID, Options) of +write_sub(Subscriber, NodeId, SubId, Options) -> + case pubsub_subscription_odbc:set_subscription(Subscriber, NodeId, SubId, Options) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> @@ -2510,7 +2510,7 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Entities = lists:flatmap( fun({_, none}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2524,22 +2524,22 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> end; ({_, none, _}) -> []; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubID, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubId, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name='subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription)) | nodeAttr(SubsNode)]}]; SubsNode -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = [?XMLATTR('jid', exmpp_jid:to_binary(SubJID)), - ?XMLATTR('subid', SubID), + ?XMLATTR('subid', SubId), ?XMLATTR('subscription', subscription_to_string(Subscription))]}]; _ -> [] end; - ({#pubsub_node{nodeid = {_, SubsNode}}, Subscription, SubJID}) -> + ({#pubsub_node{id = {_, SubsNode}}, Subscription, SubJID}) -> case Node of <<>> -> [#xmlel{ns = ?NS_PUBSUB, name = 'subscription', attrs = @@ -2561,10 +2561,10 @@ get_subscriptions(Host, Node, JID, Plugins) when is_list(Plugins) -> Error end. get_subscriptions(Host, Node, JID) -> - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> Features = features(Type), RetrieveFeature = lists:member("manage-subscriptions", Features), - {result, Affiliation} = node_call(Type, get_affiliation, [NodeId, JID]), + {result, Affiliation} = node_call(Type, get_affiliation, [Nidx, JID]), if not RetrieveFeature -> %% Service does not support manage subscriptions @@ -2573,7 +2573,7 @@ get_subscriptions(Host, Node, JID) -> %% Entity is not an owner {error, 'forbidden'}; true -> - node_call(Type, get_node_subscriptions, [NodeId]) + node_call(Type, get_node_subscriptions, [Nidx]) end end, case transaction(Host, Node, Action, sync_dirty) of @@ -2649,12 +2649,12 @@ set_subscriptions(Host, Node, From, EntitiesEls) -> ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, - Action = fun(#pubsub_node{type = Type, id = NodeId}) -> - case lists:member(Owner, node_owners_call(Type, NodeId)) of + Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> + case lists:member(Owner, node_owners_call(Type, Nidx)) of true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> - case node_call(Type, set_subscriptions, [NodeId, JID, Subscription, SubId]) of + case node_call(Type, set_subscriptions, [Nidx, JID, Subscription, SubId]) of {error, Err} -> [{error, Err} | Acc]; _ -> Notify(JID, Subscription, SubId), Acc end @@ -3004,18 +3004,17 @@ get_collection_subscriptions(Host, Node) -> _ -> [] end. -get_node_subs(#pubsub_node{type = Type, - id = NodeID}) -> - case node_call(Type, get_node_subscriptions, [NodeID]) of - {result, Subs} -> get_options_for_subs(NodeID, Subs); +get_node_subs(#pubsub_node{type = Type, idx = Nidx}) -> + case node_call(Type, get_node_subscriptions, [Nidx]) of + {result, Subs} -> get_options_for_subs(Nidx, Subs); Other -> Other end. -get_options_for_subs(NodeID, Subs) -> - lists:foldl(fun({JID, subscribed, SubID}, Acc) -> - case pubsub_subscription_odbc:get_subscription(JID, NodeID, SubID) of - {error, notfound} -> [{JID, SubID, []} | Acc]; - {result, #pubsub_subscription{options = Options}} -> [{JID, SubID, Options} | Acc]; +get_options_for_subs(Nidx, Subs) -> + lists:foldl(fun({JID, subscribed, SubId}, Acc) -> + case pubsub_subscription_odbc:read_subscription(JID, Nidx, SubId) of + {error, notfound} -> [{JID, SubId, []} | Acc]; + #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc end; (_, Acc) -> @@ -3049,8 +3048,8 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy MsgType -> add_message_type(BaseStanza, atom_to_list(MsgType)) end, %% Handles explicit subscriptions - SubIDsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), - lists:foreach(fun ({LJID, NodeName, SubIDs}) -> + SubIdsByJID = subscribed_nodes_by_jid(NotifyType, SubsByDepth), + lists:foreach(fun ({LJID, NodeName, SubIds}) -> LJIDs = case BroadcastAll of true -> {U, S, _} = LJID, @@ -3058,19 +3057,19 @@ broadcast_stanza(Host, _Node, _NodeId, _Type, NodeOptions, SubsByDepth, NotifyTy false -> [LJID] end, - %% Determine if the stanza should have SHIM ('SubID' and 'name') headers - StanzaToSend = case {SHIM, SubIDs} of + %% Determine if the stanza should have SHIM ('SubId' and 'name') headers + StanzaToSend = case {SHIM, SubIds} of {false, _} -> Stanza; {true, [_]} -> add_shim_headers(Stanza, collection_shim(NodeName)); - {true, SubIDs} -> - add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIDs))) + {true, SubIds} -> + add_shim_headers(Stanza, lists:append(collection_shim(NodeName), subid_shim(SubIds))) end, lists:foreach(fun(To) -> ejabberd_router:route(From, exmpp_jid:make(To), StanzaToSend) end, LJIDs) - end, SubIDsByJID). + end, SubIdsByJID). broadcast_stanza({LUser, LServer, LResource}, Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM) -> broadcast_stanza({LUser, LServer, LResource}, Node, NodeId, Type, NodeOptions, SubsByDepth, NotifyType, BaseStanza, SHIM), @@ -3121,12 +3120,12 @@ broadcast_stanza(Host, _Publisher, Node, NodeId, Type, NodeOptions, SubsByDepth, subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> NodesToDeliver = fun(Depth, Node, Subs, Acc) -> - NodeName = case Node#pubsub_node.nodeid of + NodeName = case Node#pubsub_node.id of {_, N} -> N; Other -> Other end, NodeOptions = Node#pubsub_node.options, - lists:foldl(fun({LJID, SubID, SubOptions}, {JIDs, Recipients}) -> + lists:foldl(fun({LJID, SubId, SubOptions}, {JIDs, Recipients}) -> case is_to_deliver(LJID, NotifyType, Depth, NodeOptions, SubOptions) of true -> %% If is to deliver : @@ -3136,26 +3135,26 @@ subscribed_nodes_by_jid(NotifyType, SubsByDepth) -> lists:foldl( fun(JIDToDeliver, {JIDsAcc, RecipientsAcc}) -> case lists:member(JIDToDeliver, JIDs) of - %% check if the JIDs co-accumulator contains the Subscription Jid, + %% check if the JIDs co-accumulator contains the Subscription JID, false -> %% - if not, - %% - add the Jid to JIDs list co-accumulator ; - %% - create a tuple of the Jid, NodeId, and SubID (as list), + %% - add the JID to JIDs list co-accumulator ; + %% - create a tuple of the JID, NodeId, and SubId (as list), %% and add the tuple to the Recipients list co-accumulator - {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubID]} | RecipientsAcc]}; + {[JIDToDeliver | JIDsAcc], [{JIDToDeliver, NodeName, [SubId]} | RecipientsAcc]}; true -> - %% - if the JIDs co-accumulator contains the Jid - %% get the tuple containing the Jid from the Recipient list co-accumulator - {_, {JIDToDeliver, NodeName1, SubIDs}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), + %% - if the JIDs co-accumulator contains the JID + %% get the tuple containing the JID from the Recipient list co-accumulator + {_, {JIDToDeliver, NodeName1, SubIds}} = lists:keysearch(JIDToDeliver, 1, RecipientsAcc), %% delete the tuple from the Recipients list % v1 : Recipients1 = lists:keydelete(LJID, 1, Recipients), - % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubID | SubIDs]}), - %% add the SubID to the SubIDs list in the tuple, + % v2 : Recipients1 = lists:keyreplace(LJID, 1, Recipients, {LJID, NodeId1, [SubId | SubIds]}), + %% add the SubId to the SubIds list in the tuple, %% and add the tuple back to the Recipients list co-accumulator - % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIDs, [SubID])}])} - % v1.2 : {JIDs, [{LJID, NodeId1, [SubID | SubIDs]} | Recipients1]} + % v1.1 : {JIDs, lists:append(Recipients1, [{LJID, NodeId1, lists:append(SubIds, [SubId])}])} + % v1.2 : {JIDs, [{LJID, NodeId1, [SubId | SubIds]} | Recipients1]} % v2: {JIDs, Recipients1} - {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubID | SubIDs]})} + {JIDsAcc, lists:keyreplace(JIDToDeliver, 1, RecipientsAcc, {JIDToDeliver, NodeName1, [SubId | SubIds]})} end end, {JIDs, Recipients}, JIDsToDeliver) end; @@ -3185,8 +3184,8 @@ user_resources(User, Server) -> get_configure(Host, ServerHost, Node, From, Lang) -> ServerHostB = list_to_binary(ServerHost), Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> Groups = ejabberd_hooks:run_fold(roster_groups, ServerHostB, [], [ServerHostB]), {result, @@ -3367,8 +3366,8 @@ set_configure(Host, Node, From, Els, Lang) -> {result, []}; "submit" -> Action = - fun(#pubsub_node{options = Options, type = Type, id = NodeId} = N) -> - case node_call(Type, get_affiliation, [NodeId, From]) of + fun(#pubsub_node{options = Options, type = Type, idx = Nidx} = N) -> + case node_call(Type, get_affiliation, [Nidx, From]) of {result, owner} -> case jlib:parse_xdata_submit(XEl) of invalid -> @@ -3394,10 +3393,10 @@ set_configure(Host, Node, From, Els, Lang) -> end, case transaction(Host, Node, Action, transaction) of {result, {TNode, ok}} -> - NodeId = TNode#pubsub_node.id, + Nidx = TNode#pubsub_node.idx, Type = TNode#pubsub_node.type, Options = TNode#pubsub_node.options, - broadcast_config_notification(Host, Node, NodeId, Type, Options, Lang), + broadcast_config_notification(Host, Node, Nidx, Type, Options, Lang), {result, []}; Other -> Other @@ -3544,7 +3543,7 @@ get_cached_item(Host, NodeId) -> true -> case mnesia:dirty_read({pubsub_last_item, NodeId}) of [{pubsub_last_item, NodeId, ItemId, Creation, Payload}] -> - #pubsub_item{itemid = {ItemId, NodeId}, payload = Payload, + #pubsub_item{id = {ItemId, NodeId}, payload = Payload, creation = Creation, modification = Creation}; _ -> undefined @@ -3787,7 +3786,7 @@ itemAttr(ItemId) -> [?XMLATTR('id', ItemId)]. % build item elements from item list itemsEls(Items) -> - lists:map(fun(#pubsub_item{itemid = {ItemId, _}, payload = Payload}) -> + lists:map(fun(#pubsub_item{id = {ItemId, _}, payload = Payload}) -> #xmlel{ns = ?NS_PUBSUB, name = 'item', attrs = itemAttr(ItemId), children = Payload} end, Items). @@ -3827,17 +3826,17 @@ collection_shim(Node) -> attrs = [?XMLATTR('name', <<"Collection">>)], children = [?XMLCDATA(node_to_string(Node))]}]. -subid_shim(SubIDs) -> +subid_shim(SubIds) -> [#xmlel{ns = ?NS_PUBSUB, name ='header', - attrs = [?XMLATTR('name', <<"SubID">>)], - children = [?XMLCDATA(SubID)]} - || SubID <- SubIDs]. + attrs = [?XMLATTR('name', <<"SubId">>)], + children = [?XMLCDATA(SubId)]} + || SubId <- SubIds]. -extended_headers(Jids) -> +extended_headers(JIDs) -> [#xmlel{ns = ?NS_ADDRESS, name = 'address', - attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', Jid)]} - || Jid <- Jids]. + attrs = [?XMLATTR('type', <<"replyto">>), ?XMLATTR('jid', JID)]} + || JID <- JIDs]. feature_check_packet(allow, _User, Server, Pres, {From, _To, El}, in) -> Host = list_to_binary(host(Server)), @@ -3893,10 +3892,10 @@ purge_offline({User, Server, _} = LJID) -> case Result of {ok, Affiliations} -> lists:foreach( - fun({#pubsub_node{nodeid = {_, NodeId}, options = Options, type = Type}, Affiliation}) + fun({#pubsub_node{id = {_, NodeId}, options = Options, type = Type}, Affiliation}) when Affiliation == 'owner' orelse Affiliation == 'publisher' -> - Action = fun(#pubsub_node{type = NType, id = NodeIdx}) -> - node_call(NType, get_items, [NodeIdx, service_jid(Host)]) + Action = fun(#pubsub_node{type = NType, idx = Nidx}) -> + node_call(NType, get_items, [Nidx, service_jid(Host)]) end, case transaction(Host, NodeId, Action, sync_dirty) of {result, {_, []}} -> @@ -3912,7 +3911,7 @@ purge_offline({User, Server, _} = LJID) -> {true, true, true, true} -> ForceNotify = get_option(Options, notify_retract), lists:foreach( - fun(#pubsub_item{itemid = {ItemId, _}, modification = {_, Modification}}) -> + fun(#pubsub_item{id = {ItemId, _}, modification = {_, Modification}}) -> case Modification of {User, Server, _} -> delete_item(Host, NodeId, LJID, ItemId, ForceNotify); diff --git a/src/mod_pubsub/node.template b/src/mod_pubsub/node.template index 0efe75418..f1a9ed557 100644 --- a/src/mod_pubsub/node.template +++ b/src/mod_pubsub/node.template @@ -123,8 +123,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_buddy.erl b/src/mod_pubsub/node_buddy.erl index 78af0a00e..202abcfcb 100644 --- a/src/mod_pubsub/node_buddy.erl +++ b/src/mod_pubsub/node_buddy.erl @@ -130,8 +130,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_club.erl b/src/mod_pubsub/node_club.erl index a8988819f..9dc4f202e 100644 --- a/src/mod_pubsub/node_club.erl +++ b/src/mod_pubsub/node_club.erl @@ -128,8 +128,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_dag.erl b/src/mod_pubsub/node_dag.erl index 768e50cbd..29db20103 100644 --- a/src/mod_pubsub/node_dag.erl +++ b/src/mod_pubsub/node_dag.erl @@ -73,33 +73,33 @@ create_node_permission(_Host, _ServerHost, _Node, _ParentNode, _Owner, _Access) -> {result, true}. -create_node(NodeID, Owner) -> - node_flat:create_node(NodeID, Owner). +create_node(NodeId, Owner) -> + node_flat:create_node(NodeId, Owner). delete_node(Removed) -> node_flat:delete_node(Removed). -subscribe_node(NodeID, Sender, Subscriber, AccessModel, +subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> - node_flat:subscribe_node(NodeID, Sender, Subscriber, AccessModel, + node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeID, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeID, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). -publish_item(NodeID, Publisher, Model, MaxItems, ItemID, Payload) -> +publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> %% TODO: should look up the NodeTree plugin here. There's no %% access to the Host of the request at this level, so for now we %% just use nodetree_dag. - case nodetree_dag:get_node(NodeID) of + case nodetree_dag:get_node(NodeId) of #pubsub_node{options = Options} -> case find_opt(node_type, Options) of collection -> {error, mod_pubsub:extended_error('not-allowed', "publish")}; _ -> - node_flat:publish_item(NodeID, Publisher, Model, - MaxItems, ItemID, Payload) + node_flat:publish_item(NodeId, Publisher, Model, + MaxItems, ItemId, Payload) end; Err -> Err @@ -109,72 +109,72 @@ find_opt(_, []) -> false; find_opt(Option, [{Option, Value} | _]) -> Value; find_opt(Option, [_ | T]) -> find_opt(Option, T). -remove_extra_items(NodeID, MaxItems, ItemIDs) -> - node_flat:remove_extra_items(NodeID, MaxItems, ItemIDs). +remove_extra_items(NodeId, MaxItems, ItemIds) -> + node_flat:remove_extra_items(NodeId, MaxItems, ItemIds). -delete_item(NodeID, Publisher, PublishModel, ItemID) -> - node_flat:delete_item(NodeID, Publisher, PublishModel, ItemID). +delete_item(NodeId, Publisher, PublishModel, ItemId) -> + node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId). -purge_node(NodeID, Owner) -> - node_flat:purge_node(NodeID, Owner). +purge_node(NodeId, Owner) -> + node_flat:purge_node(NodeId, Owner). get_entity_affiliations(Host, Owner) -> node_flat:get_entity_affiliations(Host, Owner). -get_node_affiliations(NodeID) -> - node_flat:get_node_affiliations(NodeID). +get_node_affiliations(NodeId) -> + node_flat:get_node_affiliations(NodeId). -get_affiliation(NodeID, Owner) -> - node_flat:get_affiliation(NodeID, Owner). +get_affiliation(NodeId, Owner) -> + node_flat:get_affiliation(NodeId, Owner). -set_affiliation(NodeID, Owner, Affiliation) -> - node_flat:set_affiliation(NodeID, Owner, Affiliation). +set_affiliation(NodeId, Owner, Affiliation) -> + node_flat:set_affiliation(NodeId, Owner, Affiliation). get_entity_subscriptions(Host, Owner) -> node_flat:get_entity_subscriptions(Host, Owner). -get_node_subscriptions(NodeID) -> - node_flat:get_node_subscriptions(NodeID). +get_node_subscriptions(NodeId) -> + node_flat:get_node_subscriptions(NodeId). -get_subscriptions(NodeID, Owner) -> - node_flat:get_subscriptions(NodeID, Owner). +get_subscriptions(NodeId, Owner) -> + node_flat:get_subscriptions(NodeId, Owner). -set_subscriptions(NodeID, Owner, Subscription, SubID) -> - node_flat:set_subscriptions(NodeID, Owner, Subscription, SubID). +set_subscriptions(NodeId, Owner, Subscription, SubId) -> + node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId). get_pending_nodes(Host, Owner) -> node_flat:get_pending_nodes(Host, Owner). -get_states(NodeID) -> - node_flat:get_states(NodeID). +get_states(NodeId) -> + node_flat:get_states(NodeId). -get_state(NodeID, JID) -> - node_flat:get_state(NodeID, JID). +get_state(NodeId, JID) -> + node_flat:get_state(NodeId, JID). set_state(State) -> node_flat:set_state(State). -get_items(NodeID, From) -> - node_flat:get_items(NodeID, From). +get_items(NodeId, From) -> + node_flat:get_items(NodeId, From). -get_items(NodeID, JID, AccessModel, PresenceSubscription, - RosterGroup, SubID) -> - node_flat:get_items(NodeID, JID, AccessModel, PresenceSubscription, - RosterGroup, SubID). +get_items(NodeId, JID, AccessModel, PresenceSubscription, + RosterGroup, SubId) -> + node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, + RosterGroup, SubId). -get_item(NodeID, ItemID) -> - node_flat:get_item(NodeID, ItemID). +get_item(NodeId, ItemId) -> + node_flat:get_item(NodeId, ItemId). -get_item(NodeID, ItemID, JID, AccessModel, PresenceSubscription, - RosterGroup, SubID) -> - node_flat:get_item(NodeID, ItemID, JID, AccessModel, - PresenceSubscription, RosterGroup, SubID). +get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, + RosterGroup, SubId) -> + node_flat:get_item(NodeId, ItemId, JID, AccessModel, + PresenceSubscription, RosterGroup, SubId). set_item(Item) -> node_flat:set_item(Item). -get_item_name(Host, Node, ID) -> - node_flat:get_item_name(Host, Node, ID). +get_item_name(Host, Node, ItemId) -> + node_flat:get_item_name(Host, Node, ItemId). node_to_path(Node) -> node_flat:node_to_path(Node). diff --git a/src/mod_pubsub/node_dispatch.erl b/src/mod_pubsub/node_dispatch.erl index 1876d0c06..2c1ad3565 100644 --- a/src/mod_pubsub/node_dispatch.erl +++ b/src/mod_pubsub/node_dispatch.erl @@ -126,13 +126,13 @@ subscribe_node(_NodeId, _Sender, _Subscriber, _AccessModel, _SendLast, _PresenceSubscription, _RosterGroup, _Options) -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')}. -unsubscribe_node(_NodeId, _Sender, _Subscriber, _SubID) -> +unsubscribe_node(_NodeId, _Sender, _Subscriber, _SubId) -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')}. publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> lists:foreach(fun(SubNode) -> node_flat:publish_item( - SubNode#pubsub_node.id, Publisher, Model, + SubNode#pubsub_node.idx, Publisher, Model, MaxItems, ItemId, Payload) end, nodetree_tree:get_subnodes(NodeId, Publisher, Publisher)). diff --git a/src/mod_pubsub/node_flat.erl b/src/mod_pubsub/node_flat.erl index 985bc9421..b44d7bd6f 100644 --- a/src/mod_pubsub/node_flat.erl +++ b/src/mod_pubsub/node_flat.erl @@ -195,30 +195,30 @@ create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> %% @spec (NodeId, Owner) -> %% {result, Result} | exit -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() %% @doc

    create_node(NodeId, Owner) -> OwnerKey = jlib:short_prepd_bare_jid(Owner), - set_state(#pubsub_state{stateid = {OwnerKey, NodeId}, affiliation = owner}), + set_state(#pubsub_state{id = {OwnerKey, NodeId}, affiliation = owner}), {result, {default, broadcast}}. %% @spec (Removed) -> ok -%% Removed = [mod_pubsub:pubsubNode()] +%% Removed = [mod_pubsub:pubsub_node()] %% @doc

    purge items of deleted nodes after effective deletion.

    delete_node(Removed) -> - Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) -> + Tr = fun(#pubsub_state{id = {J, _}, subscriptions = Ss}) -> lists:map(fun(S) -> {J, S} end, Ss) end, Reply = lists:map( - fun(#pubsub_node{id = NodeId} = PubsubNode) -> - {result, States} = get_states(NodeId), + fun(#pubsub_node{idx = Nidx} = PubsubNode) -> + {result, States} = get_states(Nidx), lists:foreach( - fun(#pubsub_state{stateid = {LJID, _}, items = Items}) -> - del_items(NodeId, Items), - del_state(NodeId, LJID) + fun(#pubsub_state{id = {LJID, _}, items = Items}) -> + del_items(Nidx, Items), + del_state(Nidx, LJID) end, States), {PubsubNode, lists:flatmap(Tr, States)} end, Removed), @@ -321,9 +321,9 @@ subscribe_node(NodeId, Sender, {U,S,R} = Subscriber, AccessModel, %% @spec (NodeId, Sender, Subscriber, SubId) -> %% {error, Reason} | {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Sender = mod_pubsub:jid() -%% Subscriber = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Sender = ljid() +%% Subscriber = ljid() %% SubId = mod_pubsub:subid() %% Reason = mod_pubsub:stanzaError() %% @doc

    Unsubscribe the Subscriber from the Node.

    @@ -399,11 +399,11 @@ delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) -> %% @spec (NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% {true, PubsubItem} | {result, Reply} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() %% MaxItems = integer() -%% ItemId = string() +%% ItemId = item() %% Payload = term() %% @doc

    Publishes the item passed as parameter.

    %%

    The mechanism works as follow: @@ -465,7 +465,7 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> OldItem#pubsub_item{modification = PubId, payload = Payload}; _ -> - #pubsub_item{itemid = {ItemId, NodeId}, + #pubsub_item{id = {ItemId, NodeId}, creation = {Now, GenKey}, modification = PubId, payload = Payload} @@ -481,7 +481,7 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> end. %% @spec (NodeId, MaxItems, ItemIds) -> {NewItemIds,OldItemIds} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% MaxItems = integer() | unlimited %% ItemIds = [ItemId::string()] %% NewItemIds = [ItemId::string()] @@ -508,10 +508,10 @@ remove_extra_items(NodeId, MaxItems, ItemIds) -> %% @spec (NodeId, Publisher, PublishModel, ItemId) -> %% {error, Reason::stanzaError()} | %% {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() -%% ItemId = string() +%% ItemId = item() %% @doc

    Triggers item deletion.

    %%

    Default plugin: The user performing the deletion must be the node owner %% or a publisher, or PublishModel being open.

    @@ -563,8 +563,8 @@ delete_item(NodeId, Publisher, PublishModel, ItemId) -> %% @spec (NodeId, Owner) -> %% {error, Reason::stanzaError()} | %% {result, {default, broadcast}} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() purge_node(NodeId, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), GenState = get_state(NodeId, GenKey), @@ -586,7 +586,7 @@ purge_node(NodeId, Owner) -> %% @spec (Host, JID) -> [{Node,Affiliation}] %% Host = host() -%% JID = mod_pubsub:jid() +%% JID = ljid() %% @doc

    Return the current affiliations for the given user

    %%

    The default module reads affiliations in the main Mnesia %% pubsub_state table. If a plugin stores its data in the same @@ -596,14 +596,14 @@ purge_node(NodeId, Owner) -> %% pubsub_state table.

    get_entity_affiliations(Host, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}), + States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, _ = '_'}), NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) -> + Reply = lists:foldl(fun(#pubsub_state{id = {_, N}, affiliation = A}, Acc) -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {Host, _}} = Node -> [{Node, A}|Acc]; + #pubsub_node{id = {Host, _}} = Node -> [{Node, A}|Acc]; _ -> Acc end end, [], States), @@ -611,7 +611,7 @@ get_entity_affiliations(Host, Owner) -> get_node_affiliations(NodeId) -> {result, States} = get_states(NodeId), - Tr = fun(#pubsub_state{stateid = {J, _}, affiliation = A}) -> + Tr = fun(#pubsub_state{id = {J, _}, affiliation = A}) -> {J, A} end, {result, lists:map(Tr, States)}. @@ -633,7 +633,7 @@ set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> %% @spec (Host, Owner) -> [{Node,Subscription}] %% Host = host() -%% Owner = mod_pubsub:jid() +%% Owner = ljid() %% @doc

    Return the current subscriptions for the given user

    %%

    The default module reads subscriptions in the main Mnesia %% pubsub_state table. If a plugin stores its data in the same @@ -646,19 +646,19 @@ get_entity_subscriptions(Host, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), States = case SubKey of GenKey -> mnesia:match_object( - #pubsub_state{stateid = {{U, D, '_'}, '_'}, _ = '_'}); + #pubsub_state{id = {{U, D, '_'}, '_'}, _ = '_'}); _ -> mnesia:match_object( - #pubsub_state{stateid = {GenKey, '_'}, _ = '_'}) + #pubsub_state{id = {GenKey, '_'}, _ = '_'}) ++ mnesia:match_object( - #pubsub_state{stateid = {SubKey, '_'}, _ = '_'}) + #pubsub_state{id = {SubKey, '_'}, _ = '_'}) end, NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) -> + Reply = lists:foldl(fun(#pubsub_state{id = {J, N}, subscriptions = Ss}, Acc) -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {Host, _}} = Node -> + #pubsub_node{id = {Host, _}} = Node -> lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, J} | Acc2]; (S, Acc2) -> @@ -671,7 +671,7 @@ get_entity_subscriptions(Host, Owner) -> get_node_subscriptions(NodeId) -> {result, States} = get_states(NodeId), - Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Subscriptions}) -> + Tr = fun(#pubsub_state{id = {J, _}, subscriptions = Subscriptions}) -> %% TODO: get rid of cases to handle non-list subscriptions case Subscriptions of [_|_] -> @@ -723,8 +723,8 @@ replace_subscription(NewSub, SubState) -> replace_subscription(_, [], Acc) -> Acc; -replace_subscription({Sub, SubId}, [{_, SubID} | T], Acc) -> - replace_subscription({Sub, SubId}, T, [{Sub, SubID} | Acc]). +replace_subscription({Sub, SubId}, [{_, SubId} | T], Acc) -> + replace_subscription({Sub, SubId}, T, [{Sub, SubId} | Acc]). new_subscription(NodeId, Owner, Subscription, SubState) -> SubId = pubsub_subscription:add_subscription(Owner, NodeId, []), @@ -733,34 +733,34 @@ new_subscription(NodeId, Owner, Subscription, SubState) -> {Subscription, SubId}. unsub_with_subid(NodeId, SubId, SubState) -> - pubsub_subscription:delete_subscription(SubState#pubsub_state.stateid, + pubsub_subscription:delete_subscription(SubState#pubsub_state.id, NodeId, SubId), NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end, SubState#pubsub_state.subscriptions), case {NewSubs, SubState#pubsub_state.affiliation} of {[], none} -> - del_state(NodeId, element(1, SubState#pubsub_state.stateid)); + del_state(NodeId, element(1, SubState#pubsub_state.id)); _ -> set_state(SubState#pubsub_state{subscriptions = NewSubs}) end. %% @spec (Host, Owner) -> {result, [Node]} | {error, Reason} %% Host = host() %% Owner = jid() -%% Node = pubsubNode() +%% Node = node() %% @doc

    Returns a list of Owner's nodes on Host with pending %% subscriptions.

    get_pending_nodes(Host, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, + States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, affiliation = owner, _ = '_'}), - NodeIDs = [ID || #pubsub_state{stateid = {_, ID}} <- States], + Nidxs = [Nidx || #pubsub_state{id = {_, Nidx}} <- States], NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree end, - Reply = mnesia:foldl(fun(#pubsub_state{stateid = {_, NID}} = S, Acc) -> - case lists:member(NID, NodeIDs) of + Reply = mnesia:foldl(fun(#pubsub_state{id = {_, Nidx}} = S, Acc) -> + case lists:member(Nidx, Nidxs) of true -> case get_nodes_helper(NodeTree, S) of {value, Node} -> [Node | Acc]; @@ -773,7 +773,7 @@ get_pending_nodes(Host, Owner) -> {result, Reply}. get_nodes_helper(NodeTree, - #pubsub_state{stateid = {_, N}, subscriptions = Subs}) -> + #pubsub_state{id = {_, N}, subscriptions = Subs}) -> HasPending = fun ({pending, _}) -> true; (pending) -> true; (_) -> false @@ -781,7 +781,7 @@ get_nodes_helper(NodeTree, case lists:any(HasPending, Subs) of true -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {_, Node}} -> + #pubsub_node{id = {_, Node}} -> {value, Node}; _ -> false @@ -791,7 +791,7 @@ get_nodes_helper(NodeTree, end. %% @spec (NodeId) -> {result, [State] | []} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% State = mod_pubsub:pubsubState() %% @doc Returns the list of stored states for a given node. %%

    For the default PubSub module, states are stored in Mnesia database.

    @@ -805,26 +805,26 @@ get_nodes_helper(NodeTree, %% node_default:get_states(NodeId).'''

    get_states(NodeId) -> States = case catch mnesia:match_object( - #pubsub_state{stateid = {'_', NodeId}, _ = '_'}) of + #pubsub_state{id = {'_', NodeId}, _ = '_'}) of List when is_list(List) -> List; _ -> [] end, {result, States}. %% @spec (NodeId, JID) -> [State] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% JID = mod_pubsub:jid() -%% State = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% JID = ljid() +%% State = mod_pubsub:pubsub_item() %% @doc

    Returns a state (one state list), given its reference.

    get_state(NodeId, JID) -> StateId = {JID, NodeId}, case catch mnesia:read({pubsub_state, StateId}) of [State] when is_record(State, pubsub_state) -> State; - _ -> #pubsub_state{stateid=StateId} + _ -> #pubsub_state{id=StateId} end. %% @spec (State) -> ok | {error, Reason::stanzaError()} -%% State = mod_pubsub:pubsubStates() +%% State = mod_pubsub:pubsub_state() %% @doc

    Write a state into database.

    set_state(State) when is_record(State, pubsub_state) -> mnesia:write(State); @@ -832,14 +832,14 @@ set_state(_) -> {error, 'internal-server-error'}. %% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% @doc

    Delete a state from database.

    del_state(NodeId, JID) -> mnesia:delete({pubsub_state, {JID, NodeId}}). %% @spec (NodeId, From) -> [Items] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% Items = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% Items = mod_pubsub:pubsub_item() %% @doc Returns the list of stored items for a given node. %%

    For the default PubSub module, items are stored in Mnesia database.

    %%

    We can consider that the pubsub_item table have been created by the main @@ -851,7 +851,7 @@ del_state(NodeId, JID) -> %% ```get_items(NodeId, From) -> %% node_default:get_items(NodeId, From).'''

    get_items(NodeId, _From) -> - Items = mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'}), + Items = mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'}), {result, lists:reverse(lists:keysort(#pubsub_item.modification, Items))}. get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> SubKey = jlib:short_prepd_jid(JID), @@ -891,9 +891,9 @@ get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) - end. %% @spec (NodeId, ItemId) -> [Item] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() -%% Item = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% ItemId = item() +%% Item = mod_pubsub:pubsub_item() %% @doc

    Returns an item (one item list), given its reference.

    get_item(NodeId, ItemId) -> case mnesia:read({pubsub_item, {ItemId, NodeId}}) of @@ -912,7 +912,7 @@ get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _S %%SubId == "", ?? -> %% Entity has multiple subscriptions to the node but does not specify a subscription ID %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; - %%InvalidSubID -> + %%InvalidSubId -> %% Entity is subscribed but specifies an invalid subscription ID %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; Affiliation == outcast -> @@ -938,7 +938,7 @@ get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _S end. %% @spec (Item) -> ok | {error, Reason::stanzaError()} -%% Item = mod_pubsub:pubsubItems() +%% Item = mod_pubsub:pubsub_item() %% @doc

    Write an item into database.

    set_item(Item) when is_record(Item, pubsub_item) -> mnesia:write(Item); @@ -946,8 +946,8 @@ set_item(_) -> {error, 'internal-server-error'}. %% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() +%% NodeId = nodeidx() +%% ItemId = item() %% @doc

    Delete an item from database.

    del_item(NodeId, ItemId) -> mnesia:delete({pubsub_item, {ItemId, NodeId}}). diff --git a/src/mod_pubsub/node_flat_odbc.erl b/src/mod_pubsub/node_flat_odbc.erl index 2a15af325..6efe12be4 100644 --- a/src/mod_pubsub/node_flat_odbc.erl +++ b/src/mod_pubsub/node_flat_odbc.erl @@ -37,7 +37,7 @@ %%% development is still a work in progress. However, the system is already %%% useable and useful as is. Please, send us comments, feedback and %%% improvements.

    - +%%TODO : fix SQL requests with nodeid/id and id/idx changes -module(node_flat_odbc). -author('christophe.romain@process-one.net'). @@ -191,9 +191,9 @@ features() -> %% @spec (Host, ServerHost, Node, ParentNode, Owner, Access) -> bool() %% Host = mod_pubsub:host() %% ServerHost = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% ParentNode = mod_pubsub:pubsubNode() -%% Owner = mod_pubsub:jid() +%% Node = mod_pubsub:node() +%% ParentNode = mod_pubsub:node() +%% Owner = ljid() %% Access = all | atom() %% @doc Checks if the current user has the permission to create the requested node %%

    In {@link node_default}, the permission is decided by the place in the @@ -212,34 +212,27 @@ create_node_permission(Host, ServerHost, Node, ParentNode, Owner, Access) -> %% @spec (NodeId, Owner) -> %% {result, Result} | exit -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() %% @doc

    create_node(NodeId, Owner) -> OwnerKey = jlib:short_prepd_bare_jid(Owner), - State = #pubsub_state{stateid = {OwnerKey, NodeId}, affiliation = owner}, + State = #pubsub_state{id = {OwnerKey, NodeId}, affiliation = owner}, catch ejabberd_odbc:sql_query_t( ["insert into pubsub_state(nodeid, jid, affiliation, subscriptions) " "values(", state_to_raw(NodeId, State), ");"]), {result, {default, broadcast}}. %% @spec (Removed) -> ok -%% Removed = [mod_pubsub:pubsubNode()] +%% Removed = [mod_pubsub:node()] %% @doc

    purge items of deleted nodes after effective deletion.

    delete_node(Removed) -> -%% pablo: TODO, this is present on trunk/node_flat but not on trunk/node_flat_odbc. -%% check what is the desired behaviour -%% Tr = fun(#pubsub_state{stateid = {J, _}, subscriptions = Ss}) -> -%% lists:map(fun(S) -> -%% {J, S} -%% end, Ss) -%% end, Reply = lists:map( - fun(#pubsub_node{id = NodeId} = PubsubNode) -> + fun(#pubsub_node{idx = Nidx} = PubsubNode) -> Subscriptions = case catch ejabberd_odbc:sql_query_t( ["select jid, subscriptions " "from pubsub_state " - "where nodeid='", NodeId, ";"]) of + "where nodeid='", Nidx, ";"]) of {selected, ["jid", "subscriptions"], RItems} -> lists:map(fun({SJID, Subscriptions}) -> {decode_jid(SJID), decode_subscriptions(Subscriptions)} @@ -345,9 +338,9 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, %% @spec (NodeId, Sender, Subscriber, SubId) -> %% {error, Reason} | {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Sender = mod_pubsub:jid() -%% Subscriber = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Sender = ljid() +%% Subscriber = ljid() %% SubId = mod_pubsub:subid() %% Reason = mod_pubsub:stanzaError() %% @doc

    Unsubscribe the Subscriber from the Node.

    @@ -417,11 +410,11 @@ delete_subscription(SubKey, NodeId, {Subscription, SubId}, Affiliation, Subscrip %% @spec (NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% {true, PubsubItem} | {result, Reply} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() %% MaxItems = integer() -%% ItemId = string() +%% ItemId = item() %% Payload = term() %% @doc

    Publishes the item passed as parameter.

    %%

    The mechanism works as follow: @@ -474,7 +467,7 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% Note: this works cause set_item tries an update before %% the insert, and the update just ignore creation field. PubId = {now(), SubKey}, - set_item(#pubsub_item{itemid = {ItemId, NodeId}, + set_item(#pubsub_item{id = {ItemId, NodeId}, creation = {now(), GenKey}, modification = PubId, payload = Payload}), @@ -488,10 +481,10 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> end. %% @spec (NodeId, MaxItems, ItemIds) -> {NewItemIds,OldItemIds} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% MaxItems = integer() | unlimited -%% ItemIds = [ItemId::string()] -%% NewItemIds = [ItemId::string()] +%% ItemIds = [item()] +%% NewItemIds = [item()] %% @doc

    This function is used to remove extra items, most notably when the %% maximum number of items has been reached.

    %%

    This function is used internally by the core PubSub module, as no @@ -515,10 +508,10 @@ remove_extra_items(NodeId, MaxItems, ItemIds) -> %% @spec (NodeId, Publisher, PublishModel, ItemId) -> %% {error, Reason::stanzaError()} | %% {result, []} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Publisher = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Publisher = ljid() %% PublishModel = atom() -%% ItemId = string() +%% ItemId = item() %% @doc

    Triggers item deletion.

    %%

    Default plugin: The user performing the deletion must be the node owner %% or a publisher, or PublishModel being open.

    @@ -549,8 +542,8 @@ delete_item(NodeId, Publisher, PublishModel, ItemId) -> %% @spec (NodeId, Owner) -> %% {error, Reason::stanzaError()} | %% {result, {default, broadcast}} -%% NodeId = mod_pubsub:pubsubNodeId() -%% Owner = mod_pubsub:jid() +%% NodeId = nodeidx() +%% Owner = ljid() purge_node(NodeId, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), GenState = get_state(NodeId, GenKey), @@ -569,7 +562,7 @@ purge_node(NodeId, Owner) -> %% @spec (Host, JID) -> [{Node,Affiliation}] %% Host = host() -%% JID = mod_pubsub:jid() +%% JID = ljid() %% @doc

    Return the current affiliations for the given user

    %%

    The default module reads affiliations in the main Mnesia %% pubsub_state table. If a plugin stores its data in the same @@ -632,7 +625,7 @@ set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> %% @spec (Host, Owner) -> [{Node,Subscription}] %% Host = host() -%% Owner = mod_pubsub:jid() +%% Owner = ljid() %% @doc

    Return the current subscriptions for the given user

    %%

    The default module reads subscriptions in the main Mnesia %% pubsub_state table. If a plugin stores its data in the same @@ -664,13 +657,13 @@ get_entity_subscriptions(Host, Owner) -> {selected, ["node", "type", "nodeid", "jid", "subscriptions"], RItems} -> lists:foldl(fun({N, T, I, J, S}, Acc) -> Node = nodetree_tree_odbc:raw_to_node(Host, {N, "", T, I}), - Jid = decode_jid(J), + JID = decode_jid(J), case decode_subscriptions(S) of [] -> - [{Node, none, Jid}|Acc]; + [{Node, none, JID}|Acc]; Subs -> - lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, Jid}|Acc2]; - (Sub, Acc2) -> [{Node, Sub, Jid}|Acc2] + lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, JID}|Acc2]; + (Sub, Acc2) -> [{Node, Sub, JID}|Acc2] end, Acc, Subs) end end, [], RItems); @@ -707,13 +700,13 @@ get_entity_subscriptions_for_send_last(Host, Owner) -> {selected, ["node", "type", "nodeid", "jid", "subscriptions"], RItems} -> lists:foldl(fun({N, T, I, J, S}, Acc) -> Node = nodetree_tree_odbc:raw_to_node(Host, {N, "", T, I}), - Jid = decode_jid(J), + JID = decode_jid(J), case decode_subscriptions(S) of [] -> - [{Node, none, Jid}|Acc]; + [{Node, none, JID}|Acc]; Subs -> - lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, Jid}|Acc2]; - (Sub, Acc2) -> [{Node, Sub, Jid}|Acc2] + lists:foldl(fun({Sub, SubId}, Acc2) -> [{Node, Sub, SubId, JID}|Acc2]; + (Sub, Acc2) -> [{Node, Sub, JID}|Acc2] end, Acc, Subs) end end, [], RItems); @@ -729,13 +722,13 @@ get_node_subscriptions(NodeId) -> "where nodeid='", NodeId, "';"]) of {selected, ["jid", "subscriptions"], RItems} -> lists:foldl(fun({J, S}, Acc) -> - Jid = decode_jid(J), + JID = decode_jid(J), case decode_subscriptions(S) of [] -> - [{Jid, none}|Acc]; + [{JID, none}|Acc]; Subs -> - lists:foldl(fun({Sub, SubId}, Acc2) -> [{Jid, Sub, SubId}|Acc2]; - (Sub, Acc2) -> [{Jid, Sub}|Acc2] + lists:foldl(fun({Sub, SubId}, Acc2) -> [{JID, Sub, SubId}|Acc2]; + (Sub, Acc2) -> [{JID, Sub}|Acc2] end, Acc, Subs) end end, [], RItems); @@ -786,8 +779,8 @@ replace_subscription(NewSub, SubState) -> replace_subscription(_, [], Acc) -> Acc; -replace_subscription({Sub, SubId}, [{_, SubID} | T], Acc) -> - replace_subscription({Sub, SubId}, T, [{Sub, SubID} | Acc]). +replace_subscription({Sub, SubId}, [{_, SubId} | T], Acc) -> + replace_subscription({Sub, SubId}, T, [{Sub, SubId} | Acc]). new_subscription(NodeId, Owner, Subscription, SubState) -> case pubsub_subscription_odbc:subscribe_node(Owner, NodeId, []) of @@ -800,13 +793,13 @@ new_subscription(NodeId, Owner, Subscription, SubState) -> end. unsub_with_subid(NodeId, SubId, SubState) -> - pubsub_subscription_odbc:unsubscribe_node(SubState#pubsub_state.stateid, + pubsub_subscription_odbc:unsubscribe_node(SubState#pubsub_state.id, NodeId, SubId), NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end, SubState#pubsub_state.subscriptions), case {NewSubs, SubState#pubsub_state.affiliation} of {[], none} -> - del_state(NodeId, element(1, SubState#pubsub_state.stateid)); + del_state(NodeId, element(1, SubState#pubsub_state.id)); _ -> set_state(SubState#pubsub_state{subscriptions = NewSubs}) end. @@ -814,21 +807,21 @@ unsub_with_subid(NodeId, SubId, SubState) -> %% @spec (Host, Owner) -> {result, [Node]} | {error, Reason} %% Host = host() %% Owner = jid() -%% Node = pubsubNode() +%% Node = node() %% @doc

    Returns a list of Owner's nodes on Host with pending %% subscriptions.

    get_pending_nodes(Host, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, + States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, affiliation = owner, _ = '_'}), - NodeIDs = [ID || #pubsub_state{stateid = {_, ID}} <- States], + Nidxs = [Nidx || #pubsub_state{id = {_, Nidx}} <- States], NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree_odbc end, - Reply = mnesia:foldl(fun(#pubsub_state{stateid = {_, NID}} = S, Acc) -> - case lists:member(NID, NodeIDs) of + Reply = mnesia:foldl(fun(#pubsub_state{id = {_, Nidx}} = S, Acc) -> + case lists:member(Nidx, Nidxs) of true -> case get_nodes_helper(NodeTree, S) of {value, Node} -> [Node | Acc]; @@ -841,7 +834,7 @@ get_pending_nodes(Host, Owner) -> {result, Reply}. get_nodes_helper(NodeTree, - #pubsub_state{stateid = {_, N}, subscriptions = Subs}) -> + #pubsub_state{id = {_, N}, subscriptions = Subs}) -> HasPending = fun ({pending, _}) -> true; (pending) -> true; (_) -> false @@ -849,7 +842,7 @@ get_nodes_helper(NodeTree, case lists:any(HasPending, Subs) of true -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {_, Node}} -> + #pubsub_node{id = {_, Node}} -> {value, Node}; _ -> false @@ -859,7 +852,7 @@ get_nodes_helper(NodeTree, end. %% @spec (NodeId) -> {result, [State] | []} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% State = mod_pubsub:pubsubState() %% @doc Returns the list of stored states for a given node. %%

    For the default PubSub module, states are stored in Mnesia database.

    @@ -878,7 +871,7 @@ get_states(NodeId) -> "where nodeid='", NodeId, "';"]) of {selected, ["jid", "affiliation", "subscriptions"], RItems} -> {result, lists:map(fun({SJID, Affiliation, Subscriptions}) -> - #pubsub_state{stateid = {decode_jid(SJID), NodeId}, + #pubsub_state{id = {decode_jid(SJID), NodeId}, items = itemids(NodeId, SJID), affiliation = decode_affiliation(Affiliation), subscriptions = decode_subscriptions(Subscriptions)} @@ -889,13 +882,13 @@ get_states(NodeId) -> %% @spec (NodeId, JID) -> [State] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% JID = mod_pubsub:jid() -%% State = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% JID = ljid() +%% State = mod_pubsub:pubsub_state() %% @doc

    Returns a state (one state list), given its reference.

    get_state(NodeId, JID) -> State = get_state_without_itemids(NodeId, JID), - {SJID, _} = State#pubsub_state.stateid, + {SJID, _} = State#pubsub_state.id, State#pubsub_state{items = itemids(NodeId, SJID)}. get_state_without_itemids(NodeId, JID) -> J = encode_jid(JID), @@ -905,25 +898,25 @@ get_state_without_itemids(NodeId, JID) -> "where jid='", J, "' " "and nodeid='", NodeId, "';"]) of {selected, ["jid", "affiliation", "subscriptions"], [{SJID, Affiliation, Subscriptions}]} -> - #pubsub_state{stateid = {decode_jid(SJID), NodeId}, + #pubsub_state{id = {decode_jid(SJID), NodeId}, affiliation = decode_affiliation(Affiliation), subscriptions = decode_subscriptions(Subscriptions)}; _ -> - #pubsub_state{stateid={JID, NodeId}} + #pubsub_state{id={JID, NodeId}} end. %% @spec (State) -> ok | {error, Reason::stanzaError()} %% State = mod_pubsub:pubsubStates() %% @doc

    Write a state into database.

    set_state(State) when is_record(State, pubsub_state) -> - {_, NodeId} = State#pubsub_state.stateid, + {_, NodeId} = State#pubsub_state.id, set_state(NodeId, State). set_state(NodeId, State) -> %% NOTE: in odbc version, as we do not handle item list, %% we just need to update affiliation and subscription %% cause {JID,NodeId} is the key. if it does not exists, then we insert it. %% MySQL can be optimized using INSERT ... ON DUPLICATE KEY as well - {JID, _} = State#pubsub_state.stateid, + {JID, _} = State#pubsub_state.id, J = encode_jid(JID), S = encode_subscriptions(State#pubsub_state.subscriptions), A = encode_affiliation(State#pubsub_state.affiliation), @@ -941,7 +934,7 @@ set_state(NodeId, State) -> {result, []}. %% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() +%% NodeId = nodeidx() %% @doc

    Delete a state from database.

    del_state(NodeId, JID) -> J = encode_jid(JID), @@ -952,8 +945,8 @@ del_state(NodeId, JID) -> ok. %% @spec (NodeId, From) -> {[Items], RsmOut} | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% Items = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% Items = mod_pubsub:pubsub_item() %% @doc Returns the list of stored items for a given node. %%

    For the default PubSub module, items are stored in Mnesia database.

    %%

    We can consider that the pubsub_item table have been created by the main @@ -1100,9 +1093,9 @@ get_last_items(NodeId, _From, Count) -> end. %% @spec (NodeId, ItemId) -> [Item] | [] -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() -%% Item = mod_pubsub:pubsubItems() +%% NodeId = nodeidx() +%% ItemId = item() +%% Item = mod_pubsub:pubsub_item() %% @doc

    Returns an item (one item list), given its reference.

    get_item(NodeId, ItemId) -> I = ?PUBSUB:escape(ItemId), @@ -1126,7 +1119,7 @@ get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _S %%SubId == "", ?? -> %% Entity has multiple subscriptions to the node but does not specify a subscription ID %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; - %%InvalidSubID -> + %%InvalidSubId -> %% Entity is subscribed but specifies an invalid subscription ID %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; Affiliation == outcast -> @@ -1152,10 +1145,10 @@ get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _S end. %% @spec (Item) -> ok | {error, Reason::stanzaError()} -%% Item = mod_pubsub:pubsubItems() +%% Item = mod_pubsub:pubsub_item() %% @doc

    Write an item into database.

    set_item(Item) -> - {ItemId, NodeId} = Item#pubsub_item.itemid, + {ItemId, NodeId} = Item#pubsub_item.id, I = ?PUBSUB:escape(ItemId), {C, _} = Item#pubsub_item.creation, {M, JID} = Item#pubsub_item.modification, @@ -1182,8 +1175,8 @@ set_item(Item) -> {result, []}. %% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()} -%% NodeId = mod_pubsub:pubsubNodeId() -%% ItemId = string() +%% NodeId = nodeidx() +%% ItemId = item() %% @doc

    Delete an item from database.

    del_item(NodeId, ItemId) -> I = ?PUBSUB:escape(ItemId), @@ -1337,7 +1330,7 @@ encode_subscriptions(Subscriptions) -> %%% record getter/setter state_to_raw(NodeId, State) -> - {JID, _} = State#pubsub_state.stateid, + {JID, _} = State#pubsub_state.id, J = encode_jid(JID), A = encode_affiliation(State#pubsub_state.affiliation), S = encode_subscriptions(State#pubsub_state.subscriptions), @@ -1353,7 +1346,7 @@ raw_to_item(NodeId, {ItemId, SJID, Creation, Modification, XML}) -> {error, _Reason} -> []; [El] -> [El] end, - #pubsub_item{itemid = {ItemId, NodeId}, + #pubsub_item{id = {ItemId, NodeId}, creation={ToTime(Creation), JID}, modification={ToTime(Modification), JID}, payload = Payload}. diff --git a/src/mod_pubsub/node_hometree.erl b/src/mod_pubsub/node_hometree.erl index 069f38599..34ec658d4 100644 --- a/src/mod_pubsub/node_hometree.erl +++ b/src/mod_pubsub/node_hometree.erl @@ -140,8 +140,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_hometree_odbc.erl b/src/mod_pubsub/node_hometree_odbc.erl index 2dd0503c5..ba5024822 100644 --- a/src/mod_pubsub/node_hometree_odbc.erl +++ b/src/mod_pubsub/node_hometree_odbc.erl @@ -111,8 +111,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat_odbc:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat_odbc:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_mb.erl b/src/mod_pubsub/node_mb.erl index 57d155558..41beab5d4 100644 --- a/src/mod_pubsub/node_mb.erl +++ b/src/mod_pubsub/node_mb.erl @@ -137,8 +137,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_pep:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_pep:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_pep:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_pep.erl b/src/mod_pubsub/node_pep.erl index 66522460b..a59fa9d57 100644 --- a/src/mod_pubsub/node_pep.erl +++ b/src/mod_pubsub/node_pep.erl @@ -156,8 +156,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - case node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + case node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId) of {error, Error} -> {error, Error}; {result, _} -> {result, []} end. @@ -177,14 +177,14 @@ purge_node(NodeId, Owner) -> get_entity_affiliations(_Host, Owner) -> {_, D, _} = jlib:short_prepd_jid(Owner), GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{stateid = {GenKey, '_'}, _ = '_'}), + States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, _ = '_'}), NodeTree = case catch ets:lookup(gen_mod:get_module_proc(D, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {_, N}, affiliation = A}, Acc) -> + Reply = lists:foldl(fun(#pubsub_state{id = {_, N}, affiliation = A}, Acc) -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {{_, D, _}, _}} = Node -> [{Node, A}|Acc]; + #pubsub_node{id = {{_, D, _}, _}} = Node -> [{Node, A}|Acc]; _ -> Acc end end, [], States), @@ -204,22 +204,22 @@ get_entity_subscriptions(_Host, Owner) -> GenKey = jlib:short_prepd_bare_jid(Owner), States = case SubKey of GenKey -> mnesia:match_object( - #pubsub_state{stateid = {{U, D, '_'}, '_'}, _ = '_'}); + #pubsub_state{id = {{U, D, '_'}, '_'}, _ = '_'}); _ -> mnesia:match_object( - #pubsub_state{stateid = {GenKey, '_'}, _ = '_'}) + #pubsub_state{id = {GenKey, '_'}, _ = '_'}) ++ mnesia:match_object( - #pubsub_state{stateid = {SubKey, '_'}, _ = '_'}) + #pubsub_state{id = {SubKey, '_'}, _ = '_'}) end, NodeTree = case catch ets:lookup(gen_mod:get_module_proc(D, config), nodetree) of [{nodetree, N}] -> N; _ -> nodetree_tree end, - Reply = lists:foldl(fun(#pubsub_state{stateid = {J, N}, subscriptions = Ss}, Acc) -> + Reply = lists:foldl(fun(#pubsub_state{id = {J, N}, subscriptions = Ss}, Acc) -> case NodeTree:get_node(N) of - #pubsub_node{nodeid = {{_, D, _}, _}} = Node -> - lists:foldl(fun({subscribed, SubID}, Acc2) -> - [{Node, subscribed, SubID, J} | Acc2]; - ({pending, _SubID}, Acc2) -> + #pubsub_node{id = {{_, D, _}, _}} = Node -> + lists:foldl(fun({subscribed, SubId}, Acc2) -> + [{Node, subscribed, SubId, J} | Acc2]; + ({pending, _SubId}, Acc2) -> [{Node, pending, J} | Acc2]; (S, Acc2) -> [{Node, S, J} | Acc2] diff --git a/src/mod_pubsub/node_pep_odbc.erl b/src/mod_pubsub/node_pep_odbc.erl index b567d9f19..c9c215548 100644 --- a/src/mod_pubsub/node_pep_odbc.erl +++ b/src/mod_pubsub/node_pep_odbc.erl @@ -25,7 +25,7 @@ %%% @doc The module {@module} is the pep PubSub plugin. %%%

    PubSub plugin nodes are using the {@link gen_pubsub_node} behaviour.

    - +%%TODO : fix SQL requests with nodeid/id and id/idx changes -module(node_pep_odbc). -author('christophe.romain@process-one.net'). @@ -163,8 +163,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - case node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubID) of +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + case node_flat_odbc:unsubscribe_node(NodeId, Sender, Subscriber, SubId) of {error, Error} -> {error, Error}; {result, _} -> {result, []} end. diff --git a/src/mod_pubsub/node_private.erl b/src/mod_pubsub/node_private.erl index cbde859e1..da8e90f8e 100644 --- a/src/mod_pubsub/node_private.erl +++ b/src/mod_pubsub/node_private.erl @@ -133,8 +133,8 @@ subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/node_public.erl b/src/mod_pubsub/node_public.erl index 720ab706b..2e0e96af0 100644 --- a/src/mod_pubsub/node_public.erl +++ b/src/mod_pubsub/node_public.erl @@ -130,8 +130,8 @@ delete_node(Removed) -> subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubID) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubID). +unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). diff --git a/src/mod_pubsub/nodetree_dag.erl b/src/mod_pubsub/nodetree_dag.erl index 6713720bc..f82353f53 100644 --- a/src/mod_pubsub/nodetree_dag.erl +++ b/src/mod_pubsub/nodetree_dag.erl @@ -58,26 +58,26 @@ init(Host, ServerHost, Opts) -> terminate(Host, ServerHost) -> nodetree_tree:terminate(Host, ServerHost). -create_node(Key, NodeID, Type, Owner, Options, Parents) -> +create_node(Key, Node, Type, Owner, Options, Parents) -> OwnerJID = jlib:short_prepd_bare_jid(Owner), - case find_node(Key, NodeID) of + case find_node(Key, Node) of false -> - ID = pubsub_index:new(node), - N = #pubsub_node{nodeid = oid(Key, NodeID), - id = ID, + Nidx = pubsub_index:new(node), + N = #pubsub_node{id = oid(Key, Node), + idx = Nidx, type = Type, - parents = Parents, + parents = Parents, owners = [OwnerJID], options = Options}, case set_node(N) of - ok -> {ok, ID}; + ok -> {ok, Nidx}; Other -> Other end; _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'conflict')} end. -set_node(#pubsub_node{nodeid = {Key, _}, +set_node(#pubsub_node{id = {Key, _}, owners = Owners, options = Options} = Node) -> Parents = find_opt(collection, ?DEFAULT_PARENTS, Options), @@ -89,43 +89,43 @@ set_node(#pubsub_node{nodeid = {Key, _}, Other end. -delete_node(Key, NodeID) -> - case find_node(Key, NodeID) of +delete_node(Key, Node) -> + case find_node(Key, Node) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - Node -> + Record -> %% Find all of N's children, update their configs to %% remove N from the collection setting. lists:foreach(fun (#pubsub_node{options = Opts} = Child) -> - NewOpts = remove_config_parent(NodeID, Opts), + NewOpts = remove_config_parent(Node, Opts), Parents = find_opt(collection, ?DEFAULT_PARENTS, NewOpts), ok = mnesia:write(pubsub_node, Child#pubsub_node{ parents = Parents, options = NewOpts}, write) - end, get_subnodes(Key, NodeID)), + end, get_subnodes(Key, Node)), %% Remove and return the requested node. - pubsub_index:free(node, Node#pubsub_node.id), - mnesia:delete_object(pubsub_node, Node, write), - [Node] + pubsub_index:free(node, Record#pubsub_node.idx), + mnesia:delete_object(pubsub_node, Record, write), + [Record] end. options() -> nodetree_tree:options(). -get_node(Host, NodeID, _From) -> - get_node(Host, NodeID). +get_node(Host, Node, _From) -> + get_node(Host, Node). -get_node(Host, NodeID) -> - case find_node(Host, NodeID) of +get_node(Host, Node) -> + case find_node(Host, Node) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - Node -> Node + Record -> Record end. -get_node(NodeId) -> - nodetree_tree:get_node(NodeId). +get_node(Node) -> + nodetree_tree:get_node(Node). get_nodes(Key, From) -> nodetree_tree:get_nodes(Key, From). @@ -133,49 +133,47 @@ get_nodes(Key, From) -> get_nodes(Key) -> nodetree_tree:get_nodes(Key). -get_parentnodes(Host, NodeID, _From) -> - case find_node(Host, NodeID) of +get_parentnodes(Host, Node, _From) -> + case find_node(Host, Node) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; #pubsub_node{parents = Parents} -> - Q = qlc:q([N || #pubsub_node{nodeid = {NHost, NNode}} = N <- mnesia:table(pubsub_node), + Q = qlc:q([N || #pubsub_node{id = {NHost, NNode}} = N <- mnesia:table(pubsub_node), Parent <- Parents, Host == NHost, Parent == NNode]), qlc:e(Q) end. -get_parentnodes_tree(Host, NodeID, _From) -> - Pred = fun (NID, #pubsub_node{nodeid = {_, NNodeID}}) -> - NID == NNodeID - end, +get_parentnodes_tree(Host, Node, _From) -> + Pred = fun (Name, #pubsub_node{id = {_, NodeName}}) -> Name == NodeName end, Tr = fun (#pubsub_node{parents = Parents}) -> Parents end, - traversal_helper(Pred, Tr, Host, [NodeID]). + traversal_helper(Pred, Tr, Host, [Node]). -get_subnodes(Host, NodeID, _From) -> - get_subnodes(Host, NodeID). +get_subnodes(Host, Node, _From) -> + get_subnodes(Host, Node). get_subnodes(Host, <<>>) -> get_subnodes_helper(Host, <<>>); -get_subnodes(Host, NodeID) -> - case find_node(Host, NodeID) of +get_subnodes(Host, Node) -> + case find_node(Host, Node) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - _ -> get_subnodes_helper(Host, NodeID) + _ -> get_subnodes_helper(Host, Node) end. -get_subnodes_helper(Host, NodeID) -> - Q = qlc:q([Node || #pubsub_node{nodeid = {NHost, _}, - parents = Parents} = Node <- mnesia:table(pubsub_node), +get_subnodes_helper(Host, Node) -> + Q = qlc:q([Record || #pubsub_node{id = {NHost, _}, + parents = Parents} = Record <- mnesia:table(pubsub_node), Host == NHost, - lists:member(NodeID, Parents)]), + lists:member(Node, Parents)]), qlc:e(Q). -get_subnodes_tree(Host, NodeID, From) -> - Pred = fun (NID, #pubsub_node{parents = Parents}) -> - lists:member(NID, Parents) +get_subnodes_tree(Host, Node, From) -> + Pred = fun (N, #pubsub_node{parents = Parents}) -> + lists:member(N, Parents) end, - Tr = fun (#pubsub_node{nodeid = {_, N}}) -> [N] end, - traversal_helper(Pred, Tr, 1, Host, [NodeID], - [{0, [get_node(Host, NodeID, From)]}]). + Tr = fun (#pubsub_node{id = {_, N}}) -> [N] end, + traversal_helper(Pred, Tr, 1, Host, [Node], + [{0, [get_node(Host, Node, From)]}]). %%==================================================================== %% Internal functions @@ -183,9 +181,9 @@ get_subnodes_tree(Host, NodeID, From) -> oid(Key, Name) -> {Key, Name}. %% Key = jlib:jid() | host() -%% NodeID = string() -find_node(Key, NodeID) -> - case mnesia:read(pubsub_node, oid(Key, NodeID), read) of +%% Node = string() +find_node(Key, Node) -> + case mnesia:read(pubsub_node, oid(Key, Node), read) of [] -> false; [Node] -> Node end. @@ -199,30 +197,30 @@ find_opt(Key, Default, Options) -> _ -> Default end. -traversal_helper(Pred, Tr, Host, NodeIDs) -> - traversal_helper(Pred, Tr, 0, Host, NodeIDs, []). +traversal_helper(Pred, Tr, Host, Nodes) -> + traversal_helper(Pred, Tr, 0, Host, Nodes, []). traversal_helper(_Pred, _Tr, _Depth, _Host, [], Acc) -> Acc; -traversal_helper(Pred, Tr, Depth, Host, NodeIDs, Acc) -> - Q = qlc:q([Node || #pubsub_node{nodeid = {NHost, _}} = Node <- mnesia:table(pubsub_node), - NodeID <- NodeIDs, +traversal_helper(Pred, Tr, Depth, Host, Nodes, Acc) -> + Q = qlc:q([Record || #pubsub_node{id = {NHost, _}} = Record <- mnesia:table(pubsub_node), + Node <- Nodes, Host == NHost, - Pred(NodeID, Node)]), + Pred(Node, Node)]), Nodes = qlc:e(Q), - IDs = lists:flatmap(Tr, Nodes), - traversal_helper(Pred, Tr, Depth + 1, Host, IDs, [{Depth, Nodes} | Acc]). + Names = lists:flatmap(Tr, Nodes), + traversal_helper(Pred, Tr, Depth + 1, Host, Names, [{Depth, Nodes} | Acc]). -remove_config_parent(NodeID, Options) -> - remove_config_parent(NodeID, Options, []). +remove_config_parent(Node, Options) -> + remove_config_parent(Node, Options, []). -remove_config_parent(_NodeID, [], Acc) -> +remove_config_parent(_Node, [], Acc) -> lists:reverse(Acc); -remove_config_parent(NodeID, [{collection, Parents} | T], Acc) -> - remove_config_parent(NodeID, T, - [{collection, lists:delete(NodeID, Parents)} | Acc]); -remove_config_parent(NodeID, [H | T], Acc) -> - remove_config_parent(NodeID, T, [H | Acc]). +remove_config_parent(Node, [{collection, Parents} | T], Acc) -> + remove_config_parent(Node, T, + [{collection, lists:delete(Node, Parents)} | Acc]); +remove_config_parent(Node, [H | T], Acc) -> + remove_config_parent(Node, T, [H | Acc]). validate_parentage(_Key, _Owners, []) -> true; @@ -230,8 +228,8 @@ validate_parentage(Key, Owners, [[] | T]) -> validate_parentage(Key, Owners, T); validate_parentage(Key, Owners, [<<>> | T]) -> validate_parentage(Key, Owners, T); -validate_parentage(Key, Owners, [ParentID | T]) -> - case find_node(Key, ParentID) of +validate_parentage(Key, Owners, [ParentId | T]) -> + case find_node(Key, ParentId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item_not_found')}; #pubsub_node{owners = POwners, options = POptions} -> NodeType = find_opt(node_type, ?DEFAULT_NODETYPE, POptions), diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index 6c6329482..a5caa4c92 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -78,7 +78,7 @@ init(_Host, _ServerHost, _Opts) -> mnesia:create_table(pubsub_node, [{disc_copies, [node()]}, {attributes, record_info(fields, pubsub_node)}]), - mnesia:add_table_index(pubsub_node, id), + mnesia:add_table_index(pubsub_node, idx), NodesFields = record_info(fields, pubsub_node), case mnesia:table_info(pubsub_node, attributes) of NodesFields -> ok; @@ -105,7 +105,7 @@ set_node(_) -> %% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() get_node(Host, Node, _From) -> get_node(Host, Node). get_node(Host, Node) -> @@ -114,24 +114,24 @@ get_node(Host, Node) -> [] -> {error, 'item-not-found'}; Error -> Error end. -get_node(NodeId) -> - case catch mnesia:index_read(pubsub_node, NodeId, #pubsub_node.id) of +get_node(Nidx) -> + case catch mnesia:index_read(pubsub_node, Nidx, #pubsub_node.idx) of [Record] when is_record(Record, pubsub_node) -> Record; [] -> {error, 'item-not-found'}; Error -> Error end. %% @spec (Host, From) -> [pubsubNode()] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() get_nodes(Host, _From) -> get_nodes(Host). get_nodes(Host) -> - mnesia:match_object(#pubsub_node{nodeid = {Host, '_'}, _ = '_'}). + mnesia:match_object(#pubsub_node{id = {Host, '_'}, _ = '_'}). %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() %% Depth = integer() %% Record = pubsubNode() %% @doc

    Default node tree does not handle parents, return empty list.

    @@ -139,9 +139,9 @@ get_parentnodes(_Host, _Node, _From) -> []. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() %% Depth = integer() %% Record = pubsubNode() %% @doc

    Default node tree does not handle parents, return a list @@ -154,27 +154,27 @@ get_parentnodes_tree(Host, Node, From) -> %% @spec (Host, Node, From) -> [pubsubNode()] | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Node = node() +%% From = ljid() get_subnodes(Host, Node, _From) -> get_subnodes(Host, Node). get_subnodes(Host, <<>>) -> - Q = qlc:q([N || #pubsub_node{nodeid = {NHost, _}, + Q = qlc:q([N || #pubsub_node{id = {NHost, _}, parents = Parents} = N <- mnesia:table(pubsub_node), Host == NHost, Parents == []]), qlc:e(Q); get_subnodes(Host, Node) -> - Q = qlc:q([N || #pubsub_node{nodeid = {NHost, _}, + Q = qlc:q([N || #pubsub_node{id = {NHost, _}, parents = Parents} = N <- mnesia:table(pubsub_node), Host == NHost, lists:member(Node, Parents)]), qlc:e(Q). -%% @spec (Host, Index, From) -> [pubsubNodeIdx()] | {error, Reason} +%% @spec (Host, Index, From) -> [nodeidx()] | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Node = node() +%% From = ljid() get_subnodes_tree(Host, Node, _From) -> get_subnodes_tree(Host, Node). get_subnodes_tree(Host, Node) -> @@ -184,7 +184,7 @@ get_subnodes_tree(Host, Node) -> Rec -> BasePlugin = list_to_atom("node_"++Rec#pubsub_node.type), BasePath = BasePlugin:node_to_path(Node), - mnesia:foldl(fun(#pubsub_node{nodeid = {H, N}} = R, Acc) -> + mnesia:foldl(fun(#pubsub_node{id = {H, N}} = R, Acc) -> Plugin = list_to_atom("node_"++R#pubsub_node.type), Path = Plugin:node_to_path(N), case lists:prefix(BasePath, Path) and (H == Host) of @@ -195,10 +195,10 @@ get_subnodes_tree(Host, Node) -> end. %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% NodeType = mod_pubsub:nodeType() -%% Owner = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% NodeType = nodeType() +%% Owner = ljid() %% Options = list() create_node(Host, Node, Type, Owner, Options, Parents) -> BJID = jlib:short_prepd_bare_jid(Owner), @@ -226,29 +226,29 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> end, case ParentExists of true -> - NodeId = pubsub_index:new(node), - mnesia:write(#pubsub_node{nodeid = {Host, Node}, - id = NodeId, + Nidx = pubsub_index:new(node), + mnesia:write(#pubsub_node{id = {Host, Node}, + idx = Nidx, parents = Parents, type = Type, owners = [BJID], options = Options}), - {ok, NodeId}; + {ok, Nidx}; false -> %% Requesting entity is prohibited from creating nodes {error, 'forbidden'} end; _ -> - %% NodeID already exists + %% Node already exists {error, 'conflict'} end. %% @spec (Host, Node) -> [mod_pubsub:node()] -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() delete_node(Host, Node) -> Removed = get_subnodes_tree(Host, Node), - lists:foreach(fun(#pubsub_node{nodeid = {_, N}, id = I}) -> + lists:foreach(fun(#pubsub_node{id = {_, N}, idx = I}) -> pubsub_index:free(node, I), mnesia:delete({pubsub_node, {Host, N}}) end, Removed), diff --git a/src/mod_pubsub/nodetree_tree_odbc.erl b/src/mod_pubsub/nodetree_tree_odbc.erl index 55c611345..68c3eaaae 100644 --- a/src/mod_pubsub/nodetree_tree_odbc.erl +++ b/src/mod_pubsub/nodetree_tree_odbc.erl @@ -32,7 +32,6 @@ %%% development is still a work in progress. However, the system is already %%% useable and useful as is. Please, send us comments, feedback and %%% improvements.

    - -module(nodetree_tree_odbc). -author('christophe.romain@process-one.net'). @@ -84,16 +83,16 @@ terminate(_Host, _ServerHost) -> ok. %% @spec () -> [Option] -%% Option = mod_pubsub:nodetreeOption() +%% Option = nodetreeOption() %% @doc Returns the default pubsub node tree options. options() -> [{virtual_tree, false}, {odbc, true}]. -%% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} +%% @spec (Host, Node, From) -> node() | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() get_node(Host, Node, _From) -> get_node(Host, Node). get_node(Host, Node) -> @@ -111,22 +110,22 @@ get_node(Host, Node) -> _ -> {error, 'item_not_found'} end. -get_node(NodeId) -> +get_node(Nidx) -> case catch ejabberd_odbc:sql_query_t( ["select host, node, parent, type " "from pubsub_node " - "where nodeid='", NodeId, "';"]) + "where nodeid='", Nidx, "';"]) of {selected, ["host", "node", "parent", "type"], [{Host, Node, Parent, Type}]} -> - raw_to_node(Host, {Node, Parent, Type, NodeId}); + raw_to_node(Host, {Node, Parent, Type, Nidx}); {'EXIT', _Reason} -> {error, 'internal_server_error'}; _ -> {error, 'item_not_found'} end. -%% @spec (Host, From) -> [pubsubNode()] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() +%% @spec (Host, From) -> [node()] | {error, Reason} +%% Host = mod_pubsub:host() | ljid() get_nodes(Host, _From) -> get_nodes(Host). get_nodes(Host) -> @@ -143,21 +142,21 @@ get_nodes(Host) -> end. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() -%% Depth = integer() -%% Record = pubsubNode() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() +%% Depth = int() +%% Record = mod_pubsub:pubsub_node() %% @doc

    Default node tree does not handle parents, return empty list.

    get_parentnodes(_Host, _Node, _From) -> []. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() -%% Depth = integer() -%% Record = pubsubNode() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% From = ljid() +%% Depth = int() +%% Record = mod_pubsub:pubsub_node() %% @doc

    Default node tree does not handle parents, return a list %% containing just this node.

    get_parentnodes_tree(Host, Node, From) -> @@ -182,10 +181,10 @@ get_subnodes(Host, Node) -> [] end. -%% @spec (Host, Index, From) -> [pubsubNodeIdx()] | {error, Reason} +%% @spec (Host, Index, From) -> [nodeidx()] | {error, Reason} %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Node = node() +%% From = ljid() get_subnodes_tree(Host, Node, _From) -> get_subnodes_tree(Host, Node). get_subnodes_tree(Host, Node) -> @@ -203,10 +202,10 @@ get_subnodes_tree(Host, Node) -> end. %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok | {error, Reason} -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() -%% NodeType = mod_pubsub:nodeType() -%% Owner = mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() +%% Node = node() +%% NodeType = nodeType() +%% Owner = ljid() %% Options = list() create_node(Host, Node, Type, Owner, Options, Parents) -> BJID = jlib:short_prepd_bare_jid(Owner), @@ -223,9 +222,9 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> true; [Parent | _] -> case nodeid(Host, Parent) of - {result, PNodeId} -> + {result, Pidx} -> BHost = list_to_binary(Host), - case nodeowners(PNodeId) of + case nodeowners(Pidx) of [{undefined, BHost, undefined}] -> true; Owners -> lists:member(BJID, Owners) end; @@ -239,11 +238,11 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> case ParentExists of true -> case set_node(#pubsub_node{ - nodeid={Host, Node}, + id={Host, Node}, parents=Parents, type=Type, options=Options}) of - {result, NodeId} -> {ok, NodeId}; + {result, Nidx} -> {ok, Nidx}; Other -> Other end; false -> @@ -251,16 +250,16 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> {error, 'forbidden'} end; {result, _} -> - %% NodeID already exists + %% Node already exists {error, 'conflict'}; Error -> Error end. -%% @spec (Host, Node) -> [mod_pubsub:node()] -%% Host = mod_pubsub:host() | mod_pubsub:jid() -%% Node = mod_pubsub:pubsubNode() +%% @spec (Host, Node) -> [node()] +%% Host = mod_pubsub:host() | ljid() +%% Node = node() delete_node(Host, Node) -> H = ?PUBSUB:escape(Host), N = ?PUBSUB:escape(?PUBSUB:node_to_string(Node)), @@ -273,11 +272,11 @@ delete_node(Host, Node) -> %% helpers -raw_to_node(Host, {Node, Parent, Type, NodeId}) -> +raw_to_node(Host, {Node, Parent, Type, Nidx}) -> Options = case catch ejabberd_odbc:sql_query_t( ["select name,val " "from pubsub_node_option " - "where nodeid='", NodeId, "';"]) + "where nodeid='", Nidx, "';"]) of {selected, ["name", "val"], ROptions} -> DbOpts = lists:map(fun({Key, Value}) -> @@ -295,16 +294,16 @@ raw_to_node(Host, {Node, Parent, Type, NodeId}) -> [] end, #pubsub_node{ - nodeid = {Host, ?PUBSUB:string_to_node(Node)}, + id = {Host, ?PUBSUB:string_to_node(Node)}, parents = [?PUBSUB:string_to_node(Parent)], - id = NodeId, + idx = Nidx, type = Type, options = Options}. %% @spec (NodeRecord) -> ok | {error, Reason} %% Record = mod_pubsub:pubsub_node() set_node(Record) -> - {Host, Node} = Record#pubsub_node.nodeid, + {Host, Node} = Record#pubsub_node.id, Parent = case Record#pubsub_node.parents of [] -> <<>>; [First | _] -> First @@ -313,29 +312,29 @@ set_node(Record) -> H = ?PUBSUB:escape(Host), N = ?PUBSUB:escape(?PUBSUB:node_to_string(Node)), P = ?PUBSUB:escape(?PUBSUB:node_to_string(Parent)), - NodeId = case nodeid(Host, Node) of - {result, OldNodeId} -> + Nidx = case nodeid(Host, Node) of + {result, OldNidx} -> catch ejabberd_odbc:sql_query_t( ["delete from pubsub_node_option " - "where nodeid='", OldNodeId, "';"]), + "where nodeid='", OldNidx, "';"]), catch ejabberd_odbc:sql_query_t( ["update pubsub_node " "set host='", H, "' " "node='", N, "' " "parent='", P, "' " "type='", Type, "' " - "where nodeid='", OldNodeId, "';"]), - OldNodeId; + "where nodeid='", OldNidx, "';"]), + OldNidx; _ -> catch ejabberd_odbc:sql_query_t( ["insert into pubsub_node(host, node, parent, type) " "values('", H, "', '", N, "', '", P, "', '", Type, "');"]), case nodeid(Host, Node) of - {result, NewNodeId} -> NewNodeId; - _ -> none % this should not happen + {result, NewNidx} -> NewNidx; + _ -> none % this should not happe end end, - case NodeId of + case Nidx of none -> {error, 'internal_server_error'}; _ -> @@ -344,9 +343,9 @@ set_node(Record) -> SValue = ?PUBSUB:escape(lists:flatten(io_lib:fwrite("~p",[Value]))), catch ejabberd_odbc:sql_query_t( ["insert into pubsub_node_option(nodeid, name, val) " - "values('", NodeId, "', '", SKey, "', '", SValue, "');"]) + "values('", Nidx, "', '", SKey, "', '", SValue, "');"]) end, Record#pubsub_node.options), - {result, NodeId} + {result, Nidx} end. nodeid(Host, Node) -> @@ -357,16 +356,16 @@ nodeid(Host, Node) -> "from pubsub_node " "where host='", H, "' and node='", N, "';"]) of - {selected, ["nodeid"], [{NodeId}]} -> - {result, NodeId}; + {selected, ["nodeid"], [{Nidx}]} -> + {result, Nidx}; {'EXIT', _Reason} -> {error, 'internal_server_error'}; _ -> {error, 'item_not_found'} end. -nodeowners(NodeId) -> - {result, Res} = node_flat_odbc:get_node_affiliations(NodeId), +nodeowners(Nidx) -> + {result, Res} = node_flat_odbc:get_node_affiliations(Nidx), lists:foldl(fun({LJID, owner}, Acc) -> [LJID|Acc]; (_, Acc) -> Acc end, [], Res). diff --git a/src/mod_pubsub/nodetree_virtual.erl b/src/mod_pubsub/nodetree_virtual.erl index 8433b9b54..490f3aedf 100644 --- a/src/mod_pubsub/nodetree_virtual.erl +++ b/src/mod_pubsub/nodetree_virtual.erl @@ -86,18 +86,19 @@ set_node(_NodeRecord) -> %% @spec (Host, Node, From) -> pubsubNode() %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() %% @doc

    Virtual node tree does not handle a node database. Any node is considered %% as existing. Node record contains default values.

    get_node(Host, Node, _From) -> get_node(Host, Node). get_node(Host, Node) -> - #pubsub_node{nodeid = {Host, Node}, id = {Host, Node}, owners = [{undefined, list_to_binary(Host), undefined}]}. + %% TODO : to fix idx + #pubsub_node{id = {Host, Node}, idx = {Host, Node}, owners = [{undefined, list_to_binary(Host), undefined}]}. get_node({Host, _} = NodeId) -> - #pubsub_node{nodeid = NodeId, id = NodeId, owners = [{undefined, list_to_binary(Host), undefined}]}. + #pubsub_node{id = NodeId, idx = NodeId, owners = [{undefined, list_to_binary(Host), undefined}]}. %% @spec (Host, From) -> [pubsubNode()] -%% Host = mod_pubsub:host() | mod_pubsub:jid() +%% Host = mod_pubsub:host() | ljid() %% @doc

    Virtual node tree does not handle a node database. Any node is considered %% as existing. Nodes list can not be determined.

    get_nodes(Host, _From) -> @@ -107,8 +108,8 @@ get_nodes(_Host) -> %% @spec (Host, Node, From) -> [pubsubNode()] %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% From = mod_pubsub:jid() +%% Node = node() +%% From = ljid() %% @doc

    Virtual node tree does not handle parent/child. Child list is empty.

    get_subnodes(Host, Node, _From) -> get_subnodes(Host, Node). @@ -117,7 +118,7 @@ get_subnodes(_Host, _Node) -> %% @spec (Host, Index, From) -> [pubsubNode()] %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() %% @doc

    Virtual node tree does not handle parent/child. Child list is empty.

    get_subnodes_tree(Host, Node, _From) -> get_subnodes_tree(Host, Node). @@ -126,9 +127,9 @@ get_subnodes_tree(_Host, _Node) -> %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() -%% Type = mod_pubsub:nodeType() -%% Owner = mod_pubsub:jid() +%% Node = node() +%% Type = nodeType() +%% Owner = ljid() %% Options = list() %% @doc

    No node record is stored on database. Any valid node %% is considered as already created.

    @@ -143,7 +144,7 @@ create_node(Host, Node, _Type, Owner, _Options, _Parents) -> %% @spec (Host, Node) -> [mod_pubsub:node()] %% Host = mod_pubsub:host() -%% Node = mod_pubsub:pubsubNode() +%% Node = node() %% @doc

    Virtual node tree does not handle parent/child. %% node deletion just affects the corresponding node.

    delete_node(Host, Node) -> diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index 9fd5ebd1c..8d0569e0f 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -35,14 +35,25 @@ %% ------------------------------- %% Pubsub types -%%% @type host() = string(). +%%% @type host() = binary(). %%%

    host is the name of the PubSub service. For example, it can be -%%% "pubsub.localhost".

    +%%% pubsub.localhost.

    -%%% @type pubsubNode() = [string()]. -%%%

    A node is defined by a list of its ancestors. The last element is the name -%%% of the current node. For example: -%%% ```["home", "localhost", "cromain", "node1"]'''

    +%%% @type node() = binary(). +%%%

    A node is the name of a Node. It can be anything and may represent +%%% some hierarchical tree depending of the node type. +%%% For example: +%%% /home/localhost/user/node +%%% princely_musings +%%% http://jabber.org/protocol/tune +%%% My-Own_Node

    + +%%% @type item() = binary(). +%%%

    An item is the name of an Item. It can be anything. +%%% For example: +%%% 38964 +%%% my-tune +%%% FD6SBE6a27d

    %%% @type stanzaError() = #xmlel{}. %%% Example: @@ -82,34 +93,29 @@ %%% plugin to use to manage a given node. For example, it can be %%% "flat", "hometree" or "blog".

    -%%% @type jid() = #jid{ -%%% user = string(), -%%% server = string(), -%%% resource = string(), -%%% luser = string(), -%%% lserver = string(), -%%% lresource = string()}. +%%% @type ljid() = {User::binary(), Server::binary(), Resource::binary()}. -%%% @type ljid() = {User::string(), Server::string(), Resource::string()}. +%%% @type nodeidx() = int() -%%% @type affiliation() = none | owner | publisher | outcast. +%%% @type affiliation() = none | owner | publisher | member | outcast. %%% @type subscription() = none | pending | unconfigured | subscribed. %%% internal pubsub index table -record(pubsub_index, {index, last, free}). %%% @type pubsubNode() = #pubsub_node{ -%%% nodeid = {Host::host(), Node::pubsubNode()}, -%%% parentid = Node::pubsubNode(), -%%% nodeidx = int(), +%%% id = {host(), node()}, +%%% idx = nodeidx(), +%%% parents = [Node::pubsubNode()], %%% type = nodeType(), +%%% owners = [ljid()], %%% options = [nodeOption()]}. %%%

    This is the format of the nodes table. The type of the table %%% is: set,ram/disc.

    -%%%

    The parentid and type fields are indexed.

    -%%%

    nodeidx can be anything you want.

    --record(pubsub_node, {nodeid, - id, +%%%

    The parents and type fields are indexed.

    +%%%

    nodeidx is an integer.

    +-record(pubsub_node, {id, + idx, parents = [], type = "flat", owners = [], @@ -117,26 +123,26 @@ }). %%% @type pubsubState() = #pubsub_state{ -%%% stateid = {ljid(), nodeidx()}, -%%% items = [ItemId::string()], +%%% id = {ljid(), nodeidx()}, +%%% items = [item()], %%% affiliation = affiliation(), %%% subscriptions = [subscription()]}. %%%

    This is the format of the affiliations table. The type of the %%% table is: set,ram/disc.

    --record(pubsub_state, {stateid, +-record(pubsub_state, {id, items = [], affiliation = none, subscriptions = [] }). %%% @type pubsubItem() = #pubsub_item{ -%%% itemid = {ItemId::string(), nodeidx()}, +%%% id = {item(), nodeidx()}, %%% creation = {now(), ljid()}, %%% modification = {now(), ljid()}, %%% payload = XMLContent::string()}. %%%

    This is the format of the published items table. The type of the %%% table is: set,disc,fragmented.

    --record(pubsub_item, {itemid, +-record(pubsub_item, {id, creation = {unknown,unknown}, modification = {unknown,unknown}, payload = [] @@ -144,7 +150,7 @@ %% @type pubsubSubscription() = #pubsub_subscription{ %% subid = string(), -%% state_key = {ljid(), pubsubNodeId()}, +%% state_key = {ljid(), nodeidx()}, %% options = [{atom(), term()}] %% }. %%

    This is the format of the subscriptions table. The type of the @@ -153,7 +159,7 @@ %% @type pubsubLastItem() = #pubsub_last_item{ %% nodeid = nodeidx(), -%% itemid = string(), +%% itemid = item(), %% creation = {now(), ljid()}, %% payload = XMLContent::string()}. %%

    This is the format of the last items table. it stores last item payload diff --git a/src/mod_pubsub/pubsub_db_odbc.erl b/src/mod_pubsub/pubsub_db_odbc.erl index dfdcbbc2c..42811786b 100644 --- a/src/mod_pubsub/pubsub_db_odbc.erl +++ b/src/mod_pubsub/pubsub_db_odbc.erl @@ -32,27 +32,27 @@ %% Those -spec lines produce errors in old Erlang versions. %% They can be enabled again in ejabberd 3.0 because it uses R12B or higher. --spec read_subscription(SubID :: string()) -> {ok, #pubsub_subscription{}} | notfound. -read_subscription(SubID) -> +-spec read_subscription(SubId :: string()) -> {ok, #pubsub_subscription{}} | notfound. +read_subscription(SubId) -> case ejabberd_odbc:sql_query_t( ["select opt_name, opt_value " "from pubsub_subscription_opt " - "where subid = '", ejabberd_odbc:escape(SubID), "'"]) of + "where subid = '", ejabberd_odbc:escape(SubId), "'"]) of {selected, ["opt_name", "opt_value"], []} -> notfound; {selected, ["opt_name", "opt_value"], Options} -> - {ok, #pubsub_subscription{subid = SubID, + {ok, #pubsub_subscription{subid = SubId, options = lists:map(fun subscription_opt_from_odbc/1, Options)}} end. --spec delete_subscription(SubID :: string()) -> ok. -delete_subscription(SubID) -> +-spec delete_subscription(SubId :: string()) -> ok. +delete_subscription(SubId) -> ejabberd_odbc:sql_query_t(["delete from pubsub_subscription_opt " - "where subid = '", ejabberd_odbc:escape(SubID), "'"]), + "where subid = '", ejabberd_odbc:escape(SubId), "'"]), ok. diff --git a/src/mod_pubsub/pubsub_odbc.patch b/src/mod_pubsub/pubsub_odbc.patch index 4ca79a9bd..e1e483f08 100644 --- a/src/mod_pubsub/pubsub_odbc.patch +++ b/src/mod_pubsub/pubsub_odbc.patch @@ -1,5 +1,5 @@ ---- mod_pubsub.erl 2010-08-04 18:28:18.000000000 +0200 -+++ mod_pubsub_odbc.erl 2010-08-04 18:29:41.000000000 +0200 +--- mod_pubsub.erl 2010-09-10 18:04:47.000000000 +0200 ++++ mod_pubsub_odbc.erl 2010-09-10 19:43:53.000000000 +0200 @@ -42,7 +42,7 @@ %%% 6.2.3.1, 6.2.3.5, and 6.3. For information on subscription leases see %%% XEP-0060 section 12.18. @@ -49,7 +49,7 @@ init_nodes(Host, ServerHost, NodeTree, Plugins), State = #state{host = Host, server_host = ServerHost, -@@ -280,206 +278,15 @@ +@@ -280,209 +278,14 @@ init_nodes(Host, ServerHost, _NodeTree, Plugins) -> %% TODO, this call should be done plugin side @@ -59,7 +59,7 @@ - create_node(Host, ServerHost, string_to_node("/home"), service_jid(Host), "hometree"), - create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree"); + create_node(Host, ServerHost, string_to_node("/home"), service_jid(Host), "hometree_odbc"), -+ create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); ++ create_node(Host, ServerHost, string_to_node("/home/" ++ ServerHost), service_jid(Host), "hometree_odbc"); false -> ok end. @@ -72,18 +72,18 @@ - ?INFO_MSG("upgrade node pubsub tables",[]), - F = fun() -> - {Result, LastIdx} = lists:foldl( -- fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, NodeIdx}) -> +- fun({pubsub_node, NodeId, ParentId, {nodeinfo, Items, Options, Entities}}, {RecList, Nidx}) -> - ItemsList = - lists:foldl( -- fun({item, IID, Publisher, Payload}, Acc) -> +- fun({item, ItemName, Publisher, Payload}, Acc) -> - C = {unknown, Publisher}, - M = {now(), Publisher}, - mnesia:write( -- #pubsub_item{itemid = {IID, NodeIdx}, +- #pubsub_item{id = {ItemName, Nidx}, - creation = C, - modification = M, - payload = Payload}), -- [{Publisher, IID} | Acc] +- [{Publisher, ItemName} | Acc] - end, [], Items), - Owners = - dict:fold( @@ -97,7 +97,7 @@ - end - end, [], ItemsList), - mnesia:write({pubsub_state, -- {JID, NodeIdx}, +- {JID, Nidx}, - UsrItems, - Aff, - Sub}), @@ -107,12 +107,12 @@ - end - end, [], Entities), - mnesia:delete({pubsub_node, NodeId}), -- {[#pubsub_node{nodeid = NodeId, -- id = NodeIdx, +- {[#pubsub_node{id = NodeId, +- idx = Nidx, - parents = [element(2, ParentId)], - owners = Owners, - options = Options} | -- RecList], NodeIdx + 1} +- RecList], Nidx + 1} - end, {[], 1}, - mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_'})), @@ -137,32 +137,33 @@ - [nodeid, parentid, type, owners, options] -> - F = fun({pubsub_node, NodeId, {_, Parent}, Type, Owners, Options}) -> - #pubsub_node{ -- nodeid = NodeId, -- id = 0, +- id = NodeId, +- idx = 0, - parents = [Parent], - type = Type, - owners = Owners, - options = Options} - end, +- %% TODO : to change nodeid/id and id/idx or not to change ? - mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), - FNew = fun() -> -- LastIdx = lists:foldl(fun(#pubsub_node{nodeid = NodeId} = PubsubNode, NodeIdx) -> -- mnesia:write(PubsubNode#pubsub_node{id = NodeIdx}), -- lists:foreach(fun(#pubsub_state{stateid = StateId} = State) -> +- LastIdx = lists:foldl(fun(#pubsub_node{id = NodeId} = PubsubNode, Nidx) -> +- mnesia:write(PubsubNode#pubsub_node{idx = Nidx}), +- lists:foreach(fun(#pubsub_state{id = StateId} = State) -> - {JID, _} = StateId, - mnesia:delete({pubsub_state, StateId}), -- mnesia:write(State#pubsub_state{stateid = {JID, NodeIdx}}) -- end, mnesia:match_object(#pubsub_state{stateid = {'_', NodeId}, _ = '_'})), -- lists:foreach(fun(#pubsub_item{itemid = ItemId} = Item) -> -- {IID, _} = ItemId, +- mnesia:write(State#pubsub_state{id = {JID, Nidx}}) +- end, mnesia:match_object(#pubsub_state{id = {'_', NodeId}, _ = '_'})), +- lists:foreach(fun(#pubsub_item{id = ItemId} = Item) -> +- {ItemName, _} = ItemId, - {M1, M2} = Item#pubsub_item.modification, - {C1, C2} = Item#pubsub_item.creation, - mnesia:delete({pubsub_item, ItemId}), -- mnesia:write(Item#pubsub_item{itemid = {IID, NodeIdx}, +- mnesia:write(Item#pubsub_item{id = {ItemName, Nidx}, - modification = {M2, M1}, - creation = {C2, C1}}) -- end, mnesia:match_object(#pubsub_item{itemid = {'_', NodeId}, _ = '_'})), -- NodeIdx + 1 +- end, mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'})), +- Nidx + 1 - end, 1, mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) - ++ mnesia:match_object( @@ -179,13 +180,14 @@ - [nodeid, id, parent, type, owners, options] -> - F = fun({pubsub_node, NodeId, Id, Parent, Type, Owners, Options}) -> - #pubsub_node{ -- nodeid = NodeId, -- id = Id, +- id = NodeId, +- idx = Id, - parents = [Parent], - type = Type, - owners = Owners, - options = Options} - end, +- %% TODO : to change nodeid/id and id/idx or not to change ? - mnesia:transform_table(pubsub_node, F, [nodeid, id, parents, type, owners, options]), - rename_default_nodeplugin(); - _ -> @@ -203,7 +205,7 @@ - [<<>>] -> []; - Parents -> Parents - end, -- mnesia:write(Node#pubsub_node{nodeid={H, BN}, parents=BP}), +- mnesia:write(Node#pubsub_node{id={H, BN}, parents=BP}), - mnesia:delete({pubsub_node, {H, N}}); - (_) -> - ok @@ -222,15 +224,15 @@ - case catch mnesia:table_info(pubsub_state, attributes) of - [stateid, items, affiliation, subscription] -> - ?INFO_MSG("upgrade state pubsub tables", []), -- F = fun ({pubsub_state, {JID, NodeID}, Items, Aff, Sub}, Acc) -> +- F = fun ({pubsub_state, {JID, NodeId}, Items, Aff, Sub}, Acc) -> - Subs = case Sub of - none -> - []; - _ -> -- {result, SubID} = pubsub_subscription:subscribe_node(JID, NodeID, []), -- [{Sub, SubID}] +- {result, SubId} = pubsub_subscription:subscribe_node(JID, NodeId, []), +- [{Sub, SubId}] - end, -- NewState = #pubsub_state{stateid = {JID, NodeID}, +- NewState = #pubsub_state{id = {JID, NodeId}, - items = Items, - affiliation = Aff, - subscriptions = Subs}, @@ -256,11 +258,11 @@ - _ -> - ok - end. -+ - +- send_loop(State) -> receive -@@ -491,7 +298,10 @@ + {presence, JID, Pid} -> +@@ -493,7 +296,10 @@ %% for each node From is subscribed to %% and if the node is so configured, send the last published item to From lists:foreach(fun(PType) -> @@ -272,37 +274,37 @@ lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> -@@ -616,7 +426,8 @@ +@@ -618,7 +424,8 @@ [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, -@@ -647,7 +458,8 @@ +@@ -649,7 +456,8 @@ [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s -@@ -666,7 +478,8 @@ +@@ -668,7 +476,8 @@ {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> -- Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx, owners = Owners}, Acc) -> -+ Action = fun(#pubsub_node{nodeid ={_, NodeID}, options = Options, type = Type, id = Idx}, Acc) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx, owners = Owners}, Acc) -> ++ Action = fun(#pubsub_node{id ={_, NodeId}, options = Options, type = Type, idx = Nidx}, Acc) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, -@@ -680,13 +493,14 @@ +@@ -682,13 +491,14 @@ _ -> Acc end end, @@ -313,26 +315,26 @@ end; disco_items(Host, Node, From) -> -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), - case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), + case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, -@@ -771,10 +585,10 @@ +@@ -774,10 +584,10 @@ lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun -- ({#pubsub_node{options = Options, owners = Owners, id = NodeId}, subscribed, _, JID}) -> -+ ({#pubsub_node{options = Options, id = NodeId}, subscribed, _, JID}) -> +- ({#pubsub_node{options = Options, owners = Owners, idx = Nidx}, subscribed, _, JID}) -> ++ ({#pubsub_node{options = Options, idx = Nidx}, subscribed, _, JID}) -> case get_option(Options, access_model) of presence -> - case lists:member(BJID, Owners) of -+ case lists:member(BJID, node_owners(Host, PType, NodeId)) of ++ case lists:member(BJID, node_owners(Host, PType, Nidx)) of true -> - node_action(Host, PType, unsubscribe_node, [NodeId, Entity, JID, all]); + node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> -@@ -949,10 +763,11 @@ +@@ -952,10 +762,11 @@ end, ejabberd_router:route(To, From, Res); #iq{type = get, ns = ?NS_DISCO_ITEMS, @@ -346,16 +348,16 @@ {result, IQRes} -> Result = #xmlel{ns = ?NS_DISCO_ITEMS, name = 'query', attrs = QAttrs, -@@ -1089,7 +904,7 @@ +@@ -1092,7 +903,7 @@ [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> -- case node_call(Type, get_items, [NodeId, From]) of -+ case node_call(Type, get_items, [NodeId, From, none]) of +- case node_call(Type, get_items, [Nidx, From]) of ++ case node_call(Type, get_items, [Nidx, From, none]) of {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] -@@ -1105,8 +920,9 @@ +@@ -1108,8 +919,9 @@ []; true -> [#xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_PUBSUB_s)]} | @@ -367,7 +369,7 @@ end, features(Type))] end, %% TODO: add meta-data info (spec section 5.4) -@@ -1135,8 +951,9 @@ +@@ -1138,8 +950,9 @@ #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_PUBSUB_s)]}, #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_ADHOC_s)]}, #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_VCARD_s)]}] ++ @@ -379,7 +381,7 @@ end, features(Host, Node))}; ?NS_ADHOC_b -> command_disco_info(Host, Node, From); -@@ -1146,7 +963,7 @@ +@@ -1149,7 +962,7 @@ node_disco_info(Host, Node, From) end. @@ -388,7 +390,7 @@ case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( -@@ -1163,7 +980,7 @@ +@@ -1166,7 +979,7 @@ Other -> Other end; @@ -397,7 +399,7 @@ %% TODO: support localization of this string CommandItems = [ #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', -@@ -1172,19 +989,20 @@ +@@ -1175,19 +988,20 @@ ?XMLATTR('name', "Get Pending") ]}], {result, CommandItems}; @@ -408,22 +410,22 @@ -iq_disco_items(Host, Item, From) -> +iq_disco_items(Host, Item, From, RSM) -> case string:tokens(Item, "!") of - [_SNode, _ItemID] -> + [_SNode, _ItemId] -> {result, []}; [SNode] -> Node = string_to_node(SNode), -- Action = fun(#pubsub_node{id = Idx, type = Type, options = Options, owners = Owners}) -> -- NodeItems = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners) of -+ Action = fun(#pubsub_node{id = Idx, type = Type, options = Options}) -> -+ Owners = node_owners_call(Type, Idx), -+ {NodeItems, RsmOut} = case get_allowed_items_call(Host, Idx, From, Type, Options, Owners, RSM) of +- Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options, owners = Owners}) -> +- NodeItems = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of ++ Action = fun(#pubsub_node{idx = Nidx, type = Type, options = Options}) -> ++ Owners = node_owners_call(Type, Nidx), ++ {NodeItems, RsmOut} = case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners, RSM) of {result, R} -> R; - _ -> [] + _ -> {[], none} end, Nodes = lists:map( - fun(#pubsub_node{nodeid = {_, SubNode}, options = SubOptions}) -> -@@ -1202,7 +1020,7 @@ + fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> +@@ -1205,7 +1019,7 @@ {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -432,30 +434,29 @@ end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Result}} -> {result, Result}; -@@ -1210,12 +1028,6 @@ +@@ -1213,12 +1027,6 @@ end end. --get_allowed_items_call(Host, NodeIdx, From, Type, Options, Owners) -> +-get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) -> - AccessModel = get_option(Options, access_model), - AllowedGroups = get_option(Options, roster_groups_allowed, []), - {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), -- node_call(Type, get_items, [NodeIdx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). +- node_call(Type, get_items, [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, undefined]). - get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups) -> if (AccessModel == presence) or (AccessModel == roster) -> case Host of -@@ -1333,7 +1145,8 @@ +@@ -1336,7 +1144,7 @@ (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), -- get_items(Host, Node, From, SubId, MaxItems, ItemIDs); -+ RSM = jlib:rsm_decode(SubEl), -+ get_items(Host, Node, From, SubId, MaxItems, ItemIDs, RSM); +- get_items(Host, Node, From, SubId, MaxItems, ItemIds); ++ get_items(Host, Node, From, SubId, MaxItems, ItemIds, jlib:rsm_decode(SubEl)); {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> -@@ -1490,7 +1303,8 @@ +@@ -1493,7 +1301,8 @@ _ -> [] end end, @@ -465,36 +466,36 @@ sync_dirty) of {result, Res} -> Res; Err -> Err -@@ -1534,7 +1348,7 @@ +@@ -1537,7 +1346,7 @@ %%% authorization handling --send_authorization_request(#pubsub_node{owners = Owners, nodeid = {Host, Node}}, Subscriber) -> -+send_authorization_request(#pubsub_node{nodeid = {Host, Node}, type = Type, id = NodeId}, Subscriber) -> +-send_authorization_request(#pubsub_node{owners = Owners, id = {Host, Node}}, Subscriber) -> ++send_authorization_request(#pubsub_node{id = {Host, Node}, type = Type, idx = Nidx}, Subscriber) -> Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = -@@ -1564,7 +1378,7 @@ +@@ -1567,7 +1376,7 @@ lists:foreach(fun(Owner) -> {U, S, R} = Owner, ejabberd_router:route(service_jid(Host), exmpp_jid:make(U, S, R), Stanza) - end, Owners). -+ end, node_owners(Host, Type, NodeId)). ++ end, node_owners(Host, Type, Nidx)). find_authorization_response(Packet) -> Els = Packet#xmlel.children, -@@ -1623,8 +1437,8 @@ +@@ -1626,8 +1435,8 @@ "true" -> true; _ -> false end, -- Action = fun(#pubsub_node{type = Type, owners = Owners, id = NodeId}) -> +- Action = fun(#pubsub_node{type = Type, owners = Owners, idx = Nidx}) -> - IsApprover = lists:member(jlib:short_prepd_bare_jid(From), Owners), -+ Action = fun(#pubsub_node{type = Type, id = NodeId}) -> -+ IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, NodeId)), - {result, Subscriptions} = node_call(Type, get_subscriptions, [NodeId, Subscriber]), ++ Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> ++ IsApprover = lists:member(jlib:short_prepd_bare_jid(From), node_owners_call(Type, Nidx)), + {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> -@@ -1823,7 +1637,7 @@ +@@ -1826,7 +1635,7 @@ end, Reply = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [#xmlel{ns = ?NS_PUBSUB, name = 'create', attrs = nodeAttr(Node)}]}, @@ -503,7 +504,7 @@ {result, {NodeId, SubsByDepth, {Result, broadcast}}} -> broadcast_created_node(Host, Node, NodeId, Type, NodeOptions, SubsByDepth), case Result of -@@ -1927,7 +1741,7 @@ +@@ -1930,7 +1739,7 @@ %%

  • The node does not exist.
    • %% subscribe_node(Host, Node, From, JID, Configuration) -> @@ -512,50 +513,50 @@ {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid end, -@@ -1937,7 +1751,7 @@ +@@ -1940,7 +1749,7 @@ _:_ -> {undefined, undefined, undefined} end, -- Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, id = NodeId}) -> -+ Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> +- Action = fun(#pubsub_node{options = Options, owners = Owners, type = Type, idx = Nidx}) -> ++ Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), -@@ -1946,6 +1760,7 @@ +@@ -1949,6 +1758,7 @@ AccessModel = get_option(Options, access_model), SendLast = get_option(Options, send_last_published_item), AllowedGroups = get_option(Options, roster_groups_allowed, []), -+ Owners = node_owners_call(Type, NodeId), ++ Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, Subscriber, Owners, AccessModel, AllowedGroups), if not SubscribeFeature -> -@@ -2290,7 +2105,7 @@ +@@ -2293,7 +2103,7 @@ %%

    The permission are not checked in this function.

    %% @todo We probably need to check that the user doing the query has the right %% to read the items. --get_items(Host, Node, From, SubId, SMaxItems, ItemIDs) -> -+get_items(Host, Node, From, SubId, SMaxItems, ItemIDs, RSM) -> +-get_items(Host, Node, From, SubId, SMaxItems, ItemIds) -> ++get_items(Host, Node, From, SubId, SMaxItems, ItemIds, RSM) -> MaxItems = if SMaxItems == "" -> get_max_items_node(Host); -@@ -2304,12 +2119,13 @@ +@@ -2307,12 +2117,13 @@ {error, Error} -> {error, Error}; _ -> -- Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId, owners = Owners}) -> -+ Action = fun(#pubsub_node{options = Options, type = Type, id = NodeId}) -> +- Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx, owners = Owners}) -> ++ Action = fun(#pubsub_node{options = Options, type = Type, idx = Nidx}) -> Features = features(Type), RetreiveFeature = lists:member("retrieve-items", Features), PersistentFeature = lists:member("persistent-items", Features), AccessModel = get_option(Options, access_model), AllowedGroups = get_option(Options, roster_groups_allowed, []), -+ Owners = node_owners_call(Type, NodeId), ++ Owners = node_owners_call(Type, Nidx), {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), if not RetreiveFeature -> -@@ -2322,11 +2138,11 @@ +@@ -2325,11 +2136,11 @@ node_call(Type, get_items, - [NodeId, From, + [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, - SubId]) + SubId, RSM]) @@ -564,10 +565,10 @@ case transaction(Host, Node, Action, sync_dirty) of - {result, {_, Items}} -> + {result, {_, Items, RSMOut}} -> - SendItems = case ItemIDs of + SendItems = case ItemIds of [] -> Items; -@@ -2339,7 +2155,7 @@ +@@ -2342,7 +2153,7 @@ %% number of items sent to MaxItems: {result, #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [#xmlel{ns = ?NS_PUBSUB, name = 'items', attrs = nodeAttr(Node), children = @@ -576,7 +577,7 @@ Error -> Error end -@@ -2360,6 +2176,17 @@ +@@ -2365,6 +2176,17 @@ {result, {_, Items}} -> Items; Error -> Error end. @@ -594,7 +595,7 @@ %% @spec (Host, Node, NodeId, Type, LJID, Number) -> any() %% Host = pubsubHost() -@@ -2371,16 +2198,29 @@ +@@ -2376,16 +2198,29 @@ %% @doc

    Resend the items of a node to the user.

    %% @todo use cache-last-item feature send_items(Host, Node, NodeId, Type, LJID, last) -> @@ -630,21 +631,21 @@ send_items(Host, Node, NodeId, Type, {LU, LS, LR} = LJID, Number) -> ToSend = case node_action(Host, Type, get_items, [NodeId, LJID]) of {result, []} -> -@@ -2507,7 +2347,8 @@ +@@ -2512,7 +2347,8 @@ error -> {error, 'bad-request'}; _ -> -- Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}=N) -> -+ Action = fun(#pubsub_node{type = Type, id = NodeId}) -> -+ Owners = node_owners_call(Type, NodeId), +- Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}=N) -> ++ Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> ++ Owners = node_owners_call(Type, Nidx), case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), -@@ -2517,24 +2358,8 @@ +@@ -2522,24 +2358,8 @@ end, lists:foreach( fun({JID, Affiliation}) -> -- {result, _} = node_call(Type, set_affiliation, [NodeId, JID, Affiliation]), +- {result, _} = node_call(Type, set_affiliation, [Nidx, JID, Affiliation]), - case Affiliation of - owner -> - NewOwner = jlib:short_prepd_bare_jid(JID), @@ -663,16 +664,16 @@ - ok - end + % TODO, check if nothing missing here about new owners -+ node_call(Type, set_affiliation, [NodeId, JID, Affiliation]) ++ node_call(Type, set_affiliation, [Nidx, JID, Affiliation]) end, FilteredEntities), {result, []}; _ -> -@@ -2589,11 +2414,11 @@ +@@ -2594,11 +2414,11 @@ end. - read_sub(Subscriber, Node, NodeID, SubID, Lang) -> -- case pubsub_subscription:get_subscription(Subscriber, NodeID, SubID) of -+ case pubsub_subscription_odbc:get_subscription(Subscriber, NodeID, SubID) of + read_sub(Subscriber, Node, NodeId, SubId, Lang) -> +- case pubsub_subscription:get_subscription(Subscriber, NodeId, SubId) of ++ case pubsub_subscription_odbc:get_subscription(Subscriber, NodeId, SubId) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, #pubsub_subscription{options = Options}} -> @@ -680,37 +681,37 @@ + {result, XdataEl} = pubsub_subscription_odbc:get_options_xform(Lang, Options), OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), - ?XMLATTR('subid', SubID) | nodeAttr(Node)], -@@ -2620,7 +2445,7 @@ + ?XMLATTR('subid', SubId) | nodeAttr(Node)], +@@ -2625,7 +2445,7 @@ end. - set_options_helper(Configuration, JID, NodeID, SubID, Type) -> + set_options_helper(Configuration, JID, NodeId, SubId, Type) -> - SubOpts = case pubsub_subscription:parse_options_xform(Configuration) of + SubOpts = case pubsub_subscription_odbc:parse_options_xform(Configuration) of {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid end, -@@ -2650,7 +2475,7 @@ - write_sub(_Subscriber, _NodeID, _SubID, invalid) -> +@@ -2655,7 +2475,7 @@ + write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; - write_sub(Subscriber, NodeID, SubID, Options) -> -- case pubsub_subscription:set_subscription(Subscriber, NodeID, SubID, Options) of -+ case pubsub_subscription_odbc:set_subscription(Subscriber, NodeID, SubID, Options) of + write_sub(Subscriber, NodeId, SubId, Options) -> +- case pubsub_subscription:set_subscription(Subscriber, NodeId, SubId, Options) of ++ case pubsub_subscription_odbc:set_subscription(Subscriber, NodeId, SubId, Options) of {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> -@@ -2824,8 +2649,8 @@ +@@ -2829,8 +2649,8 @@ ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, -- Action = fun(#pubsub_node{owners = Owners, type = Type, id = NodeId}) -> +- Action = fun(#pubsub_node{owners = Owners, type = Type, idx = Nidx}) -> - case lists:member(Owner, Owners) of -+ Action = fun(#pubsub_node{type = Type, id = NodeId}) -> -+ case lists:member(Owner, node_owners_call(Type, NodeId)) of ++ Action = fun(#pubsub_node{type = Type, idx = Nidx}) -> ++ case lists:member(Owner, node_owners_call(Type, Nidx)) of true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> -@@ -3174,7 +2999,7 @@ +@@ -3179,7 +2999,7 @@ {Depth, [{N, get_node_subs(N)} || N <- Nodes]} end, tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]))} end, @@ -719,19 +720,16 @@ {result, CollSubs} -> CollSubs; _ -> [] end. -@@ -3188,9 +3013,9 @@ +@@ -3192,7 +3012,7 @@ - get_options_for_subs(NodeID, Subs) -> - lists:foldl(fun({JID, subscribed, SubID}, Acc) -> -- case pubsub_subscription:read_subscription(JID, NodeID, SubID) of -+ case pubsub_subscription_odbc:get_subscription(JID, NodeID, SubID) of - {error, notfound} -> [{JID, SubID, []} | Acc]; -- #pubsub_subscription{options = Options} -> [{JID, SubID, Options} | Acc]; -+ {result, #pubsub_subscription{options = Options}} -> [{JID, SubID, Options} | Acc]; + get_options_for_subs(Nidx, Subs) -> + lists:foldl(fun({JID, subscribed, SubId}, Acc) -> +- case pubsub_subscription:read_subscription(JID, Nidx, SubId) of ++ case pubsub_subscription_odbc:read_subscription(JID, Nidx, SubId) of + {error, notfound} -> [{JID, SubId, []} | Acc]; + #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc - end; - (_, Acc) -> -@@ -3412,6 +3237,30 @@ +@@ -3416,6 +3236,30 @@ Result end. @@ -762,7 +760,7 @@ %% @spec (Host, Options) -> MaxItems %% Host = host() %% Options = [Option] -@@ -3815,7 +3664,13 @@ +@@ -3819,7 +3663,13 @@ tree_action(Host, Function, Args) -> ?DEBUG("tree_action ~p ~p ~p",[Host,Function,Args]), Fun = fun() -> tree_call(Host, Function, Args) end, @@ -777,7 +775,7 @@ %% @doc

    node plugin call.

    node_call(Type, Function, Args) -> -@@ -3835,13 +3690,13 @@ +@@ -3839,13 +3689,13 @@ node_action(Host, Type, Function, Args) -> ?DEBUG("node_action ~p ~p ~p ~p",[Host,Type,Function,Args]), @@ -793,7 +791,7 @@ case tree_call(Host, get_node, [Host, Node]) of N when is_record(N, pubsub_node) -> case Action(N) of -@@ -3854,13 +3709,20 @@ +@@ -3858,13 +3708,20 @@ end end, Trans). @@ -818,7 +816,7 @@ {result, Result} -> {result, Result}; {error, Error} -> {error, Error}; {atomic, {result, Result}} -> {result, Result}; -@@ -3868,6 +3730,15 @@ +@@ -3872,6 +3729,15 @@ {aborted, Reason} -> ?ERROR_MSG("transaction return internal error: ~p~n", [{aborted, Reason}]), {error, 'internal-server-error'}; @@ -834,7 +832,7 @@ {'EXIT', Reason} -> ?ERROR_MSG("transaction return internal error: ~p~n", [{'EXIT', Reason}]), {error, 'internal-server-error'}; -@@ -3876,6 +3747,16 @@ +@@ -3880,6 +3746,16 @@ {error, 'internal-server-error'} end. diff --git a/src/mod_pubsub/pubsub_subscription.erl b/src/mod_pubsub/pubsub_subscription.erl index 72a721877..87753acde 100644 --- a/src/mod_pubsub/pubsub_subscription.erl +++ b/src/mod_pubsub/pubsub_subscription.erl @@ -89,36 +89,36 @@ init() -> ok = create_table(). -subscribe_node(JID, NodeID, Options) -> +subscribe_node(JID, NodeId, Options) -> try mnesia:sync_dirty(fun add_subscription/3, - [JID, NodeID, Options]) of + [JID, NodeId, Options]) of {error, Error} -> {error, Error}; Result -> {result, Result} catch Error -> Error end. -unsubscribe_node(JID, NodeID, SubID) -> +unsubscribe_node(JID, NodeId, SubId) -> try mnesia:sync_dirty(fun delete_subscription/3, - [JID, NodeID, SubID]) of + [JID, NodeId, SubId]) of {error, Error} -> {error, Error}; Result -> {result, Result} catch Error -> Error end. -get_subscription(JID, NodeID, SubID) -> +get_subscription(JID, NodeId, SubId) -> try mnesia:sync_dirty(fun read_subscription/3, - [JID, NodeID, SubID]) of + [JID, NodeId, SubId]) of {error, Error} -> {error, Error}; Result -> {result, Result} catch Error -> Error end. -set_subscription(JID, NodeID, SubID, Options) -> +set_subscription(JID, NodeId, SubId, Options) -> try mnesia:sync_dirty(fun write_subscription/4, - [JID, NodeID, SubID, Options]) of + [JID, NodeId, SubId, Options]) of {error, Error} -> {error, Error}; Result -> {result, Result} catch @@ -170,22 +170,22 @@ create_table() -> Other -> Other end. -add_subscription(_JID, _NodeID, Options) -> - SubID = make_subid(), - mnesia:write(#pubsub_subscription{subid = SubID, options = Options}), - SubID. +add_subscription(_JID, _NodeId, Options) -> + SubId = make_subid(), + mnesia:write(#pubsub_subscription{subid = SubId, options = Options}), + SubId. -delete_subscription(_JID, _NodeID, SubID) -> - mnesia:delete({pubsub_subscription, SubID}). +delete_subscription(_JID, _NodeId, SubId) -> + mnesia:delete({pubsub_subscription, SubId}). -read_subscription(_JID, _NodeID, SubID) -> - case mnesia:read({pubsub_subscription, SubID}) of +read_subscription(_JID, _NodeId, SubId) -> + case mnesia:read({pubsub_subscription, SubId}) of [Sub] -> Sub; _ -> {error, notfound} end. -write_subscription(JID, NodeID, SubID, Options) -> - case read_subscription(JID, NodeID, SubID) of +write_subscription(JID, NodeId, SubId, Options) -> + case read_subscription(JID, NodeId, SubId) of {error, notfound} -> {error, notfound}; Sub -> mnesia:write(Sub#pubsub_subscription{options = Options}) end. diff --git a/src/mod_pubsub/pubsub_subscription_odbc.erl b/src/mod_pubsub/pubsub_subscription_odbc.erl index f5591e032..88070a136 100644 --- a/src/mod_pubsub/pubsub_subscription_odbc.erl +++ b/src/mod_pubsub/pubsub_subscription_odbc.erl @@ -89,33 +89,33 @@ init() -> ok = create_table(). -subscribe_node(_JID, _NodeID, Options) -> - SubID = make_subid(), - ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubID, options = Options}), - {result, SubID}. +subscribe_node(_JID, _Nidx, Options) -> + SubId = make_subid(), + ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubId, options = Options}), + {result, SubId}. -unsubscribe_node(_JID, _NodeID, SubID) -> - case ?DB_MOD:read_subscription(SubID) of +unsubscribe_node(_JID, _Nidx, SubId) -> + case ?DB_MOD:read_subscription(SubId) of {ok, Sub} -> - ?DB_MOD:delete_subscription(SubID), + ?DB_MOD:delete_subscription(SubId), {result, Sub}; notfound -> {error, notfound} end. -get_subscription(_JID, _NodeID, SubID) -> - case ?DB_MOD:read_subscription(SubID) of +get_subscription(_JID, _Nidx, SubId) -> + case ?DB_MOD:read_subscription(SubId) of {ok, Sub} -> {result, Sub}; notfound -> {error, notfound} end. -set_subscription(_JID, _NodeID, SubID, Options) -> - case ?DB_MOD:read_subscription(SubID) of +set_subscription(_JID, _Nidx, SubId, Options) -> + case ?DB_MOD:read_subscription(SubId) of {ok, _} -> - ?DB_MOD:update_subscription(#pubsub_subscription{subid = SubID, options = Options}), + ?DB_MOD:update_subscription(#pubsub_subscription{subid = SubId, options = Options}), {result, ok}; notfound -> - ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubID, options = Options}), + ?DB_MOD:add_subscription(#pubsub_subscription{subid = SubId, options = Options}), {result, ok} end. From 813022aec1a9ac999cc4ee548c8683ce0bc34ccd Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 13 Sep 2010 12:05:10 +0200 Subject: [PATCH 05/34] Support timezone West of UTC (thanks to Edwin Fine)(EJAB-1301) --- src/mod_time.erl | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/mod_time.erl b/src/mod_time.erl index b7482bcda..4f2eb1ac3 100644 --- a/src/mod_time.erl +++ b/src/mod_time.erl @@ -59,7 +59,13 @@ process_local_iq(_From, _To, #iq{type = get} = IQ_Rec) -> {UTC, UTC_diff} = jlib:timestamp_to_iso(Now_universal, utc), Seconds_diff = calendar:datetime_to_gregorian_seconds(Now_local) - calendar:datetime_to_gregorian_seconds(Now_universal), - {Hd, Md, _} = calendar:seconds_to_time(Seconds_diff), + {Hd, Md, _} = case Seconds_diff >= 0 of + true -> + calendar:seconds_to_time(Seconds_diff); + false -> + {Hd0, Md0, Sd0} = calendar:seconds_to_time(-Seconds_diff), + {-Hd0, Md0, Sd0} + end, {_, TZO_diff} = jlib:timestamp_to_iso({{0, 0, 0}, {0, 0, 0}}, {Hd, Md}), Result = #xmlel{ns = ?NS_TIME, name = 'time', children = [ #xmlel{ns = ?NS_TIME, name = 'tzo', children = [ From 89a98be605370d75769485b4c7892ce586591aac Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 13 Sep 2010 17:49:55 +0200 Subject: [PATCH 06/34] Display priority, login time, pid and pid info in webadmin (EJAB-1300) --- src/ejabberd_c2s.erl | 7 +-- src/ejabberd_sm.erl | 5 +- src/web/ejabberd_web_admin.erl | 84 ++++++++++++++++++++++++++++++++-- 3 files changed, 88 insertions(+), 8 deletions(-) diff --git a/src/ejabberd_c2s.erl b/src/ejabberd_c2s.erl index 309287721..c21263d10 100644 --- a/src/ejabberd_c2s.erl +++ b/src/ejabberd_c2s.erl @@ -71,6 +71,9 @@ -include("ejabberd.hrl"). -include("mod_privacy.hrl"). +%% Copied from ejabberd_socket.erl +-record(socket_state, {sockmod, socket, receiver}). + -define(SETS, gb_sets). -define(DICT, dict). @@ -527,6 +530,7 @@ wait_for_auth({xmlstreamelement, El}, StateData) -> "(~w) Accepted legacy authentication for ~s by ~s", [StateData#state.socket, exmpp_jid:to_binary(JID), AuthModule]), + erlang:link((StateData#state.socket)#socket_state.receiver), SID = {now(), self()}, Conn = get_conn_type(StateData), %% Info = [{ip, StateData#state.ip}, {conn, Conn}, @@ -1594,9 +1598,6 @@ get_auth_tags([_ | L], U, P, D, R) -> get_auth_tags([], U, P, D, R) -> {U, P, D, R}. -%% Copied from ejabberd_socket.erl --record(socket_state, {sockmod, socket, receiver}). - get_conn_type(StateData) -> case (StateData#state.sockmod):get_sockmod(StateData#state.socket) of gen_tcp -> c2s; diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl index f6d09276f..d9f2ac34d 100644 --- a/src/ejabberd_sm.erl +++ b/src/ejabberd_sm.erl @@ -214,7 +214,10 @@ get_user_info(User, Server, Resource) N = node(element(2, Session#session.sid)), Conn = proplists:get_value(conn, Session#session.info), IP = proplists:get_value(ip, Session#session.info), - [{node, N}, {conn, Conn}, {ip, IP}]; + Priority = Session#session.priority, %% integer() + {CreationNow, Pid} = Session#session.sid, + CreationString = jlib:now_to_utc_string(CreationNow), + [{node, Node}, {conn, Conn}, {ip, IP}, {priority, Priority}, {pid, Pid}, {creation, CreationString}]; true -> offline end. diff --git a/src/web/ejabberd_web_admin.erl b/src/web/ejabberd_web_admin.erl index 60c19e58d..df3659004 100644 --- a/src/web/ejabberd_web_admin.erl +++ b/src/web/ejabberd_web_admin.erl @@ -1732,10 +1732,17 @@ user_info(User, Server, Query, Lang) -> FIP = case ejabberd_sm:get_user_info( UserB, ServerB, R) of offline -> + NodePidS = "", ""; Info when is_list(Info) -> Node = proplists:get_value(node, Info), + NodeS = atom_to_list(Node), Conn = proplists:get_value(conn, Info), + Priority = proplists:get_value(priority, Info), + Creation = proplists:get_value(creation, Info), + Pid = proplists:get_value(pid, Info), + PidS = pid_to_list(Pid), + NodePidS = NodeS ++ "/pid/" ++ PidS, {IP, Port} = proplists:get_value(ip, Info), ConnS = case Conn of c2s -> "plain"; @@ -1746,14 +1753,16 @@ user_info(User, Server, Query, Lang) -> http_poll -> "http-poll" end, " (" ++ + " #" ++ integer_to_list(Priority) ++ " " ++ ConnS ++ "://" ++ inet_parse:ntoa(IP) ++ ":" ++ - integer_to_list(Port) - ++ "#" ++ atom_to_list(Node) - ++ ")" + integer_to_list(Port) ++ + "#" ++ NodeS ++ + " " ++ Creation ++ + ") " end, - ?LI([?C(binary_to_list(R) ++ FIP)]) + ?LI([?C(binary_to_list(R) ++ FIP), ?AC("/admin/node/" ++ NodePidS ++ "/", "View Process")]) end, lists:sort(Resources)))] end, Password = ejabberd_auth:get_password_s(User, Server), @@ -2149,6 +2158,7 @@ get_node(global, Node, [], Query, Lang) -> [?XE('ul', [?LI([?ACT(Base ++ "db/", "Database")]), ?LI([?ACT(Base ++ "backup/", "Backup")]), + ?LI([?ACT(Base ++ "pid/", "Erlang Processes")]), ?LI([?ACT(Base ++ "ports/", "Listened Ports")]), ?LI([?ACT(Base ++ "stats/", "Statistics")]), ?LI([?ACT(Base ++ "update/", "Update")]) @@ -2326,6 +2336,71 @@ get_node(global, Node, ["backup"], Query, Lang) -> ]) ])])]; +get_node(global, Node, ["pid"], _Query, Lang) -> + NodeS = atom_to_list(Node), + Processes = rpc:call(Node, erlang, processes, []), + ProcessesNumber = length(Processes), + ProcessesList = lists:map( + fun(P) -> + PS = pid_to_list(P), + NodePidS = NodeS ++ "/pid/" ++ PS, + ?AC("/admin/node/" ++ NodePidS ++ "/", PS) + end, + Processes), + [?XC('h1', io_lib:format(?T("Erlang Processes at node ~p"), [Node])), + ?XAE('table', [], + [?XE('tbody', + [?XE('tr', [?XCT('td', "Number of processes:"), + ?XAC('td', [?XMLATTR('class', <<"alignright">>)], + pretty_string_int(ProcessesNumber))]) + ]) + ]), + ?XAE('p', [], + [?CT("Processes: ")] ++ ProcessesList + )]; + +get_node(global, Node, ["pid", PidS], _Query, Lang) -> + NodeS = atom_to_list(Node), + ProcessInfo = rpc:call(Node, erlang, process_info, [list_to_pid(PidS)]), + ProcessInfoS = io_lib:format("~p", [ProcessInfo]), + ProcLinkList = case re:run(ProcessInfoS, "<[0-9]+\\.[0-9]+\\.[0-9]+>", + [global, {capture, all, list}]) of + {match, PidsRareList} -> + lists:map( + fun([PS]) -> + NodePidS = NodeS ++ "/pid/" ++ PS, + ?AC("/admin/node/" ++ NodePidS ++ "/", PS) + end, + PidsRareList); + _ -> + [] + end, + PortLinkList = + case proplists:get_value(links, ProcessInfo) of + Links when is_list(Links) -> + lists:foldl( + fun(Link, LinkRes) when is_port(Link) -> + PortInfo = rpc:call(Node, erlang, port_info, [Link]), + PortInfoString = io_lib:format("~p", [PortInfo]), + LinkRes ++ [{erlang:port_to_list(Link), PortInfoString}]; + (_Link, LinkRes) -> LinkRes + end, + [], + Links); + _ -> + [] + end, + [?XC('h1', io_lib:format(?T("Erlang Process ~s at node ~p"), [PidS, Node])), + ?XC('h3', ?T("Process Information:")), + ?XAE('pre', [], [?C(ProcessInfoS)]), + ?XC('h3', ?T("Related Processes:")), + ?XAE('p', [], ProcLinkList), + ?XC('h3', ?T("Linked Ports:")), + ?XE('ul', + [ ?XE('li', [ ?C(PortName), ?BR, ?C(PortDescr) ]) + || {PortName, PortDescr} <- PortLinkList]) + ]; + get_node(global, Node, ["ports"], Query, Lang) -> Ports = rpc:call(Node, ejabberd_config, get_local_option, [listen]), Res = case catch node_ports_parse_query(Node, Ports, Query) of @@ -2964,6 +3039,7 @@ make_node_menu(global, Node, Lang) -> NodeBase = get_base_path(global, Node), NodeFixed = [{"db/", "Database"}, {"backup/", "Backup"}, + {"pid/", "Erlang Processes"}, {"ports/", "Listened Ports"}, {"stats/", "Statistics"}, {"update/", "Update"}] From 52deb1667632d790bc60cfc53c37b41eb1e9748a Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Wed, 15 Sep 2010 12:16:03 +0200 Subject: [PATCH 07/34] apply modification for the exmpp #jid{} record update --- src/mod_sic.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/mod_sic.erl b/src/mod_sic.erl index 3a3f14b02..c9756df73 100644 --- a/src/mod_sic.erl +++ b/src/mod_sic.erl @@ -62,8 +62,8 @@ process_local_iq(_From, _To, #iq{type = 'set'} = IQ) -> process_sm_iq( - #jid{prep_node = Node, prep_domain = Domain} = From, - #jid{prep_node = Node, prep_domain = Domain} = _To, + #jid{node = Node, domain = Domain} = From, + #jid{node = Node, domain = Domain} = _To, #iq{type = 'get'} = IQ) -> get_ip(From, IQ); From cb953f949faca0429c6ba337d8bdd917e0c664c4 Mon Sep 17 00:00:00 2001 From: Badlop Date: Wed, 15 Sep 2010 20:04:35 +0200 Subject: [PATCH 08/34] Fix problems reported by Dialyzer --- src/ejabberd_captcha.erl | 50 ++++++++++++++++++++-------------------- src/eldap/eldap.erl | 17 ++++---------- 2 files changed, 30 insertions(+), 37 deletions(-) diff --git a/src/ejabberd_captcha.erl b/src/ejabberd_captcha.erl index bb75308f9..6a063fc34 100644 --- a/src/ejabberd_captcha.erl +++ b/src/ejabberd_captcha.erl @@ -81,13 +81,13 @@ start_link() -> gen_server:start_link({local, ?MODULE}, ?MODULE, [], []). create_captcha(SID, From, To, Lang, Args) - when is_binary(Lang), is_list(SID) -> + when is_binary(Lang), is_binary(SID) -> case create_image() of {ok, Type, Key, Image} -> - Id = randoms:get_string() ++ "-" ++ ejabberd_cluster:node_id(), - B64Image = jlib:encode_base64(binary_to_list(Image)), + Id = list_to_binary(randoms:get_string() ++ "-" ++ ejabberd_cluster:node_id()), + B64Image = list_to_binary(jlib:encode_base64(binary_to_list(Image))), JID = exmpp_jid:to_list(From), - CID = "sha1+" ++ sha:sha(Image) ++ "@bob.xmpp.org", + CID = list_to_binary(["sha1+", sha:sha(Image), "@bob.xmpp.org"]), % Data = {xmlelement, "data", % [{"xmlns", ?NS_BOB}, {"cid", CID}, % {"max-age", "0"}, {"type", Type}], @@ -103,7 +103,7 @@ create_captcha(SID, From, To, Lang, Args) }, #xmlattr{ name = 'max-age', - value = "0" + value = <<"0">> }, #xmlattr{ name = 'type', @@ -134,20 +134,20 @@ create_captcha(SID, From, To, Lang, Args) attrs = [ #xmlattr{ name = 'type', - value = "form" + value = <<"form">> } ], children = [ - ?VFIELD("hidden", "FORM_TYPE", #xmlcdata{cdata = ?NS_CAPTCHA}), - ?VFIELD("hidden", "from", #xmlcdata{cdata = exmpp_jid:to_list(To)}), - ?VFIELD("hidden", "challenge", #xmlcdata{cdata = Id}), - ?VFIELD("hidden", "sid", #xmlcdata{cdata = SID}), + ?VFIELD(<<"hidden">>, <<"FORM_TYPE">>, #xmlcdata{cdata = ?NS_CAPTCHA}), + ?VFIELD(<<"hidden">>, <<"from">>, #xmlcdata{cdata = exmpp_jid:to_binary(To)}), + ?VFIELD(<<"hidden">>, <<"challenge">>, #xmlcdata{cdata = Id}), + ?VFIELD(<<"hidden">>, <<"sid">>, #xmlcdata{cdata = SID}), #xmlel{ name = 'field', attrs = [ #xmlattr{ name = 'var', - value = "ocr" + value = <<"ocr">> }, #xmlattr{ name = 'label', @@ -168,7 +168,7 @@ create_captcha(SID, From, To, Lang, Args) } ], children = [ - #xmlcdata{cdata = "cid:" ++ CID} + #xmlcdata{cdata = list_to_binary(["cid:", CID])} ] } ] @@ -199,7 +199,7 @@ create_captcha(SID, From, To, Lang, Args) name = 'url', children = [ #xmlcdata{ - cdata = get_url(Id)} + cdata = list_to_binary(get_url(Id))} ] } ] @@ -232,7 +232,7 @@ build_captcha_html(Id, Lang) -> attrs = [ #xmlattr{ name = 'src', - value = get_url(Id ++ "/image") + value = list_to_binary(get_url(Id ++ "/image")) } ] }, @@ -247,15 +247,15 @@ build_captcha_html(Id, Lang) -> attrs = [ #xmlattr{ name = 'type', - value = "hidden" + value = <<"hidden">> }, #xmlattr{ name = 'name', - value = "id" + value = <<"id">> }, #xmlattr{ name = 'value', - value = Id + value = list_to_binary(Id) } ] }, @@ -300,7 +300,7 @@ build_captcha_html(Id, Lang) -> attrs = [ #xmlattr{ name = 'action', - value = get_url(Id) + value = list_to_binary(get_url(Id)) }, #xmlattr{ name = 'name', @@ -399,7 +399,7 @@ process_reply(El) -> process(_Handlers, #request{method='GET', lang=Lang, path=[_, Id]}) -> case build_captcha_html(Id, Lang) of - {FormEl, _} when is_tuple(FormEl) -> + {FormEl, CaptchaTuple} when is_tuple(CaptchaTuple) -> Form = %{xmlelement, "div", [{"align", "center"}], %[FormEl]}, @@ -502,25 +502,25 @@ code_change(_OldVsn, State, _Extra) -> %%-------------------------------------------------------------------- %% Function: create_image() -> {ok, Type, Key, Image} | {error, Reason} %% Type = "image/png" | "image/jpeg" | "image/gif" -%% Key = string() +%% Key = binary() %% Image = binary() %% Reason = atom() %%-------------------------------------------------------------------- create_image() -> %% Six numbers from 1 to 9. - Key = string:substr(randoms:get_string(), 1, 6), + Key = list_to_binary(string:substr(randoms:get_string(), 1, 6)), create_image(Key). create_image(Key) -> FileName = get_prog_name(), - Cmd = lists:flatten(io_lib:format("~s ~s", [FileName, Key])), + Cmd = lists:flatten(io_lib:format("~s ~p", [FileName, Key])), case cmd(Cmd) of {ok, <<16#89, $P, $N, $G, $\r, $\n, 16#1a, $\n, _/binary>> = Img} -> - {ok, "image/png", Key, Img}; + {ok, <<"image/png">>, Key, Img}; {ok, <<16#ff, 16#d8, _/binary>> = Img} -> - {ok, "image/jpeg", Key, Img}; + {ok, <<"image/jpeg">>, Key, Img}; {ok, <<$G, $I, $F, $8, X, $a, _/binary>> = Img} when X==$7; X==$9 -> - {ok, "image/gif", Key, Img}; + {ok, <<"image/gif">>, Key, Img}; {error, enodata = Reason} -> ?ERROR_MSG("Failed to process output from \"~s\". " "Maybe ImageMagick's Convert program is not installed.", diff --git a/src/eldap/eldap.erl b/src/eldap/eldap.erl index 7868f6036..7b14ae5c9 100644 --- a/src/eldap/eldap.erl +++ b/src/eldap/eldap.erl @@ -423,8 +423,8 @@ get_handle(Name) when is_list(Name) -> list_to_atom("eldap_" ++ Name). %%---------------------------------------------------------------------- init([]) -> case get_config() of - {ok, Hosts, Rootdn, Passwd, Opts} -> - init({Hosts, Rootdn, Passwd, Opts}); + {ok, Hosts, Port, Rootdn, Passwd, Opts} -> + init({Hosts, Port, Rootdn, Passwd, Opts}); {error, Reason} -> {stop, Reason} end; @@ -440,8 +440,6 @@ init({Hosts, Port, Rootdn, Passwd, Opts}) -> case Encrypt of tls -> ?LDAPS_PORT; - starttls -> - ?LDAP_PORT; _ -> ?LDAP_PORT end; @@ -886,14 +884,9 @@ cancel_timer(Timer) -> %%% Sanity check of received packet check_tag(Data) -> - case asn1rt_ber_bin:decode_tag(Data) of - {_Tag, Data1, _Rb} -> - case asn1rt_ber_bin:decode_length(Data1) of - {{_Len,_Data2}, _Rb2} -> ok; - _ -> throw({error,decoded_tag_length}) - end; - _ -> throw({error,decoded_tag}) - end. + {_Tag, Data1, _Rb} = asn1rt_ber_bin:decode_tag(Data), + {{_Len,_Data2}, _Rb2} = asn1rt_ber_bin:decode_length(Data1), + ok. close_and_retry(S, Timeout) -> catch (S#eldap.sockmod):close(S#eldap.fd), From 1cbfdce457372ace923c90c5f5f4c8c5d6650b4b Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Thu, 16 Sep 2010 14:52:30 +0200 Subject: [PATCH 09/34] remove garbage configuration --- src/mod_pubsub/node.template | 3 +-- src/mod_pubsub/node_pep_odbc.erl | 1 - src/mod_pubsub/node_public.erl | 3 +-- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/src/mod_pubsub/node.template b/src/mod_pubsub/node.template index f1a9ed557..b6f39e6d2 100644 --- a/src/mod_pubsub/node.template +++ b/src/mod_pubsub/node.template @@ -75,8 +75,7 @@ terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost). options() -> - [{node_type, __TO_BE_DEFINED__}, - {deliver_payloads, true}, + [{deliver_payloads, true}, {notify_config, false}, {notify_delete, false}, {notify_retract, true}, diff --git a/src/mod_pubsub/node_pep_odbc.erl b/src/mod_pubsub/node_pep_odbc.erl index c9c215548..91f52e60e 100644 --- a/src/mod_pubsub/node_pep_odbc.erl +++ b/src/mod_pubsub/node_pep_odbc.erl @@ -86,7 +86,6 @@ terminate(Host, ServerHost) -> options() -> [{odbc, true}, - {node_type, pep}, {deliver_payloads, true}, {notify_config, false}, {notify_delete, false}, diff --git a/src/mod_pubsub/node_public.erl b/src/mod_pubsub/node_public.erl index 2e0e96af0..f2fc6e780 100644 --- a/src/mod_pubsub/node_public.erl +++ b/src/mod_pubsub/node_public.erl @@ -82,8 +82,7 @@ terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost). options() -> - [{node_type, public}, - {deliver_payloads, true}, + [{deliver_payloads, true}, {notify_config, false}, {notify_delete, false}, {notify_retract, true}, From afac34de880c05b4c754cfc29fcf8e232618645d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20K=C3=B6hler?= Date: Fri, 17 Sep 2010 16:42:35 +0200 Subject: [PATCH 10/34] Discard unmatched INFO messages in ejabberd services. This patch will stop services terminating with function clause messages, but doesn't affect the message queue at all. --- src/ejabberd_service.erl | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ejabberd_service.erl b/src/ejabberd_service.erl index a786a217f..943ce4e55 100644 --- a/src/ejabberd_service.erl +++ b/src/ejabberd_service.erl @@ -349,6 +349,9 @@ handle_info({route, From, To, Packet}, StateName, StateData) -> Err = exmpp_stanza:reply_with_error(Packet, 'not-allowed'), ejabberd_router:route_error(To, From, Err, Packet) end, + {next_state, StateName, StateData}; +handle_info(Info, StateName, StateData) -> + ?ERROR_MSG("Unexpected info: ~p", [Info]), {next_state, StateName, StateData}. From 9bde1dc9afe2181bc11a96fa0e14bdb67d33274f Mon Sep 17 00:00:00 2001 From: Badlop Date: Fri, 17 Sep 2010 21:06:30 +0200 Subject: [PATCH 11/34] =?UTF-8?q?Add=20missing=20needdb,=20use=20bare=20ji?= =?UTF-8?q?d=20to=20get=20roster;=20now=20group=20and=20subs=20blocking=20?= =?UTF-8?q?works=20again=20(thanks=20to=20Andreas=20K=C3=B6hler)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/mod_privacy.erl | 7 +++++-- src/mod_roster.erl | 10 +++++----- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/src/mod_privacy.erl b/src/mod_privacy.erl index e1b882e72..1b448a2f8 100644 --- a/src/mod_privacy.erl +++ b/src/mod_privacy.erl @@ -418,11 +418,14 @@ process_active_set(LUser, LServer, Name) -> [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [#privacy_list{}] -> - List = gen_storage:select(LServer, privacy_list_data, + Data = gen_storage:select(LServer, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), + List = list_data_to_items(Data), + NeedDb = is_list_needdb(List), {result, [], #userlist{name = Name, - list = list_data_to_items(List)}}; + needdb = NeedDb, + list = List}}; [] -> {error, 'item-not-found'} end diff --git a/src/mod_roster.erl b/src/mod_roster.erl index a0037151c..573ffb96d 100644 --- a/src/mod_roster.erl +++ b/src/mod_roster.erl @@ -1183,15 +1183,15 @@ get_jid_info(_, User, Server, JID) LServer = exmpp_stringprep:nameprep(Server), try F = fun() -> - LJID = jlib:short_prepd_jid(JID), - case catch gen_storage:read(LServer, {rosteritem, {LUser, LServer, LJID}}) of + LJID = jlib:short_prepd_jid(JID), + LRJID = jlib:short_prepd_bare_jid(JID), + case catch gen_storage:read(LServer, {rosteritem, {LUser, LServer, LRJID}}) of [#rosteritem{subscription = Subscription}] -> Groups = [Group || #rostergroup{grp = Group} <- - gen_storage:read(LServer, {rostergroup, {LUser, LServer, LJID}})], + gen_storage:read(LServer, {rostergroup, {LUser, LServer, LRJID}})], {Subscription, Groups}; _ -> - LRJID = jlib:short_prepd_bare_jid(JID), if LRJID == LJID -> {none, []}; @@ -1202,7 +1202,7 @@ get_jid_info(_, User, Server, JID) [#rosteritem{subscription = Subscription}] -> Groups = [Group || #rostergroup{grp = Group} <- - gen_storage:read(LServer, {rostergroup, {LUser, LServer, LJID}})], + gen_storage:read(LServer, {rostergroup, {LUser, LServer, LRJID}})], {Subscription, Groups}; _ -> {none, []} From 2e75faefae29a96c077adeaf803f4c264c2fa226 Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Mon, 20 Sep 2010 16:54:37 +0200 Subject: [PATCH 12/34] improve type specification --- src/mod_pubsub/mod_pubsub.erl | 4 +- src/mod_pubsub/mod_pubsub_odbc.erl | 4 +- src/mod_pubsub/node_buddy.erl | 2 - src/mod_pubsub/node_club.erl | 1 - src/mod_pubsub/node_dispatch.erl | 1 - src/mod_pubsub/node_flat.erl | 1 - src/mod_pubsub/node_flat_odbc.erl | 1 - src/mod_pubsub/node_hometree.erl | 1 - src/mod_pubsub/node_hometree_odbc.erl | 1 - src/mod_pubsub/node_mb.erl | 2 - src/mod_pubsub/node_pep.erl | 2 - src/mod_pubsub/node_pep_odbc.erl | 2 - src/mod_pubsub/node_private.erl | 2 - src/mod_pubsub/node_public.erl | 2 - src/mod_pubsub/nodetree_dag.erl | 1 - src/mod_pubsub/nodetree_tree.erl | 1 - src/mod_pubsub/nodetree_tree_odbc.erl | 1 - src/mod_pubsub/nodetree_virtual.erl | 2 - src/mod_pubsub/pubsub.hrl | 251 +++++++++++++++----- src/mod_pubsub/pubsub_odbc.patch | 102 ++++---- src/mod_pubsub/pubsub_subscription.erl | 1 - src/mod_pubsub/pubsub_subscription_odbc.erl | 1 - 22 files changed, 240 insertions(+), 146 deletions(-) diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index adec996f0..419bd48e4 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -49,8 +49,6 @@ -behaviour(gen_server). -behaviour(gen_mod). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("adhoc.hrl"). -include("pubsub.hrl"). @@ -2219,7 +2217,7 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> Options = TNode#pubsub_node.options, broadcast_retract_items(Host, Node, Nidx, Type, Options, [ItemId], ForceNotify), case get_cached_item(Host, Nidx) of - #pubsub_item{id = {ItemId, Nidx}, _ = '_'} -> unset_cached_item(Host, Nidx); + #pubsub_item{id = {ItemId, Nidx}} -> unset_cached_item(Host, Nidx); _ -> ok end, case Result of diff --git a/src/mod_pubsub/mod_pubsub_odbc.erl b/src/mod_pubsub/mod_pubsub_odbc.erl index 003262583..f8b72155f 100644 --- a/src/mod_pubsub/mod_pubsub_odbc.erl +++ b/src/mod_pubsub/mod_pubsub_odbc.erl @@ -49,8 +49,6 @@ -behaviour(gen_server). -behaviour(gen_mod). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("adhoc.hrl"). -include("pubsub.hrl"). @@ -2029,7 +2027,7 @@ delete_item(Host, Node, Publisher, ItemId, ForceNotify) -> Options = TNode#pubsub_node.options, broadcast_retract_items(Host, Node, Nidx, Type, Options, [ItemId], ForceNotify), case get_cached_item(Host, Nidx) of - #pubsub_item{id = {ItemId, Nidx}, _ = '_'} -> unset_cached_item(Host, Nidx); + #pubsub_item{id = {ItemId, Nidx}} -> unset_cached_item(Host, Nidx); _ -> ok end, case Result of diff --git a/src/mod_pubsub/node_buddy.erl b/src/mod_pubsub/node_buddy.erl index 202abcfcb..46f63ecdf 100644 --- a/src/mod_pubsub/node_buddy.erl +++ b/src/mod_pubsub/node_buddy.erl @@ -26,8 +26,6 @@ -module(node_buddy). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_club.erl b/src/mod_pubsub/node_club.erl index 9dc4f202e..b7bb7cd4e 100644 --- a/src/mod_pubsub/node_club.erl +++ b/src/mod_pubsub/node_club.erl @@ -27,7 +27,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_dispatch.erl b/src/mod_pubsub/node_dispatch.erl index 2c1ad3565..b5b8419c6 100644 --- a/src/mod_pubsub/node_dispatch.erl +++ b/src/mod_pubsub/node_dispatch.erl @@ -27,7 +27,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_flat.erl b/src/mod_pubsub/node_flat.erl index b44d7bd6f..b7f0a7a16 100644 --- a/src/mod_pubsub/node_flat.erl +++ b/src/mod_pubsub/node_flat.erl @@ -42,7 +42,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_flat_odbc.erl b/src/mod_pubsub/node_flat_odbc.erl index 6efe12be4..fa249df69 100644 --- a/src/mod_pubsub/node_flat_odbc.erl +++ b/src/mod_pubsub/node_flat_odbc.erl @@ -42,7 +42,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -include("jlib.hrl"). %% for rsm_in and rsm_out records definitions -define(PUBSUB, mod_pubsub_odbc). diff --git a/src/mod_pubsub/node_hometree.erl b/src/mod_pubsub/node_hometree.erl index 34ec658d4..901e6cc72 100644 --- a/src/mod_pubsub/node_hometree.erl +++ b/src/mod_pubsub/node_hometree.erl @@ -26,7 +26,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_hometree_odbc.erl b/src/mod_pubsub/node_hometree_odbc.erl index ba5024822..711914511 100644 --- a/src/mod_pubsub/node_hometree_odbc.erl +++ b/src/mod_pubsub/node_hometree_odbc.erl @@ -26,7 +26,6 @@ -author('christophe.romain@process-one.net'). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_mb.erl b/src/mod_pubsub/node_mb.erl index 41beab5d4..162a1e96e 100644 --- a/src/mod_pubsub/node_mb.erl +++ b/src/mod_pubsub/node_mb.erl @@ -36,8 +36,6 @@ -module(node_mb). -author('eric@ohmforce.com'). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("pubsub.hrl"). diff --git a/src/mod_pubsub/node_pep.erl b/src/mod_pubsub/node_pep.erl index a59fa9d57..8ec3737bf 100644 --- a/src/mod_pubsub/node_pep.erl +++ b/src/mod_pubsub/node_pep.erl @@ -29,8 +29,6 @@ -module(node_pep). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("pubsub.hrl"). diff --git a/src/mod_pubsub/node_pep_odbc.erl b/src/mod_pubsub/node_pep_odbc.erl index 91f52e60e..14d0875cc 100644 --- a/src/mod_pubsub/node_pep_odbc.erl +++ b/src/mod_pubsub/node_pep_odbc.erl @@ -29,8 +29,6 @@ -module(node_pep_odbc). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("ejabberd.hrl"). -include("pubsub.hrl"). diff --git a/src/mod_pubsub/node_private.erl b/src/mod_pubsub/node_private.erl index da8e90f8e..c069ad1b2 100644 --- a/src/mod_pubsub/node_private.erl +++ b/src/mod_pubsub/node_private.erl @@ -26,8 +26,6 @@ -module(node_private). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/node_public.erl b/src/mod_pubsub/node_public.erl index f2fc6e780..b5719b5e7 100644 --- a/src/mod_pubsub/node_public.erl +++ b/src/mod_pubsub/node_public.erl @@ -26,8 +26,6 @@ -module(node_public). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_node). diff --git a/src/mod_pubsub/nodetree_dag.erl b/src/mod_pubsub/nodetree_dag.erl index f82353f53..722aaee51 100644 --- a/src/mod_pubsub/nodetree_dag.erl +++ b/src/mod_pubsub/nodetree_dag.erl @@ -39,7 +39,6 @@ -include("ejabberd.hrl"). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -behaviour(gen_pubsub_nodetree). diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index a5caa4c92..b30f2814d 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -37,7 +37,6 @@ -author('christophe.romain@process-one.net'). -include_lib("stdlib/include/qlc.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -include("pubsub.hrl"). diff --git a/src/mod_pubsub/nodetree_tree_odbc.erl b/src/mod_pubsub/nodetree_tree_odbc.erl index 68c3eaaae..9460bee3a 100644 --- a/src/mod_pubsub/nodetree_tree_odbc.erl +++ b/src/mod_pubsub/nodetree_tree_odbc.erl @@ -36,7 +36,6 @@ -author('christophe.romain@process-one.net'). -include_lib("stdlib/include/qlc.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -include("pubsub.hrl"). diff --git a/src/mod_pubsub/nodetree_virtual.erl b/src/mod_pubsub/nodetree_virtual.erl index 490f3aedf..c23ec82f9 100644 --- a/src/mod_pubsub/nodetree_virtual.erl +++ b/src/mod_pubsub/nodetree_virtual.erl @@ -33,8 +33,6 @@ -module(nodetree_virtual). -author('christophe.romain@process-one.net'). --include_lib("exmpp/include/exmpp.hrl"). - -include("pubsub.hrl"). -behaviour(gen_pubsub_nodetree). diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index 8d0569e0f..e45d4597f 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -21,6 +21,11 @@ %%% This file contains pubsub types definition. %%% ==================================================================== + +-include_lib("exmpp/include/exmpp.hrl"). +-include_lib("exmpp/include/exmpp_jid.hrl"). + + %% ------------------------------- %% Pubsub constants -define(ERR_EXTENDED(E,C), mod_pubsub:extended_error(E,C)). @@ -32,15 +37,22 @@ %% Would be nice to have it configurable. -define(MAX_PAYLOAD_SIZE, 60000). -%% ------------------------------- + +%% ------------ %% Pubsub types +%% ------------ %%% @type host() = binary(). +%%% %%%

    host is the name of the PubSub service. For example, it can be %%% pubsub.localhost.

    -%%% @type node() = binary(). -%%%

    A node is the name of a Node. It can be anything and may represent +-type(host() :: binary()). + + +%%% @type nodeId() = binary(). +%%% +%%%

    A nodeId is the name of a Node. It can be anything and may represent %%% some hierarchical tree depending of the node type. %%% For example: %%% /home/localhost/user/node @@ -48,14 +60,66 @@ %%% http://jabber.org/protocol/tune %%% My-Own_Node

    -%%% @type item() = binary(). -%%%

    An item is the name of an Item. It can be anything. +-type(nodeId() :: binary()). + + +%%% @type itemId() = binary(). +%%% +%%%

    An itemId is the name of an Item. It can be anything. %%% For example: %%% 38964 %%% my-tune %%% FD6SBE6a27d

    +-type(itemId() :: binary()). + + +%%% @type subId() = binary(). + +-type(subId() :: binary()). + + +%%% @type nodeType() = string(). +%%% +%%%

    The nodeType is a string containing the name of the PubSub +%%% plugin to use to manage a given node. For example, it can be +%%% "flat", "hometree" or "blog".

    + +-type(nodeType() :: string()). + + +%%% @type ljid() = {User::binary(), Server::binary(), Resource::binary()}. + +-type(ljid() :: {User::binary(), Server::binary(), Resource::binary()}). + + +%%% @type nodeIdx() = integer(). + +-type(nodeIdx() :: integer()). + + +%%% @type now() = {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}. + +-type(now() :: {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}). + + +%%% @type affiliation() = none | owner | publisher | member | outcast. + +-type(affiliation() :: none | owner | publisher | member | outcast). + + +%%% @type subscription() = none | pending | unconfigured | subscribed. + +-type(subscription() :: none | pending | unconfigured | subscribed). + + +%%% @type payload() = string(). + +-type(payload() :: string()). + + %%% @type stanzaError() = #xmlel{}. +%%% %%% Example: %%% ```#xmlel{name = 'error' %%% ns = ?NS_STANZAS, @@ -73,7 +137,11 @@ %%% } %%% ]}''' +-type(stanzaError() :: #xmlel{}). + + %%% @type pubsubIQResponse() = #xmlel{}. +%%% %%% Example: %%% ```#xmlel{name = 'pubsub', %%% ns = ?NS_PUBSUB, @@ -84,84 +152,139 @@ %%% ] %%% }''' -%%% @type nodeOption() = {Option::atom(), Value::term()}. +-type(pubsubIQResponse() :: #xmlel{}). + + +%%% @type nodeOption() = {Option, Value}. +%%% Option = atom() +%%% Value = term(). +%%% %%% Example: %%% ```{deliver_payloads, true}''' -%%% @type nodeType() = string(). -%%%

    The nodeType is a string containing the name of the PubSub -%%% plugin to use to manage a given node. For example, it can be -%%% "flat", "hometree" or "blog".

    +-type(nodeOption() :: {Option::atom(), Value::term()}). -%%% @type ljid() = {User::binary(), Server::binary(), Resource::binary()}. +%%% @type subOption() = {Option, Value}. +%%% Option = atom() +%%% Value = term(). -%%% @type nodeidx() = int() +-type(subOption() :: {Option::atom(), Value::term()}). -%%% @type affiliation() = none | owner | publisher | member | outcast. -%%% @type subscription() = none | pending | unconfigured | subscribed. -%%% internal pubsub index table --record(pubsub_index, {index, last, free}). +%%% @type pubsubIndex() = {pubsub_index, Index, Last, Free}. +%%% Index = atom() +%%% Last = nodeIdx() +%%% Free = [nodeIdx()]. +%%% +%%% Internal pubsub index table. -%%% @type pubsubNode() = #pubsub_node{ -%%% id = {host(), node()}, -%%% idx = nodeidx(), -%%% parents = [Node::pubsubNode()], -%%% type = nodeType(), -%%% owners = [ljid()], -%%% options = [nodeOption()]}. +-record(pubsub_index, +{ + index :: atom(), + last :: integer(), + free :: [integer()] +}). + +-type(pubsubIndex() :: #pubsub_index{}). + + +%%% @type pubsubNode() = {pubsub_node, Id, Idx, Parents, Type, Owners, Options} +%%% Id = {host(), nodeId()} +%%% Idx = nodeIdx() +%%% Parents = [nodeId()] +%%% Type = nodeType() +%%% Owners = [ljid()] +%%% Options = [nodeOption()]. +%%% %%%

    This is the format of the nodes table. The type of the table %%% is: set,ram/disc.

    %%%

    The parents and type fields are indexed.

    -%%%

    nodeidx is an integer.

    --record(pubsub_node, {id, - idx, - parents = [], - type = "flat", - owners = [], - options = [] - }). +%%%

    idx is an integer.

    -%%% @type pubsubState() = #pubsub_state{ -%%% id = {ljid(), nodeidx()}, -%%% items = [item()], -%%% affiliation = affiliation(), -%%% subscriptions = [subscription()]}. -%%%

    This is the format of the affiliations table. The type of the -%%% table is: set,ram/disc.

    --record(pubsub_state, {id, - items = [], - affiliation = none, - subscriptions = [] +-record(pubsub_node, +{ + id :: {host(), nodeId()}, + idx :: nodeIdx(), + parents = [] :: [nodeId()], + type = "flat" :: nodeType(), + owners = [] :: [ljid()], + options = [] :: [nodeOption()] }). -%%% @type pubsubItem() = #pubsub_item{ -%%% id = {item(), nodeidx()}, -%%% creation = {now(), ljid()}, -%%% modification = {now(), ljid()}, -%%% payload = XMLContent::string()}. +-type(pubsubNode() :: #pubsub_node{}). + + +%%% @type pubsubState() = {pubsub_state, Id, Items, Affiliation, Subscriptions} +%%% Id = {ljid(), nodeIdx()} +%%% Items = [itemId()] +%%% Affiliation = affiliation() +%%% Subscriptions = [subscription()]. +%%% +%%%

    This is the format of the affiliations table. The type of the +%%% table is: set,ram/disc.

    + +-record(pubsub_state, +{ + id :: {ljid(), nodeIdx()}, + items = [] :: [itemId()], + affiliation = none :: affiliation(), + subscriptions = [] :: [subscription()] +}). + +-type(pubsubState() :: #pubsub_state{}). + + +%%% @type pubsubItem() = {pubsub_item, Id, Creation, Modification, Payload} +%%% Id = {itemId(), nodeIdx()} +%%% Creation = {now(), ljid()} +%%% Modification = {now(), ljid()} +%%% Payload = payload(). +%%% %%%

    This is the format of the published items table. The type of the %%% table is: set,disc,fragmented.

    --record(pubsub_item, {id, - creation = {unknown,unknown}, - modification = {unknown,unknown}, - payload = [] - }). -%% @type pubsubSubscription() = #pubsub_subscription{ -%% subid = string(), -%% state_key = {ljid(), nodeidx()}, -%% options = [{atom(), term()}] -%% }. +-record(pubsub_item, +{ + id :: {itemId(), nodeIdx()}, + creation = {unknown,unknown} :: {now(), ljid()}, + modification = {unknown,unknown} :: {now(), ljid()}, + payload = [] :: payload() +}). + +-type(pubsubItem() :: #pubsub_item{}). + + +%%% @type pubsubSubscription() = {pubsub_subscription, SubId, Options} +%%% SubId = subId() +%%% Options = [nodeOption()]. +%%% %%

    This is the format of the subscriptions table. The type of the %% table is: set,ram/disc.

    --record(pubsub_subscription, {subid, options}). -%% @type pubsubLastItem() = #pubsub_last_item{ -%% nodeid = nodeidx(), -%% itemid = item(), -%% creation = {now(), ljid()}, -%% payload = XMLContent::string()}. +-record(pubsub_subscription, +{ + subid :: subId(), + options :: [subOption()] +}). + +-type(pubsubSubscription() :: #pubsub_subscription{}). + + +%%% @type pubsubLastItem() = {pubsub_last_item, NodeId, ItemId, Creation, Payload} +%%% NodeId = nodeIdx() +%%% ItemId = itemId() +%%% Creation = {now(), ljid()}() +%%% Payload = payload(). +%%% %%

    This is the format of the last items table. it stores last item payload %% for every node

    --record(pubsub_last_item, {nodeid, itemid, creation, payload}). + +-record(pubsub_last_item, +{ + nodeid :: nodeIdx(), + itemid :: itemId(), + creation :: {now(), ljid()}, + payload :: payload() +}). + +-type(pubsubLastItem() :: #pubsub_last_item{}). diff --git a/src/mod_pubsub/pubsub_odbc.patch b/src/mod_pubsub/pubsub_odbc.patch index e1e483f08..08c274887 100644 --- a/src/mod_pubsub/pubsub_odbc.patch +++ b/src/mod_pubsub/pubsub_odbc.patch @@ -1,5 +1,5 @@ ---- mod_pubsub.erl 2010-09-10 18:04:47.000000000 +0200 -+++ mod_pubsub_odbc.erl 2010-09-10 19:43:53.000000000 +0200 +--- mod_pubsub.erl 2010-09-20 15:56:56.000000000 +0200 ++++ mod_pubsub_odbc.erl 2010-09-20 16:50:49.000000000 +0200 @@ -42,7 +42,7 @@ %%% 6.2.3.1, 6.2.3.5, and 6.3. For information on subscription leases see %%% XEP-0060 section 12.18. @@ -9,7 +9,7 @@ -author('christophe.romain@process-one.net'). -version('1.13-0'). -@@ -55,9 +55,9 @@ +@@ -53,9 +53,9 @@ -include("adhoc.hrl"). -include("pubsub.hrl"). @@ -22,7 +22,7 @@ %% exports for hooks -export([presence_probe/3, -@@ -104,7 +104,7 @@ +@@ -102,7 +102,7 @@ string_to_affiliation/1, extended_error/2, extended_error/3, @@ -31,7 +31,7 @@ ]). %% API and gen_server callbacks -@@ -123,7 +123,7 @@ +@@ -121,7 +121,7 @@ -export([send_loop/1 ]). @@ -40,7 +40,7 @@ -define(LOOPNAME, ejabberd_mod_pubsub_loop). -define(PLUGIN_PREFIX, "node_"). -define(TREE_PREFIX, "nodetree_"). -@@ -220,8 +220,6 @@ +@@ -218,8 +218,6 @@ ok end, ejabberd_router:register_route(Host), @@ -49,7 +49,7 @@ init_nodes(Host, ServerHost, NodeTree, Plugins), State = #state{host = Host, server_host = ServerHost, -@@ -280,209 +278,14 @@ +@@ -278,209 +276,14 @@ init_nodes(Host, ServerHost, _NodeTree, Plugins) -> %% TODO, this call should be done plugin side @@ -262,7 +262,7 @@ send_loop(State) -> receive {presence, JID, Pid} -> -@@ -493,7 +296,10 @@ +@@ -491,7 +294,10 @@ %% for each node From is subscribed to %% and if the node is so configured, send the last published item to From lists:foreach(fun(PType) -> @@ -274,7 +274,7 @@ lists:foreach( fun({Node, subscribed, _, SubJID}) -> if (SubJID == LJID) or (SubJID == BJID) -> -@@ -618,7 +424,8 @@ +@@ -616,7 +422,8 @@ [#xmlel{name = 'identity', ns = ?NS_DISCO_INFO, attrs = [?XMLATTR('category', <<"pubsub">>), ?XMLATTR('type', <<"pep">>)]}]; disco_identity(Host, Node, From) -> @@ -284,7 +284,7 @@ case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, -@@ -649,7 +456,8 @@ +@@ -647,7 +454,8 @@ [?NS_PUBSUB_s | [?NS_PUBSUB_s++"#"++Feature || Feature <- features("pep")]]; disco_features(Host, Node, From) -> @@ -294,7 +294,7 @@ case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> {result, [?NS_PUBSUB_s -@@ -668,7 +476,8 @@ +@@ -666,7 +474,8 @@ {result, disco_items(To, Node, From) ++ OtherItems}. disco_items(Host, <<>>, From) -> @@ -304,7 +304,7 @@ case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, _} -> [#xmlel{name = 'item', ns = ?NS_DISCO_INFO, -@@ -682,13 +491,14 @@ +@@ -680,13 +489,14 @@ _ -> Acc end end, @@ -321,7 +321,7 @@ case get_allowed_items_call(Host, Nidx, From, Type, Options, Owners) of {result, Items} -> {result, -@@ -774,10 +584,10 @@ +@@ -772,10 +582,10 @@ lists:foreach(fun(PType) -> {result, Subscriptions} = node_action(Host, PType, get_entity_subscriptions, [Host, Entity]), lists:foreach(fun @@ -334,7 +334,7 @@ true -> node_action(Host, PType, unsubscribe_node, [Nidx, Entity, JID, all]); false -> -@@ -952,10 +762,11 @@ +@@ -950,10 +760,11 @@ end, ejabberd_router:route(To, From, Res); #iq{type = get, ns = ?NS_DISCO_ITEMS, @@ -348,7 +348,7 @@ {result, IQRes} -> Result = #xmlel{ns = ?NS_DISCO_ITEMS, name = 'query', attrs = QAttrs, -@@ -1092,7 +903,7 @@ +@@ -1090,7 +901,7 @@ [] -> ["leaf"]; %% No sub-nodes: it's a leaf node _ -> @@ -357,7 +357,7 @@ {result, []} -> ["collection"]; {result, _} -> ["leaf", "collection"]; _ -> [] -@@ -1108,8 +919,9 @@ +@@ -1106,8 +917,9 @@ []; true -> [#xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_PUBSUB_s)]} | @@ -369,7 +369,7 @@ end, features(Type))] end, %% TODO: add meta-data info (spec section 5.4) -@@ -1138,8 +950,9 @@ +@@ -1136,8 +948,9 @@ #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_PUBSUB_s)]}, #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_ADHOC_s)]}, #xmlel{ns = ?NS_DISCO_INFO, name = 'feature', attrs = [?XMLATTR('var', ?NS_VCARD_s)]}] ++ @@ -381,7 +381,7 @@ end, features(Host, Node))}; ?NS_ADHOC_b -> command_disco_info(Host, Node, From); -@@ -1149,7 +962,7 @@ +@@ -1147,7 +960,7 @@ node_disco_info(Host, Node, From) end. @@ -390,7 +390,7 @@ case tree_action(Host, get_subnodes, [Host, <<>>, From]) of Nodes when is_list(Nodes) -> {result, lists:map( -@@ -1166,7 +979,7 @@ +@@ -1164,7 +977,7 @@ Other -> Other end; @@ -399,7 +399,7 @@ %% TODO: support localization of this string CommandItems = [ #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', -@@ -1175,19 +988,20 @@ +@@ -1173,19 +986,20 @@ ?XMLATTR('name', "Get Pending") ]}], {result, CommandItems}; @@ -425,7 +425,7 @@ end, Nodes = lists:map( fun(#pubsub_node{id = {_, SubNode}, options = SubOptions}) -> -@@ -1205,7 +1019,7 @@ +@@ -1203,7 +1017,7 @@ {result, Name} = node_call(Type, get_item_name, [Host, Node, RN]), #xmlel{ns = ?NS_DISCO_ITEMS, name = 'item', attrs = [?XMLATTR('jid', Host), ?XMLATTR('name', Name)]} end, NodeItems), @@ -434,7 +434,7 @@ end, case transaction(Host, Node, Action, sync_dirty) of {result, {_, Result}} -> {result, Result}; -@@ -1213,12 +1027,6 @@ +@@ -1211,12 +1025,6 @@ end end. @@ -447,7 +447,7 @@ get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups) -> if (AccessModel == presence) or (AccessModel == roster) -> case Host of -@@ -1336,7 +1144,7 @@ +@@ -1334,7 +1142,7 @@ (_, Acc) -> Acc end, [], exmpp_xml:remove_cdata_from_list(Els)), @@ -456,7 +456,7 @@ {get, 'subscriptions'} -> get_subscriptions(Host, Node, From, Plugins); {get, 'affiliations'} -> -@@ -1493,7 +1301,8 @@ +@@ -1491,7 +1299,8 @@ _ -> [] end end, @@ -466,7 +466,7 @@ sync_dirty) of {result, Res} -> Res; Err -> Err -@@ -1537,7 +1346,7 @@ +@@ -1535,7 +1344,7 @@ %%% authorization handling @@ -475,7 +475,7 @@ Lang = <<"en">>, %% TODO fix {U, S, R} = Subscriber, Stanza = #xmlel{ns = ?NS_JABBER_CLIENT, name = 'message', children = -@@ -1567,7 +1376,7 @@ +@@ -1565,7 +1374,7 @@ lists:foreach(fun(Owner) -> {U, S, R} = Owner, ejabberd_router:route(service_jid(Host), exmpp_jid:make(U, S, R), Stanza) @@ -484,7 +484,7 @@ find_authorization_response(Packet) -> Els = Packet#xmlel.children, -@@ -1626,8 +1435,8 @@ +@@ -1624,8 +1433,8 @@ "true" -> true; _ -> false end, @@ -495,7 +495,7 @@ {result, Subscriptions} = node_call(Type, get_subscriptions, [Nidx, Subscriber]), if not IsApprover -> -@@ -1826,7 +1635,7 @@ +@@ -1824,7 +1633,7 @@ end, Reply = #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [#xmlel{ns = ?NS_PUBSUB, name = 'create', attrs = nodeAttr(Node)}]}, @@ -504,7 +504,7 @@ {result, {NodeId, SubsByDepth, {Result, broadcast}}} -> broadcast_created_node(Host, Node, NodeId, Type, NodeOptions, SubsByDepth), case Result of -@@ -1930,7 +1739,7 @@ +@@ -1928,7 +1737,7 @@ %%
  • The node does not exist.
    • %% subscribe_node(Host, Node, From, JID, Configuration) -> @@ -513,7 +513,7 @@ {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid end, -@@ -1940,7 +1749,7 @@ +@@ -1938,7 +1747,7 @@ _:_ -> {undefined, undefined, undefined} end, @@ -522,7 +522,7 @@ Features = features(Type), SubscribeFeature = lists:member("subscribe", Features), OptionsFeature = lists:member("subscription-options", Features), -@@ -1949,6 +1758,7 @@ +@@ -1947,6 +1756,7 @@ AccessModel = get_option(Options, access_model), SendLast = get_option(Options, send_last_published_item), AllowedGroups = get_option(Options, roster_groups_allowed, []), @@ -530,7 +530,7 @@ {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, Subscriber, Owners, AccessModel, AllowedGroups), if not SubscribeFeature -> -@@ -2293,7 +2103,7 @@ +@@ -2291,7 +2101,7 @@ %%

    The permission are not checked in this function.

    %% @todo We probably need to check that the user doing the query has the right %% to read the items. @@ -539,7 +539,7 @@ MaxItems = if SMaxItems == "" -> get_max_items_node(Host); -@@ -2307,12 +2117,13 @@ +@@ -2305,12 +2115,13 @@ {error, Error} -> {error, Error}; _ -> @@ -554,7 +554,7 @@ {PresenceSubscription, RosterGroup} = get_presence_and_roster_permissions(Host, From, Owners, AccessModel, AllowedGroups), if not RetreiveFeature -> -@@ -2325,11 +2136,11 @@ +@@ -2323,11 +2134,11 @@ node_call(Type, get_items, [Nidx, From, AccessModel, PresenceSubscription, RosterGroup, @@ -568,7 +568,7 @@ SendItems = case ItemIds of [] -> Items; -@@ -2342,7 +2153,7 @@ +@@ -2340,7 +2151,7 @@ %% number of items sent to MaxItems: {result, #xmlel{ns = ?NS_PUBSUB, name = 'pubsub', children = [#xmlel{ns = ?NS_PUBSUB, name = 'items', attrs = nodeAttr(Node), children = @@ -577,7 +577,7 @@ Error -> Error end -@@ -2365,6 +2176,17 @@ +@@ -2363,6 +2174,17 @@ {result, {_, Items}} -> Items; Error -> Error end. @@ -595,7 +595,7 @@ %% @spec (Host, Node, NodeId, Type, LJID, Number) -> any() %% Host = pubsubHost() -@@ -2376,16 +2198,29 @@ +@@ -2374,16 +2196,29 @@ %% @doc

    Resend the items of a node to the user.

    %% @todo use cache-last-item feature send_items(Host, Node, NodeId, Type, LJID, last) -> @@ -631,7 +631,7 @@ send_items(Host, Node, NodeId, Type, {LU, LS, LR} = LJID, Number) -> ToSend = case node_action(Host, Type, get_items, [NodeId, LJID]) of {result, []} -> -@@ -2512,7 +2347,8 @@ +@@ -2510,7 +2345,8 @@ error -> {error, 'bad-request'}; _ -> @@ -641,7 +641,7 @@ case lists:member(Owner, Owners) of true -> OwnerJID = exmpp_jid:make(Owner), -@@ -2522,24 +2358,8 @@ +@@ -2520,24 +2356,8 @@ end, lists:foreach( fun({JID, Affiliation}) -> @@ -668,7 +668,7 @@ end, FilteredEntities), {result, []}; _ -> -@@ -2594,11 +2414,11 @@ +@@ -2592,11 +2412,11 @@ end. read_sub(Subscriber, Node, NodeId, SubId, Lang) -> @@ -682,7 +682,7 @@ OptionsEl = #xmlel{ns = ?NS_PUBSUB, name = 'options', attrs = [ ?XMLATTR('jid', exmpp_jid:to_binary(Subscriber)), ?XMLATTR('subid', SubId) | nodeAttr(Node)], -@@ -2625,7 +2445,7 @@ +@@ -2623,7 +2443,7 @@ end. set_options_helper(Configuration, JID, NodeId, SubId, Type) -> @@ -691,7 +691,7 @@ {result, GoodSubOpts} -> GoodSubOpts; _ -> invalid end, -@@ -2655,7 +2475,7 @@ +@@ -2653,7 +2473,7 @@ write_sub(_Subscriber, _NodeId, _SubId, invalid) -> {error, extended_error('bad-request', "invalid-options")}; write_sub(Subscriber, NodeId, SubId, Options) -> @@ -700,7 +700,7 @@ {error, notfound} -> {error, extended_error('not-acceptable', "invalid-subid")}; {result, _} -> -@@ -2829,8 +2649,8 @@ +@@ -2827,8 +2647,8 @@ ?XMLATTR('subsription', subscription_to_string(Sub)) | nodeAttr(Node)]}]}]}, ejabberd_router:route(service_jid(Host), JID, Stanza) end, @@ -711,7 +711,7 @@ true -> Result = lists:foldl(fun({JID, Subscription, SubId}, Acc) -> -@@ -3179,7 +2999,7 @@ +@@ -3177,7 +2997,7 @@ {Depth, [{N, get_node_subs(N)} || N <- Nodes]} end, tree_call(Host, get_parentnodes_tree, [Host, Node, service_jid(Host)]))} end, @@ -720,7 +720,7 @@ {result, CollSubs} -> CollSubs; _ -> [] end. -@@ -3192,7 +3012,7 @@ +@@ -3190,7 +3010,7 @@ get_options_for_subs(Nidx, Subs) -> lists:foldl(fun({JID, subscribed, SubId}, Acc) -> @@ -729,7 +729,7 @@ {error, notfound} -> [{JID, SubId, []} | Acc]; #pubsub_subscription{options = Options} -> [{JID, SubId, Options} | Acc]; _ -> Acc -@@ -3416,6 +3236,30 @@ +@@ -3414,6 +3234,30 @@ Result end. @@ -760,7 +760,7 @@ %% @spec (Host, Options) -> MaxItems %% Host = host() %% Options = [Option] -@@ -3819,7 +3663,13 @@ +@@ -3817,7 +3661,13 @@ tree_action(Host, Function, Args) -> ?DEBUG("tree_action ~p ~p ~p",[Host,Function,Args]), Fun = fun() -> tree_call(Host, Function, Args) end, @@ -775,7 +775,7 @@ %% @doc

    node plugin call.

    node_call(Type, Function, Args) -> -@@ -3839,13 +3689,13 @@ +@@ -3837,13 +3687,13 @@ node_action(Host, Type, Function, Args) -> ?DEBUG("node_action ~p ~p ~p ~p",[Host,Type,Function,Args]), @@ -791,7 +791,7 @@ case tree_call(Host, get_node, [Host, Node]) of N when is_record(N, pubsub_node) -> case Action(N) of -@@ -3858,13 +3708,20 @@ +@@ -3856,13 +3706,20 @@ end end, Trans). @@ -816,7 +816,7 @@ {result, Result} -> {result, Result}; {error, Error} -> {error, Error}; {atomic, {result, Result}} -> {result, Result}; -@@ -3872,6 +3729,15 @@ +@@ -3870,6 +3727,15 @@ {aborted, Reason} -> ?ERROR_MSG("transaction return internal error: ~p~n", [{aborted, Reason}]), {error, 'internal-server-error'}; @@ -832,7 +832,7 @@ {'EXIT', Reason} -> ?ERROR_MSG("transaction return internal error: ~p~n", [{'EXIT', Reason}]), {error, 'internal-server-error'}; -@@ -3880,6 +3746,16 @@ +@@ -3878,6 +3744,16 @@ {error, 'internal-server-error'} end. diff --git a/src/mod_pubsub/pubsub_subscription.erl b/src/mod_pubsub/pubsub_subscription.erl index 87753acde..7e129068d 100644 --- a/src/mod_pubsub/pubsub_subscription.erl +++ b/src/mod_pubsub/pubsub_subscription.erl @@ -39,7 +39,6 @@ write_subscription/4]). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -define(PUBSUB_DELIVER, "pubsub#deliver"). -define(PUBSUB_DIGEST, "pubsub#digest"). diff --git a/src/mod_pubsub/pubsub_subscription_odbc.erl b/src/mod_pubsub/pubsub_subscription_odbc.erl index 88070a136..b03b10cd2 100644 --- a/src/mod_pubsub/pubsub_subscription_odbc.erl +++ b/src/mod_pubsub/pubsub_subscription_odbc.erl @@ -37,7 +37,6 @@ -include_lib("stdlib/include/qlc.hrl"). -include("pubsub.hrl"). --include_lib("exmpp/include/exmpp.hrl"). -define(PUBSUB_DELIVER, "pubsub#deliver"). -define(PUBSUB_DIGEST, "pubsub#digest"). From d4480c1361796fc1341182f33ae26a52e9b77a43 Mon Sep 17 00:00:00 2001 From: Evgeniy Khramtsov Date: Tue, 21 Sep 2010 04:31:18 +1000 Subject: [PATCH 13/34] fixes default value for cache_life_time --- src/mod_caps.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mod_caps.erl b/src/mod_caps.erl index 27bdbcbdc..5cd8e274d 100644 --- a/src/mod_caps.erl +++ b/src/mod_caps.erl @@ -205,7 +205,7 @@ init([Host, Opts]) -> {attributes, record_info(fields, caps_features)}]), mnesia:add_table_copy(caps_features, node(), disc_only_copies), MaxSize = gen_mod:get_opt(cache_size, Opts, 1000), - LifeTime = gen_mod:get_opt(cache_life_time, Opts, timer:hours(24)), + LifeTime = gen_mod:get_opt(cache_life_time, Opts, timer:hours(24) div 1000), cache_tab:new(caps_features, [{max_size, MaxSize}, {life_time, LifeTime}]), HostB = list_to_binary(Host), ejabberd_hooks:add(user_send_packet, HostB, ?MODULE, user_send_packet, 75), From 62b3b31b8d44390dd17dca0303f5e522e206a64f Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 21 Sep 2010 17:05:50 +0200 Subject: [PATCH 14/34] Allow webadmins to change roster of user (EJAB-72) --- src/mod_roster.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mod_roster.erl b/src/mod_roster.erl index 573ffb96d..1a7756113 100644 --- a/src/mod_roster.erl +++ b/src/mod_roster.erl @@ -1518,7 +1518,7 @@ user_roster_item_parse_query(User, Server, Items, Query) -> ns = ?NS_ROSTER, name = 'query', children = [Item]}, - process_iq( + process_iq_set( UJID, UJID, #iq{type = set, ns = ?NS_JABBER_CLIENT, payload = Request}), throw(submitted); From a46f02a13663c91ac3d72d6fe0ffd44ee7708a64 Mon Sep 17 00:00:00 2001 From: Badlop Date: Wed, 22 Sep 2010 00:14:47 +0200 Subject: [PATCH 15/34] Fix typo in type --- src/mod_pubsub/pubsub.hrl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index e45d4597f..2ab6a112d 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -273,7 +273,7 @@ %%% @type pubsubLastItem() = {pubsub_last_item, NodeId, ItemId, Creation, Payload} %%% NodeId = nodeIdx() %%% ItemId = itemId() -%%% Creation = {now(), ljid()}() +%%% Creation = {now(), ljid()} %%% Payload = payload(). %%% %%

    This is the format of the last items table. it stores last item payload From 73c992c5af24cc9006d8215b130a7b3d65a82bdb Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 27 Sep 2010 13:31:50 +0200 Subject: [PATCH 16/34] Delete compiled files from git; they are included in source package (EJAB-1311) --- doc/Makefile | 1 + doc/dev.html | 412 ---- doc/features.html | 131 - doc/guide.html | 4174 ------------------------------- doc/version.tex | 2 - src/configure | 5977 --------------------------------------------- 6 files changed, 1 insertion(+), 10696 deletions(-) delete mode 100644 doc/dev.html delete mode 100644 doc/features.html delete mode 100644 doc/guide.html delete mode 100644 doc/version.tex delete mode 100755 src/configure diff --git a/doc/Makefile b/doc/Makefile index a7ea171f2..b6235a2db 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -35,6 +35,7 @@ clean: rm -f *.out rm -f *.pdf rm -f *.toc + rm -f version.tex [ ! -f contributed_modules.tex ] || rm contributed_modules.tex distclean: clean diff --git a/doc/dev.html b/doc/dev.html deleted file mode 100644 index 9360a7987..000000000 --- a/doc/dev.html +++ /dev/null @@ -1,412 +0,0 @@ - - - -Ejabberd 3.0.0-prealpha Developers Guide - - - - - - - - -

    - -

    -

    Ejabberd 3.0.0-prealpha Developers Guide

    Alexey Shchepin
    - mailto:alexey@sevcom.net
    - xmpp:aleksey@jabber.ru

    - -logo.png - - -
    I can thoroughly recommend ejabberd for ease of setup – -Kevin Smith, Current maintainer of the Psi project
    -

    Contents

    Introduction -

    ejabberd is a free and open source instant messaging server written in Erlang/OTP.

    ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

    ejabberd is designed to be a rock-solid and feature rich XMPP server.

    ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.

    -

    1  Key Features

    - -

    ejabberd is: -

    • -Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
    • Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
    • Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.
    • Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: -
      • -Comprehensive documentation. -
      • Straightforward installers for Linux, Mac OS X, and Windows.
      • Web Administration. -
      • Shared Roster Groups. -
      • Command line administration tool.
      • Can integrate with existing authentication mechanisms. -
      • Capability to send announce messages. -
    • Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -
      • -Translated to 24 languages.
      • Support for IDNA. -
    • Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -
    -

    2  Additional Features

    - -

    Moreover, ejabberd comes with a wide range of other state-of-the-art features: -

    • -Modular -
      • -Load only the modules you want. -
      • Extend ejabberd with your own custom modules. -
      -
    • Security -
      • -SASL and STARTTLS for c2s and s2s connections. -
      • STARTTLS and Dialback s2s connections. -
      • Web Admin accessible via HTTPS secure access. -
      -
    • Databases -
      • -Internal database for fast deployment (Mnesia). -
      • Native MySQL support. -
      • Native PostgreSQL support. -
      • ODBC data storage support. -
      • Microsoft SQL Server support.
      -
    • Authentication -
      • -Internal Authentication. -
      • PAM, LDAP and ODBC.
      • External Authentication script. -
      -
    • Others -
      • -Support for virtual hosting. -
      • Compressing XML streams with Stream Compression (XEP-0138). -
      • Statistics via Statistics Gathering (XEP-0039). -
      • IPv6 support both for c2s and s2s connections. -
      • Multi-User Chat module with support for clustering and HTML logging.
      • Users Directory based on users vCards. -
      • Publish-Subscribe component with support for Personal Eventing via Pubsub. -
      • Support for web clients: HTTP Polling and HTTP Binding (BOSH) services. -
      • Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. -
      -
    -

    3  How it Works

    -

    A XMPP domain is served by one or more ejabberd nodes. These nodes can -be run on different machines that are connected via a network. They all must -have the ability to connect to port 4369 of all another nodes, and must have -the same magic cookie (see Erlang/OTP documentation, in other words the file -~ejabberd/.erlang.cookie must be the same on all nodes). This is -needed because all nodes exchange information about connected users, S2S -connections, registered services, etc…

    Each ejabberd node have following modules: -

    • -router; -
    • local router. -
    • session manager; -
    • S2S manager; -
    -

    3.1  Router

    This module is the main router of XMPP packets on each node. It routes -them based on their destinations domains. It has two tables: local and global -routes. First, domain of packet destination searched in local table, and if it -found, then the packet is routed to appropriate process. If no, then it -searches in global table, and is routed to the appropriate ejabberd node or -process. If it does not exists in either tables, then it sent to the S2S -manager.

    -

    3.2  Local Router

    This module routes packets which have a destination domain equal to this server -name. If destination JID has a non-empty user part, then it routed to the -session manager, else it is processed depending on it’s content.

    -

    3.3  Session Manager

    This module routes packets to local users. It searches for what user resource -packet must be sended via presence table. If this resource is connected to -this node, it is routed to C2S process, if it connected via another node, then -the packet is sent to session manager on that node.

    -

    3.4  S2S Manager

    This module routes packets to other XMPP servers. First, it checks if an -open S2S connection from the domain of the packet source to the domain of -packet destination already exists. If it is open on another node, then it -routes the packet to S2S manager on that node, if it is open on this node, then -it is routed to the process that serves this connection, and if a connection -does not exist, then it is opened and registered.

    -

    4  Authentication

    -

    4.0.1  External

    - -

    The external authentication script follows -the erlang port driver API.

    That script is supposed to do theses actions, in an infinite loop: -

    • -read from stdin: AABBBBBBBBB..... -
      • -A: 2 bytes of length data (a short in network byte order) -
      • B: a string of length found in A that contains operation in plain text -operation are as follows: -
        • -auth:User:Server:Password (check if a username/password pair is correct) -
        • isuser:User:Server (check if it’s a valid user) -
        • setpass:User:Server:Password (set user’s password) -
        • tryregister:User:Server:Password (try to register an account) -
        • removeuser:User:Server (remove this account) -
        • removeuser3:User:Server:Password (remove this account if the password is correct) -
        -
      -
    • write to stdout: AABB -
      • -A: the number 2 (coded as a short, which is bytes length of following result) -
      • B: the result code (coded as a short), should be 1 for success/valid, or 0 for failure/invalid -
      -

    Example python script -

    #!/usr/bin/python
-
-import sys
-from struct import *
-
-def from_ejabberd():
-    input_length = sys.stdin.read(2)
-    (size,) = unpack('>h', input_length)
-    return sys.stdin.read(size).split(':')
-
-def to_ejabberd(bool):
-    answer = 0
-    if bool:
-        answer = 1
-    token = pack('>hh', 2, answer)
-    sys.stdout.write(token)
-    sys.stdout.flush()
-
-def auth(username, server, password):
-    return True
-
-def isuser(username, server):
-    return True
-
-def setpass(username, server, password):
-    return True
-
-while True:
-    data = from_ejabberd()
-    success = False
-    if data[0] == "auth":
-        success = auth(data[1], data[2], data[3])
-    elif data[0] == "isuser":
-        success = isuser(data[1], data[2])
-    elif data[0] == "setpass":
-        success = setpass(data[1], data[2], data[3])
-    to_ejabberd(success)
-
    -

    5  XML Representation

    -

    Each XML stanza is represented as the following tuple: -

    XMLElement = {xmlelement, Name, Attrs, [ElementOrCDATA]}
-        Name = string()
-        Attrs = [Attr]
-        Attr = {Key, Val}
-        Key = string()
-        Val = string()
-        ElementOrCDATA = XMLElement | CDATA
-        CDATA = {xmlcdata, string()}
-

    E. g. this stanza: -

    <message to='test@conference.example.org' type='groupchat'>
-  <body>test</body>
-</message>
-

    is represented as the following structure: -

    {xmlelement, "message",
-    [{"to", "test@conference.example.org"},
-     {"type", "groupchat"}],
-    [{xmlelement, "body",
-         [],
-         [{xmlcdata, "test"}]}]}}
-
    -

    6  Module xml

    -

    -
    element_to_string(El) -> string() -
    El = XMLElement
-
    Returns string representation of XML stanza El.
    crypt(S) -> string() -
    S = string()
-
    Returns string which correspond to S with encoded XML special -characters.
    remove_cdata(ECList) -> EList -
    ECList = [ElementOrCDATA]
-EList = [XMLElement]
-
    EList is a list of all non-CDATA elements of ECList.
    get_path_s(El, Path) -> Res -
    El = XMLElement
-Path = [PathItem]
-PathItem = PathElem | PathAttr | PathCDATA
-PathElem = {elem, Name}
-PathAttr = {attr, Name}
-PathCDATA = cdata
-Name = string()
-Res = string() | XMLElement
-
    If Path is empty, then returns El. Else sequentially -consider elements of Path. Each element is one of: -
    -
    {elem, Name} Name is name of subelement of -El, if such element exists, then this element considered in -following steps, else returns empty string. -
    {attr, Name} If El have attribute Name, then -returns value of this attribute, else returns empty string. -
    cdata Returns CDATA of El. -
    TODO: -
             get_cdata/1, get_tag_cdata/1
-         get_attr/2, get_attr_s/2
-         get_tag_attr/2, get_tag_attr_s/2
-         get_subtag/2
-
    -

    7  Module xml_stream

    -

    -
    parse_element(Str) -> XMLElement | {error, Err} -
    Str = string()
-Err = term()
-
    Parses Str using XML parser, returns either parsed element or error -tuple. -
    -

    8  Modules

    -

    -

    8.1  Module gen_iq_handler

    -

    The module gen_iq_handler allows to easily write handlers for IQ packets -of particular XML namespaces that addressed to server or to users bare JIDs.

    In this module the following functions are defined: -

    -
    add_iq_handler(Component, Host, NS, Module, Function, Type) -
    Component = Module = Function = atom()
-Host = NS = string()
-Type = no_queue | one_queue | parallel
-
    Registers function Module:Function as handler for IQ packets on -virtual host Host that contain child of namespace NS in -Component. Queueing discipline is Type. There are at least -two components defined: -
    -
    ejabberd_local Handles packets that addressed to server JID; -
    ejabberd_sm Handles packets that addressed to users bare JIDs. -
    -
    remove_iq_handler(Component, Host, NS) -
    Component = atom()
-Host = NS = string()
-
    Removes IQ handler on virtual host Host for namespace NS from -Component. -

    Handler function must have the following type: -

    -
    Module:Function(From, To, IQ) -
    From = To = jid()
-
    -module(mod_cputime).
-
--behaviour(gen_mod).
-
--export([start/2,
-         stop/1,
-         process_local_iq/3]).
-
--include("ejabberd.hrl").
--include("jlib.hrl").
-
--define(NS_CPUTIME, "ejabberd:cputime").
-
-start(Host, Opts) ->
-    IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue),
-    gen_iq_handler:add_iq_handler(ejabberd_local, Host, ?NS_CPUTIME,
-                                  ?MODULE, process_local_iq, IQDisc).
-
-stop(Host) ->
-    gen_iq_handler:remove_iq_handler(ejabberd_local, Host, ?NS_CPUTIME).
-
-process_local_iq(From, To, {iq, ID, Type, XMLNS, SubEl}) ->
-    case Type of
-        set ->
-            {iq, ID, error, XMLNS,
-             [SubEl, ?ERR_NOT_ALLOWED]};
-        get ->
-            CPUTime = element(1, erlang:statistics(runtime))/1000,
-            SCPUTime = lists:flatten(io_lib:format("~.3f", CPUTime)),
-            {iq, ID, result, XMLNS,
-             [{xmlelement, "query",
-               [{"xmlns", ?NS_CPUTIME}],
-               [{xmlelement, "cputime", [], [{xmlcdata, SCPUTime}]}]}]}
-    end.
-
    -

    8.2  Services

    -

    -module(mod_echo).
-
--behaviour(gen_mod).
-
--export([start/2, init/1, stop/1]).
-
--include("ejabberd.hrl").
--include("jlib.hrl").
-
-start(Host, Opts) ->
-    MyHost = gen_mod:get_opt(host, Opts, "echo." ++ Host),
-    register(gen_mod:get_module_proc(Host, ?PROCNAME),
-             spawn(?MODULE, init, [MyHost])).
-
-init(Host) ->
-    ejabberd_router:register_local_route(Host),
-    loop(Host).
-
-loop(Host) ->
-    receive
-        {route, From, To, Packet} ->
-            ejabberd_router:route(To, From, Packet),
-            loop(Host);
-        stop ->
-            ejabberd_router:unregister_route(Host),
-            ok;
-        _ ->
-            loop(Host)
-    end.
-
-stop(Host) ->
-    Proc = gen_mod:get_module_proc(Host, ?PROCNAME),
-    Proc ! stop,
-    {wait, Proc}.
-
    - - - -
    This document was translated from LATEX by -HEVEA.
    - diff --git a/doc/features.html b/doc/features.html deleted file mode 100644 index 62f98324d..000000000 --- a/doc/features.html +++ /dev/null @@ -1,131 +0,0 @@ - - - -Ejabberd 3.0.0-prealpha Feature Sheet - - - - - - - - -

    - -

    -

    Ejabberd 3.0.0-prealpha Feature Sheet

    Sander Devrieze
    - mailto:s.devrieze@pandora.be
    - xmpp:sander@devrieze.dyndns.org

    - -logo.png - - -
    I can thoroughly recommend ejabberd for ease of setup – -Kevin Smith, Current maintainer of the Psi project

    Introduction -

    I just tried out ejabberd and was impressed both by ejabberd itself and the language it is written in, Erlang. — -Joeri

    ejabberd is a free and open source instant messaging server written in Erlang/OTP.

    ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

    ejabberd is designed to be a rock-solid and feature rich XMPP server.

    ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.

    -

    Key Features

    - -

    Erlang seems to be tailor-made for writing stable, robust servers. — -Peter Saint-André, Executive Director of the Jabber Software Foundation

    ejabberd is: -

    • -Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
    • Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
    • Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.
    • Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: -
      • -Comprehensive documentation. -
      • Straightforward installers for Linux, Mac OS X, and Windows.
      • Web Administration. -
      • Shared Roster Groups. -
      • Command line administration tool.
      • Can integrate with existing authentication mechanisms. -
      • Capability to send announce messages. -
    • Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -
      • -Translated to 24 languages.
      • Support for IDNA. -
    • Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -
    -

    Additional Features

    - -

    ejabberd is making inroads to solving the "buggy incomplete server" problem — -Justin Karneges, Founder of the Psi and the Delta projects

    Moreover, ejabberd comes with a wide range of other state-of-the-art features: -

    • -Modular -
      • -Load only the modules you want. -
      • Extend ejabberd with your own custom modules. -
      -
    • Security -
      • -SASL and STARTTLS for c2s and s2s connections. -
      • STARTTLS and Dialback s2s connections. -
      • Web Admin accessible via HTTPS secure access. -
      -
    • Databases -
      • -Internal database for fast deployment (Mnesia). -
      • Native MySQL support. -
      • Native PostgreSQL support. -
      • ODBC data storage support. -
      • Microsoft SQL Server support.
      -
    • Authentication -
      • -Internal Authentication. -
      • PAM, LDAP and ODBC.
      • External Authentication script. -
      -
    • Others -
      • -Support for virtual hosting. -
      • Compressing XML streams with Stream Compression (XEP-0138). -
      • Statistics via Statistics Gathering (XEP-0039). -
      • IPv6 support both for c2s and s2s connections. -
      • Multi-User Chat module with support for clustering and HTML logging.
      • Users Directory based on users vCards. -
      • Publish-Subscribe component with support for Personal Eventing via Pubsub. -
      • Support for web clients: HTTP Polling and HTTP Binding (BOSH) services. -
      • Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. -
      -
    - - - -
    This document was translated from LATEX by -HEVEA.
    - diff --git a/doc/guide.html b/doc/guide.html deleted file mode 100644 index c242dbb77..000000000 --- a/doc/guide.html +++ /dev/null @@ -1,4174 +0,0 @@ - - - - - - - - ejabberd 3.0.0-alpha-x - - Installation and Operation Guide - - - - - - - - - - - - - - -

    - -

    -

    -

    -
    - - - - -
    ejabberd 3.0.0-alpha-x
     
    Installation and Operation Guide

    -
    - -
    - -

    -

    -

    Contents

    -

    Chapter 1  Introduction

    -

    ejabberd is a free and open source instant messaging server written in Erlang/OTP.

    ejabberd is cross-platform, distributed, fault-tolerant, and based on open standards to achieve real-time communication.

    ejabberd is designed to be a rock-solid and feature rich XMPP server.

    ejabberd is suitable for small deployments, whether they need to be scalable or not, as well as extremely big deployments.

    -

    1.1  Key Features

    - -

    ejabberd is: -

    • -Cross-platform: ejabberd runs under Microsoft Windows and Unix derived systems such as Linux, FreeBSD and NetBSD.
    • Distributed: You can run ejabberd on a cluster of machines and all of them will serve the same Jabber domain(s). When you need more capacity you can simply add a new cheap node to your cluster. Accordingly, you do not need to buy an expensive high-end machine to support tens of thousands concurrent users.
    • Fault-tolerant: You can deploy an ejabberd cluster so that all the information required for a properly working service will be replicated permanently on all nodes. This means that if one of the nodes crashes, the others will continue working without disruption. In addition, nodes also can be added or replaced ‘on the fly’.
    • Administrator Friendly: ejabberd is built on top of the Open Source Erlang. As a result you do not need to install an external database, an external web server, amongst others because everything is already included, and ready to run out of the box. Other administrator benefits include: -
      • -Comprehensive documentation. -
      • Straightforward installers for Linux, Mac OS X, and Windows.
      • Web Administration. -
      • Shared Roster Groups. -
      • Command line administration tool.
      • Can integrate with existing authentication mechanisms. -
      • Capability to send announce messages. -
    • Internationalized: ejabberd leads in internationalization. Hence it is very well suited in a globalized world. Related features are: -
      • -Translated to 24 languages.
      • Support for IDNA. -
    • Open Standards: ejabberd is the first Open Source Jabber server claiming to fully comply to the XMPP standard. -
    -

    1.2  Additional Features

    - -

    Moreover, ejabberd comes with a wide range of other state-of-the-art features: -

    • -Modular -
      • -Load only the modules you want. -
      • Extend ejabberd with your own custom modules. -
      -
    • Security -
      • -SASL and STARTTLS for c2s and s2s connections. -
      • STARTTLS and Dialback s2s connections. -
      • Web Admin accessible via HTTPS secure access. -
      -
    • Databases -
      • -Internal database for fast deployment (Mnesia). -
      • Native MySQL support. -
      • Native PostgreSQL support. -
      • ODBC data storage support. -
      • Microsoft SQL Server support.
      -
    • Authentication -
      • -Internal Authentication. -
      • PAM, LDAP and ODBC.
      • External Authentication script. -
      -
    • Others -
      • -Support for virtual hosting. -
      • Compressing XML streams with Stream Compression (XEP-0138). -
      • Statistics via Statistics Gathering (XEP-0039). -
      • IPv6 support both for c2s and s2s connections. -
      • Multi-User Chat module with support for clustering and HTML logging.
      • Users Directory based on users vCards. -
      • Publish-Subscribe component with support for Personal Eventing via Pubsub. -
      • Support for web clients: HTTP Polling and HTTP Binding (BOSH) services. -
      • Component support: interface with networks such as AIM, ICQ and MSN installing special tranports. -
      -

    -

    Chapter 2  Installing ejabberd

    -

    2.1  Installing ejabberd with Binary Installer

    Probably the easiest way to install an ejabberd instant messaging server -is using the binary installer published by ProcessOne. -The binary installers of released ejabberd versions -are available in the ProcessOne ejabberd downloads page: -http://www.process-one.net/en/ejabberd/downloads

    The installer will deploy and configure a full featured ejabberd -server and does not require any extra dependencies.

    In *nix systems, remember to set executable the binary installer before starting it. For example: -

    chmod +x ejabberd-2.0.0_1-linux-x86-installer.bin
-./ejabberd-2.0.0_1-linux-x86-installer.bin
-

    ejabberd can be started manually at any time, -or automatically by the operating system at system boot time.

    To start and stop ejabberd manually, -use the desktop shortcuts created by the installer. -If the machine doesn’t have a graphical system, use the scripts ’start’ -and ’stop’ in the ’bin’ directory where ejabberd is installed.

    The Windows installer also adds ejabberd as a system service, -and a shortcut to a debug console for experienced administrators. -If you want ejabberd to be started automatically at boot time, -go to the Windows service settings and set ejabberd to be automatically started. -Note that the Windows service is a feature still in development, -and for example it doesn’t read the file ejabberdctl.cfg.

    On a *nix system, if you want ejabberd to be started as daemon at boot time, -copy ejabberd.init from the ’bin’ directory to something like /etc/init.d/ejabberd -(depending on your distribution). -Create a system user called ejabberd; -it will be used by the script to start the server. -Then you can call /etc/inid.d/ejabberd start as root to start the server.

    If ejabberd doesn’t start correctly in Windows, -try to start it using the shortcut in desktop or start menu. -If the window shows error 14001, the solution is to install: -"Microsoft Visual C++ 2005 SP1 Redistributable Package". -You can download it from -www.microsoft.com. -Then uninstall ejabberd and install it again.

    If ejabberd doesn’t start correctly and a crash dump is generated, -there was a severe problem. -You can try starting ejabberd with -the script bin/live.bat in Windows, -or with the command bin/ejabberdctl live in other Operating Systems. -This way you see the error message provided by Erlang -and can identify what is exactly the problem.

    The ejabberdctl administration script is included in the bin directory. -Please refer to the section 4.1 for details about ejabberdctl, -and configurable options to fine tune the Erlang runtime system.

    -

    2.2  Installing ejabberd with Operating System Specific Packages

    Some Operating Systems provide a specific ejabberd package adapted to -the system architecture and libraries. -It usually also checks dependencies -and performs basic configuration tasks like creating the initial -administrator account. Some examples are Debian and Gentoo. Consult the -resources provided by your Operating System for more information.

    Usually those packages create a script like /etc/init.d/ejabberd -to start and stop ejabberd as a service at boot time.

    -

    2.3  Installing ejabberd with CEAN

    CEAN -(Comprehensive Erlang Archive Network) is a repository that hosts binary -packages from many Erlang programs, including ejabberd and all its dependencies. -The binaries are available for many different system architectures, so this is an -alternative to the binary installer and Operating System’s ejabberd packages.

    You will have to create your own ejabberd start -script depending of how you handle your CEAN installation. -The default ejabberdctl script is located -into ejabberd’s priv directory and can be used as an example.

    -

    2.4  Installing ejabberd from Source Code

    -

    The canonical form for distribution of ejabberd stable releases is the source code package. -Compiling ejabberd from source code is quite easy in *nix systems, -as long as your system have all the dependencies.

    -

    2.4.1  Requirements

    -

    To compile ejabberd on a ‘Unix-like’ operating system, you need: -

    • -GNU Make -
    • GCC -
    • Erlang/OTP R12B-5 or higher. -
    • exmpp 0.9.6 or higher -
    • OpenSSL 0.9.8 or higher, for STARTTLS, SASL and SSL encryption. -
    • Zlib 1.2.3 or higher, for Stream Compression support (XEP-0138). Optional. -
    • Erlang mysql library. Optional. For MySQL authentication or storage. See section 3.2.1. -
    • Erlang pgsql library. Optional. For PostgreSQL authentication or storage. See section 3.2.3. -
    • PAM library. Optional. For Pluggable Authentication Modules (PAM). See section 3.1.4. -
    • ESASL library. Optional. For SASL GSSAPI authentication. See section 3.1.4. -
    • ImageMagick’s Convert program. Optional. For CAPTCHA challenges. See section 3.1.8. -

    -

    2.4.2  Download Source Code

    -

    Released versions of ejabberd are available in the ProcessOne ejabberd downloads page: -http://www.process-one.net/en/ejabberd/downloads

    -Alternatively, the latest development source code can be retrieved from the Git repository using the commands: -

    git clone git://git.process-one.net/ejabberd/mainline.git ejabberd
-cd ejabberd
-

    -

    2.4.3  Compile

    -

    To compile ejabberd execute the commands: -

    ./configure
-make
-

    The build configuration script allows several options. -To get the full list run the command: -

    ./configure --help
-

    Some options that you may be interested in modifying: -

    - --prefix=/
    - Specify the path prefix where the files will be copied when running - the make install command.

    --enable-user[=USER]
    - Allow this normal system user to execute the ejabberdctl script - (see section 4.1), - read the configuration files, - read and write in the spool directory, - read and write in the log directory. - The account user and group must exist in the machine - before running make install. - This account doesn’t need an explicit HOME directory, because - /var/lib/ejabberd/ will be used by default.

    --enable-pam
    - Enable the PAM authentication method (see section 3.1.4).

    --enable-odbc or --enable-mssql
    - Required if you want to use an external database. - See section 3.2 for more information.

    --enable-full-xml
    - Enable the use of XML based optimisations. - It will for example use CDATA to escape characters in the XMPP stream. - Use this option only if you are sure your XMPP clients include a fully compliant XML parser.

    --disable-transient-supervisors
    - Disable the use of Erlang/OTP supervision for transient processes. -

    -

    2.4.4  Install

    -

    To install ejabberd in the destination directories, run the command: -

    make install
-

    Note that you probably need administrative privileges in the system -to install ejabberd.

    The files and directories created are, by default: -

    - /etc/ejabberd/
    Configuration directory: -
    - ejabberd.cfg
    ejabberd configuration file -
    ejabberdctl.cfg
    Configuration file of the administration script -
    inetrc
    Network DNS configuration file -
    -
    /lib/ejabberd/
    -
    - ebin/
    Erlang binary files (*.beam) -
    include/
    Erlang header files (*.hrl) -
    priv/
    Additional files required at runtime -
    - bin/
    Executable programs -
    lib/
    Binary system libraries (*.so) -
    msgs/
    Translation files (*.msgs) -
    -
    -
    /sbin/ejabberdctl
    Administration script (see section 4.1) -
    /share/doc/ejabberd/
    Documentation of ejabberd -
    /var/lib/ejabberd/
    Spool directory: -
    - .erlang.cookie
    Erlang cookie file (see section 5.3) -
    acl.DCD, ...
    Mnesia database spool files (*.DCD, *.DCL, *.DAT) -
    -
    /var/log/ejabberd/
    Log directory (see section 7.1): -
    - ejabberd.log
    ejabberd service log -
    erlang.log
    Erlang/OTP system log -
    -

    -

    2.4.5  Start

    -

    You can use the ejabberdctl command line administration script to start and stop ejabberd. -If you provided the configure option --enable-user=USER (see 2.4.3), -you can execute ejabberdctl with either that system account or root.

    Usage example: -

    ejabberdctl start
-
-ejabberdctl status
-The node ejabberd@localhost is started with status: started
-ejabberd is running in that node
-
-ejabberdctl stop
-

    If ejabberd doesn’t start correctly and a crash dump is generated, -there was a severe problem. -You can try starting ejabberd with -the command ejabberdctl live -to see the error message provided by Erlang -and can identify what is exactly the problem.

    Please refer to the section 4.1 for details about ejabberdctl, -and configurable options to fine tune the Erlang runtime system.

    If you want ejabberd to be started as daemon at boot time, -copy ejabberd.init to something like /etc/init.d/ejabberd -(depending on your distribution). -Create a system user called ejabberd; -it will be used by the script to start the server. -Then you can call /etc/inid.d/ejabberd start as root to start the server.

    -

    2.4.6  Specific Notes for BSD

    -

    The command to compile ejabberd in BSD systems is: -

    gmake
-

    -

    2.4.7  Specific Notes for Sun Solaris

    -

    You need to have GNU install, -but it isn’t included in Solaris. -It can be easily installed if your Solaris system -is set up for blastwave.org -package repository. -Make sure /opt/csw/bin is in your PATH and run: -

    pkg-get -i fileutils
-

    If that program is called ginstall, -modify the ejabberd Makefile script to suit your system, -for example: -

    cat Makefile | sed s/install/ginstall/ > Makefile.gi
-

    And finally install ejabberd with: -

    gmake -f Makefile.gi ginstall
-

    -

    2.4.8  Specific Notes for Microsoft Windows

    -

    -

    Requirements

    To compile ejabberd on a Microsoft Windows system, you need: -

    -

    Compilation

    We assume that we will try to put as much library as possible into C:\sdk\ to make it easier to track what is install for ejabberd.

    1. -Install Erlang emulator (for example, into C:\sdk\erl5.6.5). -
    2. Install OpenSSL in C:\sdk\OpenSSL and add C:\sdk\OpenSSL\lib\VC to your path or copy the binaries to your system directory. -
    3. Install ZLib in C:\sdk\gnuWin32. Copy -C:\sdk\GnuWin32\bin\zlib1.dll to your system directory. -
    4. Make sure the you can access Erlang binaries from your path. For example: set PATH=%PATH%;"C:\sdk\erl5.6.5\bin" -
    5. Depending on how you end up actually installing the library you might need to check and tweak the paths in the file configure.erl. -
    6. While in the directory ejabberd\src run: -
      configure.bat
-nmake -f Makefile.win32
-
    7. Edit the file ejabberd\src\ejabberd.cfg and run -
      werl -s ejabberd -name ejabberd
-

    -

    2.5  Create a XMPP Account for Administration

    You need a XMPP account and grant him administrative privileges -to enter the ejabberd Web Admin: -

    1. -Register a XMPP account on your ejabberd server, for example admin1@example.org. -There are two ways to register a XMPP account: -
      1. -Using ejabberdctl (see section 4.1): -
        ejabberdctl register admin1 example.org FgT5bk3
-
      2. Using a XMPP client and In-Band Registration (see section 3.3.18). -
      -
    2. Edit the ejabberd configuration file to give administration rights to the XMPP account you created: -
      {acl, admins, {user, "admin1", "example.org"}}.
-{access, configure, [{allow, admins}]}.
-
      You can grant administrative privileges to many XMPP accounts, -and also to accounts in other XMPP servers. -
    3. Restart ejabberd to load the new configuration. -
    4. Open the Web Admin (http://server:port/admin/) in your -favourite browser. Make sure to enter the full JID as username (in this -example: admin1@example.org. The reason that you also need to enter the -suffix, is because ejabberd’s virtual hosting support. -

    -

    2.6  Upgrading ejabberd

    To upgrade an ejabberd installation to a new version, -simply uninstall the old version, and then install the new one. -Of course, it is important that the configuration file -and Mnesia database spool directory are not removed.

    ejabberd automatically updates the Mnesia table definitions at startup when needed. -If you also use an external database for storage of some modules, -check if the release notes of the new ejabberd version -indicates you need to also update those tables.

    -

    Chapter 3  Configuring ejabberd

    -

    -

    3.1  Basic Configuration

    The configuration file will be loaded the first time you start ejabberd. The -content from this file will be parsed and stored in the internal ejabberd database. Subsequently the -configuration will be loaded from the database and any commands in the -configuration file are appended to the entries in the database.

    Note that ejabberd never edits the configuration file. -So, the configuration changes done using the Web Admin -are stored in the database, but are not reflected in the configuration file. -If you want those changes to be use after ejabberd restart, you can either -edit the configuration file, or remove all its content.

    The configuration file contains a sequence of Erlang terms. Lines beginning with a -‘%’ sign are ignored. Each term is a tuple of which the first element is -the name of an option, and any further elements are that option’s values. If the -configuration file do not contain for instance the ‘hosts’ option, the old -host name(s) stored in the database will be used.

    You can override the old values stored in the database by adding next lines to -the beginning of the configuration file: -

    override_global.
-override_local.
-override_acls.
-

    With these lines the old global options (shared between all ejabberd nodes in a -cluster), local options (which are specific for this particular ejabberd node) -and ACLs will be removed before new ones are added.

    -

    3.1.1  Host Names

    -

    The option hosts defines a list containing one or more domains that -ejabberd will serve.

    The syntax is: -

    {hosts, [HostName, ...]}.

    Examples: -

    • -Serving one domain: -
      {hosts, ["example.org"]}.
-
    • Serving three domains: -
      {hosts, ["example.net", "example.com", "jabber.somesite.org"]}.
-

    -

    3.1.2  Virtual Hosting

    -

    Options can be defined separately for every virtual host using the -host_config option.

    The syntax is: -

    {host_config, HostName, [Option, ...]}

    Examples: -

    • -Domain example.net is using the internal authentication method while -domain example.com is using the LDAP server running on the -domain localhost to perform authentication: -
      {host_config, "example.net", [{auth_method,   storage},
-                              {auth_storage,  mnesia}]}.
-
-{host_config, "example.com", [{auth_method,   ldap],
-                              {ldap_servers,  ["localhost"]},
-                              {ldap_uids,     [{"uid"}]},
-                              {ldap_rootdn,   "dc=localdomain"},
-                              {ldap_rootdn,   "dc=example,dc=com"},
-                              {ldap_password, ""}]}.
-
    • Domain example.net is using ODBC to perform authentication -while domain example.com is using the LDAP servers running on the domains -localhost and otherhost: -
      {host_config, "example.net", [{auth_method, storage},
-                              {auth_storage, odbc},
-                              {odbc_server, "DSN=ejabberd;UID=ejabberd;PWD=ejabberd"}]}.
-
-{host_config, "example.com", [{auth_method,   ldap},
-                              {ldap_servers,  ["localhost", "otherhost"]},
-                              {ldap_uids,     [{"uid"}]},
-                              {ldap_rootdn,   "dc=localdomain"},
-                              {ldap_rootdn,   "dc=example,dc=com"},
-                              {ldap_password, ""}]}.
-

    To define specific ejabberd modules in a virtual host, -you can define the global modules option with the common modules, -and later add specific modules to certain virtual hosts. -To accomplish that, instead of defining each option in host_config with the general syntax -

    {OptionName, OptionValue}

    -use this syntax: -

    {{add, OptionName}, OptionValue}

    In this example three virtual hosts have some similar modules, but there are also -other different modules for some specific virtual hosts: -

    %% This ejabberd server has three vhosts:
-{hosts, ["one.example.org", "two.example.org", "three.example.org"]}.
-
-%% Configuration of modules that are common to all vhosts
-{modules,
- [
-  {mod_roster,     []},
-  {mod_configure,  []},
-  {mod_disco,      []},
-  {mod_private,    []},
-  {mod_time,       []},
-  {mod_last,       []},
-  {mod_version,    []}
- ]}.
-
-%% Add some modules to vhost one:
-{host_config, "one.example.org",
- [{{add, modules}, [
-                    {mod_echo,       [{host, "echo-service.one.example.org"}]}
-                    {mod_http_bind,  []},
-                    {mod_logxml,     []}
-                   ]
-  }
- ]}.
-
-%% Add a module just to vhost two:
-{host_config, "two.example.org",
- [{{add, modules}, [
-                    {mod_echo,       [{host, "mirror.two.example.org"}]}
-                   ]
-  }
- ]}.
-

    -

    3.1.3  Listening Ports

    -

    The option listen defines for which ports, addresses and network protocols ejabberd -will listen and what services will be run on them. Each element of the list is a -tuple with the following elements: -

    • -Port number. Optionally also the IP address and/or a transport protocol. -
    • Listening module that serves this port. -
    • Options for the TCP socket and for the listening module. -

    The option syntax is: -

    {listen, [Listener, ...]}.

    To define a listener there are several syntax. -

    {PortNumber, Module, [Option, ...]}
    {{PortNumber, IPaddress}, Module, [Option, ...]}
    {{PortNumber, TransportProtocol}, Module, [Option, ...]}
    {{PortNumber, IPaddress, TransportProtocol}, Module, [Option, ...]}

    -

    Port Number, IP Address and Transport Protocol

    The port number defines which port to listen for incoming connections. -It can be a Jabber/XMPP standard port -(see section 5.1) or any other valid port number.

    The IP address can be represented with a string -or an Erlang tuple with decimal or hexadecimal numbers. -The socket will listen only in that network interface. -It is possible to specify a generic address, -so ejabberd will listen in all addresses. -Depending in the type of the IP address, IPv4 or IPv6 will be used. -When not specified the IP address, it will listen on all IPv4 network addresses.

    Some example values for IP address: -

    • -"0.0.0.0" to listen in all IPv4 network interfaces. This is the default value when no IP is specified. -
    • "::" to listen in all IPv6 network interfaces -
    • "10.11.12.13" is the IPv4 address 10.11.12.13 -
    • "::FFFF:127.0.0.1" is the IPv6 address ::FFFF:127.0.0.1/128 -
    • {10, 11, 12, 13} is the IPv4 address 10.11.12.13 -
    • {0, 0, 0, 0, 0, 65535, 32512, 1} is the IPv6 address ::FFFF:127.0.0.1/128 -
    • {16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1} is the IPv6 address FDCA:8AB6:A243:75EF::1/128 -

    The transport protocol can be tcp or udp. -Default is tcp.

    -

    Listening Module

    -The available modules, their purpose and the options allowed by each one are: -

    -ejabberd_c2s
    -Handles c2s connections.
    - Options: access, certfile, max_fsm_queue, -max_stanza_size, shaper, -starttls, starttls_required, tls, -zlib -
    ejabberd_s2s_in
    -Handles incoming s2s connections.
    - Options: max_stanza_size, shaper -
    ejabberd_service
    -Interacts with an external component -(as defined in the Jabber Component Protocol (XEP-0114).
    - Options: access, hosts, max_fsm_queue, -service_check_from, shaper -
    ejabberd_stun
    -Handles STUN Binding requests as defined in -RFC 5389.
    - Options: certfile -
    ejabberd_http
    -Handles incoming HTTP connections.
    - Options: captcha, certfile, http_bind, http_poll, -request_handlers, tls, web_admin
    -

    -

    Options

    This is a detailed description of each option allowed by the listening modules: -

    -{access, AccessName}
    This option defines -access to the port. The default value is all. -
    {backlog, Value}
    The backlog value -defines the maximum length that the queue of pending connections may -grow to. This should be increased if the server is going to handle -lots of new incoming connections as they may be dropped if there is -no space in the queue (and ejabberd was not able to accept them -immediately). Default value is 5. -
    captcha
    -Simple web page that allows a user to fill a CAPTCHA challenge (see section 3.1.8). -
    {certfile, Path}
    Full path to a file containing the default SSL certificate. -To define a certificate file specific for a given domain, use the global option domain_certfile. -
    {hosts, [Hostname, ...], [HostOption, ...]}
    -The external Jabber component that connects to this ejabberd_service -can serve one or more hostnames. -As HostOption you can define options for the component; -currently the only allowed option is the password required to the component -when attempt to connect to ejabberd: {password, Secret}. -Note that you cannot define in a single ejabberd_service components of -different services: add an ejabberd_service for each service, -as seen in an example below. -
    http_bind
    -This option enables HTTP Binding (XEP-0124 and XEP-0206) support. HTTP Bind -enables access via HTTP requests to ejabberd from behind firewalls which -do not allow outgoing sockets on port 5222.

    Remember that you must also install and enable the module mod_http_bind.

    If HTTP Bind is enabled, it will be available at -http://server:port/http-bind/. Be aware that support for HTTP Bind -is also needed in the XMPP client. Remark also that HTTP Bind can be -interesting to host a web-based XMPP client such as -JWChat -(check the tutorials to install JWChat with ejabberd and an -embedded local web server -or Apache). -

    http_poll
    -This option enables HTTP Polling (XEP-0025) support. HTTP Polling -enables access via HTTP requests to ejabberd from behind firewalls which -do not allow outgoing sockets on port 5222.

    If HTTP Polling is enabled, it will be available at -http://server:port/http-poll/. Be aware that support for HTTP Polling -is also needed in the XMPP client. Remark also that HTTP Polling can be -interesting to host a web-based XMPP client such as -JWChat.

    The maximum period of time to keep a client session active without -an incoming POST request can be configured with the global option -http_poll_timeout. The default value is five minutes. -The option can be defined in ejabberd.cfg, expressing the time -in seconds: {http_poll_timeout, 300}. -

    {max_fsm_queue, Size}
    -This option specifies the maximum number of elements in the queue of the FSM -(Finite State Machine). -Roughly speaking, each message in such queues represents one XML -stanza queued to be sent into its relevant outgoing stream. If queue size -reaches the limit (because, for example, the receiver of stanzas is too slow), -the FSM and the corresponding connection (if any) will be terminated -and error message will be logged. -The reasonable value for this option depends on your hardware configuration. -However, there is no much sense to set the size above 1000 elements. -This option can be specified for ejabberd_service and -ejabberd_c2s listeners, -or also globally for ejabberd_s2s_out. -If the option is not specified for ejabberd_service or -ejabberd_c2s listeners, -the globally configured value is used. -The allowed values are integers and ’undefined’. -Default value: ’undefined’. -
    {max_stanza_size, Size}
    -This option specifies an -approximate maximum size in bytes of XML stanzas. Approximate, -because it is calculated with the precision of one block of read -data. For example {max_stanza_size, 65536}. The default -value is infinity. Recommended values are 65536 for c2s -connections and 131072 for s2s connections. s2s max stanza size -must always much higher than c2s limit. Change this value with -extreme care as it can cause unwanted disconnect if set too low. -
    {request_handlers, [ {Path, Module}, ...]}
    To define one or several handlers that will serve HTTP requests. -The Path is a list of strings; so the URIs that start with that Path will be served by Module. -For example, if you want mod_foo to serve the URIs that start with /a/b/, -and you also want mod_http_bind to serve the URIs /http-bind/, -use this option: {request_handlers, [{["a", "b"], mod_foo}, {["http-bind"], mod_http_bind}]} -
    {service_check_from, true|false}
    - -This option can be used with ejabberd_service only. -XEP-0114 requires that the domain must match the hostname of the component. -If this option is set to false, ejabberd will allow the component -to send stanzas with any arbitrary domain in the ’from’ attribute. -Only use this option if you are completely sure about it. -The default value is true, to be compliant with XEP-0114. -
    {shaper, none|ShaperName}
    This option defines a -shaper for the port (see section 3.1.6). The default value -is none. -
    starttls
    This option -specifies that STARTTLS encryption is available on connections to the port. -You should also set the certfile option. -You can define a certificate file for a specific domain using the global option domain_certfile. -
    starttls_required
    This option -specifies that STARTTLS encryption is required on connections to the port. -No unencrypted connections will be allowed. -You should also set the certfile option. -You can define a certificate file for a specific domain using the global option domain_certfile. -
    tls
    This option specifies that traffic on -the port will be encrypted using SSL immediately after connecting. -This was the traditional encryption method in the early Jabber software, -commonly on port 5223 for client-to-server communications. -But this method is nowadays deprecated and not recommended. -The preferable encryption method is STARTTLS on port 5222, as defined -RFC 3920: XMPP Core, -which can be enabled in ejabberd with the option starttls. -If this option is set, you should also set the certfile option. -The option tls can also be used in ejabberd_http to support HTTPS. -
    web_admin
    This option -enables the Web Admin for ejabberd administration which is available -at http://server:port/admin/. Login and password are the username and -password of one of the registered users who are granted access by the -‘configure’ access rule. -
    zlib
    This -option specifies that Zlib stream compression (as defined in XEP-0138) -is available on connections to the port. -

    There are some additional global options that can be specified in the ejabberd configuration file (outside listen): -

    -{s2s_use_starttls, true|false}
    -This option defines whether to -use STARTTLS for s2s connections. -
    {s2s_certfile, Path}
    Full path to a -file containing a SSL certificate. -
    {domain_certfile, Domain, Path}
    -Full path to the file containing the SSL certificate for a specific domain. -
    {outgoing_s2s_options, Methods, Timeout}
    -Specify which address families to try, in what order, and connect timeout in milliseconds. -By default it first tries connecting with IPv4, if that fails it tries using IPv6, -with a timeout of 10000 milliseconds. -
    {outgoing_s2s_local_address, IPaddress}
    -Specify which local IP address is desired for the outgoing S2S connections. -This option is used only if the local and remote addresses -are of the same IP version (either 4 or 6). -If this option is not defined, and the ejabberd_s2s_in -listener address is defined, then that one is used. -
    {s2s_dns_options, [ {Property, Value}, ...]}
    -Define properties to use for DNS resolving. -Allowed Properties are: timeout in seconds which default value is 10 -and retries which default value is 2. -
    {s2s_default_policy, allow|deny}
    -The default policy for incoming and outgoing s2s connections to other XMPP servers. -The default value is allow. -
    {{s2s_host, Host}, allow|deny}
    -Defines if incoming and outgoing s2s connections with a specific remote host are allowed or denied. -This allows to restrict ejabberd to only establish s2s connections -with a small list of trusted servers, or to block some specific servers. -
    {s2s_max_retry_delay, Seconds}
    -The maximum allowed delay for retry to connect after a failed connection attempt. -Specified in seconds. The default value is 300 seconds (5 minutes). -
    {max_fsm_queue, Size}
    -This option specifies the maximum number of elements in the queue of the FSM -(Finite State Machine). -Roughly speaking, each message in such queues represents one XML -stanza queued to be sent into its relevant outgoing stream. If queue size -reaches the limit (because, for example, the receiver of stanzas is too slow), -the FSM and the corresponding connection (if any) will be terminated -and error message will be logged. -The reasonable value for this option depends on your hardware configuration. -However, there is no much sense to set the size above 1000 elements. -This option can be specified for ejabberd_service and -ejabberd_c2s listeners, -or also globally for ejabberd_s2s_out. -If the option is not specified for ejabberd_service or -ejabberd_c2s listeners, -the globally configured value is used. -The allowed values are integers and ’undefined’. -Default value: ’undefined’. -
    {route_subdomains, local|s2s}
    -Defines if ejabberd must route stanzas directed to subdomains locally (compliant with -RFC 3920: XMPP Core), -or to foreign server using S2S (compliant with -RFC 3920 bis). -

    -

    Examples

    For example, the following simple configuration defines: -

    • -There are three domains. The default certificate file is server.pem. -However, the c2s and s2s connections to the domain example.com use the file example_com.pem. -
    • Port 5222 listens for c2s connections with STARTTLS, -and also allows plain connections for old clients. -
    • Port 5223 listens for c2s connections with the old SSL. -
    • Port 5269 listens for s2s connections with STARTTLS. The socket is set for IPv6 instead of IPv4. -
    • Port 3478 listens for STUN requests over UDP. -
    • Port 5280 listens for HTTP requests, and serves the HTTP Poll service. -
    • Port 5281 listens for HTTP requests, and serves the Web Admin using HTTPS as explained in -section 4.3. The socket only listens connections to the IP address 127.0.0.1. -
    {hosts, ["example.com", "example.org", "example.net"]}.
-{listen,
- [
-  {5222, ejabberd_c2s, [
-                        {access, c2s},
-                        {shaper, c2s_shaper},
-                        starttls, {certfile, "/etc/ejabberd/server.pem"},
-                        {max_stanza_size, 65536}
-                       ]},
-  {5223, ejabberd_c2s, [
-                        {access, c2s},
-                        {shaper, c2s_shaper},
-                        tls, {certfile, "/etc/ejabberd/server.pem"},
-                        {max_stanza_size, 65536}
-                       ]},
-  {{5269, "::"}, ejabberd_s2s_in, [
-                                   {shaper, s2s_shaper},
-                                   {max_stanza_size, 131072}
-                                  ]},
-  {{3478, udp}, ejabberd_stun, []},
-  {5280, ejabberd_http, [
-                         http_poll
-                        ]},
-  {{5281, "127.0.0.1"}, ejabberd_http, [
-                                        web_admin,
-                                        tls, {certfile, "/etc/ejabberd/server.pem"},
-                                       ]}
- ]
-}.
-{s2s_use_starttls, true}.
-{s2s_certfile, "/etc/ejabberd/server.pem"}.
-{domain_certfile, "example.com", "/etc/ejabberd/example_com.pem"}.
-

    In this example, the following configuration defines that: -

    • -c2s connections are listened for on port 5222 (all IPv4 addresses) and -on port 5223 (SSL, IP 192.168.0.1 and fdca:8ab6:a243:75ef::1) and denied -for the user called ‘bad’. -
    • s2s connections are listened for on port 5269 (all IPv4 addresses) -with STARTTLS for secured traffic enabled. -Incoming and outgoing connections of remote XMPP servers are denied, -only two servers can connect: "jabber.example.org" and "example.com". -
    • Port 5280 is serving the Web Admin and the HTTP Polling service -in all the IPv4 addresses. Note -that it is also possible to serve them on different ports. The second -example in section 4.3 shows how exactly this can be done. -
    • All users except for the administrators have a traffic of limit -1,000 Bytes/second -
    • The -AIM transport -aim.example.org is connected to port 5233 on localhost IP addresses -(127.0.0.1 and ::1) with password ‘aimsecret’. -
    • The ICQ transport JIT (icq.example.org and -sms.example.org) is connected to port 5234 with password -‘jitsecret’. -
    • The -MSN transport -msn.example.org is connected to port 5235 with password -‘msnsecret’. -
    • The -Yahoo! transport -yahoo.example.org is connected to port 5236 with password -‘yahoosecret’. -
    • The Gadu-Gadu transport gg.example.org is -connected to port 5237 with password ‘ggsecret’. -
    • The -Jabber Mail Component -jmc.example.org is connected to port 5238 with password -‘jmcsecret’. -
    • The service custom has enabled the special option to avoiding checking the from attribute in the packets send by this component. The component can send packets in behalf of any users from the server, or even on behalf of any server. -
    {acl, blocked, {user, "bad"}}.
-{access, c2s, [{deny, blocked},
-               {allow, all}]}.
-{shaper, normal, {maxrate, 1000}}.
-{access, c2s_shaper, [{none, admin},
-                      {normal, all}]}.
-{listen,
- [{5222, ejabberd_c2s, [
-                        {access, c2s},
-                        {shaper, c2s_shaper}
-                       ]},
-  {{5223, {192, 168, 0, 1}}, ejabberd_c2s, [
-                                            {access, c2s},
-                                            ssl, {certfile, "/path/to/ssl.pem"}
-                                           ]},
-  {{5223, {16#fdca, 16#8ab6, 16#a243, 16#75ef, 0, 0, 0, 1}},
-   ejabberd_c2s, [
-                  {access, c2s},
-                  ssl, {certfile, "/path/to/ssl.pem"}
-                 ]},
-  {5269, ejabberd_s2s_in, []},
-  {{5280, {0, 0, 0, 0}}, ejabberd_http, [
-                                         http_poll,
-                                         web_admin
-                                        ]},
-  {{5233, {127, 0, 0, 1}}, ejabberd_service, [
-                                              {hosts, ["aim.example.org"],
-                                                 [{password, "aimsecret"}]}
-                                             ]},
-  {{5233, "::1"}, ejabberd_service, [
-                                     {hosts, ["aim.example.org"],
-                                        [{password, "aimsecret"}]}
-                                    ]},
-  {5234, ejabberd_service, [{hosts, ["icq.example.org", "sms.example.org"],
-                             [{password, "jitsecret"}]}]},
-  {5235, ejabberd_service, [{hosts, ["msn.example.org"],
-                             [{password, "msnsecret"}]}]},
-  {5236, ejabberd_service, [{hosts, ["yahoo.example.org"],
-                             [{password, "yahoosecret"}]}]},
-  {5237, ejabberd_service, [{hosts, ["gg.example.org"],
-                             [{password, "ggsecret"}]}]},
-  {5238, ejabberd_service, [{hosts, ["jmc.example.org"],
-                             [{password, "jmcsecret"}]}]},
-  {5239, ejabberd_service, [{hosts, ["custom.example.org"],
-                             [{password, "customsecret"}]},
-                            {service_check_from, false}]}
- ]
-}.
-{s2s_use_starttls, true}.
-{s2s_certfile, "/path/to/ssl.pem"}.
-{s2s_default_policy, deny}.
-{{s2s_host,"jabber.example.org"}, allow}.
-{{s2s_host,"example.com"}, allow}.
-

    Note, that for services based in jabberd14 or WPJabber -you have to make the transports log and do XDB by themselves: -

      <!--
-     You have to add elogger and rlogger entries here when using ejabberd.
-     In this case the transport will do the logging.
-  -->
-
-  <log id='logger'>
-    <host/>
-    <logtype/>
-    <format>%d: [%t] (%h): %s</format>
-    <file>/var/log/jabber/service.log</file>
-  </log>
-
-  <!--
-     Some XMPP server implementations do not provide
-     XDB services (for example, jabberd2 and ejabberd).
-     xdb_file.so is loaded in to handle all XDB requests.
-  -->
-
-  <xdb id="xdb">
-    <host/>
-    <load>
-      <!-- this is a lib of wpjabber or jabberd14 -->
-      <xdb_file>/usr/lib/jabber/xdb_file.so</xdb_file>
-      </load>
-    <xdb_file xmlns="jabber:config:xdb_file">
-      <spool><jabberd:cmdline flag='s'>/var/spool/jabber</jabberd:cmdline></spool>
-    </xdb_file>
-  </xdb>
-

    -

    3.1.4  Authentication

    -

    The option auth_method defines the authentication methods that are used -for user authentication. -Usually only one method is defined, with this syntax: -

    {auth_method, Method}.

    -This full syntax can be used to specify one or more methods: -

    {auth_method, [Method1, Method2, ...]}.

    The following authentication methods are supported by ejabberd: -

    • -database storage in internal Mnesia or ODBC — See section 3.1.4. -
    • external — See section 3.1.4. -
    • ldap — See section 3.2.5. -
    • anonymous — See section 3.1.4. -
    • pam — See section 3.1.4. -
    • a method with SASL GSSAPI — See section 3.1.4. -

    Account creation is only supported by the methods: -internal Mnesia storage, ODBC storage, and external.

    -

    Database Storage

    -

    You can configure ejabberd to use the database storage authentication method, -and store either in the internal Mnesia database or in an ODBC database. -The specific storage is configured with the option: -

    {auth_storage, mnesia|odbc}
-

    When the storage is configured for ODBC, the ODBC server is -configured with the odbc_server option, see -3.2.1 for MySQL, 3.2.3 for PostgreSQL, 3.2.2 for MSSQL, and 3.2.4 for generic ODBC.

    Examples: -

    • -To use internal Mnesia storage on all virtual hosts: -
      {auth_method, storage}.
-{auth_storage, mnesia}.
-
    • To use ODBC storage on all virtual hosts: -
      {auth_method, storage}.
-{auth_storage, odbc}.
-
    • To use Mnesia storage on example.org, -ODBC storage in a MySQL database on example.com, -ODBC storage in a PostgreSQL database on example2.com, -and LDAP on example.net: -
      {host_config, "example.org", [
-    {auth_method, storage}, 
-    {auth_storage, mnesia}
-]}.
-{host_config, "example.com", [
-    {auth_method, storage}, 
-    {auth_storage, odbc}, 
-    {odbc_server, {mysql, "localhost", "test", "root", "password"}}
-]}.
-{host_config, "example2.com", [
-    {auth_method, storage},
-    {auth_storage, odbc}, 
-    {odbc_server, "DSN=database;UID=ejabberd;PWD=password"}
-]}.
-{host_config, "example.net", [
-    {auth_method, ldap}
-]}.
-

    -

    External Script

    -

    In this authentication method, when ejabberd starts, -it start a script, and calls it to perform authentication tasks.

    The server administrator can write the external authentication script -in any language. -The details on the interface between ejabberd and the script are described -in the ejabberd Developers Guide. -There are also several example authentication scripts.

    These are the specific options: -

    -{extauth_program, PathToScript}
    -Indicate in this option the full path to the external authentication script. -The script must be executable by ejabberd.
    {extauth_instances, Integer}
    -Indicate how many instances of the script to run simultaneously to serve authentication in the virtual host. -The default value is the minimum number: 1.
    {extauth_cache, false|CacheTimeInteger}
    -The value false disables the caching feature, this is the default. -The integer 0 (zero) enables caching for statistics, but doesn’t use that cached information to authenticate users. -If another integer value is set, caching is enabled both for statistics and for authentication: -the CacheTimeInteger indicates the number of seconds that ejabberd can reuse -the authentication information since the user last disconnected, -to verify again the user authentication without querying again the extauth script. -Note: caching should not be enabled in a host if internal auth is also enabled. -If caching is enabled, mod_last must be enabled also in that vhost. -

    This example sets external authentication, the extauth script, enables caching for 10 minutes, -and starts three instances of the script for each virtual host defined in ejabberd: -

    {auth_method, external}.
-{extauth_program, "/etc/ejabberd/JabberAuth.class.php"}.
-{extauth_cache, 600}.
-{extauth_instances, 3}. 
-

    -

    SASL Anonymous and Anonymous Login

    -

    The value anonymous will enable the internal authentication method.

    The anonymous authentication method can be configured with the following -options. Remember that you can use the host_config option to set virtual -host specific options (see section 3.1.2). Note that there also -is a detailed tutorial regarding SASL -Anonymous and anonymous login configuration.

    -{allow_multiple_connections, false|true}
    This option is only used -when the anonymous mode is -enabled. Setting it to true means that the same username can be taken -multiple times in anonymous login mode if different resource are used to -connect. This option is only useful in very special occasions. The default -value is false. -
    {anonymous_protocol, sasl_anon | login_anon | both}
    -sasl_anon means -that the SASL Anonymous method will be used. login_anon means that the -anonymous login method will be used. both means that SASL Anonymous and -login anonymous are both enabled. -

    Those options are defined for each virtual host with the host_config -parameter (see section 3.1.2).

    Examples: -

    • -To enable anonymous login on all virtual hosts: -
      {auth_method, anonymous}.
-{anonymous_protocol, login_anon}.
-
    • Similar as previous example, but limited to public.example.org: -
      {host_config, "public.example.org", [{auth_method, anonymous},
-                                     {anonymous_protocol, login_anon}]}.
-
    • To enable anonymous login and internal authentication on a virtual host: -
      {host_config, "public.example.org", [{auth_method, [internal, anonymous]},
-                                     {anonymous_protocol, login_anon}]}.
-
    • To enable SASL Anonymous on a virtual host: -
      {host_config, "public.example.org", [{auth_method, anonymous},
-                                     {anonymous_protocol, sasl_anon}]}.
-
    • To enable SASL Anonymous and anonymous login on a virtual host: -
      {host_config, "public.example.org", [{auth_method, anonymous},
-                                     {anonymous_protocol, both}]}.
-
    • To enable SASL Anonymous, anonymous login, and internal authentication on -a virtual host: -
      {host_config, "public.example.org", [{auth_method, [internal, anonymous]},
-                                     {anonymous_protocol, both}]}.
-

    -

    PAM Authentication

    -

    ejabberd supports authentication via Pluggable Authentication Modules (PAM). -PAM is currently supported in AIX, FreeBSD, HP-UX, Linux, Mac OS X, NetBSD and Solaris. -PAM authentication is disabled by default, so you have to configure and compile -ejabberd with PAM support enabled: -

    ./configure --enable-pam && make install
-

    Options: -

    -{pam_service, Name}
    This option defines the PAM service name. -Default is "ejabberd". Refer to the PAM documentation of your operation system -for more information. -
    {pam_userinfotype, username|jid}
    -This option defines what type of information about the user ejabberd -provides to the PAM service: only the username, or the user JID. -Default is username. -

    Example: -

    {auth_method, pam}.
-{pam_service, "ejabberd"}.
-

    Though it is quite easy to set up PAM support in ejabberd, PAM itself introduces some -security issues:

    • -To perform PAM authentication ejabberd uses external C-program called -epam. By default, it is located in /var/lib/ejabberd/priv/bin/ -directory. You have to set it root on execution in the case when your PAM module -requires root privileges (pam_unix.so for example). Also you have to grant access -for ejabberd to this file and remove all other permissions from it. -Execute with root privileges: -
      chown root:ejabberd /var/lib/ejabberd/priv/bin/epam
-chmod 4750 /var/lib/ejabberd/priv/bin/epam
-
    • Make sure you have the latest version of PAM installed on your system. -Some old versions of PAM modules cause memory leaks. If you are not able to use the latest -version, you can kill(1) epam process periodically to reduce its memory -consumption: ejabberd will restart this process immediately. -
    • epam program tries to turn off delays on authentication failures. -However, some PAM modules ignore this behavior and rely on their own configuration options. -You can create a configuration file ejabberd.pam. -This example shows how to turn off delays in pam_unix.so module: -
      #%PAM-1.0
-auth        sufficient  pam_unix.so likeauth nullok nodelay
-account     sufficient  pam_unix.so
-
      That is not a ready to use configuration file: you must use it -as a hint when building your own PAM configuration instead. Note that if you want to disable -delays on authentication failures in the PAM configuration file, you have to restrict access -to this file, so a malicious user can’t use your configuration to perform brute-force -attacks. -
    • You may want to allow login access only for certain users. pam_listfile.so -module provides such functionality. -
    • If you use pam_winbind to authorise against a Windows Active Directory, -then /etc/nssswitch.conf must be configured to use winbind as well. -

    -

    SASL GSSAPI Authentication

    -

    ejabberd supports SASL GSSAPI authentication. -It is compatible with SSO as implemented in Spark 2.5.3.

    To use this feature, you have to download the esasl library -source code from -http://github.com/mikma/esasl, -compile and install it. Example instructions: -

    git clone git://github.com/mikma/esasl.git
-cd esasl
-./configure --prefix=/usr
-make
-sudo make install
-

    After doing this, check that esasl was installed in the /usr/lib/erlang/lib/ directory. -For compiling esasl, maybe you need to get some development files; -(for example, in Debian, the package libgsasl7-dev).

    The SASL GSSAPI mechanism uses a authentication backend only to check for a -valid user name when authorizing the user. -The authentication is done by esasl against a Kerberos key server (KDC). -Often Kerberos authentication is combined with LDAP to store user account information. -To do that, edit ejabberd.cfg and modify the auth_mehtod depending -on what you want to allow. For example: -

    {auth_method, [ldap]}.
-

    Now define the Kerberos realm: -

    {sasl_realm, "Kerberos realm"}.
-

    and manually set the FQDN. -ejabberd does a reverse lookup on the connecting IP and uses -that FQDN for locating its keytab entry in the keytab file. -

    {sasl_fqdn, "dbs.example.com"}.
-

    The environment variable KRB5_KTNAME is the location of the keytab file, -and needs to be set before starting ejabberd. -The keytab referenced by KRB5_KTNAME should contain the principal xmpp/FQDN, -where FQDN is the fully qualified host name of the ejabberd server. -For example, in Debian, add to the file /etc/ejabberd/default the line: -

    export KRB5_KTNAME="/etc/keytabs/xmpp-dbs.example.com-EXAMPLE.COM.keytab"
-

    -

    3.1.5  Access Rules

    -

    -

    ACL Definition

    -

    Access control in ejabberd is performed via Access Control Lists (ACLs). The -declarations of ACLs in the configuration file have the following syntax: -

    {acl, ACLName, ACLValue}.

    ACLValue can be one of the following: -

    -all
    Matches all JIDs. Example: -
    {acl, all, all}.
-
    {user, Username}
    Matches the user with the name -Username at the first virtual host. Example: -
    {acl, admin, {user, "yozhik"}}.
-
    {user, Username, Server}
    Matches the user with the JID -Username@Server and any resource. Example: -
    {acl, admin, {user, "yozhik", "example.org"}}.
-
    {server, Server}
    Matches any JID from server -Server. Example: -
    {acl, exampleorg, {server, "example.org"}}.
-
    {resource, Resource}
    Matches any JID with a resource -Resource. Example: -
    {acl, mucklres, {resource, "muckl"}}.
-
    {shared_group, Groupname}
    Matches any member of a Shared Roster Group with name Groupname in the virtual host. Example: -
    {acl, techgroupmembers, {shared_group, "techteam"}}.
-
    {shared_group, Groupname, Server}
    Matches any member of a Shared Roster Group with name Groupname in the virtual host Server. Example: -
    {acl, techgroupmembers, {shared_group, "techteam", "example.org"}}.
-
    {user_regexp, Regexp}
    Matches any local user with a name that -matches Regexp on local virtual hosts. Example: -
    {acl, tests, {user_regexp, "^test[0-9]*$"}}.
-
    {user_regexp, UserRegexp, Server}
    Matches any user with a name -that matches Regexp at server Server. Example: -
    {acl, tests, {user_Userregexp, "^test", "example.org"}}.
-
    {server_regexp, Regexp}
    Matches any JID from the server that -matches Regexp. Example: -
    {acl, icq, {server_regexp, "^icq\\."}}.
-
    {resource_regexp, Regexp}
    Matches any JID with a resource that -matches Regexp. Example: -
    {acl, icq, {resource_regexp, "^laptop\\."}}.
-
    {node_regexp, UserRegexp, ServerRegexp}
    Matches any user -with a name that matches UserRegexp at any server that matches -ServerRegexp. Example: -
    {acl, yohzik, {node_regexp, "^yohzik$", "^example.(com|org)$"}}.
-
    {user_glob, Glob}
    -
    {user_glob, Glob, Server}
    -
    {server_glob, Glob}
    -
    {resource_glob, Glob}
    -
    {node_glob, UserGlob, ServerGlob}
    This is the same as -above. However, it uses shell glob patterns instead of regexp. These patterns -can have the following special characters: -
    -*
    matches any string including the null string. -
    ?
    matches any single character. -
    [...]
    matches any of the enclosed characters. Character -ranges are specified by a pair of characters separated by a ‘-’. -If the first character after ‘[’ is a ‘!’, any -character not enclosed is matched. -
    -

    The following ACLName are pre-defined: -

    -all
    Matches any JID. -
    none
    Matches no JID. -

    -

    Access Rights

    -

    An entry allowing or denying access to different services. -The syntax is: -

    {access, AccessName, [ {allow|deny, ACLName}, ...]}.

    When a JID is checked to have access to Accessname, the server -sequentially checks if that JID matches any of the ACLs that are named in the -second elements of the tuples in the list. If it matches, the first element of -the first matched tuple is returned, otherwise the value ‘deny’ is -returned.

    If you define specific Access rights in a virtual host, -remember that the globally defined Access rights have precedence over those. -This means that, in case of conflict, the Access granted or denied in the global server is used -and the Access of a virtual host doesn’t have effect.

    Example: -

    {access, configure, [{allow, admin}]}.
-{access, something, [{deny, badmans},
-                     {allow, all}]}.
-

    The following AccessName are pre-defined: -

    -all
    Always returns the value ‘allow’. -
    none
    Always returns the value ‘deny’. -

    -

    Limiting Opened Sessions with ACL

    -

    The special access max_user_sessions specifies the maximum -number of sessions (authenticated connections) per user. If a user -tries to open more sessions by using different resources, the first -opened session will be disconnected. The error session replaced -will be sent to the disconnected session. The value for this option -can be either a number, or infinity. The default value is -infinity.

    The syntax is: -

    {access, max_user_sessions, [ {MaxNumber, ACLName}, ...]}.

    This example limits the number of sessions per user to 5 for all users, and to 10 for admins: -

    {access, max_user_sessions, [{10, admin}, {5, all}]}.
-

    -

    Several connections to a remote XMPP server with ACL

    -

    The special access max_s2s_connections specifies how many -simultaneous S2S connections can be established to a specific remote XMPP server. -The default value is 1. -There’s also available the access max_s2s_connections_per_node.

    The syntax is: -

    {access, max_s2s_connections, [ {MaxNumber, ACLName}, ...]}.

    Examples: -

    • -Allow up to 3 connections with each remote server: -
      {access, max_s2s_connections, [{3, all}]}.
-

    -

    3.1.6  Shapers

    -

    Shapers enable you to limit connection traffic. -The syntax is: -

    {shaper, ShaperName, Kind}.

    -Currently only one kind of shaper called maxrate is available. It has the -following syntax: -

    {maxrate, Rate}

    -where Rate stands for the maximum allowed incoming rate in bytes per -second. -When a connection exceeds this limit, ejabberd stops reading from the socket -until the average rate is again below the allowed maximum.

    Examples: -

    • -To define a shaper named ‘normal’ with traffic speed limited to -1,000 bytes/second: -
      {shaper, normal, {maxrate, 1000}}.
-
    • To define a shaper named ‘fast’ with traffic speed limited to -50,000 bytes/second: -
      {shaper, fast, {maxrate, 50000}}.
-

    -

    3.1.7  Default Language

    -

    The option language defines the default language of server strings that -can be seen by XMPP clients. If a XMPP client does not support -xml:lang, the specified language is used.

    The option syntax is: -

    {language, Language}.

    The default value is en. -In order to take effect there must be a translation file -Language.msg in ejabberd’s msgs directory.

    For example, to set Russian as default language: -

    {language, "ru"}.
-

    Appendix A provides more details about internationalization and localization.

    -

    3.1.8  CAPTCHA

    -

    Some ejabberd modules can be configured to require a CAPTCHA challenge on certain actions. -If the client does not support CAPTCHA Forms (XEP-0158), -a web link is provided so the user can fill the challenge in a web browser.

    An example script is provided that generates the image -using ImageMagick’s Convert program.

    The configurable options are: -

    -{captcha_cmd, Path}
    -Full path to a script that generates the image. -The default value is an empty string: "" -
    {captcha_host, Host}
    -Host part of the URL sent to the user. -You can include the port number. -The URL sent to the user is formed by: http://Host/captcha/ -The default value is the first hostname configured. -

    Additionally, an ejabberd_http listener must be enabled with the captcha option. -See section 3.1.3.

    Example configuration: -

    {hosts, ["example.org"]}.
-
-{captcha_cmd, "/lib/ejabberd/priv/bin/captcha.sh"}.
-{captcha_host, "example.org:5280"}.
-
-{listen,
- [
-  ...
-  {5280, ejabberd_http, [
-                         captcha,
-                         ...
-                        ]
-  }
-
-]}.
-

    -

    3.1.9  STUN

    -

    ejabberd is able to act as a stand-alone STUN server -(RFC 5389). Currently only Binding usage -is supported. In that role ejabberd helps clients with Jingle ICE (XEP-0176) support to discover their external addresses and ports.

    You should configure ejabberd_stun listening module as described in 3.1.3 section. -If certfile option is defined, ejabberd multiplexes TCP and -TLS over TCP connections on the same port. Obviously, certfile option -is defined for tcp only. Note however that TCP or TLS over TCP -support is not required for Binding usage and is reserved for -TURN -functionality. Feel free to configure udp transport only.

    Example configuration: -

    {listen,
- [
-  ...
-  {{3478, udp}, ejabberd_stun, []},
-  {3478, ejabberd_stun, []},
-  {5349, ejabberd_stun, [{certfile, "/etc/ejabberd/server.pem"}]},
-  ...
- ]
-}.
-

    You also need to configure DNS SRV records properly so clients can easily discover a -STUN server serving your XMPP domain. Refer to section -DNS Discovery of a Server -of RFC 5389 for details.

    Example DNS SRV configuration: -

    _stun._udp   IN SRV  0 0 3478 stun.example.com.
-_stun._tcp   IN SRV  0 0 3478 stun.example.com.
-_stuns._tcp  IN SRV  0 0 5349 stun.example.com.
-

    -

    3.1.10  Include Additional Configuration Files

    -

    The option include_config_file in a configuration file instructs ejabberd to include other configuration files immediately.

    The basic syntax is: -

    {include_config_file, Filename}.

    -It is possible to specify suboptions using the full syntax: -

    {include_config_file, Filename, [Suboption, ...]}.

    The filename can be indicated either as an absolute path, -or relative to the main ejabberd configuration file. -It isn’t possible to use wildcards. -The file must exist and be readable.

    The allowed suboptions are: -

    -{disallow, [Optionname, ...]}
    Disallows the usage of those options in the included configuration file. -The options that match this criteria are not accepted. -The default value is an empty list: [] -
    {allow_only, [Optionname, ...]}
    Allows only the usage of those options in the included configuration file. -The options that do not match this criteria are not accepted. -The default value is: all -

    This is a basic example: -

    {include_config_file, "/etc/ejabberd/additional.cfg"}.
-

    In this example, the included file is not allowed to contain a listen option. -If such an option is present, the option will not be accepted. -The file is in a subdirectory from where the main configuration file is. -

    {include_config_file, "./example.org/additional_not_listen.cfg", [{disallow, [listen]}]}.
-

    In this example, ejabberd.cfg defines some ACL and Access rules, -and later includes another file with additional rules: -

    {acl, admin, {user, "admin", "localhost"}}.
-{access, announce, [{allow, admin}]}.
-{include_config_file, "/etc/ejabberd/acl_and_access.cfg", [{allow_only, [acl, access]}]}.
-

    and content of the file acl_and_access.cfg can be, for example: -

    {acl, admin, {user, "bob", "localhost"}}.
-{acl, admin, {user, "jan", "localhost"}}.
-

    -

    3.1.11  Option Macros in Configuration File

    -

    In the ejabberd configuration file, -it is possible to define a macro for a value -and later use this macro when defining an option.

    A macro is defined with this syntax: -

    {define_macro, ’MACRO’, Value}.

    -The MACRO must be surrounded by single quotation marks, -and all letters in uppercase; check the examples bellow. -The value can be any valid arbitrary Erlang term.

    The first definition of a macro is preserved, -and additional definitions of the same macro are forgotten.

    Macros are processed after -additional configuration files have been included, -so it is possible to use macros that -are defined in configuration files included before the usage.

    It isn’t possible to use a macro in the definition -of another macro.

    There are two ways to use a macro: -

    ’MACRO’
    -You can put this instead of a value in an ejabberd option, -and will be replaced with the value previously defined. -If the macro is not defined previously, -the program will crash and report an error.
    {use_macro, ’MACRO’, Defaultvalue}
    -Use a macro even if it may not be defined. -If the macro is not defined previously, -the provided defaultvalue is used. -This usage behaves as if it were defined and used this way: -
    {define_macro, 'MACRO', Defaultvalue}.
-'MACRO'
-

    This example shows the basic usage of a macro: -

    {define_macro, 'LOG_LEVEL_NUMBER', 5}.
-{loglevel, 'LOG_LEVEL_NUMBER'}.
-

    The resulting option interpreted by ejabberd is: {loglevel, 5}.

    This example shows that values can be any arbitrary Erlang term: -

    {define_macro, 'USERBOB', {user, "bob", "localhost"}}.
-{acl, admin, 'USERBOB'}.
-

    The resulting option interpreted by ejabberd is: {acl, admin, {user, "bob", "localhost"}}.

    This complex example: -

    {define_macro, 'NUMBER_PORT_C2S', 5222}.
-{define_macro, 'PORT_S2S_IN', {5269, ejabberd_s2s_in, []}}.
-{listen,
- [
-  {'NUMBER_PORT_C2S', ejabberd_c2s, []},
-  'PORT_S2S_IN',
-  {{use_macro, 'NUMBER_PORT_HTTP', 5280}, ejabberd_http, []}
- ]
-}.
-

    produces this result after being interpreted: -

    {listen,
- [
-  {5222, ejabberd_c2s, []},
-  {5269, ejabberd_s2s_in, []},
-  {5280, ejabberd_http, []}
- ]
-}.
-

    -

    3.2  Database and LDAP Configuration

    - -

    ejabberd uses its internal Mnesia database by default. However, it is -possible to use a relational database or an LDAP server to store persistent, -long-living data. ejabberd is very flexible: you can configure different -authentication methods for different virtual hosts, you can configure different -authentication mechanisms for the same virtual host (fallback), you can set -different storage systems for modules, and so forth.

    The following databases are supported by ejabberd: -

    The following LDAP servers are tested with ejabberd: -

    • -Active Directory -(see section 3.2.5) -
    • OpenLDAP -
    • Normally any LDAP compatible server should work; inform us about your -success with a not-listed server so that we can list it here. -

    Important note about virtual hosting: -if you define several domains in ejabberd.cfg (see section 3.1.1), -you probably want that each virtual host uses a different configuration of database, authentication and storage, -so that usernames do not conflict and mix between different virtual hosts. -For that purpose, the options described in the next sections -must be set inside a host_config for each vhost (see section 3.1.2). -For example: -

    {host_config, "public.example.org", [
-  {odbc_server, {pgsql, "localhost", "database-public-example-org", "ejabberd", "password"}},
-  {auth_method, storage},
-  {auth_storage, odbc}
-]}.
-

    -

    3.2.1  MySQL

    -

    Although this section will describe ejabberd’s configuration when you want to -use the native MySQL driver, it does not describe MySQL’s installation and -database creation. Check the MySQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. -Note that the tutorial contains information about ejabberd’s configuration -which is duplicate to this section.

    Moreover, the file mysql.sql in the directory src/odbc might be interesting for -you. This file contains the ejabberd schema for MySQL. At the end of the file -you can find information to update your database schema.

    -

    Driver Compilation

    -

    You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for MySQL.

    1. -First, install the Erlang -MySQL library. Make sure the compiled files are in your Erlang path; you can -put them for example in the same directory as your ejabberd .beam files. -
    2. Then, configure and install ejabberd with ODBC support enabled (this is -also needed for native MySQL support!). This can be done, by using next -commands: -
      ./configure --enable-odbc && make install
-

    -

    Database Connection

    -

    The actual database access is defined in the option odbc_server. Its -value is used to define if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.

    To use the native MySQL interface, you can pass a tuple of the following form as -parameter: -

    {mysql, "Server", "Database", "Username", "Password"}

    mysql is a keyword that should be kept as is. For example: -

    {odbc_server, {mysql, "localhost", "test", "root", "password"}}.

    Optionally, it is possible to define the MySQL port to use. This -option is only useful, in very rare cases, when you are not running -MySQL with the default port setting. The mysql parameter -can thus take the following form: -

    {mysql, "Server", Port, "Database", "Username", "Password"}

    The Port value should be an integer, without quotes. For example: -

    {odbc_server, {mysql, "localhost", Port, "test", "root", "password"}}.

    By default ejabberd opens 10 connections to the database for each virtual host. -Use this option to modify the value: -

    {odbc_pool_size, 10}.
-

    You can configure an interval to make a dummy SQL request -to keep alive the connections to the database. -The default value is ’undefined’, so no keepalive requests are made. -Specify in seconds: for example 28800 means 8 hours. -

    {odbc_keepalive_interval, undefined}.
-

    If the connection to the database fails, ejabberd waits 30 seconds before retrying. -You can modify this interval with this option: -

    {odbc_start_interval, 30}.
-

    -

    Authentication

    -

    See section 3.1.4.

    -

    Storage

    -

    MySQL also can be used to store information into from several ejabberd -modules. -See section 3.3.1 to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -{backend, odbc} to the module.

    -

    3.2.2  Microsoft SQL Server

    -

    Although this section will describe ejabberd’s configuration when you want to -use Microsoft SQL Server, it does not describe Microsoft SQL Server’s -installation and database creation. Check the MySQL documentation and the -tutorial Using ejabberd with MySQL native driver for information regarding these topics. -Note that the tutorial contains information about ejabberd’s configuration -which is duplicate to this section.

    Moreover, the file mssql.sql in the directory src/odbc might be interesting for -you. This file contains the ejabberd schema for Microsoft SQL Server. At the end -of the file you can find information to update your database schema.

    -

    Driver Compilation

    -

    You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for ODBC.

    If you want to use Microsoft SQL Server with ODBC, you need to configure, -compile and install ejabberd with support for ODBC and Microsoft SQL Server -enabled. This can be done, by using next commands: -

    ./configure --enable-odbc --enable-mssql && make install
-

    -

    Database Connection

    -

    See section 3.1.4.

    -

    Authentication

    -

    The configuration of Authentication for a Microsoft SQL Server -is the same as the configuration for -ODBC compatible servers (see section 3.2.4).

    -

    Storage

    -

    Microsoft SQL Server also can be used to store information into from several -ejabberd modules. -See section 3.3.1 to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -{backend, odbc} to the module.

    -

    3.2.3  PostgreSQL

    -

    Although this section will describe ejabberd’s configuration when you want to -use the native PostgreSQL driver, it does not describe PostgreSQL’s installation -and database creation. Check the PostgreSQL documentation and the tutorial Using ejabberd with MySQL native driver for information regarding these topics. -Note that the tutorial contains information about ejabberd’s configuration -which is duplicate to this section.

    Also the file pg.sql in the directory src/odbc might be interesting for you. -This file contains the ejabberd schema for PostgreSQL. At the end of the file -you can find information to update your database schema.

    -

    Driver Compilation

    -

    You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for -PostgreSQL.

    1. -First, install the Erlang pgsql library from -ejabberd-modules SVN repository. -Make sure the compiled -files are in your Erlang path; you can put them for example in the same -directory as your ejabberd .beam files. -
    2. Then, configure, compile and install ejabberd with ODBC support enabled -(this is also needed for native PostgreSQL support!). This can be done, by -using next commands: -
      ./configure --enable-odbc && make install
-

    -

    Database Connection

    -

    The actual database access is defined in the option odbc_server. Its -value is used to define if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.

    To use the native PostgreSQL interface, you can pass a tuple of the following -form as parameter: -

    {pgsql, "Server", "Database", "Username", "Password"}

    pgsql is a keyword that should be kept as is. For example: -

    {odbc_server, {pgsql, "localhost", "database", "ejabberd", "password"}}.

    Optionally, it is possible to define the PostgreSQL port to use. This -option is only useful, in very rare cases, when you are not running -PostgreSQL with the default port setting. The pgsql parameter -can thus take the following form: -

    {pgsql, "Server", Port, "Database", "Username", "Password"}

    The Port value should be an integer, without quotes. For example: -

    {odbc_server, {pgsql, "localhost", 5432, "database", "ejabberd", "password"}}.

    By default ejabberd opens 10 connections to the database for each virtual host. -Use this option to modify the value: -

    {odbc_pool_size, 10}.
-

    You can configure an interval to make a dummy SQL request -to keep alive the connections to the database. -The default value is ’undefined’, so no keepalive requests are made. -Specify in seconds: for example 28800 means 8 hours. -

    {odbc_keepalive_interval, undefined}.
-

    -

    Authentication

    -

    See section 3.1.4.

    -

    Storage

    -

    PostgreSQL also can be used to store information into from several ejabberd -modules. -See section 3.3.1 to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -{backend, odbc} to the module.

    -

    3.2.4  ODBC Compatible

    -

    Although this section will describe ejabberd’s configuration when you want to -use the ODBC driver, it does not describe the installation and database creation -of your database. Check the documentation of your database. The tutorial Using ejabberd with MySQL native driver also can help you. Note that the tutorial -contains information about ejabberd’s configuration which is duplicate to -this section.

    -

    Driver Compilation

    You can skip this step if you installed ejabberd using a binary installer or -if the binary packages of ejabberd you are using include support for -ODBC.

    1. -First, install the Erlang -MySQL library. Make sure the compiled files are in your Erlang path; you can -put them for example in the same directory as your ejabberd .beam files. -
    2. Then, configure, compile and install ejabberd with ODBC support -enabled. This can be done, by using next commands: -
      ./configure --enable-odbc && make install
-

    -

    Database Connection

    -

    The actual database access is defined in the option odbc_server. Its -value is used to defined if we want to use ODBC, or one of the two native -interface available, PostgreSQL or MySQL.

    To use a relational database through ODBC, you can pass the ODBC connection -string as odbc_server parameter. For example: -

    {odbc_server, "DSN=database;UID=ejabberd;PWD=password"}.
-

    By default ejabberd opens 10 connections to the database for each virtual host. -Use this option to modify the value: -

    {odbc_pool_size, 10}.
-

    You can configure an interval to make a dummy SQL request -to keep alive the connections to the database. -The default value is ’undefined’, so no keepalive requests are made. -Specify in seconds: for example 28800 means 8 hours. -

    {odbc_keepalive_interval, undefined}.
-

    -

    Authentication

    -

    See section 3.1.4.

    -

    Storage

    -

    An ODBC compatible database also can be used to store information into from -several ejabberd modules. -See section 3.3.1 to see which modules support an ODBC storage backend. -To configure the module to use ODBC as storage backend, add the option -{backend, odbc} to the module.

    -

    3.2.5  LDAP

    -

    ejabberd has built-in LDAP support. You can authenticate users against LDAP -server and use LDAP directory as vCard storage. Shared rosters are not supported -yet.

    Usually ejabberd treats LDAP as a read-only storage: -it is possible to consult data, but not possible to -create accounts or edit vCard that is stored in LDAP. -However, it is possible to change passwords if mod_register module is enabled -and LDAP server supports -RFC 3062.

    -

    Connection

    Two connections are established to the LDAP server per vhost, -one for authentication and other for regular calls.

    Parameters: -

    -{ldap_servers, [Servers, ...]}
    List of IP addresses or DNS names of your -LDAP servers. This option is required. -
    {ldap_encrypt, none|tls}
    Type of connection encryption to the LDAP server. -Allowed values are: none, tls. -The value tls enables encryption by using LDAP over SSL. -Note that STARTTLS encryption is not supported. -The default value is: none. -
    {ldap_tls_verify, false|soft|hard}
    -This option specifies whether to verify LDAP server certificate or not when TLS is enabled. -When hard is enabled ejabberd doesn’t proceed if a certificate is invalid. -When soft is enabled ejabberd proceeds even if check fails. -The default is false which means no checks are performed. -
    {ldap_port, Number}
    Port to connect to your LDAP server. -The default port is 389 if encryption is disabled; and 636 if encryption is enabled. -If you configure a value, it is stored in ejabberd’s database. -Then, if you remove that value from the configuration file, -the value previously stored in the database will be used instead of the default port. -
    {ldap_rootdn, RootDN}
    Bind DN. The default value -is "" which means ‘anonymous connection’. -
    {ldap_password, Password}
    Bind password. The default -value is "". -

    Example: -

    {auth_method, ldap}.
-{ldap_servers, ["ldap.example.org"]}.
-{ldap_port, 389}.
-{ldap_rootdn, "cn=Manager,dc=domain,dc=org"}.
-{ldap_password, "secret"}.
-

    -

    Authentication

    You can authenticate users against an LDAP directory. -Note that current LDAP implementation does not support SASL authentication.

    Available options are:

    -{ldap_base, Base}
    LDAP base directory which stores -users accounts. This option is required. -
    {ldap_uids, [ {ldap_uidattr} | {ldap_uidattr, ldap_uidattr_format}, ...]}
    -LDAP attribute which holds a list of attributes to use as alternatives for getting the JID. -The default attributes are [{"uid", "%u"}]. -The attributes are of the form: -[{ldap_uidattr}] or [{ldap_uidattr, ldap_uidattr_format}]. -You can use as many comma separated attributes as needed. -The values for ldap_uidattr and -ldap_uidattr_format are described as follow: -
    -ldap_uidattr
    LDAP attribute which holds -the user’s part of a JID. The default value is "uid". -
    ldap_uidattr_format
    Format of -the ldap_uidattr variable. The format must contain one and -only one pattern variable "%u" which will be replaced by the -user’s part of a JID. For example, "%u@example.org". The default -value is "%u". -
    -
    {ldap_filter, Filter}
    -RFC 4515 LDAP filter. The -default Filter value is: undefined. Example: -"(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, do -not forget to close brackets and do not use superfluous whitespaces. Also you -must not use ldap_uidattr attribute in filter because this -attribute will be substituted in LDAP filter automatically. -
    {ldap_filter, Filter}
    -RFC 4515 LDAP filter. The -default Filter value is: undefined. Example: -"(&(objectClass=shadowAccount)(memberOf=Jabber Users))". Please, do -not forget to close brackets and do not use superfluous whitespaces. Also you -must not use ldap_uidattr attribute in filter because this -attribute will be substituted in LDAP filter automatically. -
    {ldap_dn_filter, { Filter, FilterAttrs }}
    -This filter is applied on the results returned by the main filter. This filter -performs additional LDAP lookup to make the complete result. This is useful -when you are unable to define all filter rules in ldap_filter. You -can define "%u", "%d", "%s" and "%D" pattern -variables in Filter: "%u" is replaced by a user’s part of a JID, -"%d" is replaced by the corresponding domain (virtual host), -all "%s" variables are consecutively replaced by values of FilterAttrs -attributes and "%D" is replaced by Distinguished Name. By default -ldap_dn_filter is undefined. -Example: -
    {ldap_dn_filter, {"(&(name=%s)(owner=%D)(user=%u@%d))", ["sn"]}}.
-
    Since this filter makes additional LDAP lookups, use it only in the -last resort: try to define all filter rules in ldap_filter if possible. -
    {ldap_local_filter, Filter}
    -If you can’t use ldap_filter due to performance reasons -(the LDAP server has many users registered), -you can use this local filter. -The local filter checks an attribute in ejabberd, -not in LDAP, so this limits the load on the LDAP directory. -The default filter is: undefined. -Example values: -
    {ldap_local_filter, {notequal, {"accountStatus",["disabled"]}}}.
-{ldap_local_filter, {equal, {"accountStatus",["enabled"]}}}.
-{ldap_local_filter, undefined}.
-

    -

    Examples

    -
    Common example

    Let’s say ldap.example.org is the name of our LDAP server. We have -users with their passwords in "ou=Users,dc=example,dc=org" directory. -Also we have addressbook, which contains users emails and their additional -infos in "ou=AddressBook,dc=example,dc=org" directory. -The connection to the LDAP server is encrypted using TLS, -and using the custom port 6123. -Corresponding authentication section should looks like this:

    %% Authentication method
-{auth_method, ldap}.
-%% DNS name of our LDAP server
-{ldap_servers, ["ldap.example.org"]}.
-%% Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret"
-{ldap_rootdn, "cn=Manager,dc=example,dc=org"}.
-{ldap_password, "secret"}.
-{ldap_encrypt, tls}.
-{ldap_port, 6123}.
-%% Define the user's base
-{ldap_base, "ou=Users,dc=example,dc=org"}.
-%% We want to authorize users from 'shadowAccount' object class only
-{ldap_filter, "(objectClass=shadowAccount)"}.
-

    Now we want to use users LDAP-info as their vCards. We have four attributes -defined in our LDAP schema: "mail" — email address, "givenName" -— first name, "sn" — second name, "birthDay" — birthday. -Also we want users to search each other. Let’s see how we can set it up:

    {modules,
- [
-  ...
-  {mod_vcard_ldap,
-   [
-    %% We use the same server and port, but want to bind anonymously because
-    %% our LDAP server accepts anonymous requests to
-    %% "ou=AddressBook,dc=example,dc=org" subtree.
-    {ldap_rootdn, ""},
-    {ldap_password, ""},
-    %% define the addressbook's base
-    {ldap_base, "ou=AddressBook,dc=example,dc=org"},
-    %% uidattr: user's part of JID is located in the "mail" attribute
-    %% uidattr_format: common format for our emails
-    {ldap_uids, [{"mail", "%u@mail.example.org"}]},
-    %% We have to define empty filter here, because entries in addressbook does not
-    %% belong to shadowAccount object class
-    {ldap_filter, ""},
-    %% Now we want to define vCard pattern
-    {ldap_vcard_map,
-     [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
-      {"GIVEN", "%s", ["givenName"]},
-      {"FAMILY", "%s", ["sn"]},
-      {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John"
-      {"EMAIL", "%s", ["mail"]},
-      {"BDAY", "%s", ["birthDay"]}]},
-    %% Search form
-    {ldap_search_fields,
-     [{"User", "%u"},
-      {"Name", "givenName"},
-      {"Family Name", "sn"},
-      {"Email", "mail"},
-      {"Birthday", "birthDay"}]},
-    %% vCard fields to be reported
-    %% Note that JID is always returned with search results
-    {ldap_search_reported,
-     [{"Full Name", "FN"},
-      {"Nickname", "NICKNAME"},
-      {"Birthday", "BDAY"}]}
-  ]},
-  ...
- ]}.
-

    Note that mod_vcard_ldap module checks for the existence of the user before -searching in his information in LDAP.

    -
    Active Directory

    -

    Active Directory is just an LDAP-server with predefined attributes. A sample -configuration is shown below:

    {auth_method, ldap}.
-{ldap_servers, ["office.org"]}.    % List of LDAP servers
-{ldap_base, "DC=office,DC=org"}. % Search base of LDAP directory
-{ldap_rootdn, "CN=Administrator,CN=Users,DC=office,DC=org"}. % LDAP manager
-{ldap_password, "*******"}. % Password to LDAP manager
-{ldap_uids, [{"sAMAccountName"}]}.
-{ldap_filter, "(memberOf=*)"}.
-
-{modules,
- [
-  ...
-  {mod_vcard_ldap,
-   [{ldap_vcard_map,
-     [{"NICKNAME", "%u", []},
-      {"GIVEN", "%s", ["givenName"]},
-      {"MIDDLE", "%s", ["initials"]},
-      {"FAMILY", "%s", ["sn"]},
-      {"FN", "%s", ["displayName"]},
-      {"EMAIL", "%s", ["mail"]},
-      {"ORGNAME", "%s", ["company"]},
-      {"ORGUNIT", "%s", ["department"]},
-      {"CTRY", "%s", ["c"]},
-      {"LOCALITY", "%s", ["l"]},
-      {"STREET", "%s", ["streetAddress"]},
-      {"REGION", "%s", ["st"]},
-      {"PCODE", "%s", ["postalCode"]},
-      {"TITLE", "%s", ["title"]},
-      {"URL", "%s", ["wWWHomePage"]},
-      {"DESC", "%s", ["description"]},
-      {"TEL", "%s", ["telephoneNumber"]}]},
-    {ldap_search_fields,
-     [{"User", "%u"},
-      {"Name", "givenName"},
-      {"Family Name", "sn"},
-      {"Email", "mail"},
-      {"Company", "company"},
-      {"Department", "department"},
-      {"Role", "title"},
-      {"Description", "description"},
-      {"Phone", "telephoneNumber"}]},
-    {ldap_search_reported,
-     [{"Full Name", "FN"},
-      {"Nickname", "NICKNAME"},
-      {"Email", "EMAIL"}]}
-  ]},
-  ...
- ]}.
-

    -

    3.3  Modules Configuration

    -

    The option modules defines the list of modules that will be loaded after -ejabberd’s startup. Each entry in the list is a tuple in which the first -element is the name of a module and the second is a list of options for that -module.

    The syntax is: -

    {modules, [ {ModuleName, ModuleOptions}, ...]}.

    Examples: -

    • -In this example only the module mod_echo is loaded and no module -options are specified between the square brackets: -
      {modules,
- [
-  {mod_echo,      []}
- ]}.
-
    • In the second example the modules mod_echo, mod_time, and -mod_version are loaded without options. Remark that, besides the last entry, -all entries end with a comma: -
      {modules,
- [
-  {mod_echo,      []},
-  {mod_time,      []},
-  {mod_version,   []}
- ]}.
-

    -

    3.3.1  Modules Overview

    -

    The following table lists all modules included in ejabberd.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleFeatureDependencies
    mod_adhocAd-Hoc Commands (XEP-0050) 
    mod_announceManage announcementsrecommends mod_adhoc
    mod_capsEntity Capabilities (XEP-0115) 
    mod_configureServer configuration using Ad-Hocmod_adhoc
    mod_discoService Discovery (XEP-0030) 
    mod_echoEchoes XMPP stanzas 
    mod_http_bindXMPP over Bosh service (HTTP Binding) 
    mod_http_fileserverSmall HTTP file server 
    mod_lastLast Activity (XEP-0012) 
    mod_mucMulti-User Chat (XEP-0045) 
    mod_muc_logMulti-User Chat room loggingmod_muc
    mod_multicastMulticast Service (XEP-0033) 
    mod_offlineOffline message storage (XEP-0160) 
    mod_pingXMPP Ping and periodic keepalives (XEP-0199) 
    mod_privacyBlocking Communication (XMPP IM) 
    mod_privatePrivate XML Storage (XEP-0049) 
    mod_proxy65SOCKS5 Bytestreams (XEP-0065) 
    mod_pubsubPub-Sub (XEP-0060), PEP (XEP-0163)mod_caps
    mod_pubsub_odbcPub-Sub (XEP-0060), PEP (XEP-0163)supported DB (*) and mod_caps
    mod_registerIn-Band Registration (XEP-0077) 
    mod_rosterRoster management (XMPP IM) 
    mod_service_logCopy user messages to logger service 
    mod_shared_rosterShared roster managementmod_roster
    mod_sicServer IP Check (XEP-0279) 
    mod_statsStatistics Gathering (XEP-0039) 
    mod_timeEntity Time (XEP-0202) 
    mod_vcardvcard-temp (XEP-0054) 
    mod_vcard_ldapvcard-temp (XEP-0054)LDAP server
    mod_vcard_xupdatevCard-Based Avatars (XEP-0153)mod_vcard
    mod_versionSoftware Version (XEP-0092) 
    -
    • -(*) This module requires a supported database. For a list of supported databases, see section 3.2. -

    You can see which database backend each module needs by looking at the suffix: -

    • -No suffix, this means that the modules uses Erlang’s built-in database -Mnesia as backend, or in some cases it can be configured to use ODBC. -
    • ‘_odbc’, this means that the module needs a supported database -(see 3.2) as backend. -
    • ‘_ldap’, this means that the module needs an LDAP server as backend. -

    Those modules accept the option {backend, mnesia|odbc}, -and can store the tables in the configured backend:

    You can find more -contributed modules on the -ejabberd website. Please remember that these contributions might not work or -that they can contain severe bugs and security leaks. Therefore, use them at -your own risk!

    -

    3.3.2  Common Options

    The following options are used by many modules. Therefore, they are described in -this separate section.

    -

    iqdisc

    -

    Many modules define handlers for processing IQ queries of different namespaces -to this server or to a user (e. g. to example.org or to -user@example.org). This option defines processing discipline for -these queries.

    The syntax is: -

    {iqdisc, Value}

    Possible Value are: -

    -no_queue
    All queries of a namespace with this processing discipline are -processed immediately. This also means that no other packets can be processed -until this one has been completely processed. Hence this discipline is not -recommended if the processing of a query can take a relatively long time. -
    one_queue
    In this case a separate queue is created for the processing -of IQ queries of a namespace with this discipline. In addition, the processing -of this queue is done in parallel with that of other packets. This discipline -is most recommended. -
    {queues, N}
    N separate queues are created to process the -queries. The queries are thus process in parallel, but in a -controlled way. -
    parallel
    For every packet with this discipline a separate Erlang process -is spawned. Consequently, all these packets are processed in parallel. -Although spawning of Erlang process has a relatively low cost, this can break -the server’s normal work, because the Erlang emulator has a limit on the -number of processes (32000 by default). -

    Example: -

    {modules,
- [
-  ...
-  {mod_time, [{iqdisc, no_queue}]},
-  ...
- ]}.
-

    -

    host

    -

    This option defines the Jabber ID of a service provided by an ejabberd module.

    The syntax is: -

    {host, HostName}

    If you include the keyword "@HOST@" in the HostName, -it is replaced at start time with the real virtual host string.

    This example configures -the echo module to provide its echoing service -in the Jabber ID mirror.example.org: -

    {modules,
- [
-  ...
-  {mod_echo, [{host, "mirror.example.org"}]},
-  ...
- ]}.
-

    However, if there are several virtual hosts and this module is enabled in all of them, -the "@HOST@" keyword must be used: -

    {modules,
- [
-  ...
-  {mod_echo, [{host, "mirror.@HOST@"}]},
-  ...
- ]}.
-

    -

    3.3.3  mod_announce

    -

    This module enables configured users to broadcast announcements and to set -the message of the day (MOTD). -Configured users can perform these actions with a -XMPP client either using Ad-hoc commands -or sending messages to specific JIDs.

    The Ad-hoc commands are listed in the Server Discovery. -For this feature to work, mod_adhoc must be enabled.

    The specific JIDs where messages can be sent are listed bellow. -The first JID in each entry will apply only to the specified virtual host -example.org, while the JID between brackets will apply to all virtual -hosts in ejabberd. -

    -example.org/announce/all (example.org/announce/all-hosts/all)
    The -message is sent to all registered users. If the user is online and connected -to several resources, only the resource with the highest priority will receive -the message. If the registered user is not connected, the message will be -stored offline in assumption that offline storage -(see section 3.3.12) is enabled. -
    example.org/announce/online (example.org/announce/all-hosts/online)
    The -message is sent to all connected users. If the user is online and connected -to several resources, all resources will receive the message. -
    example.org/announce/motd (example.org/announce/all-hosts/motd)
    The -message is set as the message of the day (MOTD) and is sent to users when they -login. In addition the message is sent to all connected users (similar to -announce/online). -
    example.org/announce/motd/update (example.org/announce/all-hosts/motd/update)
    -The message is set as message of the day (MOTD) and is sent to users when they -login. The message is not sent to any currently connected user. -
    example.org/announce/motd/delete (example.org/announce/all-hosts/motd/delete)
    -Any message sent to this JID removes the existing message of the day (MOTD). -

    Options: -

    -{access, AccessName}
    This option specifies who is allowed to -send announcements and to set the message of the day (by default, nobody is -able to send such messages). -

    Examples: -

    • -Only administrators can send announcements: -
      {access, announce, [{allow, admins}]}.
-
-{modules,
- [
-  ...
-  {mod_adhoc, []},
-  {mod_announce, [{access, announce}]},
-  ...
- ]}.
-
    • Administrators as well as the direction can send announcements: -
      {acl, direction, {user, "big_boss", "example.org"}}.
-{acl, direction, {user, "assistant", "example.org"}}.
-{acl, admins, {user, "admin", "example.org"}}.
-
-{access, announce, [{allow, admins},
-                    {allow, direction}]}.
-
-{modules,
- [
-  ...
-  {mod_adhoc, []},
-  {mod_announce, [{access, announce}]},
-  ...
- ]}.
-

    Note that mod_announce can be resource intensive on large -deployments as it can broadcast lot of messages. This module should be -disabled for instances of ejabberd with hundreds of thousands users.

    -

    3.3.4  mod_disco

    - - - - -

    This module adds support for Service Discovery (XEP-0030). With -this module enabled, services on your server can be discovered by -XMPP clients. Note that ejabberd has no modules with support -for the superseded Jabber Browsing (XEP-0011) and Agent Information -(XEP-0094). Accordingly, XMPP clients need to have support for -the newer Service Discovery protocol if you want them be able to discover -the services you offer.

    Options: -

    -{iqdisc, Discipline}
    This specifies -the processing discipline for Service Discovery (http://jabber.org/protocol/disco#items and -http://jabber.org/protocol/disco#info) IQ queries (see section 3.3.2). -
    {extra_domains, [Domain, ...]}
    With this option, -you can specify a list of extra domains that are added to the Service Discovery item list. -
    {server_info, [ {Modules, Field, [Value, ...]}, ... ]}
    -Specify additional information about the server, -as described in Contact Addresses for XMPP Services (XEP-0157). -Modules can be the keyword ‘all’, -in which case the information is reported in all the services; -or a list of ejabberd modules, -in which case the information is only specified for the services provided by those modules. -Any arbitrary Field and Value can be specified, not only contact addresses. -

    Examples: -

    • -To serve a link to the Jabber User Directory on jabber.org: -
      {modules,
- [
-  ...
-  {mod_disco, [{extra_domains, ["users.jabber.org"]}]},
-  ...
- ]}.
-
    • To serve a link to the transports on another server: -
      {modules,
- [
-  ...
-  {mod_disco, [{extra_domains, ["icq.example.com",
-                                "msn.example.com"]}]},
-  ...
- ]}.
-
    • To serve a link to a few friendly servers: -
      {modules,
- [
-  ...
-  {mod_disco, [{extra_domains, ["example.org",
-                                "example.com"]}]},
-  ...
- ]}.
-
    • With this configuration, all services show abuse addresses, -feedback address on the main server, -and admin addresses for both the main server and the vJUD service: -
      {modules,
- [
-  ...
-  {mod_disco, [{server_info, [
-      {all,
-       "abuse-addresses",
-       ["mailto:abuse@shakespeare.lit"]},
-      {[mod_muc],
-       "Web chatroom logs",
-       ["http://www.example.org/muc-logs"]},
-      {[mod_disco],
-       "feedback-addresses",
-       ["http://shakespeare.lit/feedback.php", "mailto:feedback@shakespeare.lit", "xmpp:feedback@shakespeare.lit"]},
-      {[mod_disco, mod_vcard],
-       "admin-addresses",
-       ["mailto:xmpp@shakespeare.lit", "xmpp:admins@shakespeare.lit"]}
-  ]}]},
-  ...
- ]}.
-

    -

    3.3.5  mod_echo

    -

    This module simply echoes any XMPP -packet back to the sender. This mirror can be of interest for -ejabberd and XMPP client debugging.

    Options: -

    - -{host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘echo.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -

    Example: Mirror, mirror, on the wall, who is the most beautiful -of them all? -

    {modules,
- [
-  ...
-  {mod_echo, [{host, "mirror.example.org"}]},
-  ...
- ]}.
-

    -

    3.3.6  mod_http_bind

    -

    This module implements XMPP over Bosh (formerly known as HTTP Binding) -as defined in XEP-0124 and XEP-0206. -It extends ejabberd’s built in HTTP service with a configurable -resource at which this service will be hosted.

    To use HTTP-Binding, enable the module: -

    {modules,
- [
-  ...
-  {mod_http_bind, []},
-  ...
-]}.
-

    and add http_bind in the HTTP service. For example: -

    {listen, 
- [
-  ...
-  {5280, ejabberd_http, [
-                         http_bind,
-                         http_poll,
-                         web_admin
-                        ]
-  },
-  ...
-]}.
-

    With this configuration, the module will serve the requests sent to -http://example.org:5280/http-bind/ -Remember that this page is not designed to be used by web browsers, -it is used by XMPP clients that support XMPP over Bosh.

    If you want to set the service in a different URI path or use a different module, -you can configure it manually using the option request_handlers. -For example: -

    {listen, 
- [
-  ...
-  {5280, ejabberd_http, [
-                         {request_handlers, [{["http-bind"], mod_http_bind}]},
-                         http_poll,
-                         web_admin
-                        ]
-  },
-  ...
-]}.
-

    Options: -

    -{max_inactivity, Seconds}
    -Define the maximum inactivity period in seconds. -Default value is 30 seconds. -For example, to set 50 seconds: -
    {modules,
- [
-  ...
-  {mod_http_bind, [ {max_inactivity, 50} ]},
-  ...
-]}.
-

    -

    3.3.7  mod_http_fileserver

    -

    This simple module serves files from the local disk over HTTP.

    Options: -

    -{docroot, Path}
    -Directory to serve the files. -
    {accesslog, Path}
    -File to log accesses using an Apache-like format. -No log will be recorded if this option is not specified. -
    {directory_indices, [Index, ...]}
    -Indicate one or more directory index files, similarly to Apache’s -DirectoryIndex variable. When a web request hits a directory -instead of a regular file, those directory indices are looked in -order, and the first one found is returned. -
    {custom_headers, [ {Name, Value}, ...]}
    -Indicate custom HTTP headers to be included in all responses. -Default value is: [] -
    {content_types, [ {Name, Type}, ...]}
    -Specify mappings of extension to content type. -There are several content types already defined, -with this option you can add new definitions, modify or delete existing ones. -To delete an existing definition, simply define it with a value: ‘undefined’. -
    {default_content_type, Type}
    -Specify the content type to use for unknown extensions. -Default value is ‘application/octet-stream’. -

    This example configuration will serve the files from -the local directory /var/www -in the address http://example.org:5280/pub/archive/. -In this example a new content type ogg is defined, -png is redefined, and jpg definition is deleted. -To use this module you must enable it: -

    {modules,
- [
-  ...
-  {mod_http_fileserver, [
-                         {docroot, "/var/www"}, 
-                         {accesslog, "/var/log/ejabberd/access.log"},
-                         {directory_indices, ["index.html", "main.htm"]},
-                         {custom_headers, [{"X-Powered-By", "Erlang/OTP"},
-                                           {"X-Fry", "It's a widely-believed fact!"}
-                                          ]},
-                         {content_types, [{".ogg", "audio/ogg"},
-                                          {".png", "image/png"},
-                                          {".jpg", undefined}
-                                         ]},
-                         {default_content_type, "text/html"}
-                        ]
-  },
-  ...
-]}.
-

    And define it as a handler in the HTTP service: -

    {listen, 
- [
-  ...
-  {5280, ejabberd_http, [
-                         ...
-                         {request_handlers, [
-                                             ...
-                                             {["pub", "archive"], mod_http_fileserver},
-                                             ...
-                                            ]
-                         },
-                         ...
-                        ]
-  },
-  ...
-]}.
-

    -

    3.3.8  mod_last

    -

    This module adds support for Last Activity (XEP-0012). It can be used to -discover when a disconnected user last accessed the server, to know when a -connected user was last active on the server, or to query the uptime of the -ejabberd server.

    Options: -

    -{backend, mnesia|odbc}
    -Specify the backend used to store the tables: last_activity. -The default value is mnesia. -If configured to odbc, then you must also configure in ejabberd -the database connection (see the subsections of 3.2). - -
    {iqdisc, Discipline}
    This specifies -the processing discipline for Last activity (jabber:iq:last) IQ queries (see section 3.3.2). -

    -

    3.3.9  mod_muc

    -

    This module provides a Multi-User Chat (XEP-0045) service. -Users can discover existing rooms, join or create them. -Occupants of a room can chat in public or have private chats.

    Some of the features of Multi-User Chat: -

    • -Sending public and private messages to room occupants. -
    • Inviting other users to a room. -
    • Setting a room subject. -
    • Creating password protected rooms. -
    • Kicking and banning occupants. -

    The MUC service allows any Jabber ID to register a nickname, -so nobody else can use that nickname in any room in the MUC service. -To register a nickname, open the Service Discovery in your -XMPP client and register in the MUC service.

    This module supports clustering and load -balancing. One module can be started per cluster node. Rooms are -distributed at creation time on all available MUC module -instances. The multi-user chat module is clustered but the rooms -themselves are not clustered nor fault-tolerant: if the node managing a -set of rooms goes down, the rooms disappear and they will be recreated -on an available node on first connection attempt.

    Module options: -

    - -{host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘conference.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -
    {access, AccessName}
    You can specify who is allowed to use -the Multi-User Chat service. By default everyone is allowed to use it. -
    {access_create, AccessName}
    To configure who is -allowed to create new rooms at the Multi-User Chat service, this option can be used. -By default any account in the local ejabberd server is allowed to create rooms. -
    {access_persistent, AccessName}
    To configure who is -allowed to modify the ’persistent’ room option. -By default any account in the local ejabberd server is allowed to modify that option. -
    {access_admin, AccessName}
    This option specifies -who is allowed to administrate the Multi-User Chat service. The default -value is none, which means that only the room creator can -administer his room. -The administrators can send a normal message to the service JID, -and it will be shown in all active rooms as a service message. -The administrators can send a groupchat message to the JID of an active room, -and the message will be shown in the room as a service message. -
    {history_size, Size}
    A small history of -the current discussion is sent to users when they enter the -room. With this option you can define the number of history messages -to keep and send to users joining the room. The value is an -integer. Setting the value to 0 disables the history feature -and, as a result, nothing is kept in memory. The default value is -20. This value is global and thus affects all rooms on the -service. -
    {max_users, Number}
    This option defines at -the service level, the maximum number of users allowed per -room. It can be lowered in each room configuration but cannot be -increased in individual room configuration. The default value is -200. -
    {max_users_admin_threshold, Number}
    - This option defines the -number of service admins or room owners allowed to enter the room when -the maximum number of allowed occupants was reached. The default limit -is 5. -
    {max_user_conferences, Number}
    - This option defines the maximum -number of rooms that any given user can join. The default value -is 10. This option is used to prevent possible abuses. Note that -this is a soft limit: some users can sometimes join more conferences -in cluster configurations. -
    {max_room_id, Number}
    -This option defines the maximum number of characters that Room ID -can have when creating a new room. -The default value is to not limit: infinite. -
    {max_room_name, Number}
    -This option defines the maximum number of characters that Room Name -can have when configuring the room. -The default value is to not limit: infinite. -
    {max_room_desc, Number}
    -This option defines the maximum number of characters that Room Description -can have when configuring the room. -The default value is to not limit: infinite. -
    {min_message_interval, Number}
    -This option defines the minimum interval between two messages send -by an occupant in seconds. This option is global and valid for all -rooms. A decimal value can be used. When this option is not defined, -message rate is not limited. This feature can be used to protect a -MUC service from occupant abuses and limit number of messages that will -be broadcasted by the service. A good value for this minimum message -interval is 0.4 second. If an occupant tries to send messages faster, an -error is send back explaining that the message has been discarded -and describing the reason why the message is not acceptable. -
    {min_presence_interval, Number}
    - This option defines the -minimum of time between presence changes coming from a given occupant in -seconds. This option is global and valid for all rooms. A -decimal value can be used. When this option is not defined, no -restriction is applied. This option can be used to protect a MUC -service for occupants abuses. If an occupant tries -to change its presence more often than the specified interval, the -presence is cached by ejabberd and only the last presence is -broadcasted to all occupants in the room after expiration of the -interval delay. Intermediate presence packets are silently -discarded. A good value for this option is 4 seconds. -
    {default_room_options, [ {OptionName, OptionValue}, ...]}
    -This module option allows to define the desired default room options. -Note that the creator of a room can modify the options of his room -at any time using a XMPP client with MUC capability. -The available room options and the default values are: -
    -{allow_change_subj, true|false}
    Allow occupants to change the subject. -
    {allow_private_messages, true|false}
    Occupants can send private messages to other occupants. -
    {allow_query_users, true|false}
    Occupants can send IQ queries to other occupants. -
    {allow_user_invites, false|true}
    Allow occupants to send invitations. -
    {allow_visitor_nickchange, true|false}
    Allow visitors to -change nickname. -
    {allow_visitor_status, true|false}
    Allow visitors to send -status text in presence updates. If disallowed, the status -text is stripped before broadcasting the presence update to all -the room occupants. -
    {anonymous, true|false}
    The room is anonymous: -occupants don’t see the real JIDs of other occupants. -Note that the room moderators can always see the real JIDs of the occupants. -
    {captcha_protected, false}
    -When a user tries to join a room where he has no affiliation (not owner, admin or member), -the room requires him to fill a CAPTCHA challenge (see section 3.1.8) -in order to accept her join in the room. -
    {logging, false|true}
    The public messages are logged using mod_muc_log. -
    {max_users, 200}
    Maximum number of occupants in the room. -
    {members_by_default, true|false}
    The occupants that enter the room are participants by default, so they have ’voice’. -
    {members_only, false|true}
    Only members of the room can enter. -
    {moderated, true|false}
    Only occupants with ’voice’ can send public messages. -
    {password, "roompass123"}
    Password of the room. You may want to enable the next option too. -
    {password_protected, false|true}
    The password is required to enter the room. -
    {persistent, false|true}
    The room persists even if the last participant leaves. -
    {public, true|false}
    The room is public in the list of the MUC service, so it can be discovered. -
    {public_list, true|false}
    The list of participants is public, without requiring to enter the room. -
    {title, "Room Title"}
    A human-readable title of the room. -
    -All of those room options can be set to true or false, -except password and title which are strings, -and max_users that is integer. -

    Examples: -

    • -In the first example everyone is allowed to use the Multi-User Chat -service. Everyone will also be able to create new rooms but only the user -admin@example.org is allowed to administrate any room. In this -example he is also a global administrator. When admin@example.org -sends a message such as ‘Tomorrow, the XMPP server will be moved -to new hardware. This will involve service breakdowns around 23:00 UMT. -We apologise for this inconvenience.’ to conference.example.org, -it will be displayed in all active rooms. In this example the history -feature is disabled. -
      {acl, admin, {user, "admin", "example.org"}}.
-
-{access, muc_admin, [{allow, admin}]}.
-
-{modules,
- [
-  ...
-  {mod_muc, [{access, all},
-             {access_create, all},
-             {access_admin, muc_admin},
-             {history_size, 0}]},
-  ...
- ]}.
-
    • In the second example the Multi-User Chat service is only accessible by -paying customers registered on our domains and on other servers. Of course -the administrator is also allowed to access rooms. In addition, he is the -only authority able to create and administer rooms. When -admin@example.org sends a message such as ‘Tomorrow, the Jabber -server will be moved to new hardware. This will involve service breakdowns -around 23:00 UMT. We apologise for this inconvenience.’ to -conference.example.org, it will be displayed in all active rooms. No -history_size option is used, this means that the feature is enabled -and the default value of 20 history messages will be send to the users. -
      {acl, paying_customers, {user, "customer1", "example.net"}}.
-{acl, paying_customers, {user, "customer2", "example.com"}}.
-{acl, paying_customers, {user, "customer3", "example.org"}}.
-{acl, admin, {user, "admin", "example.org"}}.
-
-{access, muc_admin, [{allow, admin},
-                      {deny, all}]}.
-{access, muc_access, [{allow, paying_customers},
-                      {allow, admin},
-                      {deny, all}]}.
-
-{modules,
- [
-  ...
-  {mod_muc, [{access, muc_access},
-             {access_create, muc_admin},
-             {access_admin, muc_admin}]},
-  ...
- ]}.
-
    • In the following example, MUC anti abuse options are used. An -occupant cannot send more than one message every 0.4 seconds and cannot -change its presence more than once every 4 seconds. -The length of Room IDs and Room Names are limited to 20 characters, -and Room Description to 300 characters. No ACLs are -defined, but some user restriction could be added as well:
      {modules,
- [
-  ...
-  {mod_muc, [{min_message_interval, 0.4},
-             {min_presence_interval, 4},
-             {max_room_id, 20},
-             {max_room_name, 20},
-             {max_room_desc, 300}]},
-  ...
- ]}.
-
    • This example shows how to use default_room_options to make sure -the newly created rooms have by default those options. -
      {modules,
- [
-  ...
-  {mod_muc, [{access, muc_access},
-             {access_create, muc_admin},
-             {default_room_options,
-              [
-               {allow_change_subj, false},
-               {allow_query_users, true},
-               {allow_private_messages, true},
-               {members_by_default, false},
-               {title, "New chatroom"},
-               {anonymous, false}
-              ]},
-             {access_admin, muc_admin}]},
-  ...
- ]}.
-

    -

    3.3.10  mod_muc_log

    -

    This module enables optional logging of Multi-User Chat (MUC) public conversations to -HTML. Once you enable this module, users can join a room using a MUC capable -XMPP client, and if they have enough privileges, they can request the -configuration form in which they can set the option to enable room logging.

    Features: -

    • -Room details are added on top of each page: room title, JID, -author, subject and configuration. -
    • -The room JID in the generated HTML is a link to join the room (using -XMPP URI). -
    • Subject and room configuration changes are tracked and displayed. -
    • Joins, leaves, nick changes, kicks, bans and ‘/me’ are tracked and -displayed, including the reason if available. -
    • Generated HTML files are XHTML 1.0 Transitional and CSS compliant. -
    • Timestamps are self-referencing links. -
    • Links on top for quicker navigation: Previous day, Next day, Up. -
    • CSS is used for style definition, and a custom CSS file can be used. -
    • URLs on messages and subjects are converted to hyperlinks. -
    • Timezone used on timestamps is shown on the log files. -
    • A custom link can be added on top of each page. -

    Options: -

    -{access_log, AccessName}
    -This option restricts which occupants are allowed to enable or disable room -logging. The default value is muc_admin. Note for this default setting -you need to have an access rule for muc_admin in order to take effect. -
    {cssfile, false|URL}
    -With this option you can set whether the HTML files should have a custom CSS -file or if they need to use the embedded CSS file. Allowed values are -false and an URL to a CSS file. With the first value, HTML files will -include the embedded CSS code. With the latter, you can specify the URL of the -custom CSS file (for example: "http://example.com/my.css"). The default value -is false. -
    {dirname, room_jid|room_name}
    -Allows to configure the name of the room directory. -Allowed values are room_jid and room_name. -With the first value, the room directory name will be the full room JID. -With the latter, the room directory name will be only the room name, -not including the MUC service name. -The default value is room_jid. -
    {dirtype, subdirs|plain}
    -The type of the created directories can be specified with this option. Allowed -values are subdirs and plain. With the first value, -subdirectories are created for each year and month. With the latter, the -names of the log files contain the full date, and there are no subdirectories. -The default value is subdirs. -
    {file_format, html|plaintext}
    -Define the format of the log files: -html stores in HTML format, -plaintext stores in plain text. -The default value is html. -
    {outdir, Path}
    -This option sets the full path to the directory in which the HTML files should -be stored. Make sure the ejabberd daemon user has write access on that -directory. The default value is "www/muc". -
    {link_nofollow true|false}
    -The option link_nofollow adds a special attribute -to links that prevent their indexation by search engines. The default value -is true, which means that nofollow attributes will be added to user -submitted links. -
    {timezone, local|universal}
    -The time zone for the logs is configurable with this option. Allowed values -are local and universal. With the first value, the local time, -as reported to Erlang by the operating system, will be used. With the latter, -GMT/UTC time will be used. The default value is local. -
    {top_link, {URL, Text}}
    -With this option you can customize the link on the top right corner of each -log file. The default value is {"/", "Home"}. -

    Examples: -

    • -In the first example any room owner can enable logging, and a -custom CSS file will be used (http://example.com/my.css). The names -of the log files will contain the full date, and there will be no -subdirectories. The log files will be stored in /var/www/muclogs, and the -time zone will be GMT/UTC. Finally, the top link will be -<a href="http://www.jabber.ru/">Jabber.ru</a>. -
      {access, muc, [{allow, all}]}.
-
-{modules,
- [
-  ...
-  {mod_muc_log, [
-                 {access_log, muc},
-                 {cssfile, "http://example.com/my.css"},
-                 {dirtype, plain},
-                 {dirname, room_jid},
-                 {outdir, "/var/www/muclogs"},
-                 {timezone, universal},
-                 {link_nofollow, true},
-                 {top_link, {"http://www.jabber.ru/", "Jabber.ru"}}
-                ]},
-  ...
- ]}.
-
    • In the second example only admin1@example.org and -admin2@example.net can enable logging, and the embedded CSS file will be -used. The names of the log files will only contain the day (number), -and there will be subdirectories for each year and month. The log files will -be stored in /var/www/muclogs, and the local time will be used. Finally, the -top link will be the default <a href="/">Home</a>. -
      {acl, admins, {user, "admin1", "example.org"}}.
-{acl, admins, {user, "admin2", "example.net"}}.
-
-{access, muc_log, [{allow, admins},
-                   {deny, all}]}.
-
-{modules,
- [
-  ...
-  {mod_muc_log, [
-                 {access_log, muc_log},
-                 {cssfile, false},
-                 {dirtype, subdirs},
-                 {outdir, "/var/www/muclogs"},
-                 {timezone, local}
-                ]},
-  ...
- ]}.
-

    -

    3.3.11  mod_multicast

    -

    This module implements a service for Extended Stanza Addressing (XEP-0033) -that can be used by local or remote XMPP entities (users, components or servers). -If this service is enabled, it will be used by ejabberd to send -C2S presence broadcasts, and MUC groupchat messages.

    Options: -

    - -{host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘multicast.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -
    {access, AccessName}
    -Specify who can send packets to the multicast service. -By default everyone is allowed to use it. -
    {limits, [ {Sender, Stanza, Number} ] }
    -Specify a list of custom limits which override the default ones. -Sender can be local or remote. -Stanza can be message or presence. -Number can be a positive integer or the key word infinite. -The default value of this option is: -
    [{local,  message,  100},
- {local,  presence, 100},
- {remote, message,   20},
- {remote, presence,  20}]
-

    Example configuration: -

    % Only admins can send packets to multicast service
-{access, multicast, [{allow, admin}, {deny, all}]}.
-
-% If you want to allow all your users:
-%{access, multicast, [{allow, all}]}.
-
-% This allows both admins and remote users to send packets,
-% but does not allow local users:
-%{acl, allservers, {server_glob, "*"}}.
-%{access, multicast, [{allow, admin}, {deny, local}, {allow, allservers}]}.
-
-{modules, [
-  ...
-  {mod_multicast, [
-     {host, "multicast.example.org"},
-     {access, multicast},
-     {limits, [
-       {local, message, 40},
-       {local, presence, infinite},
-       {remote, message, 150}
-     ]}
-  ]},
-  ...
-]}.
-

    -

    3.3.12  mod_offline

    -

    This module implements offline message storage (XEP-0160). -This means that all messages -sent to an offline user will be stored on the server until that user comes -online again. Thus it is very similar to how email works. Note that -ejabberdctl has a command to delete expired messages -(see section 4.1).

    -{access_max_user_messages, AccessName}
    -This option defines which access rule will be enforced to limit -the maximum number of offline messages that a user can have (quota). -When a user has too many offline messages, any new messages that he receive are discarded, -and a resource-constraint error is returned to the sender. -The default value is max_user_offline_messages. -Then you can define an access rule with a syntax similar to -
    {backend, mnesia|odbc}
    -Specify the backend used to store the tables: offline_msg. -The default value is mnesia. -If configured to odbc, then you must also configure in ejabberd -the database connection (see the subsections of 3.2). - -max_user_sessions (see 3.1.5). -

    This example allows power users to have as much as 5000 offline messages, -administrators up to 2000, -and all the other users up to 100. -

    {acl, admin, {user, "admin1", "localhost"}}.
-{acl, admin, {user, "admin2", "example.org"}}.
-{acl, poweruser, {user, "bob", "example.org"}}.
-{acl, poweruser, {user, "jane", "example.org"}}.
-
-{access, max_user_offline_messages, [ {5000, poweruser}, {2000, admin}, {100, all} ]}.
-
-{modules,
- [
-  ...
-  {mod_offline,  [ {access_max_user_messages, max_user_offline_messages} ]},
-  ...
- ]}.
-

    -

    3.3.13  mod_ping

    -

    This module implements support for XMPP Ping (XEP-0199) and periodic keepalives. -When this module is enabled ejabberd responds correctly to -ping requests, as defined in the protocol.

    Configuration options: -

    -{send_pings, true|false}
    -If this option is set to true, the server sends pings to connected clients -that are not active in a given interval ping_interval. -This is useful to keep client connections alive or checking availability. -By default this option is disabled. -
    {ping_interval, Seconds}
    -How often to send pings to connected clients, if the previous option is enabled. -If a client connection does not send or receive any stanza in this interval, -a ping request is sent to the client. -The default value is 60 seconds. -
    {timeout_action, none|kill}
    -What to do when a client does not answer to a server ping request in less than 32 seconds. -The default is to do nothing. -

    This example enables Ping responses, configures the module to send pings -to client connections that are inactive for 4 minutes, -and if a client does not answer to the ping in less than 32 seconds, its connection is closed: -

    {modules,
- [
-  ...
-  {mod_ping,  [{send_pings, true}, {ping_interval, 240}, {timeout_action, kill}]},
-  ...
- ]}.
-

    -

    3.3.14  mod_privacy

    -

    This module implements Blocking Communication (also known as Privacy Rules) -as defined in section 10 from XMPP IM. If end users have support for it in -their XMPP client, they will be able to: -

    -
    • -Retrieving one’s privacy lists. -
    • Adding, removing, and editing one’s privacy lists. -
    • Setting, changing, or declining active lists. -
    • Setting, changing, or declining the default list (i.e., the list that -is active by default). -
    • Allowing or blocking messages based on JID, group, or subscription type -(or globally). -
    • Allowing or blocking inbound presence notifications based on JID, group, -or subscription type (or globally). -
    • Allowing or blocking outbound presence notifications based on JID, group, -or subscription type (or globally). -
    • Allowing or blocking IQ stanzas based on JID, group, or subscription type -(or globally). -
    • Allowing or blocking all communications based on JID, group, or -subscription type (or globally). -
    -(from http://xmpp.org/rfcs/rfc3921.html#privacy) -

    Options: -

    -{backend, mnesia|odbc}
    -Specify the backend used to store the tables: privacy_default_list, privacy_list and privacy_list_data. -The default value is mnesia. -If configured to odbc, then you must also configure in ejabberd -the database connection (see the subsections of 3.2). - -
    {iqdisc, Discipline}
    This specifies -the processing discipline for Blocking Communication (jabber:iq:privacy) IQ queries (see section 3.3.2). -

    -

    3.3.15  mod_private

    -

    This module adds support for Private XML Storage (XEP-0049): -

    -Using this method, XMPP entities can store private data on the server and -retrieve it whenever necessary. The data stored might be anything, as long as -it is valid XML. One typical usage for this namespace is the server-side storage -of client-specific preferences; another is Bookmark Storage (XEP-0048). -

    Options: -

    -{backend, mnesia|odbc}
    -Specify the backend used to store the tables: private_storage. -The default value is mnesia. -If configured to odbc, then you must also configure in ejabberd -the database connection (see the subsections of 3.2). - -
    {iqdisc, Discipline}
    This specifies -the processing discipline for Private XML Storage (jabber:iq:private) IQ queries (see section 3.3.2). -

    -

    3.3.16  mod_proxy65

    -

    This module implements SOCKS5 Bytestreams (XEP-0065). -It allows ejabberd to act as a file transfer proxy between two -XMPP clients.

    Options: -

    - -{host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘proxy.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -
    {name, Text}
    Defines Service Discovery name of the service. -Default is "SOCKS5 Bytestreams". -
    {ip, IPTuple}
    This option specifies which network interface -to listen for. Default is an IP address of the service’s DNS name, or, -if fails, {127,0,0,1}. -
    {port, Number}
    This option defines port to listen for -incoming connections. Default is 7777. -
    {hostname, HostName}
    Defines a hostname advertised -by the service when establishing a session with clients. This is useful when -you run the service behind a NAT. The default is the value of ip option. -Examples: "proxy.mydomain.org", "200.150.100.50". Note that -not all clients understand domain names in stream negotiation, -so you should think twice before setting domain name in this option. -
    {auth_type, anonymous|plain}
    SOCKS5 authentication type. -Possible values are anonymous and plain. Default is -anonymous. -
    {access, AccessName}
    Defines ACL for file transfer initiators. -Default is all. -
    {max_connections, Number}
    Maximum number of -active connections per file transfer initiator. No limit by default. -
    {shaper, none|ShaperName}
    This option defines shaper for -the file transfer peers. Shaper with the maximum bandwidth will be selected. -Default is none. -

    Examples: -

    • -The simpliest configuration of the module: -
      {modules,
- [
-  ...
-  {mod_proxy65, []},
-  ...
- ]}.
-
    • More complicated configuration. -
      {acl, proxy_users, {server, "example.org"}}.
-{access, proxy65_access, [{allow, proxy_users}, {deny, all}]}.
-
-{acl, admin, {user, "admin", "example.org"}}.
-{shaper, proxyrate, {maxrate, 10240}}. %% 10 Kbytes/sec
-{access, proxy65_shaper, [{none, admin}, {proxyrate, proxy_users}]}.
-
-{modules,
- [
-  ...
-  {mod_proxy65, [{host, "proxy1.example.org"},
-                 {name, "File Transfer Proxy"},
-                 {ip, {200,150,100,1}},
-                 {port, 7778},
-                 {max_connections, 5},
-                 {access, proxy65_access},
-                 {shaper, proxy65_shaper}]},
-  ...
- ]}.
-

    -

    3.3.17  mod_pubsub

    -

    This module offers a Publish-Subscribe Service (XEP-0060). -The functionality in mod_pubsub can be extended using plugins. -The plugin that implements PEP (Personal Eventing via Pubsub) (XEP-0163) -is enabled in the default ejabberd configuration file, -and it requires mod_caps.

    Options: -

    - -{host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘pubsub.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -If you use mod_pubsub_odbc, please ensure the prefix contains only one dot, -for example ‘pubsub.’, or ‘publish.’,. -
    {access_createnode, AccessName}
    -This option restricts which users are allowed to create pubsub nodes using -ACL and ACCESS. -By default any account in the local ejabberd server is allowed to create pubsub nodes. -
    {max_items_node, MaxItems}
    -Define the maximum number of items that can be stored in a node. -Default value is 10. -
    {plugins, [ Plugin, ...]}
    -To specify which pubsub node plugins to use. If not defined, the default -pubsub plugin is always used. -
    {nodetree, Name}
    -To specify which nodetree to use. If not defined, the default pubsub -nodetree is used. Only one nodetree can be used per host, -and is shared by all node plugins. -
    {ignore_pep_from_offline, false|true}
    -To specify whether or not we should get last published PEP items -from users in our roster which are offline when we connect. Value is true or false. -If not defined, pubsub assumes true so we only get last items of online contacts. -
    {last_item_cache, false|true}
    -To specify whether or not pubsub should cache last items. Value is true -or false. If not defined, pubsub do not cache last items. On systems with not so many nodes, -caching last items speeds up pubsub and allows to raise user connection rate. The cost is memory -usage, as every item is stored in memory. -
    {pep_mapping, [ {Key, Value}, ...]}
    -This allow to define a Key-Value list to choose defined node plugins on given PEP namespace. -The following example will use node_tune instead of node_pep for every PEP node with tune namespace: -
      {mod_pubsub, [{pep_mapping, [{"http://jabber.org/protocol/tune", "tune"}]}]}
-

    Example of configuration that uses flat nodes as default, and allows use of flat, nodetree and pep nodes: -

    {modules,
- [
-  ...
-  {mod_pubsub, [
-                {access_createnode, pubsub_createnode},
-                {plugins, ["flat", "hometree", "pep"]}
-               ]},
-  ...
- ]}.
-

    Using ODBC database requires use of dedicated plugins. The following example shows previous configuration -with ODBC usage: -

    {modules,
- [
-  ...
-  {mod_pubsub_odbc, [
-                {access_createnode, pubsub_createnode},
-                {plugins, ["flat_odbc", "hometree_odbc", "pep_odbc"]}
-               ]},
-  ...
- ]}.
-

    -

    3.3.18  mod_register

    -

    This module adds support for In-Band Registration (XEP-0077). This protocol -enables end users to use a XMPP client to: -

    • -Register a new account on the server. -
    • Change the password from an existing account on the server. -
    • Delete an existing account on the server. -

    Options: -

    -{access, AccessName}
    This option can be configured to specify -rules to restrict registration. If a rule returns ‘deny’ on the requested -user name, registration for that user name is denied. (there are no -restrictions by default). -
    {access_from, AccessName}
    By default, ejabberd -doesn’t allow to register new accounts from s2s or existing c2s sessions. You can -change it by defining access rule in this option. Use with care: allowing registration -from s2s leads to uncontrolled massive accounts creation by rogue users. -
    {welcome_message, Message}
    Set a welcome message that -is sent to each newly registered account. The first string is the subject, and -the second string is the message body. -In the body you can set a newline with the characters: \n -
    {registration_watchers, [ JID, ...]}
    This option defines a -list of JIDs which will be notified each time a new account is registered. -
    {iqdisc, Discipline}
    This specifies -the processing discipline for In-Band Registration (jabber:iq:register) IQ queries (see section 3.3.2). -

    This module reads also another option defined globally for the server: -{registration_timeout, Timeout}. -This option limits the frequency of registration from a given IP or username. -So, a user that tries to register a new account from the same IP address or JID during -this number of seconds after his previous registration -will receive an error resource-constraint with the explanation: -“Users are not allowed to register accounts so quickly”. -The timeout is expressed in seconds, and it must be an integer. -To disable this limitation, -instead of an integer put a word like: infinity. -Default value: 600 seconds.

    Examples: -

    • -Next example prohibits the registration of too short account names: -
      {acl, shortname, {user_glob, "?"}}.
-{acl, shortname, {user_glob, "??"}}.
-%% The same using regexp:
-%%{acl, shortname, {user_regexp, "^..?$"}}.
-
-{access, register, [{deny, shortname},
-                    {allow, all}]}.
-
-{modules,
- [
-  ...
-  {mod_register, [{access, register}]},
-  ...
- ]}.
-
    • This configuration prohibits usage of In-Band Registration -to create or delete accounts, -but allows existing accounts to change the password: -
      {access, register, [{deny, all}]}.
-
-{modules,
- [
-  ...
-  {mod_register, [{access, register}]},
-  ...
- ]}.
-
    • This configuration disables all In-Band Registration -functionality: create, delete accounts and change password: -
      {modules,
- [
-  ...
-  %% {mod_register, [{access, register}]},
-  ...
- ]}.
-
    • Define the welcome message and two registration watchers. -Also define a registration timeout of one hour: -
      {registration_timeout, 3600}.
-{modules,
- [
-  ...
-  {mod_register,
-   [
-    {welcome_message, {"Welcome!", "Hi.\nWelcome to this Jabber server.\n Check http://www.jabber.org\n\nBye"}},
-    {registration_watchers, ["admin1@example.org", "boss@example.net"]}
-   ]},
-  ...
- ]}.
-

    -

    3.3.19  mod_roster

    -

    This module implements roster management as defined in -RFC 3921: XMPP IM. -It also supports Roster Versioning (XEP-0237).

    Options: -

    -{backend, mnesia|odbc}
    -Specify the backend used to store the tables: rosteritem and rostergroup. -The default value is mnesia. -If configured to odbc, then you must also configure in ejabberd -the database connection (see the subsections of 3.2). - -
    {iqdisc, Discipline}
    This specifies -the processing discipline for Roster Management (jabber:iq:roster) IQ queries (see section 3.3.2). -
    access
    -This option can be configured to specify rules to restrict roster management. -If a rule returns ‘deny’ on the requested user name, -that user cannot modify his personal roster: -not add/remove/modify contacts, -or subscribe/unsubscribe presence. -By default there aren’t restrictions. -
    {versioning, false|true}
    Enables -Roster Versioning. -This option is disabled by default. -
    {store_current_id, false|true}
    -If this option is enabled, the current version number is stored on the database. -If disabled, the version number is calculated on the fly each time. -Enabling this option reduces the load for both ejabberd and the database. -This option does not affect the client in any way. -This option is only useful if Roster Versioning is enabled. -This option is disabled by default. -Important: if you use mod_shared_roster, you must disable this option. -

    This example configuration enables Roster Versioning with storage of current id: -

    {modules,
- [
-  ...
-  {mod_roster, [{versioning, true}, {store_current_id, true}]},
-  ...
- ]}.
-

    With this example configuration only admins can manage their rosters; -everybody else cannot modify the roster: -

    {acl, admin, {user, "bob", "example.org"}}.
-{acl, admin, {user, "sarah", "example.org"}}.
-
-{access, roster, [{allow, admin},
-                  {deny, all}]}.
-
-{modules,
- [
-  ...
-  {mod_roster, [{access, roster}]},
-  ...
- ]}.
-

    -

    3.3.20  mod_service_log

    -

    This module adds support for logging end user packets via a XMPP message -auditing service such as -Bandersnatch. All user -packets are encapsulated in a <route/> element and sent to the specified -service(s).

    Options: -

    -{loggers, [Names, ...]}
    With this option a (list of) service(s) -that will receive the packets can be specified. -

    Examples: -

    • -To log all end user packets to the Bandersnatch service running on -bandersnatch.example.com: -
      {modules,
- [
-  ...
-  {mod_service_log, [{loggers, ["bandersnatch.example.com"]}]},
-  ...
- ]}.
-
    • To log all end user packets to the Bandersnatch service running on -bandersnatch.example.com and the backup service on -bandersnatch.example.org: -
      {modules,
- [
-  ...
-  {mod_service_log, [{loggers, ["bandersnatch.example.com",
-                                "bandersnatch.example.org"]}]},
-  ...
- ]}.
-

    -

    3.3.21  mod_shared_roster

    -

    This module enables you to create shared roster groups. This means that you can -create groups of people that can see members from (other) groups in their -rosters. The big advantages of this feature are that end users do not need to -manually add all users to their rosters, and that they cannot permanently delete -users from the shared roster groups. -A shared roster group can have members from any XMPP server, -but the presence will only be available from and to members -of the same virtual host where the group is created.

    Shared roster groups can be edited only via the Web Admin. Each group -has a unique identification and the following parameters: -

    -Name
    The name of the group, which will be displayed in the roster. -
    Description
    The description of the group. This parameter does not affect -anything. -
    Members
    A list of full JIDs of group members, entered one per line in -the Web Admin. -To put as members all the registered users in the virtual hosts, -you can use the special directive: @all@. -Note that this directive is designed for a small server with just a few hundred users. -
    Displayed groups
    A list of groups that will be in the rosters of this -group’s members. -

    Examples: -

    • -Take the case of a computer club that wants all its members seeing each -other in their rosters. To achieve this, they need to create a shared roster -group similar to next table: -
      - - - - - -
      IdentificationGroup ‘club_members’
      NameClub Members
      DescriptionMembers from the computer club
      Members - - -
      member1@example.org
      member2@example.org
      member3@example.org
      Displayed groupsclub_members
      -
      -
    • In another case we have a company which has three divisions: Management, -Marketing and Sales. All group members should see all other members in their -rosters. Additionally, all managers should have all marketing and sales people -in their roster. Simultaneously, all marketeers and the whole sales team -should see all managers. This scenario can be achieved by creating shared -roster groups as shown in the following table: -
      - - - - - -
      Identification Group ‘management’ Group ‘marketing’ Group ‘sales’
      NameManagementMarketingSales
      Description 
      Members - - - -
      manager1@example.org
      manager2@example.org
      manager3@example.org
      manager4@example.org
      -      		 - - - -
      marketeer1@example.org
      marketeer2@example.org
      marketeer3@example.org
      marketeer4@example.org
      -      		 - - - -
      saleswoman1@example.org
      salesman1@example.org
      saleswoman2@example.org
      salesman2@example.org
      Displayed groups - - -
      management
      marketing
      sales
      -      		 - -
      management
      marketing
      -      		 - -
      management
      sales
      -
      -

    -

    3.3.22  mod_sic

    -

    This module adds support for Server IP Check (XEP-0279). This protocol -enables a client to discover its external IP address.

    Options: -

    -{iqdisc, Discipline}
    This specifies -the processing discipline for urn:xmpp:sic:0 IQ queries (see section 3.3.2). -

    -

    3.3.23  mod_stats

    -

    This module adds support for Statistics Gathering (XEP-0039). This protocol -allows you to retrieve next statistics from your ejabberd deployment: -

    • -Total number of registered users on the current virtual host (users/total). -
    • Total number of registered users on all virtual hosts (users/all-hosts/total). -
    • Total number of online users on the current virtual host (users/online). -
    • Total number of online users on all virtual hosts (users/all-hosts/online). -

    Options: -

    -{iqdisc, Discipline}
    This specifies -the processing discipline for Statistics Gathering (http://jabber.org/protocol/stats) IQ queries (see section 3.3.2). -

    As there are only a small amount of clients (for example -Tkabber) and software libraries with -support for this XEP, a few examples are given of the XML you need to send -in order to get the statistics. Here they are: -

    • -You can request the number of online users on the current virtual host -(example.org) by sending: -
      <iq to='example.org' type='get'>
-  <query xmlns='http://jabber.org/protocol/stats'>
-    <stat name='users/online'/>
-  </query>
-</iq>
-
    • You can request the total number of registered users on all virtual hosts -by sending: -
      <iq to='example.org' type='get'>
-  <query xmlns='http://jabber.org/protocol/stats'>
-    <stat name='users/all-hosts/total'/>
-  </query>
-</iq>
-

    -

    3.3.24  mod_time

    -

    This module features support for Entity Time (XEP-0202). By using this XEP, -you are able to discover the time at another entity’s location.

    Options: -

    -{iqdisc, Discipline}
    This specifies -the processing discipline for Entity Time (jabber:iq:time) IQ queries (see section 3.3.2). -

    -

    3.3.25  mod_vcard

    -

    This module allows end users to store and retrieve their vCard, and to retrieve -other users vCards, as defined in vcard-temp (XEP-0054). The module also -implements an uncomplicated Jabber User Directory based on the vCards of -these users. Moreover, it enables the server to send its vCard when queried.

    Options: -

    -{backend, mnesia|odbc}
    -Specify the backend used to store the tables: vcard. -The default value is mnesia. -If configured to odbc, then you must also configure in ejabberd -the database connection (see the subsections of 3.2). - - -
    {host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘vjud.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -
    {iqdisc, Discipline}
    This specifies -the processing discipline for vcard-temp IQ queries (see section 3.3.2). -
    {search, true|false}
    This option specifies whether the search -functionality is enabled or not -If disabled, the option host will be ignored and the -Jabber User Directory service will not appear in the Service Discovery item -list. The default value is true. -
    {matches, infinity|Number}
    With this option, the number of reported -search results can be limited. If the option’s value is set to infinity, -all search results are reported. The default value is 30. -
    {allow_return_all, false|true}
    This option enables -you to specify if search operations with empty input fields should return all -users who added some information to their vCard. The default value is -false. -
    {search_all_hosts, true|false}
    If this option is set -to true, search operations will apply to all virtual hosts. Otherwise -only the current host will be searched. The default value is true. -

    Examples: -

    • -In this first situation, search results are limited to twenty items, -every user who added information to their vCard will be listed when people -do an empty search, and only users from the current host will be returned: -
      {modules,
- [
-  ...
-  {mod_vcard, [{search, true},
-               {matches, 20},
-               {allow_return_all, true},
-               {search_all_hosts, false}]},
-  ...
- ]}.
-
    • The second situation differs in a way that search results are not limited, -and that all virtual hosts will be searched instead of only the current one: -
      {modules,
- [
-  ...
-  {mod_vcard, [{search, true},
-               {matches, infinity},
-               {allow_return_all, true}]},
-  ...
- ]}.
-

    -

    3.3.26  mod_vcard_ldap

    -

    ejabberd can map LDAP attributes to vCard fields. This behaviour is -implemented in the mod_vcard_ldap module. This module does not depend on the -authentication method (see 3.2.5).

    Usually ejabberd treats LDAP as a read-only storage: -it is possible to consult data, but not possible to -create accounts or edit vCard that is stored in LDAP. -However, it is possible to change passwords if mod_register module is enabled -and LDAP server supports -RFC 3062.

    The mod_vcard_ldap module has -its own optional parameters. The first group of parameters has the same -meaning as the top-level LDAP parameters to set the authentication method: -ldap_servers, ldap_port, ldap_rootdn, -ldap_password, ldap_base, ldap_uids, and -ldap_filter. See section 3.2.5 for detailed information -about these options. If one of these options is not set, ejabberd will look -for the top-level option with the same name.

    The second group of parameters -consists of the following mod_vcard_ldap-specific options:

    - -{host, HostName}
    This option defines the Jabber ID of the -service. If the host option is not specified, the Jabber ID will be the -hostname of the virtual host with the prefix ‘vjud.’. The keyword "@HOST@" -is replaced at start time with the real virtual host name. - -
    {iqdisc, Discipline}
    This specifies -the processing discipline for vcard-temp IQ queries (see section 3.3.2). -
    {search, true|false}
    This option specifies whether the search -functionality is enabled (value: true) or disabled (value: -false). If disabled, the option host will be ignored and the -Jabber User Directory service will not appear in the Service Discovery item -list. The default value is true. -
    {matches, infinity|Number}
    With this option, the number of reported -search results can be limited. If the option’s value is set to infinity, -all search results are reported. The default value is 30. -
    {ldap_vcard_map, [ {Name, Pattern, LDAPattributes}, ...]}
    -With this option you can set the table that maps LDAP attributes to vCard fields. - -Name is the type name of the vCard as defined in -RFC 2426. -Pattern is a string which contains pattern variables -"%u", "%d" or "%s". -LDAPattributes is the list containing LDAP attributes. -The pattern variables -"%s" will be sequentially replaced -with the values of LDAP attributes from List_of_LDAP_attributes, -"%u" will be replaced with the user part of a JID, -and "%d" will be replaced with the domain part of a JID. -The default is: -
    [{"NICKNAME", "%u", []},
- {"FN", "%s", ["displayName"]},
- {"LAST", "%s", ["sn"]},
- {"FIRST", "%s", ["givenName"]},
- {"MIDDLE", "%s", ["initials"]},
- {"ORGNAME", "%s", ["o"]},
- {"ORGUNIT", "%s", ["ou"]},
- {"CTRY", "%s", ["c"]},
- {"LOCALITY", "%s", ["l"]},
- {"STREET", "%s", ["street"]},
- {"REGION", "%s", ["st"]},
- {"PCODE", "%s", ["postalCode"]},
- {"TITLE", "%s", ["title"]},
- {"URL", "%s", ["labeleduri"]},
- {"DESC", "%s", ["description"]},
- {"TEL", "%s", ["telephoneNumber"]},
- {"EMAIL", "%s", ["mail"]},
- {"BDAY", "%s", ["birthDay"]},
- {"ROLE", "%s", ["employeeType"]},
- {"PHOTO", "%s", ["jpegPhoto"]}]
-
    {ldap_search_fields, [ {Name, Attribute}, ...]}
    This option -defines the search form and the LDAP attributes to search within. -Name is the name of a search form -field which will be automatically translated by using the translation -files (see msgs/*.msg for available words). Attribute is the -LDAP attribute or the pattern "%u". The default is: -
    [{"User", "%u"},
- {"Full Name", "displayName"},
- {"Given Name", "givenName"},
- {"Middle Name", "initials"},
- {"Family Name", "sn"},
- {"Nickname", "%u"},
- {"Birthday", "birthDay"},
- {"Country", "c"},
- {"City", "l"},
- {"Email", "mail"},
- {"Organization Name", "o"},
- {"Organization Unit", "ou"}]
-
    {ldap_search_reported, [ {SearchField, VcardField}, ...]}
    This option -defines which search fields should be reported. -SearchField is the name of a search form -field which will be automatically translated by using the translation -files (see msgs/*.msg for available words). VcardField is the -vCard field name defined in the ldap_vcard_map option. The default -is: -
    [{"Full Name", "FN"},
- {"Given Name", "FIRST"},
- {"Middle Name", "MIDDLE"},
- {"Family Name", "LAST"},
- {"Nickname", "NICKNAME"},
- {"Birthday", "BDAY"},
- {"Country", "CTRY"},
- {"City", "LOCALITY"},
- {"Email", "EMAIL"},
- {"Organization Name", "ORGNAME"},
- {"Organization Unit", "ORGUNIT"}]
-

    Examples: -

    • -

      Let’s say ldap.example.org is the name of our LDAP server. We have -users with their passwords in "ou=Users,dc=example,dc=org" directory. -Also we have addressbook, which contains users emails and their additional -infos in "ou=AddressBook,dc=example,dc=org" directory. Corresponding -authentication section should looks like this:

      %% authentication method
-{auth_method, ldap}.
-%% DNS name of our LDAP server
-{ldap_servers, ["ldap.example.org"]}.
-%% We want to authorize users from 'shadowAccount' object class only
-{ldap_filter, "(objectClass=shadowAccount)"}.
-

      Now we want to use users LDAP-info as their vCards. We have four attributes -defined in our LDAP schema: "mail" — email address, "givenName" -— first name, "sn" — second name, "birthDay" — birthday. -Also we want users to search each other. Let’s see how we can set it up:

      {modules,
-  ...
-  {mod_vcard_ldap,
-   [
-    %% We use the same server and port, but want to bind anonymously because
-    %% our LDAP server accepts anonymous requests to
-    %% "ou=AddressBook,dc=example,dc=org" subtree.
-    {ldap_rootdn, ""},
-    {ldap_password, ""},
-    %% define the addressbook's base
-    {ldap_base, "ou=AddressBook,dc=example,dc=org"},
-    %% uidattr: user's part of JID is located in the "mail" attribute
-    %% uidattr_format: common format for our emails
-    {ldap_uids, [{"mail","%u@mail.example.org"}]},
-    %% We have to define empty filter here, because entries in addressbook does not
-    %% belong to shadowAccount object class
-    {ldap_filter, ""},
-    %% Now we want to define vCard pattern
-    {ldap_vcard_map,
-     [{"NICKNAME", "%u", []}, % just use user's part of JID as his nickname
-      {"FIRST", "%s", ["givenName"]},
-      {"LAST", "%s", ["sn"]},
-      {"FN", "%s, %s", ["sn", "givenName"]}, % example: "Smith, John"
-      {"EMAIL", "%s", ["mail"]},
-      {"BDAY", "%s", ["birthDay"]}]},
-    %% Search form
-    {ldap_search_fields,
-     [{"User", "%u"},
-      {"Name", "givenName"},
-      {"Family Name", "sn"},
-      {"Email", "mail"},
-      {"Birthday", "birthDay"}]},
-    %% vCard fields to be reported
-    %% Note that JID is always returned with search results
-    {ldap_search_reported,
-     [{"Full Name", "FN"},
-      {"Nickname", "NICKNAME"},
-      {"Birthday", "BDAY"}]}
-  ]}
-  ...
-}.
-

      Note that mod_vcard_ldap module checks an existence of the user before -searching his info in LDAP.

    • ldap_vcard_map example: -
      {ldap_vcard_map,
- [{"NICKNAME", "%u", []},
-  {"FN", "%s", ["displayName"]},
-  {"CTRY", "Russia", []},
-  {"EMAIL", "%u@%d", []},
-  {"DESC", "%s\n%s", ["title", "description"]}
- ]},
-
    • ldap_search_fields example: -
      {ldap_search_fields,
- [{"User", "uid"},
-  {"Full Name", "displayName"},
-  {"Email", "mail"}
- ]},
-
    • ldap_search_reported example: -
      {ldap_search_reported,
- [{"Full Name", "FN"},
-  {"Email", "EMAIL"},
-  {"Birthday", "BDAY"},
-  {"Nickname", "NICKNAME"}
- ]},
-

    -

    3.3.27  mod_vcard_xupdate

    -

    The user’s client can store an avatar in the user vCard. -The vCard-Based Avatars protocol (XEP-0153) -provides a method for clients to inform the contacts what is the avatar hash value. -However, simple or small clients may not implement that protocol.

    If this module is enabled, all the outgoing client presence stanzas get automatically -the avatar hash on behalf of the client. -So, the contacts receive the presence stanzas with the Update Data described -in XEP-0153 as if the client would had inserted it itself. -If the client had already included such element in the presence stanza, -it is replaced with the element generated by ejabberd.

    By enabling this module, each vCard modification produces a hash recalculation, -and each presence sent by a client produces hash retrieval and a -presence stanza rewrite. -For this reason, enabling this module will introduce a computational overhead -in servers with clients that change frequently their presence.

    -

    3.3.28  mod_version

    -

    This module implements Software Version (XEP-0092). Consequently, it -answers ejabberd’s version when queried.

    Options: -

    -{show_os, true|false}
    Should the operating system be revealed or not. -The default value is true. -
    {iqdisc, Discipline}
    This specifies -the processing discipline for Software Version (jabber:iq:version) IQ queries (see section 3.3.2). -

    -

    Chapter 4  Managing an ejabberd Server

    -

    4.1  ejabberdctl

    With the ejabberdctl command line administration script -you can execute ejabberdctl commands (described in the next section, 4.1.1) -and also many general ejabberd commands (described in section 4.2). -This means you can start, stop and perform many other administrative tasks -in a local or remote ejabberd server (by providing the argument --node NODENAME).

    The ejabberdctl script can be configured in the file ejabberdctl.cfg. -This file includes detailed information about each configurable option. See section 4.1.2.

    The ejabberdctl script returns a numerical status code. -Success is represented by 0, -error is represented by 1, -and other codes may be used for specific results. -This can be used by other scripts to determine automatically -if a command succeeded or failed, -for example using: echo $?

    -

    4.1.1  ejabberdctl Commands

    When ejabberdctl is executed without any parameter, -it displays the available options. If there isn’t an ejabberd server running, -the available parameters are: -

    -start
    Start ejabberd in background mode. This is the default method. -
    debug
    Attach an Erlang shell to an already existing ejabberd server. This allows to execute commands interactively in the ejabberd server. -
    live
    Start ejabberd in live mode: the shell keeps attached to the started server, showing log messages and allowing to execute interactive commands. -

    If there is an ejabberd server running in the system, -ejabberdctl shows the ejabberdctl commands described bellow -and all the ejabberd commands available in that server (see 4.2.1).

    The ejabberdctl commands are: -

    -help
    Get help about ejabberdctl or any available command. Try ejabberdctl help help. -
    status
    Check the status of the ejabberd server. -
    stop
    Stop the ejabberd server. -
    restart
    Restart the ejabberd server. -
    mnesia
    Get information about the Mnesia database. -

    The ejabberdctl script can be restricted to require authentication -and execute some ejabberd commands; see 4.2.2. -Add the option to the file ejabberd.cfg. -In this example there is no restriction: -

    {ejabberdctl_access_commands, []}.
-

    If account robot1@example.org is registered in ejabberd with password abcdef -(which MD5 is E8B501798950FC58AAD83C8C14978E), -and ejabberd.cfg contains this setting: -

    {hosts, ["example.org"]}.
-{acl, bots, {user, "robot1", "example.org"}}.
-{access, ctlaccess, [{allow, bots}]}.
-{ejabberdctl_access_commands, [ {ctlaccess, [registered_users, register], []} ]}.
-

    then you can do this in the shell: -

    $ ejabberdctl registered_users example.org
-Error: no_auth_provided
-$ ejabberdctl --auth robot1 example.org E8B501798950FC58AAD83C8C14978E registered_users example.org
-robot1
-testuser1
-testuser2
-

    -

    4.1.2  Erlang Runtime System

    ejabberd is an Erlang/OTP application that runs inside an Erlang runtime system. -This system is configured using environment variables and command line parameters. -The ejabberdctl administration script uses many of those possibilities. -You can configure some of them with the file ejabberdctl.cfg, -which includes detailed description about them. -This section describes for reference purposes -all the environment variables and command line parameters.

    The environment variables: -

    -EJABBERD_CONFIG_PATH
    - Path to the ejabberd configuration file. -
    EJABBERD_MSGS_PATH
    - Path to the directory with translated strings. -
    EJABBERD_LOG_PATH
    - Path to the ejabberd service log file. -
    EJABBERD_SO_PATH
    - Path to the directory with binary system libraries. -
    EJABBERD_DOC_PATH
    - Path to the directory with ejabberd documentation. -
    EJABBERD_PID_PATH
    - Path to the PID file that ejabberd can create when started. -
    HOME
    - Path to the directory that is considered ejabberd’s home. - This path is used to read the file .erlang.cookie. -
    ERL_CRASH_DUMP
    - Path to the file where crash reports will be dumped. -
    ERL_INETRC
    - Indicates which IP name resolution to use. - If using -sname, specify either this option or -kernel inetrc filepath. -
    ERL_MAX_PORTS
    - Maximum number of simultaneously open Erlang ports. -
    ERL_MAX_ETS_TABLES
    - Maximum number of ETS and Mnesia tables. -

    The command line parameters: -

    --sname ejabberd
    - The Erlang node will be identified using only the first part - of the host name, i. e. other Erlang nodes outside this domain cannot contact - this node. This is the preferable option in most cases. -
    -name ejabberd
    - The Erlang node will be fully identified. -This is only useful if you plan to setup an ejabberd cluster with nodes in different networks. -
    -kernel inetrc ’"/etc/ejabberd/inetrc"’
    - Indicates which IP name resolution to use. - If using -sname, specify either this option or ERL_INETRC. -
    -kernel inet_dist_listen_min 4200 inet_dist_listen_min 4210
    - Define the first and last ports that epmd (section 5.2) can listen to. -
    -detached
    -Starts the Erlang system detached from the system console. - Useful for running daemons and backgrounds processes. -
    -noinput
    - Ensures that the Erlang system never tries to read any input. - Useful for running daemons and backgrounds processes. -
    -pa /var/lib/ejabberd/ebin
    - Specify the directory where Erlang binary files (*.beam) are located. -
    -s ejabberd
    - Tell Erlang runtime system to start the ejabberd application. -
    -mnesia dir ’"/var/lib/ejabberd/"’
    - Specify the Mnesia database directory. -
    -sasl sasl_error_logger {file, "/var/log/ejabberd/erlang.log"}
    - Path to the Erlang/OTP system log file. -SASL here means “System Architecture Support Libraries” -not “Simple Authentication and Security Layer”. -
    +K [true|false]
    - Kernel polling. -
    -smp [auto|enable|disable]
    - SMP support. -
    +P 250000
    - Maximum number of Erlang processes. -
    -remsh ejabberd@localhost
    - Open an Erlang shell in a remote Erlang node. -
    -hidden
    - The connections to other nodes are hidden (not published). - The result is that this node is not considered part of the cluster. - This is important when starting a temporary ctl or debug node. -

    -Note that some characters need to be escaped when used in shell scripts, for instance " and {}. -You can find other options in the Erlang manual page (erl -man erl).

    -

    4.2  ejabberd Commands

    An ejabberd command is an abstract function identified by a name, -with a defined number and type of calling arguments and type of result -that is registered in the ejabberd_commands service. -Those commands can be defined in any Erlang module and executed using any valid frontend.

    ejabberd includes a frontend to execute ejabberd commands: the script ejabberdctl. -Other known frontends that can be installed to execute ejabberd commands in different ways are: -ejabberd_xmlrpc (XML-RPC service), -mod_rest (HTTP POST service), -mod_shcommands (ejabberd WebAdmin page).

    -

    4.2.1  List of ejabberd Commands

    ejabberd includes a few ejabberd Commands by default. -When more modules are installed, new commands may be available in the frontends.

    The easiest way to get a list of the available commands, and get help for them is to use -the ejabberdctl script: -

    $ ejabberdctl help
-Usage: ejabberdctl [--node nodename] [--auth user host password] command [options]
-
-Available commands in this ejabberd node:
-  backup file                  Store the database to backup file
-  connected_users              List all established sessions
-  connected_users_number       Get the number of established sessions
-  ...
-

    The most interesting ones are: -

    -reopen_log
    Reopen the log files after they were renamed. -If the old files were not renamed before calling this command, -they are automatically renamed to "*-old.log". See section 7.1. -
    backup ejabberd.backup
    -Store internal Mnesia database to a binary backup file. -
    restore ejabberd.backup
    -Restore immediately from a binary backup file the internal Mnesia database. -This will consume a lot of memory if you have a large database, -so better use install_fallback. -
    install_fallback ejabberd.backup
    -The binary backup file is installed as fallback: -it will be used to restore the database at the next ejabberd start. -This means that, after running this command, you have to restart ejabberd. -This command requires less memory than restore. -
    dump ejabberd.dump
    -Dump internal Mnesia database to a text file dump. -
    load ejabberd.dump
    -Restore immediately from a text file dump. -This is not recommended for big databases, as it will consume much time, -memory and processor. In that case it’s preferable to use backup and install_fallback. -
    import_piefxis, export_piefxis, export_piefxis_host
    -These options can be used to migrate accounts -using XEP-0227 formatted XML files -from/to other Jabber/XMPP servers -or move users of a vhost to another ejabberd installation. -See also ejabberd migration kit. -
    import_file, import_dir
    -These options can be used to migrate accounts -using jabberd1.4 formatted XML files. -from other Jabber/XMPP servers -There exist tutorials to -migrate from other software to ejabberd. -
    delete_expired_messages
    This option can be used to delete old messages -in offline storage. This might be useful when the number of offline messages -is very high. -
    delete_old_messages days
    Delete offline messages older than the given days. -
    register user host password
    Register an account in that domain with the given password. -
    unregister user host
    Unregister the given account. -

    -

    4.2.2  Restrict Execution with AccessCommands

    The frontends can be configured to restrict access to certain commands. -In that case, authentication information must be provided. -In each frontend the AccessCommands option is defined -in a different place. But in all cases the option syntax is the same: -

    AccessCommands = [ {Access, CommandNames, Arguments}, ...]
-Access = atom()
-CommandNames = all | [CommandName]
-CommandName = atom()
-Arguments = [ {ArgumentName, ArgumentValue}, ...]
-ArgumentName = atom()
-ArgumentValue = any()
-

    The default value is to not define any restriction: []. -The authentication information is provided when executing a command, -and is Username, Hostname and Password of a local XMPP account -that has permission to execute the corresponding command. -This means that the account must be registered in the local ejabberd, -because the information will be verified. -It is possible to provide the plaintext password or its MD5 sum.

    When one or several access restrictions are defined and the -authentication information is provided, -each restriction is verified until one matches completely: -the account matches the Access rule, -the command name is listed in CommandNames, -and the provided arguments do not contradict Arguments.

    As an example to understand the syntax, let’s suppose those options: -

    {hosts, ["example.org"]}.
-{acl, bots, {user, "robot1", "example.org"}}.
-{access, commaccess, [{allow, bots}]}.
-

    This list of access restrictions allows only robot1@example.org to execute all commands: -

    [{commaccess, all, []}]
-

    See another list of restrictions (the corresponding ACL and ACCESS are not shown): -

    [
- %% This bot can execute all commands:
- {bot, all, []},
- %% This bot can only execute the command 'dump'. No argument restriction:
- {bot_backups, [dump], []}
- %% This bot can execute all commands,
- %% but if a 'host' argument is provided, it must be "example.org":
- {bot_all_example, all, [{host, "example.org"}]},
- %% This bot can only execute the command 'register',
- %% and if argument 'host' is provided, it must be "example.org":
- {bot_reg_example, [register], [{host, "example.org"}]},
- %% This bot can execute the commands 'register' and 'unregister',
- %% if argument host is provided, it must be "test.org":
- {_bot_reg_test, [register, unregister], [{host, "test.org"}]}
-]
-

    -

    4.3  Web Admin

    -

    The ejabberd Web Admin allows to administer most of ejabberd using a web browser.

    This feature is enabled by default: -a ejabberd_http listener with the option web_admin (see -section 3.1.3) is included in the listening ports. Then you can open -http://server:port/admin/ in your favourite web browser. You -will be asked to enter the username (the full Jabber ID) and password -of an ejabberd user with administrator rights. After authentication -you will see a page similar to figure 4.1.

    - -webadmmain.png - - -
    -
    Figure 4.1: Top page from the Web Admin
    - -

    -Here you can edit access restrictions, manage users, create backups, -manage the database, enable/disable ports listened for, view server -statistics,…

    The access rule configure determines what accounts can access the Web Admin and modify it. -The access rule webadmin_view is to grant only view access: those accounts can browse the Web Admin with read-only access.

    Example configurations: -

    • -You can serve the Web Admin on the same port as the -HTTP Polling interface. In this example -you should point your web browser to http://example.org:5280/admin/ to -administer all virtual hosts or to -http://example.org:5280/admin/server/example.com/ to administer only -the virtual host example.com. Before you get access to the Web Admin -you need to enter as username, the JID and password from a registered user -that is allowed to configure ejabberd. In this example you can enter as -username ‘admin@example.net’ to administer all virtual hosts (first -URL). If you log in with ‘admin@example.com’ on
      - http://example.org:5280/admin/server/example.com/ you can only -administer the virtual host example.com. -The account ‘reviewer@example.com’ can browse that vhost in read-only mode. -
      {acl, admins, {user, "admin", "example.net"}}.
-{host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}.
-{host_config, "example.com", [{acl, viewers, {user, "reviewer", "example.com"}}]}.
-
-{access, configure, [{allow, admins}]}.
-{access, webadmin_view, [{allow, viewers}]}.
-
-{hosts, ["example.org"]}.
-
-{listen,
- [
-  ...
-  {5280, ejabberd_http, [http_poll, web_admin]},
-  ...
- ]}.
-
    • For security reasons, you can serve the Web Admin on a secured -connection, on a port differing from the HTTP Polling interface, and bind it -to the internal LAN IP. The Web Admin will be accessible by pointing your -web browser to https://192.168.1.1:5282/admin/: -
      -{hosts, ["example.org"]}.
-
-{listen,
- [
-  ...
-  {5280, ejabberd_http, [
-                         http_poll
-                        ]},
-  {{5282, "192.168.1.1"}, ejabberd_http, [
-                                          web_admin,
-                                          tls, {certfile, "/usr/local/etc/server.pem"}
-                                         ]},
-  ...
- ]}.
-

    Certain pages in the ejabberd Web Admin contain a link to a related -section in the ejabberd Installation and Operation Guide. -In order to view such links, a copy in HTML format of the Guide must -be installed in the system. -The file is searched by default in -"/share/doc/ejabberd/guide.html". -The directory of the documentation can be specified in -the environment variable EJABBERD_DOC_PATH. -See section 4.1.2.

    -

    4.4  Ad-hoc Commands

    If you enable mod_configure and mod_adhoc, -you can perform several administrative tasks in ejabberd -with a XMPP client. -The client must support Ad-Hoc Commands (XEP-0050), -and you must login in the XMPP server with -an account with proper privileges.

    -

    4.5  Change Computer Hostname

    ejabberd uses the distributed Mnesia database. -Being distributed, Mnesia enforces consistency of its file, -so it stores the name of the Erlang node in it (see section 5.4). -The name of an Erlang node includes the hostname of the computer. -So, the name of the Erlang node changes -if you change the name of the machine in which ejabberd runs, -or when you move ejabberd to a different machine.

    You have two ways to use the old Mnesia database in an ejabberd with new node name: -put the old node name in ejabberdctl.cfg, -or convert the database to the new node name.

    Those example steps will backup, convert and load the Mnesia database. -You need to have either the old Mnesia spool dir or a backup of Mnesia. -If you already have a backup file of the old database, you can go directly to step 5. -You also need to know the old node name and the new node name. -If you don’t know them, look for them by executing ejabberdctl -or in the ejabberd log files.

    Before starting, setup some variables: -

    OLDNODE=ejabberd@oldmachine
-NEWNODE=ejabberd@newmachine
-OLDFILE=/tmp/old.backup
-NEWFILE=/tmp/new.backup
-
    1. -Start ejabberd enforcing the old node name: -
      ejabberdctl --node $OLDNODE start
-
    2. Generate a backup file: -
      ejabberdctl --node $OLDNODE backup $OLDFILE
-
    3. Stop the old node: -
      ejabberdctl --node $OLDNODE stop
-
    4. Make sure there aren’t files in the Mnesia spool dir. For example: -
      mkdir /var/lib/ejabberd/oldfiles
-mv /var/lib/ejabberd/*.* /var/lib/ejabberd/oldfiles/
-
    5. Start ejabberd. There isn’t any need to specify the node name anymore: -
      ejabberdctl start
-
    6. Convert the backup to new node name: -
      ejabberdctl mnesia_change_nodename $OLDNODE $NEWNODE $OLDFILE $NEWFILE
-
    7. Install the backup file as a fallback: -
      ejabberdctl install_fallback $NEWFILE
-
    8. Stop ejabberd: -
      ejabberdctl stop
-
      You may see an error message in the log files, it’s normal, so don’t worry: -
      Mnesia(ejabberd@newmachine):
-** ERROR ** (ignoring core)
-** FATAL ** A fallback is installed and Mnesia must be restarted.
-  Forcing shutdown after mnesia_down from ejabberd@newmachine...
-
    9. Now you can finally start ejabberd: -
      ejabberdctl start
-
    10. Check that the information of the old database is available: accounts, rosters... -After you finish, remember to delete the temporary backup files from public directories. -

    -

    Chapter 5  Securing ejabberd

    -

    5.1  Firewall Settings

    -

    You need to take the following TCP ports in mind when configuring your firewall: -

    - - - - - - -
    PortDescription
    5222Standard port for Jabber/XMPP client connections, plain or STARTTLS.
    5223Standard port for Jabber client connections using the old SSL method.
    5269Standard port for Jabber/XMPP server connections.
    4369EPMD (section 5.2) listens for Erlang node name requests.
    port rangeUsed for connections between Erlang nodes. This range is configurable (see section 5.2).
    -

    -

    5.2  epmd

    epmd (Erlang Port Mapper Daemon) -is a small name server included in Erlang/OTP -and used by Erlang programs when establishing distributed Erlang communications. -ejabberd needs epmd to use ejabberdctl and also when clustering ejabberd nodes. -This small program is automatically started by Erlang, and is never stopped. -If ejabberd is stopped, and there aren’t any other Erlang programs -running in the system, you can safely stop epmd if you want.

    ejabberd runs inside an Erlang node. -To communicate with ejabberd, the script ejabberdctl starts a new Erlang node -and connects to the Erlang node that holds ejabberd. -In order for this communication to work, -epmd must be running and listening for name requests in the port 4369. -You should block the port 4369 in the firewall in such a way that -only the programs in your machine can access it.

    If you build a cluster of several ejabberd instances, -each ejabberd instance is called an ejabberd node. -Those ejabberd nodes use a special Erlang communication method to -build the cluster, and EPMD is again needed listening in the port 4369. -So, if you plan to build a cluster of ejabberd nodes -you must open the port 4369 for the machines involved in the cluster. -Remember to block the port so Internet doesn’t have access to it.

    Once an Erlang node solved the node name of another Erlang node using EPMD and port 4369, -the nodes communicate directly. -The ports used in this case by default are random, -but can be configured in the file ejabberdctl.cfg. -The Erlang command-line parameter used internally is, for example: -

    erl ... -kernel inet_dist_listen_min 4370 inet_dist_listen_max 4375
-

    -

    5.3  Erlang Cookie

    The Erlang cookie is a string with numbers and letters. -An Erlang node reads the cookie at startup from the command-line parameter -setcookie. -If not indicated, the cookie is read from the cookie file $HOME/.erlang.cookie. -If this file does not exist, it is created immediately with a random cookie. -Two Erlang nodes communicate only if they have the same cookie. -Setting a cookie on the Erlang node allows you to structure your Erlang network -and define which nodes are allowed to connect to which.

    Thanks to Erlang cookies, you can prevent access to the Erlang node by mistake, -for example when there are several Erlang nodes running different programs in the same machine.

    Setting a secret cookie is a simple method -to difficult unauthorized access to your Erlang node. -However, the cookie system is not ultimately effective -to prevent unauthorized access or intrusion to an Erlang node. -The communication between Erlang nodes are not encrypted, -so the cookie could be read sniffing the traffic on the network. -The recommended way to secure the Erlang node is to block the port 4369.

    -

    5.4  Erlang Node Name

    An Erlang node may have a node name. -The name can be short (if indicated with the command-line parameter -sname) -or long (if indicated with the parameter -name). -Starting an Erlang node with -sname limits the communication between Erlang nodes to the LAN.

    Using the option -sname instead of -name is a simple method -to difficult unauthorized access to your Erlang node. -However, it is not ultimately effective to prevent access to the Erlang node, -because it may be possible to fake the fact that you are on another network -using a modified version of Erlang epmd. -The recommended way to secure the Erlang node is to block the port 4369.

    -

    5.5  Securing Sensitive Files

    ejabberd stores sensitive data in the file system either in plain text or binary files. -The file system permissions should be set to only allow the proper user to read, -write and execute those files and directories.

    -ejabberd configuration file: /etc/ejabberd/ejabberd.cfg
    -Contains the JID of administrators -and passwords of external components. -The backup files probably contain also this information, -so it is preferable to secure the whole /etc/ejabberd/ directory. -
    ejabberd service log: /var/log/ejabberd/ejabberd.log
    -Contains IP addresses of clients. -If the loglevel is set to 5, it contains whole conversations and passwords. -If a logrotate system is used, there may be several log files with similar information, -so it is preferable to secure the whole /var/log/ejabberd/ directory. -
    Mnesia database spool files in /var/lib/ejabberd/
    -The files store binary data, but some parts are still readable. -The files are generated by Mnesia and their permissions cannot be set directly, -so it is preferable to secure the whole /var/lib/ejabberd/ directory. -
    Erlang cookie file: /var/lib/ejabberd/.erlang.cookie
    -See section 5.3. -

    -

    Chapter 6  Clustering

    -

    -

    6.1  How it Works

    -

    A XMPP domain is served by one or more ejabberd nodes. These nodes can -be run on different machines that are connected via a network. They all -must have the ability to connect to port 4369 of all another nodes, and must -have the same magic cookie (see Erlang/OTP documentation, in other words the -file ~ejabberd/.erlang.cookie must be the same on all nodes). This is -needed because all nodes exchange information about connected users, s2s -connections, registered services, etc…

    Each ejabberd node has the following modules: -

    • -router, -
    • local router, -
    • session manager, -
    • s2s manager. -

    -

    6.1.1  Router

    -

    This module is the main router of XMPP packets on each node. It -routes them based on their destination’s domains. It uses a global -routing table. The domain of the packet’s destination is searched in the -routing table, and if it is found, the packet is routed to the -appropriate process. If not, it is sent to the s2s manager.

    -

    6.1.2  Local Router

    -

    This module routes packets which have a destination domain equal to -one of this server’s host names. If the destination JID has a non-empty user -part, it is routed to the session manager, otherwise it is processed depending -on its content.

    -

    6.1.3  Session Manager

    -

    This module routes packets to local users. It looks up to which user -resource a packet must be sent via a presence table. Then the packet is -either routed to the appropriate c2s process, or stored in offline -storage, or bounced back.

    -

    6.1.4  s2s Manager

    -

    This module routes packets to other XMPP servers. First, it -checks if an opened s2s connection from the domain of the packet’s -source to the domain of the packet’s destination exists. If that is the case, -the s2s manager routes the packet to the process -serving this connection, otherwise a new connection is opened.

    -

    6.2  Clustering Setup

    -

    Suppose you already configured ejabberd on one machine named (first), -and you need to setup another one to make an ejabberd cluster. Then do -following steps:

    1. -Copy ~ejabberd/.erlang.cookie file from first to -second.

      (alt) You can also add ‘-setcookie content_of_.erlang.cookie’ -option to all ‘erl’ commands below.

    2. On second run the following command as the ejabberd daemon user, -in the working directory of ejabberd:
      erl -sname ejabberd \
-    -mnesia dir '"/var/lib/ejabberd/"' \
-    -mnesia extra_db_nodes "['ejabberd@first']" \
-    -s mnesia
-

      This will start Mnesia serving the same database as ejabberd@first. -You can check this by running the command ‘mnesia:info().’. You -should see a lot of remote tables and a line like the following:

      Note: the Mnesia directory may be different in your system. -To know where does ejabberd expect Mnesia to be installed by default, -call 4.1 without options and it will show some help, -including the Mnesia database spool dir.

      running db nodes   = [ejabberd@first, ejabberd@second]
-
    3. Now run the following in the same ‘erl’ session:
      mnesia:change_table_copy_type(schema, node(), disc_copies).
-

      This will create local disc storage for the database.

      (alt) Change storage type of the scheme table to ‘RAM and disc -copy’ on the second node via the Web Admin.

    4. Now you can add replicas of various tables to this node with -‘mnesia:add_table_copy’ or -‘mnesia:change_table_copy_type’ as above (just replace -‘schema’ with another table name and ‘disc_copies’ -can be replaced with ‘ram_copies’ or -‘disc_only_copies’).

      Which tables to replicate is very dependant on your needs, you can get -some hints from the command ‘mnesia:info().’, by looking at the -size of tables and the default storage type for each table on ’first’.

      Replicating a table makes lookups in this table faster on this node. -Writing, on the other hand, will be slower. And of course if machine with one -of the replicas is down, other replicas will be used.

      Also section 5.3 (Table Fragmentation) of Mnesia User’s Guide can be helpful. -

      (alt) Same as in previous item, but for other tables.

    5. Run ‘init:stop().’ or just ‘q().’ to exit from -the Erlang shell. This probably can take some time if Mnesia has not yet -transfered and processed all data it needed from first.
    6. Now run ejabberd on second with a configuration similar as -on first: you probably do not need to duplicate ‘acl’ -and ‘access’ options because they will be taken from -first. If you installed mod_irc, notice that it should be -enabled only on one machine in the cluster. -

    You can repeat these steps for other machines supposed to serve this -domain.

    -

    6.3  Service Load-Balancing

    -

    -

    6.3.1  Components Load-Balancing

    -

    6.3.2  Domain Load-Balancing Algorithm

    -

    ejabberd includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.

    The default distribution algorithm try to deliver to a local instance of a component. If several local instances are available, one instance is chosen randomly. If no instance is available locally, one instance is chosen randomly among the remote component instances.

    If you need a different behaviour, you can change the load balancing behaviour with the option domain_balancing. The syntax of the option is the following: -

    {domain_balancing, "component.example.com", BalancingCriteria}.

    Several balancing criteria are available: -

    • -destination: the full JID of the packet to attribute is used. -
    • source: the full JID of the packet from attribute is used. -
    • bare_destination: the bare JID (without resource) of the packet to attribute is used. -
    • bare_source: the bare JID (without resource) of the packet from attribute is used. -

    If the value corresponding to the criteria is the same, the same component instance in the cluster will be used.

    -

    6.3.3  Load-Balancing Buckets

    -

    When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failing the service will not work correctly unless the sessions are rebalanced.

    In this case, it is best to limit the problem to the sessions handled by the failing component. This is what the domain_balancing_component_number option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.

    The syntax is: -

    {domain_balancing_component_number, "component.example.com", Number}.

    -

    Chapter 7  Debugging

    -

    -

    7.1  Log Files

    An ejabberd node writes two log files: -

    - ejabberd.log
    is the ejabberd service log, with the messages reported by ejabberd code -
    erlang.log
    is the Erlang/OTP system log, with the messages reported by Erlang/OTP using SASL (System Architecture Support Libraries) -

    The option loglevel modifies the verbosity of the file ejabberd.log. The syntax is: -

    {loglevel, Level}.

    The possible Level are: -

    - 0
    No ejabberd log at all (not recommended) -
    1
    Critical -
    2
    Error -
    3
    Warning -
    4
    Info -
    5
    Debug -

    -For example, the default configuration is: -

    {loglevel, 4}.
-

    The log files grow continually, so it is recommended to rotate them periodically. -To rotate the log files, rename the files and then reopen them. -The ejabberdctl command reopen-log -(please refer to section 4.1.1) -reopens the log files, -and also renames the old ones if you didn’t rename them.

    -

    7.2  Debug Console

    The Debug Console is an Erlang shell attached to an already running ejabberd server. -With this Erlang shell, an experienced administrator can perform complex tasks.

    This shell gives complete control over the ejabberd server, -so it is important to use it with extremely care. -There are some simple and safe examples in the article -Interconnecting Erlang Nodes

    To exit the shell, close the window or press the keys: control+c control+c.

    -

    7.3  Watchdog Alerts

    -

    ejabberd includes a watchdog mechanism that may be useful to developers -when troubleshooting a problem related to memory usage. -If a process in the ejabberd server consumes more memory than the configured threshold, -a message is sent to the XMPP accounts defined with the option -watchdog_admins - in the ejabberd configuration file.

    The syntax is: -

    {watchdog_admins, [JID, ...]}.

    The memory consumed is measured in words: -a word on 32-bit architecture is 4 bytes, -and a word on 64-bit architecture is 8 bytes. -The threshold by default is 1000000 words. -This value can be configured with the option watchdog_large_heap, -or in a conversation with the watchdog alert bot.

    The syntax is: -

    {watchdog_large_heap, Number}.

    Example configuration: -

    {watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
-{watchdog_large_heap, 30000000}.
-

    To remove watchdog admins, remove them in the option. -To remove all watchdog admins, set the option with an empty list: -

    {watchdog_admins, []}.
-

    -

    Appendix A  Internationalization and Localization

    -

    The source code of ejabberd supports localization. -The translators can edit the -gettext .po files -using any capable program (KBabel, Lokalize, Poedit...) or a simple text editor.

    Then gettext -is used to extract, update and export those .po files to the .msg format read by ejabberd. -To perform those management tasks, in the src/ directory execute make translations. -The translatable strings are extracted from source code to generate the file ejabberd.pot. -This file is merged with each .po file to produce updated .po files. -Finally those .po files are exported to .msg files, that have a format easily readable by ejabberd.

    All built-in modules support the xml:lang attribute inside IQ queries. -Figure A.1, for example, shows the reply to the following query: -

    <iq id='5'
-    to='example.org'
-    type='get'
-    xml:lang='ru'>
-  <query xmlns='http://jabber.org/protocol/disco#items'/>
-</iq>
-
    - -discorus.png - - -
    -
    Figure A.1: Service Discovery when xml:lang=’ru’
    - -

    The Web Admin also supports the Accept-Language HTTP header.

    - -webadmmainru.png - - -
    -
    Figure A.2: Web Admin showing a virtual host when the web browser provides the -HTTP header ‘Accept-Language: ru’
    - -

    -

    Appendix B  Release Notes

    -

    Release notes are available from ejabberd Home Page

    -

    Appendix C  Acknowledgements

    Thanks to all people who contributed to this guide: -

    -

    Appendix D  Copyright Information

    Ejabberd Installation and Operation Guide.
    -Copyright © 2003 — 2010 ProcessOne

    This document 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 document 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 document; if not, write to the Free Software Foundation, Inc., 51 Franklin -Street, Fifth Floor, Boston, MA 02110-1301, USA.

    - - - -
    This document was translated from LATEX by -HEVEA.
    - diff --git a/doc/version.tex b/doc/version.tex deleted file mode 100644 index 42cf7d828..000000000 --- a/doc/version.tex +++ /dev/null @@ -1,2 +0,0 @@ -% ejabberd version (automatically generated). -\newcommand{\version}{3.0.0-alpha-x} diff --git a/src/configure b/src/configure deleted file mode 100755 index a71534543..000000000 --- a/src/configure +++ /dev/null @@ -1,5977 +0,0 @@ -#! /bin/sh -# Guess values for system-dependent variables and create Makefiles. -# Generated by GNU Autoconf 2.65 for ejabberd 3.0.0-alpha-x. -# -# Report bugs to . -# -# -# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, -# 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, -# Inc. -# -# -# This configure script is free software; the Free Software Foundation -# gives unlimited permission to copy, distribute and modify it. -## -------------------- ## -## M4sh Initialization. ## -## -------------------- ## - -# Be more Bourne compatible -DUALCASE=1; export DUALCASE # for MKS sh -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then : - emulate sh - NULLCMD=: - # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in #( - *posix*) : - set -o posix ;; #( - *) : - ;; -esac -fi - - -as_nl=' -' -export as_nl -# Printing a long string crashes Solaris 7 /usr/bin/printf. -as_echo='\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\' -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo$as_echo -# Prefer a ksh shell builtin over an external printf program on Solaris, -# but without wasting forks for bash or zsh. -if test -z "$BASH_VERSION$ZSH_VERSION" \ - && (test "X`print -r -- $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='print -r --' - as_echo_n='print -rn --' -elif (test "X`printf %s $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='printf %s\n' - as_echo_n='printf %s' -else - if test "X`(/usr/ucb/echo -n -n $as_echo) 2>/dev/null`" = "X-n $as_echo"; then - as_echo_body='eval /usr/ucb/echo -n "$1$as_nl"' - as_echo_n='/usr/ucb/echo -n' - else - as_echo_body='eval expr "X$1" : "X\\(.*\\)"' - as_echo_n_body='eval - arg=$1; - case $arg in #( - *"$as_nl"*) - expr "X$arg" : "X\\(.*\\)$as_nl"; - arg=`expr "X$arg" : ".*$as_nl\\(.*\\)"`;; - esac; - expr "X$arg" : "X\\(.*\\)" | tr -d "$as_nl" - ' - export as_echo_n_body - as_echo_n='sh -c $as_echo_n_body as_echo' - fi - export as_echo_body - as_echo='sh -c $as_echo_body as_echo' -fi - -# The user is always right. -if test "${PATH_SEPARATOR+set}" != set; then - PATH_SEPARATOR=: - (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { - (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || - PATH_SEPARATOR=';' - } -fi - - -# IFS -# We need space, tab and new line, in precisely that order. Quoting is -# there to prevent editors from complaining about space-tab. -# (If _AS_PATH_WALK were called with IFS unset, it would disable word -# splitting by setting IFS to empty value.) -IFS=" "" $as_nl" - -# Find who we are. Look in the path if we contain no directory separator. -case $0 in #(( - *[\\/]* ) as_myself=$0 ;; - *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break - done -IFS=$as_save_IFS - - ;; -esac -# We did not find ourselves, most probably we were run as `sh COMMAND' -# in which case we are not to be found in the path. -if test "x$as_myself" = x; then - as_myself=$0 -fi -if test ! -f "$as_myself"; then - $as_echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 - exit 1 -fi - -# Unset variables that we do not need and which cause bugs (e.g. in -# pre-3.0 UWIN ksh). But do not cause bugs in bash 2.01; the "|| exit 1" -# suppresses any "Segmentation fault" message there. '((' could -# trigger a bug in pdksh 5.2.14. -for as_var in BASH_ENV ENV MAIL MAILPATH -do eval test x\${$as_var+set} = xset \ - && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : -done -PS1='$ ' -PS2='> ' -PS4='+ ' - -# NLS nuisances. -LC_ALL=C -export LC_ALL -LANGUAGE=C -export LANGUAGE - -# CDPATH. -(unset CDPATH) >/dev/null 2>&1 && unset CDPATH - -if test "x$CONFIG_SHELL" = x; then - as_bourne_compatible="if test -n \"\${ZSH_VERSION+set}\" && (emulate sh) >/dev/null 2>&1; then : - emulate sh - NULLCMD=: - # Pre-4.2 versions of Zsh do word splitting on \${1+\"\$@\"}, which - # is contrary to our usage. Disable this feature. - alias -g '\${1+\"\$@\"}'='\"\$@\"' - setopt NO_GLOB_SUBST -else - case \`(set -o) 2>/dev/null\` in #( - *posix*) : - set -o posix ;; #( - *) : - ;; -esac -fi -" - as_required="as_fn_return () { (exit \$1); } -as_fn_success () { as_fn_return 0; } -as_fn_failure () { as_fn_return 1; } -as_fn_ret_success () { return 0; } -as_fn_ret_failure () { return 1; } - -exitcode=0 -as_fn_success || { exitcode=1; echo as_fn_success failed.; } -as_fn_failure && { exitcode=1; echo as_fn_failure succeeded.; } -as_fn_ret_success || { exitcode=1; echo as_fn_ret_success failed.; } -as_fn_ret_failure && { exitcode=1; echo as_fn_ret_failure succeeded.; } -if ( set x; as_fn_ret_success y && test x = \"\$1\" ); then : - -else - exitcode=1; echo positional parameters were not saved. -fi -test x\$exitcode = x0 || exit 1" - as_suggested=" as_lineno_1=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_1a=\$LINENO - as_lineno_2=";as_suggested=$as_suggested$LINENO;as_suggested=$as_suggested" as_lineno_2a=\$LINENO - eval 'test \"x\$as_lineno_1'\$as_run'\" != \"x\$as_lineno_2'\$as_run'\" && - test \"x\`expr \$as_lineno_1'\$as_run' + 1\`\" = \"x\$as_lineno_2'\$as_run'\"' || exit 1 -test \$(( 1 + 1 )) = 2 || exit 1" - if (eval "$as_required") 2>/dev/null; then : - as_have_required=yes -else - as_have_required=no -fi - if test x$as_have_required = xyes && (eval "$as_suggested") 2>/dev/null; then : - -else - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_found=false -for as_dir in /bin$PATH_SEPARATOR/usr/bin$PATH_SEPARATOR$PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - as_found=: - case $as_dir in #( - /*) - for as_base in sh bash ksh sh5; do - # Try only shells that exist, to save several forks. - as_shell=$as_dir/$as_base - if { test -f "$as_shell" || test -f "$as_shell.exe"; } && - { $as_echo "$as_bourne_compatible""$as_required" | as_run=a "$as_shell"; } 2>/dev/null; then : - CONFIG_SHELL=$as_shell as_have_required=yes - if { $as_echo "$as_bourne_compatible""$as_suggested" | as_run=a "$as_shell"; } 2>/dev/null; then : - break 2 -fi -fi - done;; - esac - as_found=false -done -$as_found || { if { test -f "$SHELL" || test -f "$SHELL.exe"; } && - { $as_echo "$as_bourne_compatible""$as_required" | as_run=a "$SHELL"; } 2>/dev/null; then : - CONFIG_SHELL=$SHELL as_have_required=yes -fi; } -IFS=$as_save_IFS - - - if test "x$CONFIG_SHELL" != x; then : - # We cannot yet assume a decent shell, so we have to provide a - # neutralization value for shells without unset; and this also - # works around shells that cannot unset nonexistent variables. - BASH_ENV=/dev/null - ENV=/dev/null - (unset BASH_ENV) >/dev/null 2>&1 && unset BASH_ENV ENV - export CONFIG_SHELL - exec "$CONFIG_SHELL" "$as_myself" ${1+"$@"} -fi - - if test x$as_have_required = xno; then : - $as_echo "$0: This script requires a shell more modern than all" - $as_echo "$0: the shells that I found on your system." - if test x${ZSH_VERSION+set} = xset ; then - $as_echo "$0: In particular, zsh $ZSH_VERSION has bugs and should" - $as_echo "$0: be upgraded to zsh 4.3.4 or later." - else - $as_echo "$0: Please tell bug-autoconf@gnu.org and -$0: ejabberd@process-one.net about your system, including -$0: any error possibly output before this message. Then -$0: install a modern shell, or manually run the script -$0: under such a shell if you do have one." - fi - exit 1 -fi -fi -fi -SHELL=${CONFIG_SHELL-/bin/sh} -export SHELL -# Unset more variables known to interfere with behavior of common tools. -CLICOLOR_FORCE= GREP_OPTIONS= -unset CLICOLOR_FORCE GREP_OPTIONS - -## --------------------- ## -## M4sh Shell Functions. ## -## --------------------- ## -# as_fn_unset VAR -# --------------- -# Portably unset VAR. -as_fn_unset () -{ - { eval $1=; unset $1;} -} -as_unset=as_fn_unset - -# as_fn_set_status STATUS -# ----------------------- -# Set $? to STATUS, without forking. -as_fn_set_status () -{ - return $1 -} # as_fn_set_status - -# as_fn_exit STATUS -# ----------------- -# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. -as_fn_exit () -{ - set +e - as_fn_set_status $1 - exit $1 -} # as_fn_exit - -# as_fn_mkdir_p -# ------------- -# Create "$as_dir" as a directory, including parents if necessary. -as_fn_mkdir_p () -{ - - case $as_dir in #( - -*) as_dir=./$as_dir;; - esac - test -d "$as_dir" || eval $as_mkdir_p || { - as_dirs= - while :; do - case $as_dir in #( - *\'*) as_qdir=`$as_echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( - *) as_qdir=$as_dir;; - esac - as_dirs="'$as_qdir' $as_dirs" - as_dir=`$as_dirname -- "$as_dir" || -$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_dir" : 'X\(//\)[^/]' \| \ - X"$as_dir" : 'X\(//\)$' \| \ - X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$as_dir" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - test -d "$as_dir" && break - done - test -z "$as_dirs" || eval "mkdir $as_dirs" - } || test -d "$as_dir" || as_fn_error "cannot create directory $as_dir" - - -} # as_fn_mkdir_p -# as_fn_append VAR VALUE -# ---------------------- -# Append the text in VALUE to the end of the definition contained in VAR. Take -# advantage of any shell optimizations that allow amortized linear growth over -# repeated appends, instead of the typical quadratic growth present in naive -# implementations. -if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null; then : - eval 'as_fn_append () - { - eval $1+=\$2 - }' -else - as_fn_append () - { - eval $1=\$$1\$2 - } -fi # as_fn_append - -# as_fn_arith ARG... -# ------------------ -# Perform arithmetic evaluation on the ARGs, and store the result in the -# global $as_val. Take advantage of shells that can avoid forks. The arguments -# must be portable across $(()) and expr. -if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null; then : - eval 'as_fn_arith () - { - as_val=$(( $* )) - }' -else - as_fn_arith () - { - as_val=`expr "$@" || test $? -eq 1` - } -fi # as_fn_arith - - -# as_fn_error ERROR [LINENO LOG_FD] -# --------------------------------- -# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are -# provided, also output the error to LOG_FD, referencing LINENO. Then exit the -# script with status $?, using 1 if that was 0. -as_fn_error () -{ - as_status=$?; test $as_status -eq 0 && as_status=1 - if test "$3"; then - as_lineno=${as_lineno-"$2"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - $as_echo "$as_me:${as_lineno-$LINENO}: error: $1" >&$3 - fi - $as_echo "$as_me: error: $1" >&2 - as_fn_exit $as_status -} # as_fn_error - -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then - as_basename=basename -else - as_basename=false -fi - -if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then - as_dirname=dirname -else - as_dirname=false -fi - -as_me=`$as_basename -- "$0" || -$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X/"$0" | - sed '/^.*\/\([^/][^/]*\)\/*$/{ - s//\1/ - q - } - /^X\/\(\/\/\)$/{ - s//\1/ - q - } - /^X\/\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - -# Avoid depending upon Character Ranges. -as_cr_letters='abcdefghijklmnopqrstuvwxyz' -as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' -as_cr_Letters=$as_cr_letters$as_cr_LETTERS -as_cr_digits='0123456789' -as_cr_alnum=$as_cr_Letters$as_cr_digits - - - as_lineno_1=$LINENO as_lineno_1a=$LINENO - as_lineno_2=$LINENO as_lineno_2a=$LINENO - eval 'test "x$as_lineno_1'$as_run'" != "x$as_lineno_2'$as_run'" && - test "x`expr $as_lineno_1'$as_run' + 1`" = "x$as_lineno_2'$as_run'"' || { - # Blame Lee E. McMahon (1931-1989) for sed's syntax. :-) - sed -n ' - p - /[$]LINENO/= - ' <$as_myself | - sed ' - s/[$]LINENO.*/&-/ - t lineno - b - :lineno - N - :loop - s/[$]LINENO\([^'$as_cr_alnum'_].*\n\)\(.*\)/\2\1\2/ - t loop - s/-\n.*// - ' >$as_me.lineno && - chmod +x "$as_me.lineno" || - { $as_echo "$as_me: error: cannot create $as_me.lineno; rerun with a POSIX shell" >&2; as_fn_exit 1; } - - # Don't try to exec as it changes $[0], causing all sort of problems - # (the dirname of $[0] is not the place where we might find the - # original and so on. Autoconf is especially sensitive to this). - . "./$as_me.lineno" - # Exit status is that of the last command. - exit -} - -ECHO_C= ECHO_N= ECHO_T= -case `echo -n x` in #((((( --n*) - case `echo 'xy\c'` in - *c*) ECHO_T=' ';; # ECHO_T is single tab character. - xy) ECHO_C='\c';; - *) echo `echo ksh88 bug on AIX 6.1` > /dev/null - ECHO_T=' ';; - esac;; -*) - ECHO_N='-n';; -esac - -rm -f conf$$ conf$$.exe conf$$.file -if test -d conf$$.dir; then - rm -f conf$$.dir/conf$$.file -else - rm -f conf$$.dir - mkdir conf$$.dir 2>/dev/null -fi -if (echo >conf$$.file) 2>/dev/null; then - if ln -s conf$$.file conf$$ 2>/dev/null; then - as_ln_s='ln -s' - # ... but there are two gotchas: - # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. - # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. - # In both cases, we have to default to `cp -p'. - ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || - as_ln_s='cp -p' - elif ln conf$$.file conf$$ 2>/dev/null; then - as_ln_s=ln - else - as_ln_s='cp -p' - fi -else - as_ln_s='cp -p' -fi -rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file -rmdir conf$$.dir 2>/dev/null - -if mkdir -p . 2>/dev/null; then - as_mkdir_p='mkdir -p "$as_dir"' -else - test -d ./-p && rmdir ./-p - as_mkdir_p=false -fi - -if test -x / >/dev/null 2>&1; then - as_test_x='test -x' -else - if ls -dL / >/dev/null 2>&1; then - as_ls_L_option=L - else - as_ls_L_option= - fi - as_test_x=' - eval sh -c '\'' - if test -d "$1"; then - test -d "$1/."; - else - case $1 in #( - -*)set "./$1";; - esac; - case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in #(( - ???[sx]*):;;*)false;;esac;fi - '\'' sh - ' -fi -as_executable_p=$as_test_x - -# Sed expression to map a string onto a valid CPP name. -as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" - -# Sed expression to map a string onto a valid variable name. -as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" - - -test -n "$DJDIR" || exec 7<&0 &1 - -# Name of the host. -# hostname on some systems (SVR3.2, Linux) returns a bogus exit status, -# so uname gets run too. -ac_hostname=`(hostname || uname -n) 2>/dev/null | sed 1q` - -# -# Initializations. -# -ac_default_prefix=/usr/local -ac_clean_files= -ac_config_libobj_dir=. -LIBOBJS= -cross_compiling=no -subdirs= -MFLAGS= -MAKEFLAGS= - -# Identity of this package. -PACKAGE_NAME='ejabberd' -PACKAGE_TARNAME='ejabberd' -PACKAGE_VERSION='3.0.0-alpha-x' -PACKAGE_STRING='ejabberd 3.0.0-alpha-x' -PACKAGE_BUGREPORT='ejabberd@process-one.net' -PACKAGE_URL='' - -ac_default_prefix=/ -# Factoring default headers for most tests. -ac_includes_default="\ -#include -#ifdef HAVE_SYS_TYPES_H -# include -#endif -#ifdef HAVE_SYS_STAT_H -# include -#endif -#ifdef STDC_HEADERS -# include -# include -#else -# ifdef HAVE_STDLIB_H -# include -# endif -#endif -#ifdef HAVE_STRING_H -# if !defined STDC_HEADERS && defined HAVE_MEMORY_H -# include -# endif -# include -#endif -#ifdef HAVE_STRINGS_H -# include -#endif -#ifdef HAVE_INTTYPES_H -# include -#endif -#ifdef HAVE_STDINT_H -# include -#endif -#ifdef HAVE_UNISTD_H -# include -#endif" - -ac_subst_vars='LTLIBOBJS -ERLCFLAGS -target_os -target_vendor -target_cpu -target -host_os -host_vendor -host_cpu -host -build_os -build_vendor -build_cpu -build -md2 -INSTALLUSER -SSL_CFLAGS -SSL_LIBS -full_xml -transient_supervisors -db_type -roster_gateway_workaround -hipe -PAM_LIBS -PAM_CFLAGS -make_pam -pam -ZLIB_LIBS -ZLIB_CFLAGS -make_ejabberd_zlib -ejabberd_zlib -make_web -web -make_tls -tls -make_odbc -odbc -make_eldap -eldap -make_mod_pubsub -mod_pubsub -make_mod_proxy65 -mod_proxy65 -make_mod_muc -mod_muc -LIBOBJS -EGREP -GREP -CPP -ERLANG_EXMPP -ERLANG_LIBS -ERLANG_CFLAGS -ERL -ERLC -SET_MAKE -OBJEXT -EXEEXT -ac_ct_CC -CPPFLAGS -LDFLAGS -CFLAGS -CC -target_alias -host_alias -build_alias -LIBS -ECHO_T -ECHO_N -ECHO_C -DEFS -mandir -localedir -libdir -psdir -pdfdir -dvidir -htmldir -infodir -docdir -oldincludedir -includedir -localstatedir -sharedstatedir -sysconfdir -datadir -datarootdir -libexecdir -sbindir -bindir -program_transform_name -prefix -exec_prefix -PACKAGE_URL -PACKAGE_BUGREPORT -PACKAGE_STRING -PACKAGE_VERSION -PACKAGE_TARNAME -PACKAGE_NAME -PATH_SEPARATOR -SHELL' -ac_subst_files='' -ac_user_opts=' -enable_option_checking -with_erlang -enable_mod_muc -enable_mod_proxy65 -enable_mod_pubsub -enable_eldap -enable_odbc -enable_tls -enable_web -enable_ejabberd_zlib -with_zlib -enable_pam -with_pam -enable_hipe -enable_roster_gateway_workaround -enable_mssql -enable_transient_supervisors -enable_full_xml -with_openssl -enable_user -' - ac_precious_vars='build_alias -host_alias -target_alias -CC -CFLAGS -LDFLAGS -LIBS -CPPFLAGS -CPP -ERLC -ERLCFLAGS' - - -# Initialize some variables set by options. -ac_init_help= -ac_init_version=false -ac_unrecognized_opts= -ac_unrecognized_sep= -# The variables have the same names as the options, with -# dashes changed to underlines. -cache_file=/dev/null -exec_prefix=NONE -no_create= -no_recursion= -prefix=NONE -program_prefix=NONE -program_suffix=NONE -program_transform_name=s,x,x, -silent= -site= -srcdir= -verbose= -x_includes=NONE -x_libraries=NONE - -# Installation directory options. -# These are left unexpanded so users can "make install exec_prefix=/foo" -# and all the variables that are supposed to be based on exec_prefix -# by default will actually change. -# Use braces instead of parens because sh, perl, etc. also accept them. -# (The list follows the same order as the GNU Coding Standards.) -bindir='${exec_prefix}/bin' -sbindir='${exec_prefix}/sbin' -libexecdir='${exec_prefix}/libexec' -datarootdir='${prefix}/share' -datadir='${datarootdir}' -sysconfdir='${prefix}/etc' -sharedstatedir='${prefix}/com' -localstatedir='${prefix}/var' -includedir='${prefix}/include' -oldincludedir='/usr/include' -docdir='${datarootdir}/doc/${PACKAGE_TARNAME}' -infodir='${datarootdir}/info' -htmldir='${docdir}' -dvidir='${docdir}' -pdfdir='${docdir}' -psdir='${docdir}' -libdir='${exec_prefix}/lib' -localedir='${datarootdir}/locale' -mandir='${datarootdir}/man' - -ac_prev= -ac_dashdash= -for ac_option -do - # If the previous option needs an argument, assign it. - if test -n "$ac_prev"; then - eval $ac_prev=\$ac_option - ac_prev= - continue - fi - - case $ac_option in - *=*) ac_optarg=`expr "X$ac_option" : '[^=]*=\(.*\)'` ;; - *) ac_optarg=yes ;; - esac - - # Accept the important Cygnus configure options, so we can diagnose typos. - - case $ac_dashdash$ac_option in - --) - ac_dashdash=yes ;; - - -bindir | --bindir | --bindi | --bind | --bin | --bi) - ac_prev=bindir ;; - -bindir=* | --bindir=* | --bindi=* | --bind=* | --bin=* | --bi=*) - bindir=$ac_optarg ;; - - -build | --build | --buil | --bui | --bu) - ac_prev=build_alias ;; - -build=* | --build=* | --buil=* | --bui=* | --bu=*) - build_alias=$ac_optarg ;; - - -cache-file | --cache-file | --cache-fil | --cache-fi \ - | --cache-f | --cache- | --cache | --cach | --cac | --ca | --c) - ac_prev=cache_file ;; - -cache-file=* | --cache-file=* | --cache-fil=* | --cache-fi=* \ - | --cache-f=* | --cache-=* | --cache=* | --cach=* | --cac=* | --ca=* | --c=*) - cache_file=$ac_optarg ;; - - --config-cache | -C) - cache_file=config.cache ;; - - -datadir | --datadir | --datadi | --datad) - ac_prev=datadir ;; - -datadir=* | --datadir=* | --datadi=* | --datad=*) - datadir=$ac_optarg ;; - - -datarootdir | --datarootdir | --datarootdi | --datarootd | --dataroot \ - | --dataroo | --dataro | --datar) - ac_prev=datarootdir ;; - -datarootdir=* | --datarootdir=* | --datarootdi=* | --datarootd=* \ - | --dataroot=* | --dataroo=* | --dataro=* | --datar=*) - datarootdir=$ac_optarg ;; - - -disable-* | --disable-*) - ac_useropt=`expr "x$ac_option" : 'x-*disable-\(.*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid feature name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"enable_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--disable-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval enable_$ac_useropt=no ;; - - -docdir | --docdir | --docdi | --doc | --do) - ac_prev=docdir ;; - -docdir=* | --docdir=* | --docdi=* | --doc=* | --do=*) - docdir=$ac_optarg ;; - - -dvidir | --dvidir | --dvidi | --dvid | --dvi | --dv) - ac_prev=dvidir ;; - -dvidir=* | --dvidir=* | --dvidi=* | --dvid=* | --dvi=* | --dv=*) - dvidir=$ac_optarg ;; - - -enable-* | --enable-*) - ac_useropt=`expr "x$ac_option" : 'x-*enable-\([^=]*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid feature name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"enable_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--enable-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval enable_$ac_useropt=\$ac_optarg ;; - - -exec-prefix | --exec_prefix | --exec-prefix | --exec-prefi \ - | --exec-pref | --exec-pre | --exec-pr | --exec-p | --exec- \ - | --exec | --exe | --ex) - ac_prev=exec_prefix ;; - -exec-prefix=* | --exec_prefix=* | --exec-prefix=* | --exec-prefi=* \ - | --exec-pref=* | --exec-pre=* | --exec-pr=* | --exec-p=* | --exec-=* \ - | --exec=* | --exe=* | --ex=*) - exec_prefix=$ac_optarg ;; - - -gas | --gas | --ga | --g) - # Obsolete; use --with-gas. - with_gas=yes ;; - - -help | --help | --hel | --he | -h) - ac_init_help=long ;; - -help=r* | --help=r* | --hel=r* | --he=r* | -hr*) - ac_init_help=recursive ;; - -help=s* | --help=s* | --hel=s* | --he=s* | -hs*) - ac_init_help=short ;; - - -host | --host | --hos | --ho) - ac_prev=host_alias ;; - -host=* | --host=* | --hos=* | --ho=*) - host_alias=$ac_optarg ;; - - -htmldir | --htmldir | --htmldi | --htmld | --html | --htm | --ht) - ac_prev=htmldir ;; - -htmldir=* | --htmldir=* | --htmldi=* | --htmld=* | --html=* | --htm=* \ - | --ht=*) - htmldir=$ac_optarg ;; - - -includedir | --includedir | --includedi | --included | --include \ - | --includ | --inclu | --incl | --inc) - ac_prev=includedir ;; - -includedir=* | --includedir=* | --includedi=* | --included=* | --include=* \ - | --includ=* | --inclu=* | --incl=* | --inc=*) - includedir=$ac_optarg ;; - - -infodir | --infodir | --infodi | --infod | --info | --inf) - ac_prev=infodir ;; - -infodir=* | --infodir=* | --infodi=* | --infod=* | --info=* | --inf=*) - infodir=$ac_optarg ;; - - -libdir | --libdir | --libdi | --libd) - ac_prev=libdir ;; - -libdir=* | --libdir=* | --libdi=* | --libd=*) - libdir=$ac_optarg ;; - - -libexecdir | --libexecdir | --libexecdi | --libexecd | --libexec \ - | --libexe | --libex | --libe) - ac_prev=libexecdir ;; - -libexecdir=* | --libexecdir=* | --libexecdi=* | --libexecd=* | --libexec=* \ - | --libexe=* | --libex=* | --libe=*) - libexecdir=$ac_optarg ;; - - -localedir | --localedir | --localedi | --localed | --locale) - ac_prev=localedir ;; - -localedir=* | --localedir=* | --localedi=* | --localed=* | --locale=*) - localedir=$ac_optarg ;; - - -localstatedir | --localstatedir | --localstatedi | --localstated \ - | --localstate | --localstat | --localsta | --localst | --locals) - ac_prev=localstatedir ;; - -localstatedir=* | --localstatedir=* | --localstatedi=* | --localstated=* \ - | --localstate=* | --localstat=* | --localsta=* | --localst=* | --locals=*) - localstatedir=$ac_optarg ;; - - -mandir | --mandir | --mandi | --mand | --man | --ma | --m) - ac_prev=mandir ;; - -mandir=* | --mandir=* | --mandi=* | --mand=* | --man=* | --ma=* | --m=*) - mandir=$ac_optarg ;; - - -nfp | --nfp | --nf) - # Obsolete; use --without-fp. - with_fp=no ;; - - -no-create | --no-create | --no-creat | --no-crea | --no-cre \ - | --no-cr | --no-c | -n) - no_create=yes ;; - - -no-recursion | --no-recursion | --no-recursio | --no-recursi \ - | --no-recurs | --no-recur | --no-recu | --no-rec | --no-re | --no-r) - no_recursion=yes ;; - - -oldincludedir | --oldincludedir | --oldincludedi | --oldincluded \ - | --oldinclude | --oldinclud | --oldinclu | --oldincl | --oldinc \ - | --oldin | --oldi | --old | --ol | --o) - ac_prev=oldincludedir ;; - -oldincludedir=* | --oldincludedir=* | --oldincludedi=* | --oldincluded=* \ - | --oldinclude=* | --oldinclud=* | --oldinclu=* | --oldincl=* | --oldinc=* \ - | --oldin=* | --oldi=* | --old=* | --ol=* | --o=*) - oldincludedir=$ac_optarg ;; - - -prefix | --prefix | --prefi | --pref | --pre | --pr | --p) - ac_prev=prefix ;; - -prefix=* | --prefix=* | --prefi=* | --pref=* | --pre=* | --pr=* | --p=*) - prefix=$ac_optarg ;; - - -program-prefix | --program-prefix | --program-prefi | --program-pref \ - | --program-pre | --program-pr | --program-p) - ac_prev=program_prefix ;; - -program-prefix=* | --program-prefix=* | --program-prefi=* \ - | --program-pref=* | --program-pre=* | --program-pr=* | --program-p=*) - program_prefix=$ac_optarg ;; - - -program-suffix | --program-suffix | --program-suffi | --program-suff \ - | --program-suf | --program-su | --program-s) - ac_prev=program_suffix ;; - -program-suffix=* | --program-suffix=* | --program-suffi=* \ - | --program-suff=* | --program-suf=* | --program-su=* | --program-s=*) - program_suffix=$ac_optarg ;; - - -program-transform-name | --program-transform-name \ - | --program-transform-nam | --program-transform-na \ - | --program-transform-n | --program-transform- \ - | --program-transform | --program-transfor \ - | --program-transfo | --program-transf \ - | --program-trans | --program-tran \ - | --progr-tra | --program-tr | --program-t) - ac_prev=program_transform_name ;; - -program-transform-name=* | --program-transform-name=* \ - | --program-transform-nam=* | --program-transform-na=* \ - | --program-transform-n=* | --program-transform-=* \ - | --program-transform=* | --program-transfor=* \ - | --program-transfo=* | --program-transf=* \ - | --program-trans=* | --program-tran=* \ - | --progr-tra=* | --program-tr=* | --program-t=*) - program_transform_name=$ac_optarg ;; - - -pdfdir | --pdfdir | --pdfdi | --pdfd | --pdf | --pd) - ac_prev=pdfdir ;; - -pdfdir=* | --pdfdir=* | --pdfdi=* | --pdfd=* | --pdf=* | --pd=*) - pdfdir=$ac_optarg ;; - - -psdir | --psdir | --psdi | --psd | --ps) - ac_prev=psdir ;; - -psdir=* | --psdir=* | --psdi=* | --psd=* | --ps=*) - psdir=$ac_optarg ;; - - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil) - silent=yes ;; - - -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb) - ac_prev=sbindir ;; - -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \ - | --sbi=* | --sb=*) - sbindir=$ac_optarg ;; - - -sharedstatedir | --sharedstatedir | --sharedstatedi \ - | --sharedstated | --sharedstate | --sharedstat | --sharedsta \ - | --sharedst | --shareds | --shared | --share | --shar \ - | --sha | --sh) - ac_prev=sharedstatedir ;; - -sharedstatedir=* | --sharedstatedir=* | --sharedstatedi=* \ - | --sharedstated=* | --sharedstate=* | --sharedstat=* | --sharedsta=* \ - | --sharedst=* | --shareds=* | --shared=* | --share=* | --shar=* \ - | --sha=* | --sh=*) - sharedstatedir=$ac_optarg ;; - - -site | --site | --sit) - ac_prev=site ;; - -site=* | --site=* | --sit=*) - site=$ac_optarg ;; - - -srcdir | --srcdir | --srcdi | --srcd | --src | --sr) - ac_prev=srcdir ;; - -srcdir=* | --srcdir=* | --srcdi=* | --srcd=* | --src=* | --sr=*) - srcdir=$ac_optarg ;; - - -sysconfdir | --sysconfdir | --sysconfdi | --sysconfd | --sysconf \ - | --syscon | --sysco | --sysc | --sys | --sy) - ac_prev=sysconfdir ;; - -sysconfdir=* | --sysconfdir=* | --sysconfdi=* | --sysconfd=* | --sysconf=* \ - | --syscon=* | --sysco=* | --sysc=* | --sys=* | --sy=*) - sysconfdir=$ac_optarg ;; - - -target | --target | --targe | --targ | --tar | --ta | --t) - ac_prev=target_alias ;; - -target=* | --target=* | --targe=* | --targ=* | --tar=* | --ta=* | --t=*) - target_alias=$ac_optarg ;; - - -v | -verbose | --verbose | --verbos | --verbo | --verb) - verbose=yes ;; - - -version | --version | --versio | --versi | --vers | -V) - ac_init_version=: ;; - - -with-* | --with-*) - ac_useropt=`expr "x$ac_option" : 'x-*with-\([^=]*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid package name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"with_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--with-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval with_$ac_useropt=\$ac_optarg ;; - - -without-* | --without-*) - ac_useropt=`expr "x$ac_option" : 'x-*without-\(.*\)'` - # Reject names that are not valid shell variable names. - expr "x$ac_useropt" : ".*[^-+._$as_cr_alnum]" >/dev/null && - as_fn_error "invalid package name: $ac_useropt" - ac_useropt_orig=$ac_useropt - ac_useropt=`$as_echo "$ac_useropt" | sed 's/[-+.]/_/g'` - case $ac_user_opts in - *" -"with_$ac_useropt" -"*) ;; - *) ac_unrecognized_opts="$ac_unrecognized_opts$ac_unrecognized_sep--without-$ac_useropt_orig" - ac_unrecognized_sep=', ';; - esac - eval with_$ac_useropt=no ;; - - --x) - # Obsolete; use --with-x. - with_x=yes ;; - - -x-includes | --x-includes | --x-include | --x-includ | --x-inclu \ - | --x-incl | --x-inc | --x-in | --x-i) - ac_prev=x_includes ;; - -x-includes=* | --x-includes=* | --x-include=* | --x-includ=* | --x-inclu=* \ - | --x-incl=* | --x-inc=* | --x-in=* | --x-i=*) - x_includes=$ac_optarg ;; - - -x-libraries | --x-libraries | --x-librarie | --x-librari \ - | --x-librar | --x-libra | --x-libr | --x-lib | --x-li | --x-l) - ac_prev=x_libraries ;; - -x-libraries=* | --x-libraries=* | --x-librarie=* | --x-librari=* \ - | --x-librar=* | --x-libra=* | --x-libr=* | --x-lib=* | --x-li=* | --x-l=*) - x_libraries=$ac_optarg ;; - - -*) as_fn_error "unrecognized option: \`$ac_option' -Try \`$0 --help' for more information." - ;; - - *=*) - ac_envvar=`expr "x$ac_option" : 'x\([^=]*\)='` - # Reject names that are not valid shell variable names. - case $ac_envvar in #( - '' | [0-9]* | *[!_$as_cr_alnum]* ) - as_fn_error "invalid variable name: \`$ac_envvar'" ;; - esac - eval $ac_envvar=\$ac_optarg - export $ac_envvar ;; - - *) - # FIXME: should be removed in autoconf 3.0. - $as_echo "$as_me: WARNING: you should use --build, --host, --target" >&2 - expr "x$ac_option" : ".*[^-._$as_cr_alnum]" >/dev/null && - $as_echo "$as_me: WARNING: invalid host type: $ac_option" >&2 - : ${build_alias=$ac_option} ${host_alias=$ac_option} ${target_alias=$ac_option} - ;; - - esac -done - -if test -n "$ac_prev"; then - ac_option=--`echo $ac_prev | sed 's/_/-/g'` - as_fn_error "missing argument to $ac_option" -fi - -if test -n "$ac_unrecognized_opts"; then - case $enable_option_checking in - no) ;; - fatal) as_fn_error "unrecognized options: $ac_unrecognized_opts" ;; - *) $as_echo "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2 ;; - esac -fi - -# Check all directory arguments for consistency. -for ac_var in exec_prefix prefix bindir sbindir libexecdir datarootdir \ - datadir sysconfdir sharedstatedir localstatedir includedir \ - oldincludedir docdir infodir htmldir dvidir pdfdir psdir \ - libdir localedir mandir -do - eval ac_val=\$$ac_var - # Remove trailing slashes. - case $ac_val in - */ ) - ac_val=`expr "X$ac_val" : 'X\(.*[^/]\)' \| "X$ac_val" : 'X\(.*\)'` - eval $ac_var=\$ac_val;; - esac - # Be sure to have absolute directory names. - case $ac_val in - [\\/$]* | ?:[\\/]* ) continue;; - NONE | '' ) case $ac_var in *prefix ) continue;; esac;; - esac - as_fn_error "expected an absolute directory name for --$ac_var: $ac_val" -done - -# There might be people who depend on the old broken behavior: `$host' -# used to hold the argument of --host etc. -# FIXME: To remove some day. -build=$build_alias -host=$host_alias -target=$target_alias - -# FIXME: To remove some day. -if test "x$host_alias" != x; then - if test "x$build_alias" = x; then - cross_compiling=maybe - $as_echo "$as_me: WARNING: If you wanted to set the --build type, don't use --host. - If a cross compiler is detected then cross compile mode will be used." >&2 - elif test "x$build_alias" != "x$host_alias"; then - cross_compiling=yes - fi -fi - -ac_tool_prefix= -test -n "$host_alias" && ac_tool_prefix=$host_alias- - -test "$silent" = yes && exec 6>/dev/null - - -ac_pwd=`pwd` && test -n "$ac_pwd" && -ac_ls_di=`ls -di .` && -ac_pwd_ls_di=`cd "$ac_pwd" && ls -di .` || - as_fn_error "working directory cannot be determined" -test "X$ac_ls_di" = "X$ac_pwd_ls_di" || - as_fn_error "pwd does not report name of working directory" - - -# Find the source files, if location was not specified. -if test -z "$srcdir"; then - ac_srcdir_defaulted=yes - # Try the directory containing this script, then the parent directory. - ac_confdir=`$as_dirname -- "$as_myself" || -$as_expr X"$as_myself" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_myself" : 'X\(//\)[^/]' \| \ - X"$as_myself" : 'X\(//\)$' \| \ - X"$as_myself" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$as_myself" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - srcdir=$ac_confdir - if test ! -r "$srcdir/$ac_unique_file"; then - srcdir=.. - fi -else - ac_srcdir_defaulted=no -fi -if test ! -r "$srcdir/$ac_unique_file"; then - test "$ac_srcdir_defaulted" = yes && srcdir="$ac_confdir or .." - as_fn_error "cannot find sources ($ac_unique_file) in $srcdir" -fi -ac_msg="sources are in $srcdir, but \`cd $srcdir' does not work" -ac_abs_confdir=`( - cd "$srcdir" && test -r "./$ac_unique_file" || as_fn_error "$ac_msg" - pwd)` -# When building in place, set srcdir=. -if test "$ac_abs_confdir" = "$ac_pwd"; then - srcdir=. -fi -# Remove unnecessary trailing slashes from srcdir. -# Double slashes in file names in object file debugging info -# mess up M-x gdb in Emacs. -case $srcdir in -*/) srcdir=`expr "X$srcdir" : 'X\(.*[^/]\)' \| "X$srcdir" : 'X\(.*\)'`;; -esac -for ac_var in $ac_precious_vars; do - eval ac_env_${ac_var}_set=\${${ac_var}+set} - eval ac_env_${ac_var}_value=\$${ac_var} - eval ac_cv_env_${ac_var}_set=\${${ac_var}+set} - eval ac_cv_env_${ac_var}_value=\$${ac_var} -done - -# -# Report the --help message. -# -if test "$ac_init_help" = "long"; then - # Omit some internal or obsolete options to make the list less imposing. - # This message is too long to be a string in the A/UX 3.1 sh. - cat <<_ACEOF -\`configure' configures ejabberd 3.0.0-alpha-x to adapt to many kinds of systems. - -Usage: $0 [OPTION]... [VAR=VALUE]... - -To assign environment variables (e.g., CC, CFLAGS...), specify them as -VAR=VALUE. See below for descriptions of some of the useful variables. - -Defaults for the options are specified in brackets. - -Configuration: - -h, --help display this help and exit - --help=short display options specific to this package - --help=recursive display the short help of all the included packages - -V, --version display version information and exit - -q, --quiet, --silent do not print \`checking...' messages - --cache-file=FILE cache test results in FILE [disabled] - -C, --config-cache alias for \`--cache-file=config.cache' - -n, --no-create do not create output files - --srcdir=DIR find the sources in DIR [configure dir or \`..'] - -Installation directories: - --prefix=PREFIX install architecture-independent files in PREFIX - [$ac_default_prefix] - --exec-prefix=EPREFIX install architecture-dependent files in EPREFIX - [PREFIX] - -By default, \`make install' will install all the files in -\`$ac_default_prefix/bin', \`$ac_default_prefix/lib' etc. You can specify -an installation prefix other than \`$ac_default_prefix' using \`--prefix', -for instance \`--prefix=\$HOME'. - -For better control, use the options below. - -Fine tuning of the installation directories: - --bindir=DIR user executables [EPREFIX/bin] - --sbindir=DIR system admin executables [EPREFIX/sbin] - --libexecdir=DIR program executables [EPREFIX/libexec] - --sysconfdir=DIR read-only single-machine data [PREFIX/etc] - --sharedstatedir=DIR modifiable architecture-independent data [PREFIX/com] - --localstatedir=DIR modifiable single-machine data [PREFIX/var] - --libdir=DIR object code libraries [EPREFIX/lib] - --includedir=DIR C header files [PREFIX/include] - --oldincludedir=DIR C header files for non-gcc [/usr/include] - --datarootdir=DIR read-only arch.-independent data root [PREFIX/share] - --datadir=DIR read-only architecture-independent data [DATAROOTDIR] - --infodir=DIR info documentation [DATAROOTDIR/info] - --localedir=DIR locale-dependent data [DATAROOTDIR/locale] - --mandir=DIR man documentation [DATAROOTDIR/man] - --docdir=DIR documentation root [DATAROOTDIR/doc/ejabberd] - --htmldir=DIR html documentation [DOCDIR] - --dvidir=DIR dvi documentation [DOCDIR] - --pdfdir=DIR pdf documentation [DOCDIR] - --psdir=DIR ps documentation [DOCDIR] -_ACEOF - - cat <<\_ACEOF - -System types: - --build=BUILD configure for building on BUILD [guessed] - --host=HOST cross-compile to build programs to run on HOST [BUILD] - --target=TARGET configure for building compilers for TARGET [HOST] -_ACEOF -fi - -if test -n "$ac_init_help"; then - case $ac_init_help in - short | recursive ) echo "Configuration of ejabberd 3.0.0-alpha-x:";; - esac - cat <<\_ACEOF - -Optional Features: - --disable-option-checking ignore unrecognized --enable/--with options - --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no) - --enable-FEATURE[=ARG] include FEATURE [ARG=yes] - --enable-mod_muc enable mod_muc (default: yes) - --enable-mod_proxy65 enable mod_proxy65 (default: yes) - --enable-mod_pubsub enable mod_pubsub (default: yes) - --enable-eldap enable eldap (default: yes) - --enable-odbc enable odbc (default: no) - --enable-tls enable tls (default: yes) - --enable-web enable web (default: yes) - --enable-ejabberd_zlib enable ejabberd_zlib (default: yes) - --enable-pam enable pam (default: no) - --enable-hipe compile natively with HiPE, not recommended - (default: no) - --enable-roster-gateway-workaround - turn on workaround for processing gateway - subscriptions (default: no) - --enable-mssql use Microsoft SQL Server database (default: no, - requires --enable-odbc) - --enable-transient_supervisors - use Erlang supervision for transient process - (default: yes) - --enable-full-xml use XML features in XMPP stream (ex: CDATA) - (default: no, requires XML compliant clients) - --enable-user[[[=USER]]] - allow this system user to start ejabberd (default: - no) - -Optional Packages: - --with-PACKAGE[=ARG] use PACKAGE [ARG=yes] - --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no) - --with-erlang=PREFIX path to erlc and erl - --with-zlib=PREFIX prefix where zlib is installed - --with-pam=PREFIX prefix where PAM is installed - --with-openssl=PREFIX prefix where OPENSSL is installed - -Some influential environment variables: - CC C compiler command - CFLAGS C compiler flags - LDFLAGS linker flags, e.g. -L if you have libraries in a - nonstandard directory - LIBS libraries to pass to the linker, e.g. -l - CPPFLAGS (Objective) C/C++ preprocessor flags, e.g. -I if - you have headers in a nonstandard directory - CPP C preprocessor - ERLC Erlang/OTP compiler command [autodetected] - ERLCFLAGS Erlang/OTP compiler flags [none] - -Use these variables to override the choices made by `configure' or to help -it to find libraries and programs with nonstandard names/locations. - -Report bugs to . -_ACEOF -ac_status=$? -fi - -if test "$ac_init_help" = "recursive"; then - # If there are subdirs, report their specific --help. - for ac_dir in : $ac_subdirs_all; do test "x$ac_dir" = x: && continue - test -d "$ac_dir" || - { cd "$srcdir" && ac_pwd=`pwd` && srcdir=. && test -d "$ac_dir"; } || - continue - ac_builddir=. - -case "$ac_dir" in -.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; -*) - ac_dir_suffix=/`$as_echo "$ac_dir" | sed 's|^\.[\\/]||'` - # A ".." for each directory in $ac_dir_suffix. - ac_top_builddir_sub=`$as_echo "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` - case $ac_top_builddir_sub in - "") ac_top_builddir_sub=. ac_top_build_prefix= ;; - *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; - esac ;; -esac -ac_abs_top_builddir=$ac_pwd -ac_abs_builddir=$ac_pwd$ac_dir_suffix -# for backward compatibility: -ac_top_builddir=$ac_top_build_prefix - -case $srcdir in - .) # We are building in place. - ac_srcdir=. - ac_top_srcdir=$ac_top_builddir_sub - ac_abs_top_srcdir=$ac_pwd ;; - [\\/]* | ?:[\\/]* ) # Absolute name. - ac_srcdir=$srcdir$ac_dir_suffix; - ac_top_srcdir=$srcdir - ac_abs_top_srcdir=$srcdir ;; - *) # Relative name. - ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix - ac_top_srcdir=$ac_top_build_prefix$srcdir - ac_abs_top_srcdir=$ac_pwd/$srcdir ;; -esac -ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix - - cd "$ac_dir" || { ac_status=$?; continue; } - # Check for guested configure. - if test -f "$ac_srcdir/configure.gnu"; then - echo && - $SHELL "$ac_srcdir/configure.gnu" --help=recursive - elif test -f "$ac_srcdir/configure"; then - echo && - $SHELL "$ac_srcdir/configure" --help=recursive - else - $as_echo "$as_me: WARNING: no configuration information is in $ac_dir" >&2 - fi || ac_status=$? - cd "$ac_pwd" || { ac_status=$?; break; } - done -fi - -test -n "$ac_init_help" && exit $ac_status -if $ac_init_version; then - cat <<\_ACEOF -ejabberd configure 3.0.0-alpha-x -generated by GNU Autoconf 2.65 - -Copyright (C) 2009 Free Software Foundation, Inc. -This configure script is free software; the Free Software Foundation -gives unlimited permission to copy, distribute and modify it. -_ACEOF - exit -fi - -## ------------------------ ## -## Autoconf initialization. ## -## ------------------------ ## - -# ac_fn_c_try_compile LINENO -# -------------------------- -# Try to compile conftest.$ac_ext, and return whether this succeeded. -ac_fn_c_try_compile () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - rm -f conftest.$ac_objext - if { { ac_try="$ac_compile" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_compile") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - grep -v '^ *+' conftest.err >conftest.er1 - cat conftest.er1 >&5 - mv -f conftest.er1 conftest.err - fi - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { - test -z "$ac_c_werror_flag" || - test ! -s conftest.err - } && test -s conftest.$ac_objext; then : - ac_retval=0 -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=1 -fi - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_compile - -# ac_fn_c_try_cpp LINENO -# ---------------------- -# Try to preprocess conftest.$ac_ext, and return whether this succeeded. -ac_fn_c_try_cpp () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { { ac_try="$ac_cpp conftest.$ac_ext" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_cpp conftest.$ac_ext") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - grep -v '^ *+' conftest.err >conftest.er1 - cat conftest.er1 >&5 - mv -f conftest.er1 conftest.err - fi - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } >/dev/null && { - test -z "$ac_c_preproc_warn_flag$ac_c_werror_flag" || - test ! -s conftest.err - }; then : - ac_retval=0 -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=1 -fi - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_cpp - -# ac_fn_c_try_run LINENO -# ---------------------- -# Try to link conftest.$ac_ext, and return whether this succeeded. Assumes -# that executables *can* be run. -ac_fn_c_try_run () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { ac_try='./conftest$ac_exeext' - { { case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_try") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; }; then : - ac_retval=0 -else - $as_echo "$as_me: program exited with status $ac_status" >&5 - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=$ac_status -fi - rm -rf conftest.dSYM conftest_ipa8_conftest.oo - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_run - -# ac_fn_c_check_header_mongrel LINENO HEADER VAR INCLUDES -# ------------------------------------------------------- -# Tests whether HEADER exists, giving a warning if it cannot be compiled using -# the include files in INCLUDES and setting the cache variable VAR -# accordingly. -ac_fn_c_check_header_mongrel () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 -$as_echo_n "checking for $2... " >&6; } -if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -fi -eval ac_res=\$$3 - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 -$as_echo "$ac_res" >&6; } -else - # Is the header compilable? -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking $2 usability" >&5 -$as_echo_n "checking $2 usability... " >&6; } -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -$4 -#include <$2> -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_header_compiler=yes -else - ac_header_compiler=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_header_compiler" >&5 -$as_echo "$ac_header_compiler" >&6; } - -# Is the header present? -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking $2 presence" >&5 -$as_echo_n "checking $2 presence... " >&6; } -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include <$2> -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - ac_header_preproc=yes -else - ac_header_preproc=no -fi -rm -f conftest.err conftest.$ac_ext -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_header_preproc" >&5 -$as_echo "$ac_header_preproc" >&6; } - -# So? What about this header? -case $ac_header_compiler:$ac_header_preproc:$ac_c_preproc_warn_flag in #(( - yes:no: ) - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: accepted by the compiler, rejected by the preprocessor!" >&5 -$as_echo "$as_me: WARNING: $2: accepted by the compiler, rejected by the preprocessor!" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: proceeding with the compiler's result" >&5 -$as_echo "$as_me: WARNING: $2: proceeding with the compiler's result" >&2;} - ;; - no:yes:* ) - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: present but cannot be compiled" >&5 -$as_echo "$as_me: WARNING: $2: present but cannot be compiled" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: check for missing prerequisite headers?" >&5 -$as_echo "$as_me: WARNING: $2: check for missing prerequisite headers?" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: see the Autoconf documentation" >&5 -$as_echo "$as_me: WARNING: $2: see the Autoconf documentation" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: section \"Present But Cannot Be Compiled\"" >&5 -$as_echo "$as_me: WARNING: $2: section \"Present But Cannot Be Compiled\"" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $2: proceeding with the compiler's result" >&5 -$as_echo "$as_me: WARNING: $2: proceeding with the compiler's result" >&2;} -( cat <<\_ASBOX -## --------------------------------------- ## -## Report this to ejabberd@process-one.net ## -## --------------------------------------- ## -_ASBOX - ) | sed "s/^/$as_me: WARNING: /" >&2 - ;; -esac - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 -$as_echo_n "checking for $2... " >&6; } -if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -else - eval "$3=\$ac_header_compiler" -fi -eval ac_res=\$$3 - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 -$as_echo "$ac_res" >&6; } -fi - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - -} # ac_fn_c_check_header_mongrel - -# ac_fn_c_check_header_compile LINENO HEADER VAR INCLUDES -# ------------------------------------------------------- -# Tests whether HEADER exists and can be compiled using the include files in -# INCLUDES, setting the cache variable VAR accordingly. -ac_fn_c_check_header_compile () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for $2" >&5 -$as_echo_n "checking for $2... " >&6; } -if { as_var=$3; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -$4 -#include <$2> -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - eval "$3=yes" -else - eval "$3=no" -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -eval ac_res=\$$3 - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_res" >&5 -$as_echo "$ac_res" >&6; } - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - -} # ac_fn_c_check_header_compile - -# ac_fn_c_try_link LINENO -# ----------------------- -# Try to link conftest.$ac_ext, and return whether this succeeded. -ac_fn_c_try_link () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - rm -f conftest.$ac_objext conftest$ac_exeext - if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - grep -v '^ *+' conftest.err >conftest.er1 - cat conftest.er1 >&5 - mv -f conftest.er1 conftest.err - fi - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { - test -z "$ac_c_werror_flag" || - test ! -s conftest.err - } && test -s conftest$ac_exeext && { - test "$cross_compiling" = yes || - $as_test_x conftest$ac_exeext - }; then : - ac_retval=0 -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=1 -fi - # Delete the IPA/IPO (Inter Procedural Analysis/Optimization) information - # created by the PGI compiler (conftest_ipa8_conftest.oo), as it would - # interfere with the next link command; also delete a directory that is - # left behind by Apple's compiler. We do this before executing the actions. - rm -rf conftest.dSYM conftest_ipa8_conftest.oo - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_c_try_link - -# ac_fn_erl_try_run LINENO -# ------------------------ -# Try to link conftest.$ac_ext, and return whether this succeeded. Assumes -# that executables *can* be run. -ac_fn_erl_try_run () -{ - as_lineno=${as_lineno-"$1"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } && { ac_try='./conftest$ac_exeext' - { { case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_try") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; }; then : - ac_retval=0 -else - $as_echo "$as_me: program exited with status $ac_status" >&5 - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - - ac_retval=$ac_status -fi - rm -rf conftest.dSYM conftest_ipa8_conftest.oo - eval $as_lineno_stack; test "x$as_lineno_stack" = x && { as_lineno=; unset as_lineno;} - as_fn_set_status $ac_retval - -} # ac_fn_erl_try_run -cat >config.log <<_ACEOF -This file contains any messages produced by compilers while -running configure, to aid debugging if configure makes a mistake. - -It was created by ejabberd $as_me 3.0.0-alpha-x, which was -generated by GNU Autoconf 2.65. Invocation command line was - - $ $0 $@ - -_ACEOF -exec 5>>config.log -{ -cat <<_ASUNAME -## --------- ## -## Platform. ## -## --------- ## - -hostname = `(hostname || uname -n) 2>/dev/null | sed 1q` -uname -m = `(uname -m) 2>/dev/null || echo unknown` -uname -r = `(uname -r) 2>/dev/null || echo unknown` -uname -s = `(uname -s) 2>/dev/null || echo unknown` -uname -v = `(uname -v) 2>/dev/null || echo unknown` - -/usr/bin/uname -p = `(/usr/bin/uname -p) 2>/dev/null || echo unknown` -/bin/uname -X = `(/bin/uname -X) 2>/dev/null || echo unknown` - -/bin/arch = `(/bin/arch) 2>/dev/null || echo unknown` -/usr/bin/arch -k = `(/usr/bin/arch -k) 2>/dev/null || echo unknown` -/usr/convex/getsysinfo = `(/usr/convex/getsysinfo) 2>/dev/null || echo unknown` -/usr/bin/hostinfo = `(/usr/bin/hostinfo) 2>/dev/null || echo unknown` -/bin/machine = `(/bin/machine) 2>/dev/null || echo unknown` -/usr/bin/oslevel = `(/usr/bin/oslevel) 2>/dev/null || echo unknown` -/bin/universe = `(/bin/universe) 2>/dev/null || echo unknown` - -_ASUNAME - -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - $as_echo "PATH: $as_dir" - done -IFS=$as_save_IFS - -} >&5 - -cat >&5 <<_ACEOF - - -## ----------- ## -## Core tests. ## -## ----------- ## - -_ACEOF - - -# Keep a trace of the command line. -# Strip out --no-create and --no-recursion so they do not pile up. -# Strip out --silent because we don't want to record it for future runs. -# Also quote any args containing shell meta-characters. -# Make two passes to allow for proper duplicate-argument suppression. -ac_configure_args= -ac_configure_args0= -ac_configure_args1= -ac_must_keep_next=false -for ac_pass in 1 2 -do - for ac_arg - do - case $ac_arg in - -no-create | --no-c* | -n | -no-recursion | --no-r*) continue ;; - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil) - continue ;; - *\'*) - ac_arg=`$as_echo "$ac_arg" | sed "s/'/'\\\\\\\\''/g"` ;; - esac - case $ac_pass in - 1) as_fn_append ac_configure_args0 " '$ac_arg'" ;; - 2) - as_fn_append ac_configure_args1 " '$ac_arg'" - if test $ac_must_keep_next = true; then - ac_must_keep_next=false # Got value, back to normal. - else - case $ac_arg in - *=* | --config-cache | -C | -disable-* | --disable-* \ - | -enable-* | --enable-* | -gas | --g* | -nfp | --nf* \ - | -q | -quiet | --q* | -silent | --sil* | -v | -verb* \ - | -with-* | --with-* | -without-* | --without-* | --x) - case "$ac_configure_args0 " in - "$ac_configure_args1"*" '$ac_arg' "* ) continue ;; - esac - ;; - -* ) ac_must_keep_next=true ;; - esac - fi - as_fn_append ac_configure_args " '$ac_arg'" - ;; - esac - done -done -{ ac_configure_args0=; unset ac_configure_args0;} -{ ac_configure_args1=; unset ac_configure_args1;} - -# When interrupted or exit'd, cleanup temporary files, and complete -# config.log. We remove comments because anyway the quotes in there -# would cause problems or look ugly. -# WARNING: Use '\'' to represent an apostrophe within the trap. -# WARNING: Do not start the trap code with a newline, due to a FreeBSD 4.0 bug. -trap 'exit_status=$? - # Save into config.log some information that might help in debugging. - { - echo - - cat <<\_ASBOX -## ---------------- ## -## Cache variables. ## -## ---------------- ## -_ASBOX - echo - # The following way of writing the cache mishandles newlines in values, -( - for ac_var in `(set) 2>&1 | sed -n '\''s/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'\''`; do - eval ac_val=\$$ac_var - case $ac_val in #( - *${as_nl}*) - case $ac_var in #( - *_cv_*) { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 -$as_echo "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; - esac - case $ac_var in #( - _ | IFS | as_nl) ;; #( - BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( - *) { eval $ac_var=; unset $ac_var;} ;; - esac ;; - esac - done - (set) 2>&1 | - case $as_nl`(ac_space='\'' '\''; set) 2>&1` in #( - *${as_nl}ac_space=\ *) - sed -n \ - "s/'\''/'\''\\\\'\'''\''/g; - s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\''\\2'\''/p" - ;; #( - *) - sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" - ;; - esac | - sort -) - echo - - cat <<\_ASBOX -## ----------------- ## -## Output variables. ## -## ----------------- ## -_ASBOX - echo - for ac_var in $ac_subst_vars - do - eval ac_val=\$$ac_var - case $ac_val in - *\'\''*) ac_val=`$as_echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; - esac - $as_echo "$ac_var='\''$ac_val'\''" - done | sort - echo - - if test -n "$ac_subst_files"; then - cat <<\_ASBOX -## ------------------- ## -## File substitutions. ## -## ------------------- ## -_ASBOX - echo - for ac_var in $ac_subst_files - do - eval ac_val=\$$ac_var - case $ac_val in - *\'\''*) ac_val=`$as_echo "$ac_val" | sed "s/'\''/'\''\\\\\\\\'\'''\''/g"`;; - esac - $as_echo "$ac_var='\''$ac_val'\''" - done | sort - echo - fi - - if test -s confdefs.h; then - cat <<\_ASBOX -## ----------- ## -## confdefs.h. ## -## ----------- ## -_ASBOX - echo - cat confdefs.h - echo - fi - test "$ac_signal" != 0 && - $as_echo "$as_me: caught signal $ac_signal" - $as_echo "$as_me: exit $exit_status" - } >&5 - rm -f core *.core core.conftest.* && - rm -f -r conftest* confdefs* conf$$* $ac_clean_files && - exit $exit_status -' 0 -for ac_signal in 1 2 13 15; do - trap 'ac_signal='$ac_signal'; as_fn_exit 1' $ac_signal -done -ac_signal=0 - -# confdefs.h avoids OS command line length limits that DEFS can exceed. -rm -f -r conftest* confdefs.h - -$as_echo "/* confdefs.h */" > confdefs.h - -# Predefined preprocessor variables. - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_NAME "$PACKAGE_NAME" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_TARNAME "$PACKAGE_TARNAME" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_VERSION "$PACKAGE_VERSION" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_STRING "$PACKAGE_STRING" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_BUGREPORT "$PACKAGE_BUGREPORT" -_ACEOF - -cat >>confdefs.h <<_ACEOF -#define PACKAGE_URL "$PACKAGE_URL" -_ACEOF - - -# Let the site file select an alternate cache file if it wants to. -# Prefer an explicitly selected file to automatically selected ones. -ac_site_file1=NONE -ac_site_file2=NONE -if test -n "$CONFIG_SITE"; then - ac_site_file1=$CONFIG_SITE -elif test "x$prefix" != xNONE; then - ac_site_file1=$prefix/share/config.site - ac_site_file2=$prefix/etc/config.site -else - ac_site_file1=$ac_default_prefix/share/config.site - ac_site_file2=$ac_default_prefix/etc/config.site -fi -for ac_site_file in "$ac_site_file1" "$ac_site_file2" -do - test "x$ac_site_file" = xNONE && continue - if test /dev/null != "$ac_site_file" && test -r "$ac_site_file"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: loading site script $ac_site_file" >&5 -$as_echo "$as_me: loading site script $ac_site_file" >&6;} - sed 's/^/| /' "$ac_site_file" >&5 - . "$ac_site_file" - fi -done - -if test -r "$cache_file"; then - # Some versions of bash will fail to source /dev/null (special files - # actually), so we avoid doing that. DJGPP emulates it as a regular file. - if test /dev/null != "$cache_file" && test -f "$cache_file"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: loading cache $cache_file" >&5 -$as_echo "$as_me: loading cache $cache_file" >&6;} - case $cache_file in - [\\/]* | ?:[\\/]* ) . "$cache_file";; - *) . "./$cache_file";; - esac - fi -else - { $as_echo "$as_me:${as_lineno-$LINENO}: creating cache $cache_file" >&5 -$as_echo "$as_me: creating cache $cache_file" >&6;} - >$cache_file -fi - -# Check that the precious variables saved in the cache have kept the same -# value. -ac_cache_corrupted=false -for ac_var in $ac_precious_vars; do - eval ac_old_set=\$ac_cv_env_${ac_var}_set - eval ac_new_set=\$ac_env_${ac_var}_set - eval ac_old_val=\$ac_cv_env_${ac_var}_value - eval ac_new_val=\$ac_env_${ac_var}_value - case $ac_old_set,$ac_new_set in - set,) - { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&5 -$as_echo "$as_me: error: \`$ac_var' was set to \`$ac_old_val' in the previous run" >&2;} - ac_cache_corrupted=: ;; - ,set) - { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' was not set in the previous run" >&5 -$as_echo "$as_me: error: \`$ac_var' was not set in the previous run" >&2;} - ac_cache_corrupted=: ;; - ,);; - *) - if test "x$ac_old_val" != "x$ac_new_val"; then - # differences in whitespace do not lead to failure. - ac_old_val_w=`echo x $ac_old_val` - ac_new_val_w=`echo x $ac_new_val` - if test "$ac_old_val_w" != "$ac_new_val_w"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: error: \`$ac_var' has changed since the previous run:" >&5 -$as_echo "$as_me: error: \`$ac_var' has changed since the previous run:" >&2;} - ac_cache_corrupted=: - else - { $as_echo "$as_me:${as_lineno-$LINENO}: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&5 -$as_echo "$as_me: warning: ignoring whitespace changes in \`$ac_var' since the previous run:" >&2;} - eval $ac_var=\$ac_old_val - fi - { $as_echo "$as_me:${as_lineno-$LINENO}: former value: \`$ac_old_val'" >&5 -$as_echo "$as_me: former value: \`$ac_old_val'" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: current value: \`$ac_new_val'" >&5 -$as_echo "$as_me: current value: \`$ac_new_val'" >&2;} - fi;; - esac - # Pass precious variables to config.status. - if test "$ac_new_set" = set; then - case $ac_new_val in - *\'*) ac_arg=$ac_var=`$as_echo "$ac_new_val" | sed "s/'/'\\\\\\\\''/g"` ;; - *) ac_arg=$ac_var=$ac_new_val ;; - esac - case " $ac_configure_args " in - *" '$ac_arg' "*) ;; # Avoid dups. Use of quotes ensures accuracy. - *) as_fn_append ac_configure_args " '$ac_arg'" ;; - esac - fi -done -if $ac_cache_corrupted; then - { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} - { $as_echo "$as_me:${as_lineno-$LINENO}: error: changes in the environment can compromise the build" >&5 -$as_echo "$as_me: error: changes in the environment can compromise the build" >&2;} - as_fn_error "run \`make distclean' and/or \`rm $cache_file' and start over" "$LINENO" 5 -fi -## -------------------- ## -## Main body of script. ## -## -------------------- ## - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - - - -# Checks for programs. -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu -if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}gcc", so it can be a program name with args. -set dummy ${ac_tool_prefix}gcc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_CC="${ac_tool_prefix}gcc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_prog_CC"; then - ac_ct_CC=$CC - # Extract the first word of "gcc", so it can be a program name with args. -set dummy gcc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_ac_ct_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$ac_ct_CC"; then - ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_ac_ct_CC="gcc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -ac_ct_CC=$ac_cv_prog_ac_ct_CC -if test -n "$ac_ct_CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 -$as_echo "$ac_ct_CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_ct_CC" = x; then - CC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - CC=$ac_ct_CC - fi -else - CC="$ac_cv_prog_CC" -fi - -if test -z "$CC"; then - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}cc", so it can be a program name with args. -set dummy ${ac_tool_prefix}cc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_CC="${ac_tool_prefix}cc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - - fi -fi -if test -z "$CC"; then - # Extract the first word of "cc", so it can be a program name with args. -set dummy cc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else - ac_prog_rejected=no -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - if test "$as_dir/$ac_word$ac_exec_ext" = "/usr/ucb/cc"; then - ac_prog_rejected=yes - continue - fi - ac_cv_prog_CC="cc" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -if test $ac_prog_rejected = yes; then - # We found a bogon in the path, so make sure we never use it. - set dummy $ac_cv_prog_CC - shift - if test $# != 0; then - # We chose a different compiler from the bogus one. - # However, it has the same basename, so the bogon will be chosen - # first if we set CC to just the basename; use the full file name. - shift - ac_cv_prog_CC="$as_dir/$ac_word${1+' '}$@" - fi -fi -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$CC"; then - if test -n "$ac_tool_prefix"; then - for ac_prog in cl.exe - do - # Extract the first word of "$ac_tool_prefix$ac_prog", so it can be a program name with args. -set dummy $ac_tool_prefix$ac_prog; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$CC"; then - ac_cv_prog_CC="$CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_CC="$ac_tool_prefix$ac_prog" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -CC=$ac_cv_prog_CC -if test -n "$CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $CC" >&5 -$as_echo "$CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - - test -n "$CC" && break - done -fi -if test -z "$CC"; then - ac_ct_CC=$CC - for ac_prog in cl.exe -do - # Extract the first word of "$ac_prog", so it can be a program name with args. -set dummy $ac_prog; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_prog_ac_ct_CC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -n "$ac_ct_CC"; then - ac_cv_prog_ac_ct_CC="$ac_ct_CC" # Let the user override the test. -else -as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_prog_ac_ct_CC="$ac_prog" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - -fi -fi -ac_ct_CC=$ac_cv_prog_ac_ct_CC -if test -n "$ac_ct_CC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_ct_CC" >&5 -$as_echo "$ac_ct_CC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - - test -n "$ac_ct_CC" && break -done - - if test "x$ac_ct_CC" = x; then - CC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - CC=$ac_ct_CC - fi -fi - -fi - - -test -z "$CC" && { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "no acceptable C compiler found in \$PATH -See \`config.log' for more details." "$LINENO" 5; } - -# Provide some information about the compiler. -$as_echo "$as_me:${as_lineno-$LINENO}: checking for C compiler version" >&5 -set X $ac_compile -ac_compiler=$2 -for ac_option in --version -v -V -qversion; do - { { ac_try="$ac_compiler $ac_option >&5" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_compiler $ac_option >&5") 2>conftest.err - ac_status=$? - if test -s conftest.err; then - sed '10a\ -... rest of stderr output deleted ... - 10q' conftest.err >conftest.er1 - cat conftest.er1 >&5 - fi - rm -f conftest.er1 conftest.err - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } -done - -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -ac_clean_files_save=$ac_clean_files -ac_clean_files="$ac_clean_files a.out a.out.dSYM a.exe b.out" -# Try to create an executable without -o first, disregard a.out. -# It will help us diagnose broken compilers, and finding out an intuition -# of exeext. -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether the C compiler works" >&5 -$as_echo_n "checking whether the C compiler works... " >&6; } -ac_link_default=`$as_echo "$ac_link" | sed 's/ -o *conftest[^ ]*//'` - -# The possible output files: -ac_files="a.out conftest.exe conftest a.exe a_out.exe b.out conftest.*" - -ac_rmfiles= -for ac_file in $ac_files -do - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) ;; - * ) ac_rmfiles="$ac_rmfiles $ac_file";; - esac -done -rm -f $ac_rmfiles - -if { { ac_try="$ac_link_default" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link_default") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; then : - # Autoconf-2.13 could set the ac_cv_exeext variable to `no'. -# So ignore a value of `no', otherwise this would lead to `EXEEXT = no' -# in a Makefile. We should not override ac_cv_exeext if it was cached, -# so that the user can short-circuit this test for compilers unknown to -# Autoconf. -for ac_file in $ac_files '' -do - test -f "$ac_file" || continue - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) - ;; - [ab].out ) - # We found the default executable, but exeext='' is most - # certainly right. - break;; - *.* ) - if test "${ac_cv_exeext+set}" = set && test "$ac_cv_exeext" != no; - then :; else - ac_cv_exeext=`expr "$ac_file" : '[^.]*\(\..*\)'` - fi - # We set ac_cv_exeext here because the later test for it is not - # safe: cross compilers may not add the suffix if given an `-o' - # argument, so we may need to know it at that point already. - # Even if this section looks crufty: it has the advantage of - # actually working. - break;; - * ) - break;; - esac -done -test "$ac_cv_exeext" = no && ac_cv_exeext= - -else - ac_file='' -fi -if test -z "$ac_file"; then : - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -$as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - -{ { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -{ as_fn_set_status 77 -as_fn_error "C compiler cannot create executables -See \`config.log' for more details." "$LINENO" 5; }; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5 -$as_echo "yes" >&6; } -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for C compiler default output file name" >&5 -$as_echo_n "checking for C compiler default output file name... " >&6; } -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_file" >&5 -$as_echo "$ac_file" >&6; } -ac_exeext=$ac_cv_exeext - -rm -f -r a.out a.out.dSYM a.exe conftest$ac_cv_exeext b.out -ac_clean_files=$ac_clean_files_save -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for suffix of executables" >&5 -$as_echo_n "checking for suffix of executables... " >&6; } -if { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; then : - # If both `conftest.exe' and `conftest' are `present' (well, observable) -# catch `conftest.exe'. For instance with Cygwin, `ls conftest' will -# work properly (i.e., refer to `conftest.exe'), while it won't with -# `rm'. -for ac_file in conftest.exe conftest conftest.*; do - test -f "$ac_file" || continue - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM | *.o | *.obj ) ;; - *.* ) ac_cv_exeext=`expr "$ac_file" : '[^.]*\(\..*\)'` - break;; - * ) break;; - esac -done -else - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot compute suffix of executables: cannot compile and link -See \`config.log' for more details." "$LINENO" 5; } -fi -rm -f conftest conftest$ac_cv_exeext -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_exeext" >&5 -$as_echo "$ac_cv_exeext" >&6; } - -rm -f conftest.$ac_ext -EXEEXT=$ac_cv_exeext -ac_exeext=$EXEEXT -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -int -main () -{ -FILE *f = fopen ("conftest.out", "w"); - return ferror (f) || fclose (f) != 0; - - ; - return 0; -} -_ACEOF -ac_clean_files="$ac_clean_files conftest.out" -# Check that the compiler produces executables we can run. If not, either -# the compiler is broken, or we cross compile. -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether we are cross compiling" >&5 -$as_echo_n "checking whether we are cross compiling... " >&6; } -if test "$cross_compiling" != yes; then - { { ac_try="$ac_link" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_link") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; } - if { ac_try='./conftest$ac_cv_exeext' - { { case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_try") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; }; then - cross_compiling=no - else - if test "$cross_compiling" = maybe; then - cross_compiling=yes - else - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot run C compiled programs. -If you meant to cross compile, use \`--host'. -See \`config.log' for more details." "$LINENO" 5; } - fi - fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $cross_compiling" >&5 -$as_echo "$cross_compiling" >&6; } - -rm -f conftest.$ac_ext conftest$ac_cv_exeext conftest.out -ac_clean_files=$ac_clean_files_save -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for suffix of object files" >&5 -$as_echo_n "checking for suffix of object files... " >&6; } -if test "${ac_cv_objext+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -rm -f conftest.o conftest.obj -if { { ac_try="$ac_compile" -case "(($ac_try" in - *\"* | *\`* | *\\*) ac_try_echo=\$ac_try;; - *) ac_try_echo=$ac_try;; -esac -eval ac_try_echo="\"\$as_me:${as_lineno-$LINENO}: $ac_try_echo\"" -$as_echo "$ac_try_echo"; } >&5 - (eval "$ac_compile") 2>&5 - ac_status=$? - $as_echo "$as_me:${as_lineno-$LINENO}: \$? = $ac_status" >&5 - test $ac_status = 0; }; then : - for ac_file in conftest.o conftest.obj conftest.*; do - test -f "$ac_file" || continue; - case $ac_file in - *.$ac_ext | *.xcoff | *.tds | *.d | *.pdb | *.xSYM | *.bb | *.bbg | *.map | *.inf | *.dSYM ) ;; - *) ac_cv_objext=`expr "$ac_file" : '.*\.\(.*\)'` - break;; - esac -done -else - $as_echo "$as_me: failed program was:" >&5 -sed 's/^/| /' conftest.$ac_ext >&5 - -{ { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot compute suffix of object files: cannot compile -See \`config.log' for more details." "$LINENO" 5; } -fi -rm -f conftest.$ac_cv_objext conftest.$ac_ext -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_objext" >&5 -$as_echo "$ac_cv_objext" >&6; } -OBJEXT=$ac_cv_objext -ac_objext=$OBJEXT -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether we are using the GNU C compiler" >&5 -$as_echo_n "checking whether we are using the GNU C compiler... " >&6; } -if test "${ac_cv_c_compiler_gnu+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ -#ifndef __GNUC__ - choke me -#endif - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_compiler_gnu=yes -else - ac_compiler_gnu=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -ac_cv_c_compiler_gnu=$ac_compiler_gnu - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_c_compiler_gnu" >&5 -$as_echo "$ac_cv_c_compiler_gnu" >&6; } -if test $ac_compiler_gnu = yes; then - GCC=yes -else - GCC= -fi -ac_test_CFLAGS=${CFLAGS+set} -ac_save_CFLAGS=$CFLAGS -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether $CC accepts -g" >&5 -$as_echo_n "checking whether $CC accepts -g... " >&6; } -if test "${ac_cv_prog_cc_g+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_save_c_werror_flag=$ac_c_werror_flag - ac_c_werror_flag=yes - ac_cv_prog_cc_g=no - CFLAGS="-g" - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_prog_cc_g=yes -else - CFLAGS="" - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - -else - ac_c_werror_flag=$ac_save_c_werror_flag - CFLAGS="-g" - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_prog_cc_g=yes -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext - ac_c_werror_flag=$ac_save_c_werror_flag -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_g" >&5 -$as_echo "$ac_cv_prog_cc_g" >&6; } -if test "$ac_test_CFLAGS" = set; then - CFLAGS=$ac_save_CFLAGS -elif test $ac_cv_prog_cc_g = yes; then - if test "$GCC" = yes; then - CFLAGS="-g -O2" - else - CFLAGS="-g" - fi -else - if test "$GCC" = yes; then - CFLAGS="-O2" - else - CFLAGS= - fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $CC option to accept ISO C89" >&5 -$as_echo_n "checking for $CC option to accept ISO C89... " >&6; } -if test "${ac_cv_prog_cc_c89+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_cv_prog_cc_c89=no -ac_save_CC=$CC -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -#include -#include -#include -/* Most of the following tests are stolen from RCS 5.7's src/conf.sh. */ -struct buf { int x; }; -FILE * (*rcsopen) (struct buf *, struct stat *, int); -static char *e (p, i) - char **p; - int i; -{ - return p[i]; -} -static char *f (char * (*g) (char **, int), char **p, ...) -{ - char *s; - va_list v; - va_start (v,p); - s = g (p, va_arg (v,int)); - va_end (v); - return s; -} - -/* OSF 4.0 Compaq cc is some sort of almost-ANSI by default. It has - function prototypes and stuff, but not '\xHH' hex character constants. - These don't provoke an error unfortunately, instead are silently treated - as 'x'. The following induces an error, until -std is added to get - proper ANSI mode. Curiously '\x00'!='x' always comes out true, for an - array size at least. It's necessary to write '\x00'==0 to get something - that's true only with -std. */ -int osf4_cc_array ['\x00' == 0 ? 1 : -1]; - -/* IBM C 6 for AIX is almost-ANSI by default, but it replaces macro parameters - inside strings and character constants. */ -#define FOO(x) 'x' -int xlc6_cc_array[FOO(a) == 'x' ? 1 : -1]; - -int test (int i, double x); -struct s1 {int (*f) (int a);}; -struct s2 {int (*f) (double a);}; -int pairnames (int, char **, FILE *(*)(struct buf *, struct stat *, int), int, int); -int argc; -char **argv; -int -main () -{ -return f (e, argv, 0) != argv[0] || f (e, argv, 1) != argv[1]; - ; - return 0; -} -_ACEOF -for ac_arg in '' -qlanglvl=extc89 -qlanglvl=ansi -std \ - -Ae "-Aa -D_HPUX_SOURCE" "-Xc -D__EXTENSIONS__" -do - CC="$ac_save_CC $ac_arg" - if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_prog_cc_c89=$ac_arg -fi -rm -f core conftest.err conftest.$ac_objext - test "x$ac_cv_prog_cc_c89" != "xno" && break -done -rm -f conftest.$ac_ext -CC=$ac_save_CC - -fi -# AC_CACHE_VAL -case "x$ac_cv_prog_cc_c89" in - x) - { $as_echo "$as_me:${as_lineno-$LINENO}: result: none needed" >&5 -$as_echo "none needed" >&6; } ;; - xno) - { $as_echo "$as_me:${as_lineno-$LINENO}: result: unsupported" >&5 -$as_echo "unsupported" >&6; } ;; - *) - CC="$CC $ac_cv_prog_cc_c89" - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_prog_cc_c89" >&5 -$as_echo "$ac_cv_prog_cc_c89" >&6; } ;; -esac -if test "x$ac_cv_prog_cc_c89" != xno; then : - -fi - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether ${MAKE-make} sets \$(MAKE)" >&5 -$as_echo_n "checking whether ${MAKE-make} sets \$(MAKE)... " >&6; } -set x ${MAKE-make} -ac_make=`$as_echo "$2" | sed 's/+/p/g; s/[^a-zA-Z0-9_]/_/g'` -if { as_var=ac_cv_prog_make_${ac_make}_set; eval "test \"\${$as_var+set}\" = set"; }; then : - $as_echo_n "(cached) " >&6 -else - cat >conftest.make <<\_ACEOF -SHELL = /bin/sh -all: - @echo '@@@%%%=$(MAKE)=@@@%%%' -_ACEOF -# GNU make sometimes prints "make[1]: Entering...", which would confuse us. -case `${MAKE-make} -f conftest.make 2>/dev/null` in - *@@@%%%=?*=@@@%%%*) - eval ac_cv_prog_make_${ac_make}_set=yes;; - *) - eval ac_cv_prog_make_${ac_make}_set=no;; -esac -rm -f conftest.make -fi -if eval test \$ac_cv_prog_make_${ac_make}_set = yes; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: yes" >&5 -$as_echo "yes" >&6; } - SET_MAKE= -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } - SET_MAKE="MAKE=${MAKE-make}" -fi - - -if test "x$GCC" = "xyes"; then - CFLAGS="$CFLAGS -Wall" -fi - -#locating erlang - -# Check whether --with-erlang was given. -if test "${with_erlang+set}" = set; then : - withval=$with_erlang; -fi - - - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}erlc", so it can be a program name with args. -set dummy ${ac_tool_prefix}erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ERLC="$ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ERLC=$ac_cv_path_ERLC -if test -n "$ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERLC" >&5 -$as_echo "$ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_path_ERLC"; then - ac_pt_ERLC=$ERLC - # Extract the first word of "erlc", so it can be a program name with args. -set dummy erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ac_pt_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ac_pt_ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ac_pt_ERLC="$ac_pt_ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ac_pt_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ac_pt_ERLC=$ac_cv_path_ac_pt_ERLC -if test -n "$ac_pt_ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_pt_ERLC" >&5 -$as_echo "$ac_pt_ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_pt_ERLC" = x; then - ERLC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - ERLC=$ac_pt_ERLC - fi -else - ERLC="$ac_cv_path_ERLC" -fi - - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}erl", so it can be a program name with args. -set dummy ${ac_tool_prefix}erl; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ERL+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ERL in - [\\/]* | ?:[\\/]*) - ac_cv_path_ERL="$ERL" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ERL="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ERL=$ac_cv_path_ERL -if test -n "$ERL"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERL" >&5 -$as_echo "$ERL" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_path_ERL"; then - ac_pt_ERL=$ERL - # Extract the first word of "erl", so it can be a program name with args. -set dummy erl; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ac_pt_ERL+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ac_pt_ERL in - [\\/]* | ?:[\\/]*) - ac_cv_path_ac_pt_ERL="$ac_pt_ERL" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -as_dummy="$with_erlang:$with_erlang/bin:$PATH" -for as_dir in $as_dummy -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ac_pt_ERL="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ac_pt_ERL=$ac_cv_path_ac_pt_ERL -if test -n "$ac_pt_ERL"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_pt_ERL" >&5 -$as_echo "$ac_pt_ERL" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_pt_ERL" = x; then - ERL="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - ERL=$ac_pt_ERL - fi -else - ERL="$ac_cv_path_ERL" -fi - - - if test "z$ERLC" = "z" || test "z$ERL" = "z"; then - as_fn_error "erlang not found" "$LINENO" 5 - fi - - - cat >>conftest.erl <<_EOF - --module(conftest). --author('alexey@sevcom.net'). - --export([start/0]). - -start() -> - EIDirS = code:lib_dir("erl_interface") ++ "\n", - EILibS = libpath("erl_interface") ++ "\n", - EXMPPDir = code:lib_dir("exmpp"), - case EXMPPDir of - {error, bad_name} -> exit("exmpp not found"); - _ -> ok - end, - EXMPPDirS = EXMPPDir ++ "\n", - RootDirS = code:root_dir() ++ "\n", - file:write_file("conftest.out", list_to_binary(EIDirS ++ EILibS ++ EXMPPDirS ++ RootDirS)), - halt(). - -%% return physical architecture based on OS/Processor -archname() -> - ArchStr = erlang:system_info(system_architecture), - case os:type() of - {win32, _} -> "windows"; - {unix,UnixName} -> - Specs = string:tokens(ArchStr,"-"), - Cpu = case lists:nth(2,Specs) of - "pc" -> "x86"; - _ -> hd(Specs) - end, - atom_to_list(UnixName) ++ "-" ++ Cpu; - _ -> "generic" - end. - -%% Return arch-based library path or a default value if this directory -%% does not exist -libpath(App) -> - PrivDir = code:priv_dir(App), - ArchDir = archname(), - LibArchDir = filename:join([PrivDir,"lib",ArchDir]), - case file:list_dir(LibArchDir) of - %% Arch lib dir exists: We use it - {ok, _List} -> LibArchDir; - %% Arch lib dir does not exist: Return the default value - %% ({error, enoent}): - _Error -> code:lib_dir("erl_interface") ++ "/lib" - end. - -_EOF - - if ! $ERLC conftest.erl; then - as_fn_error "could not compile sample program" "$LINENO" 5 - fi - - if ! $ERL -s conftest -noshell; then - as_fn_error "could not run sample program" "$LINENO" 5 - fi - - if ! test -f conftest.out; then - as_fn_error "erlang program was not properly executed, (conftest.out was not produced)" "$LINENO" 5 - fi - - # First line - ERLANG_EI_DIR=`cat conftest.out | head -n 1` - # Second line - ERLANG_EI_LIB=`cat conftest.out | head -n 2 | tail -n 1` - # Third line - ERLANG_EXMPP=`cat conftest.out | head -n 3 | tail -n 1` - # End line - ERLANG_DIR=`cat conftest.out | tail -n 1` - - ERLANG_CFLAGS="-I$ERLANG_EI_DIR/include -I$ERLANG_DIR/usr/include" - ERLANG_LIBS="-L$ERLANG_EI_LIB -lerl_interface -lei" - - - - - - - - -# Checks for typedefs, structures, and compiler characteristics. - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for an ANSI C-conforming const" >&5 -$as_echo_n "checking for an ANSI C-conforming const... " >&6; } -if test "${ac_cv_c_const+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -int -main () -{ -/* FIXME: Include the comments suggested by Paul. */ -#ifndef __cplusplus - /* Ultrix mips cc rejects this. */ - typedef int charset[2]; - const charset cs; - /* SunOS 4.1.1 cc rejects this. */ - char const *const *pcpcc; - char **ppc; - /* NEC SVR4.0.2 mips cc rejects this. */ - struct point {int x, y;}; - static struct point const zero = {0,0}; - /* AIX XL C 1.02.0.0 rejects this. - It does not let you subtract one const X* pointer from another in - an arm of an if-expression whose if-part is not a constant - expression */ - const char *g = "string"; - pcpcc = &g + (g ? g-g : 0); - /* HPUX 7.0 cc rejects these. */ - ++pcpcc; - ppc = (char**) pcpcc; - pcpcc = (char const *const *) ppc; - { /* SCO 3.2v4 cc rejects this. */ - char *t; - char const *s = 0 ? (char *) 0 : (char const *) 0; - - *t++ = 0; - if (s) return 0; - } - { /* Someone thinks the Sun supposedly-ANSI compiler will reject this. */ - int x[] = {25, 17}; - const int *foo = &x[0]; - ++foo; - } - { /* Sun SC1.0 ANSI compiler rejects this -- but not the above. */ - typedef const int *iptr; - iptr p = 0; - ++p; - } - { /* AIX XL C 1.02.0.0 rejects this saying - "k.c", line 2.27: 1506-025 (S) Operand must be a modifiable lvalue. */ - struct s { int j; const int *ap[3]; }; - struct s *b; b->j = 5; - } - { /* ULTRIX-32 V3.1 (Rev 9) vcc rejects this */ - const int foo = 10; - if (!foo) return 0; - } - return !cs[0] && !zero.x; -#endif - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_c_const=yes -else - ac_cv_c_const=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_c_const" >&5 -$as_echo "$ac_cv_c_const" >&6; } -if test $ac_cv_c_const = no; then - -$as_echo "#define const /**/" >>confdefs.h - -fi - - -# Check Erlang headers are installed -#AC_CHECK_HEADER(erl_driver.h,,[AC_MSG_ERROR([cannot find Erlang header files])]) - -# Change default prefix - - -# Checks for library functions. -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking how to run the C preprocessor" >&5 -$as_echo_n "checking how to run the C preprocessor... " >&6; } -# On Suns, sometimes $CPP names a directory. -if test -n "$CPP" && test -d "$CPP"; then - CPP= -fi -if test -z "$CPP"; then - if test "${ac_cv_prog_CPP+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - # Double quotes because CPP needs to be expanded - for CPP in "$CC -E" "$CC -E -traditional-cpp" "/lib/cpp" - do - ac_preproc_ok=false -for ac_c_preproc_warn_flag in '' yes -do - # Use a header file that comes with gcc, so configuring glibc - # with a fresh cross-compiler works. - # Prefer to if __STDC__ is defined, since - # exists even on freestanding compilers. - # On the NeXT, cc -E runs the code through the compiler's parser, - # not just through cpp. "Syntax error" is here to catch this case. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#ifdef __STDC__ -# include -#else -# include -#endif - Syntax error -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - -else - # Broken: fails on valid input. -continue -fi -rm -f conftest.err conftest.$ac_ext - - # OK, works on sane cases. Now check whether nonexistent headers - # can be detected and how. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - # Broken: success on invalid input. -continue -else - # Passes both tests. -ac_preproc_ok=: -break -fi -rm -f conftest.err conftest.$ac_ext - -done -# Because of `break', _AC_PREPROC_IFELSE's cleaning code was skipped. -rm -f conftest.err conftest.$ac_ext -if $ac_preproc_ok; then : - break -fi - - done - ac_cv_prog_CPP=$CPP - -fi - CPP=$ac_cv_prog_CPP -else - ac_cv_prog_CPP=$CPP -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $CPP" >&5 -$as_echo "$CPP" >&6; } -ac_preproc_ok=false -for ac_c_preproc_warn_flag in '' yes -do - # Use a header file that comes with gcc, so configuring glibc - # with a fresh cross-compiler works. - # Prefer to if __STDC__ is defined, since - # exists even on freestanding compilers. - # On the NeXT, cc -E runs the code through the compiler's parser, - # not just through cpp. "Syntax error" is here to catch this case. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#ifdef __STDC__ -# include -#else -# include -#endif - Syntax error -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - -else - # Broken: fails on valid input. -continue -fi -rm -f conftest.err conftest.$ac_ext - - # OK, works on sane cases. Now check whether nonexistent headers - # can be detected and how. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -_ACEOF -if ac_fn_c_try_cpp "$LINENO"; then : - # Broken: success on invalid input. -continue -else - # Passes both tests. -ac_preproc_ok=: -break -fi -rm -f conftest.err conftest.$ac_ext - -done -# Because of `break', _AC_PREPROC_IFELSE's cleaning code was skipped. -rm -f conftest.err conftest.$ac_ext -if $ac_preproc_ok; then : - -else - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "C preprocessor \"$CPP\" fails sanity check -See \`config.log' for more details." "$LINENO" 5; } -fi - -ac_ext=c -ac_cpp='$CPP $CPPFLAGS' -ac_compile='$CC -c $CFLAGS $CPPFLAGS conftest.$ac_ext >&5' -ac_link='$CC -o conftest$ac_exeext $CFLAGS $CPPFLAGS $LDFLAGS conftest.$ac_ext $LIBS >&5' -ac_compiler_gnu=$ac_cv_c_compiler_gnu - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for grep that handles long lines and -e" >&5 -$as_echo_n "checking for grep that handles long lines and -e... " >&6; } -if test "${ac_cv_path_GREP+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test -z "$GREP"; then - ac_path_GREP_found=false - # Loop through the user's path and test for each of PROGNAME-LIST - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH$PATH_SEPARATOR/usr/xpg4/bin -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_prog in grep ggrep; do - for ac_exec_ext in '' $ac_executable_extensions; do - ac_path_GREP="$as_dir/$ac_prog$ac_exec_ext" - { test -f "$ac_path_GREP" && $as_test_x "$ac_path_GREP"; } || continue -# Check for GNU ac_path_GREP and select it if it is found. - # Check for GNU $ac_path_GREP -case `"$ac_path_GREP" --version 2>&1` in -*GNU*) - ac_cv_path_GREP="$ac_path_GREP" ac_path_GREP_found=:;; -*) - ac_count=0 - $as_echo_n 0123456789 >"conftest.in" - while : - do - cat "conftest.in" "conftest.in" >"conftest.tmp" - mv "conftest.tmp" "conftest.in" - cp "conftest.in" "conftest.nl" - $as_echo 'GREP' >> "conftest.nl" - "$ac_path_GREP" -e 'GREP$' -e '-(cannot match)-' < "conftest.nl" >"conftest.out" 2>/dev/null || break - diff "conftest.out" "conftest.nl" >/dev/null 2>&1 || break - as_fn_arith $ac_count + 1 && ac_count=$as_val - if test $ac_count -gt ${ac_path_GREP_max-0}; then - # Best one so far, save it but keep looking for a better one - ac_cv_path_GREP="$ac_path_GREP" - ac_path_GREP_max=$ac_count - fi - # 10*(2^10) chars as input seems more than enough - test $ac_count -gt 10 && break - done - rm -f conftest.in conftest.tmp conftest.nl conftest.out;; -esac - - $ac_path_GREP_found && break 3 - done - done - done -IFS=$as_save_IFS - if test -z "$ac_cv_path_GREP"; then - as_fn_error "no acceptable grep could be found in $PATH$PATH_SEPARATOR/usr/xpg4/bin" "$LINENO" 5 - fi -else - ac_cv_path_GREP=$GREP -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_path_GREP" >&5 -$as_echo "$ac_cv_path_GREP" >&6; } - GREP="$ac_cv_path_GREP" - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for egrep" >&5 -$as_echo_n "checking for egrep... " >&6; } -if test "${ac_cv_path_EGREP+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if echo a | $GREP -E '(a|b)' >/dev/null 2>&1 - then ac_cv_path_EGREP="$GREP -E" - else - if test -z "$EGREP"; then - ac_path_EGREP_found=false - # Loop through the user's path and test for each of PROGNAME-LIST - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH$PATH_SEPARATOR/usr/xpg4/bin -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_prog in egrep; do - for ac_exec_ext in '' $ac_executable_extensions; do - ac_path_EGREP="$as_dir/$ac_prog$ac_exec_ext" - { test -f "$ac_path_EGREP" && $as_test_x "$ac_path_EGREP"; } || continue -# Check for GNU ac_path_EGREP and select it if it is found. - # Check for GNU $ac_path_EGREP -case `"$ac_path_EGREP" --version 2>&1` in -*GNU*) - ac_cv_path_EGREP="$ac_path_EGREP" ac_path_EGREP_found=:;; -*) - ac_count=0 - $as_echo_n 0123456789 >"conftest.in" - while : - do - cat "conftest.in" "conftest.in" >"conftest.tmp" - mv "conftest.tmp" "conftest.in" - cp "conftest.in" "conftest.nl" - $as_echo 'EGREP' >> "conftest.nl" - "$ac_path_EGREP" 'EGREP$' < "conftest.nl" >"conftest.out" 2>/dev/null || break - diff "conftest.out" "conftest.nl" >/dev/null 2>&1 || break - as_fn_arith $ac_count + 1 && ac_count=$as_val - if test $ac_count -gt ${ac_path_EGREP_max-0}; then - # Best one so far, save it but keep looking for a better one - ac_cv_path_EGREP="$ac_path_EGREP" - ac_path_EGREP_max=$ac_count - fi - # 10*(2^10) chars as input seems more than enough - test $ac_count -gt 10 && break - done - rm -f conftest.in conftest.tmp conftest.nl conftest.out;; -esac - - $ac_path_EGREP_found && break 3 - done - done - done -IFS=$as_save_IFS - if test -z "$ac_cv_path_EGREP"; then - as_fn_error "no acceptable egrep could be found in $PATH$PATH_SEPARATOR/usr/xpg4/bin" "$LINENO" 5 - fi -else - ac_cv_path_EGREP=$EGREP -fi - - fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_path_EGREP" >&5 -$as_echo "$ac_cv_path_EGREP" >&6; } - EGREP="$ac_cv_path_EGREP" - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for ANSI C header files" >&5 -$as_echo_n "checking for ANSI C header files... " >&6; } -if test "${ac_cv_header_stdc+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -#include -#include -#include - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_header_stdc=yes -else - ac_cv_header_stdc=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext - -if test $ac_cv_header_stdc = yes; then - # SunOS 4.x string.h does not declare mem*, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "memchr" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # ISC 2.0.2 stdlib.h does not declare free, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "free" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # /bin/cc in Irix-4.0.5 gets non-ANSI ctype macros unless using -ansi. - if test "$cross_compiling" = yes; then : - : -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -#include -#if ((' ' & 0x0FF) == 0x020) -# define ISLOWER(c) ('a' <= (c) && (c) <= 'z') -# define TOUPPER(c) (ISLOWER(c) ? 'A' + ((c) - 'a') : (c)) -#else -# define ISLOWER(c) \ - (('a' <= (c) && (c) <= 'i') \ - || ('j' <= (c) && (c) <= 'r') \ - || ('s' <= (c) && (c) <= 'z')) -# define TOUPPER(c) (ISLOWER(c) ? ((c) | 0x40) : (c)) -#endif - -#define XOR(e, f) (((e) && !(f)) || (!(e) && (f))) -int -main () -{ - int i; - for (i = 0; i < 256; i++) - if (XOR (islower (i), ISLOWER (i)) - || toupper (i) != TOUPPER (i)) - return 2; - return 0; -} -_ACEOF -if ac_fn_c_try_run "$LINENO"; then : - -else - ac_cv_header_stdc=no -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - -fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_header_stdc" >&5 -$as_echo "$ac_cv_header_stdc" >&6; } -if test $ac_cv_header_stdc = yes; then - -$as_echo "#define STDC_HEADERS 1" >>confdefs.h - -fi - -# On IRIX 5.3, sys/types and inttypes.h are conflicting. -for ac_header in sys/types.h sys/stat.h stdlib.h string.h memory.h strings.h \ - inttypes.h stdint.h unistd.h -do : - as_ac_Header=`$as_echo "ac_cv_header_$ac_header" | $as_tr_sh` -ac_fn_c_check_header_compile "$LINENO" "$ac_header" "$as_ac_Header" "$ac_includes_default -" -eval as_val=\$$as_ac_Header - if test "x$as_val" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define `$as_echo "HAVE_$ac_header" | $as_tr_cpp` 1 -_ACEOF - -fi - -done - - -for ac_header in stdlib.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "stdlib.h" "ac_cv_header_stdlib_h" "$ac_includes_default" -if test "x$ac_cv_header_stdlib_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_STDLIB_H 1 -_ACEOF - -fi - -done - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for GNU libc compatible malloc" >&5 -$as_echo_n "checking for GNU libc compatible malloc... " >&6; } -if test "${ac_cv_func_malloc_0_nonnull+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test "$cross_compiling" = yes; then : - ac_cv_func_malloc_0_nonnull=no -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#if defined STDC_HEADERS || defined HAVE_STDLIB_H -# include -#else -char *malloc (); -#endif - -int -main () -{ -return ! malloc (0); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_run "$LINENO"; then : - ac_cv_func_malloc_0_nonnull=yes -else - ac_cv_func_malloc_0_nonnull=no -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_func_malloc_0_nonnull" >&5 -$as_echo "$ac_cv_func_malloc_0_nonnull" >&6; } -if test $ac_cv_func_malloc_0_nonnull = yes; then : - -$as_echo "#define HAVE_MALLOC 1" >>confdefs.h - -else - $as_echo "#define HAVE_MALLOC 0" >>confdefs.h - - case " $LIBOBJS " in - *" malloc.$ac_objext "* ) ;; - *) LIBOBJS="$LIBOBJS malloc.$ac_objext" - ;; -esac - - -$as_echo "#define malloc rpl_malloc" >>confdefs.h - -fi - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for ANSI C header files" >&5 -$as_echo_n "checking for ANSI C header files... " >&6; } -if test "${ac_cv_header_stdc+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -#include -#include -#include - -int -main () -{ - - ; - return 0; -} -_ACEOF -if ac_fn_c_try_compile "$LINENO"; then : - ac_cv_header_stdc=yes -else - ac_cv_header_stdc=no -fi -rm -f core conftest.err conftest.$ac_objext conftest.$ac_ext - -if test $ac_cv_header_stdc = yes; then - # SunOS 4.x string.h does not declare mem*, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "memchr" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # ISC 2.0.2 stdlib.h does not declare free, contrary to ANSI. - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include - -_ACEOF -if (eval "$ac_cpp conftest.$ac_ext") 2>&5 | - $EGREP "free" >/dev/null 2>&1; then : - -else - ac_cv_header_stdc=no -fi -rm -f conftest* - -fi - -if test $ac_cv_header_stdc = yes; then - # /bin/cc in Irix-4.0.5 gets non-ANSI ctype macros unless using -ansi. - if test "$cross_compiling" = yes; then : - : -else - cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ -#include -#include -#if ((' ' & 0x0FF) == 0x020) -# define ISLOWER(c) ('a' <= (c) && (c) <= 'z') -# define TOUPPER(c) (ISLOWER(c) ? 'A' + ((c) - 'a') : (c)) -#else -# define ISLOWER(c) \ - (('a' <= (c) && (c) <= 'i') \ - || ('j' <= (c) && (c) <= 'r') \ - || ('s' <= (c) && (c) <= 'z')) -# define TOUPPER(c) (ISLOWER(c) ? ((c) | 0x40) : (c)) -#endif - -#define XOR(e, f) (((e) && !(f)) || (!(e) && (f))) -int -main () -{ - int i; - for (i = 0; i < 256; i++) - if (XOR (islower (i), ISLOWER (i)) - || toupper (i) != TOUPPER (i)) - return 2; - return 0; -} -_ACEOF -if ac_fn_c_try_run "$LINENO"; then : - -else - ac_cv_header_stdc=no -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - -fi -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_header_stdc" >&5 -$as_echo "$ac_cv_header_stdc" >&6; } -if test $ac_cv_header_stdc = yes; then - -$as_echo "#define STDC_HEADERS 1" >>confdefs.h - -fi - - - -mod_muc= -make_mod_muc= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build mod_muc" >&5 -$as_echo_n "checking whether build mod_muc... " >&6; } -# Check whether --enable-mod_muc was given. -if test "${enable_mod_muc+set}" = set; then : - enableval=$enable_mod_muc; mr_enable_mod_muc="$enableval" -else - mr_enable_mod_muc=yes -fi - -if test "$mr_enable_mod_muc" = "yes"; then -mod_muc=mod_muc -make_mod_muc=mod_muc/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_mod_muc" >&5 -$as_echo "$mr_enable_mod_muc" >&6; } - - - - - -mod_proxy65= -make_mod_proxy65= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build mod_proxy65" >&5 -$as_echo_n "checking whether build mod_proxy65... " >&6; } -# Check whether --enable-mod_proxy65 was given. -if test "${enable_mod_proxy65+set}" = set; then : - enableval=$enable_mod_proxy65; mr_enable_mod_proxy65="$enableval" -else - mr_enable_mod_proxy65=yes -fi - -if test "$mr_enable_mod_proxy65" = "yes"; then -mod_proxy65=mod_proxy65 -make_mod_proxy65=mod_proxy65/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_mod_proxy65" >&5 -$as_echo "$mr_enable_mod_proxy65" >&6; } - - - - - -mod_pubsub= -make_mod_pubsub= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build mod_pubsub" >&5 -$as_echo_n "checking whether build mod_pubsub... " >&6; } -# Check whether --enable-mod_pubsub was given. -if test "${enable_mod_pubsub+set}" = set; then : - enableval=$enable_mod_pubsub; mr_enable_mod_pubsub="$enableval" -else - mr_enable_mod_pubsub=yes -fi - -if test "$mr_enable_mod_pubsub" = "yes"; then -mod_pubsub=mod_pubsub -make_mod_pubsub=mod_pubsub/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_mod_pubsub" >&5 -$as_echo "$mr_enable_mod_pubsub" >&6; } - - - - - -eldap= -make_eldap= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build eldap" >&5 -$as_echo_n "checking whether build eldap... " >&6; } -# Check whether --enable-eldap was given. -if test "${enable_eldap+set}" = set; then : - enableval=$enable_eldap; mr_enable_eldap="$enableval" -else - mr_enable_eldap=yes -fi - -if test "$mr_enable_eldap" = "yes"; then -eldap=eldap -make_eldap=eldap/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_eldap" >&5 -$as_echo "$mr_enable_eldap" >&6; } - - - - - -odbc= -make_odbc= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build odbc" >&5 -$as_echo_n "checking whether build odbc... " >&6; } -# Check whether --enable-odbc was given. -if test "${enable_odbc+set}" = set; then : - enableval=$enable_odbc; mr_enable_odbc="$enableval" -else - mr_enable_odbc=no -fi - -if test "$mr_enable_odbc" = "yes"; then -odbc=odbc -make_odbc=odbc/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_odbc" >&5 -$as_echo "$mr_enable_odbc" >&6; } - - - - - -tls= -make_tls= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build tls" >&5 -$as_echo_n "checking whether build tls... " >&6; } -# Check whether --enable-tls was given. -if test "${enable_tls+set}" = set; then : - enableval=$enable_tls; mr_enable_tls="$enableval" -else - mr_enable_tls=yes -fi - -if test "$mr_enable_tls" = "yes"; then -tls=tls -make_tls=tls/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_tls" >&5 -$as_echo "$mr_enable_tls" >&6; } - - - - - -web= -make_web= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build web" >&5 -$as_echo_n "checking whether build web... " >&6; } -# Check whether --enable-web was given. -if test "${enable_web+set}" = set; then : - enableval=$enable_web; mr_enable_web="$enableval" -else - mr_enable_web=yes -fi - -if test "$mr_enable_web" = "yes"; then -web=web -make_web=web/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_web" >&5 -$as_echo "$mr_enable_web" >&6; } - - - - - - -ejabberd_zlib= -make_ejabberd_zlib= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build ejabberd_zlib" >&5 -$as_echo_n "checking whether build ejabberd_zlib... " >&6; } -# Check whether --enable-ejabberd_zlib was given. -if test "${enable_ejabberd_zlib+set}" = set; then : - enableval=$enable_ejabberd_zlib; mr_enable_ejabberd_zlib="$enableval" -else - mr_enable_ejabberd_zlib=yes -fi - -if test "$mr_enable_ejabberd_zlib" = "yes"; then -ejabberd_zlib=ejabberd_zlib -make_ejabberd_zlib=ejabberd_zlib/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_ejabberd_zlib" >&5 -$as_echo "$mr_enable_ejabberd_zlib" >&6; } - - - - -#locating zlib - -# Check whether --with-zlib was given. -if test "${with_zlib+set}" = set; then : - withval=$with_zlib; -fi - - -if test x"$ejabberd_zlib" != x; then - ZLIB_CFLAGS= - ZLIB_LIBS= - if test x"$with_zlib" != x; then - ZLIB_CFLAGS="-I$with_zlib/include" - ZLIB_LIBS="-L$with_zlib/lib" - fi - - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for gzgets in -lz" >&5 -$as_echo_n "checking for gzgets in -lz... " >&6; } -if test "${ac_cv_lib_z_gzgets+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_check_lib_save_LIBS=$LIBS -LIBS="-lz "$ZLIB_LIBS" $LIBS" -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -/* Override any GCC internal prototype to avoid an error. - Use char because int might match the return type of a GCC - builtin and then its argument prototype would still apply. */ -#ifdef __cplusplus -extern "C" -#endif -char gzgets (); -int -main () -{ -return gzgets (); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_link "$LINENO"; then : - ac_cv_lib_z_gzgets=yes -else - ac_cv_lib_z_gzgets=no -fi -rm -f core conftest.err conftest.$ac_objext \ - conftest$ac_exeext conftest.$ac_ext -LIBS=$ac_check_lib_save_LIBS -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_z_gzgets" >&5 -$as_echo "$ac_cv_lib_z_gzgets" >&6; } -if test "x$ac_cv_lib_z_gzgets" = x""yes; then : - ZLIB_LIBS="$ZLIB_LIBS -lz" - zlib_found=yes -else - zlib_found=no -fi - - if test $zlib_found = no; then - as_fn_error "Could not find development files of zlib library. Install them or disable \`ejabberd_zlib' with: --disable-ejabberd_zlib" "$LINENO" 5 - fi - zlib_save_CFLAGS="$CFLAGS" - CFLAGS="$CFLAGS $ZLIB_CFLAGS" - zlib_save_CPPFLAGS="$CFLAGS" - CPPFLAGS="$CPPFLAGS $ZLIB_CFLAGS" - for ac_header in zlib.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "zlib.h" "ac_cv_header_zlib_h" "$ac_includes_default" -if test "x$ac_cv_header_zlib_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_ZLIB_H 1 -_ACEOF - -else - zlib_found=no -fi - -done - - if test $zlib_found = no; then - as_fn_error "Could not find zlib.h. Install it or disable \`ejabberd_zlib' with: --disable-ejabberd_zlib" "$LINENO" 5 - fi - CFLAGS="$zlib_save_CFLAGS" - CPPFLAGS="$zlib_save_CPPFLAGS" - - - -fi - - - -pam= -make_pam= -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking whether build pam" >&5 -$as_echo_n "checking whether build pam... " >&6; } -# Check whether --enable-pam was given. -if test "${enable_pam+set}" = set; then : - enableval=$enable_pam; mr_enable_pam="$enableval" -else - mr_enable_pam=no -fi - -if test "$mr_enable_pam" = "yes"; then -pam=pam -make_pam=pam/Makefile -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $mr_enable_pam" >&5 -$as_echo "$mr_enable_pam" >&6; } - - - - -#locating PAM - -# Check whether --with-pam was given. -if test "${with_pam+set}" = set; then : - withval=$with_pam; -fi - -if test x"$pam" != x; then - PAM_CFLAGS= - PAM_LIBS= - if test x"$with_pam" != x; then - PAM_CFLAGS="-I$with_pam/include" - PAM_LIBS="-L$with_pam/lib" - fi - - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for pam_start in -lpam" >&5 -$as_echo_n "checking for pam_start in -lpam... " >&6; } -if test "${ac_cv_lib_pam_pam_start+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_check_lib_save_LIBS=$LIBS -LIBS="-lpam "$PAM_LIBS" $LIBS" -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -/* Override any GCC internal prototype to avoid an error. - Use char because int might match the return type of a GCC - builtin and then its argument prototype would still apply. */ -#ifdef __cplusplus -extern "C" -#endif -char pam_start (); -int -main () -{ -return pam_start (); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_link "$LINENO"; then : - ac_cv_lib_pam_pam_start=yes -else - ac_cv_lib_pam_pam_start=no -fi -rm -f core conftest.err conftest.$ac_objext \ - conftest$ac_exeext conftest.$ac_ext -LIBS=$ac_check_lib_save_LIBS -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_pam_pam_start" >&5 -$as_echo "$ac_cv_lib_pam_pam_start" >&6; } -if test "x$ac_cv_lib_pam_pam_start" = x""yes; then : - PAM_LIBS="$PAM_LIBS -lpam" - pam_found=yes -else - pam_found=no -fi - - if test $pam_found = no; then - as_fn_error "Could not find development files of PAM library. Install them or disable \`pam' with: --disable-pam" "$LINENO" 5 - fi - pam_save_CFLAGS="$CFLAGS" - CFLAGS="$CFLAGS $PAM_CFLAGS" - pam_save_CPPFLAGS="$CPPFLAGS" - CPPFLAGS="$CPPFLAGS $PAM_CFLAGS" - for ac_header in security/pam_appl.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "security/pam_appl.h" "ac_cv_header_security_pam_appl_h" "$ac_includes_default" -if test "x$ac_cv_header_security_pam_appl_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_SECURITY_PAM_APPL_H 1 -_ACEOF - -else - pam_found=no -fi - -done - - if test $pam_found = no; then - as_fn_error "Could not find security/pam_appl.h. Install it or disable \`pam' with: --disable-pam" "$LINENO" 5 - fi - CFLAGS="$pam_save_CFLAGS" - CPPFLAGS="$pam_save_CPPFLAGS" - - - -fi - - -# Check whether --enable-hipe was given. -if test "${enable_hipe+set}" = set; then : - enableval=$enable_hipe; case "${enableval}" in - yes) hipe=true ;; - no) hipe=false ;; - *) as_fn_error "bad value ${enableval} for --enable-hipe" "$LINENO" 5 ;; -esac -else - hipe=false -fi - - - -# Check whether --enable-roster_gateway_workaround was given. -if test "${enable_roster_gateway_workaround+set}" = set; then : - enableval=$enable_roster_gateway_workaround; case "${enableval}" in - yes) roster_gateway_workaround=true ;; - no) roster_gateway_workaround=false ;; - *) as_fn_error "bad value ${enableval} for --enable-roster-gateway-workaround" "$LINENO" 5 ;; -esac -else - roster_gateway_workaround=false -fi - - - -# Check whether --enable-mssql was given. -if test "${enable_mssql+set}" = set; then : - enableval=$enable_mssql; case "${enableval}" in - yes) db_type=mssql ;; - no) db_type=generic ;; - *) as_fn_error "bad value ${enableval} for --enable-mssql" "$LINENO" 5 ;; -esac -else - db_type=generic -fi - - - -# Check whether --enable-transient_supervisors was given. -if test "${enable_transient_supervisors+set}" = set; then : - enableval=$enable_transient_supervisors; case "${enableval}" in - yes) transient_supervisors=true ;; - no) transient_supervisors=false ;; - *) as_fn_error "bad value ${enableval} for --enable-transient_supervisors" "$LINENO" 5 ;; -esac -else - transient_supervisors=true -fi - - - -# Check whether --enable-full_xml was given. -if test "${enable_full_xml+set}" = set; then : - enableval=$enable_full_xml; case "${enableval}" in - yes) full_xml=true ;; - no) full_xml=false ;; - *) as_fn_error "bad value ${enableval} for --enable-full-xml" "$LINENO" 5 ;; -esac -else - full_xml=false -fi - - - -ac_config_files="$ac_config_files Makefile $make_mod_muc $make_mod_pubsub $make_mod_proxy65 $make_eldap $make_pam $make_web stun/Makefile $make_tls $make_odbc $make_ejabberd_zlib" - -#openssl - -# Check whether --with-openssl was given. -if test "${with_openssl+set}" = set; then : - withval=$with_openssl; -fi - -unset SSL_LIBS; -unset SSL_CFLAGS; -have_openssl=no -if test x"$tls" != x; then - for ssl_prefix in $withval /usr/local/ssl /usr/lib/ssl /usr/ssl /usr/pkg /usr/local /usr; do - printf "looking for openssl in $ssl_prefix...\n" - SSL_CFLAGS="-I$ssl_prefix/include" - SSL_LIBS="-L$ssl_prefix/lib -lcrypto" - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for SSL_new in -lssl" >&5 -$as_echo_n "checking for SSL_new in -lssl... " >&6; } -if test "${ac_cv_lib_ssl_SSL_new+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_check_lib_save_LIBS=$LIBS -LIBS="-lssl $SSL_LIBS $SSL_CFLAGS $LIBS" -cat confdefs.h - <<_ACEOF >conftest.$ac_ext -/* end confdefs.h. */ - -/* Override any GCC internal prototype to avoid an error. - Use char because int might match the return type of a GCC - builtin and then its argument prototype would still apply. */ -#ifdef __cplusplus -extern "C" -#endif -char SSL_new (); -int -main () -{ -return SSL_new (); - ; - return 0; -} -_ACEOF -if ac_fn_c_try_link "$LINENO"; then : - ac_cv_lib_ssl_SSL_new=yes -else - ac_cv_lib_ssl_SSL_new=no -fi -rm -f core conftest.err conftest.$ac_objext \ - conftest$ac_exeext conftest.$ac_ext -LIBS=$ac_check_lib_save_LIBS -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_lib_ssl_SSL_new" >&5 -$as_echo "$ac_cv_lib_ssl_SSL_new" >&6; } -if test "x$ac_cv_lib_ssl_SSL_new" = x""yes; then : - have_openssl=yes -else - have_openssl=no -fi - - if test x"$have_openssl" = xyes; then - save_CPPFLAGS=$CPPFLAGS - CPPFLAGS="-I$ssl_prefix/include $CPPFLAGS" - for ac_header in openssl/ssl.h -do : - ac_fn_c_check_header_mongrel "$LINENO" "openssl/ssl.h" "ac_cv_header_openssl_ssl_h" "$ac_includes_default" -if test "x$ac_cv_header_openssl_ssl_h" = x""yes; then : - cat >>confdefs.h <<_ACEOF -#define HAVE_OPENSSL_SSL_H 1 -_ACEOF - have_openssl_h=yes -fi - -done - - CPPFLAGS=$save_CPPFLAGS - if test x"$have_openssl_h" = xyes; then - have_openssl=yes - printf "openssl found in $ssl_prefix\n"; - SSL_LIBS="-L$ssl_prefix/lib -lssl -lcrypto" - CPPFLAGS="-I$ssl_prefix/include $CPPFLAGS" - SSL_CFLAGS="-DHAVE_SSL" - break - fi - else - # Clear this from the autoconf cache, so in the next pass of - # this loop with different -L arguments, it will test again. - unset ac_cv_lib_ssl_SSL_new - fi - done -if test x${have_openssl} != xyes; then - as_fn_error "Could not find development files of OpenSSL library. Install them or disable \`tls' with: --disable-tls" "$LINENO" 5 -fi - - -fi - -# If ssl is kerberized it need krb5.h -# On RedHat and OpenBSD, krb5.h is in an unsual place: -KRB5_INCLUDE="`krb5-config --cflags 2>/dev/null`" -if test -n "$KRB5_INCLUDE" ; then - CPPFLAGS="$CPPFLAGS $KRB5_INCLUDE" -else - # For RedHat For BSD - for D in /usr/kerberos/include /usr/include/kerberos /usr/include/kerberosV - do - if test -d $D ; then - CPPFLAGS="$CPPFLAGS -I$D" - fi - done -fi -ac_fn_c_check_header_mongrel "$LINENO" "krb5.h" "ac_cv_header_krb5_h" "$ac_includes_default" -if test "x$ac_cv_header_krb5_h" = x""yes; then : - -fi - - - -ENABLEUSER="" -# Check whether --enable-user was given. -if test "${enable_user+set}" = set; then : - enableval=$enable_user; case "${enableval}" in - yes) ENABLEUSER=`whoami` ;; - no) ENABLEUSER="" ;; - *) ENABLEUSER=$enableval - esac -fi - -if test "$ENABLEUSER" != ""; then - echo "allow this system user to start ejabberd: $ENABLEUSER" - INSTALLUSER=$ENABLEUSER - -fi - -ac_fn_c_check_header_mongrel "$LINENO" "openssl/md2.h" "ac_cv_header_openssl_md2_h" "$ac_includes_default" -if test "x$ac_cv_header_openssl_md2_h" = x""yes; then : - md2=true -else - md2=false -fi - - - - -ac_aux_dir= -for ac_dir in "$srcdir" "$srcdir/.." "$srcdir/../.."; do - for ac_t in install-sh install.sh shtool; do - if test -f "$ac_dir/$ac_t"; then - ac_aux_dir=$ac_dir - ac_install_sh="$ac_aux_dir/$ac_t -c" - break 2 - fi - done -done -if test -z "$ac_aux_dir"; then - as_fn_error "cannot find install-sh, install.sh, or shtool in \"$srcdir\" \"$srcdir/..\" \"$srcdir/../..\"" "$LINENO" 5 -fi - -# These three variables are undocumented and unsupported, -# and are intended to be withdrawn in a future Autoconf release. -# They can cause serious problems if a builder's source tree is in a directory -# whose full name contains unusual characters. -ac_config_guess="$SHELL $ac_aux_dir/config.guess" # Please don't use this var. -ac_config_sub="$SHELL $ac_aux_dir/config.sub" # Please don't use this var. -ac_configure="$SHELL $ac_aux_dir/configure" # Please don't use this var. - - -# Make sure we can run config.sub. -$SHELL "$ac_aux_dir/config.sub" sun4 >/dev/null 2>&1 || - as_fn_error "cannot run $SHELL $ac_aux_dir/config.sub" "$LINENO" 5 - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking build system type" >&5 -$as_echo_n "checking build system type... " >&6; } -if test "${ac_cv_build+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - ac_build_alias=$build_alias -test "x$ac_build_alias" = x && - ac_build_alias=`$SHELL "$ac_aux_dir/config.guess"` -test "x$ac_build_alias" = x && - as_fn_error "cannot guess build type; you must specify one" "$LINENO" 5 -ac_cv_build=`$SHELL "$ac_aux_dir/config.sub" $ac_build_alias` || - as_fn_error "$SHELL $ac_aux_dir/config.sub $ac_build_alias failed" "$LINENO" 5 - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_build" >&5 -$as_echo "$ac_cv_build" >&6; } -case $ac_cv_build in -*-*-*) ;; -*) as_fn_error "invalid value of canonical build" "$LINENO" 5;; -esac -build=$ac_cv_build -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_build -shift -build_cpu=$1 -build_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -build_os=$* -IFS=$ac_save_IFS -case $build_os in *\ *) build_os=`echo "$build_os" | sed 's/ /-/g'`;; esac - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking host system type" >&5 -$as_echo_n "checking host system type... " >&6; } -if test "${ac_cv_host+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test "x$host_alias" = x; then - ac_cv_host=$ac_cv_build -else - ac_cv_host=`$SHELL "$ac_aux_dir/config.sub" $host_alias` || - as_fn_error "$SHELL $ac_aux_dir/config.sub $host_alias failed" "$LINENO" 5 -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_host" >&5 -$as_echo "$ac_cv_host" >&6; } -case $ac_cv_host in -*-*-*) ;; -*) as_fn_error "invalid value of canonical host" "$LINENO" 5;; -esac -host=$ac_cv_host -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_host -shift -host_cpu=$1 -host_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -host_os=$* -IFS=$ac_save_IFS -case $host_os in *\ *) host_os=`echo "$host_os" | sed 's/ /-/g'`;; esac - - -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking target system type" >&5 -$as_echo_n "checking target system type... " >&6; } -if test "${ac_cv_target+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - if test "x$target_alias" = x; then - ac_cv_target=$ac_cv_host -else - ac_cv_target=`$SHELL "$ac_aux_dir/config.sub" $target_alias` || - as_fn_error "$SHELL $ac_aux_dir/config.sub $target_alias failed" "$LINENO" 5 -fi - -fi -{ $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_cv_target" >&5 -$as_echo "$ac_cv_target" >&6; } -case $ac_cv_target in -*-*-*) ;; -*) as_fn_error "invalid value of canonical target" "$LINENO" 5;; -esac -target=$ac_cv_target -ac_save_IFS=$IFS; IFS='-' -set x $ac_cv_target -shift -target_cpu=$1 -target_vendor=$2 -shift; shift -# Remember, the first character of IFS is used to create $*, -# except with old shells: -target_os=$* -IFS=$ac_save_IFS -case $target_os in *\ *) target_os=`echo "$target_os" | sed 's/ /-/g'`;; esac - - -# The aliases save the names the user supplied, while $host etc. -# will get canonicalized. -test -n "$target_alias" && - test "$program_prefix$program_suffix$program_transform_name" = \ - NONENONEs,x,x, && - program_prefix=${target_alias}- - -#AC_DEFINE_UNQUOTED(CPU_VENDOR_OS, "$target") -#AC_SUBST(target_os) - - -case "$target_os" in - *darwin10*) - echo "Target OS is 'Darwin10'" - ac_ext=erl -ac_compile='$ERLC $ERLCFLAGS -b beam conftest.$ac_ext >&5' -ac_link='$ERLC $ERLCFLAGS -b beam conftest.$ac_ext >&5 && echo "#!/bin/sh" > conftest$ac_exeext && $as_echo "\"$ERL\" -run conftest start -run init stop -noshell" >> conftest$ac_exeext && chmod +x conftest$ac_exeext' - - if test -n "$ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: checking for erlc" >&5 -$as_echo_n "checking for erlc... " >&6; } - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERLC" >&5 -$as_echo "$ERLC" >&6; } -else - if test -n "$ac_tool_prefix"; then - # Extract the first word of "${ac_tool_prefix}erlc", so it can be a program name with args. -set dummy ${ac_tool_prefix}erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ERLC="$ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ERLC=$ac_cv_path_ERLC -if test -n "$ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ERLC" >&5 -$as_echo "$ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - -fi -if test -z "$ac_cv_path_ERLC"; then - ac_pt_ERLC=$ERLC - # Extract the first word of "erlc", so it can be a program name with args. -set dummy erlc; ac_word=$2 -{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5 -$as_echo_n "checking for $ac_word... " >&6; } -if test "${ac_cv_path_ac_pt_ERLC+set}" = set; then : - $as_echo_n "(cached) " >&6 -else - case $ac_pt_ERLC in - [\\/]* | ?:[\\/]*) - ac_cv_path_ac_pt_ERLC="$ac_pt_ERLC" # Let the user override the test with a path. - ;; - *) - as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - for ac_exec_ext in '' $ac_executable_extensions; do - if { test -f "$as_dir/$ac_word$ac_exec_ext" && $as_test_x "$as_dir/$ac_word$ac_exec_ext"; }; then - ac_cv_path_ac_pt_ERLC="$as_dir/$ac_word$ac_exec_ext" - $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5 - break 2 - fi -done - done -IFS=$as_save_IFS - - ;; -esac -fi -ac_pt_ERLC=$ac_cv_path_ac_pt_ERLC -if test -n "$ac_pt_ERLC"; then - { $as_echo "$as_me:${as_lineno-$LINENO}: result: $ac_pt_ERLC" >&5 -$as_echo "$ac_pt_ERLC" >&6; } -else - { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5 -$as_echo "no" >&6; } -fi - - if test "x$ac_pt_ERLC" = x; then - ERLC="" - else - case $cross_compiling:$ac_tool_warned in -yes:) -{ $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: using cross tools not prefixed with host triplet" >&5 -$as_echo "$as_me: WARNING: using cross tools not prefixed with host triplet" >&2;} -ac_tool_warned=yes ;; -esac - ERLC=$ac_pt_ERLC - fi -else - ERLC="$ac_cv_path_ERLC" -fi - -fi - - -if test "$cross_compiling" = yes; then : - { { $as_echo "$as_me:${as_lineno-$LINENO}: error: in \`$ac_pwd':" >&5 -$as_echo "$as_me: error: in \`$ac_pwd':" >&2;} -as_fn_error "cannot run test program while cross compiling -See \`config.log' for more details." "$LINENO" 5; } -else - cat > conftest.$ac_ext <<_ACEOF --module(conftest). --export([start/0]). - -start() -> - halt(case erlang:system_info(wordsize) of - 8 -> 0; 4 -> 1 end) -. - -_ACEOF -if ac_fn_erl_try_run "$LINENO"; then : - { $as_echo "$as_me:${as_lineno-$LINENO}: found 64-bit Erlang" >&5 -$as_echo "$as_me: found 64-bit Erlang" >&6;} - CBIT=-m64 -else - { $as_echo "$as_me:${as_lineno-$LINENO}: found 32-bit Erlang" >&5 -$as_echo "$as_me: found 32-bit Erlang" >&6;} - CBIT=-m32 -fi -rm -f core *.core core.conftest.* gmon.out bb.out conftest$ac_exeext \ - conftest.$ac_objext conftest.beam conftest.$ac_ext -fi - - ;; - *) - echo "Target OS is '$target_os'" - CBIT="" - ;; -esac -CFLAGS="$CFLAGS $CBIT" -LD_SHARED="$LD_SHARED $CBIT" -echo "CBIT is set to '$CBIT'" - -cat >confcache <<\_ACEOF -# This file is a shell script that caches the results of configure -# tests run on this system so they can be shared between configure -# scripts and configure runs, see configure's option --config-cache. -# It is not useful on other systems. If it contains results you don't -# want to keep, you may remove or edit it. -# -# config.status only pays attention to the cache file if you give it -# the --recheck option to rerun configure. -# -# `ac_cv_env_foo' variables (set or unset) will be overridden when -# loading this file, other *unset* `ac_cv_foo' will be assigned the -# following values. - -_ACEOF - -# The following way of writing the cache mishandles newlines in values, -# but we know of no workaround that is simple, portable, and efficient. -# So, we kill variables containing newlines. -# Ultrix sh set writes to stderr and can't be redirected directly, -# and sets the high bit in the cache file unless we assign to the vars. -( - for ac_var in `(set) 2>&1 | sed -n 's/^\([a-zA-Z_][a-zA-Z0-9_]*\)=.*/\1/p'`; do - eval ac_val=\$$ac_var - case $ac_val in #( - *${as_nl}*) - case $ac_var in #( - *_cv_*) { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: cache variable $ac_var contains a newline" >&5 -$as_echo "$as_me: WARNING: cache variable $ac_var contains a newline" >&2;} ;; - esac - case $ac_var in #( - _ | IFS | as_nl) ;; #( - BASH_ARGV | BASH_SOURCE) eval $ac_var= ;; #( - *) { eval $ac_var=; unset $ac_var;} ;; - esac ;; - esac - done - - (set) 2>&1 | - case $as_nl`(ac_space=' '; set) 2>&1` in #( - *${as_nl}ac_space=\ *) - # `set' does not quote correctly, so add quotes: double-quote - # substitution turns \\\\ into \\, and sed turns \\ into \. - sed -n \ - "s/'/'\\\\''/g; - s/^\\([_$as_cr_alnum]*_cv_[_$as_cr_alnum]*\\)=\\(.*\\)/\\1='\\2'/p" - ;; #( - *) - # `set' quotes correctly as required by POSIX, so do not add quotes. - sed -n "/^[_$as_cr_alnum]*_cv_[_$as_cr_alnum]*=/p" - ;; - esac | - sort -) | - sed ' - /^ac_cv_env_/b end - t clear - :clear - s/^\([^=]*\)=\(.*[{}].*\)$/test "${\1+set}" = set || &/ - t end - s/^\([^=]*\)=\(.*\)$/\1=${\1=\2}/ - :end' >>confcache -if diff "$cache_file" confcache >/dev/null 2>&1; then :; else - if test -w "$cache_file"; then - test "x$cache_file" != "x/dev/null" && - { $as_echo "$as_me:${as_lineno-$LINENO}: updating cache $cache_file" >&5 -$as_echo "$as_me: updating cache $cache_file" >&6;} - cat confcache >$cache_file - else - { $as_echo "$as_me:${as_lineno-$LINENO}: not updating unwritable cache $cache_file" >&5 -$as_echo "$as_me: not updating unwritable cache $cache_file" >&6;} - fi -fi -rm -f confcache - -test "x$prefix" = xNONE && prefix=$ac_default_prefix -# Let make expand exec_prefix. -test "x$exec_prefix" = xNONE && exec_prefix='${prefix}' - -# Transform confdefs.h into DEFS. -# Protect against shell expansion while executing Makefile rules. -# Protect against Makefile macro expansion. -# -# If the first sed substitution is executed (which looks for macros that -# take arguments), then branch to the quote section. Otherwise, -# look for a macro that doesn't take arguments. -ac_script=' -:mline -/\\$/{ - N - s,\\\n,, - b mline -} -t clear -:clear -s/^[ ]*#[ ]*define[ ][ ]*\([^ (][^ (]*([^)]*)\)[ ]*\(.*\)/-D\1=\2/g -t quote -s/^[ ]*#[ ]*define[ ][ ]*\([^ ][^ ]*\)[ ]*\(.*\)/-D\1=\2/g -t quote -b any -:quote -s/[ `~#$^&*(){}\\|;'\''"<>?]/\\&/g -s/\[/\\&/g -s/\]/\\&/g -s/\$/$$/g -H -:any -${ - g - s/^\n// - s/\n/ /g - p -} -' -DEFS=`sed -n "$ac_script" confdefs.h` - - -ac_libobjs= -ac_ltlibobjs= -for ac_i in : $LIBOBJS; do test "x$ac_i" = x: && continue - # 1. Remove the extension, and $U if already installed. - ac_script='s/\$U\././;s/\.o$//;s/\.obj$//' - ac_i=`$as_echo "$ac_i" | sed "$ac_script"` - # 2. Prepend LIBOBJDIR. When used with automake>=1.10 LIBOBJDIR - # will be set to the directory where LIBOBJS objects are built. - as_fn_append ac_libobjs " \${LIBOBJDIR}$ac_i\$U.$ac_objext" - as_fn_append ac_ltlibobjs " \${LIBOBJDIR}$ac_i"'$U.lo' -done -LIBOBJS=$ac_libobjs - -LTLIBOBJS=$ac_ltlibobjs - - - -: ${CONFIG_STATUS=./config.status} -ac_write_fail=0 -ac_clean_files_save=$ac_clean_files -ac_clean_files="$ac_clean_files $CONFIG_STATUS" -{ $as_echo "$as_me:${as_lineno-$LINENO}: creating $CONFIG_STATUS" >&5 -$as_echo "$as_me: creating $CONFIG_STATUS" >&6;} -as_write_fail=0 -cat >$CONFIG_STATUS <<_ASEOF || as_write_fail=1 -#! $SHELL -# Generated by $as_me. -# Run this file to recreate the current configuration. -# Compiler output produced by configure, useful for debugging -# configure, is in config.log if it exists. - -debug=false -ac_cs_recheck=false -ac_cs_silent=false - -SHELL=\${CONFIG_SHELL-$SHELL} -export SHELL -_ASEOF -cat >>$CONFIG_STATUS <<\_ASEOF || as_write_fail=1 -## -------------------- ## -## M4sh Initialization. ## -## -------------------- ## - -# Be more Bourne compatible -DUALCASE=1; export DUALCASE # for MKS sh -if test -n "${ZSH_VERSION+set}" && (emulate sh) >/dev/null 2>&1; then : - emulate sh - NULLCMD=: - # Pre-4.2 versions of Zsh do word splitting on ${1+"$@"}, which - # is contrary to our usage. Disable this feature. - alias -g '${1+"$@"}'='"$@"' - setopt NO_GLOB_SUBST -else - case `(set -o) 2>/dev/null` in #( - *posix*) : - set -o posix ;; #( - *) : - ;; -esac -fi - - -as_nl=' -' -export as_nl -# Printing a long string crashes Solaris 7 /usr/bin/printf. -as_echo='\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\' -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo -as_echo=$as_echo$as_echo$as_echo$as_echo$as_echo$as_echo -# Prefer a ksh shell builtin over an external printf program on Solaris, -# but without wasting forks for bash or zsh. -if test -z "$BASH_VERSION$ZSH_VERSION" \ - && (test "X`print -r -- $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='print -r --' - as_echo_n='print -rn --' -elif (test "X`printf %s $as_echo`" = "X$as_echo") 2>/dev/null; then - as_echo='printf %s\n' - as_echo_n='printf %s' -else - if test "X`(/usr/ucb/echo -n -n $as_echo) 2>/dev/null`" = "X-n $as_echo"; then - as_echo_body='eval /usr/ucb/echo -n "$1$as_nl"' - as_echo_n='/usr/ucb/echo -n' - else - as_echo_body='eval expr "X$1" : "X\\(.*\\)"' - as_echo_n_body='eval - arg=$1; - case $arg in #( - *"$as_nl"*) - expr "X$arg" : "X\\(.*\\)$as_nl"; - arg=`expr "X$arg" : ".*$as_nl\\(.*\\)"`;; - esac; - expr "X$arg" : "X\\(.*\\)" | tr -d "$as_nl" - ' - export as_echo_n_body - as_echo_n='sh -c $as_echo_n_body as_echo' - fi - export as_echo_body - as_echo='sh -c $as_echo_body as_echo' -fi - -# The user is always right. -if test "${PATH_SEPARATOR+set}" != set; then - PATH_SEPARATOR=: - (PATH='/bin;/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 && { - (PATH='/bin:/bin'; FPATH=$PATH; sh -c :) >/dev/null 2>&1 || - PATH_SEPARATOR=';' - } -fi - - -# IFS -# We need space, tab and new line, in precisely that order. Quoting is -# there to prevent editors from complaining about space-tab. -# (If _AS_PATH_WALK were called with IFS unset, it would disable word -# splitting by setting IFS to empty value.) -IFS=" "" $as_nl" - -# Find who we are. Look in the path if we contain no directory separator. -case $0 in #(( - *[\\/]* ) as_myself=$0 ;; - *) as_save_IFS=$IFS; IFS=$PATH_SEPARATOR -for as_dir in $PATH -do - IFS=$as_save_IFS - test -z "$as_dir" && as_dir=. - test -r "$as_dir/$0" && as_myself=$as_dir/$0 && break - done -IFS=$as_save_IFS - - ;; -esac -# We did not find ourselves, most probably we were run as `sh COMMAND' -# in which case we are not to be found in the path. -if test "x$as_myself" = x; then - as_myself=$0 -fi -if test ! -f "$as_myself"; then - $as_echo "$as_myself: error: cannot find myself; rerun with an absolute file name" >&2 - exit 1 -fi - -# Unset variables that we do not need and which cause bugs (e.g. in -# pre-3.0 UWIN ksh). But do not cause bugs in bash 2.01; the "|| exit 1" -# suppresses any "Segmentation fault" message there. '((' could -# trigger a bug in pdksh 5.2.14. -for as_var in BASH_ENV ENV MAIL MAILPATH -do eval test x\${$as_var+set} = xset \ - && ( (unset $as_var) || exit 1) >/dev/null 2>&1 && unset $as_var || : -done -PS1='$ ' -PS2='> ' -PS4='+ ' - -# NLS nuisances. -LC_ALL=C -export LC_ALL -LANGUAGE=C -export LANGUAGE - -# CDPATH. -(unset CDPATH) >/dev/null 2>&1 && unset CDPATH - - -# as_fn_error ERROR [LINENO LOG_FD] -# --------------------------------- -# Output "`basename $0`: error: ERROR" to stderr. If LINENO and LOG_FD are -# provided, also output the error to LOG_FD, referencing LINENO. Then exit the -# script with status $?, using 1 if that was 0. -as_fn_error () -{ - as_status=$?; test $as_status -eq 0 && as_status=1 - if test "$3"; then - as_lineno=${as_lineno-"$2"} as_lineno_stack=as_lineno_stack=$as_lineno_stack - $as_echo "$as_me:${as_lineno-$LINENO}: error: $1" >&$3 - fi - $as_echo "$as_me: error: $1" >&2 - as_fn_exit $as_status -} # as_fn_error - - -# as_fn_set_status STATUS -# ----------------------- -# Set $? to STATUS, without forking. -as_fn_set_status () -{ - return $1 -} # as_fn_set_status - -# as_fn_exit STATUS -# ----------------- -# Exit the shell with STATUS, even in a "trap 0" or "set -e" context. -as_fn_exit () -{ - set +e - as_fn_set_status $1 - exit $1 -} # as_fn_exit - -# as_fn_unset VAR -# --------------- -# Portably unset VAR. -as_fn_unset () -{ - { eval $1=; unset $1;} -} -as_unset=as_fn_unset -# as_fn_append VAR VALUE -# ---------------------- -# Append the text in VALUE to the end of the definition contained in VAR. Take -# advantage of any shell optimizations that allow amortized linear growth over -# repeated appends, instead of the typical quadratic growth present in naive -# implementations. -if (eval "as_var=1; as_var+=2; test x\$as_var = x12") 2>/dev/null; then : - eval 'as_fn_append () - { - eval $1+=\$2 - }' -else - as_fn_append () - { - eval $1=\$$1\$2 - } -fi # as_fn_append - -# as_fn_arith ARG... -# ------------------ -# Perform arithmetic evaluation on the ARGs, and store the result in the -# global $as_val. Take advantage of shells that can avoid forks. The arguments -# must be portable across $(()) and expr. -if (eval "test \$(( 1 + 1 )) = 2") 2>/dev/null; then : - eval 'as_fn_arith () - { - as_val=$(( $* )) - }' -else - as_fn_arith () - { - as_val=`expr "$@" || test $? -eq 1` - } -fi # as_fn_arith - - -if expr a : '\(a\)' >/dev/null 2>&1 && - test "X`expr 00001 : '.*\(...\)'`" = X001; then - as_expr=expr -else - as_expr=false -fi - -if (basename -- /) >/dev/null 2>&1 && test "X`basename -- / 2>&1`" = "X/"; then - as_basename=basename -else - as_basename=false -fi - -if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then - as_dirname=dirname -else - as_dirname=false -fi - -as_me=`$as_basename -- "$0" || -$as_expr X/"$0" : '.*/\([^/][^/]*\)/*$' \| \ - X"$0" : 'X\(//\)$' \| \ - X"$0" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X/"$0" | - sed '/^.*\/\([^/][^/]*\)\/*$/{ - s//\1/ - q - } - /^X\/\(\/\/\)$/{ - s//\1/ - q - } - /^X\/\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - -# Avoid depending upon Character Ranges. -as_cr_letters='abcdefghijklmnopqrstuvwxyz' -as_cr_LETTERS='ABCDEFGHIJKLMNOPQRSTUVWXYZ' -as_cr_Letters=$as_cr_letters$as_cr_LETTERS -as_cr_digits='0123456789' -as_cr_alnum=$as_cr_Letters$as_cr_digits - -ECHO_C= ECHO_N= ECHO_T= -case `echo -n x` in #((((( --n*) - case `echo 'xy\c'` in - *c*) ECHO_T=' ';; # ECHO_T is single tab character. - xy) ECHO_C='\c';; - *) echo `echo ksh88 bug on AIX 6.1` > /dev/null - ECHO_T=' ';; - esac;; -*) - ECHO_N='-n';; -esac - -rm -f conf$$ conf$$.exe conf$$.file -if test -d conf$$.dir; then - rm -f conf$$.dir/conf$$.file -else - rm -f conf$$.dir - mkdir conf$$.dir 2>/dev/null -fi -if (echo >conf$$.file) 2>/dev/null; then - if ln -s conf$$.file conf$$ 2>/dev/null; then - as_ln_s='ln -s' - # ... but there are two gotchas: - # 1) On MSYS, both `ln -s file dir' and `ln file dir' fail. - # 2) DJGPP < 2.04 has no symlinks; `ln -s' creates a wrapper executable. - # In both cases, we have to default to `cp -p'. - ln -s conf$$.file conf$$.dir 2>/dev/null && test ! -f conf$$.exe || - as_ln_s='cp -p' - elif ln conf$$.file conf$$ 2>/dev/null; then - as_ln_s=ln - else - as_ln_s='cp -p' - fi -else - as_ln_s='cp -p' -fi -rm -f conf$$ conf$$.exe conf$$.dir/conf$$.file conf$$.file -rmdir conf$$.dir 2>/dev/null - - -# as_fn_mkdir_p -# ------------- -# Create "$as_dir" as a directory, including parents if necessary. -as_fn_mkdir_p () -{ - - case $as_dir in #( - -*) as_dir=./$as_dir;; - esac - test -d "$as_dir" || eval $as_mkdir_p || { - as_dirs= - while :; do - case $as_dir in #( - *\'*) as_qdir=`$as_echo "$as_dir" | sed "s/'/'\\\\\\\\''/g"`;; #'( - *) as_qdir=$as_dir;; - esac - as_dirs="'$as_qdir' $as_dirs" - as_dir=`$as_dirname -- "$as_dir" || -$as_expr X"$as_dir" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$as_dir" : 'X\(//\)[^/]' \| \ - X"$as_dir" : 'X\(//\)$' \| \ - X"$as_dir" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$as_dir" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - test -d "$as_dir" && break - done - test -z "$as_dirs" || eval "mkdir $as_dirs" - } || test -d "$as_dir" || as_fn_error "cannot create directory $as_dir" - - -} # as_fn_mkdir_p -if mkdir -p . 2>/dev/null; then - as_mkdir_p='mkdir -p "$as_dir"' -else - test -d ./-p && rmdir ./-p - as_mkdir_p=false -fi - -if test -x / >/dev/null 2>&1; then - as_test_x='test -x' -else - if ls -dL / >/dev/null 2>&1; then - as_ls_L_option=L - else - as_ls_L_option= - fi - as_test_x=' - eval sh -c '\'' - if test -d "$1"; then - test -d "$1/."; - else - case $1 in #( - -*)set "./$1";; - esac; - case `ls -ld'$as_ls_L_option' "$1" 2>/dev/null` in #(( - ???[sx]*):;;*)false;;esac;fi - '\'' sh - ' -fi -as_executable_p=$as_test_x - -# Sed expression to map a string onto a valid CPP name. -as_tr_cpp="eval sed 'y%*$as_cr_letters%P$as_cr_LETTERS%;s%[^_$as_cr_alnum]%_%g'" - -# Sed expression to map a string onto a valid variable name. -as_tr_sh="eval sed 'y%*+%pp%;s%[^_$as_cr_alnum]%_%g'" - - -exec 6>&1 -## ----------------------------------- ## -## Main body of $CONFIG_STATUS script. ## -## ----------------------------------- ## -_ASEOF -test $as_write_fail = 0 && chmod +x $CONFIG_STATUS || ac_write_fail=1 - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -# Save the log message, to keep $0 and so on meaningful, and to -# report actual input values of CONFIG_FILES etc. instead of their -# values after options handling. -ac_log=" -This file was extended by ejabberd $as_me 3.0.0-alpha-x, which was -generated by GNU Autoconf 2.65. Invocation command line was - - CONFIG_FILES = $CONFIG_FILES - CONFIG_HEADERS = $CONFIG_HEADERS - CONFIG_LINKS = $CONFIG_LINKS - CONFIG_COMMANDS = $CONFIG_COMMANDS - $ $0 $@ - -on `(hostname || uname -n) 2>/dev/null | sed 1q` -" - -_ACEOF - -case $ac_config_files in *" -"*) set x $ac_config_files; shift; ac_config_files=$*;; -esac - - - -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -# Files that config.status was made for. -config_files="$ac_config_files" - -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -ac_cs_usage="\ -\`$as_me' instantiates files and other configuration actions -from templates according to the current configuration. Unless the files -and actions are specified as TAGs, all are instantiated by default. - -Usage: $0 [OPTION]... [TAG]... - - -h, --help print this help, then exit - -V, --version print version number and configuration settings, then exit - --config print configuration, then exit - -q, --quiet, --silent - do not print progress messages - -d, --debug don't remove temporary files - --recheck update $as_me by reconfiguring in the same conditions - --file=FILE[:TEMPLATE] - instantiate the configuration file FILE - -Configuration files: -$config_files - -Report bugs to ." - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`" -ac_cs_version="\\ -ejabberd config.status 3.0.0-alpha-x -configured by $0, generated by GNU Autoconf 2.65, - with options \\"\$ac_cs_config\\" - -Copyright (C) 2009 Free Software Foundation, Inc. -This config.status script is free software; the Free Software Foundation -gives unlimited permission to copy, distribute and modify it." - -ac_pwd='$ac_pwd' -srcdir='$srcdir' -test -n "\$AWK" || AWK=awk -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -# The default lists apply if the user does not specify any file. -ac_need_defaults=: -while test $# != 0 -do - case $1 in - --*=*) - ac_option=`expr "X$1" : 'X\([^=]*\)='` - ac_optarg=`expr "X$1" : 'X[^=]*=\(.*\)'` - ac_shift=: - ;; - *) - ac_option=$1 - ac_optarg=$2 - ac_shift=shift - ;; - esac - - case $ac_option in - # Handling of the options. - -recheck | --recheck | --rechec | --reche | --rech | --rec | --re | --r) - ac_cs_recheck=: ;; - --version | --versio | --versi | --vers | --ver | --ve | --v | -V ) - $as_echo "$ac_cs_version"; exit ;; - --config | --confi | --conf | --con | --co | --c ) - $as_echo "$ac_cs_config"; exit ;; - --debug | --debu | --deb | --de | --d | -d ) - debug=: ;; - --file | --fil | --fi | --f ) - $ac_shift - case $ac_optarg in - *\'*) ac_optarg=`$as_echo "$ac_optarg" | sed "s/'/'\\\\\\\\''/g"` ;; - esac - as_fn_append CONFIG_FILES " '$ac_optarg'" - ac_need_defaults=false;; - --he | --h | --help | --hel | -h ) - $as_echo "$ac_cs_usage"; exit ;; - -q | -quiet | --quiet | --quie | --qui | --qu | --q \ - | -silent | --silent | --silen | --sile | --sil | --si | --s) - ac_cs_silent=: ;; - - # This is an error. - -*) as_fn_error "unrecognized option: \`$1' -Try \`$0 --help' for more information." ;; - - *) as_fn_append ac_config_targets " $1" - ac_need_defaults=false ;; - - esac - shift -done - -ac_configure_extra_args= - -if $ac_cs_silent; then - exec 6>/dev/null - ac_configure_extra_args="$ac_configure_extra_args --silent" -fi - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -if \$ac_cs_recheck; then - set X '$SHELL' '$0' $ac_configure_args \$ac_configure_extra_args --no-create --no-recursion - shift - \$as_echo "running CONFIG_SHELL=$SHELL \$*" >&6 - CONFIG_SHELL='$SHELL' - export CONFIG_SHELL - exec "\$@" -fi - -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -exec 5>>config.log -{ - echo - sed 'h;s/./-/g;s/^.../## /;s/...$/ ##/;p;x;p;x' <<_ASBOX -## Running $as_me. ## -_ASBOX - $as_echo "$ac_log" -} >&5 - -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 - -# Handling of arguments. -for ac_config_target in $ac_config_targets -do - case $ac_config_target in - "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;; - "$make_mod_muc") CONFIG_FILES="$CONFIG_FILES $make_mod_muc" ;; - "$make_mod_pubsub") CONFIG_FILES="$CONFIG_FILES $make_mod_pubsub" ;; - "$make_mod_proxy65") CONFIG_FILES="$CONFIG_FILES $make_mod_proxy65" ;; - "$make_eldap") CONFIG_FILES="$CONFIG_FILES $make_eldap" ;; - "$make_pam") CONFIG_FILES="$CONFIG_FILES $make_pam" ;; - "$make_web") CONFIG_FILES="$CONFIG_FILES $make_web" ;; - "stun/Makefile") CONFIG_FILES="$CONFIG_FILES stun/Makefile" ;; - "$make_tls") CONFIG_FILES="$CONFIG_FILES $make_tls" ;; - "$make_odbc") CONFIG_FILES="$CONFIG_FILES $make_odbc" ;; - "$make_ejabberd_zlib") CONFIG_FILES="$CONFIG_FILES $make_ejabberd_zlib" ;; - - *) as_fn_error "invalid argument: \`$ac_config_target'" "$LINENO" 5;; - esac -done - - -# If the user did not use the arguments to specify the items to instantiate, -# then the envvar interface is used. Set only those that are not. -# We use the long form for the default assignment because of an extremely -# bizarre bug on SunOS 4.1.3. -if $ac_need_defaults; then - test "${CONFIG_FILES+set}" = set || CONFIG_FILES=$config_files -fi - -# Have a temporary directory for convenience. Make it in the build tree -# simply because there is no reason against having it here, and in addition, -# creating and moving files from /tmp can sometimes cause problems. -# Hook for its removal unless debugging. -# Note that there is a small window in which the directory will not be cleaned: -# after its creation but before its name has been assigned to `$tmp'. -$debug || -{ - tmp= - trap 'exit_status=$? - { test -z "$tmp" || test ! -d "$tmp" || rm -fr "$tmp"; } && exit $exit_status -' 0 - trap 'as_fn_exit 1' 1 2 13 15 -} -# Create a (secure) tmp directory for tmp files. - -{ - tmp=`(umask 077 && mktemp -d "./confXXXXXX") 2>/dev/null` && - test -n "$tmp" && test -d "$tmp" -} || -{ - tmp=./conf$$-$RANDOM - (umask 077 && mkdir "$tmp") -} || as_fn_error "cannot create a temporary directory in ." "$LINENO" 5 - -# Set up the scripts for CONFIG_FILES section. -# No need to generate them if there are no CONFIG_FILES. -# This happens for instance with `./config.status config.h'. -if test -n "$CONFIG_FILES"; then - - -ac_cr=`echo X | tr X '\015'` -# On cygwin, bash can eat \r inside `` if the user requested igncr. -# But we know of no other shell where ac_cr would be empty at this -# point, so we can use a bashism as a fallback. -if test "x$ac_cr" = x; then - eval ac_cr=\$\'\\r\' -fi -ac_cs_awk_cr=`$AWK 'BEGIN { print "a\rb" }' /dev/null` -if test "$ac_cs_awk_cr" = "a${ac_cr}b"; then - ac_cs_awk_cr='\r' -else - ac_cs_awk_cr=$ac_cr -fi - -echo 'BEGIN {' >"$tmp/subs1.awk" && -_ACEOF - - -{ - echo "cat >conf$$subs.awk <<_ACEOF" && - echo "$ac_subst_vars" | sed 's/.*/&!$&$ac_delim/' && - echo "_ACEOF" -} >conf$$subs.sh || - as_fn_error "could not make $CONFIG_STATUS" "$LINENO" 5 -ac_delim_num=`echo "$ac_subst_vars" | grep -c '$'` -ac_delim='%!_!# ' -for ac_last_try in false false false false false :; do - . ./conf$$subs.sh || - as_fn_error "could not make $CONFIG_STATUS" "$LINENO" 5 - - ac_delim_n=`sed -n "s/.*$ac_delim\$/X/p" conf$$subs.awk | grep -c X` - if test $ac_delim_n = $ac_delim_num; then - break - elif $ac_last_try; then - as_fn_error "could not make $CONFIG_STATUS" "$LINENO" 5 - else - ac_delim="$ac_delim!$ac_delim _$ac_delim!! " - fi -done -rm -f conf$$subs.sh - -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -cat >>"\$tmp/subs1.awk" <<\\_ACAWK && -_ACEOF -sed -n ' -h -s/^/S["/; s/!.*/"]=/ -p -g -s/^[^!]*!// -:repl -t repl -s/'"$ac_delim"'$// -t delim -:nl -h -s/\(.\{148\}\)..*/\1/ -t more1 -s/["\\]/\\&/g; s/^/"/; s/$/\\n"\\/ -p -n -b repl -:more1 -s/["\\]/\\&/g; s/^/"/; s/$/"\\/ -p -g -s/.\{148\}// -t nl -:delim -h -s/\(.\{148\}\)..*/\1/ -t more2 -s/["\\]/\\&/g; s/^/"/; s/$/"/ -p -b -:more2 -s/["\\]/\\&/g; s/^/"/; s/$/"\\/ -p -g -s/.\{148\}// -t delim -' >$CONFIG_STATUS || ac_write_fail=1 -rm -f conf$$subs.awk -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -_ACAWK -cat >>"\$tmp/subs1.awk" <<_ACAWK && - for (key in S) S_is_set[key] = 1 - FS = "" - -} -{ - line = $ 0 - nfields = split(line, field, "@") - substed = 0 - len = length(field[1]) - for (i = 2; i < nfields; i++) { - key = field[i] - keylen = length(key) - if (S_is_set[key]) { - value = S[key] - line = substr(line, 1, len) "" value "" substr(line, len + keylen + 3) - len += length(value) + length(field[++i]) - substed = 1 - } else - len += 1 + keylen - } - - print line -} - -_ACAWK -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -if sed "s/$ac_cr//" < /dev/null > /dev/null 2>&1; then - sed "s/$ac_cr\$//; s/$ac_cr/$ac_cs_awk_cr/g" -else - cat -fi < "$tmp/subs1.awk" > "$tmp/subs.awk" \ - || as_fn_error "could not setup config files machinery" "$LINENO" 5 -_ACEOF - -# VPATH may cause trouble with some makes, so we remove $(srcdir), -# ${srcdir} and @srcdir@ from VPATH if srcdir is ".", strip leading and -# trailing colons and then remove the whole line if VPATH becomes empty -# (actually we leave an empty line to preserve line numbers). -if test "x$srcdir" = x.; then - ac_vpsub='/^[ ]*VPATH[ ]*=/{ -s/:*\$(srcdir):*/:/ -s/:*\${srcdir}:*/:/ -s/:*@srcdir@:*/:/ -s/^\([^=]*=[ ]*\):*/\1/ -s/:*$// -s/^[^=]*=[ ]*$// -}' -fi - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -fi # test -n "$CONFIG_FILES" - - -eval set X " :F $CONFIG_FILES " -shift -for ac_tag -do - case $ac_tag in - :[FHLC]) ac_mode=$ac_tag; continue;; - esac - case $ac_mode$ac_tag in - :[FHL]*:*);; - :L* | :C*:*) as_fn_error "invalid tag \`$ac_tag'" "$LINENO" 5;; - :[FH]-) ac_tag=-:-;; - :[FH]*) ac_tag=$ac_tag:$ac_tag.in;; - esac - ac_save_IFS=$IFS - IFS=: - set x $ac_tag - IFS=$ac_save_IFS - shift - ac_file=$1 - shift - - case $ac_mode in - :L) ac_source=$1;; - :[FH]) - ac_file_inputs= - for ac_f - do - case $ac_f in - -) ac_f="$tmp/stdin";; - *) # Look for the file first in the build tree, then in the source tree - # (if the path is not absolute). The absolute path cannot be DOS-style, - # because $ac_f cannot contain `:'. - test -f "$ac_f" || - case $ac_f in - [\\/$]*) false;; - *) test -f "$srcdir/$ac_f" && ac_f="$srcdir/$ac_f";; - esac || - as_fn_error "cannot find input file: \`$ac_f'" "$LINENO" 5;; - esac - case $ac_f in *\'*) ac_f=`$as_echo "$ac_f" | sed "s/'/'\\\\\\\\''/g"`;; esac - as_fn_append ac_file_inputs " '$ac_f'" - done - - # Let's still pretend it is `configure' which instantiates (i.e., don't - # use $as_me), people would be surprised to read: - # /* config.h. Generated by config.status. */ - configure_input='Generated from '` - $as_echo "$*" | sed 's|^[^:]*/||;s|:[^:]*/|, |g' - `' by configure.' - if test x"$ac_file" != x-; then - configure_input="$ac_file. $configure_input" - { $as_echo "$as_me:${as_lineno-$LINENO}: creating $ac_file" >&5 -$as_echo "$as_me: creating $ac_file" >&6;} - fi - # Neutralize special characters interpreted by sed in replacement strings. - case $configure_input in #( - *\&* | *\|* | *\\* ) - ac_sed_conf_input=`$as_echo "$configure_input" | - sed 's/[\\\\&|]/\\\\&/g'`;; #( - *) ac_sed_conf_input=$configure_input;; - esac - - case $ac_tag in - *:-:* | *:-) cat >"$tmp/stdin" \ - || as_fn_error "could not create $ac_file" "$LINENO" 5 ;; - esac - ;; - esac - - ac_dir=`$as_dirname -- "$ac_file" || -$as_expr X"$ac_file" : 'X\(.*[^/]\)//*[^/][^/]*/*$' \| \ - X"$ac_file" : 'X\(//\)[^/]' \| \ - X"$ac_file" : 'X\(//\)$' \| \ - X"$ac_file" : 'X\(/\)' \| . 2>/dev/null || -$as_echo X"$ac_file" | - sed '/^X\(.*[^/]\)\/\/*[^/][^/]*\/*$/{ - s//\1/ - q - } - /^X\(\/\/\)[^/].*/{ - s//\1/ - q - } - /^X\(\/\/\)$/{ - s//\1/ - q - } - /^X\(\/\).*/{ - s//\1/ - q - } - s/.*/./; q'` - as_dir="$ac_dir"; as_fn_mkdir_p - ac_builddir=. - -case "$ac_dir" in -.) ac_dir_suffix= ac_top_builddir_sub=. ac_top_build_prefix= ;; -*) - ac_dir_suffix=/`$as_echo "$ac_dir" | sed 's|^\.[\\/]||'` - # A ".." for each directory in $ac_dir_suffix. - ac_top_builddir_sub=`$as_echo "$ac_dir_suffix" | sed 's|/[^\\/]*|/..|g;s|/||'` - case $ac_top_builddir_sub in - "") ac_top_builddir_sub=. ac_top_build_prefix= ;; - *) ac_top_build_prefix=$ac_top_builddir_sub/ ;; - esac ;; -esac -ac_abs_top_builddir=$ac_pwd -ac_abs_builddir=$ac_pwd$ac_dir_suffix -# for backward compatibility: -ac_top_builddir=$ac_top_build_prefix - -case $srcdir in - .) # We are building in place. - ac_srcdir=. - ac_top_srcdir=$ac_top_builddir_sub - ac_abs_top_srcdir=$ac_pwd ;; - [\\/]* | ?:[\\/]* ) # Absolute name. - ac_srcdir=$srcdir$ac_dir_suffix; - ac_top_srcdir=$srcdir - ac_abs_top_srcdir=$srcdir ;; - *) # Relative name. - ac_srcdir=$ac_top_build_prefix$srcdir$ac_dir_suffix - ac_top_srcdir=$ac_top_build_prefix$srcdir - ac_abs_top_srcdir=$ac_pwd/$srcdir ;; -esac -ac_abs_srcdir=$ac_abs_top_srcdir$ac_dir_suffix - - - case $ac_mode in - :F) - # - # CONFIG_FILE - # - -_ACEOF - -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -# If the template does not know about datarootdir, expand it. -# FIXME: This hack should be removed a few years after 2.60. -ac_datarootdir_hack=; ac_datarootdir_seen= -ac_sed_dataroot=' -/datarootdir/ { - p - q -} -/@datadir@/p -/@docdir@/p -/@infodir@/p -/@localedir@/p -/@mandir@/p' -case `eval "sed -n \"\$ac_sed_dataroot\" $ac_file_inputs"` in -*datarootdir*) ac_datarootdir_seen=yes;; -*@datadir@*|*@docdir@*|*@infodir@*|*@localedir@*|*@mandir@*) - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&5 -$as_echo "$as_me: WARNING: $ac_file_inputs seems to ignore the --datarootdir setting" >&2;} -_ACEOF -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 - ac_datarootdir_hack=' - s&@datadir@&$datadir&g - s&@docdir@&$docdir&g - s&@infodir@&$infodir&g - s&@localedir@&$localedir&g - s&@mandir@&$mandir&g - s&\\\${datarootdir}&$datarootdir&g' ;; -esac -_ACEOF - -# Neutralize VPATH when `$srcdir' = `.'. -# Shell code in configure.ac might set extrasub. -# FIXME: do we really want to maintain this feature? -cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1 -ac_sed_extra="$ac_vpsub -$extrasub -_ACEOF -cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1 -:t -/@[a-zA-Z_][a-zA-Z_0-9]*@/!b -s|@configure_input@|$ac_sed_conf_input|;t t -s&@top_builddir@&$ac_top_builddir_sub&;t t -s&@top_build_prefix@&$ac_top_build_prefix&;t t -s&@srcdir@&$ac_srcdir&;t t -s&@abs_srcdir@&$ac_abs_srcdir&;t t -s&@top_srcdir@&$ac_top_srcdir&;t t -s&@abs_top_srcdir@&$ac_abs_top_srcdir&;t t -s&@builddir@&$ac_builddir&;t t -s&@abs_builddir@&$ac_abs_builddir&;t t -s&@abs_top_builddir@&$ac_abs_top_builddir&;t t -$ac_datarootdir_hack -" -eval sed \"\$ac_sed_extra\" "$ac_file_inputs" | $AWK -f "$tmp/subs.awk" >$tmp/out \ - || as_fn_error "could not create $ac_file" "$LINENO" 5 - -test -z "$ac_datarootdir_hack$ac_datarootdir_seen" && - { ac_out=`sed -n '/\${datarootdir}/p' "$tmp/out"`; test -n "$ac_out"; } && - { ac_out=`sed -n '/^[ ]*datarootdir[ ]*:*=/p' "$tmp/out"`; test -z "$ac_out"; } && - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: $ac_file contains a reference to the variable \`datarootdir' -which seems to be undefined. Please make sure it is defined." >&5 -$as_echo "$as_me: WARNING: $ac_file contains a reference to the variable \`datarootdir' -which seems to be undefined. Please make sure it is defined." >&2;} - - rm -f "$tmp/stdin" - case $ac_file in - -) cat "$tmp/out" && rm -f "$tmp/out";; - *) rm -f "$ac_file" && mv "$tmp/out" "$ac_file";; - esac \ - || as_fn_error "could not create $ac_file" "$LINENO" 5 - ;; - - - - esac - -done # for ac_tag - - -as_fn_exit 0 -_ACEOF -ac_clean_files=$ac_clean_files_save - -test $ac_write_fail = 0 || - as_fn_error "write failure creating $CONFIG_STATUS" "$LINENO" 5 - - -# configure is writing to config.log, and then calls config.status. -# config.status does its own redirection, appending to config.log. -# Unfortunately, on DOS this fails, as config.log is still kept open -# by configure, so config.status won't be able to write to it; its -# output is simply discarded. So we exec the FD to /dev/null, -# effectively closing config.log, so it can be properly (re)opened and -# appended to by config.status. When coming back to configure, we -# need to make the FD available again. -if test "$no_create" != yes; then - ac_cs_success=: - ac_config_status_args= - test "$silent" = yes && - ac_config_status_args="$ac_config_status_args --quiet" - exec 5>/dev/null - $SHELL $CONFIG_STATUS $ac_config_status_args || ac_cs_success=false - exec 5>>config.log - # Use ||, not &&, to avoid exiting from the if with $? = 1, which - # would make configure fail if this is the last instruction. - $ac_cs_success || as_fn_exit $? -fi -if test -n "$ac_unrecognized_opts" && test "$enable_option_checking" != no; then - { $as_echo "$as_me:${as_lineno-$LINENO}: WARNING: unrecognized options: $ac_unrecognized_opts" >&5 -$as_echo "$as_me: WARNING: unrecognized options: $ac_unrecognized_opts" >&2;} -fi - - -echo -echo "********************** WARNING ! ************************" -echo "* ejabberd master is NOT ready for real usage yet, *" -echo "* because it is still in heavy development. *" -echo "* Don't use ejabberd master, it is still alpha code! *" -echo "* Please use ejabberd 2.1.x branch instead. *" -echo "*********************************************************" -echo From b2d67df8d0b65400ae8c8183e6fe2199d14feb7e Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 27 Sep 2010 13:34:43 +0200 Subject: [PATCH 17/34] Remove Marshall T. Rose examples, superseded by supported examples (EJAB-1311) --- examples/mtr/ejabberd | 75 ------------------------------ examples/mtr/ejabberd-netbsd.sh | 81 --------------------------------- examples/mtr/ejabberd.cfg | 66 --------------------------- 3 files changed, 222 deletions(-) delete mode 100644 examples/mtr/ejabberd delete mode 100644 examples/mtr/ejabberd-netbsd.sh delete mode 100644 examples/mtr/ejabberd.cfg diff --git a/examples/mtr/ejabberd b/examples/mtr/ejabberd deleted file mode 100644 index 4328b0697..000000000 --- a/examples/mtr/ejabberd +++ /dev/null @@ -1,75 +0,0 @@ -#!/bin/sh -# -# PROVIDE: ejabberd -# REQUIRE: DAEMON -# KEYWORD: shutdown -# - -HOME=/usr/pkg/jabber D=/usr/pkg/jabber/ejabberd export HOME - -name="ejabberd" -rcvar=$name - -if [ -r /etc/rc.conf ] -then - . /etc/rc.conf -else - eval ${rcvar}=YES -fi - -# $flags from environment overrides ${rcvar}_flags -if [ -n "${flags}" ] -then - eval ${rcvar}_flags="${flags}" -fi - -checkyesno() -{ - eval _value=\$${1} - case $_value in - [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) return 0 ;; - [Nn][Oo]|[Ff][Aa][Ll][Ss][Ee]|[Oo][Ff][Ff]|0) return 1 ;; - *) - echo "\$${1} is not set properly." - return 1 - ;; - esac -} - -cmd=${1:-start} -case ${cmd} in -force*) - cmd=${cmd#force} - eval ${rcvar}=YES - ;; -esac - -if checkyesno ${rcvar} -then -else - exit 0 -fi - -case ${cmd} in -start) - if [ -x $D/src ]; then - echo "Starting ${name}." - cd $D/src - ERL_MAX_PORTS=32000 export ERL_MAX_PORTS - ulimit -n $ERL_MAX_PORTS - su jabber -c "/usr/pkg/bin/erl -sname ejabberd -s ejabberd -heart -detached -sasl sasl_error_logger '{file, \"ejabberd-sasl.log\"}' &" \ - 1>/dev/null 2>&1 - fi - ;; -stop) - echo "rpc:call('ejabberd@`hostname -s`', init, stop, [])." | \ - su jabber -c "/usr/pkg/bin/erl -sname ejabberdstop" - ;; -restart) - echo "rpc:call('ejabberd@`hostname -s`', init, restart, [])." | \ - su jabber -c "/usr/pkg/bin/erl -sname ejabberdrestart" - ;; -*) - echo "Usage: $0 {start|stop|restart}" - exit 1 -esac diff --git a/examples/mtr/ejabberd-netbsd.sh b/examples/mtr/ejabberd-netbsd.sh deleted file mode 100644 index 31d01b6b8..000000000 --- a/examples/mtr/ejabberd-netbsd.sh +++ /dev/null @@ -1,81 +0,0 @@ -#!/bin/sh - -echo '1. fetch, compile, and install erlang' - -if [ ! pkg_info erlang 1>/dev/null 2>&1 ]; then - cd /usr/pkgsrc/lang/erlang - make fetch-list|sh - make - make install -fi -if pkg_info erlang | grep -q erlang-9.1nb1; then -else - echo "erlang-9.1nb1 not installed" 1>&2 - exit 1 -fi - - -echo '2. install crypt_drv.so' - -if [ ! -d /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib ] ; then - mkdir -p /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib -fi -if [ ! -f /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib/crypto_drv.so ]; then - cp work/otp*/lib/crypto/priv/*/*/crypto_drv.so \ - /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib -fi - - -echo '3. compile and install elibcrypto.so' - -if [ ! -f /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib/elibcrypto.so ]; then -cd /usr/pkgsrc/lang/erlang/work/otp_src_R9B-1/lib/crypto/c_src -ld -r -u CRYPTO_set_mem_functions -u MD5 -u MD5_Init -u MD5_Update \ - -u MD5_Final -u SHA1 -u SHA1_Init -u SHA1_Update -u SHA1_Final \ - -u des_set_key -u des_ncbc_encrypt -u des_ede3_cbc_encrypt \ - -L/usr/lib -lcrypto -o ../priv/obj/i386--netbsdelf/elibcrypto.o -cc -shared \ - -L/usr/pkgsrc/lang/erlang/work/otp_src_R9B-1/lib/erl_interface/obj/i386--netbsdelf \ - -o ../priv/obj/i386--netbsdelf/elibcrypto.so \ - ../priv/obj/i386--netbsdelf/elibcrypto.o -L/usr/lib -lcrypto -cp ../priv/obj/i386--netbsdelf/elibcrypto.so \ - /usr/pkg/lib/erlang/lib/crypto-1.1.2.1/priv/lib -fi - - -echo '4. compile and install ssl_esock' - -if [ ! -f /usr/pkg/lib/erlang/lib/ssl-2.3.5/priv/bin/ssl_esock ]; then - cd /usr/pkg/lib/erlang/lib/ssl-2.3.5/priv/obj/ - make -fi - - -echo '5. initial ejabberd configuration' - -cd /usr/pkg/jabber/ejabberd/src -./configure - - -echo '6. edit ejabberd Makefiles' - -for M in Makefile mod_*/Makefile; do - if [ ! -f $M.orig ]; then - mv $M $M.orig - sed -e s%/usr/local%/usr/pkg%g < $M.orig > $M - fi -done - - -echo '7. compile ejabberd' - -gmake -for A in mod_muc mod_pubsub; do - (cd $A; gmake) -done - - -echo '' -echo 'now edit ejabberd.cfg' -echo '' -echo 'to start ejabberd: erl -sname ejabberd -s ejabberd' diff --git a/examples/mtr/ejabberd.cfg b/examples/mtr/ejabberd.cfg deleted file mode 100644 index 6f4f4b284..000000000 --- a/examples/mtr/ejabberd.cfg +++ /dev/null @@ -1,66 +0,0 @@ -% jabber.dbc.mtview.ca.us - -override_acls. - -{acl, admin, {user, "mrose", "jabber.dbc.mtview.ca.us"}}. - - -{access, announce, [{allow, admin}, - {deny, all}]}. -{access, c2s, [{deny, blocked}, - {allow, all}]}. -{access, c2s_shaper, [{none, admin}, - {normal, all}]}. -{access, configure, [{allow, admin}, - {deny, all}]}. -{access, disco_admin, [{allow, admin}, - {deny, all}]}. -{access, muc_admin, [{allow, admin}, - {deny, all}]}. -{access, register, [{deny, all}]}. -{access, s2s_shaper, [{fast, all}]}. - - -{auth_method, internal}. -{host, "jabber.dbc.mtview.ca.us"}. -{outgoing_s2s_port, 5269}. -{shaper, normal, {maxrate, 1000}}. -{shaper, fast, {maxrate, 50000}}. -{welcome_message, none}. - - -{listen, [{5222, ejabberd_c2s, - [{access, c2s}, - {shaper, c2s_shaper}]}, - {5223, ejabberd_c2s, - [{access, c2s}, - {shaper, c2s_shaper}, - {ssl, [{certfile, "/etc/openssl/certs/ejabberd.pem"}]}]}, - {5269, ejabberd_s2s_in, - [{shaper, s2s_shaper}]}]}. - - -{modules, [ - {mod_register, []}, - {mod_roster, []}, - {mod_privacy, []}, - {mod_configure, []}, - {mod_disco, []}, - {mod_stats, []}, - {mod_vcard, []}, - {mod_offline, []}, - {mod_echo, [{host, "echo.jabber.dbc.mtview.ca.us"}]}, - {mod_private, []}, -% {mod_irc, []}, - {mod_muc, []}, - {mod_pubsub, []}, - {mod_time, []}, - {mod_last, []}, - {mod_version, []} - ]}. - - - -% Local Variables: -% mode: erlang -% End: From caf07d09bf42d9135d5a239680d8795f5f7d78df Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 27 Sep 2010 13:35:08 +0200 Subject: [PATCH 18/34] Remove files about obsolete transports (EJAB-1311) --- .../configs/aim-transport.xml | 77 --------- examples/transport-configs/configs/ile.xml | 136 ---------------- .../configs/jabber-gg-transport.xml | 149 ------------------ examples/transport-configs/configs/jit.xml | 128 --------------- .../configs/msn-transport.xml | 118 -------------- .../configs/yahoo-transport-2.xml | 86 ---------- .../init-scripts/aim-transport | 45 ------ examples/transport-configs/init-scripts/ile | 43 ----- .../init-scripts/jabber-gg-transport | 47 ------ examples/transport-configs/init-scripts/jit | 45 ------ .../init-scripts/msn-transport | 50 ------ .../init-scripts/yahoo-transport-2 | 45 ------ 12 files changed, 969 deletions(-) delete mode 100644 examples/transport-configs/configs/aim-transport.xml delete mode 100644 examples/transport-configs/configs/ile.xml delete mode 100644 examples/transport-configs/configs/jabber-gg-transport.xml delete mode 100644 examples/transport-configs/configs/jit.xml delete mode 100644 examples/transport-configs/configs/msn-transport.xml delete mode 100644 examples/transport-configs/configs/yahoo-transport-2.xml delete mode 100755 examples/transport-configs/init-scripts/aim-transport delete mode 100755 examples/transport-configs/init-scripts/ile delete mode 100755 examples/transport-configs/init-scripts/jabber-gg-transport delete mode 100755 examples/transport-configs/init-scripts/jit delete mode 100755 examples/transport-configs/init-scripts/msn-transport delete mode 100755 examples/transport-configs/init-scripts/yahoo-transport-2 diff --git a/examples/transport-configs/configs/aim-transport.xml b/examples/transport-configs/configs/aim-transport.xml deleted file mode 100644 index 41804c69d..000000000 --- a/examples/transport-configs/configs/aim-transport.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - - - - - %d: [%t] (%h): %s - /var/log/jabber/aim-transport-error.log - - - - - record - %d %h %s - /var/log/jabber/aim-transport-record.log - - - - - - - - /usr/local/lib/jabber/libjabberdxdbfile.so - - - /var/spool/jabber - - - - - - - - - - AIM/ICQ Transport - This is the AIM/ICQ Transport. - EMAIL@ADDRESS.COM - http://aim-transport.jabberstudio.org/ - - cp1252 - - - - /usr/local/lib/jabber/aim-transport.so - - - - - - - - - 127.0.0.1 - 5233 - SECRET - - - - /var/run/jabber/aim-transport.pid - - diff --git a/examples/transport-configs/configs/ile.xml b/examples/transport-configs/configs/ile.xml deleted file mode 100644 index 5999f0fbd..000000000 --- a/examples/transport-configs/configs/ile.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - 127.0.0.1 - 5238 - SECRET - ile.SERVER.COM - 7 - en - - I Love Email - With this service you can receive email notifications. - -Security warning: Be careful when using this. Your password will travel in clear from your client to your jabber server if you don't use SSL and it will probably travel in clear from the jabber server to your email server. Use with care. This shouldn't be an issue in your Intranet, but it is if you use an ILE installed in a foreign jabber server. - EMAIL@ADDRESS.COM - http://ile.jabberstudio.org/ - - - - - /var/log/jabber/ile.log - 1 - - - - 10 - 20 - - - - /var/spool/jabber/ile.SERVER.COM/users.db - /var/spool/jabber/ile.SERVER.COM/passwords.db - /var/spool/jabber/ile.SERVER.COM/hosts.db - /var/spool/jabber/ile.SERVER.COM/types.db - /var/spool/jabber/ile.SERVER.COM/notifyxa.db - /var/spool/jabber/ile.SERVER.COM/notifydnd.db - /var/spool/jabber/ile.SERVER.COM/urls.db - - -
    - - Please fill in the fields,according to your email account settings and notification preferences - ILE: Email notification service - Email account settings - Username - Password - Hostname - Type - You have received NUM email messages since last time I checked, which was CHECKINTERVAL minutes ago. - There was an error while trying to check mail for ACCOUNT. - Notification Options - Notify even when Xtended Away (XA) - Notify even when Do Not Disturb (DND) - Webmail URL - Login to ACCOUNT - ILE: an email notifier component: http://ile.jabberstudio.org - - - - Por favor, rellene los campos del formulario. - ILE: Servicio de notificación de correo - Configuración de la cuenta de correo - Usuario - Clave - Host - Tipo - Ha recibido NUM email(s) desde la última comprobación que fue hace CHECKINTERVAL minutos - Ha habido un error en la comprobación del correo para la cuenta ACCOUNT. - Opciones de notificación - Notificar incluso si muy ausente (XA) - Notificar incluso si no molestar (DND) - Webmail URL - Leer correo de ACCOUNT - ILE: un notificador de nuevo email - http://ile.jabberstudio.org - - - - Ompli els camps del formulari. - ILE: Servei de notificació de nou email - Dades del compte de mail - Usuari - Clau - Host - Tipus - Ha rebut NUM email(s) des de la última comprobació que va ser fa CHECKINTERVAL minuts. - S'ha produit un error en la comprobació del correu per al compte ACCOUNT. - Opcions de notificació - Notificar si molt absent (XA) - Notificar si no molestar (DND) - Webmail URL - Llegir correu de ACCOUNT - ILE: un notificador de nou email - http://ile.jabberstudio.org - - - - - Va rog completati urmatoarele campuri - I Love Email: new email notification service - Email account settings - Nume utilizator - Parola - Nume gazda - Tip - Ati primit NUM mesaj(e) de la ultima verificare, care a fost acum CHECKINTERVAL minute. - A fost eroare in timp ce incercam sa verific posta pentru ACCOUNT. - Notification Options - Notify even when Xtended Away (XA) - Notify even when Do Not Disturb (DND) - Webmail URL - Login to ACCOUNT - ILE: an email notifier component: http://ile.jabberstudio.org - - - - - Vul volgende velden in. - ILE: Dienst voor e-mailnotificaties - Instellingen van e-mailaccount - Gebruikersnaam - Wachtwoord - Inkomende mailserver - Type verbinding - U hebt NUM berichten ontvangen sinds CHECKINTERVAL minuten geleden. - Fout tijdens controle op nieuwe e-mails bij ACCOUNT. ILE zal deze account niet meer opnieuw controleren tot u uw registratiegegevens wijzigt of opnieuw aanmeldt. - Notificatie-instellingen - Notificeer ook in de status Niet Beschikbaar (XA) - Notificeer ook in de status Niet Storen (DND) - URL van webmail - Aanmelden op ACCOUNT - ILE: een dienst om e-mailnotificaties te ontvangen: http://ile.jabberstudio.org - - -
    - -     \ No newline at end of file diff --git a/examples/transport-configs/configs/jabber-gg-transport.xml b/examples/transport-configs/configs/jabber-gg-transport.xml deleted file mode 100644 index 39d8c0b64..000000000 --- a/examples/transport-configs/configs/jabber-gg-transport.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - 127.0.0.1 - 5237 - SECRET - - - - - - Fill in your GG number (after "username") - and password to register on the transport. -

    To change your information in the GaduGadu directory you need to fill in the other fields. -

    To remove registration you need to leave the form blank. - - - - - - - To search people:
    - First fill in surname or family name, nickname, city, birthyear or range of birthyears (eg. 1950-1960) - and gender (you may fill in more fields at once).
    - or
    - Fill in phone number
    - or
    - Fill in the GG number of the person you are searching. -     -     - - - - Please fill in the GaduGadu number of the person you want to add. - - GG Nummer - - - - Gadu-Gadu Transport - This is the Gadu-Gadu Transport. - EMAIL@ADDRESS.COM - http://www.jabberstudio.org/projects/jabber-gg-transport/ - - - - - - - - /var/log/jabber/jabber-gg-transport.log - - - - - - 60 - 10 - - - 315360000 - - - 300 - - - 60 - - - 5 - - - - - - - /var/spool/jabber/gg.SERVER.COM/ - - - /var/run/jabber/jabber-gg-transport.pid - - - GG_TRANSPORT_ADMIN@SERVER.COM - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/examples/transport-configs/configs/jit.xml b/examples/transport-configs/configs/jit.xml deleted file mode 100644 index c0d78c40a..000000000 --- a/examples/transport-configs/configs/jit.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - - - - - /var/log/jabber/jit-error - - - - - record - /var/log/jabber/jit-record - - - - - - - - /usr/local/lib/jabber/xdb_file.so - - - /var/spool/jabber - - - - - - - - sms.icq.SERVER.COM - - - - sms.icq.SERVER.COM - - away - - - Fill in your UIN and password. - Search ICQ users. - - ICQ Transport (JIT) - This is the Jabber ICQ Transport. - EMAIL@ADDRESS.COM - http://jit.jabberstudio.org/ - - - 3907 - - - - - - - - - - - - /var/spool/jabber/jit-count - - 5 - - 5 - - 18000 - windows-1252 - - login.icq.com - - - - - /usr/local/lib/jabber/jit.so - - - - - - - SERVER.COM - - - 127.0.0.1 - 5234 - SECRET - - - - /var/run/jabber/jit.pid - - diff --git a/examples/transport-configs/configs/msn-transport.xml b/examples/transport-configs/configs/msn-transport.xml deleted file mode 100644 index a6f1391db..000000000 --- a/examples/transport-configs/configs/msn-transport.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - - - - - %d: [%t] (%h): %s - /var/log/jabber/msn-transport-error.log - - - - - record - %d %h %s - /var/log/jabber/msn-transport-record.log - - - - - - - - /usr/local/lib/jabber/libjabberdxdbfile.so - - - /var/spool/jabber - - - - - - - - - Fill in your MSN account and password (eg: user1@hotmail.com). A nickname is optional. - - MSN Transport - This is the MSN Transport. - EMAIL@ADDRESS.COM - http://msn-transport.jabberstudio.org/ - - - - - More than one user entered this chat session. Enter this room to switch to groupchat modus. - - is available - has leaved the room - - - - - - - - - - /usr/local/lib/jabber/msn-transport.so - - - - - - - - - 127.0.0.1 - 5235 - SECRET - - - - /var/run/jabber/msn-transport.pid - - diff --git a/examples/transport-configs/configs/yahoo-transport-2.xml b/examples/transport-configs/configs/yahoo-transport-2.xml deleted file mode 100644 index 2d077aa7a..000000000 --- a/examples/transport-configs/configs/yahoo-transport-2.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - - - - %d: [%t] (%h): %s - /var/log/jabber/yahoo-transport-2-error.log - - - - - - - - - /usr/local/lib/jabber/libjabberdxdbfile.so - - - /var/spool/jabber - - - - - - - - - - Yahoo! Transport - vCard not implemented in current version - This is the Yahoo! transport. - EMAIL@ADDRESS.COM - http://yahoo-transport-2.jabberstudio.org/ - - Fill in your YAHOO! Messenger username and password to register on this transport. - scs.msg.yahoo.com - 5050 - - CP1252 - - - - - - /usr/local/lib/jabber/yahoo-transport-2.so - - - - - - - - - 127.0.0.1 - 5236 - SECRET - - - - /var/run/jabber/yahoo-transport-2.pid - - diff --git a/examples/transport-configs/init-scripts/aim-transport b/examples/transport-configs/init-scripts/aim-transport deleted file mode 100755 index e13d6572f..000000000 --- a/examples/transport-configs/init-scripts/aim-transport +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/sh -######################################################### -# -# aim-transport -- script to start aim-transport. -# -######################################################### - -DAEMON=/usr/local/sbin/jabberd-aim-transport -CONF=/etc/jabber/aim-transport.xml -NAME=jabberd-aim-transport -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/ile b/examples/transport-configs/init-scripts/ile deleted file mode 100755 index a1e072f2c..000000000 --- a/examples/transport-configs/init-scripts/ile +++ /dev/null @@ -1,43 +0,0 @@ -#!/bin/sh -######################################################### -# -# ile -- script to start ILE. -# -######################################################### - -DAEMON=/usr/local/sbin/ile.pl -NAME=ile.pl -CONF=/etc/jabber/ile.xml -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - echo "Not implemented yet. Starting in normal mode" - $0 start - ;; - start) - test -f $DAEMON || exit 0 - echo "Starting $NAME." - $DAEMON $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|status|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/jabber-gg-transport b/examples/transport-configs/init-scripts/jabber-gg-transport deleted file mode 100755 index 269685d0d..000000000 --- a/examples/transport-configs/init-scripts/jabber-gg-transport +++ /dev/null @@ -1,47 +0,0 @@ -#!/bin/sh -######################################################### -# -# jabber-gg-transport -- script to start jabber-gg-transport. -# -######################################################### - -DAEMON=/usr/local/sbin/jggtrans -CONF=/etc/jabber/jabber-gg-transport.xml -NAME=jggtrans -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - rm /var/run/jabber/jabber-gg-transport.pid - ;; - - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/jit b/examples/transport-configs/init-scripts/jit deleted file mode 100755 index 55e000ee8..000000000 --- a/examples/transport-configs/init-scripts/jit +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/sh -######################################################### -# -# jit -- script to start JIT. -# -######################################################### - -DAEMON=/usr/local/sbin/wpjabber-jit -CONF=/etc/jabber/jit.xml -NAME=wpjabber-jit -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/msn-transport b/examples/transport-configs/init-scripts/msn-transport deleted file mode 100755 index 555ba2b0f..000000000 --- a/examples/transport-configs/init-scripts/msn-transport +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/sh -######################################################### -# -# msn-transport -- script to start MSN Transport. -# -######################################################### - -DAEMON=/usr/local/sbin/jabberd-msn-transport -CONF=/etc/jabber/msn-transport.xml -NAME=jabberd-msn-transport -HOME=/etc/jabber/ -USER=ejabberd - -######################################################### - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - strace) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in strace mode." - strace -o /opt/ejabberd/var/log/jabber/strace.log $DAEMON -H $HOME -c $CONF & - ;; - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac diff --git a/examples/transport-configs/init-scripts/yahoo-transport-2 b/examples/transport-configs/init-scripts/yahoo-transport-2 deleted file mode 100755 index fde78a913..000000000 --- a/examples/transport-configs/init-scripts/yahoo-transport-2 +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/sh -############################################################## -# -# yahoo-transport-2 -- script to start Yahoo-transport-2. -# -############################################################# - -DAEMON=/usr/local/sbin/jabberd-yahoo-transport-2 -CONF=/etc/jabber/yahoo-transport-2.xml -NAME=jabberd-yahoo-transport-2 -HOME=/etc/jabber/ -USER=ejabberd - -############################################################# - -if [ "`/usr/bin/whoami`" != "$USER" ]; then - - echo "You need to be" $USER "user to run this script." - exit 1 -fi - -case "$1" in - debug) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME in debugging mode." - $DAEMON -D -H $HOME -c $CONF & - ;; - start) - test -f $DAEMON -a -f $CONF || exit 0 - echo "Starting $NAME." - $DAEMON -H $HOME -c $CONF & - ;; - stop) - echo "Stopping $NAME." - killall $NAME & - ;; - restart|reload) - $0 stop - sleep 3 - $0 start - ;; - *) - echo "Usage: $0 {debug|start|stop|restart}" - exit 1 -esac From 2293bd6855b45998b6ad7593ad7ccf981cf89b46 Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 27 Sep 2010 13:35:33 +0200 Subject: [PATCH 19/34] Move the extauth example script to the tools dir (EJAB-1311) --- {examples/extauth => tools}/check_pass_null.pl | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {examples/extauth => tools}/check_pass_null.pl (100%) diff --git a/examples/extauth/check_pass_null.pl b/tools/check_pass_null.pl similarity index 100% rename from examples/extauth/check_pass_null.pl rename to tools/check_pass_null.pl From 819dbdbf59e653f9f521ec8360da4170bb09bfea Mon Sep 17 00:00:00 2001 From: Badlop Date: Mon, 27 Sep 2010 13:39:15 +0200 Subject: [PATCH 20/34] Move the extract_translations code to the tools dir (EJAB-1311) --- src/Makefile.in | 2 +- {contrib => tools}/extract_translations/README | 0 .../extract_translations/extract_translations.erl | 0 {contrib => tools}/extract_translations/prepare-translation.sh | 2 +- 4 files changed, 2 insertions(+), 2 deletions(-) rename {contrib => tools}/extract_translations/README (100%) rename {contrib => tools}/extract_translations/extract_translations.erl (100%) rename {contrib => tools}/extract_translations/prepare-translation.sh (99%) diff --git a/src/Makefile.in b/src/Makefile.in index 808137a3c..019fb7c38 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -166,7 +166,7 @@ $(ERLSHLIBS): %.so: %.c $(DYNAMIC_LIB_CFLAGS) translations: - ../contrib/extract_translations/prepare-translation.sh -updateall + ../tools/extract_translations/prepare-translation.sh -updateall install: all # diff --git a/contrib/extract_translations/README b/tools/extract_translations/README similarity index 100% rename from contrib/extract_translations/README rename to tools/extract_translations/README diff --git a/contrib/extract_translations/extract_translations.erl b/tools/extract_translations/extract_translations.erl similarity index 100% rename from contrib/extract_translations/extract_translations.erl rename to tools/extract_translations/extract_translations.erl diff --git a/contrib/extract_translations/prepare-translation.sh b/tools/extract_translations/prepare-translation.sh similarity index 99% rename from contrib/extract_translations/prepare-translation.sh rename to tools/extract_translations/prepare-translation.sh index 7a40fee78..847c4f5d2 100755 --- a/contrib/extract_translations/prepare-translation.sh +++ b/tools/extract_translations/prepare-translation.sh @@ -16,7 +16,7 @@ prepare_dirs () EJA_SRC_DIR=$EJA_DIR/src/ EJA_MSGS_DIR=$EJA_SRC_DIR/msgs/ - EXTRACT_DIR=$EJA_DIR/contrib/extract_translations/ + EXTRACT_DIR=$EJA_DIR/tools/extract_translations/ EXTRACT_ERL=$EXTRACT_DIR/extract_translations.erl EXTRACT_BEAM=$EXTRACT_DIR/extract_translations.beam From f7dc4df7846534b6eee40177e45848650168c07e Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Tue, 28 Sep 2010 10:06:16 +0200 Subject: [PATCH 21/34] Allow use with binary() Host from exmpp (thanks to Karim Gemayel) --- src/gen_mod.erl | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/gen_mod.erl b/src/gen_mod.erl index d13b348d0..08ae0f88d 100644 --- a/src/gen_mod.erl +++ b/src/gen_mod.erl @@ -246,6 +246,8 @@ get_hosts(Opts, Prefix) -> Hosts end. +get_module_proc(Host, Base) when is_binary(Host) -> + get_module_proc(binary_to_list(Host), Base); get_module_proc(global, Base) -> list_to_atom(atom_to_list(Base) ++ "__global"); get_module_proc(Host, {frontend, Base}) -> From 403690a49879f7e6666d6cb0fa5cefc981080d40 Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 28 Sep 2010 16:05:53 +0200 Subject: [PATCH 22/34] Only install the guide.html files when it was compiled (EJAB-1311) --- src/Makefile.in | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/Makefile.in b/src/Makefile.in index 019fb7c38..f03f7fae8 100644 --- a/src/Makefile.in +++ b/src/Makefile.in @@ -248,9 +248,11 @@ install: all # # Documentation install -d $(DOCDIR) - install -m 644 ../doc/dev.html $(DOCDIR) - install -m 644 ../doc/guide.html $(DOCDIR) - install -m 644 ../doc/*.png $(DOCDIR) + [ -f ../doc/guide.html ] \ + && install -m 644 ../doc/dev.html $(DOCDIR) \ + && install -m 644 ../doc/guide.html $(DOCDIR) \ + && install -m 644 ../doc/*.png $(DOCDIR) \ + || echo "No ../doc/guide.html was built" install -m 644 ../doc/*.txt $(DOCDIR) [ -f ../doc/guide.pdf ] \ && install -m 644 ../doc/guide.pdf $(DOCDIR) \ From 56b66ab64feeb7b1baf3847faf93fee6e6af7663 Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 28 Sep 2010 16:05:33 +0200 Subject: [PATCH 23/34] Dialyzer fixes. Ensure all_table_hosts/1 returns only a list of binaries --- src/gen_storage.erl | 22 +++++++++++++++------- src/gen_storage_odbc.erl | 2 +- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/src/gen_storage.erl b/src/gen_storage.erl index 99af489fe..541bcd776 100644 --- a/src/gen_storage.erl +++ b/src/gen_storage.erl @@ -58,14 +58,21 @@ behaviour_info(_) -> -include("ejabberd.hrl"). % This is used for ERROR_MSG %% Returns all hosts where the table Tab is defined --spec all_table_hosts(atom()) -> +-spec all_table_hosts(storage_table()) -> [storage_host()]. all_table_hosts(Tab) -> - mnesia:dirty_select(table, [{{table, {'$1', '$2'}, '_', '_'}, + TT = setelement(2, {table, {<<"hidding_from_dialyzer">>, '$2'}, '_', '_'}, {'$1', '$2'}), + Res = (catch mnesia:dirty_select(table, [{TT, [{'=:=', '$2', {const, Tab}}], - ['$1']}]). + ['$1']}])), + case Res of + Res when is_list(Res) -> + [HostB || HostB <- Res, is_binary(HostB)]; + _ -> + [] + end. --spec table_info(storage_host, storage_table, atom()) -> +-spec table_info(storage_host(), storage_table(), atom()) -> any(). table_info(Host, Tab, InfoKey) -> Info = @@ -108,7 +115,7 @@ table_info(Host, Tab, InfoKey) -> %% option() is any mnesia option %% columndef() defaults to text for all unspecified attributes --spec create_table(atom(), storage_host(), storage_table(), #table{}) -> +-spec create_table(atom(), storage_host(), storage_table(), list()) -> tuple(). create_table(mnesia, Host, Tab, Def) -> @@ -130,9 +137,9 @@ define_table(Backend, Host, Name, Def) -> backend = Backend, def = Def}). -%% @spec (#table{}) -> [{atom(), any()}] +%% @spec (list()) -> [{atom(), any()}] --spec filter_mnesia_tabdef(#table{}) -> +-spec filter_mnesia_tabdef(list()) -> [any()]. filter_mnesia_tabdef(TabDef) -> @@ -202,6 +209,7 @@ dirty_read(Host, Tab, Key) -> | {'or', matchrule(), matchrule()} | {'orelse', matchrule(), matchrule()} | {'=', Attribute::atom(), matchvalue()} + | {'<', Attribute::atom(), matchvalue()} | {'=/=', Attribute::atom(), matchvalue()} | {like, Attribute::atom(), matchvalue()}). diff --git a/src/gen_storage_odbc.erl b/src/gen_storage_odbc.erl index 6da489da2..9fd56b4a7 100644 --- a/src/gen_storage_odbc.erl +++ b/src/gen_storage_odbc.erl @@ -22,7 +22,7 @@ attributes :: [string()], % Columns columns :: string(), % "\"col1\", \"col2\" ,..." column_names :: [{string(), [string()]}], % [{string(), [string()]}] (already quoted) - types :: [{string(), atom()}], + types :: [{string(), atom() | tuple()}], host :: string() }). -record(odbc_cont, {tabdef, sql, offset = 0, limit}). From c57f726ecbf2191a569a2b466229eb7b618a350e Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 28 Sep 2010 16:05:45 +0200 Subject: [PATCH 24/34] Fix some Dialyzer warnings --- src/ejabberd_admin.erl | 4 ++-- src/mod_vcard.erl | 26 ++++++++++++++------------ src/mod_vcard_odbc.erl | 19 ++----------------- 3 files changed, 18 insertions(+), 31 deletions(-) diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl index 6818e8c04..c563dd7bd 100644 --- a/src/ejabberd_admin.erl +++ b/src/ejabberd_admin.erl @@ -388,11 +388,11 @@ import_dir(Path) -> %%% delete_expired_messages() -> - {atomic, ok} = mod_offline:remove_expired_messages(), + mod_offline:remove_expired_messages(), ok. delete_old_messages(Days) -> - {atomic, _} = mod_offline:remove_old_messages(Days), + mod_offline:remove_old_messages(Days), ok. diff --git a/src/mod_vcard.erl b/src/mod_vcard.erl index e090ab112..f38fe7cfc 100644 --- a/src/mod_vcard.erl +++ b/src/mod_vcard.erl @@ -218,8 +218,8 @@ process_local_iq(_From, _To, #iq{type = set} = IQ_Rec) -> process_sm_iq(_From, To, #iq{type = get} = IQ_Rec) -> - LUser = exmpp_jid:prep_node_as_list(To), - LServer = exmpp_jid:prep_domain_as_list(To), + LUser = exmpp_jid:prep_node(To), + LServer = exmpp_jid:prep_domain(To), case get_vcard(LUser, LServer) of {vcard, VCard} -> exmpp_iq:result(IQ_Rec, VCard); @@ -229,15 +229,16 @@ process_sm_iq(_From, To, #iq{type = get} = IQ_Rec) -> process_sm_iq(From, _To, #iq{type = set, payload = Request} = IQ_Rec) -> User = exmpp_jid:node_as_list(From), LServer = exmpp_jid:prep_domain_as_list(From), + LServerB = exmpp_jid:prep_domain(From), case ?IS_MY_HOST(LServer) of true -> - set_vcard(User, LServer, Request), + set_vcard(User, LServer, LServerB, Request), exmpp_iq:result(IQ_Rec); false -> exmpp_iq:error(IQ_Rec, 'not-allowed') end. -%% @spec (User::string(), Host::string()) -> {vcard, xmlel()} | novcard +%% @spec (User::binary(), Host::binary()) -> {vcard, xmlel()} | novcard get_vcard(User, Host) -> US = {User, Host}, case gen_storage:dirty_read(Host, {vcard, US}) of @@ -253,7 +254,7 @@ get_vcard(User, Host) -> end. -set_vcard(User, LServer, VCARD) -> +set_vcard(User, LServer, LServerB, VCARD) -> FN = exmpp_xml:get_path(VCARD, [{element, 'FN'}, cdata_as_list]), Family = exmpp_xml:get_path(VCARD, @@ -301,14 +302,14 @@ set_vcard(User, LServer, VCARD) -> US = {LUser, LServer}, - VcardToStore = case gen_storage:table_info(LServer, vcard, backend) of + VcardToStore = case gen_storage:table_info(LServerB, vcard, backend) of mnesia -> VCARD; odbc -> lists:flatten(exmpp_xml:document_to_list(VCARD)) end, F = fun() -> - gen_storage:write(LServer, #vcard{user_host = US, vcard = VcardToStore}), - gen_storage:write(LServer, + gen_storage:write(LServerB, #vcard{user_host = US, vcard = VcardToStore}), + gen_storage:write(LServerB, #vcard_search{user_host=US, username = User, lusername = LUser, fn = FN, lfn = LFN, @@ -324,8 +325,8 @@ set_vcard(User, LServer, VCARD) -> orgunit = OrgUnit, lorgunit = LOrgUnit }) end, - gen_storage:transaction(LServer, vcard, F), LServerB = list_to_binary(LServer), + gen_storage:transaction(LServerB, vcard, F), ejabberd_hooks:run(vcard_set, LServerB, [list_to_binary(LUser), LServerB, VCARD]) catch _ -> @@ -729,10 +730,10 @@ remove_user(User, Server) when is_binary(User), is_binary(Server) -> LServer = binary_to_list(exmpp_stringprep:nameprep(Server)), US = {LUser, LServer}, F = fun() -> - gen_storage:delete(LServer, {vcard, US}), - gen_storage:delete(LServer, {vcard_search, US}) + gen_storage:delete(Server, {vcard, US}), + gen_storage:delete(Server, {vcard_search, US}) end, - gen_storage:transaction(LServer, vcard, F). + gen_storage:transaction(Server, vcard, F). %%% @@ -892,6 +893,7 @@ get_user_photo(User, Host) -> user_queue_parse_query(US, Query) -> {User, Server} = US, + ?INFO_MSG("Query vcard: ~p", [Query]), %+++ case lists:keysearch("removevcard", 1, Query) of {value, _} -> case remove_user(list_to_binary(User), list_to_binary(Server)) of diff --git a/src/mod_vcard_odbc.erl b/src/mod_vcard_odbc.erl index bb0ad5ca8..fc7d95162 100644 --- a/src/mod_vcard_odbc.erl +++ b/src/mod_vcard_odbc.erl @@ -466,10 +466,6 @@ search(LServer, Data) -> MatchSpec = make_matchspec(LServer, Data), AllowReturnAll = gen_mod:get_module_opt(LServer, ?MODULE, allow_return_all, false), - if - (MatchSpec == "") and (not AllowReturnAll) -> - []; - true -> Limit = case gen_mod:get_module_opt(LServer, ?MODULE, matches, ?JUD_MATCHES) of infinity -> @@ -491,7 +487,6 @@ search(LServer, Data) -> Error -> ?ERROR_MSG("~p", [Error]), [] - end end. @@ -500,12 +495,7 @@ make_matchspec(LServer, Data) -> filter_fields(Data, ["host = '", Host, "'"], LServer). filter_fields([], Match, _LServer) -> - case Match of - "" -> - ""; - _ -> - [" where ", Match] - end; + [" where ", Match]; filter_fields([{SVar, [Val]} | Ds], Match, LServer) when is_list(Val) and (Val /= "") -> LVal = exmpp_stringprep:to_lower(Val), @@ -539,12 +529,7 @@ make_val(Match, Field, Val) -> SVal = ejabberd_odbc:escape(Val), [Field, " = '", SVal, "'"] end, - case Match of - "" -> - Condition; - _ -> - [Match, " and ", Condition] - end. + [Match, " and ", Condition]. From 6b7d73dcd565e10718d2e0038dba2245c11fa059 Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Wed, 29 Sep 2010 11:48:19 +0200 Subject: [PATCH 25/34] fix dializer errors, improve documentation (thanks to Karim Gemayel)(EJAB-1260) --- src/mod_pubsub/node_flat.erl | 1237 +++++++++++++++--------- src/mod_pubsub/nodetree_tree.erl | 334 +++++-- src/mod_pubsub/pubsub.hrl | 173 +++- src/mod_pubsub/pubsub_index.erl | 63 +- src/mod_pubsub/pubsub_odbc.patch | 4 +- src/mod_pubsub/pubsub_subscription.erl | 351 ++++--- 6 files changed, 1398 insertions(+), 764 deletions(-) diff --git a/src/mod_pubsub/node_flat.erl b/src/mod_pubsub/node_flat.erl index b7f0a7a16..884b5bc7a 100644 --- a/src/mod_pubsub/node_flat.erl +++ b/src/mod_pubsub/node_flat.erl @@ -46,8 +46,11 @@ -behaviour(gen_pubsub_node). %% API definition --export([init/3, terminate/2, - options/0, features/0, +-export([ + init/3, + terminate/2, + options/0, + features/0, create_node_permission/6, create_node/2, delete_node/1, @@ -79,6 +82,7 @@ path_to_node/1 ]). + %% ================ %% API definition %% ================ @@ -92,6 +96,14 @@ %%

    This function is mainly used to trigger the setup task necessary for the %% plugin. It can be used for example by the developer to create the specific %% module database schema if it does not exists yet.

    +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(_Host, _ServerHost, _Opts) -> pubsub_subscription:init(), mnesia:create_table(pubsub_state, @@ -103,8 +115,7 @@ init(_Host, _ServerHost, _Opts) -> ItemsFields = record_info(fields, pubsub_item), case mnesia:table_info(pubsub_item, attributes) of ItemsFields -> ok; - _ -> - mnesia:transform_table(pubsub_item, ignore, ItemsFields) + _ -> mnesia:transform_table(pubsub_item, ignore, ItemsFields) end, ok. @@ -113,6 +124,13 @@ init(_Host, _ServerHost, _Opts) -> %% ServerHost = host() %% @doc

    Called during pubsub modules termination. Any pubsub plugin must %% implement this function. It can return anything.

    +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(_Host, _ServerHost) -> ok. @@ -133,27 +151,31 @@ terminate(_Host, _ServerHost) -> %% {max_payload_size, 100000}, %% {send_last_published_item, never}, %% {presence_based_delivery, false}]''' +-spec(options/0 :: () -> [nodeOption()]). + options() -> - [{deliver_payloads, true}, - {notify_config, false}, - {notify_delete, false}, - {notify_retract, true}, - {notify_sub, false}, - {purge_offline, false}, - {persist_items, true}, - {max_items, ?MAXITEMS}, - {subscribe, true}, - {access_model, open}, - {roster_groups_allowed, []}, - {publish_model, publishers}, - {notification_type, headline}, - {max_payload_size, ?MAX_PAYLOAD_SIZE}, - {send_last_published_item, on_sub_and_presence}, - {deliver_notifications, true}, - {presence_based_delivery, false}]. + [{'deliver_payloads', true}, + {'notify_config', false}, + {'notify_delete', false}, + {'notify_retract', true}, + {'notify_sub', false}, + {'purge_offline', false}, + {'persist_items', true}, + {'max_items', ?MAXITEMS}, + {'subscribe', true}, + {'access_model', open}, + {'roster_groups_allowed', []}, + {'publish_model', publishers}, + {'notification_type', headline}, + {'max_payload_size', ?MAX_PAYLOAD_SIZE}, + {'send_last_published_item', on_sub_and_presence}, + {'deliver_notifications', true}, + {'presence_based_delivery', false}]. %% @spec () -> [] %% @doc Returns the node features +-spec(features/0 :: () -> [Feature::string()]). + features() -> ["create-nodes", "auto-create", @@ -181,47 +203,67 @@ features() -> %% use same code as node_flat, but do not limite node to %% the home/localhost/user/... hierarchy %% any node is allowed -create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> - LOwner = jlib:short_prepd_jid(Owner), - Allowed = case LOwner of - {undefined, Host, undefined} -> - true; % pubsub service always allowed - _ -> - {LU, LS, LR} = LOwner, - acl:match_rule(ServerHost, Access, exmpp_jid:make(LU, LS, LR)) =:= allow - end, - {result, Allowed}. +-spec(create_node_permission/6 :: + ( + Host :: hostPubsub(), + ServerHost :: string(), + NodeId :: nodeId(), + ParentNodeId :: nodeId(), + JID :: jidEntity(), + Access :: atom()) + -> {'result', IsAllowed::boolean()} + ). + +create_node_permission(Host, ServerHost, _NodeId, _ParentNodeId, #jid{node = U, domain = S, resource = R} = _JID, Access) -> + Owner = {U,S,R}, + IsAllowed = case Owner of + {undefined, Host, undefined} -> true; % pubsub service always allowed + _ -> acl:match_rule(ServerHost, Access, exmpp_jid:make(Owner)) =:= 'allow' + end, + {result, IsAllowed}. %% @spec (NodeId, Owner) -> %% {result, Result} | exit %% NodeId = nodeidx() %% Owner = ljid() %% @doc

    -create_node(NodeId, Owner) -> - OwnerKey = jlib:short_prepd_bare_jid(Owner), - set_state(#pubsub_state{id = {OwnerKey, NodeId}, affiliation = owner}), - {result, {default, broadcast}}. +-spec(create_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} + ). + +create_node(NodeIdx, #jid{node = U, domain = S} = _JID) -> + set_state(#pubsub_state{id = {{U,S,undefined}, NodeIdx}, affiliation = 'owner'}), + {'result', {'default', 'broadcast'}}. %% @spec (Removed) -> ok %% Removed = [mod_pubsub:pubsub_node()] %% @doc

    purge items of deleted nodes after effective deletion.

    -delete_node(Removed) -> - Tr = fun(#pubsub_state{id = {J, _}, subscriptions = Ss}) -> - lists:map(fun(S) -> - {J, S} - end, Ss) - end, - Reply = lists:map( - fun(#pubsub_node{idx = Nidx} = PubsubNode) -> - {result, States} = get_states(Nidx), - lists:foreach( - fun(#pubsub_state{id = {LJID, _}, items = Items}) -> - del_items(Nidx, Items), - del_state(Nidx, LJID) - end, States), - {PubsubNode, lists:flatmap(Tr, States)} - end, Removed), - {result, {default, broadcast, Reply}}. +-spec(delete_node/1 :: + ( + Nodes :: [Node::pubsubNode()]) + -> {result, {'default', 'broadcast', + Reply :: [{Node :: pubsubNode(), + [{Owner :: bareUsr(), + Subscriptions :: [{Subscription :: subscription(), + SubId :: subId()}]}]}]}} + ). + +delete_node(Nodes) -> + Fun = fun(#pubsub_state{id = {Entity, _}, subscriptions = Subscriptions}) -> + [{Entity, Subscription} || Subscription <- Subscriptions] + end, + Reply = lists:map(fun(#pubsub_node{idx = NodeIdx} = Node) -> + {result, States} = get_states(NodeIdx), + lists:foreach(fun(#pubsub_state{id = {Owner, _}, items = ItemIds}) -> + del_items(NodeIdx, ItemIds), + del_state(NodeIdx, Owner), + {Node, lists:flatmap(Fun, States)} + end, States) + end, Nodes), + {'result', {'default', 'broadcast', Reply}}. %% @spec (NodeId, Sender, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> %% {error, Reason} | {result, Result} @@ -256,65 +298,83 @@ delete_node(Removed) -> %% to completly disable persistance. %%

    %%

    In the default plugin module, the record is unchanged.

    -subscribe_node(NodeId, Sender, {U,S,R} = Subscriber, AccessModel, - SendLast, PresenceSubscription, RosterGroup, Options) -> +-spec(subscribe_node/8 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + AccessModel :: accessModel(), + SendLast :: atom(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + Options :: [nodeOption()]) + -> {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId()}} + | {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId(), + SendLast ::' send_last'}} + | {'result', {'default', + Subscription :: 'pending', + SubId :: subId()}} + | {'error', _} %% TODO add all error cases + ). + +subscribe_node(NodeIdx, #jid{node = Usender, domain = Ssender} = _Sender, #jid{node = U, domain = S, resource = R} = Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> SubKey = {U, S, R}, GenKey = {U, S, undefined}, - Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey), - GenState = get_state(NodeId, GenKey), - SubState = case SubKey of - GenKey -> GenState; - _ -> get_state(NodeId, SubKey) - end, - Affiliation = GenState#pubsub_state.affiliation, - Subscriptions = SubState#pubsub_state.subscriptions, - Whitelisted = lists:member(Affiliation, [member, publisher, owner]), - PendingSubscription = lists:any(fun({pending, _}) -> true; - (_) -> false - end, Subscriptions), + Authorized = ({Usender, Ssender, undefined} == GenKey), + GenState = #pubsub_state{affiliation = Affiliation} = get_state(NodeIdx, GenKey), + SubState = #pubsub_state{subscriptions = Subscriptions} = case SubKey of + GenKey -> GenState; + _ -> get_state(NodeIdx, SubKey) + end, + Whitelisted = lists:member(Affiliation, ['member', 'publisher', 'owner']), + PendingSubscription = lists:any(fun + ({'pending', _}) -> true; + (_) -> false + end, Subscriptions), if not Authorized -> %% JIDs do not match - {error, ?ERR_EXTENDED('bad-request', "invalid-jid")}; - Affiliation == outcast -> + {'error', ?ERR_EXTENDED('bad-request', "invalid-jid")}; + Affiliation == 'outcast' -> %% Requesting entity is blocked - {error, 'forbidden'}; + {'error', 'forbidden'}; PendingSubscription -> %% Requesting entity has pending subscription - {error, ?ERR_EXTENDED('not-authorized', "pending-subscription")}; - (AccessModel == presence) and (not PresenceSubscription) -> + {'error', ?ERR_EXTENDED('not-authorized', "pending-subscription")}; + (AccessModel == 'presence') and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) - {error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; - (AccessModel == roster) and (not RosterGroup) -> + {'error', ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; + (AccessModel == 'roster') and (not RosterGroup) -> %% Entity is not authorized to create a subscription (not in roster group) - {error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; - (AccessModel == whitelist) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; + (AccessModel == 'whitelist') and (not Whitelisted) -> %% Node has whitelist access model and entity lacks required affiliation - {error, ?ERR_EXTENDED('not-allowed', "closed-node")}; + {'error', ?ERR_EXTENDED('not-allowed', "closed-node")}; %%MustPay -> - %% % Payment is required for a subscription - %% {error, ?ERR_PAYMENT_REQUIRED}; + %% Payment is required for a subscription + %% {'error', ?ERR_PAYMENT_REQUIRED}; %%ForbiddenAnonymous -> - %% % Requesting entity is anonymous - %% {error, 'forbidden'}; + %% Requesting entity is anonymous + %% {'error', 'forbidden'}; true -> - case pubsub_subscription:subscribe_node(Subscriber, NodeId, Options) of - {result, SubId} -> - NewSub = case AccessModel of - authorize -> pending; - _ -> subscribed - end, - set_state(SubState#pubsub_state{subscriptions = [{NewSub, SubId} | Subscriptions]}), - case {NewSub, SendLast} of - {subscribed, never} -> - {result, {default, subscribed, SubId}}; - {subscribed, _} -> - {result, {default, subscribed, SubId, send_last}}; - {_, _} -> - {result, {default, pending, SubId}} + case pubsub_subscription:subscribe_node(Subscriber, NodeIdx, Options) of + {'result', SubId} -> + NewSubscription = case AccessModel of + 'authorize' -> 'pending'; + _ -> 'subscribed' + end, + set_state(SubState#pubsub_state{subscriptions = [{NewSubscription, SubId} | Subscriptions]}), + case {NewSubscription, SendLast} of + {'subscribed', 'never'} -> {'result', {'default', 'subscribed', SubId}}; + {'subscribed', _} -> {'result', {'default', 'subscribed', SubId, 'send_last'}}; + {_, _} -> {'result', {'default', 'pending', SubId}} end; _ -> - {error, 'internal-server-error'} + {'error', 'internal-server-error'} end end. @@ -326,73 +386,91 @@ subscribe_node(NodeId, Sender, {U,S,R} = Subscriber, AccessModel, %% SubId = mod_pubsub:subid() %% Reason = mod_pubsub:stanzaError() %% @doc

    Unsubscribe the Subscriber from the Node.

    -unsubscribe_node(NodeId, Sender, {U, S, R} = Subscriber, SubId) -> +-spec(unsubscribe_node/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + SubId :: subId()) + -> {'result', 'default'} | {'error', _} %% TODO : add all error cases + ). + +unsubscribe_node(NodeIdx, #jid{node = Usender, domain = Ssender} = _Sender, #jid{node = U, domain = S, resource = R} = _Subscriber, SubId) -> SubKey = {U, S, R}, GenKey = {U, S, undefined}, - Authorized = (jlib:short_prepd_bare_jid(Sender) == GenKey), - GenState = get_state(NodeId, GenKey), + Authorized = ({Usender, Ssender, undefined} == GenKey), + GenState = get_state(NodeIdx, GenKey), SubState = case SubKey of - GenKey -> GenState; - _ -> get_state(NodeId, SubKey) - end, - Subscriptions = lists:filter(fun({_Sub, _SubId}) -> true; - (_SubId) -> false - end, SubState#pubsub_state.subscriptions), + GenKey -> GenState; + _ -> get_state(NodeIdx, SubKey) + end, + Subscriptions = SubState#pubsub_state.subscriptions, SubIdExists = case SubId of - [] -> false; - List when is_list(List) -> true; - _ -> false + <<>> -> false; + SubId when is_binary(SubId) -> true; + _ -> false end, if %% Requesting entity is prohibited from unsubscribing entity not Authorized -> - {error, 'forbidden'}; + {'error', 'forbidden'}; %% Entity did not specify SubId %%SubId == "", ?? -> - %% {error, ?ERR_EXTENDED('bad-request', "subid-required")}; + %% {'error', ?ERR_EXTENDED('bad-request', "subid-required")}; %% Invalid subscription identifier %%InvalidSubId -> - %% {error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; + %% {'error', ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; %% Requesting entity is not a subscriber Subscriptions == [] -> - {error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")}; + {'error', ?ERR_EXTENDED('unexpected-request', "not-subscribed")}; %% Subid supplied, so use that. SubIdExists -> - Sub = first_in_list(fun({_, Id}) when Id == SubId -> true; - (_) -> false - end, Subscriptions), - case Sub of - {value, Subscribed} -> - delete_subscriptions(Subscriber, NodeId, [Subscribed], SubState), - {result, default}; + OldSubscription = first_in_list(fun + ({_, OldSubId}) when OldSubId == SubId -> true; + (_) -> false + end, Subscriptions), + case OldSubscription of + {'value', Subscribed} -> + delete_subscriptions(SubKey, NodeIdx, [Subscribed], SubState), + {'result', 'default'}; false -> - {error, ?ERR_EXTENDED('unexpected-request', "not-subscribed")} + {'error', ?ERR_EXTENDED('unexpected-request', "not-subscribed")} end; %% Asking to remove all subscriptions to the given node - SubId == all -> - delete_subscriptions(SubKey, NodeId, Subscriptions, SubState), - {result, default}; + SubId == 'all' -> + delete_subscriptions(SubKey, NodeIdx, Subscriptions, SubState), + {'result', 'default'}; %% No subid supplied, but there's only one matching %% subscription, so use that. length(Subscriptions) == 1 -> - delete_subscriptions(SubKey, NodeId, Subscriptions, SubState), - {result, default}; + delete_subscriptions(SubKey, NodeIdx, Subscriptions, SubState), + {'result', 'default'}; true -> - {error, ?ERR_EXTENDED('bad-request', "subid-required")} + {'error', ?ERR_EXTENDED('bad-request', "subid-required")} end. -delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) -> - NewSubs = lists:foldl(fun({Subscription, SubId}, Acc) -> - pubsub_subscription:delete_subscription(SubKey, NodeId, SubId), - Acc -- [{Subscription, SubId}] - end, SubState#pubsub_state.subscriptions, Subscriptions), - case {SubState#pubsub_state.affiliation, NewSubs} of - {none, []} -> - % Just a regular subscriber, and this is final item, so - % delete the state. - del_state(NodeId, SubKey); + +-spec(delete_subscriptions/4 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + Subscriptions :: [{Subscription::subscription(), SubId::subId()}], + State :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). + +delete_subscriptions(Entity, NodeIdx, Subscriptions, State) -> + NewSubscriptions = lists:foldl(fun({Subscription, SubId}, Acc) -> + pubsub_subscription:delete_subscription(Entity, NodeIdx, SubId), + Acc -- [{Subscription, SubId}] + end, State#pubsub_state.subscriptions, Subscriptions), + case {State#pubsub_state.affiliation, NewSubscriptions} of + {'none', []} -> + % Just a regular subscriber, and this is final item, so + % delete the state. + del_state(NodeIdx, Entity); _ -> - set_state(SubState#pubsub_state{subscriptions = NewSubs}) + set_state(State#pubsub_state{subscriptions = NewSubscriptions}) end. @@ -434,48 +512,59 @@ delete_subscriptions(SubKey, NodeId, Subscriptions, SubState) -> %% to completly disable persistance. %%

    %%

    In the default plugin module, the record is unchanged.

    -publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> - SubKey = jlib:short_prepd_jid(Publisher), - GenKey = jlib:short_prepd_bare_jid(Publisher), - GenState = get_state(NodeId, GenKey), +-spec(publish_item/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), %% TODO : make a generic publishMod() type + MaxItems :: 'unlimited' | integer(), + ItemId :: itemId(), + Payload :: payload()) + -> {'result', {'default', 'broadcast', ItemIds :: [] | [itemId()]}} + | {'error', _} + ). + +publish_item(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID, PublishModel, MaxItems, ItemId, Payload) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, + GenState = get_state(NodeIdx, GenKey), SubState = case SubKey of - GenKey -> GenState; - _ -> get_state(NodeId, SubKey) - end, + GenKey -> GenState; + _ -> get_state(NodeIdx, SubKey) + end, Affiliation = GenState#pubsub_state.affiliation, Subscribed = case PublishModel of - subscribers -> is_subscribed(SubState#pubsub_state.subscriptions); - _ -> undefined - end, + 'subscribers' -> is_subscribed(SubState#pubsub_state.subscriptions); + _ -> undefined + end, if - not ((PublishModel == open) - or ((PublishModel == publishers) - and ((Affiliation == owner) or (Affiliation == publisher))) - or (Subscribed == true)) -> + not ((PublishModel == 'open') or ((PublishModel == 'publishers') + and ((Affiliation == 'owner') or (Affiliation == 'publisher'))) + or (Subscribed == 'true')) -> %% Entity does not have sufficient privileges to publish to node - {error, 'forbidden'}; + {'error', 'forbidden'}; true -> %% TODO: check creation, presence, roster if MaxItems > 0 -> - Now = now(), - PubId = {Now, SubKey}, - Item = case get_item(NodeId, ItemId) of - {result, OldItem} -> - OldItem#pubsub_item{modification = PubId, - payload = Payload}; - _ -> - #pubsub_item{id = {ItemId, NodeId}, - creation = {Now, GenKey}, - modification = PubId, - payload = Payload} - end, - Items = [ItemId | GenState#pubsub_state.items--[ItemId]], - {result, {NI, OI}} = remove_extra_items(NodeId, MaxItems, Items), - set_item(Item), - set_state(GenState#pubsub_state{items = NI}), - {result, {default, broadcast, OI}}; + Now = now(), + Modification = {Now, SubKey}, + Item = case get_item(NodeIdx, ItemId) of + {'result', OldItem} -> + OldItem#pubsub_item{modification = Modification, payload = Payload}; + _ -> + #pubsub_item{ + id = {ItemId, NodeIdx}, + creation = {Now, GenKey}, % TODO, better use {Now, SubKey} ? + modification = Modification, + payload = Payload} + end, + Items = [ItemId | GenState#pubsub_state.items--[ItemId]], + {result, {NewItems, OldItems}} = remove_extra_items(NodeIdx, MaxItems, Items), + set_item(Item), + set_state(GenState#pubsub_state{items = NewItems}), + {'result', {'default', 'broadcast', OldItems}}; true -> - {result, {default, broadcast, []}} + {'result', {'default', 'broadcast', []}} end end. @@ -494,15 +583,25 @@ publish_item(NodeId, Publisher, PublishModel, MaxItems, ItemId, Payload) -> %% plugin is using the default pubsub storage), it can implements this function like this: %% ```remove_extra_items(NodeId, MaxItems, ItemIds) -> %% node_default:remove_extra_items(NodeId, MaxItems, ItemIds).'''

    -remove_extra_items(_NodeId, unlimited, ItemIds) -> - {result, {ItemIds, []}}; -remove_extra_items(NodeId, MaxItems, ItemIds) -> +-spec(remove_extra_items/3 :: + ( + NodeIdx :: nodeIdx(), + MaxItems :: 'unlimited' | integer(), + ItemsIds :: [ItemId::itemId()]) + -> {'result', + {OldItems :: [] | [ItemId::itemId()], + NewItems :: [] | [ItemId::itemId()]}} + ). + +remove_extra_items(_NodeIdx, 'unlimited', ItemIds) -> + {'result', {ItemIds, []}}; +remove_extra_items(NodeIdx, MaxItems, ItemIds) -> NewItems = lists:sublist(ItemIds, MaxItems), OldItems = lists:nthtail(length(NewItems), ItemIds), %% Remove extra items: - del_items(NodeId, OldItems), + del_items(NodeIdx, OldItems), %% Return the new items list: - {result, {NewItems, OldItems}}. + {'result', {NewItems, OldItems}}. %% @spec (NodeId, Publisher, PublishModel, ItemId) -> %% {error, Reason::stanzaError()} | @@ -514,47 +613,54 @@ remove_extra_items(NodeId, MaxItems, ItemIds) -> %% @doc

    Triggers item deletion.

    %%

    Default plugin: The user performing the deletion must be the node owner %% or a publisher, or PublishModel being open.

    -delete_item(NodeId, Publisher, PublishModel, ItemId) -> - GenKey = jlib:short_prepd_bare_jid(Publisher), - GenState = get_state(NodeId, GenKey), - #pubsub_state{affiliation = Affiliation, items = Items} = GenState, - Allowed = (Affiliation == publisher) orelse (Affiliation == owner) - orelse (PublishModel == open) - orelse case get_item(NodeId, ItemId) of +-spec(delete_item/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), + ItemId :: itemId()) + -> {'result', {'default', 'broadcast'}} | {'error', _} + ). + +delete_item(NodeIdx, #jid{node = U, domain = S} = _JID, PublishModel, ItemId) -> + GenKey = {U,S,undefined}, + GenState = #pubsub_state{affiliation = Affiliation, items = Items} = get_state(NodeIdx, GenKey), + Allowed = (Affiliation == 'publisher') + orelse (Affiliation == 'owner') + orelse (PublishModel == 'open') + orelse case get_item(NodeIdx, ItemId) of {result, #pubsub_item{creation = {_, GenKey}}} -> true; - _ -> false + _ -> false end, if not Allowed -> %% Requesting entity does not have sufficient privileges - {error, 'forbidden'}; + {'error', 'forbidden'}; true -> case lists:member(ItemId, Items) of true -> - del_item(NodeId, ItemId), + del_item(NodeIdx, ItemId), set_state(GenState#pubsub_state{items = lists:delete(ItemId, Items)}), - {result, {default, broadcast}}; + {'result', {'default', 'broadcast'}}; false -> case Affiliation of - owner -> + 'owner' -> %% Owner can delete other publishers items as well - {result, States} = get_states(NodeId), - lists:foldl( - fun(#pubsub_state{items = PI, affiliation = publisher} = S, Res) -> - case lists:member(ItemId, PI) of - true -> - del_item(NodeId, ItemId), - set_state(S#pubsub_state{items = lists:delete(ItemId, PI)}), - {result, {default, broadcast}}; - false -> - Res - end; - (_, Res) -> - Res - end, {error, 'item-not-found'}, States); + {'result', States} = get_states(NodeIdx), + lists:foldl(fun + (#pubsub_state{items = ItemIds, affiliation = publisher} = State, Result) -> + case lists:member(ItemId, ItemIds) of + true -> + del_item(NodeIdx, ItemId), + set_state(State#pubsub_state{items = lists:delete(ItemId, ItemIds)}), + {'result', {'default', 'broadcast'}}; + false -> Result + end; + (_, Result) -> Result + end, {'error', 'item-not-found'}, States); _ -> %% Non-existent node or item - {error, 'item-not-found'} + {'error', 'item-not-found'} end end end. @@ -564,23 +670,29 @@ delete_item(NodeId, Publisher, PublishModel, ItemId) -> %% {result, {default, broadcast}} %% NodeId = nodeidx() %% Owner = ljid() -purge_node(NodeId, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - GenState = get_state(NodeId, GenKey), - case GenState of - #pubsub_state{affiliation = owner} -> - {result, States} = get_states(NodeId), - lists:foreach( - fun(#pubsub_state{items = []}) -> - ok; - (#pubsub_state{items = Items} = S) -> - del_items(NodeId, Items), - set_state(S#pubsub_state{items = []}) - end, States), - {result, {default, broadcast}}; - _ -> - %% Entity is not owner - {error, 'forbidden'} +-spec(purge_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} | {'error', 'forbidden'} + ). + +purge_node(NodeIdx, #jid{node = U, domain = S} = _JID) -> + %GenKey = {U,S,undefined} + %GenState = get_state(NodeIdx, _GenKey = {U,S,undefined}), + case _GenState = get_state(NodeIdx, _GenKey = {U,S,undefined}) of % experimental + #pubsub_state{affiliation = 'owner'} -> + {'result', States} = get_states(NodeIdx), + lists:foreach(fun + (#pubsub_state{items = []}) -> + ok; + (#pubsub_state{items = Items} = State) -> + del_items(NodeIdx, Items), + set_state(State#pubsub_state{items = []}) + end, States), + {'result', {'default', 'broadcast'}}; + _ -> %% Entity is not owner + {'error', 'forbidden'} end. %% @spec (Host, JID) -> [{Node,Affiliation}] @@ -593,41 +705,69 @@ purge_node(NodeId, Owner) -> %% the default PubSub module. Otherwise, it should return its own affiliation, %% that will be added to the affiliation stored in the main %% pubsub_state table.

    -get_entity_affiliations(Host, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, _ = '_'}), - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree - end, - Reply = lists:foldl(fun(#pubsub_state{id = {_, N}, affiliation = A}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{id = {Host, _}} = Node -> [{Node, A}|Acc]; - _ -> Acc - end - end, [], States), +-spec(get_entity_affiliations/2 :: + ( + Host :: binary(), + JID :: jidEntity()) + -> {'result', Reply :: [] | [{Node::pubsubNode(), Affiliation::affiliation()}]} + ). + +get_entity_affiliations(Host, #jid{node = U, domain = S} = _JID) -> + States = mnesia:match_object(#pubsub_state{id = {{U,S,undefined}, '_'}, _ = '_'}), + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' + end, + Reply = lists:foldl(fun + (#pubsub_state{id = {_, NodeIdx}, affiliation = Affiliation}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {Host, _}} = Node -> [{Node, Affiliation}|Acc]; + _ -> Acc + end + end, [], States), {result, Reply}. -get_node_affiliations(NodeId) -> - {result, States} = get_states(NodeId), - Tr = fun(#pubsub_state{id = {J, _}, affiliation = A}) -> - {J, A} - end, - {result, lists:map(Tr, States)}. -get_affiliation(NodeId, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - GenState = get_state(NodeId, GenKey), - {result, GenState#pubsub_state.affiliation}. +-spec(get_node_affiliations/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] | [{Entity::fullUsr(), Affiliation::affiliation()}]} + ). -set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> - GenKey = jlib:short_prepd_bare_jid(Owner), - GenState = get_state(NodeId, GenKey), - case {Affiliation, GenState#pubsub_state.subscriptions} of - {none, none} -> - del_state(NodeId, GenKey); - _ -> - set_state(GenState#pubsub_state{affiliation = Affiliation}) +get_node_affiliations(NodeIdx) -> + {result, States} = get_states(NodeIdx), + Fun = fun(#pubsub_state{id = {Entity, _}, affiliation = Affiliation}) -> + {Entity, Affiliation} + end, + {result, lists:map(Fun, States)}. + + +-spec(get_affiliation/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Affiliation::affiliation()} + ). + +get_affiliation(NodeIdx, #jid{node = U, domain = S} = _JID) -> + #pubsub_state{affiliation = Affiliation} = get_state(NodeIdx, _GenKey = {U,S,undefined}), + {'result', Affiliation}. + + +-spec(set_affiliation/3 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Affiliation :: affiliation()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_affiliation(NodeIdx, #jid{node = U, domain = S} = _JID, Affiliation) -> + GenKey = {U,S,undefined}, + GenState = #pubsub_state{subscriptions = Subscriptions} = get_state(NodeIdx, GenKey), + case {Affiliation, Subscriptions} of + {'none', []} -> del_state(NodeIdx, GenKey); + _ -> set_state(GenState#pubsub_state{affiliation = Affiliation}) end. %% @spec (Host, Owner) -> [{Node,Subscription}] @@ -640,154 +780,225 @@ set_affiliation(NodeId, Owner, Affiliation) when ?IS_JID(Owner)-> %% the default PubSub module. Otherwise, it should return its own affiliation, %% that will be added to the affiliation stored in the main %% pubsub_state table.

    -get_entity_subscriptions(Host, Owner) -> - {U, D, _} = SubKey = jlib:short_prepd_jid(Owner), - GenKey = jlib:short_prepd_bare_jid(Owner), +-spec(get_entity_subscriptions/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> {'result', [] + | [{Node :: pubsubNode(), + Subscription :: subscription(), + SubId :: subId(), + Entity :: fullUsr()}]} + ). + +get_entity_subscriptions(Host, #jid{node = U, domain = S, resource = R} = _JID) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, States = case SubKey of - GenKey -> mnesia:match_object( - #pubsub_state{id = {{U, D, '_'}, '_'}, _ = '_'}); - _ -> mnesia:match_object( - #pubsub_state{id = {GenKey, '_'}, _ = '_'}) - ++ mnesia:match_object( - #pubsub_state{id = {SubKey, '_'}, _ = '_'}) - end, - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree - end, - Reply = lists:foldl(fun(#pubsub_state{id = {J, N}, subscriptions = Ss}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{id = {Host, _}} = Node -> - lists:foldl(fun({Sub, SubId}, Acc2) -> - [{Node, Sub, SubId, J} | Acc2]; - (S, Acc2) -> - [{Node, S, J} | Acc2] - end, Acc, Ss); - _ -> Acc - end - end, [], States), + GenKey -> + mnesia:match_object(#pubsub_state{id = {{U, S, '_'}, '_'}, _ = '_'}); + _ -> + mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, _ = '_'}) + ++ + mnesia:match_object(#pubsub_state{id = {SubKey, '_'}, _ = '_'}) + end, + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' + end, + Reply = lists:foldl(fun + (#pubsub_state{id = {Entity, NodeIdx}, subscriptions = Subscriptions}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {Host, _}} = Node -> + lists:foldl(fun + ({Subscription, SubId}, Acc2) -> [{Node, Subscription, SubId, Entity} | Acc2] + %(Subscriptions, Acc2) -> [{Node, Subscription, Entity} | Acc2] + end, Acc, Subscriptions); + _ -> Acc + end + end, [], States), {result, Reply}. -get_node_subscriptions(NodeId) -> - {result, States} = get_states(NodeId), - Tr = fun(#pubsub_state{id = {J, _}, subscriptions = Subscriptions}) -> - %% TODO: get rid of cases to handle non-list subscriptions - case Subscriptions of - [_|_] -> - lists:foldl(fun({S, SubId}, Acc) -> - [{J, S, SubId} | Acc]; - (S, Acc) -> - [{J, S} | Acc] - end, [], Subscriptions); - [] -> - []; - _ -> - [{J, none}] - end - end, - {result, lists:flatmap(Tr, States)}. -get_subscriptions(NodeId, Owner) -> - SubKey = jlib:short_prepd_jid(Owner), - SubState = get_state(NodeId, SubKey), - {result, SubState#pubsub_state.subscriptions}. +-spec(get_node_subscriptions/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] + | [{Entity::fullUsr(), 'none'}] + %| [{Entity::fullUsr(), Subscription::subscription()}] %% still useful case ? + | [{Entity::fullUsr(), Subscription::subscription(), SubId::subId()}]} + ). -set_subscriptions(NodeId, Owner, Subscription, SubId) -> - SubKey = jlib:short_prepd_jid(Owner), - SubState = get_state(NodeId, SubKey), - case {SubId, SubState#pubsub_state.subscriptions} of +get_node_subscriptions(NodeIdx) -> + {result, States} = get_states(NodeIdx), + Fun = fun(#pubsub_state{id = {Entity, _}, subscriptions = Subscriptions}) -> + [{Entity, Subscription, SubId} || {Subscription, SubId} <- Subscriptions] + end, + {result, lists:flatmap(Fun, States)}. + + +-spec(get_subscriptions/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Subscriptions :: [] | [{Subscription::subscription(), SubId::subId()}]} + ). + +get_subscriptions(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID) -> + #pubsub_state{subscriptions = Subscriptions} = get_state(NodeIdx, _SubKey = {U,S,R}), + {result, Subscriptions}. + + +-spec(set_subscriptions/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscription :: subscription(), + SubId :: subId()) + -> 'ok' + | {Subscription::subscription(), SubId::subId()} + | {error, _} + ). + +set_subscriptions(NodeIdx, #jid{node = U, domain = S, resource = R} = JID, Subscription, SubId) -> + SubKey = {U,S,R}, + SubState = #pubsub_state{subscriptions = Subscriptions} = get_state(NodeIdx, SubKey), + case {SubId, Subscriptions} of {_, []} -> case Subscription of - none -> {error, ?ERR_EXTENDED('bad_request', "not-subscribed")}; - _ -> new_subscription(NodeId, Owner, Subscription, SubState) + 'none' -> {'error', ?ERR_EXTENDED('bad_request', "not-subscribed")}; + _ -> new_subscription(NodeIdx, JID, Subscription, SubState) end; - {"", [{_, SID}]} -> + {<<>>, [{_, OtherSubId}]} -> case Subscription of - none -> unsub_with_subid(NodeId, SID, SubState); - _ -> replace_subscription({Subscription, SID}, SubState) + 'none' -> unsub_with_subid(NodeIdx, OtherSubId, SubState); + _ -> replace_subscription({Subscription, OtherSubId}, SubState) end; - {"", [_|_]} -> + {<<>>, [_|_]} -> {error, ?ERR_EXTENDED('bad_request', "subid-required")}; _ -> case Subscription of - none -> unsub_with_subid(NodeId, SubId, SubState); - _ -> replace_subscription({Subscription, SubId}, SubState) + 'none' -> unsub_with_subid(NodeIdx, SubId, SubState); + _ -> replace_subscription({Subscription, SubId}, SubState) end end. -replace_subscription(NewSub, SubState) -> - NewSubs = replace_subscription(NewSub, - SubState#pubsub_state.subscriptions, []), - set_state(SubState#pubsub_state{subscriptions = NewSubs}). +-spec(replace_subscription/2 :: + ( + NewSubscription :: {Subscription::subscription(), SubId::subId()}, + SubState :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). + +replace_subscription(NewSubcription, #pubsub_state{subscriptions = Subscriptions} = SubState) -> + NewSubcriptions = replace_subscription(NewSubcription, Subscriptions, []), + set_state(SubState#pubsub_state{subscriptions = NewSubcriptions}). + + +-spec(replace_subscription/3 :: + ( + NewSubscription :: {Subscription::subscription(), SubId::subId()}, + Subscriptions :: [{Subscription::subscription(), SubId::subId()}], + Acc :: [] | [{Subscription::subscription(), SubId::subId()}]) + -> NewSubscriptions :: [] | [{Subscription::subscription(), SubId::subId()}] + ). +%% TODO : add clause case in -spec replace_subscription(_, [], Acc) -> Acc; -replace_subscription({Sub, SubId}, [{_, SubId} | T], Acc) -> - replace_subscription({Sub, SubId}, T, [{Sub, SubId} | Acc]). +replace_subscription({Subcription, SubId}, [{_, SubId} | OtherSubcriptions], Acc) -> + replace_subscription({Subcription, SubId}, OtherSubcriptions, [{Subcription, SubId} | Acc]). -new_subscription(NodeId, Owner, Subscription, SubState) -> - SubId = pubsub_subscription:add_subscription(Owner, NodeId, []), - Subscriptions = SubState#pubsub_state.subscriptions, + +-spec(new_subscription/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriptions :: subscription(), + SubState :: pubsubState()) + -> {Subscription::subscription(), SubId::subId()} + ). + +new_subscription(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID, Subscription, #pubsub_state{subscriptions = Subscriptions} = SubState) -> + SubId = pubsub_subscription:add_subscription({U,S,R}, NodeIdx, []), set_state(SubState#pubsub_state{subscriptions = [{Subscription, SubId} | Subscriptions]}), {Subscription, SubId}. -unsub_with_subid(NodeId, SubId, SubState) -> - pubsub_subscription:delete_subscription(SubState#pubsub_state.id, - NodeId, SubId), - NewSubs = lists:filter(fun ({_, SID}) -> SubId =/= SID end, - SubState#pubsub_state.subscriptions), - case {NewSubs, SubState#pubsub_state.affiliation} of - {[], none} -> - del_state(NodeId, element(1, SubState#pubsub_state.id)); - _ -> - set_state(SubState#pubsub_state{subscriptions = NewSubs}) + +-spec(unsub_with_subid/3 :: + ( + NodeIdx :: nodeIdx(), + SubId :: subId(), + SubState :: pubsubState()) + -> 'ok' | {'error', 'internal-server-error'} + ). + +unsub_with_subid(NodeIdx, SubId, #pubsub_state{id = {Entity, _}} = SubState) -> + pubsub_subscription:delete_subscription(Entity, NodeIdx, SubId), + NewSubcriptions = lists:filter(fun + ({_, SID}) -> SubId =/= SID + end, SubState#pubsub_state.subscriptions), + case {NewSubcriptions, SubState#pubsub_state.affiliation} of + {[], 'none'} -> del_state(NodeIdx, Entity); + _ -> set_state(SubState#pubsub_state{subscriptions = NewSubcriptions}) end. + %% @spec (Host, Owner) -> {result, [Node]} | {error, Reason} %% Host = host() %% Owner = jid() %% Node = node() %% @doc

    Returns a list of Owner's nodes on Host with pending %% subscriptions.

    -get_pending_nodes(Host, Owner) -> - GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, - affiliation = owner, - _ = '_'}), - Nidxs = [Nidx || #pubsub_state{id = {_, Nidx}} <- States], - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree +-spec(get_pending_nodes/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_pending_nodes(Host, #jid{node = U, domain = S} = _JID) -> + States = mnesia:match_object( + #pubsub_state{id = {{U,S,undefined}, '_'}, affiliation = 'owner', _ = '_'}), + NodeIdxs = [NodeIdx || #pubsub_state{id = {_, NodeIdx}} <- States], + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(Host, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' end, - Reply = mnesia:foldl(fun(#pubsub_state{id = {_, Nidx}} = S, Acc) -> - case lists:member(Nidx, Nidxs) of - true -> - case get_nodes_helper(NodeTree, S) of - {value, Node} -> [Node | Acc]; - false -> Acc - end; - false -> - Acc - end - end, [], pubsub_state), + Reply = mnesia:foldl(fun + (#pubsub_state{id = {_, NodeIdx}} = State, Acc) -> + case lists:member(NodeIdx, NodeIdxs) of + true -> + case get_nodes_helper(NodeTree, State) of + {value, NodeId} -> [NodeId | Acc]; + false -> Acc + end; + false -> Acc + end + end, [], pubsub_state), {result, Reply}. -get_nodes_helper(NodeTree, - #pubsub_state{id = {_, N}, subscriptions = Subs}) -> - HasPending = fun ({pending, _}) -> true; - (pending) -> true; - (_) -> false - end, - case lists:any(HasPending, Subs) of - true -> - case NodeTree:get_node(N) of - #pubsub_node{id = {_, Node}} -> - {value, Node}; - _ -> - false - end; - false -> - false - end. + +-spec(get_nodes_helper/2 :: + ( + NodeTree :: atom(), + State :: pubsubState()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_nodes_helper(NodeTree, #pubsub_state{id = {_, NodeIdx}, subscriptions = Subscriptions}) -> + HasPending = fun + ({'pending', _}) -> 'true'; + %('pending') -> 'true'; %% Not useful anymore + (_) -> 'false' + end, +case lists:any(HasPending, Subscriptions) of + true -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {_, NodeId}} -> {value, NodeId}; + _ -> false + end; + false -> false +end. %% @spec (NodeId) -> {result, [State] | []} %% NodeId = nodeidx() @@ -802,12 +1013,19 @@ get_nodes_helper(NodeTree, %% they can implement this function like this: %% ```get_states(NodeId) -> %% node_default:get_states(NodeId).'''

    -get_states(NodeId) -> - States = case catch mnesia:match_object( - #pubsub_state{id = {'_', NodeId}, _ = '_'}) of - List when is_list(List) -> List; - _ -> [] - end, +-spec(get_states/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', States :: [] | [State::pubsubState()]} + ). + +get_states(NodeIdx) -> + States = case + catch mnesia:match_object(#pubsub_state{id = {'_', NodeIdx}, _ = '_'}) + of + PubsubStates when is_list(PubsubStates) -> PubsubStates; %% is_list(PubsubStates) useful ? + _ -> [] + end, {result, States}. %% @spec (NodeId, JID) -> [State] | [] @@ -815,26 +1033,42 @@ get_states(NodeId) -> %% JID = ljid() %% State = mod_pubsub:pubsub_item() %% @doc

    Returns a state (one state list), given its reference.

    -get_state(NodeId, JID) -> - StateId = {JID, NodeId}, - case catch mnesia:read({pubsub_state, StateId}) of - [State] when is_record(State, pubsub_state) -> State; - _ -> #pubsub_state{id=StateId} +-spec(get_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> State::pubsubState() + ). + +get_state(NodeIdx, Entity) -> + case catch mnesia:read({pubsub_state, {Entity, NodeIdx}}) of + [#pubsub_state{} = State] -> State; + _ -> #pubsub_state{id = {Entity, NodeIdx}} end. %% @spec (State) -> ok | {error, Reason::stanzaError()} %% State = mod_pubsub:pubsub_state() %% @doc

    Write a state into database.

    -set_state(State) when is_record(State, pubsub_state) -> - mnesia:write(State); -set_state(_) -> - {error, 'internal-server-error'}. +-spec(set_state/1 :: + ( + State :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). +set_state(#pubsub_state{} = State) -> mnesia:write(State); +set_state(_) -> {error, 'internal-server-error'}. %% @spec (NodeId, JID) -> ok | {error, Reason::stanzaError()} %% NodeId = nodeidx() %% @doc

    Delete a state from database.

    -del_state(NodeId, JID) -> - mnesia:delete({pubsub_state, {JID, NodeId}}). +-spec(del_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> 'ok' + ). + +del_state(NodeIdx, Entity) -> + mnesia:delete({pubsub_state, {Entity, NodeIdx}}). %% @spec (NodeId, From) -> [Items] | [] %% NodeId = nodeidx() @@ -849,44 +1083,65 @@ del_state(NodeId, JID) -> %% they can implement this function like this: %% ```get_items(NodeId, From) -> %% node_default:get_items(NodeId, From).'''

    -get_items(NodeId, _From) -> - Items = mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'}), +-spec(get_items/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + ). + +get_items(NodeIdx, _Entity) -> + Items = mnesia:match_object(#pubsub_item{id = {'_', NodeIdx}, _ = '_'}), {result, lists:reverse(lists:keysort(#pubsub_item.modification, Items))}. -get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> - SubKey = jlib:short_prepd_jid(JID), - GenKey = jlib:short_prepd_bare_jid(JID), - GenState = get_state(NodeId, GenKey), - SubState = get_state(NodeId, SubKey), + + +-spec(get_items/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + | {'error', _} + ). + +get_items(NodeIdx, #jid{node = U, domain = S, resource = R} = _JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, + GenState = get_state(NodeIdx, GenKey), + SubState = get_state(NodeIdx, SubKey), Affiliation = GenState#pubsub_state.affiliation, Subscriptions = SubState#pubsub_state.subscriptions, Whitelisted = can_fetch_item(Affiliation, Subscriptions), if %%SubId == "", ?? -> - %% Entity has multiple subscriptions to the node but does not specify a subscription ID - %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; + %% Entity has multiple subscriptions to the node but does not specify a subscription ID + %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; %%InvalidSubId -> - %% Entity is subscribed but specifies an invalid subscription ID - %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; - Affiliation == outcast -> + %% Entity is subscribed but specifies an invalid subscription ID + %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; + Affiliation == 'outcast' -> %% Requesting entity is blocked - {error, 'forbidden'}; - (AccessModel == presence) and (not PresenceSubscription) -> + {'error', 'forbidden'}; + (AccessModel == 'presence') and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) - {error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; - (AccessModel == roster) and (not RosterGroup) -> + {'error', ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; + (AccessModel == 'roster') and (not RosterGroup) -> %% Entity is not authorized to create a subscription (not in roster group) - {error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; - (AccessModel == whitelist) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; + (AccessModel == 'whitelist') and (not Whitelisted) -> %% Node has whitelist access model and entity lacks required affiliation - {error, ?ERR_EXTENDED('not-allowed', "closed-node")}; - (AccessModel == authorize) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-allowed', "closed-node")}; + (AccessModel == 'authorize') and (not Whitelisted) -> %% Node has authorize access model - {error, 'forbidden'}; + {'error', 'forbidden'}; %%MustPay -> - %% % Payment is required for a subscription - %% {error, ?ERR_PAYMENT_REQUIRED}; + %% % Payment is required for a subscription + %% {error, ?ERR_PAYMENT_REQUIRED}; true -> - get_items(NodeId, JID) + get_items(NodeIdx, {U,S,R}) end. %% @spec (NodeId, ItemId) -> [Item] | [] @@ -894,66 +1149,105 @@ get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) - %% ItemId = item() %% Item = mod_pubsub:pubsub_item() %% @doc

    Returns an item (one item list), given its reference.

    -get_item(NodeId, ItemId) -> - case mnesia:read({pubsub_item, {ItemId, NodeId}}) of - [Item] when is_record(Item, pubsub_item) -> - {result, Item}; - _ -> - {error, 'item-not-found'} +-spec(get_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId) -> + case mnesia:read({pubsub_item, {ItemId, NodeIdx}}) of + [#pubsub_item{} = Item] -> {result, Item}; + _ -> {error, 'item-not-found'} end. -get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> - GenKey = jlib:short_prepd_bare_jid(JID), - GenState = get_state(NodeId, GenKey), + + +-spec(get_item/7 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId, #jid{node = U, domain = S} = _JID, AccessModel, PresenceSubscription, RosterGroup, _SubId) -> + GenKey = {U,S,undefined}, + GenState = get_state(NodeIdx, GenKey), Affiliation = GenState#pubsub_state.affiliation, Subscriptions = GenState#pubsub_state.subscriptions, Whitelisted = can_fetch_item(Affiliation, Subscriptions), if %%SubId == "", ?? -> - %% Entity has multiple subscriptions to the node but does not specify a subscription ID - %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; + %% Entity has multiple subscriptions to the node but does not specify a subscription ID + %{error, ?ERR_EXTENDED('bad-request', "subid-required")}; %%InvalidSubId -> - %% Entity is subscribed but specifies an invalid subscription ID - %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; - Affiliation == outcast -> + %% Entity is subscribed but specifies an invalid subscription ID + %{error, ?ERR_EXTENDED('not-acceptable', "invalid-subid")}; + Affiliation == 'outcast' -> %% Requesting entity is blocked - {error, 'forbidden'}; - (AccessModel == presence) and (not PresenceSubscription) -> + {'error', 'forbidden'}; + (AccessModel == 'presence') and (not PresenceSubscription) -> %% Entity is not authorized to create a subscription (presence subscription required) - {error, ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; - (AccessModel == roster) and (not RosterGroup) -> + {'error', ?ERR_EXTENDED('not-authorized', "presence-subscription-required")}; + (AccessModel == 'roster') and (not RosterGroup) -> %% Entity is not authorized to create a subscription (not in roster group) - {error, ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; - (AccessModel == whitelist) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-authorized', "not-in-roster-group")}; + (AccessModel == 'whitelist') and (not Whitelisted) -> %% Node has whitelist access model and entity lacks required affiliation - {error, ?ERR_EXTENDED('not-allowed', "closed-node")}; - (AccessModel == authorize) and (not Whitelisted) -> + {'error', ?ERR_EXTENDED('not-allowed', "closed-node")}; + (AccessModel == 'authorize') and (not Whitelisted) -> %% Node has authorize access model - {error, 'forbidden'}; + {'error', 'forbidden'}; %%MustPay -> - %% % Payment is required for a subscription - %% {error, ?ERR_PAYMENT_REQUIRED}; + %% % Payment is required for a subscription + %% {error, ?ERR_PAYMENT_REQUIRED}; true -> - get_item(NodeId, ItemId) + get_item(NodeIdx, ItemId) end. %% @spec (Item) -> ok | {error, Reason::stanzaError()} %% Item = mod_pubsub:pubsub_item() %% @doc

    Write an item into database.

    -set_item(Item) when is_record(Item, pubsub_item) -> - mnesia:write(Item); -set_item(_) -> - {error, 'internal-server-error'}. +-spec(set_item/1 :: + ( + Item :: pubsubItem()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_item(#pubsub_item{} = Item) -> mnesia:write(Item); +set_item(_) -> {error, 'internal-server-error'}. %% @spec (NodeId, ItemId) -> ok | {error, Reason::stanzaError()} %% NodeId = nodeidx() %% ItemId = item() %% @doc

    Delete an item from database.

    -del_item(NodeId, ItemId) -> - mnesia:delete({pubsub_item, {ItemId, NodeId}}). -del_items(NodeId, ItemIds) -> +-spec(del_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> 'ok' + ). + +del_item(NodeIdx, ItemId) -> + mnesia:delete({pubsub_item, {ItemId, NodeIdx}}). + + +-spec(del_items/2 :: + ( + NodeIdx :: nodeIdx(), + ItemIds :: [itemId()]) + -> 'ok' + ). + +del_items(NodeIdx, ItemIds) -> lists:foreach(fun(ItemId) -> - del_item(NodeId, ItemId) - end, ItemIds). + del_item(NodeIdx, ItemId) + end, ItemIds). %% @doc

    Return the name of the node if known: Default is to return %% node id.

    @@ -967,12 +1261,12 @@ path_to_node([]) -> <<>>; path_to_node(Path) -> case Path of - % default slot - [Node] -> Node; - % handle old possible entries, used when migrating database content to new format - [Node|_] when is_list(Node) -> list_to_binary(string:join([""|Path], "/")); - % default case (used by PEP for example) - _ -> list_to_binary(Path) + % default slot + [Node] -> Node; + % handle old possible entries, used when migrating database content to new format + [Node|_] when is_list(Node) -> list_to_binary(string:join([""|Path], "/")); + % default case (used by PEP for example) + _ -> list_to_binary(Path) end. %% @spec (Affiliation, Subscription) -> true | false @@ -980,24 +1274,45 @@ path_to_node(Path) -> %% Subscription = subscribed | none %% @doc Determines if the combination of Affiliation and Subscribed %% are allowed to get items from a node. -can_fetch_item(owner, _) -> true; -can_fetch_item(member, _) -> true; -can_fetch_item(publisher, _) -> true; -can_fetch_item(outcast, _) -> false; -can_fetch_item(none, Subscriptions) -> is_subscribed(Subscriptions); +-spec(can_fetch_item/2 :: + ( + Affiliation :: affiliation(), + Subscriptions :: [{subscription(), subId()}]) + -> CanFetchItem::boolean() + ). +%% TODO : add 'publish-only' case +can_fetch_item('owner', _) -> true; +can_fetch_item('member', _) -> true; +can_fetch_item('publisher',_) -> true; +can_fetch_item('outcast', _) -> false; +can_fetch_item('none', Subscriptions) -> is_subscribed(Subscriptions); can_fetch_item(_Affiliation, _Subscription) -> false. + +-spec(is_subscribed/1 :: + ( + Subscriptions :: [{Subscription::subscription(), SubId::subId()}]) + -> IsSubscribed::boolean() + ). + is_subscribed(Subscriptions) -> - lists:any(fun ({subscribed, _SubId}) -> true; - (_) -> false - end, Subscriptions). + lists:any(fun + ({'subscribed', _SubId}) -> true; + (_) -> false + end, Subscriptions). + %% Returns the first item where Pred() is true in List -first_in_list(_Pred, []) -> - false; -first_in_list(Pred, [H | T]) -> - case Pred(H) of - true -> {value, H}; - _ -> first_in_list(Pred, T) - end. +-spec(first_in_list/2 :: + ( + Predicate :: fun(), + Subscriptions :: [{Subscription::subscription(), SubId::subId()}]) + -> 'false' | {'value', {Subscription::subscription(), SubId::subId()}} + ). +first_in_list(_Predicate, []) -> false; +first_in_list(Predicate, [Subscription | OtherSubscriptions]) -> + case Predicate(Subscription) of + true -> {'value', Subscription}; + _ -> first_in_list(Predicate, OtherSubscriptions) + end. diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index b30f2814d..5d0f1142b 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -42,7 +42,8 @@ -behaviour(gen_pubsub_nodetree). --export([init/3, +-export([ + init/3, terminate/2, options/0, set_node/1, @@ -60,6 +61,7 @@ ]). + %% ================ %% API definition %% ================ @@ -73,6 +75,14 @@ %%

    This function is mainly used to trigger the setup task necessary for the %% plugin. It can be used for example by the developer to create the specific %% module database schema if it does not exists yet.

    +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(_Host, _ServerHost, _Opts) -> mnesia:create_table(pubsub_node, [{disc_copies, [node()]}, @@ -81,49 +91,101 @@ init(_Host, _ServerHost, _Opts) -> NodesFields = record_info(fields, pubsub_node), case mnesia:table_info(pubsub_node, attributes) of NodesFields -> ok; - _ -> - ok - %% mnesia:transform_table(pubsub_state, ignore, StatesFields) + _ -> ok %% mnesia:transform_table(pubsub_state, ignore, StatesFields) end, ok. + + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(_Host, _ServerHost) -> ok. %% @spec () -> [Option] %% Option = mod_pubsub:nodetreeOption() %% @doc Returns the default pubsub node tree options. -options() -> - [{virtual_tree, false}]. +-spec(options/0 :: () -> Options::[{'virtual_tree', 'false'}]). + +options() -> [{'virtual_tree', 'false'}]. %% @spec (NodeRecord) -> ok | {error, Reason} %% Record = mod_pubsub:pubsub_node() -set_node(Record) when is_record(Record, pubsub_node) -> - mnesia:write(Record); -set_node(_) -> - {error, 'internal-server-error'}. + %( + % Node :: pubsubNode() -> 'ok' | {'error', Reason::_}; + % Node :: any() -> {'error', 'internal-server-error'} + %). +%% -spec breaks compilation + +set_node(#pubsub_node{} = Node) -> mnesia:write(Node); +set_node(_) -> {error, 'internal-server-error'}. %% @spec (Host, Node, From) -> pubsubNode() | {error, Reason} %% Host = mod_pubsub:host() %% Node = node() -get_node(Host, Node, _From) -> - get_node(Host, Node). -get_node(Host, Node) -> - case catch mnesia:read({pubsub_node, {Host, Node}}) of - [Record] when is_record(Record, pubsub_node) -> Record; - [] -> {error, 'item-not-found'}; - Error -> Error +-spec(get_node/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> pubsubNode() | {error, 'item-not-found'} | any() + ). + +get_node(Host, NodeId, _JID) -> + get_node(Host, NodeId). + + +-spec(get_node/2 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId()) + -> pubsubNode() | {error, 'item-not-found'} | any() + ). + +get_node(Host, NodeId) -> + case catch mnesia:read({pubsub_node, {Host, NodeId}}) of + [#pubsub_node{} = Node] -> Node; + [] -> {error, 'item-not-found'}; + Error -> Error end. -get_node(Nidx) -> - case catch mnesia:index_read(pubsub_node, Nidx, #pubsub_node.idx) of - [Record] when is_record(Record, pubsub_node) -> Record; - [] -> {error, 'item-not-found'}; - Error -> Error + + +-spec(get_node/1 :: + ( + NodeIdx :: nodeIdx()) + -> pubsubNode() | {error, 'item-not-found'} | any() + ). + +get_node(NodeIdx) -> + case catch mnesia:index_read(pubsub_node, NodeIdx, #pubsub_node.idx) of + [#pubsub_node{} = Node] -> Node; + [] -> {error, 'item-not-found'}; + Error -> Error end. %% @spec (Host, From) -> [pubsubNode()] | {error, Reason} %% Host = mod_pubsub:host() | ljid() -get_nodes(Host, _From) -> +-spec(get_nodes/2 :: + ( + Host :: host(), % hostPubsub | hostPEP() + JID :: jidEntity()) + -> Nodes :: [] | [Node::pubsubNode()] + ). + +get_nodes(Host, _JID) -> get_nodes(Host). + + +-spec(get_nodes/1 :: + ( + Host :: host()) % hostPubsub | hostPEP() + -> Nodes :: [] | [Node::pubsubNode()] + ). + get_nodes(Host) -> mnesia:match_object(#pubsub_node{id = {Host, '_'}, _ = '_'}). @@ -134,7 +196,15 @@ get_nodes(Host) -> %% Depth = integer() %% Record = pubsubNode() %% @doc

    Default node tree does not handle parents, return empty list.

    -get_parentnodes(_Host, _Node, _From) -> +-spec(get_parentnodes/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> ParentNodes :: [] + ). + +get_parentnodes(_Host, _NodeId, _JID) -> []. %% @spec (Host, Node, From) -> [{Depth, Record}] | {error, Reason} @@ -145,52 +215,98 @@ get_parentnodes(_Host, _Node, _From) -> %% Record = pubsubNode() %% @doc

    Default node tree does not handle parents, return a list %% containing just this node.

    -get_parentnodes_tree(Host, Node, From) -> - case get_node(Host, Node, From) of - N when is_record(N, pubsub_node) -> [{0, [N]}]; - _Error -> [] +-spec(get_parentnodes_tree/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> ParentNodesTree :: [] | [{0, [ParentNode::pubsubNode()]}] + ). + +get_parentnodes_tree(Host, NodeId, JID) -> + case get_node(Host, NodeId, JID) of + #pubsub_node{} = ParentNode -> [{0, [ParentNode]}]; + _Error -> [] end. %% @spec (Host, Node, From) -> [pubsubNode()] | {error, Reason} %% Host = mod_pubsub:host() %% Node = node() %% From = ljid() -get_subnodes(Host, Node, _From) -> - get_subnodes(Host, Node). -get_subnodes(Host, <<>>) -> - Q = qlc:q([N || #pubsub_node{id = {NHost, _}, - parents = Parents} = N <- mnesia:table(pubsub_node), - Host == NHost, - Parents == []]), +-spec(get_subnodes/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + JID :: jidEntity()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes(Host, NodeId, _JID) -> + get_subnodes(Host, NodeId). + + +-spec(get_subnodes/2 :: + ( + ParentNodeHost :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes(ParentNodeHost, <<>>) -> + Q = qlc:q( + [Node + || #pubsub_node{id = {Host, _}, parents = ParentNodeIds} = Node + <- mnesia:table(pubsub_node), + ParentNodeHost == Host, + ParentNodeIds == []]), qlc:e(Q); -get_subnodes(Host, Node) -> - Q = qlc:q([N || #pubsub_node{id = {NHost, _}, - parents = Parents} = N <- mnesia:table(pubsub_node), - Host == NHost, - lists:member(Node, Parents)]), +get_subnodes(ParentNodeHost, ParentNodeId) -> + Q = qlc:q( + [Node + || #pubsub_node{id = {Host, _}, parents = ParentNodeIds} = Node + <- mnesia:table(pubsub_node), + ParentNodeHost == Host, + lists:member(ParentNodeId, ParentNodeIds)]), qlc:e(Q). %% @spec (Host, Index, From) -> [nodeidx()] | {error, Reason} %% Host = mod_pubsub:host() %% Node = node() %% From = ljid() -get_subnodes_tree(Host, Node, _From) -> - get_subnodes_tree(Host, Node). -get_subnodes_tree(Host, Node) -> - case get_node(Host, Node) of - {error, _} -> - []; - Rec -> - BasePlugin = list_to_atom("node_"++Rec#pubsub_node.type), - BasePath = BasePlugin:node_to_path(Node), - mnesia:foldl(fun(#pubsub_node{id = {H, N}} = R, Acc) -> - Plugin = list_to_atom("node_"++R#pubsub_node.type), - Path = Plugin:node_to_path(N), - case lists:prefix(BasePath, Path) and (H == Host) of - true -> [R | Acc]; - false -> Acc - end - end, [], pubsub_node) +-spec(get_subnodes_tree/3 :: + ( + Host :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId(), + JID :: jidEntity()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes_tree(Host, ParentNodeId, _JID) -> + get_subnodes_tree(Host, ParentNodeId). + + +-spec(get_subnodes_tree/2 :: + ( + Host :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes_tree(ParentNodeHost, ParentNodeId) -> + case get_node(ParentNodeHost, ParentNodeId) of + {error, _} -> []; + #pubsub_node{type = ParentNodeType} = _ParentNode -> + BasePlugin = list_to_atom("node_"++ParentNodeType), + BasePath = BasePlugin:node_to_path(ParentNodeId), + mnesia:foldl(fun + (#pubsub_node{id = {Host, NodeId}, type = Type} = Node, Acc) -> + Plugin = list_to_atom("node_"++Type), + Path = Plugin:node_to_path(NodeId), + case lists:prefix(BasePath, Path) and (Host == ParentNodeHost) of + true -> [Node | Acc]; + false -> Acc + end + end, [], pubsub_node) end. %% @spec (Host, Node, Type, Owner, Options, Parents) -> ok | {error, Reason} @@ -199,56 +315,70 @@ get_subnodes_tree(Host, Node) -> %% NodeType = nodeType() %% Owner = ljid() %% Options = list() -create_node(Host, Node, Type, Owner, Options, Parents) -> - BJID = jlib:short_prepd_bare_jid(Owner), - case mnesia:read({pubsub_node, {Host, Node}}) of +-spec(create_node/6 :: + ( + Host :: host(), % hostPubsub | hostPEP() + NodeId :: nodeId(), + Type :: nodeType(), + JID :: jidEntity(), + Options :: [nodeOption()], + ParentNodeIds :: [] | [nodeId()]) + -> {'ok', NodeIdx::nodeIdx()} + | {'error', 'conflict' | 'forbidden'} + ). + +create_node(Host, NodeId, Type, #jid{node = U, domain = S} = _JID, Options, ParentNodeIds) -> + Owner = {U,S,undefined}, + case mnesia:read({pubsub_node, {Host, NodeId}}) of [] -> - ParentExists = - case Host of - {_U, _S, _R} -> - %% This is special case for PEP handling - %% PEP does not uses hierarchy - true; - _ -> - case Parents of - [] -> true; - [Parent | _] -> - BHost = list_to_binary(Host), - case mnesia:read({pubsub_node, {Host, Parent}}) of - [#pubsub_node{owners = [{undefined, BHost, undefined}]}] -> true; - [#pubsub_node{owners = Owners}] -> lists:member(BJID, Owners); - _ -> false - end; - _ -> - false - end - end, + ParentExists = case Host of + %% This is special case for PEP handling, PEP does not uses hierarchy + {_, _, _} -> true; + _ -> + case ParentNodeIds of + [] -> true; + [ParentNodeId | _] -> + case mnesia:read({pubsub_node, {Host, ParentNodeId}}) of + [#pubsub_node{owners = [{undefined, Host, undefined}]}] -> true; + [#pubsub_node{owners = Owners}] -> lists:member(Owner, Owners); + _ -> false + end; + _ -> false + end + end, case ParentExists of true -> - Nidx = pubsub_index:new(node), - mnesia:write(#pubsub_node{id = {Host, Node}, - idx = Nidx, - parents = Parents, - type = Type, - owners = [BJID], - options = Options}), - {ok, Nidx}; - false -> - %% Requesting entity is prohibited from creating nodes - {error, 'forbidden'} - end; - _ -> - %% Node already exists - {error, 'conflict'} + NodeIdx = pubsub_index:new(node), + mnesia:write( + #pubsub_node{ + id = {Host, NodeId}, + idx = NodeIdx, + parents = ParentNodeIds, + type = Type, + owners = [Owner], + options = Options}), + {ok, NodeIdx}; + false -> %% Requesting entity is prohibited from creating nodes + {error, 'forbidden'} + end; + _ -> %% Node already exists + {error, 'conflict'} end. %% @spec (Host, Node) -> [mod_pubsub:node()] %% Host = mod_pubsub:host() | ljid() %% Node = node() -delete_node(Host, Node) -> - Removed = get_subnodes_tree(Host, Node), - lists:foreach(fun(#pubsub_node{id = {_, N}, idx = I}) -> - pubsub_index:free(node, I), - mnesia:delete({pubsub_node, {Host, N}}) - end, Removed), - Removed. +-spec(delete_node/2 :: +( + Host :: host(), % hostPubsub | hostPEP() + ParentNodeId :: nodeId()) + -> DeletedNodes :: [] | [Node::pubsubNode()] +). + +delete_node(Host, ParentNodeId) -> + DeletedNodes = get_subnodes_tree(Host, ParentNodeId), + lists:foreach(fun(#pubsub_node{id = {_, NodeId}, idx = NodeIdx}) -> + pubsub_index:free(node, NodeIdx), + mnesia:delete({pubsub_node, {Host, NodeId}}) + end, DeletedNodes), + DeletedNodes. diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index 2ab6a112d..be062f28b 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -42,14 +42,25 @@ %% Pubsub types %% ------------ -%%% @type host() = binary(). +%%% @type hostPubsub() = binary(). %%% -%%%

    host is the name of the PubSub service. For example, it can be +%%%

    hostPubsub is the name of the PubSub service. For example, it can be %%% pubsub.localhost.

    --type(host() :: binary()). +-type(hostPubsub() :: binary()). +%%% @type hostPEP() = {User::binary(), Server::binary, Resource::undefined}. + +-type(hostPEP() :: {User::binary(), Server::binary, Resource::undefined}). + + +%%% @type host() = hostPubsub() | hostPEP(). + +-type(host() :: hostPubsub() | hostPEP()). + + +%% TODO : move upper in exmpp %%% @type nodeId() = binary(). %%% %%%

    A nodeId is the name of a Node. It can be anything and may represent @@ -93,6 +104,58 @@ -type(ljid() :: {User::binary(), Server::binary(), Resource::binary()}). +%% TODO : move upper in exmpp +%%% @type jidComponent() = +%% #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}. + +-type(jidComponent() :: + #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}). + + +%% TODO : move upper in exmpp +%%% @type jidContact() = +%% #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}. + +-type(jidContact() :: + #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}). + + +%% TODO : move upper in exmpp +%%% @type jidEntity() = +%%% #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined} +%%% #jid{raw::binary(), node::binary(), domain::binary(), resource::binary()} +%%% #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined} +%%% #jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}. + +-type(jidEntity() :: + %% Contact bare JID + #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined} | + %% Contact full JID + #jid{raw::binary(), node::binary(), domain::binary(), resource::binary()} | + %% Component bare JID + #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined} | + %% Component full JID + #jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}). + + +%%% @type bareUsr() = {User::binary(), Server::binary(), Resource::undefined} +%%% | {User::undefined, Server::binary(), Resource::undefined}. + +-type(bareUsr() :: {User::binary(), Server::binary(), Resource::undefined} + | {User::undefined, Server::binary(), Resource::undefined}). + + +%%% @type fullUsr() = {User::binary(), Server::binary(), Resource::undefined} +%%% | {User::binary(), Server::binary(), Resource::binary()} +%%% | {User::undefined, Server::binary(), Resource::undefined} +%%% | {User::undefined, Server::binary(), Resource::binary()}. + +-type(fullUsr() :: {User::binary(), Server::binary(), Resource::undefined} + | {User::binary(), Server::binary(), Resource::binary()} + | {User::undefined, Server::binary(), Resource::undefined} + | {User::undefined, Server::binary(), Resource::binary()}). + + %%% @type nodeIdx() = integer(). -type(nodeIdx() :: integer()). @@ -103,19 +166,24 @@ -type(now() :: {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}). -%%% @type affiliation() = none | owner | publisher | member | outcast. +%%% @type affiliation() = 'none' | 'owner' | 'publisher' |'publish-only' | 'member' | 'outcast'. --type(affiliation() :: none | owner | publisher | member | outcast). +-type(affiliation() :: 'none' | 'owner' | 'publisher' |'publish-only' | 'member' | 'outcast'). -%%% @type subscription() = none | pending | unconfigured | subscribed. +%%% @type subscription() = 'none' | 'pending' | 'unconfigured' | 'subscribed'. --type(subscription() :: none | pending | unconfigured | subscribed). +-type(subscription() :: 'none' | 'pending' | 'unconfigured' | 'subscribed'). -%%% @type payload() = string(). +%%% @type accessModel() = 'open' | 'presence' | 'roster' | 'authorize' | 'whitelist'. --type(payload() :: string()). +-type(accessModel() :: 'open' | 'presence' | 'roster' | 'authorize' | 'whitelist'). + + +%%% @type payload() = [] | [#xmlel{}]. + +-type(payload() :: [] | [#xmlel{}]). %%% @type stanzaError() = #xmlel{}. @@ -155,6 +223,10 @@ -type(pubsubIQResponse() :: #xmlel{}). +%%% @type features() = [Feature::string()]. + +-type(features() :: [Feature::string()]). + %%% @type nodeOption() = {Option, Value}. %%% Option = atom() %%% Value = term(). @@ -164,6 +236,7 @@ -type(nodeOption() :: {Option::atom(), Value::term()}). + %%% @type subOption() = {Option, Value}. %%% Option = atom() %%% Value = term(). @@ -179,11 +252,11 @@ %%% Internal pubsub index table. -record(pubsub_index, -{ - index :: atom(), - last :: integer(), - free :: [integer()] -}). + { + index :: atom(), + last :: integer(), + free :: [integer()] + }). -type(pubsubIndex() :: #pubsub_index{}). @@ -193,7 +266,7 @@ %%% Idx = nodeIdx() %%% Parents = [nodeId()] %%% Type = nodeType() -%%% Owners = [ljid()] +%%% Owners = [bareUsr()] %%% Options = [nodeOption()]. %%% %%%

    This is the format of the nodes table. The type of the table @@ -202,54 +275,54 @@ %%%

    idx is an integer.

    -record(pubsub_node, -{ - id :: {host(), nodeId()}, - idx :: nodeIdx(), - parents = [] :: [nodeId()], - type = "flat" :: nodeType(), - owners = [] :: [ljid()], - options = [] :: [nodeOption()] -}). + { + id :: {host(), nodeId()}, + idx :: nodeIdx(), + parents = [] :: [nodeId()], + type = "flat" :: nodeType(), + owners = [] :: [bareUsr()], + options = [] :: [nodeOption()] + }). -type(pubsubNode() :: #pubsub_node{}). %%% @type pubsubState() = {pubsub_state, Id, Items, Affiliation, Subscriptions} -%%% Id = {ljid(), nodeIdx()} +%%% Id = {fullUsr(), nodeIdx()} %%% Items = [itemId()] %%% Affiliation = affiliation() -%%% Subscriptions = [subscription()]. +%%% Subscriptions = [{subscription(), subId()}]. %%% %%%

    This is the format of the affiliations table. The type of the %%% table is: set,ram/disc.

    -record(pubsub_state, -{ - id :: {ljid(), nodeIdx()}, - items = [] :: [itemId()], - affiliation = none :: affiliation(), - subscriptions = [] :: [subscription()] -}). + { + id :: {fullUsr(), nodeIdx()}, + items = [] :: [itemId()], + affiliation = 'none' :: affiliation(), + subscriptions = [] :: [{subscription(), subId()}] + }). -type(pubsubState() :: #pubsub_state{}). %%% @type pubsubItem() = {pubsub_item, Id, Creation, Modification, Payload} %%% Id = {itemId(), nodeIdx()} -%%% Creation = {now(), ljid()} -%%% Modification = {now(), ljid()} +%%% Creation = {now(), bareUsr()} +%%% Modification = {now(), fullUsr()} %%% Payload = payload(). %%% %%%

    This is the format of the published items table. The type of the %%% table is: set,disc,fragmented.

    -record(pubsub_item, -{ - id :: {itemId(), nodeIdx()}, - creation = {unknown,unknown} :: {now(), ljid()}, - modification = {unknown,unknown} :: {now(), ljid()}, - payload = [] :: payload() -}). + { + id :: {itemId(), nodeIdx()}, + creation = {unknown,unknown} :: {now(), bareUsr()}, + modification = {unknown,unknown} :: {now(), fullUsr()}, + payload = [] :: payload() + }). -type(pubsubItem() :: #pubsub_item{}). @@ -262,10 +335,10 @@ %% table is: set,ram/disc.

    -record(pubsub_subscription, -{ - subid :: subId(), - options :: [subOption()] -}). + { + subid :: subId(), + options :: [subOption()] + }). -type(pubsubSubscription() :: #pubsub_subscription{}). @@ -273,18 +346,18 @@ %%% @type pubsubLastItem() = {pubsub_last_item, NodeId, ItemId, Creation, Payload} %%% NodeId = nodeIdx() %%% ItemId = itemId() -%%% Creation = {now(), ljid()} +%%% Creation = {now(), bareUsr()} %%% Payload = payload(). %%% %%

    This is the format of the last items table. it stores last item payload %% for every node

    -record(pubsub_last_item, -{ - nodeid :: nodeIdx(), - itemid :: itemId(), - creation :: {now(), ljid()}, - payload :: payload() -}). + { + nodeid :: nodeIdx(), + itemid :: itemId(), + creation :: {now(), bareUsr()}, + payload :: payload() + }). -type(pubsubLastItem() :: #pubsub_last_item{}). diff --git a/src/mod_pubsub/pubsub_index.erl b/src/mod_pubsub/pubsub_index.erl index 6cde91dcc..3b1601bc8 100644 --- a/src/mod_pubsub/pubsub_index.erl +++ b/src/mod_pubsub/pubsub_index.erl @@ -31,35 +31,58 @@ -include("pubsub.hrl"). --export([init/3, new/1, free/2]). +-export([ + init/3, + new/1, + free/2 + ]). + + +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). init(_Host, _ServerHost, _Opts) -> mnesia:create_table(pubsub_index, [{disc_copies, [node()]}, {attributes, record_info(fields, pubsub_index)}]). + +-spec(new/1 :: + ( + Index::atom()) + -> Idx::integer() + ). + new(Index) -> case mnesia:read({pubsub_index, Index}) of - [I] -> - case I#pubsub_index.free of - [] -> - Id = I#pubsub_index.last + 1, - mnesia:write(I#pubsub_index{last = Id}), - Id; - [Id|Free] -> - mnesia:write(I#pubsub_index{free = Free}), - Id - end; - _ -> - mnesia:write(#pubsub_index{index = Index, last = 1, free = []}), - 1 + [#pubsub_index{free = [], last = Last} = PubsubIndex] -> + Idx = Last + 1, + mnesia:write(PubsubIndex#pubsub_index{last = Idx}), + Idx; + [#pubsub_index{free = [Idx|Free]} = PubsubIndex] -> + mnesia:write(PubsubIndex#pubsub_index{free = Free}), + Idx; + _ -> + mnesia:write(#pubsub_index{index = Index, last = 1, free = []}), + 1 end. -free(Index, Id) -> + +-spec(free/2 :: + ( + Index :: atom(), + Idx :: integer()) + -> 'ok' + ). + +free(Index, Idx) -> case mnesia:read({pubsub_index, Index}) of - [I] -> - Free = I#pubsub_index.free, - mnesia:write(I#pubsub_index{free = [Id|Free]}); - _ -> - ok + [#pubsub_index{free = Free} = PubsubIndex] -> + mnesia:write(PubsubIndex#pubsub_index{free = [Idx|Free]}); + _ -> ok end. diff --git a/src/mod_pubsub/pubsub_odbc.patch b/src/mod_pubsub/pubsub_odbc.patch index 08c274887..5309386ff 100644 --- a/src/mod_pubsub/pubsub_odbc.patch +++ b/src/mod_pubsub/pubsub_odbc.patch @@ -1,5 +1,5 @@ ---- mod_pubsub.erl 2010-09-20 15:56:56.000000000 +0200 -+++ mod_pubsub_odbc.erl 2010-09-20 16:50:49.000000000 +0200 +--- mod_pubsub.erl 2010-09-23 10:43:43.000000000 +0200 ++++ mod_pubsub_odbc.erl 2010-09-29 11:46:22.000000000 +0200 @@ -42,7 +42,7 @@ %%% 6.2.3.1, 6.2.3.5, and 6.3. For information on subscription leases see %%% XEP-0060 section 12.18. diff --git a/src/mod_pubsub/pubsub_subscription.erl b/src/mod_pubsub/pubsub_subscription.erl index 7e129068d..be33aa0ea 100644 --- a/src/mod_pubsub/pubsub_subscription.erl +++ b/src/mod_pubsub/pubsub_subscription.erl @@ -24,28 +24,32 @@ -author("bjc@kublai.com"). %% API --export([init/0, +-export([ + init/0, subscribe_node/3, unsubscribe_node/3, get_subscription/3, set_subscription/4, get_options_xform/2, - parse_options_xform/1]). + parse_options_xform/1 + ]). -% Internal function also exported for use in transactional bloc from pubsub plugins --export([add_subscription/3, + % Internal function also exported for use in transactional bloc from pubsub plugins +-export([ + add_subscription/3, delete_subscription/3, read_subscription/3, - write_subscription/4]). + write_subscription/4 + ]). -include("pubsub.hrl"). --define(PUBSUB_DELIVER, "pubsub#deliver"). --define(PUBSUB_DIGEST, "pubsub#digest"). +-define(PUBSUB_DELIVER, "pubsub#deliver"). +-define(PUBSUB_DIGEST, "pubsub#digest"). -define(PUBSUB_DIGEST_FREQUENCY, "pubsub#digest_frequency"). --define(PUBSUB_EXPIRE, "pubsub#expire"). +-define(PUBSUB_EXPIRE, "pubsub#expire"). -define(PUBSUB_INCLUDE_BODY, "pubsub#include_body"). --define(PUBSUB_SHOW_VALUES, "pubsub#show-values"). +-define(PUBSUB_SHOW_VALUES, "pubsub#show-values"). -define(PUBSUB_SUBSCRIPTION_TYPE, "pubsub#subscription_type"). -define(PUBSUB_SUBSCRIPTION_DEPTH, "pubsub#subscription_depth"). @@ -54,11 +58,11 @@ -define(DIGEST_LABEL, "Whether an entity wants to receive digests (aggregations) of notifications or all notifications individually"). -define(DIGEST_FREQUENCY_LABEL, - "The minimum number of milliseconds between sending any two notification digests"). + "The minimum number of milliseconds between sending any two notification digests"). -define(EXPIRE_LABEL, "The DateTime at which a leased subscription will end or has ended"). -define(INCLUDE_BODY_LABEL, - "Whether an entity wants to receive an XMPP message body in addition to the payload format"). + "Whether an entity wants to receive an XMPP message body in addition to the payload format"). -define(SHOW_VALUES_LABEL, "The presence states for which an entity wants to receive notifications"). -define(SUBSCRIPTION_TYPE_LABEL, @@ -85,113 +89,194 @@ %%==================================================================== %% API %%==================================================================== +-spec(init/0 :: () -> 'ok'). + init() -> ok = create_table(). -subscribe_node(JID, NodeId, Options) -> - try mnesia:sync_dirty(fun add_subscription/3, - [JID, NodeId, Options]) of - {error, Error} -> {error, Error}; - Result -> {result, Result} - catch - Error -> Error - end. +-spec(subscribe_node/3 :: + ( + Entity :: jidEntity() | fullUsr(), + NodeIdx :: nodeIdx(), + Options :: [nodeOption()]) + -> {'result', SubId::subId()} | {'error', _} + ). -unsubscribe_node(JID, NodeId, SubId) -> - try mnesia:sync_dirty(fun delete_subscription/3, - [JID, NodeId, SubId]) of +subscribe_node(#jid{node = U, domain = S, resource = R}, NodeIdx, Options) -> + subscribe_node({U,S,R}, NodeIdx, Options); +subscribe_node(Entity, NodeIdx, Options) -> + try mnesia:sync_dirty(fun add_subscription/3, [Entity, NodeIdx, Options]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Result -> {result, Result} catch Error -> Error end. -get_subscription(JID, NodeId, SubId) -> - try mnesia:sync_dirty(fun read_subscription/3, - [JID, NodeId, SubId]) of + +-spec(unsubscribe_node/3 :: + ( + JID :: jidEntity(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> {'result','ok'} | {'error', _} + ). + +unsubscribe_node(#jid{node = U, domain = S, resource = R} = _JID, NodeIdx, SubId) -> + try mnesia:sync_dirty(fun delete_subscription/3, [{U,S,R}, NodeIdx, SubId]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Result -> {result, Result} catch Error -> Error end. -set_subscription(JID, NodeId, SubId, Options) -> - try mnesia:sync_dirty(fun write_subscription/4, - [JID, NodeId, SubId, Options]) of + +-spec(get_subscription/3 :: + ( + JID :: jidEntity(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> {'result', pubsubSubscription()} | {'error', _} + ). + +get_subscription(#jid{node = U, domain = S, resource = R} = _JID, NodeIdx, SubId) -> + try mnesia:sync_dirty(fun read_subscription/3, [{U,S,R}, NodeIdx, SubId]) of {error, Error} -> {error, Error}; - Result -> {result, Result} + Subscription -> {result, Subscription} catch Error -> Error end. + +-spec(set_subscription/4 :: + ( + JID :: jidEntity(), + NodeIdx :: nodeIdx(), + SubId :: subId(), + Options :: [nodeOption()]) + -> {'result', 'ok'} | {'error', _} + ). + +set_subscription(#jid{node = U, domain = S, resource = R} = _JID, NodeIdx, SubId, Options) -> + try mnesia:sync_dirty(fun write_subscription/4, [{U,S,R}, NodeIdx, SubId, Options]) of + {error, Error} -> {error, Error}; + Result -> {result, Result} + catch + Error -> Error + end. + + +%% TODO : check input type data get_options_xform(Lang, Options) -> Keys = [deliver, digest, digest_frequency, expire, include_body, show_values, subscription_type, subscription_depth], XFields = [get_option_xfield(Lang, Key, Options) || Key <- Keys], - {result, #xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"form">>)], children = - [#xmlel{ns = ?NS_DATA_FORMS, - name = 'field', - attrs = [?XMLATTR('var', <<"FORM_TYPE">>), ?XMLATTR('type', <<"hidden">>)], - children = [#xmlel{ns = ?NS_DATA_FORMS, - name = 'value', - children = [?XMLCDATA(?NS_PUBSUB_SUBSCRIBE_OPTIONS_s)]}]}] ++ XFields}}. + {result, #xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"form">>)], children = + [#xmlel{ns = ?NS_DATA_FORMS, + name = 'field', + attrs = [?XMLATTR('var', <<"FORM_TYPE">>), ?XMLATTR('type', <<"hidden">>)], + children = [#xmlel{ns = ?NS_DATA_FORMS, + name = 'value', + children = [?XMLCDATA(?NS_PUBSUB_SUBSCRIBE_OPTIONS_s)]}]}] ++ XFields}}. +%% TODO : check input type data parse_options_xform(XFields) -> case XFields of - [] -> {result, []}; - _ -> case exmpp_xml:remove_cdata_from_list(XFields) of - [] -> {result, []}; - [#xmlel{name = 'x'} = XEl] -> - case jlib:parse_xdata_submit(XEl) of - XData when is_list(XData) -> - case set_xoption(XData, []) of - Opts when is_list(Opts) -> {result, Opts}; - Other -> Other - end; - Other -> - Other - end; - Other -> - Other - end + [] -> {result, []}; + _ -> case exmpp_xml:remove_cdata_from_list(XFields) of + [] -> {result, []}; + [#xmlel{name = 'x'} = XEl] -> + case jlib:parse_xdata_submit(XEl) of + XData when is_list(XData) -> + case set_xoption(XData, []) of + Opts when is_list(Opts) -> {result, Opts}; + Other -> Other + end; + Other -> + Other + end; + Other -> + Other + end end. %%==================================================================== %% Internal functions %%==================================================================== +-spec(create_table/0 :: () -> 'ok'). + create_table() -> case mnesia:create_table(pubsub_subscription, [{disc_copies, [node()]}, {attributes, record_info(fields, pubsub_subscription)}, - {type, set}]) of - {atomic, ok} -> ok; + {type, set}]) + of + {atomic, ok} -> ok; {aborted, {already_exists, _}} -> ok; - Other -> Other + Other -> Other end. -add_subscription(_JID, _NodeId, Options) -> +-spec(add_subscription/3 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + Options :: [nodeOption()]) + -> SubId::subId() + ). + +add_subscription(_Entity, _NodeIdx, Options) -> SubId = make_subid(), mnesia:write(#pubsub_subscription{subid = SubId, options = Options}), SubId. -delete_subscription(_JID, _NodeId, SubId) -> + +-spec(delete_subscription/3 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> 'ok' + ). + +delete_subscription(_Entity, _NodeIdx, SubId) -> mnesia:delete({pubsub_subscription, SubId}). -read_subscription(_JID, _NodeId, SubId) -> + +-spec(read_subscription/3 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + SubId :: subId()) + -> pubsubSubscription() | {'error', 'notfound'} + ). + +read_subscription(_Entity, _NodeIdx, SubId) -> case mnesia:read({pubsub_subscription, SubId}) of - [Sub] -> Sub; - _ -> {error, notfound} + [Subscription] -> Subscription; + _ -> {'error', 'notfound'} end. -write_subscription(JID, NodeId, SubId, Options) -> - case read_subscription(JID, NodeId, SubId) of - {error, notfound} -> {error, notfound}; - Sub -> mnesia:write(Sub#pubsub_subscription{options = Options}) + +-spec(write_subscription/4 :: + ( + Entity :: fullUsr(), + NodeIdx :: nodeIdx(), + SubId :: subId(), + Options :: [nodeOption()]) + -> 'ok' | {'error', 'notfound'} + ). + +write_subscription(Entity, NodeIdx, SubId, Options) -> + case read_subscription(Entity, NodeIdx, SubId) of + {error, 'notfound'} -> {error, 'notfound'}; + Subscription -> mnesia:write(Subscription#pubsub_subscription{options = Options}) end. + +-spec(make_subid/0 :: () -> SubId::subId()). + make_subid() -> {T1, T2, T3} = now(), - lists:flatten(io_lib:fwrite("~.16B~.16B~.16B", [T1, T2, T3])). + list_to_binary(lists:flatten(io_lib:fwrite("~.16B~.16B~.16B", [T1, T2, T3]))). %% %% Subscription XForm processing. @@ -199,6 +284,7 @@ make_subid() -> %% Return processed options, with types converted and so forth, using %% Opts as defaults. +%% TODO : check input type data set_xoption([], Opts) -> Opts; set_xoption([{Var, Value} | T], Opts) -> @@ -211,33 +297,36 @@ set_xoption([{Var, Value} | T], Opts) -> end, set_xoption(T, NewOpts). + %% Return the options list's key for an XForm var. -var_xfield(?PUBSUB_DELIVER) -> deliver; -var_xfield(?PUBSUB_DIGEST) -> digest; -var_xfield(?PUBSUB_DIGEST_FREQUENCY) -> digest_frequency; -var_xfield(?PUBSUB_EXPIRE) -> expire; -var_xfield(?PUBSUB_INCLUDE_BODY) -> include_body; -var_xfield(?PUBSUB_SHOW_VALUES) -> show_values; -var_xfield(?PUBSUB_SUBSCRIPTION_TYPE) -> subscription_type; -var_xfield(?PUBSUB_SUBSCRIPTION_DEPTH) -> subscription_depth; -var_xfield(_) -> {error, badarg}. +var_xfield(?PUBSUB_DELIVER) -> 'deliver'; +var_xfield(?PUBSUB_DIGEST) -> 'digest'; +var_xfield(?PUBSUB_DIGEST_FREQUENCY) -> 'digest_frequency'; +var_xfield(?PUBSUB_EXPIRE) -> 'expire'; +var_xfield(?PUBSUB_INCLUDE_BODY) -> 'include_body'; +var_xfield(?PUBSUB_SHOW_VALUES) -> 'show_values'; +var_xfield(?PUBSUB_SUBSCRIPTION_TYPE) -> 'subscription_type'; +var_xfield(?PUBSUB_SUBSCRIPTION_DEPTH) -> 'subscription_depth'; +var_xfield(_) -> {error, 'badarg'}. + %% Convert Values for option list's Key. -val_xfield(deliver, [Val]) -> xopt_to_bool(Val); -val_xfield(digest, [Val]) -> xopt_to_bool(Val); -val_xfield(digest_frequency, [Val]) -> list_to_integer(Val); -val_xfield(expire, [Val]) -> jlib:datetime_string_to_timestamp(Val); -val_xfield(include_body, [Val]) -> xopt_to_bool(Val); -val_xfield(show_values, Vals) -> Vals; -val_xfield(subscription_type, ["items"]) -> items; -val_xfield(subscription_type, ["nodes"]) -> nodes; -val_xfield(subscription_depth, ["all"]) -> all; -val_xfield(subscription_depth, [Depth]) -> +val_xfield('deliver', [Val]) -> xopt_to_bool(Val); +val_xfield('digest', [Val]) -> xopt_to_bool(Val); +val_xfield('digest_frequency', [Val]) -> list_to_integer(Val); +val_xfield('expire', [Val]) -> jlib:datetime_string_to_timestamp(Val); +val_xfield('include_body', [Val]) -> xopt_to_bool(Val); +val_xfield('show_values', Vals) -> Vals; +val_xfield('subscription_type', ["items"]) -> items; +val_xfield('subscription_type', ["nodes"]) -> nodes; +val_xfield('subscription_depth', ["all"]) -> all; +val_xfield('subscription_depth', [Depth]) -> case catch list_to_integer(Depth) of - N when is_integer(N) -> N; - _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-acceptable')} + Integer when is_integer(Integer) -> Integer; + _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-acceptable')} end. + %% Convert XForm booleans to Erlang booleans. xopt_to_bool("0") -> false; xopt_to_bool("1") -> true; @@ -247,6 +336,7 @@ xopt_to_bool(_) -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-acce %% Return a field for an XForm for Key, with data filled in, if %% applicable, from Options. +%% TODO : check input type data get_option_xfield(Lang, Key, Options) -> Var = xfield_var(Key), Label = xfield_label(Key), @@ -262,73 +352,76 @@ get_option_xfield(Lang, Key, Options) -> attrs = [?XMLATTR('var', Var), ?XMLATTR('type', Type), ?XMLATTR('label', translate:translate(Lang, Label))], children = OptEls ++ Vals}. +%% TODO : check input type data type_and_options({Type, Options}, Lang) -> {Type, [tr_xfield_options(O, Lang) || O <- Options]}; type_and_options(Type, _Lang) -> {Type, []}. +%% TODO : check input type data tr_xfield_options({Value, Label}, Lang) -> #xmlel{ns = ?NS_DATA_FORMS, - name = 'option', - attrs = [?XMLATTR('label', translate:translate(Lang, Label))], - children = [#xmlel{ns = ?NS_DATA_FORMS, - name = 'value', - children = [?XMLCDATA(Value)]}]}. + name = 'option', + attrs = [?XMLATTR('label', translate:translate(Lang, Label))], + children = [#xmlel{ns = ?NS_DATA_FORMS, + name = 'value', + children = [?XMLCDATA(Value)]}]}. +%% TODO : check input type data tr_xfield_values(Value) -> #xmlel{ns = ?NS_DATA_FORMS, name ='value', children = [?XMLCDATA(Value)]}. %% Return the XForm variable name for a subscription option key. -xfield_var(deliver) -> ?PUBSUB_DELIVER; -xfield_var(digest) -> ?PUBSUB_DIGEST; -xfield_var(digest_frequency) -> ?PUBSUB_DIGEST_FREQUENCY; -xfield_var(expire) -> ?PUBSUB_EXPIRE; -xfield_var(include_body) -> ?PUBSUB_INCLUDE_BODY; -xfield_var(show_values) -> ?PUBSUB_SHOW_VALUES; -xfield_var(subscription_type) -> ?PUBSUB_SUBSCRIPTION_TYPE; -xfield_var(subscription_depth) -> ?PUBSUB_SUBSCRIPTION_DEPTH. +xfield_var('deliver') -> ?PUBSUB_DELIVER; +xfield_var('digest') -> ?PUBSUB_DIGEST; +xfield_var('digest_frequency') -> ?PUBSUB_DIGEST_FREQUENCY; +xfield_var('expire') -> ?PUBSUB_EXPIRE; +xfield_var('include_body') -> ?PUBSUB_INCLUDE_BODY; +xfield_var('show_values') -> ?PUBSUB_SHOW_VALUES; +xfield_var('subscription_type') -> ?PUBSUB_SUBSCRIPTION_TYPE; +xfield_var('subscription_depth') -> ?PUBSUB_SUBSCRIPTION_DEPTH. %% Return the XForm variable type for a subscription option key. -xfield_type(deliver) -> "boolean"; -xfield_type(digest) -> "boolean"; -xfield_type(digest_frequency) -> "text-single"; -xfield_type(expire) -> "text-single"; -xfield_type(include_body) -> "boolean"; -xfield_type(show_values) -> +xfield_type('deliver') -> "boolean"; +xfield_type('digest') -> "boolean"; +xfield_type('digest_frequency') -> "text-single"; +xfield_type('expire') -> "text-single"; +xfield_type('include_body') -> "boolean"; +xfield_type('show_values') -> {"list-multi", [{"away", ?SHOW_VALUE_AWAY_LABEL}, {"chat", ?SHOW_VALUE_CHAT_LABEL}, {"dnd", ?SHOW_VALUE_DND_LABEL}, {"online", ?SHOW_VALUE_ONLINE_LABEL}, {"xa", ?SHOW_VALUE_XA_LABEL}]}; -xfield_type(subscription_type) -> +xfield_type(subscription_type) -> {"list-single", [{"items", ?SUBSCRIPTION_TYPE_VALUE_ITEMS_LABEL}, {"nodes", ?SUBSCRIPTION_TYPE_VALUE_NODES_LABEL}]}; xfield_type(subscription_depth) -> - {"list-single", [{"1", ?SUBSCRIPTION_DEPTH_VALUE_ONE_LABEL}, + {"list-single", [{"1", ?SUBSCRIPTION_DEPTH_VALUE_ONE_LABEL}, {"all", ?SUBSCRIPTION_DEPTH_VALUE_ALL_LABEL}]}. %% Return the XForm variable label for a subscription option key. -xfield_label(deliver) -> ?DELIVER_LABEL; -xfield_label(digest) -> ?DIGEST_LABEL; -xfield_label(digest_frequency) -> ?DIGEST_FREQUENCY_LABEL; -xfield_label(expire) -> ?EXPIRE_LABEL; -xfield_label(include_body) -> ?INCLUDE_BODY_LABEL; -xfield_label(show_values) -> ?SHOW_VALUES_LABEL; -xfield_label(subscription_type) -> ?SUBSCRIPTION_TYPE_LABEL; -xfield_label(subscription_depth) -> ?SUBSCRIPTION_DEPTH_LABEL. +xfield_label('deliver') -> ?DELIVER_LABEL; +xfield_label('digest') -> ?DIGEST_LABEL; +xfield_label('digest_frequency') -> ?DIGEST_FREQUENCY_LABEL; +xfield_label('expire') -> ?EXPIRE_LABEL; +xfield_label('include_body') -> ?INCLUDE_BODY_LABEL; +xfield_label('show_values') -> ?SHOW_VALUES_LABEL; +xfield_label('subscription_type') -> ?SUBSCRIPTION_TYPE_LABEL; +xfield_label('subscription_depth') -> ?SUBSCRIPTION_DEPTH_LABEL. %% Return the XForm value for a subscription option key. -xfield_val(deliver, Val) -> [bool_to_xopt(Val)]; -xfield_val(digest, Val) -> [bool_to_xopt(Val)]; -xfield_val(digest_frequency, Val) -> [integer_to_list(Val)]; -xfield_val(expire, Val) -> [jlib:now_to_utc_string(Val)]; -xfield_val(include_body, Val) -> [bool_to_xopt(Val)]; -xfield_val(show_values, Val) -> Val; -xfield_val(subscription_type, items) -> ["items"]; -xfield_val(subscription_type, nodes) -> ["nodes"]; -xfield_val(subscription_depth, all) -> ["all"]; -xfield_val(subscription_depth, N) -> [integer_to_list(N)]. +xfield_val('deliver', Val) -> [bool_to_xopt(Val)]; +xfield_val('digest', Val) -> [bool_to_xopt(Val)]; +xfield_val('digest_frequency', Val) -> [integer_to_list(Val)]; +xfield_val('expire', Val) -> [jlib:now_to_utc_string(Val)]; +xfield_val('include_body', Val) -> [bool_to_xopt(Val)]; +xfield_val('show_values', Val) -> Val; +xfield_val('subscription_type', 'items') -> ["items"]; +xfield_val('subscription_type', 'nodes') -> ["nodes"]; +xfield_val('subscription_depth', 'all') -> ["all"]; +xfield_val('subscription_depth', Depth) -> [integer_to_list(Depth)]. %% Convert erlang booleans to XForms. -bool_to_xopt(false) -> "false"; -bool_to_xopt(true) -> "true". +bool_to_xopt('false') -> "false"; +bool_to_xopt('true') -> "true". From 78b8307a1faee37230e990210f76e085e7f33849 Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Thu, 30 Sep 2010 12:06:40 +0200 Subject: [PATCH 26/34] fix dializer warnings (thanks to Karim Gemayel) --- src/mod_pubsub/node_flat.erl | 4 +- src/mod_pubsub/node_pep.erl | 457 ++++++++++++++++++++++++++++------- 2 files changed, 377 insertions(+), 84 deletions(-) diff --git a/src/mod_pubsub/node_flat.erl b/src/mod_pubsub/node_flat.erl index 884b5bc7a..1d1096461 100644 --- a/src/mod_pubsub/node_flat.erl +++ b/src/mod_pubsub/node_flat.erl @@ -214,11 +214,11 @@ features() -> -> {'result', IsAllowed::boolean()} ). -create_node_permission(Host, ServerHost, _NodeId, _ParentNodeId, #jid{node = U, domain = S, resource = R} = _JID, Access) -> +create_node_permission(Host, ServerHost, _NodeId, _ParentNodeId, #jid{node = U, domain = S, resource = R} = JID, Access) -> Owner = {U,S,R}, IsAllowed = case Owner of {undefined, Host, undefined} -> true; % pubsub service always allowed - _ -> acl:match_rule(ServerHost, Access, exmpp_jid:make(Owner)) =:= 'allow' + _ -> acl:match_rule(ServerHost, Access, JID) =:= 'allow' end, {result, IsAllowed}. diff --git a/src/mod_pubsub/node_pep.erl b/src/mod_pubsub/node_pep.erl index 8ec3737bf..1a4fb2aa5 100644 --- a/src/mod_pubsub/node_pep.erl +++ b/src/mod_pubsub/node_pep.erl @@ -68,15 +68,35 @@ path_to_node/1 ]). + +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(Host, ServerHost, Opts) -> node_flat:init(Host, ServerHost, Opts), complain_if_modcaps_disabled(ServerHost), ok. + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost), ok. + +-spec(options/0 :: () -> [nodeOption()]). + options() -> [{deliver_payloads, true}, {notify_config, false}, @@ -96,6 +116,9 @@ options() -> {deliver_notifications, true}, {presence_based_delivery, true}]. + +-spec(features/0 :: () -> [Feature::string()]). + features() -> ["create-nodes", %* "auto-create", %* @@ -115,165 +138,429 @@ features() -> "subscribe" %* ]. -create_node_permission(Host, ServerHost, _Node, _ParentNode, Owner, Access) -> - LOwner = jlib:short_prepd_jid(Owner), - {User, Server, Resource} = LOwner, - Allowed = case LOwner of + +-spec(create_node_permission/6 :: + ( + Host :: hostPEP(), + ServerHost :: string(), + NodeId :: nodeId(), + ParentNodeId :: nodeId(), + JID :: jidEntity(), + Access :: atom()) + -> {'result', IsAllowed::boolean()} + ). + +create_node_permission(Host, ServerHost, _NodeId, _ParentNodeId, #jid{node = U, domain = S, resource = R} = JID, Access) -> + Owner = {U,S,R}, + Allowed = case Owner of {undefined, Host, undefined} -> true; % pubsub service always allowed _ -> - JID = exmpp_jid:make(User, Server, Resource), case acl:match_rule(ServerHost, Access, JID) of - allow -> + 'allow' -> case Host of - {User, Server, _} -> true; + {_, _, _} -> true; _ -> false end; - E -> - ?DEBUG("Create not allowed : ~p~n", [E]), + Error -> + ?DEBUG("Create not allowed : ~p~n", [Error]), false end end, {result, Allowed}. -create_node(NodeId, Owner) -> - case node_flat:create_node(NodeId, Owner) of - {result, _} -> {result, []}; - Error -> Error - end. -delete_node(Removed) -> - case node_flat:delete_node(Removed) of - {result, {_, _, Removed}} -> {result, {[], Removed}}; - Error -> Error - end. +-spec(create_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', []}% | {'error', 'internal-server-error'} + ). -subscribe_node(NodeId, Sender, Subscriber, AccessModel, +create_node(NodeIdx, JID) -> + {result, _} = node_flat:create_node(NodeIdx, JID), + {result, []}. +% case node_flat:create_node(NodeIdx, JID) of +% {result, _} -> {result, []}; +% Error -> Error +% end. + + +-spec(delete_node/1 :: + ( + Nodes :: [Node::pubsubNode()]) + -> {result, {[], + Removed :: [] | [{Node :: pubsubNode(), + [{Owner :: bareUsr(), + Subscriptions :: [{Subscription :: subscription(), + SubId :: subId()}]}]}]}} + %| {'error', 'internal-server-error'} + ). + +delete_node(Nodes) -> + {result, {_, _, Nodes}} = node_flat:delete_node(Nodes), + {result, {[], Nodes}}. +% case node_flat:delete_node(Nodes) of +% {result, {_, _, Nodes}} -> {result, {[], Nodes}}; +% Error -> Error +% end. + + +-spec(subscribe_node/8 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + AccessModel :: accessModel(), + SendLast :: atom(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + Options :: [nodeOption()]) + -> {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId()}} + | {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId(), + SendLast ::' send_last'}} + | {'result', {'default', + Subscription :: 'pending', + SubId :: subId()}} + | {'error', _} %% TODO add all error cases + ). + +subscribe_node(NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> node_flat:subscribe_node( - NodeId, Sender, Subscriber, AccessModel, SendLast, + NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> - case node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId) of + +-spec(unsubscribe_node/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + SubId :: subId()) + -> {'result', []} | {'error', _} %% TODO : add all error cases + ). + +unsubscribe_node(NodeIdx, JID, Subscriber, SubId) -> + case node_flat:unsubscribe_node(NodeIdx, JID, Subscriber, SubId) of {error, Error} -> {error, Error}; {result, _} -> {result, []} end. -publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> - node_flat:publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload). -remove_extra_items(NodeId, MaxItems, ItemIds) -> - node_flat:remove_extra_items(NodeId, MaxItems, ItemIds). +-spec(publish_item/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), %% TODO : make a generic publishMod() type + MaxItems :: 'unlimited' | integer(), + ItemId :: itemId(), + Payload :: payload()) + -> {'result', {'default', 'broadcast', ItemIds :: [] | [itemId()]}} + | {'error', _} + ). -delete_item(NodeId, Publisher, PublishModel, ItemId) -> - node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId). +publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload) -> + node_flat:publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload). -purge_node(NodeId, Owner) -> - node_flat:purge_node(NodeId, Owner). -get_entity_affiliations(_Host, Owner) -> - {_, D, _} = jlib:short_prepd_jid(Owner), - GenKey = jlib:short_prepd_bare_jid(Owner), - States = mnesia:match_object(#pubsub_state{id = {GenKey, '_'}, _ = '_'}), - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(D, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree +-spec(remove_extra_items/3 :: + ( + NodeIdx :: nodeIdx(), + MaxItems :: 'unlimited' | integer(), + ItemsIds :: [ItemId::itemId()]) + -> {'result', + {OldItems :: [] | [ItemId::itemId()], + NewItems :: [] | [ItemId::itemId()]}} + ). + +remove_extra_items(NodeIdx, MaxItems, ItemIds) -> + node_flat:remove_extra_items(NodeIdx, MaxItems, ItemIds). + + +-spec(delete_item/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), + ItemId :: itemId()) + -> {'result', {'default', 'broadcast'}} | {'error', _} + ). + +delete_item(NodeIdx, JID, PublishModel, ItemId) -> + node_flat:delete_item(NodeIdx, JID, PublishModel, ItemId). + + +-spec(purge_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} | {'error', 'forbidden'} + ). + +purge_node(NodeIdx, JID) -> + node_flat:purge_node(NodeIdx, JID). + + +-spec(get_entity_affiliations/2 :: + ( + Host :: binary(), + JID :: jidEntity()) + -> {'result', Reply :: [] | [{Node::pubsubNode(), Affiliation::affiliation()}]} + ). + +get_entity_affiliations(_Host, #jid{node = U, domain = S} = _JID) -> + States = mnesia:match_object(#pubsub_state{id = {_GenKey = {U,S,undefined}, '_'}, _ = '_'}), + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(S, 'config'), 'nodetree') of + [{'nodetree', Tree}] -> Tree; + _ -> 'nodetree_tree' end, - Reply = lists:foldl(fun(#pubsub_state{id = {_, N}, affiliation = A}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{id = {{_, D, _}, _}} = Node -> [{Node, A}|Acc]; + Reply = lists:foldl(fun(#pubsub_state{id = {_, NodeIdx}, affiliation = Affiliation}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {{_, S, _}, _}} = Node -> [{Node, Affiliation}|Acc]; _ -> Acc end end, [], States), {result, Reply}. -get_node_affiliations(NodeId) -> - node_flat:get_node_affiliations(NodeId). -get_affiliation(NodeId, Owner) -> - node_flat:get_affiliation(NodeId, Owner). +-spec(get_node_affiliations/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] | [{Entity::fullUsr(), Affiliation::affiliation()}]} + ). -set_affiliation(NodeId, Owner, Affiliation) -> - node_flat:set_affiliation(NodeId, Owner, Affiliation). +get_node_affiliations(NodeIdx) -> + node_flat:get_node_affiliations(NodeIdx). -get_entity_subscriptions(_Host, Owner) -> - {U, D, _} = SubKey = jlib:short_prepd_jid(Owner), - GenKey = jlib:short_prepd_bare_jid(Owner), + +-spec(get_affiliation/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Affiliation::affiliation()} + ). + +get_affiliation(NodeIdx, JID) -> + node_flat:get_affiliation(NodeIdx, JID). + + +-spec(set_affiliation/3 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Affiliation :: affiliation()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_affiliation(NodeIdx, JID, Affiliation) -> + node_flat:set_affiliation(NodeIdx, JID, Affiliation). + + +-spec(get_entity_subscriptions/2 :: + ( + Host :: hostPEP(), + JID :: jidEntity()) + -> {'result', [] + | [{Node :: pubsubNode(), + Subscription :: subscription(), + SubId :: subId(), + Entity :: fullUsr()}]} + ). + +get_entity_subscriptions(_Host, #jid{node = U, domain = S, resource = R} = _JID) -> + SubKey = {U,S,R}, + GenKey = {U,S,undefined}, States = case SubKey of GenKey -> mnesia:match_object( - #pubsub_state{id = {{U, D, '_'}, '_'}, _ = '_'}); + #pubsub_state{id = {{U, S, '_'}, '_'}, _ = '_'}); _ -> mnesia:match_object( #pubsub_state{id = {GenKey, '_'}, _ = '_'}) ++ mnesia:match_object( #pubsub_state{id = {SubKey, '_'}, _ = '_'}) end, - NodeTree = case catch ets:lookup(gen_mod:get_module_proc(D, config), nodetree) of - [{nodetree, N}] -> N; - _ -> nodetree_tree + NodeTree = case catch ets:lookup(gen_mod:get_module_proc(S, 'config'), 'nodetree') of + [{nodetree, Tree}] -> Tree; + _ -> 'nodetree_tree' end, - Reply = lists:foldl(fun(#pubsub_state{id = {J, N}, subscriptions = Ss}, Acc) -> - case NodeTree:get_node(N) of - #pubsub_node{id = {{_, D, _}, _}} = Node -> + Reply = lists:foldl(fun(#pubsub_state{id = {Entity, NodeIdx}, subscriptions = Subscriptions}, Acc) -> + case NodeTree:get_node(NodeIdx) of + #pubsub_node{id = {{_, S, _}, _}} = Node -> lists:foldl(fun({subscribed, SubId}, Acc2) -> - [{Node, subscribed, SubId, J} | Acc2]; + [{Node, subscribed, SubId, Entity} | Acc2]; ({pending, _SubId}, Acc2) -> - [{Node, pending, J} | Acc2]; - (S, Acc2) -> - [{Node, S, J} | Acc2] - end, Acc, Ss); + [{Node, pending, Entity} | Acc2]; + (Subscription, Acc2) -> + [{Node, Subscription, Entity} | Acc2] + end, Acc, Subscriptions); _ -> Acc end end, [], States), {result, Reply}. -get_node_subscriptions(NodeId) -> + +-spec(get_node_subscriptions/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] + | [{Entity::fullUsr(), 'none'}] + %| [{Entity::fullUsr(), Subscription::subscription()}] %% still useful case ? + | [{Entity::fullUsr(), Subscription::subscription(), SubId::subId()}]} + ). + +get_node_subscriptions(NodeIdx) -> %% note: get_node_subscriptions is used for broadcasting %% there should not have any subscriptions %% but that call returns also all subscription to none %% and this is required for broadcast to occurs %% DO NOT REMOVE - node_flat:get_node_subscriptions(NodeId). + node_flat:get_node_subscriptions(NodeIdx). -get_subscriptions(NodeId, Owner) -> - node_flat:get_subscriptions(NodeId, Owner). -set_subscriptions(NodeId, Owner, Subscription, SubId) -> - node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId). +-spec(get_subscriptions/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Subscriptions :: [] | [{Subscription::subscription(), SubId::subId()}]} + ). -get_pending_nodes(Host, Owner) -> - node_flat:get_pending_nodes(Host, Owner). +get_subscriptions(NodeIdx, JID) -> + node_flat:get_subscriptions(NodeIdx, JID). -get_states(NodeId) -> - node_flat:get_states(NodeId). -get_state(NodeId, JID) -> - node_flat:get_state(NodeId, JID). +-spec(set_subscriptions/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscription :: subscription(), + SubId :: subId()) + -> 'ok' + | {Subscription::subscription(), SubId::subId()} + | {error, _} + ). + +set_subscriptions(NodeIdx, JID, Subscription, SubId) -> + node_flat:set_subscriptions(NodeIdx, JID, Subscription, SubId). + + +-spec(get_pending_nodes/2 :: + ( + Host :: hostPEP(), + JID :: jidEntity()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_pending_nodes(Host, JID) -> + node_flat:get_pending_nodes(Host, JID). + + +-spec(get_states/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', States :: [] | [State::pubsubState()]} + ). + +get_states(NodeIdx) -> + node_flat:get_states(NodeIdx). + + +-spec(get_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> State::pubsubState() + ). + +get_state(NodeIdx, Entity) -> + node_flat:get_state(NodeIdx, Entity). + + +-spec(set_state/1 :: + ( + State :: pubsubState()) + -> 'ok' | {'error', 'internal-server-error'} + ). set_state(State) -> node_flat:set_state(State). -get_items(NodeId, From) -> - node_flat:get_items(NodeId, From). -get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> - node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). +-spec(get_items/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + ). -get_item(NodeId, ItemId) -> - node_flat:get_item(NodeId, ItemId). +get_items(NodeIdx, Entity) -> + node_flat:get_items(NodeIdx, Entity). -get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> - node_flat:get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + +-spec(get_items/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + | {'error', _} + ). + +get_items(NodeIdx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_flat:get_items(NodeIdx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + + +-spec(get_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId) -> + node_flat:get_item(NodeIdx, ItemId). + + +-spec(get_item/7 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> + node_flat:get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + + +-spec(set_item/1 :: + ( + Item :: pubsubItem()) + -> 'ok' | {error, 'internal-server-error'} + ). set_item(Item) -> node_flat:set_item(Item). + get_item_name(Host, Node, Id) -> node_flat:get_item_name(Host, Node, Id). + node_to_path(Node) -> node_flat:node_to_path(Node). + path_to_node(Path) -> node_flat:path_to_node(Path). @@ -286,6 +573,12 @@ path_to_node(Path) -> %% The PEP plugin for mod_pubsub requires mod_caps to be enabled in the host. %% Check that the mod_caps module is enabled in that Jabber Host %% If not, show a warning message in the ejabberd log file. +-spec(complain_if_modcaps_disabled/1 :: + ( + ServerHost :: string()) + -> 'ok' | true + ). + complain_if_modcaps_disabled(ServerHost) -> Modules = ejabberd_config:get_local_option({modules, ServerHost}), ModCaps = [mod_caps_enabled || {mod_caps, _Opts} <- Modules], From 349c44fcc0bef5b6cbf95fbeca92e1b2b0267e4f Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 30 Sep 2010 13:44:16 +0200 Subject: [PATCH 27/34] Fix Edoc errors (thanks to Karim Gemayel) --- src/mod_pubsub/pubsub.hrl | 58 ++++++++++++++++++++++++++------------- 1 file changed, 39 insertions(+), 19 deletions(-) diff --git a/src/mod_pubsub/pubsub.hrl b/src/mod_pubsub/pubsub.hrl index be062f28b..832b4d8c4 100644 --- a/src/mod_pubsub/pubsub.hrl +++ b/src/mod_pubsub/pubsub.hrl @@ -50,7 +50,10 @@ -type(hostPubsub() :: binary()). -%%% @type hostPEP() = {User::binary(), Server::binary, Resource::undefined}. +%%% @type hostPEP() = {User, Server, Resource} +%%% User = binary() +%%% Server = binary() +%%% Resource = undefined. -type(hostPEP() :: {User::binary(), Server::binary, Resource::undefined}). @@ -99,33 +102,43 @@ -type(nodeType() :: string()). -%%% @type ljid() = {User::binary(), Server::binary(), Resource::binary()}. +%%% @type ljid() = {User, Server, Resource} +%%% User = undefined | binary() +%%% Server = binary() +%%% Resource = undefined | binary(). -type(ljid() :: {User::binary(), Server::binary(), Resource::binary()}). %% TODO : move upper in exmpp -%%% @type jidComponent() = -%% #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}. +%%% @type jidComponent() = {jid, Raw, Node, Domain, Resource} +%%% Raw = binary() +%%% Node = undefined +%%% Domain = binary() +%%% Resource = undefined. -type(jidComponent() :: #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined}). %% TODO : move upper in exmpp -%%% @type jidContact() = -%% #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}. +%%% @type jidContact() = {jid, Raw, Node, Domain, Resource} +%%% Raw = binary() +%%% Node = binary() +%%% Domain = binary() +%%% Resource = undefined. -type(jidContact() :: #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined}). %% TODO : move upper in exmpp -%%% @type jidEntity() = -%%% #jid{raw::binary(), node::binary(), domain::binary(), resource::undefined} -%%% #jid{raw::binary(), node::binary(), domain::binary(), resource::binary()} -%%% #jid{raw::binary(), node::undefined, domain::binary(), resource::undefined} -%%% #jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}. +%%% @type jidEntity() = {jid, Raw, Node, Domain, Resource} +%%% Raw = binary() +%%% Node = undefined | binary() +%%% Domain = binary() +%%% Resource = undefined | binary(). + -type(jidEntity() :: %% Contact bare JID @@ -138,17 +151,20 @@ #jid{raw::binary(), node::undefined, domain::binary(), resource::binary()}). -%%% @type bareUsr() = {User::binary(), Server::binary(), Resource::undefined} -%%% | {User::undefined, Server::binary(), Resource::undefined}. +%%% @type bareUsr() = {User, Server, Resource} +%%% User = undefined | binary() +%%% Server = binary() +%%% Resource = undefined. -type(bareUsr() :: {User::binary(), Server::binary(), Resource::undefined} | {User::undefined, Server::binary(), Resource::undefined}). -%%% @type fullUsr() = {User::binary(), Server::binary(), Resource::undefined} -%%% | {User::binary(), Server::binary(), Resource::binary()} -%%% | {User::undefined, Server::binary(), Resource::undefined} -%%% | {User::undefined, Server::binary(), Resource::binary()}. +%%% @type fullUsr() = {User, Server, Resource} +%%% User = undefined | binary() +%%% Server = binary() +%%% Resource = undefined | binary(). + -type(fullUsr() :: {User::binary(), Server::binary(), Resource::undefined} | {User::binary(), Server::binary(), Resource::binary()} @@ -161,7 +177,10 @@ -type(nodeIdx() :: integer()). -%%% @type now() = {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}. +%%% @type now() = {Megaseconds, Seconds, Microseconds} +%%% Megaseconds = integer() +%%% Seconds = integer() +%%% Microseconds = integer(). -type(now() :: {Megaseconds::integer(), Seconds::integer(), Microseconds::integer()}). @@ -223,7 +242,8 @@ -type(pubsubIQResponse() :: #xmlel{}). -%%% @type features() = [Feature::string()]. +%%% @type features() = [Feature] +%%% Feature = string(). -type(features() :: [Feature::string()]). From ee861e650d9e2c242d0d4027fbae77bedaa50e9f Mon Sep 17 00:00:00 2001 From: Christophe Romain Date: Mon, 4 Oct 2010 17:41:59 +0200 Subject: [PATCH 28/34] fix dializer warnings (thanks to Karim Gemayel) --- src/mod_pubsub/node_dag.erl | 407 ++++++++++++++++++++++++++----- src/mod_pubsub/nodetree_dag.erl | 398 ++++++++++++++++++++++-------- src/mod_pubsub/nodetree_tree.erl | 2 +- 3 files changed, 651 insertions(+), 156 deletions(-) diff --git a/src/mod_pubsub/node_dag.erl b/src/mod_pubsub/node_dag.erl index 29db20103..7f92cbc57 100644 --- a/src/mod_pubsub/node_dag.erl +++ b/src/mod_pubsub/node_dag.erl @@ -53,123 +53,412 @@ get_item/2, set_item/1, get_item_name/3, - node_to_path/1, - path_to_node/1]). + node_to_path/1, + path_to_node/1]). +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(Host, ServerHost, Opts) -> node_flat:init(Host, ServerHost, Opts). + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(Host, ServerHost) -> node_flat:terminate(Host, ServerHost). + +-spec(options/0 :: () -> [nodeOption()]). + options() -> - [{node_type, leaf} | node_flat:options()]. + [{'node_type', 'leaf'} | node_flat:options()]. + + +-spec(features/0 :: () -> [Feature::string()]). features() -> ["multi-collection" | node_flat:features()]. -create_node_permission(_Host, _ServerHost, _Node, _ParentNode, - _Owner, _Access) -> + +-spec(create_node_permission/6 :: + ( + Host :: hostPubsub(), + ServerHost :: string(), + NodeId :: nodeId(), + ParentNodeId :: nodeId(), + JID :: jidEntity(), + Access :: atom()) + -> {'result', 'true'} + ). + +create_node_permission(_Host, _ServerHost, _NodeId, _ParentNodeId, + _JID, _Access) -> {result, true}. -create_node(NodeId, Owner) -> - node_flat:create_node(NodeId, Owner). -delete_node(Removed) -> - node_flat:delete_node(Removed). +-spec(create_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} + ). -subscribe_node(NodeId, Sender, Subscriber, AccessModel, +create_node(NodeIdx, JID) -> + node_flat:create_node(NodeIdx, JID). + + +-spec(delete_node/1 :: + ( + Nodes :: [Node::pubsubNode()]) + -> {result, {'default', 'broadcast', + Reply :: [{Node :: pubsubNode(), + [{Owner :: bareUsr(), + Subscriptions :: [{Subscription :: subscription(), + SubId :: subId()}]}]}]}} + ). + +delete_node(Nodes) -> + node_flat:delete_node(Nodes). + + +-spec(subscribe_node/8 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + AccessModel :: accessModel(), + SendLast :: atom(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + Options :: [nodeOption()]) + -> {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId()}} + | {'result', {'default', + Subscription :: 'subscribed', + SubId :: subId(), + SendLast ::' send_last'}} + | {'result', {'default', + Subscription :: 'pending', + SubId :: subId()}} + | {'error', _} %% TODO add all error cases + ). + +subscribe_node(NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options) -> - node_flat:subscribe_node(NodeId, Sender, Subscriber, AccessModel, + node_flat:subscribe_node(NodeIdx, JID, Subscriber, AccessModel, SendLast, PresenceSubscription, RosterGroup, Options). -unsubscribe_node(NodeId, Sender, Subscriber, SubId) -> - node_flat:unsubscribe_node(NodeId, Sender, Subscriber, SubId). -publish_item(NodeId, Publisher, Model, MaxItems, ItemId, Payload) -> +-spec(unsubscribe_node/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscriber :: jidEntity(), + SubId :: subId()) + -> {'result', 'default'} | {'error', _} %% TODO : add all error cases + ). + +unsubscribe_node(NodeIdx, JID, Subscriber, SubId) -> + node_flat:unsubscribe_node(NodeIdx, JID, Subscriber, SubId). + + +-spec(publish_item/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), %% TODO : make a generic publishMod() type + MaxItems :: 'unlimited' | integer(), + ItemId :: itemId(), + Payload :: payload()) + -> {'result', {'default', 'broadcast', ItemIds :: [] | [itemId()]}} + | {'error', _} + ). + +publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload) -> %% TODO: should look up the NodeTree plugin here. There's no %% access to the Host of the request at this level, so for now we %% just use nodetree_dag. - case nodetree_dag:get_node(NodeId) of + case nodetree_dag:get_node(NodeIdx) of #pubsub_node{options = Options} -> - case find_opt(node_type, Options) of - collection -> + case find_opt('node_type', Options) of + 'collection' -> {error, mod_pubsub:extended_error('not-allowed', "publish")}; _ -> - node_flat:publish_item(NodeId, Publisher, Model, + node_flat:publish_item(NodeIdx, JID, PublishModel, MaxItems, ItemId, Payload) end; - Err -> - Err + Error -> + Error end. -find_opt(_, []) -> false; -find_opt(Option, [{Option, Value} | _]) -> Value; -find_opt(Option, [_ | T]) -> find_opt(Option, T). -remove_extra_items(NodeId, MaxItems, ItemIds) -> - node_flat:remove_extra_items(NodeId, MaxItems, ItemIds). +-spec(find_opt/2 :: + ( + Key :: atom(), + Options :: [] | [Option::nodeOption()]) + -> Value :: 'false' | term() + ). -delete_item(NodeId, Publisher, PublishModel, ItemId) -> - node_flat:delete_item(NodeId, Publisher, PublishModel, ItemId). +find_opt(_, []) -> false; +find_opt(Key, [{Key, Value} | _]) -> Value; +find_opt(Key, [_ | Options]) -> find_opt(Key, Options). -purge_node(NodeId, Owner) -> - node_flat:purge_node(NodeId, Owner). -get_entity_affiliations(Host, Owner) -> - node_flat:get_entity_affiliations(Host, Owner). +-spec(remove_extra_items/3 :: + ( + NodeIdx :: nodeIdx(), + MaxItems :: 'unlimited' | integer(), + ItemsIds :: [ItemId::itemId()]) + -> {'result', + {OldItems :: [] | [ItemId::itemId()], + NewItems :: [] | [ItemId::itemId()]}} + ). -get_node_affiliations(NodeId) -> - node_flat:get_node_affiliations(NodeId). +remove_extra_items(NodeIdx, MaxItems, ItemIds) -> + node_flat:remove_extra_items(NodeIdx, MaxItems, ItemIds). -get_affiliation(NodeId, Owner) -> - node_flat:get_affiliation(NodeId, Owner). -set_affiliation(NodeId, Owner, Affiliation) -> - node_flat:set_affiliation(NodeId, Owner, Affiliation). +-spec(delete_item/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + PublishModel :: atom(), + ItemId :: itemId()) + -> {'result', {'default', 'broadcast'}} | {'error', _} + ). -get_entity_subscriptions(Host, Owner) -> - node_flat:get_entity_subscriptions(Host, Owner). +delete_item(NodeIdx, JID, PublishModel, ItemId) -> + node_flat:delete_item(NodeIdx, JID, PublishModel, ItemId). -get_node_subscriptions(NodeId) -> - node_flat:get_node_subscriptions(NodeId). -get_subscriptions(NodeId, Owner) -> - node_flat:get_subscriptions(NodeId, Owner). +-spec(purge_node/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', {'default', 'broadcast'}} | {'error', 'forbidden'} + ). -set_subscriptions(NodeId, Owner, Subscription, SubId) -> - node_flat:set_subscriptions(NodeId, Owner, Subscription, SubId). +purge_node(NodeIdx, JID) -> + node_flat:purge_node(NodeIdx, JID). -get_pending_nodes(Host, Owner) -> - node_flat:get_pending_nodes(Host, Owner). -get_states(NodeId) -> - node_flat:get_states(NodeId). +-spec(get_entity_affiliations/2 :: + ( + Host :: binary(), + JID :: jidEntity()) + -> {'result', Reply :: [] | [{Node::pubsubNode(), Affiliation::affiliation()}]} + ). -get_state(NodeId, JID) -> - node_flat:get_state(NodeId, JID). +get_entity_affiliations(Host, JID) -> + node_flat:get_entity_affiliations(Host, JID). + + +-spec(get_node_affiliations/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] | [{Entity::fullUsr(), Affiliation::affiliation()}]} + ). + +get_node_affiliations(NodeIdx) -> + node_flat:get_node_affiliations(NodeIdx). + + +-spec(get_affiliation/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Affiliation::affiliation()} + ). + +get_affiliation(NodeIdx, JID) -> + node_flat:get_affiliation(NodeIdx, JID). + + +-spec(set_affiliation/3 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Affiliation :: affiliation()) + -> 'ok' | {error, 'internal-server-error'} + ). + +set_affiliation(NodeIdx, JID, Affiliation) -> + node_flat:set_affiliation(NodeIdx, JID, Affiliation). + + +-spec(get_entity_subscriptions/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> {'result', [] + | [{Node :: pubsubNode(), + Subscription :: subscription(), + SubId :: subId(), + Entity :: fullUsr()}]} + ). + +get_entity_subscriptions(Host, JID) -> + node_flat:get_entity_subscriptions(Host, JID). + + +-spec(get_node_subscriptions/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', [] + | [{Entity::fullUsr(), 'none'}] + | [{Entity::fullUsr(), Subscription::subscription(), SubId::subId()}]} + ). + +get_node_subscriptions(NodeIdx) -> + node_flat:get_node_subscriptions(NodeIdx). + + +-spec(get_subscriptions/2 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity()) + -> {'result', Subscriptions :: [] | [{Subscription::subscription(), SubId::subId()}]} + ). + +get_subscriptions(NodeIdx, JID) -> + node_flat:get_subscriptions(NodeIdx, JID). + + +-spec(set_subscriptions/4 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + Subscription :: subscription(), + SubId :: subId()) + -> 'ok' + | {Subscription::subscription(), SubId::subId()} + | {error, _} + ). + +set_subscriptions(NodeIdx, JID, Subscription, SubId) -> + node_flat:set_subscriptions(NodeIdx, JID, Subscription, SubId). + + +-spec(get_pending_nodes/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> 'false' | {'value', NodeId::nodeId()} + ). + +get_pending_nodes(Host, JID) -> + node_flat:get_pending_nodes(Host, JID). + + +-spec(get_states/1 :: + ( + NodeIdx :: nodeIdx()) + -> {'result', States :: [] | [State::pubsubState()]} + ). + +get_states(NodeIdx) -> + node_flat:get_states(NodeIdx). + + +-spec(get_state/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> State::pubsubState() + ). + +get_state(NodeIdx, Entity) -> + node_flat:get_state(NodeIdx, Entity). + + +-spec(set_state/1 :: + ( + State :: pubsubState()) + -> 'ok' | {error, 'internal-server-error'} + ). set_state(State) -> node_flat:set_state(State). -get_items(NodeId, From) -> - node_flat:get_items(NodeId, From). -get_items(NodeId, JID, AccessModel, PresenceSubscription, +-spec(get_items/2 :: + ( + NodeIdx :: nodeIdx(), + Entity :: fullUsr()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + ). + +get_items(NodeIdx, Entity) -> + node_flat:get_items(NodeIdx, Entity). + + +-spec(get_items/6 :: + ( + NodeIdx :: nodeIdx(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Items :: [] | [Item::pubsubItem()]} + | {'error', _} + ). + +get_items(NodeIdx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> - node_flat:get_items(NodeId, JID, AccessModel, PresenceSubscription, + node_flat:get_items(NodeIdx, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). -get_item(NodeId, ItemId) -> - node_flat:get_item(NodeId, ItemId). -get_item(NodeId, ItemId, JID, AccessModel, PresenceSubscription, +-spec(get_item/2 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId) -> + node_flat:get_item(NodeIdx, ItemId). + + +-spec(get_item/7 :: + ( + NodeIdx :: nodeIdx(), + ItemId :: itemId(), + JID :: jidEntity(), + AccessModel :: accessModel(), + PresenceSubscription :: boolean(), + RosterGroup :: boolean(), + SubId :: subId()) + -> {'result', Item::pubsubItem()} | {'error', 'item-not-found'} + ). + +get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId) -> - node_flat:get_item(NodeId, ItemId, JID, AccessModel, + node_flat:get_item(NodeIdx, ItemId, JID, AccessModel, PresenceSubscription, RosterGroup, SubId). + +-spec(set_item/1 :: + ( + Item :: pubsubItem()) + -> 'ok' | {error, 'internal-server-error'} + ). + set_item(Item) -> node_flat:set_item(Item). diff --git a/src/mod_pubsub/nodetree_dag.erl b/src/mod_pubsub/nodetree_dag.erl index 722aaee51..890934557 100644 --- a/src/mod_pubsub/nodetree_dag.erl +++ b/src/mod_pubsub/nodetree_dag.erl @@ -51,128 +51,265 @@ %%==================================================================== %% API %%==================================================================== +-spec(init/3 :: + ( + Host :: string(), + ServerHost :: string(), + Opts :: [{Key::atom(), Value::term()}]) + -> 'ok' + ). + init(Host, ServerHost, Opts) -> nodetree_tree:init(Host, ServerHost, Opts). + +-spec(terminate/2 :: + ( + Host :: string(), + ServerHost :: string()) + -> 'ok' + ). + terminate(Host, ServerHost) -> nodetree_tree:terminate(Host, ServerHost). -create_node(Key, Node, Type, Owner, Options, Parents) -> - OwnerJID = jlib:short_prepd_bare_jid(Owner), - case find_node(Key, Node) of + +-spec(create_node/6 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + Type :: nodeType(), + JID :: jidEntity(), + Options :: [nodeOption()], + ParentNodeIds :: [] | [nodeId()]) + -> {'ok', NodeIdx::nodeIdx()} | {'error', _} + ). + +create_node(Host, NodeId, Type, #jid{node = U, domain = S} = _JID, Options, ParentNodeIds) -> + case find_node(Host, NodeId) of false -> - Nidx = pubsub_index:new(node), - N = #pubsub_node{id = oid(Key, Node), - idx = Nidx, + NodeIdx = pubsub_index:new(node), + Node = #pubsub_node{id = {Host, NodeId}, + idx = NodeIdx, type = Type, - parents = Parents, - owners = [OwnerJID], + parents = ParentNodeIds, + owners = [_Owner = {U,S,undefined}], options = Options}, - case set_node(N) of - ok -> {ok, Nidx}; + case set_node(Node) of + ok -> {ok, NodeIdx}; Other -> Other end; _ -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'conflict')} end. -set_node(#pubsub_node{id = {Key, _}, + +-spec(set_node/1 :: + ( + Node :: pubsubNode()) + -> 'ok' | {'error', _} + ). + +set_node(#pubsub_node{id = {Host, _}, owners = Owners, options = Options} = Node) -> - Parents = find_opt(collection, ?DEFAULT_PARENTS, Options), - case validate_parentage(Key, Owners, Parents) of + ParentNodeIds = find_opt('collection', ?DEFAULT_PARENTS, Options), + case validate_parentage(Host, Owners, ParentNodeIds) of true -> %% Update parents whenever the config changes. - mnesia:write(Node#pubsub_node{parents = Parents}); + mnesia:write(Node#pubsub_node{parents = ParentNodeIds}); Other -> Other end. -delete_node(Key, Node) -> - case find_node(Key, Node) of + +-spec(delete_node/2 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId()) + -> [pubsubNode()] | {'error', _} + ). + +delete_node(Host, NodeId) -> + case find_node(Host, NodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - Record -> + ParentNode -> %% Find all of N's children, update their configs to %% remove N from the collection setting. - lists:foreach(fun (#pubsub_node{options = Opts} = Child) -> - NewOpts = remove_config_parent(Node, Opts), - Parents = find_opt(collection, ?DEFAULT_PARENTS, NewOpts), + lists:foreach(fun (#pubsub_node{options = Options} = Node) -> + NewOptions = remove_config_parent(NodeId, Options), + Parents = find_opt('collection', ?DEFAULT_PARENTS, NewOptions), ok = mnesia:write(pubsub_node, - Child#pubsub_node{ + Node#pubsub_node{ parents = Parents, - options = NewOpts}, + options = NewOptions}, write) - end, get_subnodes(Key, Node)), + end, get_subnodes(Host, NodeId)), %% Remove and return the requested node. - pubsub_index:free(node, Record#pubsub_node.idx), - mnesia:delete_object(pubsub_node, Record, write), - [Record] + pubsub_index:free(node, ParentNode#pubsub_node.idx), + mnesia:delete_object(pubsub_node, ParentNode, write), + [ParentNode] end. -options() -> - nodetree_tree:options(). -get_node(Host, Node, _From) -> - get_node(Host, Node). +-spec(options/0 :: () -> Options::[Option::nodeOption()]). + %Options::[{'virtual_tree', 'false'}]) -get_node(Host, Node) -> - case find_node(Host, Node) of +options() -> nodetree_tree:options(). + + +-spec(get_node/3 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + JID :: jidEntity()) + -> pubsubNode() | {'error', _} + ). + +get_node(Host, NodeId, _JID) -> + get_node(Host, NodeId). + + +-spec(get_node/2 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId()) + -> pubsubNode() | {'error', _} + ). + +get_node(Host, NodeId) -> + case find_node(Host, NodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - Record -> Record + Node -> Node end. -get_node(Node) -> - nodetree_tree:get_node(Node). -get_nodes(Key, From) -> - nodetree_tree:get_nodes(Key, From). +-spec(get_node/1 :: + ( + NodeIdx :: nodeIdx()) + -> pubsubNode() | {'error', 'item-not-found'} + ). -get_nodes(Key) -> - nodetree_tree:get_nodes(Key). +get_node(NodeIdx) -> + nodetree_tree:get_node(NodeIdx). -get_parentnodes(Host, Node, _From) -> - case find_node(Host, Node) of + +-spec(get_nodes/2 :: + ( + Host :: hostPubsub(), + JID :: jidEntity()) + -> Nodes :: [] | [Node::pubsubNode()] + ). + +get_nodes(Host, JID) -> + nodetree_tree:get_nodes(Host, JID). + + +-spec(get_nodes/1 :: + ( + Host :: hostPubsub()) + -> Nodes :: [] | [Node::pubsubNode()] + ). + +get_nodes(Host) -> + nodetree_tree:get_nodes(Host). + + +-spec(get_parentnodes/3 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + JID :: jidEntity()) + -> ParentNodes :: [] | [ParentNode::pubsubNode()] + ). + +get_parentnodes(Host, NodeId, _JID) -> + case find_node(Host, NodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - #pubsub_node{parents = Parents} -> - Q = qlc:q([N || #pubsub_node{id = {NHost, NNode}} = N <- mnesia:table(pubsub_node), - Parent <- Parents, + #pubsub_node{parents = ParentNodeIds} -> + Q = qlc:q([Node || #pubsub_node{id = {NHost, NNodeId}} = Node + <- mnesia:table(pubsub_node), + ParentNodeId <- ParentNodeIds, Host == NHost, - Parent == NNode]), + ParentNodeId == NNodeId]), qlc:e(Q) end. -get_parentnodes_tree(Host, Node, _From) -> + +-spec(get_parentnodes_tree/3 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId(), + JID :: jidEntity()) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). + +get_parentnodes_tree(Host, NodeId, _JID) -> Pred = fun (Name, #pubsub_node{id = {_, NodeName}}) -> Name == NodeName end, Tr = fun (#pubsub_node{parents = Parents}) -> Parents end, - traversal_helper(Pred, Tr, Host, [Node]). + traversal_helper(Pred, Tr, Host, [NodeId]). -get_subnodes(Host, Node, _From) -> + +-spec(get_subnodes/3 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId(), + JID :: jidEntity()) + -> [] | [Node::pubsubNode()] | {'error', _} + ). + +get_subnodes(Host, Node, _JID) -> get_subnodes(Host, Node). -get_subnodes(Host, <<>>) -> - get_subnodes_helper(Host, <<>>); -get_subnodes(Host, Node) -> - case find_node(Host, Node) of + +-spec(get_subnodes/2 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId()) + -> [] | [Node::pubsubNode()] | {'error', _} + ). + +get_subnodes(ParentNodeHost, <<>>) -> + get_subnodes_helper(ParentNodeHost, <<>>); +get_subnodes(ParentNodeHost, ParentNodeId) -> + case find_node(ParentNodeHost, ParentNodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item-not-found')}; - _ -> get_subnodes_helper(Host, Node) + _ -> get_subnodes_helper(ParentNodeHost, ParentNodeId) end. -get_subnodes_helper(Host, Node) -> - Q = qlc:q([Record || #pubsub_node{id = {NHost, _}, - parents = Parents} = Record <- mnesia:table(pubsub_node), - Host == NHost, - lists:member(Node, Parents)]), + +-spec(get_subnodes_helper/2 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId()) + -> SubNodes :: [] | [Node::pubsubNode()] + ). + +get_subnodes_helper(ParentNodeHost, ParentNodeId) -> + Q = qlc:q([Node || #pubsub_node{id = {Host, _}, + parents = ParentNodeIds} = Node <- mnesia:table(pubsub_node), + ParentNodeHost == Host, + lists:member(ParentNodeId, ParentNodeIds)]), qlc:e(Q). -get_subnodes_tree(Host, Node, From) -> - Pred = fun (N, #pubsub_node{parents = Parents}) -> - lists:member(N, Parents) + +-spec(get_subnodes_tree/3 :: + ( + ParentNodeHost :: hostPubsub(), + ParentNodeId :: nodeId(), + JID :: jidEntity()) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). + +get_subnodes_tree(Host, ParentNodeId, JID) -> + Pred = fun(NodeId, #pubsub_node{parents = ParentNodeIds}) -> + lists:member(NodeId, ParentNodeIds) end, - Tr = fun (#pubsub_node{id = {_, N}}) -> [N] end, - traversal_helper(Pred, Tr, 1, Host, [Node], - [{0, [get_node(Host, Node, From)]}]). + Tr = fun (#pubsub_node{id = {_, NodeId}}) -> [NodeId] end, + traversal_helper(Pred, Tr, 1, Host, [ParentNodeId], + [{0, [get_node(Host, ParentNodeId, JID)]}]). %%==================================================================== %% Internal functions @@ -181,8 +318,15 @@ oid(Key, Name) -> {Key, Name}. %% Key = jlib:jid() | host() %% Node = string() -find_node(Key, Node) -> - case mnesia:read(pubsub_node, oid(Key, Node), read) of +-spec(find_node/2 :: + ( + Host :: hostPubsub(), + NodeId :: nodeId()) + -> pubsubNode() | 'false' + ). + +find_node(Host, NodeId) -> + case mnesia:read({pubsub_node, {Host, NodeId}}) of [] -> false; [Node] -> Node end. @@ -190,53 +334,109 @@ find_node(Key, Node) -> %% Key = jlib:jid() | host() %% Default = term() %% Options = [{Key = atom(), Value = term()}] +-spec(find_opt/3 :: + ( + Key :: atom(), + Default :: term(), + Options :: [Option::nodeOption()]) + -> Value::term() + ). + find_opt(Key, Default, Options) -> case lists:keysearch(Key, 1, Options) of - {value, {Key, Val}} -> Val; + {value, {Key, Value}} -> Value; _ -> Default end. -traversal_helper(Pred, Tr, Host, Nodes) -> - traversal_helper(Pred, Tr, 0, Host, Nodes, []). + +-spec(traversal_helper/4 :: + ( + Pred :: fun(), + Tr :: fun(), + ParentNodeHost :: hostPubsub(), + ParentNodeIds :: [] | [ParentNodeId::nodeId()]) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). + +traversal_helper(Pred, Tr, ParentNodeHost, ParentNodeIds) -> + traversal_helper(Pred, Tr, 0, ParentNodeHost, ParentNodeIds, []). + + +-spec(traversal_helper/6 :: + ( + Pred :: fun(), + Tr :: fun(), + Depth :: integer(), + ParentNodeHost :: hostPubsub(), + ParentNodeIds :: [] | [ParentNodeId::nodeId()], + Acc :: [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}]) + -> [] | [{Depth::integer(), Nodes :: [] | [Node::pubsubNode()]}] + ). traversal_helper(_Pred, _Tr, _Depth, _Host, [], Acc) -> Acc; -traversal_helper(Pred, Tr, Depth, Host, Nodes, Acc) -> - Q = qlc:q([Record || #pubsub_node{id = {NHost, _}} = Record <- mnesia:table(pubsub_node), - Node <- Nodes, - Host == NHost, - Pred(Node, Node)]), +traversal_helper(Pred, Tr, Depth, ParentNodeHost, ParentNodeIds, Acc) -> + Q = qlc:q([Node || #pubsub_node{id = {Host, _}} = Node <- mnesia:table(pubsub_node), + ParentNodeId <- ParentNodeIds, + ParentNodeHost == Host, + Pred(ParentNodeId, Node)]), Nodes = qlc:e(Q), - Names = lists:flatmap(Tr, Nodes), - traversal_helper(Pred, Tr, Depth + 1, Host, Names, [{Depth, Nodes} | Acc]). + Ids = lists:flatmap(Tr, Nodes), + traversal_helper(Pred, Tr, Depth + 1, ParentNodeHost, Ids, [{Depth, Nodes} | Acc]). -remove_config_parent(Node, Options) -> - remove_config_parent(Node, Options, []). -remove_config_parent(_Node, [], Acc) -> +-spec(remove_config_parent/2 :: + ( + NodeId :: nodeId(), + Options :: [Option::nodeOption()]) + -> [Option::nodeOption()] + ). + +remove_config_parent(NodeId, Options) -> + remove_config_parent(NodeId, Options, []). + + +-spec(remove_config_parent/3 :: + ( + NodeId :: nodeId(), + Options :: [] | [Option::nodeOption()], + Acc :: [Option::nodeOption()]) + -> [Option::nodeOption()] + ). + +remove_config_parent(_NodeId, [], Acc) -> lists:reverse(Acc); -remove_config_parent(Node, [{collection, Parents} | T], Acc) -> - remove_config_parent(Node, T, - [{collection, lists:delete(Node, Parents)} | Acc]); -remove_config_parent(Node, [H | T], Acc) -> - remove_config_parent(Node, T, [H | Acc]). +remove_config_parent(NodeId, [{'collection', ParentNodeIds} | Options], Acc) -> + remove_config_parent(NodeId, Options, + [{'collection', lists:delete(NodeId, ParentNodeIds)} | Acc]); +remove_config_parent(NodeId, [Option | Options], Acc) -> + remove_config_parent(NodeId, Options, [Option | Acc]). -validate_parentage(_Key, _Owners, []) -> + +-spec(validate_parentage/3 :: + ( + Host :: hostPubsub(), + Owners :: [Owner::bareUsr()], + ParentNodeIds :: [] | [ParentNodeId::nodeId()] | [ParentNodeId :: nodeId() | []]) + -> 'true' | {'error', _} + ). + +validate_parentage(_Host, _Owners, []) -> true; -validate_parentage(Key, Owners, [[] | T]) -> - validate_parentage(Key, Owners, T); -validate_parentage(Key, Owners, [<<>> | T]) -> - validate_parentage(Key, Owners, T); -validate_parentage(Key, Owners, [ParentId | T]) -> - case find_node(Key, ParentId) of +validate_parentage(Host, Owners, [[] | ParentNodeIds]) -> + validate_parentage(Host, Owners, ParentNodeIds); +validate_parentage(Host, Owners, [<<>> | ParentNodeIds]) -> + validate_parentage(Host, Owners, ParentNodeIds); +validate_parentage(Host, Owners, [ParentNodeId | ParentNodeIds]) -> + case find_node(Host, ParentNodeId) of false -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'item_not_found')}; - #pubsub_node{owners = POwners, options = POptions} -> - NodeType = find_opt(node_type, ?DEFAULT_NODETYPE, POptions), - MutualOwners = [O || O <- Owners, PO <- POwners, - O == PO], + #pubsub_node{owners = ParentNodeOwners, options = Options} -> + NodeType = find_opt('node_type', ?DEFAULT_NODETYPE, Options), + MutualOwners = [Owner || Owner <- Owners, ParentNodeOwner <- ParentNodeOwners, + Owner == ParentNodeOwner], case {MutualOwners, NodeType} of {[], _} -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'forbidden')}; - {_, collection} -> validate_parentage(Key, Owners, T); + {_, 'collection'} -> validate_parentage(Host, Owners, ParentNodeIds); {_, _} -> {error, exmpp_stanza:error(?NS_JABBER_CLIENT, 'not-allowed')} end end. @@ -244,6 +444,12 @@ validate_parentage(Key, Owners, [ParentId | T]) -> %% @spec (Host) -> jid() %% Host = host() %% @doc

    Generate pubsub service JID.

    +-spec(service_jid/1 :: + ( + Host :: hostPubsub()) + -> ServiceJID :: jidContact() | jidComponent() %% should only return jidContact() + ). + service_jid(Host) -> case Host of {U,S,_} -> exmpp_jid:make(U, S); diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index 5d0f1142b..263b89d66 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -157,7 +157,7 @@ get_node(Host, NodeId) -> -spec(get_node/1 :: ( NodeIdx :: nodeIdx()) - -> pubsubNode() | {error, 'item-not-found'} | any() + -> pubsubNode() | {'error', 'item-not-found'} ). get_node(NodeIdx) -> From 8647ca5f0ba2215347adbfdbbd54eedda2c88e7c Mon Sep 17 00:00:00 2001 From: Evgeniy Khramtsov Date: Tue, 5 Oct 2010 21:31:05 +1000 Subject: [PATCH 29/34] use one_queue IQ discipline by default --- src/mod_vcard_ldap.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/mod_vcard_ldap.erl b/src/mod_vcard_ldap.erl index 3487ad1fc..4c08098c7 100644 --- a/src/mod_vcard_ldap.erl +++ b/src/mod_vcard_ldap.erl @@ -172,7 +172,7 @@ start_link(Host, Opts) -> init([Host, Opts]) -> HostB = list_to_binary(Host), State = parse_options(Host, Opts), - IQDisc = gen_mod:get_opt(iqdisc, Opts, parallel), + IQDisc = gen_mod:get_opt(iqdisc, Opts, one_queue), gen_iq_handler:add_iq_handler(ejabberd_local, HostB, ?NS_VCARD, ?MODULE, process_local_iq, IQDisc), gen_iq_handler:add_iq_handler(ejabberd_sm, HostB, ?NS_VCARD, From 645ddcb7492a5424c353279c8b7c645a0fedef92 Mon Sep 17 00:00:00 2001 From: Badlop Date: Tue, 5 Oct 2010 13:47:07 +0200 Subject: [PATCH 30/34] Fix unused variables --- src/ejabberd_sm.erl | 1 - src/mod_vcard_odbc.erl | 2 -- 2 files changed, 3 deletions(-) diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl index d9f2ac34d..2024b03f0 100644 --- a/src/ejabberd_sm.erl +++ b/src/ejabberd_sm.erl @@ -211,7 +211,6 @@ get_user_info(User, Server, Resource) end, if is_list(Ss), Ss /= [] -> Session = lists:max(Ss), - N = node(element(2, Session#session.sid)), Conn = proplists:get_value(conn, Session#session.info), IP = proplists:get_value(ip, Session#session.info), Priority = Session#session.priority, %% integer() diff --git a/src/mod_vcard_odbc.erl b/src/mod_vcard_odbc.erl index fc7d95162..7682646dd 100644 --- a/src/mod_vcard_odbc.erl +++ b/src/mod_vcard_odbc.erl @@ -464,8 +464,6 @@ record_to_item(LServer, {Username, FN, Family, Given, Middle, search(LServer, Data) -> MatchSpec = make_matchspec(LServer, Data), - AllowReturnAll = gen_mod:get_module_opt(LServer, ?MODULE, - allow_return_all, false), Limit = case gen_mod:get_module_opt(LServer, ?MODULE, matches, ?JUD_MATCHES) of infinity -> From 6c74c670699b186b70e73e1e154c1e82ab3400a4 Mon Sep 17 00:00:00 2001 From: Badlop Date: Wed, 6 Oct 2010 13:05:21 +0200 Subject: [PATCH 31/34] Fix Captcha library and MUC use for exmpp --- src/ejabberd_captcha.erl | 49 ++++++++++++++++++++++++------------ src/mod_muc/mod_muc_room.erl | 4 +-- 2 files changed, 35 insertions(+), 18 deletions(-) diff --git a/src/ejabberd_captcha.erl b/src/ejabberd_captcha.erl index 6a063fc34..e9a4eff5f 100644 --- a/src/ejabberd_captcha.erl +++ b/src/ejabberd_captcha.erl @@ -24,6 +24,22 @@ %%% %%%------------------------------------------------------------------- +%%% Database schema (version / storage / table) +%%% +%%% 2.1.x / mnesia / captcha +%%% id = string() +%%% pid = pid() +%%% key = string() +%%% tref = any() +%%% args = any() +%%% +%%% 3.0.0-alpha / ets / captcha +%%% id = string() +%%% pid = pid() +%%% key = string() +%%% tref = any() +%%% args = any() + -module(ejabberd_captcha). -behaviour(gen_server). @@ -63,7 +79,7 @@ } ]}). --define(CAPTCHA_TEXT(Lang), translate:translate(Lang, "Enter the text you see")). +-define(CAPTCHA_TEXT(Lang), list_to_binary(translate:translate(Lang, "Enter the text you see"))). -define(CAPTCHA_LIFETIME, 120000). % two minutes -define(RPC_TIMEOUT, 5000). @@ -84,7 +100,7 @@ create_captcha(SID, From, To, Lang, Args) when is_binary(Lang), is_binary(SID) -> case create_image() of {ok, Type, Key, Image} -> - Id = list_to_binary(randoms:get_string() ++ "-" ++ ejabberd_cluster:node_id()), + Id = randoms:get_string() ++ "-" ++ ejabberd_cluster:node_id(), B64Image = list_to_binary(jlib:encode_base64(binary_to_list(Image))), JID = exmpp_jid:to_list(From), CID = list_to_binary(["sha1+", sha:sha(Image), "@bob.xmpp.org"]), @@ -138,9 +154,9 @@ create_captcha(SID, From, To, Lang, Args) } ], children = [ - ?VFIELD(<<"hidden">>, <<"FORM_TYPE">>, #xmlcdata{cdata = ?NS_CAPTCHA}), + ?VFIELD(<<"hidden">>, <<"FORM_TYPE">>, #xmlcdata{cdata = ?NS_CAPTCHA_b}), ?VFIELD(<<"hidden">>, <<"from">>, #xmlcdata{cdata = exmpp_jid:to_binary(To)}), - ?VFIELD(<<"hidden">>, <<"challenge">>, #xmlcdata{cdata = Id}), + ?VFIELD(<<"hidden">>, <<"challenge">>, #xmlcdata{cdata = list_to_binary(Id)}), ?VFIELD(<<"hidden">>, <<"sid">>, #xmlcdata{cdata = SID}), #xmlel{ name = 'field', @@ -186,7 +202,7 @@ create_captcha(SID, From, To, Lang, Args) name = 'body', children = [ #xmlcdata{ - cdata = BodyString + cdata = list_to_binary(BodyString) } ] }, @@ -268,15 +284,15 @@ build_captcha_html(Id, Lang) -> attrs = [ #xmlattr{ name = 'type', - value = "text" + value = <<"text">> }, #xmlattr{ name = 'name', - value = "key" + value = <<"key">> }, #xmlattr{ name = 'size', - value = "10" + value = <<"10">> } ] }, @@ -304,11 +320,11 @@ build_captcha_html(Id, Lang) -> }, #xmlattr{ name = 'name', - value = "captcha" + value = <<"captcha">> }, #xmlattr{ name = 'method', - value = "POST" + value = <<"POST">> } ], children = [ @@ -330,15 +346,15 @@ build_captcha_html(Id, Lang) -> attrs = [ #xmlattr{ name = 'type', - value = "submit" + value = <<"submit">> }, #xmlattr{ name = 'name', - value = "enter" + value = <<"enter">> }, #xmlattr{ name = 'value', - value = "OK" + value = <<"OK">> } ] } @@ -408,7 +424,7 @@ process(_Handlers, #request{method='GET', lang=Lang, path=[_, Id]}) -> attrs = [ #xmlattr{ name = 'align', - value = "center" + value = <<"center">> } ], children = [FormEl] @@ -508,12 +524,12 @@ code_change(_OldVsn, State, _Extra) -> %%-------------------------------------------------------------------- create_image() -> %% Six numbers from 1 to 9. - Key = list_to_binary(string:substr(randoms:get_string(), 1, 6)), + Key = string:substr(randoms:get_string(), 1, 6), create_image(Key). create_image(Key) -> FileName = get_prog_name(), - Cmd = lists:flatten(io_lib:format("~s ~p", [FileName, Key])), + Cmd = lists:flatten(io_lib:format("~s ~s", [FileName, Key])), case cmd(Cmd) of {ok, <<16#89, $P, $N, $G, $\r, $\n, 16#1a, $\n, _/binary>> = Img} -> {ok, <<"image/png">>, Key, Img}; @@ -547,6 +563,7 @@ get_prog_name() -> throw({error, option_not_configured_captcha_cmd}) end. +%% @doc (Str::string()) -> string() get_url(Str) -> case ejabberd_config:get_local_option(captcha_host) of Host when is_list(Host) -> diff --git a/src/mod_muc/mod_muc_room.erl b/src/mod_muc/mod_muc_room.erl index 157073389..78bbd1921 100644 --- a/src/mod_muc/mod_muc_room.erl +++ b/src/mod_muc/mod_muc_room.erl @@ -1684,7 +1684,7 @@ add_new_user(From, Nick, Packet, StateData) -> StateData; captcha_required -> SID = case exmpp_stanza:get_id(Packet) of - undefined -> ""; + undefined -> <<"">>; SID1 -> SID1 end, RoomJID = StateData#state.jid, @@ -1693,7 +1693,7 @@ add_new_user(From, Nick, Packet, StateData) -> SID, RoomJID, To, Lang, From) of {ok, ID, CaptchaEls} -> MsgPkt = #xmlel{name = 'message', - attrs = [#xmlattr{name = 'id', value = ID}], + attrs = [#xmlattr{name = 'id', value = list_to_binary(ID)}], children = CaptchaEls}, Robots = ?DICT:store(From, {Nick, Packet}, StateData#state.robots), From f4f2f46f5062e142f895b905eb90ae3f67f29b1a Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 7 Oct 2010 00:14:28 +0200 Subject: [PATCH 32/34] Dirty fixes for Dialyzer warnings in mod_privacy --- src/mod_privacy.erl | 81 ++++++++++++++++++++++++--------------------- 1 file changed, 44 insertions(+), 37 deletions(-) diff --git a/src/mod_privacy.erl b/src/mod_privacy.erl index 1b448a2f8..1e95553b9 100644 --- a/src/mod_privacy.erl +++ b/src/mod_privacy.erl @@ -157,8 +157,8 @@ start(Host, Opts) -> {match_presence_out, atom} ]}]), update_tables(Host, Backend), - gen_storage:add_table_index(Host, privacy_list, name), - gen_storage:add_table_index(Host, privacy_list_data, name), + gen_storage:add_table_index(HostB, privacy_list, name), + gen_storage:add_table_index(HostB, privacy_list_data, name), ejabberd_hooks:add(privacy_iq_get, HostB, ?MODULE, process_iq_get, 50), ejabberd_hooks:add(privacy_iq_set, HostB, @@ -215,20 +215,21 @@ process_iq_get(_, From, _To, #iq{payload = SubEl}, process_lists_get(LUser, LServer, Active) -> + LServerB = list_to_binary(LServer), F = fun() -> Default = - case gen_storage:read(LServer, {privacy_default_list, {LUser, LServer}}) of + case gen_storage:read(LServerB, {privacy_default_list, {LUser, LServer}}) of [#privacy_default_list{name = Name}] -> Name; _ -> none end, Lists = [List#privacy_list.name - || List <- gen_storage:read(LServer, {privacy_list, {LUser, LServer}})], + || List <- gen_storage:read(LServerB, {privacy_list, {LUser, LServer}})], {Default, Lists} end, - case gen_storage:transaction(LServer, privacy_list, F) of - {'EXIT', _Reason} -> + case gen_storage:transaction(LServerB, privacy_list, F) of + {aborted, _Reason} -> {error, 'internal-server-error'}; {atomic, {Default, Lists}} -> case Lists of @@ -258,19 +259,20 @@ process_list_get(_LUser, _LServer, false) -> {error, 'bad-request'}; process_list_get(LUser, LServer, Name) -> + LServerB = list_to_binary(LServer), F = fun() -> - case gen_storage:select(LServer, privacy_list, + case gen_storage:select(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [] -> none; [#privacy_list{}] -> - gen_storage:select(LServer, privacy_list_data, + gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {aborted, _Reason} -> {error, 'internal-server-error'}; {atomic, none} -> @@ -375,10 +377,11 @@ process_iq_set(_, From, _To, #iq{payload = SubEl}) -> process_default_set(LUser, LServer, false) -> + LServerB = list_to_binary(LServer), F = fun() -> - gen_storage:delete(LServer, {privacy_default_list, {LUser, LServer}}) + gen_storage:delete(LServerB, {privacy_default_list, {LUser, LServer}}) end, - case gen_storage:transaction(LServer, privacy_default_list, F) of + case gen_storage:transaction(LServerB, privacy_default_list, F) of {atomic, _} -> {result, []}; _ -> @@ -386,20 +389,21 @@ process_default_set(LUser, LServer, false) -> end; process_default_set(LUser, LServer, Name) -> + LServerB = list_to_binary(LServer), F = fun() -> - case gen_storage:select(LServer, privacy_list, + case gen_storage:select(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [] -> {error, 'item-not-found'}; [#privacy_list{}] -> - gen_storage:write(LServer, + gen_storage:write(LServerB, #privacy_default_list{user_host = {LUser, LServer}, name = Name}), {result, []} end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, {error, _} = Error} -> Error; {atomic, {result, _} = Res} -> @@ -413,12 +417,13 @@ process_active_set(_LUser, _LServer, false) -> {result, [], #userlist{}}; process_active_set(LUser, LServer, Name) -> + LServerB = list_to_binary(LServer), F = fun() -> - case gen_storage:select(LServer, privacy_list, + case gen_storage:select(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]) of [#privacy_list{}] -> - Data = gen_storage:select(LServer, privacy_list_data, + Data = gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), List = list_data_to_items(Data), @@ -430,7 +435,7 @@ process_active_set(LUser, LServer, Name) -> {error, 'item-not-found'} end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, Res} -> Res; _ -> @@ -443,26 +448,27 @@ process_list_set(_LUser, _LServer, false, _Els) -> {error, 'bad-request'}; process_list_set(LUser, LServer, Name, Els) -> + LServerB = list_to_binary(LServer), case parse_items(Els) of false -> {error, 'bad-request'}; remove -> F = fun() -> - case gen_storage:read(LServer, + case gen_storage:read(LServerB, {privacy_default_list, {LUser, LServer}}) of [#privacy_default_list{name = Default}] when Name == Default -> {error, 'conflict'}; _ -> - gen_storage:delete_where(LServer, privacy_list, + gen_storage:delete_where(LServerB, privacy_list, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), - gen_storage:delete_where(LServer, privacy_list_data, + gen_storage:delete_where(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), {result, []} end end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, {error, _} = Error} -> Error; {atomic, {result, _} = Res} -> @@ -480,24 +486,24 @@ process_list_set(LUser, LServer, Name, Els) -> List -> F = fun() -> OldData = - gen_storage:select(LServer, privacy_list_data, + gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Name}]), lists:foreach( fun(Data1) -> - gen_storage:delete_object(LServer, Data1) + gen_storage:delete_object(LServerB, Data1) end, OldData), - gen_storage:write(LServer, #privacy_list{user_host = {LUser, LServer}, + gen_storage:write(LServerB, #privacy_list{user_host = {LUser, LServer}, name = Name}), NewData = list_items_to_data(LUser, LServer, Name, List), lists:foreach( fun(Data1) -> - gen_storage:write(LServer, Data1) + gen_storage:write(LServerB, Data1) end, NewData), {result, []} end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, {error, _} = Error} -> Error; {atomic, {result, _} = Res} -> @@ -650,17 +656,17 @@ is_list_needdb(Items) -> end end, Items). -get_user_list(_, User, Server) - when is_binary(User), is_binary(Server) -> +get_user_list(_, User, LServerB) + when is_binary(User), is_binary(LServerB) -> LUser = binary_to_list(User), - LServer = binary_to_list(Server), + LServer = binary_to_list(LServerB), F = fun() -> - case gen_storage:read(LServer, + case gen_storage:read(LServerB, {privacy_default_list, {LUser, LServer}}) of [] -> #userlist{}; [#privacy_default_list{name = Default}] -> - Data = gen_storage:select(LServer, privacy_list_data, + Data = gen_storage:select(LServerB, privacy_list_data, [{'=', user_host, {LUser, LServer}}, {'=', name, Default}]), List = list_data_to_items(Data), @@ -670,7 +676,7 @@ get_user_list(_, User, Server) list = List} end end, - {atomic, Res} = gen_storage:transaction(LServer, privacy_default_list, F), + {atomic, Res} = gen_storage:transaction(LServerB, privacy_default_list, F), Res. @@ -771,9 +777,9 @@ is_ptype_match(Item, PType) -> %% TODO: Investigate this: sometimes Value has binaries, other times has strings is_type_match(jid, Value, JID, _Subscription, _Groups) -> {User, Server, Resource} = exmpp_jid:to_lower(exmpp_jid:parse(Value)), - ((User == undefined) orelse (User == []) orelse (User == exmpp_jid:prep_node(JID))) - andalso ((Server == undefined) orelse (Server == []) orelse (Server == exmpp_jid:prep_domain(JID))) - andalso ((Resource == undefined) orelse (Resource == []) orelse (Resource == exmpp_jid:prep_resource(JID))); + ((User == undefined) orelse (User == exmpp_jid:prep_node(JID))) + andalso ((Server == undefined) orelse (Server == exmpp_jid:prep_domain(JID))) + andalso ((Resource == undefined) orelse (Resource == exmpp_jid:prep_resource(JID))); is_type_match(subscription, Value, _JID, Subscription, _Groups) -> Value == Subscription; is_type_match(group, Value, _JID, _Subscription, Groups) -> @@ -783,10 +789,11 @@ is_type_match(group, Value, _JID, _Subscription, Groups) -> remove_user(User, Server) -> LUser = exmpp_stringprep:nodeprep(User), LServer = exmpp_stringprep:nameprep(Server), + LServerB = list_to_binary(LServer), F = fun() -> - gen_storage:delete(LServer, {privacy_list, {LUser, LServer}}) + gen_storage:delete(LServerB, {privacy_list, {LUser, LServer}}) end, - case gen_storage:transaction(LServer, privacy_list, F) of + case gen_storage:transaction(LServerB, privacy_list, F) of {atomic, _} -> {result, []}; _ -> From 404b9a4a115ef89ab8882b71914388a15501a5b8 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 7 Oct 2010 00:16:24 +0200 Subject: [PATCH 33/34] Minor fix in http_bind detected by Dialyzer --- src/web/ejabberd_http_bind.erl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/web/ejabberd_http_bind.erl b/src/web/ejabberd_http_bind.erl index a9bdbdd39..52e38d76d 100644 --- a/src/web/ejabberd_http_bind.erl +++ b/src/web/ejabberd_http_bind.erl @@ -59,7 +59,7 @@ rid = none, key, socket, - output = "", + output = [], input = queue:new(), waiting_input = false, shaper_state, @@ -1157,7 +1157,7 @@ send_outpacket(#http_bind{pid = FsmRef}, OutPacket) -> case SEls of [{xmlstreamelement, #xmlel{name = 'features', - declared_ns = [{undefined, 'stream'}], + declared_ns = [{undefined, "stream"}], attrs = StreamAttribs, children = StreamEls}} | % {xmlelement, From 82a8dc7b3ab20aafcfe5e94a219f05af4921b6c2 Mon Sep 17 00:00:00 2001 From: Badlop Date: Thu, 7 Oct 2010 17:38:18 +0200 Subject: [PATCH 34/34] Cosmetic code changes to support emacs indentation --- src/cache_tab.erl | 4 +- src/ejabberd_admin.erl | 3 +- src/ejabberd_auth_anonymous.erl | 4 +- src/ejabberd_auth_ldap.erl | 8 +- src/ejabberd_c2s.erl | 8 +- src/ejabberd_captcha.erl | 132 +++++++++----------------- src/ejabberd_check.erl | 4 +- src/ejabberd_ctl.erl | 3 +- src/ejabberd_local.erl | 5 +- src/ejabberd_receiver.erl | 20 ++-- src/ejabberd_router.erl | 8 +- src/ejabberd_s2s.erl | 5 +- src/ejabberd_s2s_in.erl | 8 +- src/ejabberd_s2s_out.erl | 21 ++-- src/ejabberd_sm.erl | 5 +- src/mod_muc/mod_muc_room.erl | 10 +- src/mod_pubsub/mod_pubsub.erl | 12 +-- src/mod_pubsub/nodetree_tree.erl | 15 ++- src/mod_pubsub/nodetree_tree_odbc.erl | 9 +- src/mod_vcard.erl | 5 +- src/mod_vcard_ldap.erl | 5 +- src/web/ejabberd_http_poll.erl | 4 +- src/web/ejabberd_web_admin.erl | 4 +- 23 files changed, 120 insertions(+), 182 deletions(-) diff --git a/src/cache_tab.erl b/src/cache_tab.erl index b05e78b0e..6140453ca 100644 --- a/src/cache_tab.erl +++ b/src/cache_tab.erl @@ -68,8 +68,8 @@ %% API %%==================================================================== start_link(Proc, Tab, Opts, Owner) -> - ?GEN_SERVER:start_link( - {local, Proc}, ?MODULE, [Tab, Opts, get_proc_num(), Owner], []). + ?GEN_SERVER:start_link({local, Proc}, ?MODULE, + [Tab, Opts, get_proc_num(), Owner], []). new(Tab, Opts) -> Res = lists:flatmap( diff --git a/src/ejabberd_admin.erl b/src/ejabberd_admin.erl index c563dd7bd..33728e877 100644 --- a/src/ejabberd_admin.erl +++ b/src/ejabberd_admin.erl @@ -261,8 +261,7 @@ get_sasl_error_logger_type () -> stop_kindly(DelaySeconds, AnnouncementText) -> Subject = io_lib:format("Server stop in ~p seconds!", [DelaySeconds]), WaitingDesc = io_lib:format("Waiting ~p seconds", [DelaySeconds]), - Steps = [ - {"Stopping ejabberd port listeners", + Steps = [{"Stopping ejabberd port listeners", ejabberd_listener, stop_listeners, []}, {"Sending announcement to connected users", mod_announce, send_announcement_to_all, diff --git a/src/ejabberd_auth_anonymous.erl b/src/ejabberd_auth_anonymous.erl index 1f5041f46..bd69964a4 100644 --- a/src/ejabberd_auth_anonymous.erl +++ b/src/ejabberd_auth_anonymous.erl @@ -140,8 +140,8 @@ anonymous_protocol(Host) when is_list(Host) -> %% defaults to false allow_multiple_connections(Host) when is_list(Host) -> - ejabberd_config:get_local_option( - {allow_multiple_connections, Host}) =:= true. + ejabberd_config:get_local_option({allow_multiple_connections, Host}) + =:= true. %% @spec (User, Server) -> bool() %% User = string() diff --git a/src/ejabberd_auth_ldap.erl b/src/ejabberd_auth_ldap.erl index 54419374e..fbdebeb16 100644 --- a/src/ejabberd_auth_ldap.erl +++ b/src/ejabberd_auth_ldap.erl @@ -440,10 +440,10 @@ is_valid_dn(DN, Server, Attrs, State) -> end ++ [{"%d", State#state.host}, {"%D", DN}], case eldap_filter:parse(State#state.dn_filter, SubstValues) of {ok, EldapFilter} -> - case eldap_pool:search(State#state.eldap_id, [ - {base, State#state.base}, - {filter, EldapFilter}, - {attributes, ["dn"]}]) of + case eldap_pool:search(State#state.eldap_id, + [{base, State#state.base}, + {filter, EldapFilter}, + {attributes, ["dn"]}]) of #eldap_search_result{entries = [_|_]} -> DN; _ -> diff --git a/src/ejabberd_c2s.erl b/src/ejabberd_c2s.erl index c21263d10..d18b43626 100644 --- a/src/ejabberd_c2s.erl +++ b/src/ejabberd_c2s.erl @@ -667,8 +667,8 @@ wait_for_feature_request({xmlstreamelement, #xmlel{ns = NS, name = Name} = El}, TLSEnabled == false, SockMod == gen_tcp -> ServerString = binary_to_list(StateData#state.server), - TLSOpts = case ejabberd_config:get_local_option( - {domain_certfile, ServerString}) of + TLSOpts = case ejabberd_config:get_local_option + ({domain_certfile, ServerString}) of undefined -> StateData#state.tls_options; CertFile -> @@ -1606,8 +1606,8 @@ get_conn_type(StateData) -> if is_pid(StateData#state.socket) -> unknown; true -> - case ejabberd_zlib:get_sockmod( - (StateData#state.socket)#socket_state.socket) of + case ejabberd_zlib:get_sockmod + ((StateData#state.socket)#socket_state.socket) of gen_tcp -> c2s_compressed; tls -> c2s_compressed_tls end diff --git a/src/ejabberd_captcha.erl b/src/ejabberd_captcha.erl index e9a4eff5f..64bb74b3a 100644 --- a/src/ejabberd_captcha.erl +++ b/src/ejabberd_captcha.erl @@ -63,18 +63,15 @@ -define(VFIELD(Type, Var, Value), #xmlel{name = 'field', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = Type }, - #xmlattr{ - name = 'var', + #xmlattr{name = 'var', value = Var } ], children = [ - #xmlel{ - name = 'value', + #xmlel{name = 'value', children = [Value] } ]}). @@ -113,16 +110,13 @@ create_captcha(SID, From, To, Lang, Args) name = 'data', ns = ?NS_BOB, attrs = [ - #xmlattr{ - name = 'cid', + #xmlattr{name = 'cid', value = CID }, - #xmlattr{ - name = 'max-age', + #xmlattr{name = 'max-age', value = <<"0">> }, - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = Type } ], @@ -144,12 +138,10 @@ create_captcha(SID, From, To, Lang, Args) name = 'captcha', ns = ?NS_CAPTCHA, children = [ - #xmlel{ - name = 'x', + #xmlel{name = 'x', ns = ?NS_DATA_FORMS_s, attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = <<"form">> } ], @@ -158,28 +150,22 @@ create_captcha(SID, From, To, Lang, Args) ?VFIELD(<<"hidden">>, <<"from">>, #xmlcdata{cdata = exmpp_jid:to_binary(To)}), ?VFIELD(<<"hidden">>, <<"challenge">>, #xmlcdata{cdata = list_to_binary(Id)}), ?VFIELD(<<"hidden">>, <<"sid">>, #xmlcdata{cdata = SID}), - #xmlel{ - name = 'field', + #xmlel{name = 'field', attrs = [ - #xmlattr{ - name = 'var', + #xmlattr{name = 'var', value = <<"ocr">> }, - #xmlattr{ - name = 'label', + #xmlattr{name = 'label', value = ?CAPTCHA_TEXT(Lang) } ], children = [ - #xmlel{ - name = 'media', + #xmlel{name = 'media', ns = ?NS_DATA_FORMS_MEDIA_s, children = [ - #xmlel{ - name = 'uri', + #xmlel{name = 'uri', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = Type } ], @@ -198,24 +184,19 @@ create_captcha(SID, From, To, Lang, Args) BodyString1 = translate:translate(Lang, "Your messages to ~s are being blocked. To unblock them, visit ~s"), BodyString = io_lib:format(BodyString1, [JID, get_url(Id)]), Body = - #xmlel{ - name = 'body', + #xmlel{name = 'body', children = [ - #xmlcdata{ - cdata = list_to_binary(BodyString) + #xmlcdata{cdata = list_to_binary(BodyString) } ] }, OOB = - #xmlel{ - name = 'x', + #xmlel{name = 'x', ns = ?NS_OOBD_X_s, children = [ - #xmlel{ - name = 'url', + #xmlel{name = 'url', children = [ - #xmlcdata{ - cdata = list_to_binary(get_url(Id))} + #xmlcdata{cdata = list_to_binary(get_url(Id))} ] } ] @@ -243,11 +224,9 @@ build_captcha_html(Id, Lang) -> {ok, _} -> %ImgEl = {xmlelement, "img", [{"src", get_url(Id ++ "/image")}], []}, ImgEl = - #xmlel{ - name = 'img', + #xmlel{name = 'img', attrs = [ - #xmlattr{ - name = 'src', + #xmlattr{name = 'src', value = list_to_binary(get_url(Id ++ "/image")) } ] @@ -258,19 +237,15 @@ build_captcha_html(Id, Lang) -> % {"name", "id"}, % {"value", Id}], []}, IdEl = - #xmlel{ - name = 'input', + #xmlel{name = 'input', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = <<"hidden">> }, - #xmlattr{ - name = 'name', + #xmlattr{name = 'name', value = <<"id">> }, - #xmlattr{ - name = 'value', + #xmlattr{name = 'value', value = list_to_binary(Id) } ] @@ -279,19 +254,15 @@ build_captcha_html(Id, Lang) -> % {"name", "key"}, % {"size", "10"}], []}, KeyEl = - #xmlel{ - name = 'input', + #xmlel{name = 'input', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = <<"text">> }, - #xmlattr{ - name = 'name', + #xmlattr{name = 'name', value = <<"key">> }, - #xmlattr{ - name = 'size', + #xmlattr{name = 'size', value = <<"10">> } ] @@ -311,49 +282,38 @@ build_captcha_html(Id, Lang) -> % {"value", "OK"}], []} % ]}, FormEl = - #xmlel{ - name = 'form', + #xmlel{name = 'form', attrs = [ - #xmlattr{ - name = 'action', + #xmlattr{name = 'action', value = list_to_binary(get_url(Id)) }, - #xmlattr{ - name = 'name', + #xmlattr{name = 'name', value = <<"captcha">> }, - #xmlattr{ - name = 'method', + #xmlattr{name = 'method', value = <<"POST">> } ], children = [ ImgEl, - #xmlel{ - name = 'br' + #xmlel{name = 'br' }, TextEl, - #xmlel{ - name = 'br' + #xmlel{name = 'br' }, IdEl, KeyEl, - #xmlel{ - name = 'br' + #xmlel{name = 'br' }, - #xmlel{ - name = 'input', + #xmlel{name = 'input', attrs = [ - #xmlattr{ - name = 'type', + #xmlattr{name = 'type', value = <<"submit">> }, - #xmlattr{ - name = 'name', + #xmlattr{name = 'name', value = <<"enter">> }, - #xmlattr{ - name = 'value', + #xmlattr{name = 'value', value = <<"OK">> } ] @@ -419,11 +379,9 @@ process(_Handlers, #request{method='GET', lang=Lang, path=[_, Id]}) -> Form = %{xmlelement, "div", [{"align", "center"}], %[FormEl]}, - #xmlel{ - name = 'div', + #xmlel{name = 'div', attrs = [ - #xmlattr{ - name = 'align', + #xmlattr{name = 'align', value = <<"center">> } ], @@ -460,11 +418,9 @@ process(_Handlers, #request{method='POST', q=Q, lang=Lang, path=[_, Id]}) -> % [{xmlcdata, % translate:translate(Lang, "The captcha is valid.") % }]}, - #xmlel{ - name = 'p', + #xmlel{name = 'p', children = [ - #xmlcdata{ - cdata = translate:translate(Lang, "The captcha is valid.")} + #xmlcdata{cdata = translate:translate(Lang, "The captcha is valid.")} ] }, ejabberd_web:make_xhtml([Form]); diff --git a/src/ejabberd_check.erl b/src/ejabberd_check.erl index 8b315861a..637009980 100644 --- a/src/ejabberd_check.erl +++ b/src/ejabberd_check.erl @@ -88,8 +88,8 @@ get_db_used() -> DBs = lists:foldr( fun([Domain, DB], Acc) -> case check_odbc_option( - ejabberd_config:get_local_option( - {auth_method, Domain})) of + ejabberd_config:get_local_option + ({auth_method, Domain})) of true -> [get_db_type(DB)|Acc]; _ -> Acc end diff --git a/src/ejabberd_ctl.erl b/src/ejabberd_ctl.erl index 528b50aa5..e9bca6b21 100644 --- a/src/ejabberd_ctl.erl +++ b/src/ejabberd_ctl.erl @@ -438,8 +438,7 @@ print_usage() -> print_usage(dual, MaxC, ShCode). print_usage(HelpMode, MaxC, ShCode) -> AllCommands = - [ - {"status", [], "Get ejabberd status"}, + [{"status", [], "Get ejabberd status"}, {"stop", [], "Stop ejabberd"}, {"restart", [], "Restart ejabberd"}, {"help", ["[--tags [tag] | com?*]"], "Show help (try: ejabberdctl help help)"}, diff --git a/src/ejabberd_local.erl b/src/ejabberd_local.erl index ebcad372d..b6ae0a9f3 100644 --- a/src/ejabberd_local.erl +++ b/src/ejabberd_local.erl @@ -64,9 +64,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_CLIENT). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). %%==================================================================== %% API diff --git a/src/ejabberd_receiver.erl b/src/ejabberd_receiver.erl index f0cef9fe8..76a24c542 100644 --- a/src/ejabberd_receiver.erl +++ b/src/ejabberd_receiver.erl @@ -440,14 +440,12 @@ do_reset_stream(#state{xml_stream_state = XMLStreamState}) -> new_xmlstream(C2SPid, MaxStanzaSize) -> - Parser = exmpp_xml:start_parser([ - {names_as_atom, true}, - {check_nss, xmpp}, - {check_elems, xmpp}, - {check_attrs, xmpp}, - {max_size, MaxStanzaSize} - ]), - exmpp_xmlstream:start( - {gen_fsm, C2SPid}, Parser, - [{xmlstreamstart, new}] - ). + Parser = exmpp_xml:start_parser([{names_as_atom, true}, + {check_nss, xmpp}, + {check_elems, xmpp}, + {check_attrs, xmpp}, + {max_size, MaxStanzaSize} + ]), + exmpp_xmlstream:start({gen_fsm, C2SPid}, Parser, + [{xmlstreamstart, new}] + ). diff --git a/src/ejabberd_router.erl b/src/ejabberd_router.erl index be3a6401f..f9bc0ab76 100644 --- a/src/ejabberd_router.erl +++ b/src/ejabberd_router.erl @@ -427,8 +427,8 @@ do_route(OrigFrom, OrigTo, OrigPacket) -> drop end; Rs -> - Value = case ejabberd_config:get_local_option( - {domain_balancing, LDstDomain}) of + Value = case ejabberd_config:get_local_option + ({domain_balancing, LDstDomain}) of undefined -> now(); random -> now(); source -> jlib:short_prepd_jid(From); @@ -477,8 +477,8 @@ do_route(OrigFrom, OrigTo, OrigPacket) -> end. get_component_number(LDomain) -> - case ejabberd_config:get_local_option( - {domain_balancing_component_number, LDomain}) of + case ejabberd_config:get_local_option + ({domain_balancing_component_number, LDomain}) of N when is_integer(N), N > 1 -> N; diff --git a/src/ejabberd_s2s.erl b/src/ejabberd_s2s.erl index 59af8d9aa..8a69bcb04 100644 --- a/src/ejabberd_s2s.erl +++ b/src/ejabberd_s2s.erl @@ -61,9 +61,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_CLIENT). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). -record(s2s, {fromto, pid, key}). -record(state, {}). diff --git a/src/ejabberd_s2s_in.erl b/src/ejabberd_s2s_in.erl index b1b87c8df..e61e770a8 100644 --- a/src/ejabberd_s2s_in.erl +++ b/src/ejabberd_s2s_in.erl @@ -89,9 +89,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_SERVER). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). %%%---------------------------------------------------------------------- %%% API @@ -524,8 +523,7 @@ handle_sync_event(get_state_infos, _From, StateName, StateData) -> [D || {{D, _}, established} <- dict:to_list(Connections)] end, - Infos = [ - {direction, in}, + Infos = [{direction, in}, {statename, StateName}, {addr, Addr}, {port, Port}, diff --git a/src/ejabberd_s2s_out.erl b/src/ejabberd_s2s_out.erl index 37d20651b..7e686cce5 100644 --- a/src/ejabberd_s2s_out.erl +++ b/src/ejabberd_s2s_out.erl @@ -106,9 +106,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_SERVER). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). -define(SOCKET_DEFAULT_RESULT, {error, badarg}). @@ -606,9 +605,8 @@ wait_for_starttls_proceed({xmlstreamelement, El}, StateData) -> ?DEBUG("starttls: ~p", [{StateData#state.myname, StateData#state.server}]), Socket = StateData#state.socket, - TLSOpts = case ejabberd_config:get_local_option( - {domain_certfile, - StateData#state.server}) of + TLSOpts = case ejabberd_config:get_local_option + ({domain_certfile, StateData#state.server}) of undefined -> StateData#state.tls_options; CertFile -> @@ -763,8 +761,7 @@ handle_sync_event(get_state_infos, _From, StateName, StateData) -> _:_ -> {unknown,unknown} end, - Infos = [ - {direction, out}, + Infos = [{direction, out}, {statename, StateName}, {addr, Addr}, {port, Port}, @@ -862,8 +859,8 @@ terminate(Reason, StateName, StateData) -> false -> ok; Key -> - ejabberd_s2s:remove_connection( - {StateData#state.myname, StateData#state.server}, self(), Key) + ejabberd_s2s:remove_connectio + ({StateData#state.myname, StateData#state.server}, self(), Key) end, %% bounce queue manage by process and Erlang message queue bounce_queue(StateData#state.queue, 'remote-server-not-found'), @@ -953,8 +950,8 @@ send_db_request(StateData) -> Server = StateData#state.server, New = case StateData#state.new of false -> - case ejabberd_s2s:try_register( - {StateData#state.myname, Server}) of + case ejabberd_s2s:try_register + ({StateData#state.myname, Server}) of {key, Key} -> Key; false -> diff --git a/src/ejabberd_sm.erl b/src/ejabberd_sm.erl index 2024b03f0..4afeb08e7 100644 --- a/src/ejabberd_sm.erl +++ b/src/ejabberd_sm.erl @@ -80,9 +80,8 @@ % These are the namespace already declared by the stream opening. This is % used at serialization time. -define(DEFAULT_NS, ?NS_JABBER_CLIENT). --define(PREFIXED_NS, [ - {?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx} -]). +-define(PREFIXED_NS, + [{?NS_XMPP, ?NS_XMPP_pfx}, {?NS_DIALBACK, ?NS_DIALBACK_pfx}]). -define(IS_BINARY_OR_UNDEF(X), diff --git a/src/mod_muc/mod_muc_room.erl b/src/mod_muc/mod_muc_room.erl index 78bbd1921..cb8ec1cd8 100644 --- a/src/mod_muc/mod_muc_room.erl +++ b/src/mod_muc/mod_muc_room.erl @@ -232,9 +232,9 @@ normal_state({route, From, undefined, message_time = Now, message_shaper = MessageShaper, message = Packet}, - RoomQueue = queue:in( - {message, From}, - StateData#state.room_queue), + RoomQueue = + queue:in({message, From}, + StateData#state.room_queue), StateData2 = store_user_activity( From, NewActivity, StateData1), @@ -3042,8 +3042,8 @@ get_config(Lang, StateData, From) -> true -> [#xmlel{name = 'option', attrs = [?XMLATTR('label', translate:translate(Lang, "No limit"))], - children = [#xmlel{name = 'value', children = [#xmlcdata{ - cdata = <<"none">>}]}]}] + children = [#xmlel{name = 'value', + children = [#xmlcdata{cdata = <<"none">>}]}]}] end ++ [#xmlel{name = 'option', attrs = [?XMLATTR('label', N)], children = [#xmlel{name = 'value', children = [ diff --git a/src/mod_pubsub/mod_pubsub.erl b/src/mod_pubsub/mod_pubsub.erl index 419bd48e4..77737b44d 100644 --- a/src/mod_pubsub/mod_pubsub.erl +++ b/src/mod_pubsub/mod_pubsub.erl @@ -336,8 +336,8 @@ update_node_database(Host, ServerHost) -> options = Options} | RecList], Nidx + 1} end, {[], 1}, - mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_'})), + mnesia:match_object + ({pubsub_node, {Host, '_'}, '_', '_'})), mnesia:write(#pubsub_index{index = node, last = LastIdx, free = []}), Result end, @@ -386,10 +386,10 @@ update_node_database(Host, ServerHost) -> creation = {C2, C1}}) end, mnesia:match_object(#pubsub_item{id = {'_', NodeId}, _ = '_'})), Nidx + 1 - end, 1, mnesia:match_object( - {pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) - ++ mnesia:match_object( - {pubsub_node, {{'_', ServerHost, '_'}, '_'}, '_', '_', '_', '_', '_'})), + end, 1, mnesia:match_object + ({pubsub_node, {Host, '_'}, '_', '_', '_', '_', '_'}) + ++ mnesia:match_object + ({pubsub_node, {{'_', ServerHost, '_'}, '_'}, '_', '_', '_', '_', '_'})), mnesia:write(#pubsub_index{index = node, last = LastIdx, free = []}) end, case mnesia:transaction(FNew) of diff --git a/src/mod_pubsub/nodetree_tree.erl b/src/mod_pubsub/nodetree_tree.erl index 263b89d66..d46452f24 100644 --- a/src/mod_pubsub/nodetree_tree.erl +++ b/src/mod_pubsub/nodetree_tree.erl @@ -350,14 +350,13 @@ create_node(Host, NodeId, Type, #jid{node = U, domain = S} = _JID, Options, Pare true -> NodeIdx = pubsub_index:new(node), mnesia:write( - #pubsub_node{ - id = {Host, NodeId}, - idx = NodeIdx, - parents = ParentNodeIds, - type = Type, - owners = [Owner], - options = Options}), - {ok, NodeIdx}; + #pubsub_node{id = {Host, NodeId}, + idx = NodeIdx, + parents = ParentNodeIds, + type = Type, + owners = [Owner], + options = Options}), + {ok, NodeIdx}; false -> %% Requesting entity is prohibited from creating nodes {error, 'forbidden'} end; diff --git a/src/mod_pubsub/nodetree_tree_odbc.erl b/src/mod_pubsub/nodetree_tree_odbc.erl index 9460bee3a..4c2efa7f4 100644 --- a/src/mod_pubsub/nodetree_tree_odbc.erl +++ b/src/mod_pubsub/nodetree_tree_odbc.erl @@ -236,11 +236,10 @@ create_node(Host, Node, Type, Owner, Options, Parents) -> end, case ParentExists of true -> - case set_node(#pubsub_node{ - id={Host, Node}, - parents=Parents, - type=Type, - options=Options}) of + case set_node(#pubsub_node{id={Host, Node}, + parents=Parents, + type=Type, + options=Options}) of {result, Nidx} -> {ok, Nidx}; Other -> Other end; diff --git a/src/mod_vcard.erl b/src/mod_vcard.erl index f38fe7cfc..79fe4d29a 100644 --- a/src/mod_vcard.erl +++ b/src/mod_vcard.erl @@ -403,9 +403,8 @@ do_route(ServerHost, From, To, Packet) -> Result = #xmlel{ ns = ?NS_SEARCH, name = 'query', - children = [ - #xmlel{ - ns = ?NS_DATA_FORMS, + children = + [#xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"result">>)], diff --git a/src/mod_vcard_ldap.erl b/src/mod_vcard_ldap.erl index 4c08098c7..7368194a3 100644 --- a/src/mod_vcard_ldap.erl +++ b/src/mod_vcard_ldap.erl @@ -439,9 +439,8 @@ route(State, From, To, Packet) -> Result = #xmlel{ ns = ?NS_SEARCH, name = 'query', - children = [ - #xmlel{ - ns = ?NS_DATA_FORMS, + children = + [#xmlel{ns = ?NS_DATA_FORMS, name = 'x', attrs = [?XMLATTR('type', <<"result">>)], diff --git a/src/web/ejabberd_http_poll.erl b/src/web/ejabberd_http_poll.erl index f18774b2e..1033cbc3b 100644 --- a/src/web/ejabberd_http_poll.erl +++ b/src/web/ejabberd_http_poll.erl @@ -73,9 +73,7 @@ -define(CT, {"Content-Type", "text/xml; charset=utf-8"}). -define(BAD_REQUEST, [?CT, {"Set-Cookie", "ID=-3:0; expires=-1"}]). --define(PARSER_OPTIONS, [ - {names_as_atom, true} -]). +-define(PARSER_OPTIONS, [{names_as_atom, true}]). %%%---------------------------------------------------------------------- %%% API diff --git a/src/web/ejabberd_web_admin.erl b/src/web/ejabberd_web_admin.erl index df3659004..cfbdbe746 100644 --- a/src/web/ejabberd_web_admin.erl +++ b/src/web/ejabberd_web_admin.erl @@ -1001,8 +1001,8 @@ process_admin(Host, {value, {_, String}} -> case parse_access_rule(String) of {ok, Rs} -> - ejabberd_config:add_global_option( - {access, Name, Host}, Rs), + ejabberd_config:add_global_option + ({access, Name, Host}, Rs), ok; _ -> error