aboutsummaryrefslogtreecommitdiff
path: root/src/mod_carboncopy.erl
diff options
context:
space:
mode:
Diffstat (limited to 'src/mod_carboncopy.erl')
-rw-r--r--src/mod_carboncopy.erl172
1 files changed, 66 insertions, 106 deletions
diff --git a/src/mod_carboncopy.erl b/src/mod_carboncopy.erl
index de8d8e1a7..b70ccbc2a 100644
--- a/src/mod_carboncopy.erl
+++ b/src/mod_carboncopy.erl
@@ -36,37 +36,28 @@
stop/1]).
-export([user_send_packet/4, user_receive_packet/5,
- iq_handler2/3, iq_handler1/3, remove_connection/4,
+ iq_handler/1, remove_connection/4,
is_carbon_copy/1, mod_opt_type/1, depends/2]).
-include("ejabberd.hrl").
-include("logger.hrl").
--include("jlib.hrl").
+-include("xmpp.hrl").
-define(PROCNAME, ?MODULE).
+-type direction() :: sent | received.
+
-callback init(binary(), gen_mod:opts()) -> any().
-callback enable(binary(), binary(), binary(), binary()) -> ok | {error, any()}.
-callback disable(binary(), binary(), binary()) -> ok | {error, any()}.
-callback list(binary(), binary()) -> [{binary(), binary()}].
+-spec is_carbon_copy(stanza()) -> boolean().
is_carbon_copy(Packet) ->
- is_carbon_copy(Packet, <<"sent">>) orelse
- is_carbon_copy(Packet, <<"received">>).
-
-is_carbon_copy(Packet, Direction) ->
- case fxml:get_subtag(Packet, Direction) of
- #xmlel{name = Direction, attrs = Attrs} ->
- case fxml:get_attr_s(<<"xmlns">>, Attrs) of
- ?NS_CARBONS_2 -> true;
- ?NS_CARBONS_1 -> true;
- _ -> false
- end;
- _ -> false
- end.
+ xmpp:has_subtag(Packet, #carbons_sent{}) orelse
+ xmpp:has_subtag(Packet, #carbons_received{}).
start(Host, Opts) ->
IQDisc = gen_mod:get_opt(iqdisc, Opts,fun gen_iq_handler:check_type/1, one_queue),
- mod_disco:register_feature(Host, ?NS_CARBONS_1),
mod_disco:register_feature(Host, ?NS_CARBONS_2),
Mod = gen_mod:db_mod(Host, ?MODULE),
Mod:init(Host, Opts),
@@ -74,54 +65,53 @@ start(Host, Opts) ->
%% why priority 89: to define clearly that we must run BEFORE mod_logdb hook (90)
ejabberd_hooks:add(user_send_packet,Host, ?MODULE, user_send_packet, 89),
ejabberd_hooks:add(user_receive_packet,Host, ?MODULE, user_receive_packet, 89),
- gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_CARBONS_2, ?MODULE, iq_handler2, IQDisc),
- gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_CARBONS_1, ?MODULE, iq_handler1, IQDisc).
+ gen_iq_handler:add_iq_handler(ejabberd_sm, Host, ?NS_CARBONS_2, ?MODULE, iq_handler, IQDisc).
stop(Host) ->
- gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_CARBONS_1),
gen_iq_handler:remove_iq_handler(ejabberd_sm, Host, ?NS_CARBONS_2),
mod_disco:unregister_feature(Host, ?NS_CARBONS_2),
- mod_disco:unregister_feature(Host, ?NS_CARBONS_1),
%% why priority 89: to define clearly that we must run BEFORE mod_logdb hook (90)
ejabberd_hooks:delete(user_send_packet,Host, ?MODULE, user_send_packet, 89),
ejabberd_hooks:delete(user_receive_packet,Host, ?MODULE, user_receive_packet, 89),
ejabberd_hooks:delete(unset_presence_hook,Host, ?MODULE, remove_connection, 10).
-iq_handler2(From, To, IQ) ->
- iq_handler(From, To, IQ, ?NS_CARBONS_2).
-iq_handler1(From, To, IQ) ->
- iq_handler(From, To, IQ, ?NS_CARBONS_1).
-
-iq_handler(From, _To,
- #iq{type=set, lang = Lang,
- sub_el = #xmlel{name = Operation} = SubEl} = IQ, CC)->
- ?DEBUG("carbons IQ received: ~p", [IQ]),
+-spec iq_handler(iq()) -> iq().
+iq_handler(#iq{type = set, lang = Lang, from = From,
+ sub_els = [El]} = IQ) when is_record(El, carbons_enable);
+ is_record(El, carbons_disable) ->
{U, S, R} = jid:tolower(From),
- Result = case Operation of
- <<"enable">>->
- ?INFO_MSG("carbons enabled for user ~s@~s/~s", [U,S,R]),
- enable(S,U,R,CC);
- <<"disable">>->
- ?INFO_MSG("carbons disabled for user ~s@~s/~s", [U,S,R]),
- disable(S, U, R)
- end,
+ Result = case El of
+ #carbons_enable{} ->
+ ?INFO_MSG("carbons enabled for user ~s@~s/~s", [U,S,R]),
+ enable(S, U, R, ?NS_CARBONS_2);
+ #carbons_disable{} ->
+ ?INFO_MSG("carbons disabled for user ~s@~s/~s", [U,S,R]),
+ disable(S, U, R)
+ end,
case Result of
- ok ->
+ ok ->
?DEBUG("carbons IQ result: ok", []),
- IQ#iq{type=result, sub_el=[]};
+ xmpp:make_iq_result(IQ);
{error,_Error} ->
?ERROR_MSG("Error enabling / disabling carbons: ~p", [Result]),
Txt = <<"Database failure">>,
- IQ#iq{type=error,sub_el = [SubEl, ?ERRT_INTERNAL_SERVER_ERROR(Lang, Txt)]}
+ xmpp:make_error(IQ, xmpp:err_internal_server_error(Txt, Lang))
end;
-
-iq_handler(_From, _To, #iq{lang = Lang, sub_el = SubEl} = IQ, _CC)->
+iq_handler(#iq{type = set, lang = Lang} = IQ) ->
+ Txt = <<"Only <enable/> or <disable/> tags are allowed">>,
+ xmpp:make_error(IQ, xmpp:err_bad_request(Txt, Lang));
+iq_handler(#iq{type = get, lang = Lang} = IQ)->
Txt = <<"Value 'get' of 'type' attribute is not allowed">>,
- IQ#iq{type=error, sub_el = [SubEl, ?ERRT_NOT_ALLOWED(Lang, Txt)]}.
+ xmpp:make_error(IQ, xmpp:err_not_allowed(Txt, Lang)).
+-spec user_send_packet(stanza(), ejabberd_c2s:state(), jid(), jid()) ->
+ stanza() | {stop, stanza()}.
user_send_packet(Packet, _C2SState, From, To) ->
check_and_forward(From, To, Packet, sent).
+-spec user_receive_packet(stanza(), ejabberd_c2s:state(),
+ jid(), jid(), jid()) ->
+ stanza() | {stop, stanza()}.
user_receive_packet(Packet, _C2SState, JID, _From, To) ->
check_and_forward(JID, To, Packet, received).
@@ -129,10 +119,12 @@ user_receive_packet(Packet, _C2SState, JID, _From, To) ->
% - registered to the user_send_packet hook, to be called only once even for multicast
% - do not support "private" message mode, and do not modify the original packet in any way
% - we also replicate "read" notifications
+-spec check_and_forward(jid(), jid(), stanza(), direction()) ->
+ stanza() | {stop, stanza()}.
check_and_forward(JID, To, Packet, Direction)->
case is_chat_message(Packet) andalso
- fxml:get_subtag(Packet, <<"private">>) == false andalso
- fxml:get_subtag(Packet, <<"no-copy">>) == false of
+ xmpp:has_subtag(Packet, #carbons_private{}) == false andalso
+ xmpp:has_subtag(Packet, #hint{type = 'no-copy'}) == false of
true ->
case is_carbon_copy(Packet) of
false ->
@@ -147,6 +139,7 @@ check_and_forward(JID, To, Packet, Direction)->
Packet
end.
+-spec remove_connection(binary(), binary(), binary(), binary()) -> ok.
remove_connection(User, Server, Resource, _Status)->
disable(Server, User, Resource),
ok.
@@ -154,6 +147,7 @@ remove_connection(User, Server, Resource, _Status)->
%%% Internal
%% Direction = received | sent <received xmlns='urn:xmpp:carbons:1'/>
+-spec send_copies(jid(), jid(), message(), direction()) -> ok.
send_copies(JID, To, Packet, Direction)->
{U, S, R} = jid:tolower(JID),
PrioRes = ejabberd_sm:get_user_present_resources(U, S),
@@ -191,88 +185,54 @@ send_copies(JID, To, Packet, Direction)->
%TargetJIDs = lists:delete(JID, [ jid:make({U, S, CCRes}) || CCRes <- list(U, S) ]),
end,
- lists:map(fun({Dest,Version}) ->
+ lists:map(fun({Dest, _Version}) ->
{_, _, Resource} = jid:tolower(Dest),
?DEBUG("Sending: ~p =/= ~p", [R, Resource]),
Sender = jid:make({U, S, <<>>}),
%{xmlelement, N, A, C} = Packet,
- New = build_forward_packet(JID, Packet, Sender, Dest, Direction, Version),
+ New = build_forward_packet(JID, Packet, Sender, Dest, Direction),
ejabberd_router:route(Sender, Dest, New)
end, TargetJIDs),
ok.
-build_forward_packet(JID, Packet, Sender, Dest, Direction, ?NS_CARBONS_2) ->
- #xmlel{name = <<"message">>,
- attrs = [{<<"xmlns">>, <<"jabber:client">>},
- {<<"type">>, message_type(Packet)},
- {<<"from">>, jid:to_string(Sender)},
- {<<"to">>, jid:to_string(Dest)}],
- children = [
- #xmlel{name = list_to_binary(atom_to_list(Direction)),
- attrs = [{<<"xmlns">>, ?NS_CARBONS_2}],
- children = [
- #xmlel{name = <<"forwarded">>,
- attrs = [{<<"xmlns">>, ?NS_FORWARD}],
- children = [
- complete_packet(JID, Packet, Direction)]}
- ]}
- ]};
-build_forward_packet(JID, Packet, Sender, Dest, Direction, ?NS_CARBONS_1) ->
- #xmlel{name = <<"message">>,
- attrs = [{<<"xmlns">>, <<"jabber:client">>},
- {<<"type">>, message_type(Packet)},
- {<<"from">>, jid:to_string(Sender)},
- {<<"to">>, jid:to_string(Dest)}],
- children = [
- #xmlel{name = list_to_binary(atom_to_list(Direction)),
- attrs = [{<<"xmlns">>, ?NS_CARBONS_1}]},
- #xmlel{name = <<"forwarded">>,
- attrs = [{<<"xmlns">>, ?NS_FORWARD}],
- children = [complete_packet(JID, Packet, Direction)]}
- ]}.
-
+-spec build_forward_packet(jid(), message(), jid(), jid(), direction()) -> message().
+build_forward_packet(JID, #message{type = T} = Msg, Sender, Dest, Direction) ->
+ Forwarded = #forwarded{sub_els = complete_packet(JID, Msg, Direction)},
+ Carbon = case Direction of
+ sent -> #carbons_sent{forwarded = Forwarded};
+ received -> #carbons_received{forwarded = Forwarded}
+ end,
+ #message{from = Sender, to = Dest, type = T, sub_els = [Carbon]}.
+-spec enable(binary(), binary(), binary(), binary()) -> ok | {error, any()}.
enable(Host, U, R, CC)->
?DEBUG("enabling for ~p", [U]),
Mod = gen_mod:db_mod(Host, ?MODULE),
Mod:enable(U, Host, R, CC).
+-spec disable(binary(), binary(), binary()) -> ok | {error, any()}.
disable(Host, U, R)->
?DEBUG("disabling for ~p", [U]),
Mod = gen_mod:db_mod(Host, ?MODULE),
Mod:disable(U, Host, R).
-complete_packet(From, #xmlel{name = <<"message">>, attrs = OrigAttrs} = Packet, sent) ->
+-spec complete_packet(jid(), message(), direction()) -> message().
+complete_packet(From, #message{from = undefined} = Msg, sent) ->
%% if this is a packet sent by user on this host, then Packet doesn't
%% include the 'from' attribute. We must add it.
- Attrs = lists:keystore(<<"xmlns">>, 1, OrigAttrs, {<<"xmlns">>, <<"jabber:client">>}),
- case proplists:get_value(<<"from">>, Attrs) of
- undefined ->
- Packet#xmlel{attrs = [{<<"from">>, jid:to_string(From)}|Attrs]};
- _ ->
- Packet#xmlel{attrs = Attrs}
- end;
-complete_packet(_From, #xmlel{name = <<"message">>, attrs=OrigAttrs} = Packet, received) ->
- Attrs = lists:keystore(<<"xmlns">>, 1, OrigAttrs, {<<"xmlns">>, <<"jabber:client">>}),
- Packet#xmlel{attrs = Attrs}.
-
-message_type(#xmlel{attrs = Attrs}) ->
- case fxml:get_attr(<<"type">>, Attrs) of
- {value, Type} -> Type;
- false -> <<"normal">>
- end.
-
-is_chat_message(#xmlel{name = <<"message">>} = Packet) ->
- case message_type(Packet) of
- <<"chat">> -> true;
- <<"normal">> -> has_non_empty_body(Packet);
- _ -> false
- end;
-is_chat_message(_Packet) -> false.
-
-has_non_empty_body(Packet) ->
- fxml:get_subtag_cdata(Packet, <<"body">>) =/= <<"">>.
-
+ Msg#message{from = From};
+complete_packet(_From, Msg, _Direction) ->
+ Msg.
+
+-spec is_chat_message(stanza()) -> boolean().
+is_chat_message(#message{type = chat}) ->
+ true;
+is_chat_message(#message{type = normal, body = Body}) ->
+ xmpp:get_text(Body) /= <<"">>;
+is_chat_message(_) ->
+ false.
+
+-spec list(binary(), binary()) -> [{binary(), binary()}].
%% list {resource, cc_version} with carbons enabled for given user and host
list(User, Server) ->
Mod = gen_mod:db_mod(Server, ?MODULE),
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-29 21:46:53 +0000