allow to set landing_page to auto

Author: sstrigler

src/ejabberd_captcha.erl

@@ -454,7 +454,7 @@ get_prog_name() ->
 
 maybe_warning_norequesthandler() ->
     Host = hd(ejabberd_option:hosts()),
-    AutoURL = get_auto_url(any, ?MODULE, Host),
+    AutoURL = ejabberd_http:get_auto_url(any, ?MODULE, Host),
     ManualURL = ejabberd_option:captcha_url(),
     case (AutoURL == undefined) and not is_binary(ManualURL) of
         true ->
@@ -474,7 +474,7 @@ get_url(Str) ->
     case ejabberd_option:captcha_url() of
 	auto ->
             Host =  ejabberd_config:get_myname(),
-            URL = get_auto_url(any, ?MODULE, Host),
+            URL = ejabberd_http:get_auto_url(any, ?MODULE, Host),
             <<URL/binary, $/, Str/binary>>;
 	undefined ->
 	    URL = parse_captcha_host(),
@@ -500,40 +500,6 @@ parse_captcha_host() ->
 	    <<"http://", (ejabberd_config:get_myname())/binary>>
     end.
 
-get_auto_url(Tls, Module, Host) ->
-    case find_handler_port_path(Tls, Module) of
-        [] -> undefined;
-        TPPs ->
-            {ThisTls, Port, Path} = case lists:keyfind(true, 1, TPPs) of
-                                        false ->
-                                            lists:keyfind(false, 1, TPPs);
-                                        TPP ->
-                                            TPP
-                                    end,
-            Protocol = case ThisTls of
-                           false -> <<"http">>;
-                           true -> <<"https">>
-                       end,
-            <<Protocol/binary,
-              "://", Host/binary, ":",
-              (integer_to_binary(Port))/binary,
-              "/",
-              (str:join(Path, <<"/">>))/binary>>
-    end.
-
-find_handler_port_path(Tls, Module) ->
-    lists:filtermap(
-      fun({{Port, _, _},
-           ejabberd_http,
-           #{tls := ThisTls, request_handlers := Handlers}})
-            when is_integer(Port) and ((Tls == any) or (Tls == ThisTls)) ->
-              case lists:keyfind(Module, 2, Handlers) of
-                  false -> false;
-                  {Path, Module} -> {true, {ThisTls, Port, Path}}
-              end;
-         (_) -> false
-      end, ets:tab2list(ejabberd_listener)).
-
 get_transfer_protocol(PortString) ->
     PortNumber = binary_to_integer(PortString),
     PortListeners = get_port_listeners(PortNumber),

src/ejabberd_http.erl

@@ -32,7 +32,8 @@
 -export([start/3, start_link/3,
 	 accept/1, receive_headers/1, recv_file/2,
 	 listen_opt_type/1, listen_options/0,
-	 apply_custom_headers/2]).
+	 apply_custom_headers/2,
+	 get_auto_url/3, find_handler_port_path/2]).
 
 -export([init/3]).
 
@@ -925,3 +926,37 @@ listen_options() ->
      {request_handlers, []},
      {tag, <<>>},
      {custom_headers, []}].
+
+get_auto_url(Tls, Module, Host) ->
+    case find_handler_port_path(Tls, Module) of
+        [] -> undefined;
+        TPPs ->
+            {ThisTls, Port, Path} = case lists:keyfind(true, 1, TPPs) of
+                                        false ->
+                                            lists:keyfind(false, 1, TPPs);
+                                        TPP ->
+                                            TPP
+                                    end,
+            Protocol = case ThisTls of
+                           false -> <<"http">>;
+                           true -> <<"https">>
+                       end,
+            <<Protocol/binary,
+              "://", Host/binary, ":",
+              (integer_to_binary(Port))/binary,
+              "/",
+              (str:join(Path, <<"/">>))/binary>>
+    end.
+
+find_handler_port_path(Tls, Module) ->
+    lists:filtermap(
+      fun({{Port, _, _},
+           ?MODULE,
+           #{tls := ThisTls, request_handlers := Handlers}})
+            when is_integer(Port) and ((Tls == any) or (Tls == ThisTls)) ->
+              case lists:keyfind(Module, 2, Handlers) of
+                  false -> false;
+                  {Path, Module} -> {true, {ThisTls, Port, Path}}
+              end;
+         (_) -> false
+      end, ets:tab2list(ejabberd_listener)).

src/mod_host_meta.erl

@@ -36,6 +36,8 @@
 -export([mod_doc/0]).
 -export([get_url/4, get_auto_url/2]).
 
+-import(ejabberd_http, [find_handler_port_path/2]).
+
 -include("logger.hrl").
 
 -include_lib("xmpp/include/xmpp.hrl").
@@ -163,19 +165,6 @@ get_auto_url(Tls, Module) ->
               (str:join(Path, <<"/">>))/binary>>
     end.
 
-find_handler_port_path(Tls, Module) ->
-    lists:filtermap(
-      fun({{Port, _, _},
-           ejabberd_http,
-           #{tls := ThisTls, request_handlers := Handlers}})
-            when is_integer(Port) and ((Tls == any) or (Tls == ThisTls)) ->
-              case lists:keyfind(Module, 2, Handlers) of
-                  false -> false;
-                  {Path, Module} -> {true, {ThisTls, Port, Path}}
-              end;
-         (_) -> false
-      end, ets:tab2list(ejabberd_listener)).
-
 report_hostmeta_listener() ->
     case {find_handler_port_path(false, ?MODULE),
           find_handler_port_path(true, ?MODULE)} of

src/mod_invites.erl

@@ -94,8 +94,8 @@ mod_doc() ->
                   ?T("Same as top-level _`default_db`_ option, but applied to this "
                      "module only.")}},
            {landing_page,
-            #{value => "none | binary()",
-             desc => ?T("Web address of service handling invite links. This is either a local address handled by `mod_invites` configured as a handler at `ejabberd_http` or an external service like 'easy-xmpp-invitation'. The address must be given as a template pattern with fields from the `invite` that will then get replaced accordingly. Eg.: 'https://{{ host }}:5281/invites/{{ invite.token }}' or as an external service like 'http://{{ host }}:8080/easy-xmpp-invites/#{{ invite.uri|strip_protocol }}'. This is the landing page that is being communicated when creating an invite using one of the ad-hoc commands.")}
+            #{value => "none | auto | LandingPageURLTemplate",
+             desc => ?T("This is the landing page that is being communicated when creating an invite using one of the ad-hoc commands, the web address of service handling invite links. This is either a local address handled by `mod_invites` configured as a handler at `ejabberd_http` or an external service like 'easy-xmpp-invitation'. The address must be given as a template pattern with fields from the `invite` that will then get replaced accordingly. Eg.: 'https://{{ host }}:5281/invites/{{ invite.token }}' or as an external service like 'http://{{ host }}:8080/easy-xmpp-invites/#{{ invite.uri|strip_protocol }}'. For convenience you can choose 'auto' here and the ejabberd_http handler will be used.")}
            },
            {max_invites,
             #{value => "pos_integer() | infinity",
@@ -126,9 +126,12 @@ mod_doc() ->
              "",
              "modules:",
              "  mod_invites:",
-             "    access_create_account: register"]},
+             "    access_create_account: register"
+             "    landing_page: auto"
+			]},
            {?T("If you want all your users to be able to send 'create account' "
-               "invites, you would configure your server like this instead:"),
+               "invites and have a proxy in front of `ejabberd_http` to not expose its port "
+               "directly, you would configure your server like this instead:"),
             ["acl:",
              "  local:",
              "    user_regexp: \"\"",
@@ -138,7 +141,8 @@ mod_doc() ->
              "",
              "modules:",
              "  mod_invites:",
-             "    access_create_account: create_account_invite"]},
+             "    access_create_account: create_account_invite"
+             "    landing_page: https://yourhost/invites/{{ invite.token }}"]},
            ?T("Note that the names of the access rules are just examples and "
               "you're free to change them.")
            %% TODO add example for invite page
@@ -184,7 +188,7 @@ mod_opt_type(access_create_account) ->
 mod_opt_type(db_type) ->
     econf:db_type(?MODULE);
 mod_opt_type(landing_page) ->
-    econf:either(none, econf:binary("^http[s]?://"));
+    econf:either(none, econf:binary());
 mod_opt_type(max_invites) ->
     econf:pos_int(infinity);
 mod_opt_type(site_name) ->

src/mod_invites_http.erl

@@ -63,11 +63,22 @@ landing_page(Host, Invite) ->
     case mod_invites_opt:landing_page(Host) of
         none ->
             <<>>;
+        <<"auto">> ->
+            case ejabberd_http:get_auto_url(any, mod_invites, Host) of
+                undefined ->
+                    ?WARNING_MSG("'auto' URL configured for mod_invites but no request_handler found in your ~s listeners configuration.", [Host]),
+                    <<>>;
+                AutoURL ->
+                    render_landing_page_url(<<AutoURL/binary, "/{{ invite.token }}">>, Host, Invite)
+            end;
         Tmpl ->
-            Ctx = [{invite, invite_to_proplist(Invite)}, {host, Host}],
-            render_url(Tmpl, Ctx)
+            render_landing_page_url(Tmpl, Host, Invite)
     end.
 
+render_landing_page_url(Tmpl, Host, Invite) ->
+    Ctx = [{invite, invite_to_proplist(Invite)}, {host, Host}],
+    render_url(Tmpl, Ctx).
+
 -spec process(LocalPath::[binary()], #request{}) ->
     {HTTPCode::integer(), [{binary(), binary()}], Page::string()}.
 process([?STATIC | StaticFile], #request{host = Host} = Request) ->

src/mod_providers.erl

@@ -39,6 +39,8 @@
 -export([start/2, stop/1, reload/3, process/2, mod_opt_type/1, mod_options/1, depends/2]).
 -export([mod_doc/0]).
 
+-import(ejabberd_http, [find_handler_port_path/2]).
+
 -include("logger.hrl").
 
 -include_lib("xmpp/include/xmpp.hrl").
@@ -51,14 +53,14 @@
 %%| gen_mod callbacks
 
 start(_Host, _Opts) ->
-    report_hostmeta_listener(),
+    report_providers_listener(),
     ok.
 
 stop(_Host) ->
     ok.
 
 reload(_Host, _NewOpts, _OldOpts) ->
-    report_hostmeta_listener(),
+    report_providers_listener(),
     ok.
 
 depends(_Host, _Opts) ->
@@ -172,7 +174,7 @@ get_password_url2(Host) ->
     end.
 
 get_password_url3(Host) ->
-    case find_handler_port_path2(any, mod_register_web) of
+    case find_handler_port_path(any, mod_register_web) of
         [] ->
             <<"">>;
         [{ThisTls, Port, Path} | _] ->
@@ -193,23 +195,6 @@ get_password_url3(Host) ->
               "/">>
     end.
 
-%% TODO Ya hay otra funciona como esta
-find_handler_port_path2(Tls, Module) ->
-    lists:filtermap(fun ({{Port, _, _},
-                          ejabberd_http,
-                          #{tls := ThisTls, request_handlers := Handlers}})
-                            when (Tls == any) or (Tls == ThisTls) ->
-                            case lists:keyfind(Module, 2, Handlers) of
-                                false ->
-                                    false;
-                                {Path, Module} ->
-                                    {true, {ThisTls, Port, Path}}
-                            end;
-                        (_) ->
-                            false
-                    end,
-                    ets:tab2list(ejabberd_listener)).
-
 %%--------------------------------------------------------------------
 %%| Build URLs
 
@@ -222,23 +207,7 @@ build_urls(Host, Url) when not is_atom(Url) ->
     maps:from_list([{L, misc:expand_keyword(<<"@LANGUAGE_URL@">>, Url, L)}
                     || L <- Languages]).
 
-find_handler_port_path(Tls, Module) ->
-    lists:filtermap(fun ({{Port, _, _},
-                          ejabberd_http,
-                          #{tls := ThisTls, request_handlers := Handlers}})
-                            when is_integer(Port) and ((Tls == any) or (Tls == ThisTls)) ->
-                            case lists:keyfind(Module, 2, Handlers) of
-                                false ->
-                                    false;
-                                {Path, Module} ->
-                                    {true, {ThisTls, Port, Path}}
-                            end;
-                        (_) ->
-                            false
-                    end,
-                    ets:tab2list(ejabberd_listener)).
-
-report_hostmeta_listener() ->
+report_providers_listener() ->
     case {find_handler_port_path(false, ?MODULE), find_handler_port_path(true, ?MODULE)} of
         {[], []} ->
             ?CRITICAL_MSG("It seems you enabled ~p in 'modules' but forgot to "

test/ejabberd_SUITE_data/ejabberd.mnesia.yml

@@ -19,7 +19,7 @@ define_macro:
         db_type: internal
       mod_invites:
         db_type: internal
-        landing_page: "http://@HOST@:5280/invites/{{ invite.token }}" # fixme
+        landing_page: auto
       mod_last:
         db_type: internal
       mod_muc:

test/ejabberd_SUITE_data/ejabberd.mysql.yml

@@ -18,6 +18,7 @@ define_macro:
         db_type: sql
       mod_invites:
         db_type: sql
+        landing_page: auto
       mod_last:
         db_type: sql
       mod_muc: