./ct_report/coverage/mod_mam_utils.COVER.html

1 %%%-------------------------------------------------------------------
2 %%% @author Uvarov Michael <arcusfelis@gmail.com>
3 %%% @copyright (C) 2013, Uvarov Michael
4 %%% @doc General functions for MAM.
5 %%% @end
6 %%%-------------------------------------------------------------------
7 -module(mod_mam_utils).
8 %% Time
9 -export([maybe_microseconds/1]).
10
11 %% UID
12 -export([get_or_generate_mam_id/1,
13 generate_message_id/1,
14 encode_compact_uuid/2,
15 decode_compact_uuid/1,
16 mess_id_to_external_binary/1,
17 external_binary_to_mess_id/1,
18 wrapper_id/0]).
19
20 %% XML
21 -export([maybe_add_arcid_elems/4,
22 maybe_log_deprecation/1,
23 is_arcid_elem_for/3,
24 replace_arcid_elem/4,
25 replace_x_user_element/4,
26 append_arcid_elem/4,
27 delete_arcid_elem/3,
28 delete_x_user_element/1,
29 packet_to_x_user_jid/1,
30 get_one_of_path/2,
31 get_one_of_path/3,
32 is_archivable_message/4,
33 has_message_retraction/2,
34 get_retract_id/2,
35 get_origin_id/1,
36 is_groupchat/1,
37 should_page_be_flipped/1,
38 tombstone/2,
39 wrap_message/6,
40 wrap_message/7,
41 result_set/4,
42 result_query/2,
43 result_prefs/4,
44 make_fin_element/7,
45 parse_prefs/1,
46 form_borders_decode/1,
47 form_decode_optimizations/1,
48 is_mam_result_message/1,
49 make_metadata_element/0,
50 make_metadata_element/4,
51 features/2]).
52
53 %% Forms
54 -export([
55 message_form/3,
56 form_to_text/1
57 ]).
58
59 %% Text search
60 -export([
61 normalize_search_text/1,
62 normalize_search_text/2,
63 packet_to_search_body/2,
64 has_full_text_search/2
65 ]).
66
67 %% JID serialization
68 -export([jid_to_opt_binary/2,
69 expand_minified_jid/2]).
70
71 %% Other
72 -export([maybe_integer/2,
73 maybe_min/2,
74 maybe_max/2,
75 maybe_last/1,
76 apply_start_border/2,
77 apply_end_border/2,
78 bare_jid/1,
79 full_jid/1,
80 calculate_msg_id_borders/3,
81 calculate_msg_id_borders/4,
82 maybe_encode_compact_uuid/2,
83 wait_shaper/4,
84 check_for_item_not_found/3,
85 maybe_reverse_messages/2,
86 get_msg_id_and_timestamp/1,
87 lookup_specific_messages/4,
88 is_mam_muc_enabled/2]).
89
90 %% Ejabberd
91 -export([send_message/4,
92 maybe_set_client_xmlns/2,
93 is_jid_in_user_roster/3]).
94
95 %% Shared logic
96 -export([check_result_for_policy_violation/2,
97 lookup/3,
98 lookup_first_and_last_messages/4,
99 lookup_first_and_last_messages/5,
100 incremental_delete_domain/5,
101 db_message_codec/2, db_jid_codec/2]).
102
103 -callback extra_fin_element(mongooseim:host_type(),
104 mam_iq:lookup_params(),
105 exml:element()) -> exml:element().
106
107 -ignore_xref([behaviour_info/1, append_arcid_elem/4, delete_arcid_elem/3,
108 get_one_of_path/3, is_arcid_elem_for/3, maybe_encode_compact_uuid/2,
109 maybe_last/1, result_query/2, send_message/4, wrap_message/7, wrapper_id/0]).
110
111 %-define(MAM_INLINE_UTILS, true).
112
113 -ifdef(MAM_INLINE_UTILS).
114 -compile({inline, [
115 is_valid_message/4,
116 is_valid_message_type/3,
117 encode_compact_uuid/2,
118 get_one_of_path/3,
119 delay/2,
120 forwarded/3,
121 result/4,
122 valid_behavior/1]}).
123 -endif.
124
125 -include("jlib.hrl").
126 -include_lib("exml/include/exml.hrl").
127
128 -ifdef(TEST).
129 -include_lib("eunit/include/eunit.hrl").
130 -export([is_valid_message/4]).
131 -endif.
132
133 -include("mod_mam.hrl").
134 -include("mongoose_rsm.hrl").
135 -include("mongoose_ns.hrl").
136
137 -define(MAYBE_BIN(X), (is_binary(X) orelse (X) =:= undefined)).
138
139 -export_type([direction/0, retraction_id/0, retraction_info/0]).
140
141 %% ----------------------------------------------------------------------
142 %% Datetime types
143 -type ne_binary() :: <<_:8, _:_*8>>.
144 -type iso8601_datetime_binary() :: ne_binary().
145 %% Microseconds from 01.01.1970
146 -type unix_timestamp() :: mod_mam:unix_timestamp().
147
148 -type archive_behaviour() :: mod_mam:archive_behaviour().
149 -type archive_behaviour_bin() :: binary(). % `<<"roster">> | <<"always">> | <<"never">>'.
150
151 -type direction() :: incoming | outgoing.
152 -type retraction_id() :: {origin_id | stanza_id, binary()}.
153 -type retraction_info() :: #{retract_on := origin_id | stanza_id,
154 packet := exml:element(),
155 message_id := mod_mam:message_id(),
156 origin_id := null | binary()}.
157
158 %% -----------------------------------------------------------------------
159 %% Time
160
161 %% @doc Return a unix timestamp in microseconds.
162 %%
163 %% "maybe" means, that the function may return `undefined'.
164 %% @end
165 -spec maybe_microseconds(iso8601_datetime_binary()) -> unix_timestamp();
166 (<<>>) -> undefined.
167 
:-(
 maybe_microseconds(<<>>) -> undefined;
168 maybe_microseconds(ISODateTime) ->
169 201 try calendar:rfc3339_to_system_time(binary_to_list(ISODateTime), [{unit, microsecond}])
170 12 catch error:_Error -> undefined
171 end.
172
173 %% -----------------------------------------------------------------------
174 %% UID
175
176 -spec get_or_generate_mam_id(mongoose_acc:t()) -> integer().
177 get_or_generate_mam_id(Acc) ->
178 2319 case mongoose_acc:get(mam, mam_id, undefined, Acc) of
179 undefined ->
180 2298 CandidateStamp = mongoose_acc:timestamp(Acc),
181 2298 generate_message_id(CandidateStamp);
182 ExtMessId ->
183 21 mod_mam_utils:external_binary_to_mess_id(ExtMessId)
184 end.
185
186 -spec generate_message_id(integer()) -> integer().
187 generate_message_id(CandidateStamp) ->
188 2911 NodeNum = mongoose_node_num:node_num(),
189 2911 UniqueStamp = mongoose_mam_id:next_unique(CandidateStamp),
190 2911 encode_compact_uuid(UniqueStamp, NodeNum).
191
192 %% @doc Create a message ID (UID).
193 %%
194 %% It removes a leading 0 from 64-bit binary representation.
195 %% It puts node id as a last byte.
196 %% The maximum date, that can be encoded is `{{4253, 5, 31}, {22, 20, 37}}'.
197 -spec encode_compact_uuid(integer(), integer()) -> integer().
198 encode_compact_uuid(Microseconds, NodeNum)
199 when is_integer(Microseconds), is_integer(NodeNum) ->
200 12112 (Microseconds bsl 8) + NodeNum.
201
202
203 %% @doc Extract date and node id from a message id.
204 -spec decode_compact_uuid(integer()) -> {integer(), byte()}.
205 decode_compact_uuid(Id) ->
206 4670 Microseconds = Id bsr 8,
207 4670 NodeNum = Id band 255,
208 4670 {Microseconds, NodeNum}.
209
210
211 %% @doc Encode a message ID to pass it to the user.
212 -spec mess_id_to_external_binary(integer()) -> binary().
213 mess_id_to_external_binary(MessID) when is_integer(MessID) ->
214 9674 integer_to_binary(MessID, 32).
215
216 %% @doc Decode a message ID received from the user.
217 -spec external_binary_to_mess_id(binary()) -> integer().
218 external_binary_to_mess_id(BExtMessID) when is_binary(BExtMessID) ->
219 672 try binary_to_integer(BExtMessID, 32)
220 21 catch error:badarg -> throw(invalid_stanza_id)
221 end.
222
223 %% -----------------------------------------------------------------------
224 %% XML
225
226 -spec maybe_add_arcid_elems(To :: jid:simple_jid() | jid:jid(),
227 MessID :: binary(), Packet :: exml:element(),
228 AddStanzaid :: boolean()) ->
229 AlteredPacket :: exml:element().
230 maybe_add_arcid_elems(To, MessID, Packet, AddStanzaid) ->
231 1803 BareTo = jid:to_bare_binary(To),
232 1803 case AddStanzaid of
233 true ->
234 1789 replace_arcid_elem(<<"stanza-id">>, BareTo, MessID, Packet);
235 14 _ -> Packet
236 end.
237
238 maybe_log_deprecation(_IQ) ->
239 1940 ok. %% May be reused for future MAM versions.
240
241 %% @doc Return true, if the first element points on `By'.
242 -spec is_arcid_elem_for(ElemName :: binary(), exml:element(), By :: binary()) -> boolean().
243 is_arcid_elem_for(<<"archived">>, #xmlel{name = <<"archived">>, attrs=As}, By) ->
244 
:-(
 lists:member({<<"by">>, By}, As);
245 is_arcid_elem_for(<<"stanza-id">>, #xmlel{name = <<"stanza-id">>, attrs=As}, By) ->
246 85 lists:member({<<"by">>, By}, As) andalso
247 
:-(
 lists:member({<<"xmlns">>, ?NS_STANZAID}, As);
248 is_arcid_elem_for(_, _, _) ->
249 2102 false.
250
251 -spec replace_arcid_elem(ElemName :: binary(), By :: binary(), Id :: binary(),
252 Packet :: exml:element()) -> exml:element().
253 replace_arcid_elem(ElemName, By, Id, Packet) ->
254 1796 append_arcid_elem(ElemName, By, Id,
255 delete_arcid_elem(ElemName, By, Packet)).
256
257 -spec append_arcid_elem(ElemName :: binary(), By :: binary(), Id :: binary(),
258 Packet :: exml:element()) ->exml:element().
259 append_arcid_elem(<<"stanza-id">>, By, Id, Packet) ->
260 1796 Archived = #xmlel{
261 name = <<"stanza-id">>,
262 attrs=[{<<"by">>, By}, {<<"id">>, Id}, {<<"xmlns">>, ?NS_STANZAID}]},
263 1796 xml:append_subtags(Packet, [Archived]);
264 append_arcid_elem(ElemName, By, Id, Packet) ->
265 
:-(
 Archived = #xmlel{
266 name = ElemName,
267 attrs=[{<<"by">>, By}, {<<"id">>, Id}]},
268 
:-(
 xml:append_subtags(Packet, [Archived]).
269
270 -spec delete_arcid_elem(ElemName :: binary(), By :: binary(), exml:element()) -> exml:element().
271 delete_arcid_elem(ElemName, By, Packet=#xmlel{children=Cs}) ->
272 1796 Packet#xmlel{children=[C || C <- Cs, not is_arcid_elem_for(ElemName, C, By)]}.
273
274
275 is_x_user_element(#xmlel{name = <<"x">>, attrs = As}) ->
276 426 lists:member({<<"xmlns">>, ?NS_MUC_USER}, As);
277 is_x_user_element(_) ->
278 885 false.
279
280 -spec replace_x_user_element(FromJID :: jid:jid(), Role :: mod_muc:role(),
281 Affiliation :: mod_muc:affiliation(), exml:element()) -> exml:element().
282 replace_x_user_element(FromJID, Role, Affiliation, Packet) ->
283 613 append_x_user_element(FromJID, Role, Affiliation,
284 delete_x_user_element(Packet)).
285
286 append_x_user_element(FromJID, Role, Affiliation, Packet) ->
287 613 ItemElem = x_user_item(FromJID, Role, Affiliation),
288 613 X = #xmlel{
289 name = <<"x">>,
290 attrs = [{<<"xmlns">>, ?NS_MUC_USER}],
291 children = [ItemElem]},
292 613 xml:append_subtags(Packet, [X]).
293
294 x_user_item(FromJID, Role, Affiliation) ->
295 613 #xmlel{
296 name = <<"item">>,
297 attrs = [{<<"affiliation">>, atom_to_binary(Affiliation, latin1)},
298 {<<"jid">>, jid:to_binary(FromJID)},
299 {<<"role">>, atom_to_binary(Role, latin1)}]}.
300
301 -spec delete_x_user_element(exml:element()) -> exml:element().
302 delete_x_user_element(Packet=#xmlel{children=Cs}) ->
303 713 Packet#xmlel{children=[C || C <- Cs, not is_x_user_element(C)]}.
304
305 -spec packet_to_x_user_jid(exml:element()) -> jid:jid() | error | undefined.
306 packet_to_x_user_jid(#xmlel{children=Cs}) ->
307 122 case [C || C <- Cs, is_x_user_element(C)] of
308 14 [] -> undefined;
309 [X|_] ->
310 108 case exml_query:path(X, [{element, <<"item">>}, {attr, <<"jid">>}]) of
311 
:-(
 undefined -> undefined;
312 108 BinaryJid -> jid:from_binary(BinaryJid)
313 end
314 end.
315
316 -spec get_one_of_path(_, list(T)) -> T when T :: any().
317 get_one_of_path(Elem, List) ->
318 1380 get_one_of_path(Elem, List, <<>>).
319
320
321 -spec get_one_of_path(_, list(T), T) -> T when T :: any().
322 get_one_of_path(Elem, [H|T], Def) ->
323 2074 case exml_query:path(Elem, H) of
324 1388 undefined -> get_one_of_path(Elem, T, Def);
325 686 Val -> Val
326 end;
327 get_one_of_path(_Elem, [], Def) ->
328 694 Def.
329
330
331 %% @doc In order to be archived, the message must be of type "normal", "chat" or "groupchat".
332 %% It also must include a body or chat marker, as long as it doesn't include
333 %% "result", "delay" or "no-store" elements.
334 %% @end
335 -spec is_archivable_message(module(), direction(), exml:element(), boolean()) -> boolean().
336 is_archivable_message(Mod, Dir, Packet=#xmlel{name = <<"message">>}, ArchiveChatMarkers) ->
337 6284 Type = exml_query:attr(Packet, <<"type">>, <<"normal">>),
338 6284 is_valid_message_type(Mod, Dir, Type) andalso
339 6093 is_valid_message(Mod, Dir, Packet, ArchiveChatMarkers);
340 is_archivable_message(_, _, _, _) ->
341 8958 false.
342
343 284 is_valid_message_type(_, _, <<"normal">>) -> true;
344 3122 is_valid_message_type(_, _, <<"chat">>) -> true;
345 1578 is_valid_message_type(mod_inbox, _, <<"groupchat">>) -> true;
346 1109 is_valid_message_type(_, incoming, <<"groupchat">>) -> true;
347 191 is_valid_message_type(_, _, _) -> false.
348
349 is_valid_message(_Mod, _Dir, Packet, ArchiveChatMarkers) ->
350 6093 Body = exml_query:subelement(Packet, <<"body">>, false),
351 6093 ChatMarker = ArchiveChatMarkers
352 2641 andalso has_chat_marker(Packet),
353 6093 Retract = get_retract_id(Packet) =/= none,
354 %% Used in MAM
355 6093 Result = exml_query:subelement(Packet, <<"result">>, false),
356 %% Used in mod_offline
357 6093 Delay = exml_query:subelement(Packet, <<"delay">>, false),
358 %% Message Processing Hints (XEP-0334)
359 6093 NoStore = exml_query:path(Packet, [{element_with_ns, <<"no-store">>, ?NS_HINTS}], false),
360 %% Message Processing Hints (XEP-0334)
361 6093 Store = exml_query:path(Packet, [{element_with_ns, <<"store">>, ?NS_HINTS}], false),
362
363 6093 has_any([Store, Body, ChatMarker, Retract]) andalso not has_any([Result, Delay, NoStore]).
364
365 has_any(Elements) ->
366 11930 lists:any(fun(El) -> El =/= false end, Elements).
367
368 has_chat_marker(Packet) ->
369 2641 mongoose_chat_markers:has_chat_markers(Packet).
370
371 -spec get_retract_id(false, exml:element()) -> none;
372 (true, exml:element()) -> none | retraction_id().
373 get_retract_id(true = _Enabled, Packet) ->
374 10015 get_retract_id(Packet);
375 get_retract_id(false, _Packet) ->
376 28 none.
377
378 -spec get_retract_id(exml:element()) -> none | retraction_id().
379 get_retract_id(Packet) ->
380 16108 case exml_query:path(Packet, [{element_with_ns, <<"apply-to">>, ?NS_FASTEN}], none) of
381 15954 none -> none;
382 Fasten ->
383 154 case {exml_query:path(Fasten, [{element, <<"retract">>}, {attr, <<"xmlns">>}], none),
384 exml_query:path(Fasten, [{attr, <<"id">>}], none)} of
385 
:-(
 {none, _} -> none;
386 14 {_, none} -> none;
387 98 {?NS_RETRACT, OriginId} -> {origin_id, OriginId};
388 42 {?NS_ESL_RETRACT, StanzaId} -> {stanza_id, StanzaId}
389 end
390 end.
391
392 get_origin_id(Packet) ->
393 3226 exml_query:path(Packet, [{element_with_ns, <<"origin-id">>, ?NS_STANZAID},
394 {attr, <<"id">>}], none).
395
396 is_groupchat(<<"groupchat">>) ->
397 147 true;
398 is_groupchat(_) ->
399 2172 false.
400
401 -spec should_page_be_flipped(exml:element()) -> boolean().
402 should_page_be_flipped(Packet) ->
403 1380 case exml_query:path(Packet, [{element, <<"flip-page">>}], none) of
404 1338 none -> false;
405 42 _ -> true
406 end.
407
408 -spec maybe_reverse_messages(mam_iq:lookup_params(), [mod_mam:message_row()]) ->
409 [mod_mam:message_row()].
410 42 maybe_reverse_messages(#{flip_page := true}, Messages) -> lists:reverse(Messages);
411 1254 maybe_reverse_messages(#{flip_page := false}, Messages) -> Messages.
412
413 -spec get_msg_id_and_timestamp(mod_mam:message_row()) -> {binary(), binary()}.
414 get_msg_id_and_timestamp(#{id := MsgID}) ->
415 56 {Microseconds, _NodeMessID} = decode_compact_uuid(MsgID),
416 56 TS = calendar:system_time_to_rfc3339(Microseconds, [{offset, "Z"}, {unit, microsecond}]),
417 56 ExtID = mess_id_to_external_binary(MsgID),
418 56 {ExtID, list_to_binary(TS)}.
419
420 -spec lookup_specific_messages(mongooseim:host_type(),
421 mam_iq:lookup_params(),
422 [mod_mam:message_id()],
423 fun()) -> [mod_mam:message_row()] | {error, item_not_found}.
424 lookup_specific_messages(HostType, Params, IDs, FetchFun) ->
425 42 {FinalOffset, AccumulatedMessages} = lists:foldl(
426 fun(ID, {_AccOffset, AccMsgs}) ->
427 98 {ok, {_, OffsetForID, MessagesForID}} = FetchFun(HostType, Params#{message_id => ID}),
428 98 {OffsetForID, AccMsgs ++ MessagesForID}
429 end,
430 {0, []}, IDs),
431
432 42 Result = determine_result(Params, FinalOffset, AccumulatedMessages),
433
434 42 case length(IDs) == length(AccumulatedMessages) of
435 28 true -> Result;
436 14 false -> {error, item_not_found}
437 end.
438
439 determine_result(Params, Offset, Messages) ->
440 42 case maps:get(is_simple, Params, false) of
441 true ->
442 14 {ok, {undefined, undefined, Messages}};
443 false ->
444 28 {ok, {length(Messages), Offset, Messages}}
445 end.
446
447
448 tombstone(RetractionInfo = #{packet := Packet}, LocJid) ->
449 42 Packet#xmlel{children = [retracted_element(RetractionInfo, LocJid)]}.
450
451 -spec retracted_element(retraction_info(), jid:jid()) -> exml:element().
452 retracted_element(#{retract_on := origin_id,
453 origin_id := OriginID}, _LocJid) ->
454 21 Timestamp = calendar:system_time_to_rfc3339(erlang:system_time(second), [{offset, "Z"}]),
455 21 #xmlel{name = <<"retracted">>,
456 attrs = [{<<"xmlns">>, ?NS_RETRACT},
457 {<<"stamp">>, list_to_binary(Timestamp)}],
458 children = [#xmlel{name = <<"origin-id">>,
459 attrs = [{<<"xmlns">>, ?NS_STANZAID},
460 {<<"id">>, OriginID}]}
461 ]};
462 retracted_element(#{retract_on := stanza_id,
463 message_id := MessID} = Env, LocJid) ->
464 21 Timestamp = calendar:system_time_to_rfc3339(erlang:system_time(second), [{offset, "Z"}]),
465 21 StanzaID = mod_mam_utils:mess_id_to_external_binary(MessID),
466 21 MaybeOriginId = maybe_append_origin_id(Env),
467 21 #xmlel{name = <<"retracted">>,
468 attrs = [{<<"xmlns">>, ?NS_ESL_RETRACT},
469 {<<"stamp">>, list_to_binary(Timestamp)}],
470 children = [#xmlel{name = <<"stanza-id">>,
471 attrs = [{<<"xmlns">>, ?NS_STANZAID},
472 {<<"id">>, StanzaID},
473 {<<"by">>, jid:to_bare_binary(LocJid)}]} |
474 MaybeOriginId
475 ]}.
476
477 -spec maybe_append_origin_id(retraction_info()) -> [exml:element()].
478 maybe_append_origin_id(#{origin_id := OriginID}) when is_binary(OriginID), <<>> =/= OriginID ->
479 21 [#xmlel{name = <<"origin-id">>, attrs = [{<<"xmlns">>, ?NS_STANZAID}, {<<"id">>, OriginID}]}];
480 maybe_append_origin_id(_) ->
481 
:-(
 [].
482
483 %% @doc Forms `<forwarded/>' element, according to the XEP.
484 -spec wrap_message(MamNs :: binary(), Packet :: exml:element(), QueryID :: binary(),
485 MessageUID :: term(), TS :: jlib:rfc3339_string(),
486 SrcJID :: jid:jid()) -> Wrapper :: exml:element().
487 wrap_message(MamNs, Packet, QueryID, MessageUID, TS, SrcJID) ->
488 4430 wrap_message(MamNs, Packet, QueryID, MessageUID, wrapper_id(), TS, SrcJID).
489
490 -spec wrap_message(MamNs :: binary(), Packet :: exml:element(), QueryID :: binary(),
491 MessageUID :: term(), WrapperI :: binary(),
492 TS :: jlib:rfc3339_string(),
493 SrcJID :: jid:jid()) -> Wrapper :: exml:element().
494 wrap_message(MamNs, Packet, QueryID, MessageUID, WrapperID, TS, SrcJID) ->
495 4430 #xmlel{ name = <<"message">>,
496 attrs = [{<<"id">>, WrapperID}],
497 children = [result(MamNs, QueryID, MessageUID,
498 [forwarded(Packet, TS, SrcJID)])] }.
499
500 -spec forwarded(exml:element(), jlib:rfc3339_string(), jid:jid())
501 -> exml:element().
502 forwarded(Packet, TS, SrcJID) ->
503 4430 #xmlel{
504 name = <<"forwarded">>,
505 attrs = [{<<"xmlns">>, ?NS_FORWARD}],
506 %% Two places to include SrcJID:
507 %% - delay.from - optional XEP-0297 (TODO: depricate adding it?)
508 %% - message.from - required XEP-0313
509 %% Also, mod_mam_muc will replace it again with SrcJID
510 children = [delay(TS, SrcJID), replace_from_attribute(SrcJID, Packet)]}.
511
512 -spec delay(jlib:rfc3339_string(), jid:jid()) -> exml:element().
513 delay(TS, SrcJID) ->
514 4430 jlib:timestamp_to_xml(TS, SrcJID, <<>>).
515
516 replace_from_attribute(From, Packet=#xmlel{attrs = Attrs}) ->
517 4430 Attrs1 = lists:keydelete(<<"from">>, 1, Attrs),
518 4430 Attrs2 = [{<<"from">>, jid:to_binary(From)} | Attrs1],
519 4430 Packet#xmlel{attrs = Attrs2}.
520
521 %% @doc Generates tag `<result />'.
522 %% This element will be added in each forwarded message.
523 -spec result(binary(), _, MessageUID :: binary(), Children :: [exml:element(), ...])
524 -> exml:element().
525 result(MamNs, QueryID, MessageUID, Children) when is_list(Children) ->
526 %% <result xmlns='urn:xmpp:mam:tmp' queryid='f27' id='28482-98726-73623' />
527 4430 #xmlel{
528 name = <<"result">>,
529 3296 attrs = [{<<"queryid">>, QueryID} || QueryID =/= undefined, QueryID =/= <<>>] ++
530 [{<<"xmlns">>, MamNs},
531 {<<"id">>, MessageUID}],
532 children = Children}.
533
534
535 %% @doc Generates `<set />' tag.
536 %%
537 %% This element will be added into "iq/query".
538 %% @end
539 -spec result_set(FirstId :: binary() | undefined,
540 LastId :: binary() | undefined,
541 FirstIndexI :: non_neg_integer() | undefined,
542 CountI :: non_neg_integer() | undefined) -> exml:element().
543 result_set(FirstId, LastId, undefined, undefined)
544 when ?MAYBE_BIN(FirstId), ?MAYBE_BIN(LastId) ->
545 %% Simple response
546 1088 FirstEl = [#xmlel{name = <<"first">>,
547 children = [#xmlcdata{content = FirstId}]
548 }
549 1088 || FirstId =/= undefined],
550 1088 LastEl = [#xmlel{name = <<"last">>,
551 children = [#xmlcdata{content = LastId}]
552 }
553 1088 || LastId =/= undefined],
554 1088 #xmlel{
555 name = <<"set">>,
556 attrs = [{<<"xmlns">>, ?NS_RSM}],
557 children = FirstEl ++ LastEl};
558 result_set(FirstId, LastId, FirstIndexI, CountI)
559 when ?MAYBE_BIN(FirstId), ?MAYBE_BIN(LastId) ->
560 1107 FirstEl = [#xmlel{name = <<"first">>,
561 attrs = [{<<"index">>, integer_to_binary(FirstIndexI)}],
562 children = [#xmlcdata{content = FirstId}]
563 }
564 1107 || FirstId =/= undefined],
565 1107 LastEl = [#xmlel{name = <<"last">>,
566 children = [#xmlcdata{content = LastId}]
567 }
568 1107 || LastId =/= undefined],
569 1107 CountEl = #xmlel{
570 name = <<"count">>,
571 children = [#xmlcdata{content = integer_to_binary(CountI)}]},
572 1107 #xmlel{
573 name = <<"set">>,
574 attrs = [{<<"xmlns">>, ?NS_RSM}],
575 children = FirstEl ++ LastEl ++ [CountEl]}.
576
577
578 -spec result_query(jlib:xmlcdata() | exml:element(), binary()) -> exml:element().
579 result_query(SetEl, Namespace) ->
580 35 #xmlel{
581 name = <<"query">>,
582 attrs = [{<<"xmlns">>, Namespace}],
583 children = [SetEl]}.
584
585 -spec result_prefs(DefaultMode :: archive_behaviour(),
586 AlwaysJIDs :: [jid:literal_jid()],
587 NeverJIDs :: [jid:literal_jid()],
588 Namespace :: binary()) -> exml:element().
589 result_prefs(DefaultMode, AlwaysJIDs, NeverJIDs, Namespace) ->
590 469 AlwaysEl = #xmlel{name = <<"always">>,
591 children = encode_jids(AlwaysJIDs)},
592 469 NeverEl = #xmlel{name = <<"never">>,
593 children = encode_jids(NeverJIDs)},
594 469 #xmlel{
595 name = <<"prefs">>,
596 attrs = [{<<"xmlns">>, Namespace},
597 {<<"default">>, atom_to_binary(DefaultMode, utf8)}],
598 children = [AlwaysEl, NeverEl]
599 }.
600
601
602 -spec encode_jids([binary() | string()]) -> [exml:element()].
603 encode_jids(JIDs) ->
604 938 [#xmlel{name = <<"jid">>, children = [#xmlcdata{content = JID}]}
605 938 || JID <- JIDs].
606
607
608 %% MAM v0.4.1 and above
609 -spec make_fin_element(mongooseim:host_type(),
610 mam_iq:lookup_params(),
611 binary(),
612 boolean(),
613 boolean(),
614 exml:element(),
615 module()) ->
616 exml:element().
617 make_fin_element(HostType, Params, MamNs, IsComplete, IsStable, ResultSetEl, ExtFinMod) ->
618 1296 FinEl = #xmlel{
619 name = <<"fin">>,
620 attrs = [{<<"xmlns">>, MamNs}]
621 932 ++ [{<<"complete">>, <<"true">>} || IsComplete]
622 
:-(
 ++ [{<<"stable">>, <<"false">>} || not IsStable],
623 children = [ResultSetEl]},
624 1296 maybe_transform_fin_elem(ExtFinMod, HostType, Params, FinEl).
625
626 maybe_transform_fin_elem(undefined, _HostType, _Params, FinEl) ->
627 1296 FinEl;
628 maybe_transform_fin_elem(Module, HostType, Params, FinEl) ->
629 
:-(
 Module:extra_fin_element(HostType, Params, FinEl).
630
631 -spec make_metadata_element() -> exml:element().
632 make_metadata_element() ->
633 14 #xmlel{
634 name = <<"metadata">>,
635 attrs = [{<<"xmlns">>, ?NS_MAM_06}]}.
636
637 -spec make_metadata_element(binary(), binary(), binary(), binary()) -> exml:element().
638 make_metadata_element(FirstMsgID, FirstMsgTS, LastMsgID, LastMsgTS) ->
639 28 #xmlel{
640 name = <<"metadata">>,
641 attrs = [{<<"xmlns">>, ?NS_MAM_06}],
642 children = [#xmlel{name = <<"start">>,
643 attrs = [{<<"id">>, FirstMsgID}, {<<"timestamp">>, FirstMsgTS}]},
644 #xmlel{name = <<"end">>,
645 attrs = [{<<"id">>, LastMsgID}, {<<"timestamp">>, LastMsgTS}]}]
646 }.
647
648 -spec parse_prefs(PrefsEl :: exml:element()) -> mod_mam:preference().
649 parse_prefs(El = #xmlel{ name = <<"prefs">> }) ->
650 308 Default = exml_query:attr(El, <<"default">>),
651 308 AlwaysJIDs = parse_jid_list(El, <<"always">>),
652 308 NeverJIDs = parse_jid_list(El, <<"never">>),
653 308 {valid_behavior(Default), AlwaysJIDs, NeverJIDs}.
654
655
656 -spec valid_behavior(archive_behaviour_bin()) -> archive_behaviour().
657 98 valid_behavior(<<"always">>) -> always;
658 98 valid_behavior(<<"never">>) -> never;
659 112 valid_behavior(<<"roster">>) -> roster.
660
661
662 -spec parse_jid_list(exml:element(), binary()) -> [jid:literal_jid()].
663 parse_jid_list(El, Name) ->
664 616 case exml_query:subelement(El, Name) of
665 
:-(
 undefined -> [];
666 #xmlel{children = JIDEls} ->
667 %% Ignore cdata between jid elements
668 616 MaybeJids = [binary_jid_to_lower(exml_query:cdata(JIDEl))
669 616 || JIDEl <- JIDEls, is_jid_element(JIDEl)],
670 616 skip_bad_jids(MaybeJids)
671 end.
672
673 is_jid_element(#xmlel{name = <<"jid">>}) ->
674 364 true;
675 is_jid_element(_) -> %% ignore cdata
676 
:-(
 false.
677
678 %% @doc Normalize JID to be used when comparing JIDs in DB
679 binary_jid_to_lower(BinJid) when is_binary(BinJid) ->
680 364 Jid = jid:from_binary(BinJid),
681 364 case jid:to_lower(Jid) of
682 error ->
683 
:-(
 error;
684 LowerJid ->
685 364 jid:to_binary(LowerJid)
686 end.
687
688 skip_bad_jids(MaybeJids) ->
689 616 [Jid || Jid <- MaybeJids, is_binary(Jid)].
690
691 -spec form_borders_decode(mongoose_data_forms:kv_map()) -> 'undefined' | mod_mam:borders().
692 form_borders_decode(KVs) ->
693 1380 AfterID = form_field_mess_id(KVs, <<"after-id">>),
694 1380 BeforeID = form_field_mess_id(KVs, <<"before-id">>),
695 1380 FromID = form_field_mess_id(KVs, <<"from-id">>),
696 1359 ToID = form_field_mess_id(KVs, <<"to-id">>),
697 1359 borders(AfterID, BeforeID, FromID, ToID).
698
699
700 -spec borders(AfterID :: 'undefined' | non_neg_integer(),
701 BeforeID :: 'undefined' | non_neg_integer(),
702 FromID :: 'undefined' | non_neg_integer(),
703 ToID :: 'undefined' | non_neg_integer()
704 ) -> 'undefined' | mod_mam:borders().
705 borders(undefined, undefined, undefined, undefined) ->
706 1254 undefined;
707 borders(AfterID, BeforeID, FromID, ToID) ->
708 105 #mam_borders{
709 after_id = AfterID,
710 before_id = BeforeID,
711 from_id = FromID,
712 to_id = ToID
713 }.
714
715 -spec form_field_mess_id(mongoose_data_forms:kv_map(), binary()) -> 'undefined' | integer().
716 form_field_mess_id(KVs, Name) ->
717 5499 case KVs of
718 168 #{Name := [BExtMessID]} -> external_binary_to_mess_id(BExtMessID);
719 5331 #{} -> undefined
720 end.
721
722 -spec form_decode_optimizations(mongoose_data_forms:kv_map()) -> boolean().
723 form_decode_optimizations(#{<<"simple">> := [<<"true">>]}) ->
724 182 true;
725 form_decode_optimizations(#{}) ->
726 1170 false.
727
728 is_mam_result_message(Packet = #xmlel{name = <<"message">>}) ->
729 10 Ns = maybe_get_result_namespace(Packet),
730 10 is_mam_namespace(Ns);
731 is_mam_result_message(_) ->
732 
:-(
 false.
733
734 maybe_get_result_namespace(Packet) ->
735 10 exml_query:path(Packet, [{element, <<"result">>}, {attr, <<"xmlns">>}], <<>>).
736
737 is_mam_namespace(NS) ->
738 10 lists:member(NS, mam_features()).
739
740 features(Module, HostType) ->
741 89 mam_features() ++ retraction_features(Module, HostType)
742 ++ groupchat_features(Module, HostType).
743
744 mam_features() ->
745 99 [?NS_MAM_04, ?NS_MAM_06].
746
747 retraction_features(Module, HostType) ->
748 89 case has_message_retraction(Module, HostType) of
749 75 true -> [?NS_RETRACT, ?NS_RETRACT_TOMBSTONE, ?NS_ESL_RETRACT];
750 14 false -> [?NS_RETRACT]
751 end.
752
753 groupchat_features(mod_mam_pm = Module, HostType) ->
754 69 case gen_mod:get_module_opt(HostType, mod_mam, backend) of
755 
:-(
 cassandra -> [];
756 _ ->
757 69 case gen_mod:get_module_opt(HostType, Module, archive_groupchats) of
758 7 true -> [?NS_MAM_GC_FIELD, ?NS_MAM_GC_AVAILABLE];
759 62 false -> [?NS_MAM_GC_FIELD]
760 end
761 end;
762 groupchat_features(_, _) ->
763 20 [].
764
765 %% -----------------------------------------------------------------------
766 %% Forms
767
768 -spec message_form(Mod :: mod_mam_pm | mod_mam_muc,
769 HostType :: mongooseim:host_type(), binary()) ->
770 exml:element().
771 message_form(Module, HostType, MamNs) ->
772 35 Fields = message_form_fields(Module, HostType, MamNs),
773 35 Form = mongoose_data_forms:form(#{ns => MamNs, fields => Fields}),
774 35 result_query(Form, MamNs).
775
776 message_form_fields(Mod, HostType, <<"urn:xmpp:mam:1">>) ->
777 28 TextSearch =
778 case has_full_text_search(Mod, HostType) of
779 21 true -> [#{type => <<"text-single">>,
780 var => <<"{https://erlang-solutions.com/}full-text-search">>}];
781 7 false -> []
782 end,
783 28 [#{type => <<"jid-single">>, var => <<"with">>},
784 #{type => <<"text-single">>, var => <<"start">>},
785 #{type => <<"text-single">>, var => <<"end">>} | TextSearch];
786 message_form_fields(Mod, HostType, <<"urn:xmpp:mam:2">>) ->
787 7 TextSearch =
788 case has_full_text_search(Mod, HostType) of
789 7 true -> [#{type => <<"text-single">>,
790 var => <<"{https://erlang-solutions.com/}full-text-search">>}];
791 
:-(
 false -> []
792 end,
793 7 [#{type => <<"jid-single">>, var => <<"with">>},
794 #{type => <<"text-single">>, var => <<"start">>},
795 #{type => <<"text-single">>, var => <<"end">>},
796 #{type => <<"text-single">>, var => <<"before-id">>},
797 #{type => <<"text-single">>, var => <<"after-id">>},
798 #{type => <<"boolean">>, var => <<"include-groupchat">>} | TextSearch].
799
800 -spec form_to_text(_) -> 'undefined' | binary().
801 form_to_text(#{<<"full-text-search">> := [Text]}) ->
802 49 Text;
803 form_to_text(#{}) ->
804 1331 undefined.
805
806 %% -----------------------------------------------------------------------
807 %% Text search tokenization
808 %% -----------------------------------------------------------------------
809
810 %% -----------------------------------------------------------------------
811 %% @doc
812 %% Normalize given text to improve text search in some MAM backends.
813 %% This normalization involves making text all lowercase, replacing some word separators
814 %% ([, .:;-?!]) with given one (by default "%") and removing all unicode characters that are
815 %% considered non-alphanumerical.
816 %% For example, text: "My cat, was eaten by: my dog?!? Why...?!?" will be normalized as:
817 %% "my%cat%was%eaten%by%my%dog%why"
818 %% @end
819 %% -----------------------------------------------------------------------
820 -spec normalize_search_text(binary() | undefined) -> binary() | undefined.
821 normalize_search_text(Text) ->
822 1548 normalize_search_text(Text, <<"%">>).
823
824 -spec normalize_search_text(binary() | undefined, binary()) -> binary() | undefined.
825 normalize_search_text(undefined, _WordSeparator) ->
826 1506 undefined;
827 normalize_search_text(Text, WordSeparator) ->
828 10272 BodyString = unicode:characters_to_list(Text),
829 10272 LowerBody = string:to_lower(BodyString),
830 10272 ReOpts = [{return, list}, global, unicode, ucp],
831 10272 Re0 = re:replace(LowerBody, "[, .:;-?!]+", " ", ReOpts),
832 10272 Re1 = re:replace(Re0, "([^\\w ]+)|(^\\s+)|(\\s+$)", "", ReOpts),
833 10272 Re2 = re:replace(Re1, "\s+", unicode:characters_to_list(WordSeparator), ReOpts),
834 10272 unicode:characters_to_binary(Re2).
835
836 -spec packet_to_search_body(Enabled :: boolean(),
837 Packet :: exml:element()) -> binary().
838 packet_to_search_body(true, Packet) ->
839 10230 BodyValue = exml_query:path(Packet, [{element, <<"body">>}, cdata], <<>>),
840 10230 mod_mam_utils:normalize_search_text(BodyValue, <<" ">>);
841 packet_to_search_body(false, _Packet) ->
842 
:-(
 <<>>.
843
844 -spec has_full_text_search(Module :: mod_mam_pm | mod_mam_muc,
845 HostType :: mongooseim:host_type()) -> boolean().
846 has_full_text_search(Module, HostType) ->
847 17120 gen_mod:get_module_opt(HostType, Module, full_text_search).
848
849 %% Message retraction
850
851 -spec has_message_retraction(Module :: mod_mam_pm | mod_mam_muc,
852 HostType :: mongooseim:host_type()) -> boolean().
853 has_message_retraction(Module, HostType) ->
854 17174 gen_mod:get_module_opt(HostType, Module, message_retraction).
855
856 %% -----------------------------------------------------------------------
857 %% JID serialization
858
859 -spec jid_to_opt_binary(UserJID :: jid:jid(), JID :: jid:jid()
860 ) -> jid:literal_jid().
861 jid_to_opt_binary(#jid{lserver = LServer},
862 #jid{lserver = LServer, luser = <<>>, lresource = <<>>}) ->
863 
:-(
 <<$:>>;
864 jid_to_opt_binary(#jid{lserver = LServer, luser = LUser},
865 #jid{lserver = LServer, luser = LUser, lresource = <<>>}) ->
866 2287 <<>>;
867 jid_to_opt_binary(#jid{lserver = LServer, luser = LUser},
868 #jid{lserver = LServer, luser = LUser, lresource = LResource}) ->
869 1015 <<$/, LResource/binary>>;
870 jid_to_opt_binary(#jid{lserver = LServer},
871 #jid{lserver = LServer, luser = LUser, lresource = <<>>}) ->
872 %% Both clients are on the same server.
873 8722 <<LUser/binary>>;
874 jid_to_opt_binary(#jid{lserver = LServer},
875 #jid{lserver = LServer, luser = <<>>, lresource = LResource}) ->
876 %% Both clients are on the same server.
877 
:-(
 <<$:, $/, LResource/binary>>;
878 jid_to_opt_binary(#jid{lserver = LServer},
879 #jid{lserver = LServer, luser = LUser, lresource = LResource}) ->
880 %% Both clients are on the same server.
881 928 <<LUser/binary, $/, LResource/binary>>;
882 jid_to_opt_binary(_,
883 #jid{lserver = LServer, luser = LUser, lresource = <<>>}) ->
884 319 <<LServer/binary, $:, LUser/binary>>;
885 jid_to_opt_binary(_,
886 #jid{lserver = LServer, luser = LUser, lresource = LResource}) ->
887 138 <<LServer/binary, $@, LUser/binary, $/, LResource/binary>>.
888
889
890 -spec expand_minified_jid(UserJID :: jid:jid(),
891 OptJID :: jid:literal_jid()) -> jid:literal_jid().
892 expand_minified_jid(#jid{lserver = LServer, luser = LUser}, <<>>) ->
893 438 <<LUser/binary, $@, LServer/binary>>;
894 expand_minified_jid(#jid{lserver = LServer, luser = <<>>}, <<$/, LResource/binary>>) ->
895 
:-(
 <<LServer/binary, $/, LResource/binary>>;
896 expand_minified_jid(#jid{lserver = LServer, luser = LUser}, <<$/, LResource/binary>>) ->
897 1902 <<LUser/binary, $@, LServer/binary, $/, LResource/binary>>;
898 expand_minified_jid(UserJID, Encoded) ->
899 426 Part = binary:match(Encoded, [<<$@>>, <<$/>>, <<$:>>]),
900 426 expand_minified_jid(Part, UserJID, Encoded).
901
902 -spec expand_minified_jid('nomatch' | {non_neg_integer(), 1}, jid:jid(),
903 Encoded :: jid:luser() | binary()) -> binary().
904 expand_minified_jid(nomatch, #jid{lserver = ThisServer}, LUser) ->
905 22 <<LUser/binary, $@, ThisServer/binary>>;
906 expand_minified_jid({Pos, 1}, #jid{lserver = ThisServer}, Encoded) ->
907 404 case Encoded of
908 <<$:, $/, LResource/binary>> ->
909 
:-(
 <<ThisServer/binary, $/, LResource/binary>>;
910 <<$:>> ->
911 
:-(
 ThisServer;
912 <<LServer:Pos/binary, $:>> ->
913 
:-(
 <<LServer/binary>>;
914 <<LServer:Pos/binary, $:, LUser/binary>> ->
915 48 <<LUser/binary, $@, LServer/binary>>;
916 <<LServer:Pos/binary, $@, $/, LResource/binary>> ->
917 
:-(
 <<LServer/binary, $/, LResource/binary>>;
918 <<LServer:Pos/binary, $@, Tail/binary>> ->
919 59 [LUser, LResource] = binary:split(Tail, <<$/>>),
920 59 <<LUser/binary, $@, LServer/binary, $/, LResource/binary>>;
921 <<LUser:Pos/binary, $/, LResource/binary>> ->
922 297 <<LUser/binary, $@, ThisServer/binary, $/, LResource/binary>>
923 end.
924
925 -ifdef(TEST).
926
927 jid_to_opt_binary_test_() ->
928 check_stringprep(),
929 UserJID = jid:from_binary(<<"alice@room">>),
930 [?_assertEqual(JID,
931 (expand_minified_jid(UserJID,
932 jid_to_opt_binary(UserJID, jid:from_binary(JID)))))
933 || JID <- test_jids()].
934
935 test_jids() ->
936 [<<"alice@room">>,
937 <<"alice@room/computer">>,
938 <<"alice@street/mobile">>,
939 <<"bob@room">>,
940 <<"bob@room/mobile">>,
941 <<"bob@street">>,
942 <<"bob@street/mobile">>].
943
944 check_stringprep() ->
945 is_loaded_application(jid) orelse start_stringprep().
946
947 start_stringprep() ->
948 EJ = code:lib_dir(mongooseim),
949 code:add_path(filename:join([EJ, "..", "..", "deps", "jid", "ebin"])),
950 {ok, _} = application:ensure_all_started(jid).
951
952 is_loaded_application(AppName) when is_atom(AppName) ->
953 lists:keymember(AppName, 1, application:loaded_applications()).
954
955 -endif.
956
957 %% -----------------------------------------------------------------------
958 %% Other
959 -spec bare_jid(undefined | jid:jid()) -> undefined | binary().
960 
:-(
 bare_jid(undefined) -> undefined;
961 bare_jid(JID) ->
962 
:-(
 jid:to_bare_binary(jid:to_lower(JID)).
963
964 -spec full_jid(jid:jid()) -> binary().
965 full_jid(JID) ->
966 
:-(
 jid:to_binary(jid:to_lower(JID)).
967
968 -spec maybe_integer(binary(), Default :: integer()) -> integer().
969 694 maybe_integer(<<>>, Def) -> Def;
970 maybe_integer(Bin, _Def) when is_binary(Bin) ->
971 686 binary_to_integer(Bin).
972
973 -spec apply_start_border('undefined' | mod_mam:borders(), undefined | integer()) ->
974 undefined | integer().
975 apply_start_border(undefined, StartID) ->
976 1443 StartID;
977 apply_start_border(#mam_borders{after_id=AfterID, from_id=FromID}, StartID) ->
978 105 maybe_max(maybe_next_id(AfterID), maybe_max(FromID, StartID)).
979
980
981 -spec apply_end_border('undefined' | mod_mam:borders(), undefined | integer()) ->
982 undefined | integer().
983 apply_end_border(undefined, EndID) ->
984 1443 EndID;
985 apply_end_border(#mam_borders{before_id=BeforeID, to_id=ToID}, EndID) ->
986 105 maybe_min(maybe_previous_id(BeforeID), maybe_min(ToID, EndID)).
987
988 -spec calculate_msg_id_borders(mod_mam:borders() | undefined,
989 mod_mam:unix_timestamp() | undefined,
990 mod_mam:unix_timestamp() | undefined) -> R when
991 R :: {integer() | undefined, integer() | undefined}.
992 calculate_msg_id_borders(Borders, Start, End) ->
993 
:-(
 StartID = maybe_encode_compact_uuid(Start, 0),
994 
:-(
 EndID = maybe_encode_compact_uuid(End, 255),
995 
:-(
 {apply_start_border(Borders, StartID),
996 apply_end_border(Borders, EndID)}.
997
998 -spec calculate_msg_id_borders(RSM, Borders, Start, End) -> R when
999 RSM :: jlib:rsm_in() | undefined,
1000 Borders :: mod_mam:borders() | undefined,
1001 Start :: mod_mam:unix_timestamp() | undefined,
1002 End :: mod_mam:unix_timestamp() | undefined,
1003 R :: {integer() | undefined, integer() | undefined}.
1004 calculate_msg_id_borders(undefined, Borders, Start, End) ->
1005 
:-(
 calculate_msg_id_borders(Borders, Start, End);
1006 calculate_msg_id_borders(#rsm_in{id = undefined}, Borders, Start, End) ->
1007 
:-(
 calculate_msg_id_borders(Borders, Start, End);
1008 calculate_msg_id_borders(#rsm_in{direction = aft, id = Id}, Borders, Start, End)
1009 when Id =/= undefined ->
1010 
:-(
 {StartId, EndId} = mod_mam_utils:calculate_msg_id_borders(Borders, Start, End),
1011 
:-(
 {mod_mam_utils:maybe_max(StartId, Id), EndId};
1012 calculate_msg_id_borders(#rsm_in{direction = before, id = Id}, Borders, Start, End)
1013 when Id =/= undefined ->
1014 
:-(
 {StartId, EndId} = mod_mam_utils:calculate_msg_id_borders(Borders, Start, End),
1015 
:-(
 {StartId, mod_mam_utils:maybe_min(EndId, Id)}.
1016
1017 -spec maybe_encode_compact_uuid(mod_mam:unix_timestamp() | undefined, integer()) ->
1018 undefined | integer().
1019 maybe_encode_compact_uuid(undefined, _) ->
1020 
:-(
 undefined;
1021 maybe_encode_compact_uuid(Microseconds, NodeID) ->
1022 
:-(
 mod_mam_utils:encode_compact_uuid(Microseconds, NodeID).
1023
1024
1025 -spec maybe_min('undefined' | integer(), undefined | integer()) -> integer().
1026 maybe_min(undefined, Y) ->
1027 168 Y;
1028 maybe_min(X, undefined) ->
1029 42 X;
1030 maybe_min(X, Y) ->
1031 
:-(
 min(X, Y).
1032
1033
1034 -spec maybe_max('undefined' | integer(), undefined | integer()) -> integer().
1035 maybe_max(undefined, Y) ->
1036 105 Y;
1037 maybe_max(X, undefined) ->
1038 105 X;
1039 maybe_max(X, Y) ->
1040 
:-(
 max(X, Y).
1041
1042 -spec maybe_last([T]) -> undefined | {ok, T}.
1043 21 maybe_last([]) -> undefined;
1044 49 maybe_last([_|_] = L) -> {ok, lists:last(L)}.
1045
1046 -spec maybe_next_id('undefined' | non_neg_integer()) -> 'undefined' | pos_integer().
1047 maybe_next_id(undefined) ->
1048 
:-(
 undefined;
1049 maybe_next_id(X) ->
1050 105 X + 1.
1051
1052 -spec maybe_previous_id('undefined' | non_neg_integer()) -> 'undefined' | integer().
1053 maybe_previous_id(undefined) ->
1054 63 undefined;
1055 maybe_previous_id(X) ->
1056 42 X - 1.
1057
1058
1059 %% @doc Returns true, if the current page is the final one in the result set.
1060 %% If there are more pages with messages, than this function returns false.
1061 %%
1062 %% PageSize - maximum number of messages extracted in one lookup.
1063 %% TotalCount - total number of messages in the Result Set.
1064 %% Result Set - is subset of all messages in user's archive,
1065 %% in a specified time period.
1066 %% MessageRows - stuff we are about to send to the user.
1067 %% Params - lookup parameters, coming from mam_iq module.
1068 %%
1069 %% TotalCount and Offset can be undefined, in case we use IsSimple=true.
1070 %% IsSimple=true tells the server not to do heavy `SELECT COUNT(*)' queries.
1071 %%
1072 %% TODO It is possible to set complete flag WITH IsSimple=true,
1073 %% if we select one extra message from archive, but don't send it to the client.
1074 %% It's the most efficient way to query archive, if the client side does
1075 %% not care about the total number of messages and if it's stateless
1076 %% (i.e. web interface).
1077 %% Handles case when we have TotalCount and Offset as integers
1078 -spec is_complete_result_page_using_offset(Params, Result) ->
1079 boolean() when
1080 Params :: mam_iq:lookup_params(),
1081 Result :: mod_mam:lookup_result_map().
1082 is_complete_result_page_using_offset(#{page_size := PageSize} = Params,
1083 #{total_count := TotalCount, offset := Offset,
1084 messages := MessageRows})
1085 when is_integer(TotalCount), is_integer(Offset) ->
1086 1107 case maps:get(ordering_direction, Params, forward) of
1087 forward ->
1088 925 is_most_recent_page(PageSize, TotalCount, Offset, MessageRows);
1089 backward ->
1090 182 Offset =:= 0
1091 end.
1092
1093 %% @doc Returns true, if the current page contains the most recent messages.
1094 %% If there are some more recent messages in archive, this function returns false.
1095 -spec is_most_recent_page(PageSize, TotalCount, Offset, MessageRows) -> boolean() when
1096 PageSize :: non_neg_integer(),
1097 TotalCount :: non_neg_integer()|undefined,
1098 Offset :: non_neg_integer()|undefined,
1099 MessageRows :: list().
1100 is_most_recent_page(PageSize, _TotalCount, _Offset, MessageRows)
1101 when length(MessageRows) < PageSize ->
1102 715 true;
1103 is_most_recent_page(PageSize, TotalCount, Offset, MessageRows)
1104 when is_integer(TotalCount), is_integer(Offset),
1105 length(MessageRows) =:= PageSize ->
1106 %% Number of messages on skipped pages from the beginning plus the current page
1107 210 PagedCount = Offset + PageSize,
1108 210 TotalCount =:= PagedCount; %% false means full page but not the last one in the result set
1109 is_most_recent_page(_PageSize, _TotalCount, _Offset, _MessageRows) ->
1110 %% When is_integer(TotalCount), is_integer(Offset)
1111 %% it's not possible case: the page is bigger than page size.
1112 %% Otherwise either TotalCount or Offset is undefined because of optimizations.
1113 
:-(
 false.
1114
1115 -spec maybe_set_client_xmlns(boolean(), exml:element()) -> exml:element().
1116 maybe_set_client_xmlns(true, Packet) ->
1117 4430 xml:replace_tag_attr(<<"xmlns">>, <<"jabber:client">>, Packet);
1118 maybe_set_client_xmlns(false, Packet) ->
1119 
:-(
 Packet.
1120
1121 -spec action_to_shaper_name(mam_iq:action()) -> atom().
1122 action_to_shaper_name(Action) ->
1123 1926 list_to_atom(atom_to_list(Action) ++ "_shaper").
1124
1125 -spec action_to_global_shaper_name(mam_iq:action()) -> atom().
1126 action_to_global_shaper_name(Action) ->
1127 1926 list_to_atom(atom_to_list(Action) ++ "_global_shaper").
1128
1129 -spec wait_shaper(mongooseim:host_type(), jid:server(), mam_iq:action(), jid:jid()) ->
1130 continue | {error, max_delay_reached}.
1131 wait_shaper(HostType, Host, Action, From) ->
1132 1926 case mongoose_shaper:wait(
1133 HostType, Host, action_to_shaper_name(Action), From, 1) of
1134 continue ->
1135 1926 mongoose_shaper:wait(
1136 global, Host, action_to_global_shaper_name(Action), From, 1);
1137 {error, max_delay_reached} ->
1138 
:-(
 {error, max_delay_reached}
1139 end.
1140
1141 %% -----------------------------------------------------------------------
1142 %% Ejabberd
1143
1144 -spec send_message(mod_mam:message_row(), jid:jid(), jid:jid(), exml:element()) -> mongoose_acc:t().
1145 send_message(_Row, From, To, Mess) ->
1146 4430 ejabberd_sm:route(From, To, Mess).
1147
1148 -spec is_jid_in_user_roster(mongooseim:host_type(), jid:jid(), jid:jid()) -> boolean().
1149 is_jid_in_user_roster(HostType, #jid{} = ToJID, #jid{} = RemJID) ->
1150 84 RemBareJID = jid:to_bare(RemJID),
1151 84 {Subscription, _G} = mongoose_hooks:roster_get_jid_info(HostType, ToJID, RemBareJID),
1152 84 Subscription == from orelse Subscription == both.
1153
1154 %% @doc Returns a UUIDv4 canonical form binary.
1155 -spec wrapper_id() -> binary().
1156 wrapper_id() ->
1157 4430 uuid:uuid_to_string(uuid:get_v4(), binary_standard).
1158
1159
1160 -spec check_result_for_policy_violation(Params, Result) -> Result when
1161 Params :: mam_iq:lookup_params(),
1162 Result :: {ok, mod_mam:lookup_result()}
1163 | {error, 'policy-violation'}
1164 | {error, Reason :: term()}.
1165 check_result_for_policy_violation(
1166 _Params = #{limit_passed := LimitPassed,
1167 max_result_limit := MaxResultLimit},
1168 Result = {ok, {TotalCount, Offset, _MessageRows}})
1169 when is_integer(TotalCount), is_integer(Offset) ->
1170 1107 case is_policy_violation(TotalCount, Offset, MaxResultLimit, LimitPassed) of
1171 true ->
1172 
:-(
 {error, 'policy-violation'};
1173 false ->
1174 1107 Result
1175 end;
1176 check_result_for_policy_violation(_Params, Result) ->
1177 392 Result.
1178
1179 is_policy_violation(TotalCount, Offset, MaxResultLimit, LimitPassed) ->
1180 1107 TotalCount - Offset > MaxResultLimit andalso not LimitPassed.
1181
1182 %% @doc Check for XEP-313 `item-not-found' error condition,
1183 %% that is if a message ID passed in a `before'/`after' query is actually present in the archive.
1184 %% See https://xmpp.org/extensions/xep-0313.html#query-paging for details.
1185 %%
1186 %% In a backend it's reasonable to query for PageSize + 1 messages,
1187 %% so that once the interval endpoint with requested ID is discarded we actually
1188 %% return (up to) PageSize messages.
1189 %% @end
1190 -spec check_for_item_not_found(RSM, PageSize, LookupResult) -> R when
1191 RSM :: jlib:rsm_in() | undefined,
1192 PageSize :: non_neg_integer(),
1193 LookupResult :: mod_mam:lookup_result(),
1194 R :: {ok, mod_mam:lookup_result()} | {error, item_not_found}.
1195 check_for_item_not_found(#rsm_in{direction = before, id = ID},
1196 _PageSize, {TotalCount, Offset, MessageRows}) ->
1197 70 case maybe_last(MessageRows) of
1198 {ok, #{id := ID}} ->
1199 49 {ok, {TotalCount, Offset, lists:droplast(MessageRows)}};
1200 undefined ->
1201 21 {error, item_not_found}
1202 end;
1203 check_for_item_not_found(#rsm_in{direction = aft, id = ID},
1204 _PageSize, {TotalCount, Offset, MessageRows0}) ->
1205 91 case MessageRows0 of
1206 [#{id := ID} | MessageRows] ->
1207 70 {ok, {TotalCount, Offset, MessageRows}};
1208 _ ->
1209 21 {error, item_not_found}
1210 end.
1211
1212 -spec lookup(HostType :: mongooseim:host_type(),
1213 Params :: mam_iq:lookup_params(),
1214 F :: fun()) ->
1215 {ok, mod_mam:lookup_result_map()} | {error, Reason :: term()}.
1216 lookup(HostType, Params, F) ->
1217 1429 F1 = patch_fun_to_make_result_as_map(F),
1218 1429 process_lookup_with_complete_check(HostType, Params, F1).
1219
1220 process_lookup_with_complete_check(HostType, Params = #{is_simple := true}, F) ->
1221 259 process_simple_lookup_with_complete_check(HostType, Params, F);
1222 process_lookup_with_complete_check(HostType, Params, F) ->
1223 1170 case F(HostType, Params) of
1224 {ok, Result} ->
1225 1107 IsComplete = is_complete_result_page_using_offset(Params, Result),
1226 1107 {ok, Result#{is_complete => IsComplete}};
1227 Other ->
1228 63 Other
1229 end.
1230
1231 -spec lookup_first_and_last_messages(mongooseim:host_type(), mod_mam:archive_id(),
1232 jid:jid(), fun()) ->
1233 {mod_mam:message_row(), mod_mam:message_row()} | {error, term()} | empty_archive.
1234 lookup_first_and_last_messages(HostType, ArcID, ArcJID, F) ->
1235 21 lookup_first_and_last_messages(HostType, ArcID, ArcJID, ArcJID, F).
1236
1237 -spec lookup_first_and_last_messages(mongooseim:host_type(), mod_mam:archive_id(), jid:jid(),
1238 jid:jid(), fun()) ->
1239 {mod_mam:message_row(), mod_mam:message_row()} | {error, term()} | empty_archive.
1240 lookup_first_and_last_messages(HostType, ArcID, CallerJID, OwnerJID, F) ->
1241 42 FirstMsgParams = create_lookup_params(undefined, forward, ArcID, CallerJID, OwnerJID),
1242 42 LastMsgParams = create_lookup_params(#rsm_in{direction = before},
1243 backward, ArcID, CallerJID, OwnerJID),
1244 42 case lookup(HostType, FirstMsgParams, F) of
1245 {ok, #{messages := [FirstMsg]}} ->
1246 28 case lookup(HostType, LastMsgParams, F) of
1247 28 {ok, #{messages := [LastMsg]}} -> {FirstMsg, LastMsg};
1248 
:-(
 ErrorLast -> ErrorLast
1249 end;
1250 14 {ok, #{messages := []}} -> empty_archive;
1251 
:-(
 ErrorFirst -> ErrorFirst
1252 end.
1253
1254 -spec create_lookup_params(jlib:rsm_in() | undefined,
1255 backward | forward,
1256 mod_mam:archive_id(),
1257 jid:jid(),
1258 jid:jid()) -> mam_iq:lookup_params().
1259 create_lookup_params(RSM, Direction, ArcID, CallerJID, OwnerJID) ->
1260 84 #{now => erlang:system_time(microsecond),
1261 is_simple => true,
1262 rsm => RSM,
1263 max_result_limit => 1,
1264 archive_id => ArcID,
1265 owner_jid => OwnerJID,
1266 search_text => undefined,
1267 with_jid => undefined,
1268 start_ts => undefined,
1269 page_size => 1,
1270 end_ts => undefined,
1271 borders => undefined,
1272 flip_page => false,
1273 ordering_direction => Direction,
1274 limit_passed => true,
1275 caller_jid => CallerJID,
1276 message_ids => undefined}.
1277
1278 patch_fun_to_make_result_as_map(F) ->
1279 1429 fun(HostType, Params) -> result_to_map(F(HostType, Params)) end.
1280
1281 result_to_map({ok, {TotalCount, Offset, MessageRows}}) ->
1282 1366 {ok, #{total_count => TotalCount, offset => Offset, messages => MessageRows}};
1283 result_to_map(Other) ->
1284 63 Other.
1285
1286 %% We query an extra message by changing page_size.
1287 %% After that we remove this message from the result set when returning.
1288 process_simple_lookup_with_complete_check(HostType, Params = #{page_size := PageSize}, F) ->
1289 259 Params2 = Params#{page_size => PageSize + 1},
1290 259 case F(HostType, Params2) of
1291 {ok, Result} ->
1292 259 {ok, set_complete_result_page_using_extra_message(PageSize, Params, Result)};
1293 Other ->
1294 
:-(
 Other
1295 end.
1296
1297 set_complete_result_page_using_extra_message(PageSize, Params, Result = #{messages := MessageRows}) ->
1298 259 case length(MessageRows) =:= (PageSize + 1) of
1299 true ->
1300 91 Result#{is_complete => false, messages => remove_extra_message(Params, MessageRows)};
1301 false ->
1302 168 Result#{is_complete => true}
1303 end.
1304
1305 remove_extra_message(Params, Messages) ->
1306 91 case maps:get(ordering_direction, Params, forward) of
1307 forward ->
1308 35 lists:droplast(Messages);
1309 backward ->
1310 56 tl(Messages)
1311 end.
1312
1313 -spec db_jid_codec(mongooseim:host_type(), module()) -> module().
1314 db_jid_codec(HostType, Module) ->
1315 17085 gen_mod:get_module_opt(HostType, Module, db_jid_format).
1316
1317 -spec db_message_codec(mongooseim:host_type(), module()) -> module().
1318 db_message_codec(HostType, Module) ->
1319 17085 gen_mod:get_module_opt(HostType, Module, db_message_format).
1320
1321 -spec incremental_delete_domain(
1322 mongooseim:host_type(), jid:lserver(), non_neg_integer(), [atom()], non_neg_integer()) ->
1323 non_neg_integer().
1324 incremental_delete_domain(_HostType, _Domain, _Limit, [], TotalDeleted) ->
1325 5 TotalDeleted;
1326 incremental_delete_domain(HostType, Domain, Limit, [Query | MoreQueries] = AllQueries, TotalDeleted) ->
1327 26 R1 = mongoose_rdbms:execute_successfully(HostType, Query, [Domain]),
1328 26 case is_removing_done(R1, Limit) of
1329 {done, N} ->
1330 11 incremental_delete_domain(HostType, Domain, Limit, MoreQueries, N + TotalDeleted);
1331 {remove_more, N} ->
1332 15 incremental_delete_domain(HostType, Domain, Limit, AllQueries, N + TotalDeleted)
1333 end.
1334
1335 -spec is_removing_done(LastResult :: {updated, non_neg_integer()}, Limit :: non_neg_integer()) ->
1336 {done | remove_more, non_neg_integer()}.
1337 is_removing_done({updated, N}, Limit) when N < Limit ->
1338 11 {done, N};
1339 is_removing_done({updated, N}, _)->
1340 15 {remove_more, N}.
1341
1342 -spec is_mam_muc_enabled(jid:lserver(), mongooseim:host_type()) -> boolean().
1343 is_mam_muc_enabled(MucDomain, HostType) ->
1344 617 HostPattern = mongoose_config:get_opt([{modules, HostType}, mod_mam_muc, host]),
1345 617 {ok, #{subdomain_pattern := SubDomainPattern}} =
1346 mongoose_domain_api:get_subdomain_info(MucDomain),
1347 617 HostPattern =:= SubDomainPattern.
Line Hits Source