Merge pull request #1 from badlop/fix-unified

Several fixes for compilation, dialyzer, documentation and "make options"

Author: erebion

mod_unified_push/README.md

@@ -1,15 +1,16 @@
-# mod_unified_push - Conversations-compatible UnifiedPush push server implementation 
+# mod_unified_push - Conversations-compatible UnifiedPush push server implementation
 
 - Author: itd (https://codeberg.org/itd)
 - Copyright (C) 2025 itd
 
 This module adds Unified Push support compatible with Conversations.
 
-To interact with the custom IQ stanzas, this project includes code generated with the xmpp library [0] using the steps outlined in [1].
-See `xmpp_spec.patch` for details on the spec update.
-
-[0]: https://github.com/processone/xmpp
-[1]: https://github.com/processone/xmpp/issues/9#issue-205855303
+ejabberd newer than 25.04 is required,
+as it requires an updated version of the
+[xmpp erlang library](https://github.com/processone/xmpp)
+that includes the improvements from the file `xmpp_spec.patch`.
+Or you can
+[apply the patch yourself](https://github.com/processone/xmpp/issues/9#issue-205855303)
 
 ## Configuration
 

mod_unified_push/src/mod_unified_push.erl

@@ -56,21 +56,7 @@
 %% IQ handler
 -export([iq_handler/1]).
 
-%% Exports for XMPP-generated code
--export([
-    do_decode/4,
-    tags/0,
-    do_encode/2,
-    do_get_name/1,
-    do_get_ns/1,
-    pp/2,
-    records/0,
-    decode_unified_push_register/3,
-    decode_unified_push_register_attrs/4,
-    encode_unified_push_register/2,
-    decode_unified_push_register_attr_application/2,
-    decode_unified_push_register_attr_instance/2
-]).
+-type ttl_timeout() :: undefined | non_neg_integer().
 
 %% API subpaths
 -define(ENDPOINT_PUSH, "push").
@@ -84,7 +70,7 @@
 -define(UP_INSTANCE, <<"i">>).
 
 %% called by ejabberd_http
--spec process([binary()], http_request()) -> {integer(), [{binary(), binary()}], binary()}.
+-spec process([binary()], http_request()) -> {integer(), [{binary(), binary()}], [binary()]}.
 process(_LocalPath, #request{method = 'POST', data = <<>>}) ->
     ?DEBUG("bad POST request for ~p: no data", [_LocalPath]),
     {400, [], []};
@@ -99,28 +85,28 @@ process([], #request{method = 'GET'}) ->
         [
             {<<"Content-Type">>, <<"application/json">>}
         ],
-        ["{\"unifiedpush\":{\"version\":1}}"]};
+        [<<"{\"unifiedpush\":{\"version\":1}}">>]};
 process([<<?ENDPOINT_MESSAGE>> | _], _Request) ->
     %% RFC8030: 6.2.
     {410, [], []};
 process(_LocalPath, _Request) ->
     ?DEBUG("bad request for ~p: ~p", [_LocalPath, _Request]),
     {400, [], []}.
 
--spec get_ttl([{atom(), binary()}]) -> integer().
+-spec get_ttl([{atom(), binary()}]) -> ttl_timeout().
 get_ttl(Headers) ->
     try string:to_integer(proplists:get_value(<<"Ttl">>, Headers, "1")) of
-        {T, <<>>} -> T;
-        {_, _} -> -1
+        {T, <<>>} when T >= 0 -> T;
+        {_, _} -> undefined
     catch
         _:_ ->
             %% assume illegal behavior
-            -1
+            undefined
     end.
 
--spec validate_request(binary(), binary(), binary(), binary(), integer()) ->
-    {integer(), [{binary(), binary()}], binary()}.
-validate_request(_Host, _Jwk, _MaybeJwtToken, _Data, Ttl) when Ttl < 0 ->
+-spec validate_request(binary(), any(), binary(), binary(), ttl_timeout()) ->
+    {integer(), [{binary(), binary()}], []}.
+validate_request(_Host, _Jwk, _MaybeJwtToken, _Data, undefined) ->
     {400, [], []};
 validate_request(Host, Jwk, MaybeJwtToken, Data, Ttl) when Data =/= <<"">> ->
     ?DEBUG("verifying jwt validity", []),
@@ -156,8 +142,8 @@ validate_request(Host, Jwk, MaybeJwtToken, Data, Ttl) when Data =/= <<"">> ->
 validate_request(_Host, _Jwk, _MaybeJwtToken, _Data, _Ttl) ->
     {400, [], []}.
 
--spec forward_push_message(binary(), binary(), binary(), integer(), map()) ->
-    {integer(), [{binary(), binary()}], binary()}.
+-spec forward_push_message(binary(), binary(), binary(), ttl_timeout(), map()) ->
+    {integer(), [{binary(), binary()}], []}.
 forward_push_message(Host, Jwt, Data, Ttl, #{
     ?UP_APPLICATION := Application, ?UP_INSTANCE := Instance, ?UP_OWNER := To
 }) ->
@@ -179,6 +165,7 @@ forward_push_message(Host, Jwt, Data, Ttl, #{
             ?DEBUG("~p: IQ callback: ~p", [?MODULE, _Res]),
             ok
         end,
+        undefined,
         Ttl
     ),
     UrlPrefix = misc:expand_keyword(<<"@HOST@">>, guess_url_prefix(any), Host),
@@ -250,7 +237,7 @@ get_jwk(Host) ->
 -spec mod_opt_type(atom()) -> econf:validator().
 mod_opt_type(expiration) ->
     %% TODO is there an upper bound for the validity of the JWT token?
-    econf:int(0, 60 * 60 * 24);
+    econf:int(0, 86400); %% 60 * 60 * 24
 mod_opt_type(jwk) ->
     econf:map(econf:binary(), econf:either(econf:binary(), econf:int())).
 
@@ -334,20 +321,3 @@ mod_doc() ->
             "    jwk: {\"k\" => \"a4-...\",\"kty\" => \"oct\"}"
         ]
     }.
-
-%% FIXME The following lines add support for the custom IQ stanza.
-%%       If possible they should be moved to the xmpp package.
-%% Created automatically by XML generator (fxml_gen.erl)
-%% Source: xmpp_codec.spec
-
-do_decode(
-    <<"push">>,
-    <<"http://gultsch.de/xmpp/drafts/unified-push">>,
-    El,
-    Opts
-) ->
-    decode_unified_push_push(
-        <<"http://gultsch.de/xmpp/drafts/unified-push">>,
-        Opts,
-        El
-    );