>),
+ mongoose_data_forms:form_type_field(?NS_MUC_CONFIG),
stringxfield(<<"Room title">>,
<<"muc#roomconfig_roomname">>,
Config#config.title, Lang),
@@ -3420,50 +3420,20 @@ get_config(Lang, StateData, From) ->
InstructionsTxt = translate:translate(
Lang, <<"You need an x:data capable client to configure room">>),
{result, [#xmlel{name = <<"instructions">>, children = [#xmlcdata{content = InstructionsTxt}]},
- #xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA},
- {<<"type">>, <<"form">>}],
- children = Res}],
+ mongoose_data_forms:form(Res)],
StateData}.
-spec getmemberlist_field(Lang :: ejabberd:lang()) -> exml:element().
getmemberlist_field(Lang) ->
LabelTxt = translate:translate(
Lang, <<"Roles and affiliations that may retrieve member list">>),
- OptModerator = #xmlel{name = <<"option">>,
- attrs = [{<<"label">>, translate:translate(Lang, <<"moderator">>)}],
- children = [
- #xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"moderator">>}]}
- ]},
- OptParticipant = #xmlel{name = <<"option">>,
- attrs = [{<<"label">>, translate:translate(Lang, <<"participant">>)}],
- children = [
- #xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"participant">>}]}
- ]},
- OptVisitor = #xmlel{name = <<"option">>,
- attrs = [{<<"label">>, translate:translate(Lang, <<"visitor">>)}],
- children = [
- #xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"visitor">>}]}
- ]},
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, <<"list-multi">>},
- {<<"label">>, LabelTxt},
- {<<"var">>, <<"muc#roomconfig_getmemberlist">>}],
- children = [
- #xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"moderator">>}]},
- #xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"participant">>}]},
- #xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"visitor">>}]},
- OptModerator,
- OptParticipant,
- OptVisitor
- ]
- }.
+ Values = [<<"moderator">>, <<"participant">>, <<"visitor">>],
+ Options = [{translate:translate(Lang, Opt), Opt} || Opt <- Values],
+ mongoose_data_forms:form_field(#{type => <<"list-multi">>,
+ label => LabelTxt,
+ var => <<"muc#roomconfig_getmemberlist">>,
+ values => Values,
+ options => Options}).
maxusers_field(Lang, StateData) ->
ServiceMaxUsers = get_service_max_users(StateData),
@@ -3474,76 +3444,51 @@ maxusers_field(Lang, StateData) ->
{N, integer_to_binary(N)};
_ -> {0, <<"none">>}
end,
-
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, <<"list-single">>},
- {<<"label">>, translate:translate(Lang, <<"Maximum Number of Occupants">>)},
- {<<"var">>, <<"muc#roomconfig_maxusers">>}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = MaxUsersRoomString}]}] ++
- if
- is_integer(ServiceMaxUsers) -> [];
- true ->
- [#xmlel{name = <<"option">>,
- attrs = [{<<"label">>, translate:translate(Lang, <<"No limit">>)}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"none">>}]}]}]
- end ++
- [#xmlel{name = <<"option">>,
- attrs = [{<<"label">>, integer_to_binary(N)}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = integer_to_binary(N)}]}]} ||
+ LabelTxt = translate:translate(Lang, <<"Maximum Number of Occupants">>),
+ Options = if
+ is_integer(ServiceMaxUsers) -> [];
+ true -> {translate:translate(Lang, <<"No limit">>), <<"none">>}
+ end ++
+ [integer_to_binary(N) ||
N <- lists:usort([ServiceMaxUsers, DefaultRoomMaxUsers, MaxUsersRoomInteger |
- ?MAX_USERS_DEFAULT_LIST]), N =< ServiceMaxUsers]}.
+ ?MAX_USERS_DEFAULT_LIST]), N =< ServiceMaxUsers],
+ mongoose_data_forms:form_field(#{type => <<"list-single">>,
+ label => LabelTxt,
+ var => <<"muc#roomconfig_maxusers">>,
+ values => [MaxUsersRoomString],
+ options => Options}).
-spec whois_field(Lang :: ejabberd:lang(), Config :: config()) -> exml:element().
whois_field(Lang, Config) ->
- OptModerators = #xmlel{name = <<"option">>,
- attrs = [{<<"label">>,
- translate:translate(Lang, <<"moderators only">>)}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"moderators">>}]}]},
- OptAnyone = #xmlel{name = <<"option">>,
- attrs = [{<<"label">>, translate:translate(Lang, <<"anyone">>)}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = <<"anyone">>}]}]},
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, <<"list-single">>},
- {<<"label">>, translate:translate(Lang, <<"Present real Jabber IDs to">>)},
- {<<"var">>, <<"muc#roomconfig_whois">>}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = if Config#config.anonymous ->
- <<"moderators">>;
- true ->
- <<"anyone">>
- end}]},
- OptModerators,
- OptAnyone]}.
-
--spec set_config(exml:element(), state()) -> any().
-set_config(XEl, StateData) ->
- XData = jlib:parse_xdata_submit(XEl),
- case XData of
- invalid ->
- {error, mongoose_xmpp_errors:bad_request()};
- _ ->
- case set_xoption(XData, StateData#state.config) of
- #config{} = Config ->
- Res = change_config(Config, StateData),
- {result, _, NSD} = Res,
- PrevLogging = (StateData#state.config)#config.logging,
- NewLogging = Config#config.logging,
- PrevAnon = (StateData#state.config)#config.anonymous,
- NewAnon = Config#config.anonymous,
- Type = notify_config_change_and_get_type(PrevLogging, NewLogging,
- PrevAnon, NewAnon, StateData),
+ Value = if Config#config.anonymous -> <<"moderators">>;
+ true -> <<"anyone">>
+ end,
+ Options = [{translate:translate(Lang, <<"moderators only">>), <<"moderators">>},
+ {translate:translate(Lang, <<"anyone">>), <<"anyone">>}],
+ mongoose_data_forms:form_field(#{type => <<"list-single">>,
+ label => translate:translate(Lang, <<"moderators only">>),
+ var => <<"muc#roomconfig_whois">>,
+ values => [Value],
+ options => Options}).
+
+-spec set_config([{binary(), [binary()]}], state()) -> any().
+set_config(XData, StateData) ->
+ case set_xoption(XData, StateData#state.config) of
+ #config{} = Config ->
+ Res = change_config(Config, StateData),
+ {result, _, NSD} = Res,
+ PrevLogging = (StateData#state.config)#config.logging,
+ NewLogging = Config#config.logging,
+ PrevAnon = (StateData#state.config)#config.anonymous,
+ NewAnon = Config#config.anonymous,
+ Type = notify_config_change_and_get_type(PrevLogging, NewLogging,
+ PrevAnon, NewAnon, StateData),
Users = [{U#user.jid, U#user.nick, U#user.role} ||
- {_, U} <- maps:to_list(StateData#state.users)],
- add_to_log(Type, Users, NSD),
- Res;
+ {_, U} <- maps:to_list(StateData#state.users)],
+ add_to_log(Type, Users, NSD),
+ Res;
Err ->
- Err
- end
+ Err
end.
-spec notify_config_change_and_get_type(PrevLogging :: boolean(), NewLogging :: boolean(),
@@ -3986,10 +3931,10 @@ disco_item(User=#user{nick=Nick}, RoomJID) ->
| {role, BRole :: binary(), RoomNick :: mod_muc:nick()}
| {error, any()}
| ok.
-check_voice_approval(From, [#xmlel{name = <<"x">>,
- children = Items}], _Lang, StateData) ->
- BRole = get_field(<<"muc#role">>, Items),
- case Items of
+check_voice_approval(From, [XEl], _Lang, StateData) ->
+ Fields = mongoose_data_forms:form_to_kvs(XEl),
+ [BRole] = proplists:get_value(<<"muc#role">>, Fields, [undefined]),
+ case Fields of
[_Form, _Role] ->
case catch binary_to_role(BRole) of
{'EXIT', _} -> {error, mongoose_xmpp_errors:bad_request()};
@@ -3997,31 +3942,15 @@ check_voice_approval(From, [#xmlel{name = <<"x">>,
end;
_ ->
case {get_role(From, StateData),
- get_field(<<"muc#request_allow">>, Items),
- get_field(<<"muc#roomnick">>, Items)} of
- {moderator, <<"true">>, false} -> {error, mongoose_xmpp_errors:bad_request()};
- {moderator, <<"true">>, RoomNick} -> {role, BRole, RoomNick};
+ proplists:get_value(<<"muc#request_allow">>, Fields),
+ proplists:get_value(<<"muc#roomnick">>, Fields)} of
+ {moderator, [<<"true">>], undefined} -> {error, mongoose_xmpp_errors:bad_request()};
+ {moderator, [<<"true">>], [RoomNick]} -> {role, BRole, RoomNick};
{moderator, _, _} -> ok;
_ -> {error, mongoose_xmpp_errors:not_allowed()}
end
end.
-
--spec get_field(binary(), [jlib:xmlcdata() | exml:element()]) -> any().
-get_field(Var, [#xmlel{name = <<"field">>, attrs = Attrs} = Item|Items])
- when is_binary(Var) ->
- case xml:get_attr(<<"var">>, Attrs) of
- {value, Var} ->
- case xml:get_path_s(Item, [{elem, <<"value">>}, cdata]) of
- <<>> -> get_field(Var, Items);
- Value -> Value
- end;
- _ ->
- get_field(Var, Items)
- end;
-get_field(_Var, []) ->
- false.
-
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%% Invitation support
@@ -4421,7 +4350,7 @@ route_voice_approval({error, ErrType}, From, Packet, _Lang, StateData) ->
StateData;
route_voice_approval({form, RoleName}, From, _Packet, _Lang, StateData) ->
{Nick, _} = get_participant_data(From, StateData),
- ApprovalForm = jlib:make_voice_approval_form(From, Nick, RoleName),
+ ApprovalForm = make_voice_approval_form(From, Nick, RoleName),
F = fun({_, Info}) ->
ejabberd_router:route(StateData#state.jid, Info#user.jid,
ApprovalForm)
@@ -4636,16 +4565,35 @@ route_nick_iq(#routed_nick_iq{packet = Packet, lang = Lang, nick = ToNick,
decode_reason(Elem) ->
xml:get_path_s(Elem, [{elem, <<"reason">>}, cdata]).
+-spec make_voice_approval_form(From :: jid:simple_jid() | jid:jid(),
+ Nick :: binary(), Role :: binary()) -> exml:element().
+make_voice_approval_form(From, Nick, Role) ->
+ FieldSpecs =
+ [#{var => <<"muc#role">>, type => <<"text-single">>, value => Role,
+ label => <<"Request role">>},
+ #{var => <<"muc#jid">>, type => <<"jid-single">>, value => jid:to_binary(From),
+ label => <<"User ID">>},
+ #{var => <<"muc#roomnick">>, type => <<"text-single">>, value => Nick,
+ label => <<"Room Nickname">>},
+ #{var => <<"muc#request_allow">>, type => <<"boolean">>, value => <<"false">>,
+ label => <<"Grant voice to this person?">>}],
+ FormChildren =
+ [mongoose_data_forms:form_title(<<"Voice request">>),
+ mongoose_data_forms:form_instructions(
+ <<"To approve this request",
+ " for voice, select the "Grant voice to this person?" checkbox",
+ " and click OK. To skip this request, click the cancel button.">>),
+ mongoose_data_forms:form_type_field(?NS_MUC_REQUEST) |
+ lists:map(fun mongoose_data_forms:form_field/1, FieldSpecs)],
+ Form = mongoose_data_forms:form(FormChildren),
+ #xmlel{name = <<"message">>, children = [Form]}.
-spec xfield(binary(), any(), binary(), binary(), ejabberd:lang()) -> exml:element().
xfield(Type, Label, Var, Val, Lang) ->
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, Type},
- {<<"label">>, translate:translate(Lang, Label)},
- {<<"var">>, Var}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = Val}]}]}.
-
+ mongoose_data_forms:form_field(#{type => Type,
+ label => translate:translate(Lang, Label),
+ var => Var,
+ values => [Val]}).
-spec boolxfield(any(), binary(), any(), ejabberd:lang()) -> exml:element().
boolxfield(Label, Var, Val, Lang) ->
diff --git a/src/mongoose_data_forms.erl b/src/mongoose_data_forms.erl
new file mode 100644
index 0000000000..9ffedc0144
--- /dev/null
+++ b/src/mongoose_data_forms.erl
@@ -0,0 +1,133 @@
+-module(mongoose_data_forms).
+-xep([{xep, 4}, {version, "2.13.1"}]).
+
+%% Form processing
+-export([is_form/1,
+ is_submitted/1,
+ form_type/1,
+ find_form/1, find_form/2,
+ form_to_kvs/1, form_to_kvs/2,
+ form_to_map/1, form_to_map/2,
+ form_fields_to_kvs/1]).
+
+%% Form construction
+-export([form/1, form/2,
+ form_type_field/1,
+ form_field/1,
+ form_title/1,
+ form_instructions/1,
+ reported_element/1]).
+
+-include_lib("exml/include/exml.hrl").
+-include("mongoose_ns.hrl").
+
+-type field() :: #{var => binary(), type => binary(), label => binary(),
+ values => [binary()], options => [option()]}.
+-type option() :: binary() | {binary(), binary()}.
+-type kv_list() :: [{binary(), [binary()]}].
+-type kv_map() :: #{binary() => [binary()]}.
+
+-export_type([field/0, option/0, kv_list/0, kv_map/0]).
+
+%% Form processing
+
+-spec is_form(exml:element()) -> boolean().
+is_form(#xmlel{name = Name} = Elem) ->
+ Name =:= <<"x">> andalso exml_query:attr(Elem, <<"xmlns">>) =:= ?NS_XDATA.
+
+-spec is_submitted(exml:element()) -> boolean().
+is_submitted(Form) ->
+ lists:member(form_type(Form), [<<"submit">>, <<"cancel">>]).
+
+-spec form_type(exml:element()) -> binary() | undefined.
+form_type(Form) ->
+ exml_query:attr(Form, <<"type">>).
+
+-spec find_form(exml:element()) -> exml:element() | undefined.
+find_form(Parent) ->
+ exml_query:subelement_with_name_and_ns(Parent, <<"x">>, ?NS_XDATA).
+
+-spec find_form(exml:element(), Default) -> exml:element() | Default.
+find_form(Parent, Default) ->
+ exml_query:subelement_with_name_and_ns(Parent, <<"x">>, ?NS_XDATA, Default).
+
+-spec form_to_kvs(exml:element(), binary()) -> kv_list() | invalid.
+form_to_kvs(FormEl, Type) ->
+ case form_type(FormEl) of
+ Type -> form_to_kvs(FormEl);
+ _ -> invalid
+ end.
+
+-spec form_to_kvs(exml:element()) -> kv_list().
+form_to_kvs(FormEl) ->
+ form_fields_to_kvs(FormEl#xmlel.children).
+
+-spec form_to_map(exml:element(), binary()) -> kv_map() | invalid.
+form_to_map(FormEl, Type) ->
+ case form_type(FormEl) of
+ Type -> form_to_map(FormEl);
+ _ -> invalid
+ end.
+
+-spec form_to_map(exml:element()) -> kv_map().
+form_to_map(FormEl) ->
+ maps:from_list(form_fields_to_kvs(FormEl#xmlel.children)).
+
+-spec form_fields_to_kvs([exml:element()]) -> kv_list().
+form_fields_to_kvs(Fields) ->
+ lists:flatmap(fun form_field_to_kv/1, Fields).
+
+form_field_to_kv(FieldEl = #xmlel{name = <<"field">>}) ->
+ case exml_query:attr(FieldEl, <<"var">>) of
+ undefined -> [];
+ Var -> [{Var, exml_query:paths(FieldEl, [{element, <<"value">>}, cdata])}]
+ end;
+form_field_to_kv(_) ->
+ [].
+
+%% Form construction
+
+-spec form([exml:element()]) -> exml:element().
+form(Children) ->
+ form(Children, <<"form">>).
+
+-spec form([exml:element()], binary()) -> exml:element().
+form(Children, Type) ->
+ #xmlel{name = <<"x">>,
+ attrs = [{<<"xmlns">>, ?NS_XDATA}, {<<"type">>, Type}],
+ children = Children}.
+
+-spec form_type_field(binary()) -> exml:element().
+form_type_field(NS) when is_binary(NS) ->
+ form_field(#{var => <<"FORM_TYPE">>, type => <<"hidden">>, values => [NS]}).
+
+-spec form_field(field()) -> exml:element().
+form_field(M) when is_map(M) ->
+ Values = [form_field_value(Value) || Value <- maps:get(values, M, [])],
+ Options = [form_field_option(Option) || Option <- maps:get(options, M, [])],
+ Attrs = [{atom_to_binary(K), V} || {K, V} <- maps:to_list(M), K =/= values, K =/= options],
+ #xmlel{name = <<"field">>, attrs = Attrs, children = Values ++ Options}.
+
+-spec form_title(binary()) -> exml:element().
+form_title(Title) ->
+ #xmlel{name = <<"title">>, attrs = [], children = [{xmlcdata, Title}]}.
+
+-spec form_instructions(binary()) -> exml:element().
+form_instructions(Instructions) ->
+ #xmlel{name = <<"instructions">>, attrs = [], children = [{xmlcdata, Instructions}]}.
+
+-spec reported_element([exml:element()]) -> exml:element().
+reported_element(Fields) ->
+ #xmlel{name = <<"reported">>, attrs = [], children = Fields}.
+
+-spec form_field_option(option()) -> exml:element().
+form_field_option({Label, Value}) ->
+ #xmlel{name = <<"option">>,
+ attrs = [{<<"label">>, Label}],
+ children = [form_field_value(Value)]};
+form_field_option(Option) ->
+ form_field_option({Option, Option}).
+
+-spec form_field_value(binary()) -> exml:element().
+form_field_value(Value) ->
+ #xmlel{name = <<"value">>, children = [#xmlcdata{content = Value}]}.
diff --git a/src/mongoose_disco.erl b/src/mongoose_disco.erl
index 00516289ab..6ea5463dea 100644
--- a/src/mongoose_disco.erl
+++ b/src/mongoose_disco.erl
@@ -217,26 +217,6 @@ identity_to_xml(Identity) ->
-spec info_to_xml(info()) -> exml:element().
info_to_xml(#{xmlns := NS, fields := Fields}) ->
- #xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA}, {<<"type">>, <<"result">>}],
- children = [form_type_field_xml(NS) |
- [info_field_to_xml(Field) || Field <- Fields]]}.
-
--spec info_field_to_xml(info_field()) -> exml:element().
-info_field_to_xml(InfoField) ->
- {Values, Attrs} = maps:take(values, InfoField),
- #xmlel{name = <<"field">>,
- attrs = lists:map(fun({Key, Value}) -> {atom_to_binary(Key, utf8), Value} end,
- maps:to_list(Attrs)),
- children = values_to_xml(Values)}.
-
--spec values_to_xml([binary()]) -> [exml:element()].
-values_to_xml(Values) ->
- [#xmlel{name = <<"value">>, children = [#xmlcdata{content = Value}]} || Value <- Values].
-
--spec form_type_field_xml(binary()) -> exml:element().
-form_type_field_xml(NS) ->
- #xmlel{name = <<"field">>,
- attrs = [{<<"var">>, <<"FORM_TYPE">>}, {<<"type">>, <<"hidden">>}],
- children = [#xmlel{name = <<"value">>,
- children = [#xmlcdata{content = NS}]}]}.
+ Children = [mongoose_data_forms:form_type_field(NS) |
+ [mongoose_data_forms:form_field(Field) || Field <- Fields]],
+ mongoose_data_forms:form(Children, <<"result">>).
diff --git a/src/muc_light/mod_muc_light_codec_legacy.erl b/src/muc_light/mod_muc_light_codec_legacy.erl
index 156f363f02..40a39749ff 100644
--- a/src/muc_light/mod_muc_light_codec_legacy.erl
+++ b/src/muc_light/mod_muc_light_codec_legacy.erl
@@ -138,8 +138,7 @@ decode_iq(_From, #iq{ xmlns = ?NS_MUC_OWNER, type = get, sub_el = _QueryEl, id =
decode_iq(From, IQ = #iq{ xmlns = ?NS_MUC_OWNER, type = set, sub_el = QueryEl, id = ID }) ->
case exml_query:subelement(QueryEl, <<"destroy">>) of
undefined ->
- try parse_config(exml_query:paths(QueryEl, [{element, <<"x">>},
- {element, <<"field">>}])) of
+ try parse_config(mongoose_data_forms:form_to_kvs(mongoose_data_forms:find_form(QueryEl))) of
{ok, RawConfig} ->
{ok, {set, #config{ id = ID, raw_config = RawConfig }}}
catch Class:Reason:Stacktrace ->
@@ -191,20 +190,12 @@ decode_iq(_From, #iq{} = IQ) ->
%% ------------------ Parsers ------------------
--spec parse_config(Els :: [jlib:xmlch()]) -> {ok, mod_muc_light_room_config:binary_kv()}.
-parse_config(Els) ->
- parse_config(Els, []).
-
--spec parse_config(Els :: [jlib:xmlch()], ConfigAcc :: mod_muc_light_room_config:binary_kv()) ->
- {ok, mod_muc_light_room_config:binary_kv()}.
-parse_config([], ConfigAcc) ->
- {ok, ConfigAcc};
-parse_config([Field | REls], ConfigAcc) ->
- case {exml_query:attr(Field, <<"var">>),
- exml_query:path(Field, [{element, <<"value">>}, cdata])} of
- {<<"FORM_TYPE">>, _} -> parse_config(REls, ConfigAcc);
- ConfigKV -> parse_config(REls, [ConfigKV | ConfigAcc])
- end.
+-spec parse_config([{binary(), [binary()]}]) -> {ok, mod_muc_light_room_config:binary_kv()}.
+parse_config(KVs) ->
+ {ok, lists:flatmap(fun parse_config_kv/1, KVs)}.
+
+parse_config_kv({<<"FORM_TYPE">>, _}) -> [];
+parse_config_kv({K, [V]}) -> [{K, V}].
-spec parse_aff_users(Els :: [jlib:xmlch()]) -> {ok, aff_users()}.
parse_aff_users(Els) ->
@@ -267,15 +258,11 @@ encode_meta({get, #disco_items{ rooms = Rooms, id = ID, rsm = RSMOut }},
|| {{RoomU, RoomS}, RoomName, _RoomVersion} <- Rooms ],
{iq_reply, ?NS_DISCO_ITEMS, jlib:rsm_encode(RSMOut) ++ DiscoEls, ID};
encode_meta({get, #config{} = Config}, _RoomJID, _SenderJID, _HandleFun, _Acc) ->
- ConfigEls = [ jlib:form_field({K, <<"text-single">>, V, K})
+ ConfigEls = [ mongoose_data_forms:form_field(#{var => K, type => <<"text-single">>, values => [V]})
|| {K, V} <- Config#config.raw_config ],
- XEl = #xmlel{ name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA}, {<<"type">>, <<"form">>}],
- children = [
- kv_to_el(<<"title">>, <<"Configuration form for the room">>),
- jlib:form_field({<<"FORM_TYPE">>, <<"hidden">>,
- <<"http://jabber.org/protocol/muc#roomconfig">>})
- | ConfigEls] },
+ FormType = mongoose_data_forms:form_type_field(<<"http://jabber.org/protocol/muc#roomconfig">>),
+ FormTitle = mongoose_data_forms:form_title(<<"Configuration form for the room">>),
+ XEl = mongoose_data_forms:form([FormTitle, FormType | ConfigEls]),
{iq_reply, ?NS_MUC_OWNER, [XEl], Config#config.id};
encode_meta({get, #affiliations{} = Affs}, _RoomJID, _SenderJID, _HandleFun, _Acc) ->
AffEls = [ aff_user_to_item(AffUser) || AffUser <- Affs#affiliations.aff_users ],
@@ -386,10 +373,6 @@ blocking_to_el({What, Action, {WhoU, WhoS}}, Service) ->
{<<"order">>, <<"1">>}
] }.
--spec kv_to_el(binary(), binary()) -> exml:element().
-kv_to_el(Key, Value) ->
- #xmlel{ name = Key, children = [#xmlcdata{ content = Value }] }.
-
-spec envelope(XMLNS :: binary(), Children :: [jlib:xmlch()]) -> [jlib:xmlch()].
envelope(XMLNS, Children) ->
[ #xmlel{ name = <<"x">>, attrs = [{<<"xmlns">>, XMLNS}], children = Children } ].
diff --git a/src/pubsub/mod_pubsub.erl b/src/pubsub/mod_pubsub.erl
index f2b2c83739..ba2cc80ffe 100644
--- a/src/pubsub/mod_pubsub.erl
+++ b/src/pubsub/mod_pubsub.erl
@@ -1464,8 +1464,8 @@ iq_pubsub_set_retract(Host, Node, From,
iq_pubsub_set_subscribe(Host, Node, From, #{query_el := QueryEl,
action_el := #xmlel{attrs = SubscribeAttrs}}) ->
- ConfigXForm = exml_query:path(QueryEl, [{element, <<"options">>},
- {element_with_ns, <<"x">>, ?NS_XDATA}]),
+ Options = exml_query:subelement(QueryEl, <<"options">>),
+ ConfigXForm = mongoose_data_forms:find_form(Options),
JID = xml:get_attr_s(<<"jid">>, SubscribeAttrs),
subscribe_node(Host, Node, From, JID, ConfigXForm).
@@ -1504,7 +1504,7 @@ iq_pubsub_get_options(Host, Node, Lang, #{action_el := #xmlel{attrs = GetOptions
get_options(Host, Node, JID, SubId, Lang).
iq_pubsub_set_options(Host, Node, #{action_el := #xmlel{attrs = SetOptionsAttrs} = ActionEl}) ->
- XForm = exml_query:subelement_with_name_and_ns(ActionEl, <<"x">>, ?NS_XDATA),
+ XForm = mongoose_data_forms:find_form(ActionEl),
SubId = xml:get_attr_s(<<"subid">>, SetOptionsAttrs),
JID = xml:get_attr_s(<<"jid">>, SetOptionsAttrs),
set_options(Host, Node, JID, SubId, XForm).
@@ -1616,19 +1616,12 @@ send_pending_node_form(Request, Host, Owner, Plugins) ->
[] ->
{error, mongoose_xmpp_errors:feature_not_implemented()};
Ps ->
- XOpts = [#xmlel{name = <<"option">>, attrs = [],
- children = [#xmlel{name = <<"value">>,
- attrs = [],
- children = [{xmlcdata, Node}]}]}
- || Node <- get_pending_nodes(Host, Owner, Ps)],
- XForm = #xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA},
- {<<"type">>, <<"form">>}],
- children = [#xmlel{name = <<"field">>,
- attrs = [{<<"type">>, <<"list-single">>},
- {<<"var">>, <<"pubsub#node">>}],
- children = lists:usort(XOpts)}]},
- adhoc:produce_response(Request, executing, <<"execute">>, [XForm])
+ Options = get_pending_nodes(Host, Owner, Ps),
+ Field = mongoose_data_forms:form_field(#{type => <<"list-single">>,
+ var => <<"pubsub#node">>,
+ options => lists:usort(Options)}),
+ Form = mongoose_data_forms:form([Field]),
+ adhoc:produce_response(Request, executing, <<"execute">>, [Form])
end.
get_pending_nodes(Host, Owner, Plugins) ->
@@ -1650,19 +1643,17 @@ get_pending_nodes(Host, Owner, Plugins) ->
Err -> Err
end.
-adhoc_get_pending_parse_options(Host, #xmlel{name = <<"x">>} = XEl) ->
- case jlib:parse_xdata_submit(XEl) of
+adhoc_get_pending_parse_options(Host, XEl) ->
+ case mongoose_data_forms:form_to_kvs(XEl, <<"submit">>) of
invalid ->
+ ?LOG_INFO(#{what => pubsub_bad_xform, exml_packet => XEl}),
{error, mongoose_xmpp_errors:bad_request()};
- XData2 ->
- case set_xoption(Host, XData2, []) of
+ KVs ->
+ case set_xoption(Host, KVs, []) of
NewOpts when is_list(NewOpts) -> {result, NewOpts};
Err -> Err
end
- end;
-adhoc_get_pending_parse_options(_Host, XData) ->
- ?LOG_INFO(#{what => pubsub_bad_xform, exml_packet => XData}),
- {error, mongoose_xmpp_errors:bad_request()}.
+ end.
%% @doc Send a subscription approval form to Owner for all pending
%% subscriptions on Host and Node.
@@ -1700,88 +1691,49 @@ get_node_subscriptions_transaction(Owner, #pubsub_node{id = Nidx, type = Type})
send_authorization_request(#pubsub_node{nodeid = {Host, Node}, owners = Owners},
Subscriber) ->
Lang = <<"en">>,
- FormChildren = [#xmlel{name = <<"title">>, attrs = [],
- children =
- [#xmlcdata{content =
- translate:translate(Lang, <<"PubSub subscriber request">>)}]},
- #xmlel{name = <<"instructions">>,
- attrs = [],
- children =
- [#xmlcdata{content = translate:translate(
- Lang, <<"Choose whether to approve this entity's "
- "subscription.">>)}]},
- #xmlel{name = <<"field">>,
- attrs =
- [{<<"var">>, <<"FORM_TYPE">>},
- {<<"type">>, <<"hidden">>}],
- children =
- [#xmlel{name = <<"value">>,
- attrs = [],
- children = [#xmlcdata{content = ?NS_PUBSUB_SUB_AUTH}]}]},
- #xmlel{name = <<"field">>,
- attrs =
- [{<<"var">>, <<"pubsub#node">>},
- {<<"type">>,
- <<"text-single">>},
- {<<"label">>, translate:translate(Lang, <<"Node ID">>)}],
- children = [#xmlel{name = <<"value">>,
- attrs = [],
- children = [#xmlcdata{content = Node}]}]},
- #xmlel{name = <<"field">>,
- attrs =
- [{<<"var">>,
- <<"pubsub#subscriber_jid">>},
- {<<"type">>, <<"jid-single">>},
- {<<"label">>,
- translate:translate(Lang, <<"Subscriber Address">>)}],
- children =
- [#xmlel{name = <<"value">>,
- attrs = [],
- children = [#xmlcdata{content = jid:to_binary(Subscriber)}]}]},
- #xmlel{name = <<"field">>,
- attrs =
- [{<<"var">>,
- <<"pubsub#allow">>},
- {<<"type">>, <<"boolean">>},
- {<<"label">>,
- translate:translate(Lang,
- <<"Allow this Jabber ID to subscribe to "
- "this pubsub node?">>)}],
- children = [#xmlel{name = <<"value">>,
- attrs = [],
- children = [#xmlcdata{content = <<"false">>}]}]}],
+ FormChildren = [mongoose_data_forms:form_title(
+ translate:translate(Lang, <<"PubSub subscriber request">>)),
+ mongoose_data_forms:form_instructions(
+ translate:translate(Lang, <<"Choose whether to approve this entity's "
+ "subscription.">>)),
+ mongoose_data_forms:form_type_field(?NS_PUBSUB_SUB_AUTH),
+ mongoose_data_forms:form_field(
+ #{var => <<"pubsub#node">>,
+ type => <<"text-single">>,
+ label => translate:translate(Lang, <<"Node ID">>),
+ values => [Node]}),
+ mongoose_data_forms:form_field(
+ #{var => <<"pubsub#subscriber_jid">>,
+ type => <<"jid-single">>,
+ label => translate:translate(Lang, <<"Subscriber Address">>),
+ values => [jid:to_binary(Subscriber)]}),
+ mongoose_data_forms:form_field(
+ #{var => <<"pubsub#allow">>,
+ type => <<"boolean">>,
+ label => translate:translate(Lang, <<"Allow this Jabber ID to subscribe to "
+ "this pubsub node?">>),
+ values => [<<"false">>]})],
Stanza = #xmlel{name = <<"message">>,
attrs = [{<<"id">>, mongoose_bin:gen_from_crypto()}],
- children = [#xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA}, {<<"type">>, <<"form">>}],
- children = FormChildren}]},
+ children = [mongoose_data_forms:form(FormChildren)]},
lists:foreach(fun(Owner) ->
ejabberd_router:route(service_jid(Host), jid:make(Owner), Stanza)
end, Owners).
find_authorization_response(#xmlel{ children = Els }) ->
- XData = lists:foldl(fun(#xmlel{name = <<"x">>, attrs = XAttrs} = XEl, Acc) ->
- case {xml:get_attr_s(<<"xmlns">>, XAttrs),
- xml:get_attr_s(<<"type">>, XAttrs)} of
- {?NS_XDATA, <<"submit">>} ->
- [jlib:parse_xdata_submit(XEl) | Acc];
- _ ->
- Acc
- end;
- (_, Acc) ->
- Acc
- end, [], xml:remove_cdata(Els)),
+ XData = lists:flatmap(fun(El) ->
+ case mongoose_data_forms:is_form(El)
+ andalso mongoose_data_forms:form_type(El) =:= <<"submit">> of
+ true ->
+ [mongoose_data_forms:form_to_map(El)];
+ false ->
+ []
+ end
+ end, xml:remove_cdata(Els)),
case XData of
- [] ->
- none;
- [XFields] when is_list(XFields) ->
- ?LOG_DEBUG(#{what => pubsub_xfields, xfields => XFields}),
- case lists:keysearch(<<"FORM_TYPE">>, 1, XFields) of
- {value, {_, [?NS_PUBSUB_SUB_AUTH]}} -> XFields;
- _ -> invalid
- end;
- _ ->
- invalid
+ [] -> none;
+ [#{<<"FORM_TYPE">> := [?NS_PUBSUB_SUB_AUTH]} = M] -> M;
+ _ -> invalid
end.
%% @doc Send a message to JID with the supplied Subscription
@@ -1800,12 +1752,10 @@ send_authorization_approval(Host, JID, SNode, Subscription) ->
ejabberd_router:route(service_jid(Host), JID, Stanza).
handle_authorization_response(Acc, Host, From, To, Packet, XFields) ->
- case {lists:keysearch(<<"pubsub#node">>, 1, XFields),
- lists:keysearch(<<"pubsub#subscriber_jid">>, 1, XFields),
- lists:keysearch(<<"pubsub#allow">>, 1, XFields)} of
- {{value, {_, [Node]}},
- {value, {_, [SSubscriber]}},
- {value, {_, [SAllow]}}} ->
+ case XFields of
+ #{<<"pubsub#node">> := [Node],
+ <<"pubsub#subscriber_jid">> := [SSubscriber],
+ <<"pubsub#allow">> := [SAllow]} ->
FromLJID = jid:to_lower(jid:to_bare(From)),
Subscriber = jid:from_binary(SSubscriber),
Allow = string_allow_to_boolean(SAllow),
@@ -1863,12 +1813,10 @@ update_auth(Host, Node, Type, Nidx, Subscriber, Allow, Subs) ->
end.
-define(XFIELD(Type, Label, Var, Val),
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, Type},
- {<<"label">>, translate:translate(Lang, Label)},
- {<<"var">>, Var}],
- children = [#xmlel{name = <<"value">>, attrs = [],
- children = [{xmlcdata, Val}]}]}).
+ #{type => Type,
+ label => translate:translate(Lang, Label),
+ var => Var,
+ values => [Val]}).
-define(BOOLXFIELD(Label, Var, Val),
?XFIELD(<<"boolean">>, Label, Var,
@@ -1881,45 +1829,27 @@ update_auth(Host, Node, Type, Nidx, Subscriber, Allow, Subs) ->
?XFIELD(<<"text-single">>, Label, Var, Val)).
-define(STRINGMXFIELD(Label, Var, Vals),
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, <<"text-multi">>},
- {<<"label">>, translate:translate(Lang, Label)},
- {<<"var">>, Var}],
- children = [#xmlel{name = <<"value">>, attrs = [],
- children = [{xmlcdata, V}]}
- || V <- Vals]}).
+ #{type => <<"text-multi">>,
+ label => translate:translate(Lang, Label),
+ var => Var,
+ values => Vals}).
-define(XFIELDOPT(Type, Label, Var, Val, Opts),
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, Type},
- {<<"label">>, translate:translate(Lang, Label)},
- {<<"var">>, Var}],
- children = [#xmlel{name = <<"option">>, attrs = [],
- children = [#xmlel{name = <<"value">>,
- attrs = [],
- children = [{xmlcdata, Opt}]}]}
- || Opt <- Opts]
- ++
- [#xmlel{name = <<"value">>, attrs = [],
- children = [{xmlcdata, Val}]}]}).
+ #{type => Type,
+ label => translate:translate(Lang, Label),
+ var => Var,
+ options => Opts,
+ values => [Val]}).
-define(LISTXFIELD(Label, Var, Val, Opts),
?XFIELDOPT(<<"list-single">>, Label, Var, Val, Opts)).
-define(LISTMXFIELD(Label, Var, Vals, Opts),
- #xmlel{name = <<"field">>,
- attrs = [{<<"type">>, <<"list-multi">>},
- {<<"label">>, translate:translate(Lang, Label)},
- {<<"var">>, Var}],
- children = [#xmlel{name = <<"option">>, attrs = [],
- children = [#xmlel{name = <<"value">>,
- attrs = [],
- children = [{xmlcdata, Opt}]}]}
- || Opt <- Opts]
- ++
- [#xmlel{name = <<"value">>, attrs = [],
- children = [{xmlcdata, Val}]}
- || Val <- Vals]}).
+ #{type => <<"list-multi">>,
+ label => translate:translate(Lang, Label),
+ var => Var,
+ options => Opts,
+ values => Vals}).
%% @doc Create new pubsub nodes
%%In addition to method-specific error conditions, there are several general reasons
@@ -1973,17 +1903,7 @@ create_node(Host, ServerHost, <<>>, Owner, Type, Access, Configuration) ->
end;
create_node(Host, ServerHost, Node, Owner, GivenType, Access, Configuration) ->
Type = select_type(ServerHost, Host, Node, GivenType),
- ConfigXEl = case xml:remove_cdata(Configuration) of
- [] ->
- {result, node_options(Host, Type)};
- [#xmlel{name = <<"x">>} = XEl] ->
- XEl;
- _ ->
- ?LOG_INFO(#{what => pubsub_bad_node_configuration,
- pubsub_node => Node, configuration => Configuration}),
- {error, mongoose_xmpp_errors:bad_request()}
- end,
- case parse_create_node_options_if_possible(Host, Type, ConfigXEl) of
+ case parse_create_node_options(Host, Type, xml:remove_cdata(Configuration)) of
{result, NodeOptions} ->
CreateNode = fun () ->
create_node_transaction(Host, ServerHost, Node, Owner,
@@ -2007,21 +1927,27 @@ create_node(Host, ServerHost, Node, Owner, GivenType, Access, Configuration) ->
Error
end;
Error ->
+ ?LOG_INFO(#{what => pubsub_bad_node_configuration,
+ pubsub_node => Node, configuration => Configuration}),
Error
end.
-parse_create_node_options_if_possible(Host, Type, #xmlel{} = ConfigXEl) ->
- case jlib:parse_xdata_submit(ConfigXEl) of
- invalid ->
- {error, mongoose_xmpp_errors:bad_request()};
- XData ->
- case set_xoption(Host, XData, node_options(Host, Type)) of
+parse_create_node_options(Host, Type, []) ->
+ {result, node_options(Host, Type)};
+parse_create_node_options(Host, Type, [XEl]) ->
+ case mongoose_data_forms:is_form(XEl) andalso
+ mongoose_data_forms:form_type(XEl) =:= <<"submit">> of
+ true ->
+ KVs = mongoose_data_forms:form_to_kvs(XEl),
+ case set_xoption(Host, KVs, node_options(Host, Type)) of
NewOpts when is_list(NewOpts) -> {result, NewOpts};
Err -> Err
- end
+ end;
+ false ->
+ {error, mongoose_xmpp_errors:bad_request()}
end;
-parse_create_node_options_if_possible(_Host, _Type, InvalidConfigXEl) ->
- InvalidConfigXEl.
+parse_create_node_options(_Host, _Type, _) ->
+ {error, mongoose_xmpp_errors:bad_request()}.
create_node_transaction(Host, ServerHost, Node, Owner, Type, Access, NodeOptions) ->
Parent = get_parent(Type, Node),
@@ -3534,11 +3460,10 @@ broadcast_config_notification(Host, Node, Nidx, Type, NodeOptions, Lang) ->
{result, false}
end.
-payload_by_option(Type, NodeOptions, Lang) ->
+payload_by_option(_Type, NodeOptions, Lang) ->
case get_option(NodeOptions, deliver_payloads) of
true ->
- [#xmlel{name = <<"x">>, attrs = [{<<"xmlns">>, ?NS_XDATA}, {<<"type">>, <<"result">>}],
- children = get_configure_xfields(Type, NodeOptions, Lang, [])}];
+ configure_form(<<"result">>, NodeOptions, Lang, []);
false ->
[]
end.
@@ -3730,10 +3655,7 @@ get_configure_transaction(ServerHost, Node, From, Lang,
case node_call(Type, get_affiliation, [Nidx, From]) of
{result, owner} ->
Groups = mongoose_hooks:roster_groups(ServerHost),
- XEl = #xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA},
- {<<"type">>, <<"form">>}],
- children = get_configure_xfields(Type, Options, Lang, Groups)},
+ XEl = configure_form(<<"form">>, Options, Lang, Groups),
ConfigureEl = #xmlel{name = <<"configure">>,
attrs = node_attr(Node),
children = [XEl]},
@@ -3748,12 +3670,8 @@ get_configure_transaction(ServerHost, Node, From, Lang,
get_default(Host, Node, _From, #{lang := Lang}) ->
Type = select_type(Host, Node),
Options = node_options(Host, Type),
- DefaultEl = #xmlel{name = <<"default">>, attrs = [],
- children =
- [#xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA},
- {<<"type">>, <<"form">>}],
- children = get_configure_xfields(Type, Options, Lang, [])}]},
+ XEl = configure_form(<<"form">>, Options, Lang, []),
+ DefaultEl = #xmlel{name = <<"default">>, attrs = [], children = [XEl]},
{result,
[#xmlel{name = <<"pubsub">>,
attrs = [{<<"xmlns">>, ?NS_PUBSUB_OWNER}],
@@ -3855,7 +3773,13 @@ max_items(Host, Options) ->
<<"pubsub#", (atom_to_binary(Var, latin1))/binary>>,
get_option(Options, Var, []))).
-get_configure_xfields(_Type, Options, Lang, Groups) ->
+configure_form(Type, Options, Lang, Groups) ->
+ TypeField = mongoose_data_forms:form_type_field(?NS_PUBSUB_NODE_CONFIG),
+ Fields = [mongoose_data_forms:form_field(Spec) ||
+ Spec <- get_configure_xfields(Options, Lang, Groups)],
+ mongoose_data_forms:form([TypeField | Fields], Type).
+
+get_configure_xfields(Options, Lang, Groups) ->
[?XFIELD(<<"hidden">>, <<>>, <<"FORM_TYPE">>, (?NS_PUBSUB_NODE_CONFIG)),
?BOOL_CONFIG_FIELD(<<"Deliver payloads with event notifications">>,
deliver_payloads),
@@ -3905,17 +3829,26 @@ get_configure_xfields(_Type, Options, Lang, Groups) ->
%%
The specified node does not exist.
%%
set_configure(Host, Node, From, #{action_el := ActionEl, lang := Lang}) ->
- case xml:remove_cdata(ActionEl#xmlel.children) of
- [#xmlel{name = <<"x">>} = XEl] ->
- case {xml:get_tag_attr_s(<<"xmlns">>, XEl), xml:get_tag_attr_s(<<"type">>, XEl)} of
- {?NS_XDATA, <<"cancel">>} -> {result, []};
- {?NS_XDATA, <<"submit">>} -> set_configure_submit(Host, Node, From, XEl, Lang);
+ case get_form(ActionEl) of
+ {ok, XEl} ->
+ case mongoose_data_forms:form_type(XEl) of
+ <<"cancel">> -> {result, []};
+ <<"submit">> -> set_configure_submit(Host, Node, From, XEl, Lang);
_ -> {error, mongoose_xmpp_errors:bad_request()}
end;
- _ ->
+ no_form ->
{error, mongoose_xmpp_errors:bad_request()}
end.
+get_form(ParentEl) ->
+ case xml:remove_cdata(ParentEl#xmlel.children) of
+ [El] -> case mongoose_data_forms:is_form(El) of
+ true -> {ok, El};
+ false -> no_form
+ end;
+ _ -> no_form
+ end.
+
set_configure_submit(Host, Node, User, XEl, Lang) ->
Action = fun(NodeRec) ->
set_configure_transaction(Host, User, XEl, NodeRec)
@@ -3934,10 +3867,8 @@ set_configure_submit(Host, Node, User, XEl, Lang) ->
set_configure_transaction(Host, User, XEl, #pubsub_node{ type = Type, id = Nidx } = NodeRec) ->
case node_call(Type, get_affiliation, [Nidx, User]) of
{result, owner} ->
- case jlib:parse_xdata_submit(XEl) of
- invalid -> {error, mongoose_xmpp_errors:bad_request()};
- XData -> set_configure_valid_transaction(Host, NodeRec, XData)
- end;
+ KVs = mongoose_data_forms:form_to_kvs(XEl),
+ set_configure_valid_transaction(Host, NodeRec, KVs);
_ ->
{error, mongoose_xmpp_errors:forbidden()}
end.
diff --git a/src/pubsub/node_push.erl b/src/pubsub/node_push.erl
index 755ba7e502..e77424be55 100644
--- a/src/pubsub/node_push.erl
+++ b/src/pubsub/node_push.erl
@@ -111,23 +111,15 @@ is_allowed_to_publish(PublishModel, Affiliation) ->
or (Affiliation == publish_only)).
--spec parse_form(undefined | exml:element()) -> invalid_form | #{atom() => binary()}.
+-spec parse_form(undefined | exml:element()) -> invalid_form | #{binary() => binary()}.
parse_form(undefined) ->
#{};
parse_form(Form) ->
- IsForm = ?NS_XDATA == exml_query:attr(Form, <<"xmlns">>),
- IsSubmit = <<"submit">> == exml_query:attr(Form, <<"type">>, <<"submit">>),
-
- FieldsXML = exml_query:subelements(Form, <<"field">>),
- Fields = [{exml_query:attr(Field, <<"var">>),
- exml_query:path(Field, [{element, <<"value">>}, cdata])} || Field <- FieldsXML],
- {_, CustomFields} = lists:partition(
- fun({Name, _}) ->
- Name == <<"FORM_TYPE">>
- end, Fields),
-
- case IsForm andalso IsSubmit of
+ case mongoose_data_forms:is_form(Form)
+ andalso mongoose_data_forms:form_type(Form) =:= <<"submit">> of
true ->
+ Fields = mongoose_data_forms:form_to_kvs(Form),
+ CustomFields = [{K, V} || {K, [V]} <- Fields, K =/= <<"FORM_TYPE">>],
maps:from_list(CustomFields);
false ->
invalid_form
diff --git a/src/pubsub/pubsub_form_utils.erl b/src/pubsub/pubsub_form_utils.erl
index 938f5bb811..d324940cfa 100644
--- a/src/pubsub/pubsub_form_utils.erl
+++ b/src/pubsub/pubsub_form_utils.erl
@@ -54,7 +54,7 @@ make_sub_xform(Options) ->
parse_sub_xform(undefined) ->
{ok, []};
parse_sub_xform(XForm) ->
- case jlib:parse_xdata_submit(XForm) of
+ case mongoose_data_forms:form_to_kvs(XForm, <<"submit">>) of
invalid -> {error, invalid_form};
XData -> convert_fields_from_binaries(XData, [], sub_form_options())
end.
@@ -65,41 +65,30 @@ parse_sub_xform(XForm) ->
-spec make_sub_xform_xml(XFields :: [exml:element()]) -> exml:element().
make_sub_xform_xml(XFields) ->
- FormTypeEl = #xmlel{name = <<"field">>,
- attrs = [{<<"var">>, <<"FORM_TYPE">>}, {<<"type">>, <<"hidden">>}],
- children = [#xmlel{name = <<"value">>, attrs = [],
- children = [{xmlcdata, ?NS_PUBSUB_SUB_OPTIONS}]}]},
- #xmlel{name = <<"x">>, attrs = [{<<"xmlns">>, ?NS_XDATA}], children = [FormTypeEl | XFields]}.
+ mongoose_data_forms:form(XFields, ?NS_PUBSUB_SUB_OPTIONS).
-spec make_field_xml(OptDefinition :: option_definition(),
Options :: mod_pubsub:subOptions()) -> exml:element().
make_field_xml({VarName, Key, #{ label := Label, form_type := FormType } = VarProps}, Options) ->
- ChoicesEls = make_choices_xml(VarProps),
- ValEls = make_values_xml(Key, Options, VarProps),
-
- #xmlel{name = <<"field">>,
- attrs = [{<<"var">>, VarName}, {<<"type">>, FormType}, {<<"label">>, Label}],
- children = ChoicesEls ++ ValEls}.
-
-make_choices_xml(#{ possible_choices := PossibleChoices }) ->
- [ make_option_xml(Value, Label) || {Value, Label} <- PossibleChoices ];
-make_choices_xml(#{}) ->
+ mongoose_data_forms:form_field(#{var => VarName,
+ type => FormType,
+ label => Label,
+ options => make_choices(VarProps),
+ values => make_values(Key, Options, VarProps)}).
+
+make_choices(#{ possible_choices := PossibleChoices }) ->
+ [ {Label, Value} || {Value, Label} <- PossibleChoices ];
+make_choices(#{}) ->
[].
-make_option_xml(Value, Label) ->
- #xmlel{name = <<"option">>, attrs = [{<<"label">>, Label}], children = [make_value_xml(Value)]}.
-
-make_values_xml(Key, Options, #{ data_type := DataType }) ->
+make_values(Key, Options, #{ data_type := DataType }) ->
case lists:keyfind(Key, 1, Options) of
{_, Value} ->
- [make_value_xml(BinVal) || BinVal <- convert_value_to_binaries(Value, DataType)];
+ convert_value_to_binaries(Value, DataType);
false ->
[]
end.
-make_value_xml(Value) ->
- #xmlel{name = <<"value">>, attrs = [], children = [#xmlcdata{ content = Value }]}.
-
%%====================================================================
%% Form definitions & conversions
%%====================================================================
diff --git a/src/vcard/mod_vcard.erl b/src/vcard/mod_vcard.erl
index ce1d429413..77649eb03e 100644
--- a/src/vcard/mod_vcard.erl
+++ b/src/vcard/mod_vcard.erl
@@ -502,8 +502,9 @@ do_route(HostType, LServer, From, To, Acc,
route_search_iq_set(HostType, LServer, From, To, Acc, Lang, SubEl, IQ);
do_route(HostType, LServer, From, To, Acc,
#iq{type = get, xmlns = ?NS_SEARCH, lang = Lang} = IQ) ->
- Form = ?FORM(To, mod_vcard_backend:search_fields(HostType, LServer), Lang),
- ResIQ = make_search_form_result_iq(IQ, Form),
+ Instr = search_instructions(Lang),
+ Form = search_res_form(To, mod_vcard_backend:search_fields(HostType, LServer), Lang),
+ ResIQ = make_search_form_result_iq(IQ, [Instr, Form]),
ejabberd_router:route(To, From, Acc, jlib:iq_to_xml(ResIQ));
do_route(_HostType, _LServer, From, To, Acc,
#iq{type = set, xmlns = ?NS_DISCO_INFO}) ->
@@ -542,43 +543,54 @@ do_route(_HostType, _LServer, From, To, Acc, _IQ) ->
{Acc1, Err} = jlib:make_error_reply(Acc, mongoose_xmpp_errors:service_unavailable()),
ejabberd_router:route(To, From, Acc1, Err).
-make_search_form_result_iq(IQ, Form) ->
+make_search_form_result_iq(IQ, Elements) ->
IQ#iq{type = result,
sub_el = [#xmlel{name = <<"query">>,
attrs = [{<<"xmlns">>, ?NS_SEARCH}],
- children = Form
+ children = Elements
}]}.
+search_instructions(Lang) ->
+ %% This is not in the form, but the helper function can be reused
+ mongoose_data_forms:form_instructions(
+ translate:translate(Lang, <<"You need an x:data capable client to search">>)).
+
+search_res_form(JID, SearchFields, Lang) ->
+ Contents =
+ [mongoose_data_forms:form_title(
+ <<(translate:translate(Lang, <<"Search users in ">>))/binary,
+ (jid:to_binary(JID))/binary>>),
+ mongoose_data_forms:form_instructions(
+ translate:translate(Lang, <<"Fill in fields to search for any matching Jabber User">>))
+ ] ++ lists:map(fun ({X, Y}) -> ?TLFIELD(<<"text-single">>, X, Y) end, SearchFields),
+ mongoose_data_forms:form(Contents, <<"result">>).
+
route_search_iq_set(HostType, LServer, From, To, Acc, Lang, SubEl, IQ) ->
- XDataEl = find_xdata_el(SubEl),
+ XDataEl = mongoose_data_forms:find_form(SubEl),
RSMIn = jlib:rsm_decode(IQ),
case XDataEl of
- false ->
+ undefined ->
{Acc1, Err} = jlib:make_error_reply(Acc, mongoose_xmpp_errors:bad_request()),
ejabberd_router:route(To, From, Acc1, Err);
_ ->
- XData = jlib:parse_xdata_submit(XDataEl),
- case XData of
+ case mongoose_data_forms:form_to_kvs(XDataEl, <<"submit">>) of
invalid ->
{Acc1, Err} = jlib:make_error_reply(Acc, mongoose_xmpp_errors:bad_request()),
ejabberd_router:route(To, From, Acc1, Err);
- _ ->
- {SearchResult, RSMOutEls} = search_result(HostType, LServer, Lang, To, XData, RSMIn),
+ KVs ->
+ {SearchResult, RSMOutEls} = search_result(HostType, LServer, Lang, To, KVs, RSMIn),
ResIQ = make_search_result_iq(IQ, SearchResult, RSMOutEls),
ejabberd_router:route(To, From, Acc, jlib:iq_to_xml(ResIQ))
end
end.
make_search_result_iq(IQ, SearchResult, RSMOutEls) ->
+ Form = mongoose_data_forms:form(SearchResult, <<"result">>),
IQ#iq{
type = result,
sub_el = [#xmlel{name = <<"query">>,
attrs = [{<<"xmlns">>, ?NS_SEARCH}],
- children = [#xmlel{name = <<"x">>,
- attrs = [{<<"xmlns">>, ?NS_XDATA},
- {<<"type">>, <<"result">>}],
- children = SearchResult}
- ] ++ RSMOutEls}
+ children = [Form | RSMOutEls]}
]}.
iq_get_vcard() ->
@@ -588,20 +600,6 @@ iq_get_vcard() ->
#xmlel{name = <<"DESC">>,
children = [#xmlcdata{content = [<<"MongooseIM vCard module">>,
<<"\nCopyright (c) Erlang Solutions Ltd.">>]}]}].
-find_xdata_el(#xmlel{children = SubEls}) ->
- find_xdata_el1(SubEls).
-
-find_xdata_el1([]) ->
- false;
-find_xdata_el1([XE = #xmlel{attrs = Attrs} | Els]) ->
- case xml:get_attr_s(<<"xmlns">>, Attrs) of
- ?NS_XDATA ->
- XE;
- _ ->
- find_xdata_el1(Els)
- end;
-find_xdata_el1([_ | Els]) ->
- find_xdata_el1(Els).
features() ->
[?NS_DISCO_INFO, ?NS_SEARCH, ?NS_VCARD].
@@ -723,7 +721,7 @@ apply_rsm_to_search_results([], _, #rsm_out{} = RSMOut1) ->
search_result_get_jid(#xmlel{name = <<"item">>,
children = Children}) ->
- Fields = jlib:parse_xdata_fields(Children),
+ Fields = mongoose_data_forms:form_fields_to_kvs(Children),
case lists:keysearch(<<"jid">>, 1, Fields) of
{value, {<<"jid">>, JID}} ->
{ok, list_to_binary(JID)};
diff --git a/src/vcard/mod_vcard_ldap.erl b/src/vcard/mod_vcard_ldap.erl
index 9070f66a3b..fcd5130249 100644
--- a/src/vcard/mod_vcard_ldap.erl
+++ b/src/vcard/mod_vcard_ldap.erl
@@ -170,16 +170,9 @@ search_fields(HostType, LServer) ->
search_reported_fields(HostType, LServer, Lang) ->
State = get_state(HostType, LServer),
SearchReported = State#state.search_reported,
- #xmlel{name = <<"reported">>, attrs = [],
- children =
- [?TLFIELD(<<"text-single">>, <<"Jabber ID">>,
- <<"jid">>)]
- ++
- lists:map(fun ({Name, Value}) ->
- ?TLFIELD(<<"text-single">>, Name,
- Value)
- end,
- SearchReported)}.
+ Fields = [?TLFIELD(<<"text-single">>, Name, Value) ||
+ {Name, Value} <- [{<<"Jabber ID">>, <<"jid">>} | SearchReported]],
+ mongoose_data_forms:reported_element(Fields).
%%--------------------------------------------------------------------
%% API
diff --git a/src/vcard/mod_vcard_mnesia.erl b/src/vcard/mod_vcard_mnesia.erl
index 8ff8c0fd5d..a1338045de 100644
--- a/src/vcard/mod_vcard_mnesia.erl
+++ b/src/vcard/mod_vcard_mnesia.erl
@@ -183,7 +183,7 @@ record_to_item(R) ->
{User, Server} = R#vcard_search.user,
#xmlel{name = <<"item">>,
children = [
- ?FIELD(<<"jid">>, [User, <<"@">>, Server]),
+ ?FIELD(<<"jid">>, <>),
?FIELD(<<"fn">>, (R#vcard_search.fn)),
?FIELD(<<"last">>, (R#vcard_search.family)),
?FIELD(<<"first">>, (R#vcard_search.given)),