2021-11-23 06:43:54 +01:00
|
|
|
%%%----------------------------------------------------------------------
|
|
|
|
|
%%% File : mod_conversejs.erl
|
|
|
|
|
%%% Author : Alexey Shchepin <alexey@process-one.net>
|
2021-12-01 10:22:41 +01:00
|
|
|
%%% Purpose : Serve simple page for Converse.js XMPP web browser client
|
2021-11-23 06:43:54 +01:00
|
|
|
%%% Created : 8 Nov 2021 by Alexey Shchepin <alexey@process-one.net>
|
|
|
|
|
%%%
|
|
|
|
|
%%%
|
2024-01-22 16:40:01 +01:00
|
|
|
%%% ejabberd, Copyright (C) 2002-2024 ProcessOne
|
2021-11-23 06:43:54 +01:00
|
|
|
%%%
|
|
|
|
|
%%% This program is free software; you can redistribute it and/or
|
|
|
|
|
%%% modify it under the terms of the GNU General Public License as
|
|
|
|
|
%%% published by the Free Software Foundation; either version 2 of the
|
|
|
|
|
%%% License, or (at your option) any later version.
|
|
|
|
|
%%%
|
|
|
|
|
%%% This program is distributed in the hope that it will be useful,
|
|
|
|
|
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
|
%%% General Public License for more details.
|
|
|
|
|
%%%
|
|
|
|
|
%%% You should have received a copy of the GNU General Public License along
|
|
|
|
|
%%% with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
|
|
|
%%%
|
|
|
|
|
%%%----------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
-module(mod_conversejs).
|
|
|
|
|
|
|
|
|
|
-author('alexey@process-one.net').
|
|
|
|
|
|
|
|
|
|
-behaviour(gen_mod).
|
|
|
|
|
|
|
|
|
|
-export([start/2, stop/1, reload/3, process/2, depends/2,
|
|
|
|
|
mod_opt_type/1, mod_options/1, mod_doc/0]).
|
|
|
|
|
|
|
|
|
|
-include_lib("xmpp/include/xmpp.hrl").
|
|
|
|
|
-include("logger.hrl").
|
|
|
|
|
-include("ejabberd_http.hrl").
|
|
|
|
|
-include("translate.hrl").
|
|
|
|
|
-include("ejabberd_web_admin.hrl").
|
|
|
|
|
|
|
|
|
|
start(_Host, _Opts) ->
|
|
|
|
|
ok.
|
|
|
|
|
|
|
|
|
|
stop(_Host) ->
|
|
|
|
|
ok.
|
|
|
|
|
|
|
|
|
|
reload(_Host, _NewOpts, _OldOpts) ->
|
|
|
|
|
ok.
|
|
|
|
|
|
|
|
|
|
depends(_Host, _Opts) ->
|
|
|
|
|
[].
|
|
|
|
|
|
2022-03-28 15:47:17 +02:00
|
|
|
process([], #request{method = 'GET', host = Host, raw_path = RawPath}) ->
|
2022-04-05 13:28:54 +02:00
|
|
|
ExtraOptions = get_auth_options(Host)
|
|
|
|
|
++ get_register_options(Host)
|
|
|
|
|
++ get_extra_options(Host),
|
2024-02-28 11:31:16 +01:00
|
|
|
Domain = mod_conversejs_opt:default_domain(Host),
|
2022-03-28 15:47:17 +02:00
|
|
|
Script = get_file_url(Host, conversejs_script,
|
|
|
|
|
<<RawPath/binary, "/converse.min.js">>,
|
|
|
|
|
<<"https://cdn.conversejs.org/dist/converse.min.js">>),
|
|
|
|
|
CSS = get_file_url(Host, conversejs_css,
|
|
|
|
|
<<RawPath/binary, "/converse.min.css">>,
|
|
|
|
|
<<"https://cdn.conversejs.org/dist/converse.min.css">>),
|
2021-11-23 06:43:54 +01:00
|
|
|
Init = [{<<"discover_connection_methods">>, false},
|
|
|
|
|
{<<"default_domain">>, Domain},
|
|
|
|
|
{<<"domain_placeholder">>, Domain},
|
2022-03-28 15:47:17 +02:00
|
|
|
{<<"registration_domain">>, Domain},
|
|
|
|
|
{<<"assets_path">>, RawPath},
|
2022-03-31 21:24:04 +02:00
|
|
|
{<<"view_mode">>, <<"fullscreen">>}
|
|
|
|
|
| ExtraOptions],
|
2021-11-23 06:43:54 +01:00
|
|
|
Init2 =
|
2022-03-31 21:01:48 +02:00
|
|
|
case mod_host_meta:get_url(?MODULE, websocket, any, Host) of
|
2021-11-23 06:43:54 +01:00
|
|
|
undefined -> Init;
|
|
|
|
|
WSURL -> [{<<"websocket_url">>, WSURL} | Init]
|
|
|
|
|
end,
|
|
|
|
|
Init3 =
|
2022-03-31 21:01:48 +02:00
|
|
|
case mod_host_meta:get_url(?MODULE, bosh, any, Host) of
|
2021-11-23 06:43:54 +01:00
|
|
|
undefined -> Init2;
|
|
|
|
|
BoshURL -> [{<<"bosh_service_url">>, BoshURL} | Init2]
|
|
|
|
|
end,
|
2024-05-06 17:07:26 +02:00
|
|
|
Init4 = maps:from_list(Init3),
|
2021-11-23 06:43:54 +01:00
|
|
|
{200, [html],
|
|
|
|
|
[<<"<!DOCTYPE html>">>,
|
|
|
|
|
<<"<html>">>,
|
|
|
|
|
<<"<head>">>,
|
|
|
|
|
<<"<meta charset='utf-8'>">>,
|
|
|
|
|
<<"<link rel='stylesheet' type='text/css' media='screen' href='">>,
|
|
|
|
|
fxml:crypt(CSS), <<"'>">>,
|
|
|
|
|
<<"<script src='">>, fxml:crypt(Script), <<"' charset='utf-8'></script>">>,
|
|
|
|
|
<<"</head>">>,
|
|
|
|
|
<<"<body>">>,
|
|
|
|
|
<<"<script>">>,
|
2024-05-06 18:02:36 +02:00
|
|
|
<<"converse.initialize(">>, misc:json_encode(Init4), <<");">>,
|
2021-11-23 06:43:54 +01:00
|
|
|
<<"</script>">>,
|
|
|
|
|
<<"</body>">>,
|
|
|
|
|
<<"</html>">>]};
|
2022-03-28 15:47:17 +02:00
|
|
|
process(LocalPath, #request{host = Host}) ->
|
|
|
|
|
case is_served_file(LocalPath) of
|
|
|
|
|
true -> serve(Host, LocalPath);
|
|
|
|
|
false -> ejabberd_web:error(not_found)
|
|
|
|
|
end.
|
|
|
|
|
|
|
|
|
|
%%----------------------------------------------------------------------
|
|
|
|
|
%% File server
|
|
|
|
|
%%----------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
is_served_file([<<"converse.min.js">>]) -> true;
|
|
|
|
|
is_served_file([<<"converse.min.css">>]) -> true;
|
|
|
|
|
is_served_file([<<"converse.min.js.map">>]) -> true;
|
|
|
|
|
is_served_file([<<"converse.min.css.map">>]) -> true;
|
|
|
|
|
is_served_file([<<"emojis.js">>]) -> true;
|
|
|
|
|
is_served_file([<<"locales">>, _]) -> true;
|
|
|
|
|
is_served_file([<<"locales">>, <<"dayjs">>, _]) -> true;
|
|
|
|
|
is_served_file([<<"webfonts">>, _]) -> true;
|
|
|
|
|
is_served_file(_) -> false.
|
|
|
|
|
|
|
|
|
|
serve(Host, LocalPath) ->
|
|
|
|
|
case get_conversejs_resources(Host) of
|
2022-11-23 16:28:42 +01:00
|
|
|
undefined ->
|
|
|
|
|
Path = str:join(LocalPath, <<"/">>),
|
|
|
|
|
{303, [{<<"Location">>, <<"https://cdn.conversejs.org/dist/", Path/binary>>}], <<>>};
|
2022-03-28 15:47:17 +02:00
|
|
|
MainPath -> serve2(LocalPath, MainPath)
|
|
|
|
|
end.
|
|
|
|
|
|
|
|
|
|
get_conversejs_resources(Host) ->
|
|
|
|
|
Opts = gen_mod:get_module_opts(Host, ?MODULE),
|
|
|
|
|
mod_conversejs_opt:conversejs_resources(Opts).
|
|
|
|
|
|
|
|
|
|
%% Copied from mod_muc_log_http.erl
|
|
|
|
|
|
|
|
|
|
serve2(LocalPathBin, MainPathBin) ->
|
|
|
|
|
LocalPath = [binary_to_list(LPB) || LPB <- LocalPathBin],
|
|
|
|
|
MainPath = binary_to_list(MainPathBin),
|
|
|
|
|
FileName = filename:join(filename:split(MainPath) ++ LocalPath),
|
|
|
|
|
case file:read_file(FileName) of
|
|
|
|
|
{ok, FileContents} ->
|
|
|
|
|
?DEBUG("Delivering content.", []),
|
|
|
|
|
{200,
|
|
|
|
|
[{<<"Content-Type">>, content_type(FileName)}],
|
|
|
|
|
FileContents};
|
|
|
|
|
{error, eisdir} ->
|
|
|
|
|
{403, [], "Forbidden"};
|
|
|
|
|
{error, Error} ->
|
|
|
|
|
?DEBUG("Delivering error: ~p", [Error]),
|
|
|
|
|
case Error of
|
|
|
|
|
eacces -> {403, [], "Forbidden"};
|
|
|
|
|
enoent -> {404, [], "Not found"};
|
|
|
|
|
_Else -> {404, [], atom_to_list(Error)}
|
|
|
|
|
end
|
|
|
|
|
end.
|
|
|
|
|
|
|
|
|
|
content_type(Filename) ->
|
|
|
|
|
case string:to_lower(filename:extension(Filename)) of
|
|
|
|
|
".css" -> "text/css";
|
|
|
|
|
".js" -> "text/javascript";
|
|
|
|
|
".map" -> "application/json";
|
|
|
|
|
".ttf" -> "font/ttf";
|
|
|
|
|
".woff" -> "font/woff";
|
|
|
|
|
".woff2" -> "font/woff2"
|
|
|
|
|
end.
|
|
|
|
|
|
|
|
|
|
%%----------------------------------------------------------------------
|
|
|
|
|
%% Options parsing
|
|
|
|
|
%%----------------------------------------------------------------------
|
|
|
|
|
|
2022-04-05 13:28:54 +02:00
|
|
|
get_auth_options(Domain) ->
|
|
|
|
|
case {ejabberd_auth_anonymous:is_login_anonymous_enabled(Domain),
|
|
|
|
|
ejabberd_auth_anonymous:is_sasl_anonymous_enabled(Domain)} of
|
|
|
|
|
{false, false} ->
|
|
|
|
|
[{<<"authentication">>, <<"login">>}];
|
|
|
|
|
{true, false} ->
|
|
|
|
|
[{<<"authentication">>, <<"external">>}];
|
|
|
|
|
{_, true} ->
|
|
|
|
|
[{<<"authentication">>, <<"anonymous">>},
|
|
|
|
|
{<<"jid">>, Domain}]
|
|
|
|
|
end.
|
|
|
|
|
|
|
|
|
|
get_register_options(Server) ->
|
|
|
|
|
AuthSupportsRegister =
|
|
|
|
|
lists:any(
|
|
|
|
|
fun(ejabberd_auth_mnesia) -> true;
|
|
|
|
|
(ejabberd_auth_external) -> true;
|
|
|
|
|
(ejabberd_auth_sql) -> true;
|
|
|
|
|
(_) -> false
|
|
|
|
|
end,
|
|
|
|
|
ejabberd_auth:auth_modules(Server)),
|
2022-05-23 16:41:19 +02:00
|
|
|
Modules = get_register_modules(Server),
|
2022-04-05 13:28:54 +02:00
|
|
|
ModRegisterAllowsMe = (Modules == all) orelse lists:member(?MODULE, Modules),
|
|
|
|
|
[{<<"allow_registration">>, AuthSupportsRegister and ModRegisterAllowsMe}].
|
|
|
|
|
|
2022-05-23 16:41:19 +02:00
|
|
|
get_register_modules(Server) ->
|
|
|
|
|
try mod_register_opt:allow_modules(Server)
|
|
|
|
|
catch
|
|
|
|
|
error:{module_not_loaded, mod_register, _} ->
|
|
|
|
|
?DEBUG("mod_conversejs couldn't get mod_register configuration for "
|
|
|
|
|
"vhost ~p: module not loaded in that vhost.", [Server]),
|
|
|
|
|
[]
|
|
|
|
|
end.
|
|
|
|
|
|
2022-03-31 21:24:04 +02:00
|
|
|
get_extra_options(Host) ->
|
|
|
|
|
RawOpts = gen_mod:get_module_opt(Host, ?MODULE, conversejs_options),
|
|
|
|
|
lists:map(fun({Name, <<"true">>}) -> {Name, true};
|
|
|
|
|
({Name, <<"false">>}) -> {Name, false};
|
|
|
|
|
({<<"locked_domain">> = Name, Value}) ->
|
|
|
|
|
{Name, misc:expand_keyword(<<"@HOST@">>, Value, Host)};
|
|
|
|
|
({Name, Value}) ->
|
|
|
|
|
{Name, Value}
|
|
|
|
|
end,
|
|
|
|
|
RawOpts).
|
|
|
|
|
|
2022-03-28 15:47:17 +02:00
|
|
|
get_file_url(Host, Option, Filename, Default) ->
|
|
|
|
|
FileRaw = case gen_mod:get_module_opt(Host, ?MODULE, Option) of
|
|
|
|
|
auto -> get_auto_file_url(Host, Filename, Default);
|
|
|
|
|
F -> F
|
|
|
|
|
end,
|
|
|
|
|
misc:expand_keyword(<<"@HOST@">>, FileRaw, Host).
|
|
|
|
|
|
|
|
|
|
get_auto_file_url(Host, Filename, Default) ->
|
|
|
|
|
case get_conversejs_resources(Host) of
|
|
|
|
|
undefined -> Default;
|
|
|
|
|
_ -> Filename
|
|
|
|
|
end.
|
|
|
|
|
|
|
|
|
|
%%----------------------------------------------------------------------
|
|
|
|
|
%%
|
|
|
|
|
%%----------------------------------------------------------------------
|
2021-11-23 06:43:54 +01:00
|
|
|
|
|
|
|
|
mod_opt_type(bosh_service_url) ->
|
2022-03-31 21:01:48 +02:00
|
|
|
econf:either(auto, econf:binary());
|
2021-11-23 06:43:54 +01:00
|
|
|
mod_opt_type(websocket_url) ->
|
2022-03-31 21:01:48 +02:00
|
|
|
econf:either(auto, econf:binary());
|
2022-03-28 15:47:17 +02:00
|
|
|
mod_opt_type(conversejs_resources) ->
|
|
|
|
|
econf:either(undefined, econf:directory());
|
2022-03-31 21:24:04 +02:00
|
|
|
mod_opt_type(conversejs_options) ->
|
|
|
|
|
econf:map(econf:binary(), econf:either(econf:binary(), econf:int()));
|
2021-11-23 06:43:54 +01:00
|
|
|
mod_opt_type(conversejs_script) ->
|
|
|
|
|
econf:binary();
|
|
|
|
|
mod_opt_type(conversejs_css) ->
|
|
|
|
|
econf:binary();
|
|
|
|
|
mod_opt_type(default_domain) ->
|
2024-02-28 11:31:16 +01:00
|
|
|
econf:host().
|
2021-11-23 06:43:54 +01:00
|
|
|
|
2024-02-28 11:31:16 +01:00
|
|
|
mod_options(Host) ->
|
2022-03-31 21:01:48 +02:00
|
|
|
[{bosh_service_url, auto},
|
|
|
|
|
{websocket_url, auto},
|
2024-02-28 11:31:16 +01:00
|
|
|
{default_domain, Host},
|
2022-03-28 15:47:17 +02:00
|
|
|
{conversejs_resources, undefined},
|
2022-03-31 21:24:04 +02:00
|
|
|
{conversejs_options, []},
|
2022-03-28 15:47:17 +02:00
|
|
|
{conversejs_script, auto},
|
|
|
|
|
{conversejs_css, auto}].
|
2021-11-23 06:43:54 +01:00
|
|
|
|
|
|
|
|
mod_doc() ->
|
|
|
|
|
#{desc =>
|
2021-12-01 10:22:41 +01:00
|
|
|
[?T("This module serves a simple page for the "
|
|
|
|
|
"https://conversejs.org/[Converse] XMPP web browser client."), "",
|
2021-11-23 06:43:54 +01:00
|
|
|
?T("To use this module, in addition to adding it to the 'modules' "
|
|
|
|
|
"section, you must also enable it in 'listen' -> 'ejabberd_http' -> "
|
2024-03-14 12:38:03 +01:00
|
|
|
"_`listen-options.md#request_handlers|request_handlers`_."), "",
|
2022-03-31 21:01:48 +02:00
|
|
|
?T("Make sure either 'mod_bosh' or 'ejabberd_http_ws' "
|
2024-03-14 12:38:03 +01:00
|
|
|
"_`listen-options.md#request_handlers|request_handlers`_ "
|
2022-03-31 21:01:48 +02:00
|
|
|
"are enabled."), "",
|
2022-03-28 15:47:17 +02:00
|
|
|
?T("When 'conversejs_css' and 'conversejs_script' are 'auto', "
|
|
|
|
|
"by default they point to the public Converse client.")
|
2021-12-01 10:22:41 +01:00
|
|
|
],
|
2024-03-28 03:24:28 +01:00
|
|
|
note => "added in 21.12 and improved in 22.05",
|
2022-03-31 19:14:09 +02:00
|
|
|
example =>
|
|
|
|
|
[{?T("Manually setup WebSocket url, and use the public Converse client:"),
|
|
|
|
|
["listen:",
|
|
|
|
|
" -",
|
|
|
|
|
" port: 5280",
|
|
|
|
|
" module: ejabberd_http",
|
|
|
|
|
" request_handlers:",
|
|
|
|
|
" /bosh: mod_bosh",
|
|
|
|
|
" /websocket: ejabberd_http_ws",
|
|
|
|
|
" /conversejs: mod_conversejs",
|
|
|
|
|
"",
|
|
|
|
|
"modules:",
|
|
|
|
|
" mod_bosh: {}",
|
|
|
|
|
" mod_conversejs:",
|
|
|
|
|
" websocket_url: \"ws://@HOST@:5280/websocket\""]},
|
|
|
|
|
{?T("Host Converse locally and let auto detection of WebSocket and Converse URLs:"),
|
|
|
|
|
["listen:",
|
|
|
|
|
" -",
|
|
|
|
|
" port: 443",
|
|
|
|
|
" module: ejabberd_http",
|
|
|
|
|
" tls: true",
|
|
|
|
|
" request_handlers:",
|
|
|
|
|
" /websocket: ejabberd_http_ws",
|
|
|
|
|
" /conversejs: mod_conversejs",
|
|
|
|
|
"",
|
|
|
|
|
"modules:",
|
|
|
|
|
" mod_conversejs:",
|
|
|
|
|
" conversejs_resources: \"/home/ejabberd/conversejs-9.0.0/package/dist\""]},
|
|
|
|
|
{?T("Configure some additional options for Converse"),
|
|
|
|
|
["modules:",
|
|
|
|
|
" mod_conversejs:",
|
|
|
|
|
" websocket_url: auto",
|
|
|
|
|
" conversejs_options:",
|
|
|
|
|
" auto_away: 30",
|
|
|
|
|
" clear_cache_on_logout: true",
|
|
|
|
|
" i18n: \"pt\"",
|
|
|
|
|
" locked_domain: \"@HOST@\"",
|
|
|
|
|
" message_archiving: always",
|
2022-04-06 13:00:44 +02:00
|
|
|
" theme: dracula"]}
|
2022-03-31 19:14:09 +02:00
|
|
|
],
|
2021-11-23 06:43:54 +01:00
|
|
|
opts =>
|
|
|
|
|
[{websocket_url,
|
2022-03-31 21:01:48 +02:00
|
|
|
#{value => ?T("auto | WebSocketURL"),
|
2021-11-23 06:43:54 +01:00
|
|
|
desc =>
|
2022-03-31 21:01:48 +02:00
|
|
|
?T("A WebSocket URL to which Converse can connect to. "
|
|
|
|
|
"The keyword '@HOST@' is replaced with the real virtual "
|
|
|
|
|
"host name. "
|
|
|
|
|
"If set to 'auto', it will build the URL of the first "
|
|
|
|
|
"configured WebSocket request handler. "
|
|
|
|
|
"The default value is 'auto'.")}},
|
2021-11-23 06:43:54 +01:00
|
|
|
{bosh_service_url,
|
2022-03-31 21:01:48 +02:00
|
|
|
#{value => ?T("auto | BoshURL"),
|
2021-11-23 06:43:54 +01:00
|
|
|
desc =>
|
2022-03-31 21:01:48 +02:00
|
|
|
?T("BOSH service URL to which Converse can connect to. "
|
|
|
|
|
"The keyword '@HOST@' is replaced with the real "
|
|
|
|
|
"virtual host name. "
|
|
|
|
|
"If set to 'auto', it will build the URL of the first "
|
|
|
|
|
"configured BOSH request handler. "
|
|
|
|
|
"The default value is 'auto'.")}},
|
2021-11-23 06:43:54 +01:00
|
|
|
{default_domain,
|
|
|
|
|
#{value => ?T("Domain"),
|
|
|
|
|
desc =>
|
2021-12-01 10:22:41 +01:00
|
|
|
?T("Specify a domain to act as the default for user JIDs. "
|
2022-03-28 15:47:17 +02:00
|
|
|
"The keyword '@HOST@' is replaced with the hostname. "
|
|
|
|
|
"The default value is '@HOST@'.")}},
|
|
|
|
|
{conversejs_resources,
|
|
|
|
|
#{value => ?T("Path"),
|
2022-05-04 15:18:57 +02:00
|
|
|
note => "added in 22.05",
|
2022-03-28 15:47:17 +02:00
|
|
|
desc =>
|
|
|
|
|
?T("Local path to the Converse files. "
|
|
|
|
|
"If not set, the public Converse client will be used instead.")}},
|
2022-03-31 21:24:04 +02:00
|
|
|
{conversejs_options,
|
|
|
|
|
#{value => "{Name: Value}",
|
2022-05-04 15:18:57 +02:00
|
|
|
note => "added in 22.05",
|
2022-03-31 21:24:04 +02:00
|
|
|
desc =>
|
|
|
|
|
?T("Specify additional options to be passed to Converse. "
|
|
|
|
|
"See https://conversejs.org/docs/html/configuration.html[Converse configuration]. "
|
|
|
|
|
"Only boolean, integer and string values are supported; "
|
|
|
|
|
"lists are not supported.")}},
|
2021-11-23 06:43:54 +01:00
|
|
|
{conversejs_script,
|
2022-03-28 15:47:17 +02:00
|
|
|
#{value => ?T("auto | URL"),
|
2021-11-23 06:43:54 +01:00
|
|
|
desc =>
|
2022-03-28 15:47:17 +02:00
|
|
|
?T("Converse main script URL. "
|
|
|
|
|
"The keyword '@HOST@' is replaced with the hostname. "
|
|
|
|
|
"The default value is 'auto'.")}},
|
2021-11-23 06:43:54 +01:00
|
|
|
{conversejs_css,
|
2022-03-28 15:47:17 +02:00
|
|
|
#{value => ?T("auto | URL"),
|
2021-11-23 06:43:54 +01:00
|
|
|
desc =>
|
2022-03-28 15:47:17 +02:00
|
|
|
?T("Converse CSS URL. "
|
|
|
|
|
"The keyword '@HOST@' is replaced with the hostname. "
|
|
|
|
|
"The default value is 'auto'.")}}]
|
2021-11-23 06:43:54 +01:00
|
|
|
}.
|
