2015-03-11 14:14:28 +01:00
|
|
|
%%%----------------------------------------------------------------------
|
|
|
|
%%% File : ext_mod.erl
|
|
|
|
%%% Author : Christophe Romain <christophe.romain@process-one.net>
|
|
|
|
%%% Purpose : external modules management
|
|
|
|
%%% Created : 19 Feb 2015 by Christophe Romain <christophe.romain@process-one.net>
|
|
|
|
%%%
|
|
|
|
%%%
|
2020-01-28 13:34:02 +01:00
|
|
|
%%% ejabberd, Copyright (C) 2006-2020 ProcessOne
|
2015-03-11 14:14:28 +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(ext_mod).
|
2015-06-01 14:38:27 +02:00
|
|
|
|
2017-02-26 13:10:59 +01:00
|
|
|
-behaviour(gen_server).
|
2015-03-11 14:14:28 +01:00
|
|
|
-author("Christophe Romain <christophe.romain@process-one.net>").
|
|
|
|
|
2017-02-26 13:10:59 +01:00
|
|
|
-export([start_link/0, update/0, check/1,
|
2016-12-07 09:27:21 +01:00
|
|
|
available_command/0, available/0, available/1,
|
|
|
|
installed_command/0, installed/0, installed/1,
|
2019-04-03 12:50:28 +02:00
|
|
|
install/1, uninstall/1, upgrade/0, upgrade/1, add_paths/0,
|
2018-05-22 16:16:13 +02:00
|
|
|
add_sources/1, add_sources/2, del_sources/1, modules_dir/0,
|
2019-06-14 11:33:26 +02:00
|
|
|
config_dir/0, get_commands_spec/0]).
|
2019-11-07 08:47:11 +01:00
|
|
|
-export([modules_configs/0, module_ebin_dir/1]).
|
2016-12-07 09:27:21 +01:00
|
|
|
-export([compile_erlang_file/2, compile_elixir_file/2]).
|
2015-03-11 14:14:28 +01:00
|
|
|
|
2017-02-26 13:10:59 +01:00
|
|
|
%% gen_server callbacks
|
|
|
|
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
|
|
|
|
terminate/2, code_change/3]).
|
|
|
|
|
2015-03-11 14:14:28 +01:00
|
|
|
-include("ejabberd_commands.hrl").
|
2015-10-23 17:21:19 +02:00
|
|
|
-include("logger.hrl").
|
2015-03-11 14:14:28 +01:00
|
|
|
|
|
|
|
-define(REPOS, "https://github.com/processone/ejabberd-contrib").
|
|
|
|
|
2017-02-26 13:10:59 +01:00
|
|
|
-record(state, {}).
|
|
|
|
|
|
|
|
start_link() ->
|
|
|
|
gen_server:start_link({local, ?MODULE}, ?MODULE, [], []).
|
2015-03-11 14:14:28 +01:00
|
|
|
|
2017-02-26 13:10:59 +01:00
|
|
|
init([]) ->
|
|
|
|
process_flag(trap_exit, true),
|
2019-04-03 12:50:28 +02:00
|
|
|
add_paths(),
|
2018-04-23 17:40:44 +02:00
|
|
|
application:start(inets),
|
|
|
|
inets:start(httpc, [{profile, ext_mod}]),
|
2017-02-26 13:10:59 +01:00
|
|
|
ejabberd_commands:register_commands(get_commands_spec()),
|
|
|
|
{ok, #state{}}.
|
|
|
|
|
2019-04-03 12:50:28 +02:00
|
|
|
add_paths() ->
|
|
|
|
[code:add_patha(module_ebin_dir(Module))
|
|
|
|
|| {Module, _} <- installed()].
|
|
|
|
|
2019-07-12 10:55:36 +02:00
|
|
|
handle_call(Request, From, State) ->
|
|
|
|
?WARNING_MSG("Unexpected call from ~p: ~p", [From, Request]),
|
|
|
|
{noreply, State}.
|
2015-03-11 14:14:28 +01:00
|
|
|
|
2019-07-12 10:55:36 +02:00
|
|
|
handle_cast(Msg, State) ->
|
|
|
|
?WARNING_MSG("Unexpected cast: ~p", [Msg]),
|
2017-02-26 13:10:59 +01:00
|
|
|
{noreply, State}.
|
|
|
|
|
2019-07-12 10:55:36 +02:00
|
|
|
handle_info(Info, State) ->
|
|
|
|
?WARNING_MSG("Unexpected info: ~p", [Info]),
|
2017-02-26 13:10:59 +01:00
|
|
|
{noreply, State}.
|
|
|
|
|
|
|
|
terminate(_Reason, _State) ->
|
2016-01-26 10:00:11 +01:00
|
|
|
ejabberd_commands:unregister_commands(get_commands_spec()).
|
2015-03-11 14:14:28 +01:00
|
|
|
|
2017-02-26 13:10:59 +01:00
|
|
|
code_change(_OldVsn, State, _Extra) ->
|
|
|
|
{ok, State}.
|
|
|
|
|
|
|
|
%% -- ejabberd commands
|
2016-01-26 10:00:11 +01:00
|
|
|
get_commands_spec() ->
|
2015-03-13 11:54:32 +01:00
|
|
|
[#ejabberd_commands{name = modules_update_specs,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "Update the module source code from Git",
|
|
|
|
longdesc = "A connection to Internet is required",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = update,
|
|
|
|
args = [],
|
2017-06-20 14:45:31 +02:00
|
|
|
result = {res, rescode}},
|
2015-03-13 11:54:32 +01:00
|
|
|
#ejabberd_commands{name = modules_available,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "List the contributed modules available to install",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = available_command,
|
2017-07-21 11:18:44 +02:00
|
|
|
result_desc = "List of tuples with module name and description",
|
|
|
|
result_example = [{mod_cron, "Execute scheduled commands"},
|
|
|
|
{mod_rest, "ReST frontend"}],
|
2015-03-11 14:14:28 +01:00
|
|
|
args = [],
|
|
|
|
result = {modules, {list,
|
|
|
|
{module, {tuple,
|
|
|
|
[{name, atom},
|
|
|
|
{summary, string}]}}}}},
|
2015-03-13 11:54:32 +01:00
|
|
|
#ejabberd_commands{name = modules_installed,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "List the contributed modules already installed",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = installed_command,
|
2017-07-21 11:18:44 +02:00
|
|
|
result_desc = "List of tuples with module name and description",
|
|
|
|
result_example = [{mod_cron, "Execute scheduled commands"},
|
|
|
|
{mod_rest, "ReST frontend"}],
|
2015-03-11 14:14:28 +01:00
|
|
|
args = [],
|
|
|
|
result = {modules, {list,
|
|
|
|
{module, {tuple,
|
|
|
|
[{name, atom},
|
|
|
|
{summary, string}]}}}}},
|
2015-03-13 11:54:32 +01:00
|
|
|
#ejabberd_commands{name = module_install,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "Compile, install and start an available contributed module",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = install,
|
2017-07-21 11:42:03 +02:00
|
|
|
args_desc = ["Module name"],
|
|
|
|
args_example = [<<"mod_rest">>],
|
2015-03-11 14:14:28 +01:00
|
|
|
args = [{module, binary}],
|
2017-06-20 14:45:31 +02:00
|
|
|
result = {res, rescode}},
|
2015-03-13 11:54:32 +01:00
|
|
|
#ejabberd_commands{name = module_uninstall,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "Uninstall a contributed module",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = uninstall,
|
2017-07-21 11:42:03 +02:00
|
|
|
args_desc = ["Module name"],
|
|
|
|
args_example = [<<"mod_rest">>],
|
2015-03-11 14:14:28 +01:00
|
|
|
args = [{module, binary}],
|
2017-06-20 14:45:31 +02:00
|
|
|
result = {res, rescode}},
|
2015-03-13 11:54:32 +01:00
|
|
|
#ejabberd_commands{name = module_upgrade,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "Upgrade the running code of an installed module",
|
|
|
|
longdesc = "In practice, this uninstalls and installs the module",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = upgrade,
|
2017-07-21 11:42:03 +02:00
|
|
|
args_desc = ["Module name"],
|
|
|
|
args_example = [<<"mod_rest">>],
|
2015-03-11 14:14:28 +01:00
|
|
|
args = [{module, binary}],
|
2017-06-20 14:45:31 +02:00
|
|
|
result = {res, rescode}},
|
2015-03-13 11:54:32 +01:00
|
|
|
#ejabberd_commands{name = module_check,
|
2015-03-11 14:14:28 +01:00
|
|
|
tags = [admin,modules],
|
2017-07-21 11:18:44 +02:00
|
|
|
desc = "Check the contributed module repository compliance",
|
2015-03-11 14:14:28 +01:00
|
|
|
module = ?MODULE, function = check,
|
2017-07-21 11:42:03 +02:00
|
|
|
args_desc = ["Module name"],
|
|
|
|
args_example = [<<"mod_rest">>],
|
2015-03-11 14:14:28 +01:00
|
|
|
args = [{module, binary}],
|
2017-06-20 14:45:31 +02:00
|
|
|
result = {res, rescode}}
|
2015-03-11 14:14:28 +01:00
|
|
|
].
|
|
|
|
%% -- public modules functions
|
|
|
|
|
|
|
|
update() ->
|
2017-08-01 13:33:14 +02:00
|
|
|
Contrib = maps:put(?REPOS, [], maps:new()),
|
|
|
|
Jungles = lists:foldl(fun({Package, Spec}, Acc) ->
|
|
|
|
Repo = proplists:get_value(url, Spec, ""),
|
|
|
|
Mods = maps:get(Repo, Acc, []),
|
|
|
|
maps:put(Repo, [Package|Mods], Acc)
|
|
|
|
end, Contrib, modules_spec(sources_dir(), "*/*")),
|
|
|
|
Repos = maps:fold(fun(Repo, _Mods, Acc) ->
|
|
|
|
Update = add_sources(Repo),
|
2019-09-23 14:17:20 +02:00
|
|
|
?INFO_MSG("Update packages from repo ~ts: ~p", [Repo, Update]),
|
2017-08-01 13:33:14 +02:00
|
|
|
case Update of
|
|
|
|
ok -> Acc;
|
|
|
|
Error -> [{repository, Repo, Error}|Acc]
|
|
|
|
end
|
|
|
|
end, [], Jungles),
|
2015-10-23 17:21:19 +02:00
|
|
|
Res = lists:foldl(fun({Package, Spec}, Acc) ->
|
2017-08-01 13:33:14 +02:00
|
|
|
Repo = proplists:get_value(url, Spec, ""),
|
|
|
|
Update = add_sources(Package, Repo),
|
2019-09-23 14:17:20 +02:00
|
|
|
?INFO_MSG("Update package ~ts: ~p", [Package, Update]),
|
2015-10-23 17:21:19 +02:00
|
|
|
case Update of
|
|
|
|
ok -> Acc;
|
2017-08-01 13:33:14 +02:00
|
|
|
Error -> [{Package, Repo, Error}|Acc]
|
2015-10-23 17:21:19 +02:00
|
|
|
end
|
2017-08-01 13:33:14 +02:00
|
|
|
end, Repos, modules_spec(sources_dir(), "*")),
|
2015-10-23 17:21:19 +02:00
|
|
|
case Res of
|
|
|
|
[] -> ok;
|
|
|
|
[Error|_] -> Error
|
|
|
|
end.
|
2015-03-11 14:14:28 +01:00
|
|
|
|
|
|
|
available() ->
|
|
|
|
Jungle = modules_spec(sources_dir(), "*/*"),
|
|
|
|
Standalone = modules_spec(sources_dir(), "*"),
|
|
|
|
lists:keysort(1,
|
|
|
|
lists:foldl(fun({Key, Val}, Acc) ->
|
|
|
|
lists:keystore(Key, 1, Acc, {Key, Val})
|
|
|
|
end, Jungle, Standalone)).
|
|
|
|
available(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
available(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
available(Package) when is_binary(Package) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
Available = [misc:atom_to_binary(K) || K<-proplists:get_keys(available())],
|
2015-03-11 14:14:28 +01:00
|
|
|
lists:member(Package, Available).
|
|
|
|
|
|
|
|
available_command() ->
|
|
|
|
[short_spec(Item) || Item <- available()].
|
|
|
|
|
|
|
|
installed() ->
|
|
|
|
modules_spec(modules_dir(), "*").
|
|
|
|
installed(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
installed(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
installed(Package) when is_binary(Package) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
Installed = [misc:atom_to_binary(K) || K<-proplists:get_keys(installed())],
|
2015-03-11 14:14:28 +01:00
|
|
|
lists:member(Package, Installed).
|
|
|
|
|
|
|
|
installed_command() ->
|
|
|
|
[short_spec(Item) || Item <- installed()].
|
|
|
|
|
|
|
|
install(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
install(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
install(Package) when is_binary(Package) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
Spec = [S || {Mod, S} <- available(), misc:atom_to_binary(Mod)==Package],
|
2015-03-11 14:14:28 +01:00
|
|
|
case {Spec, installed(Package), is_contrib_allowed()} of
|
|
|
|
{_, _, false} ->
|
|
|
|
{error, not_allowed};
|
|
|
|
{[], _, _} ->
|
|
|
|
{error, not_available};
|
|
|
|
{_, true, _} ->
|
|
|
|
{error, conflict};
|
|
|
|
{[Attrs], _, _} ->
|
2017-04-11 12:13:58 +02:00
|
|
|
Module = misc:binary_to_atom(Package),
|
2015-03-11 14:14:28 +01:00
|
|
|
case compile_and_install(Module, Attrs) of
|
|
|
|
ok ->
|
|
|
|
code:add_patha(module_ebin_dir(Module)),
|
2019-06-14 11:33:26 +02:00
|
|
|
ejabberd_config:reload(),
|
2016-11-28 17:15:57 +01:00
|
|
|
case erlang:function_exported(Module, post_install, 0) of
|
|
|
|
true -> Module:post_install();
|
|
|
|
_ -> ok
|
|
|
|
end;
|
2015-03-11 14:14:28 +01:00
|
|
|
Error ->
|
|
|
|
delete_path(module_lib_dir(Module)),
|
|
|
|
Error
|
|
|
|
end
|
|
|
|
end.
|
|
|
|
|
|
|
|
uninstall(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
uninstall(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
uninstall(Package) when is_binary(Package) ->
|
|
|
|
case installed(Package) of
|
|
|
|
true ->
|
2017-04-11 12:13:58 +02:00
|
|
|
Module = misc:binary_to_atom(Package),
|
2016-11-28 17:15:57 +01:00
|
|
|
case erlang:function_exported(Module, pre_uninstall, 0) of
|
|
|
|
true -> Module:pre_uninstall();
|
|
|
|
_ -> ok
|
|
|
|
end,
|
2015-03-11 14:14:28 +01:00
|
|
|
[catch gen_mod:stop_module(Host, Module)
|
2019-06-14 11:33:26 +02:00
|
|
|
|| Host <- ejabberd_option:hosts()],
|
2015-03-11 14:14:28 +01:00
|
|
|
code:purge(Module),
|
|
|
|
code:delete(Module),
|
|
|
|
code:del_path(module_ebin_dir(Module)),
|
2015-07-24 15:09:57 +02:00
|
|
|
delete_path(module_lib_dir(Module)),
|
2019-06-14 11:33:26 +02:00
|
|
|
ejabberd_config:reload();
|
2015-03-11 14:14:28 +01:00
|
|
|
false ->
|
|
|
|
{error, not_installed}
|
|
|
|
end.
|
|
|
|
|
|
|
|
upgrade() ->
|
|
|
|
[{Package, upgrade(Package)} || {Package, _Spec} <- installed()].
|
|
|
|
upgrade(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
upgrade(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
upgrade(Package) when is_binary(Package) ->
|
|
|
|
uninstall(Package),
|
|
|
|
install(Package).
|
|
|
|
|
|
|
|
add_sources(Path) when is_list(Path) ->
|
2015-03-13 17:59:19 +01:00
|
|
|
add_sources(iolist_to_binary(module_name(Path)), Path).
|
2015-03-11 14:14:28 +01:00
|
|
|
add_sources(_, "") ->
|
|
|
|
{error, no_url};
|
|
|
|
add_sources(Module, Path) when is_atom(Module), is_list(Path) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
add_sources(misc:atom_to_binary(Module), Path);
|
2015-03-11 14:14:28 +01:00
|
|
|
add_sources(Package, Path) when is_binary(Package), is_list(Path) ->
|
|
|
|
DestDir = sources_dir(),
|
|
|
|
RepDir = filename:join(DestDir, module_name(Path)),
|
|
|
|
delete_path(RepDir),
|
|
|
|
case filelib:ensure_dir(RepDir) of
|
|
|
|
ok ->
|
|
|
|
case {string:left(Path, 4), string:right(Path, 2)} of
|
|
|
|
{"http", "ip"} -> extract(zip, geturl(Path), DestDir);
|
|
|
|
{"http", "gz"} -> extract(tar, geturl(Path), DestDir);
|
|
|
|
{"http", _} -> extract_url(Path, DestDir);
|
|
|
|
{"git@", _} -> extract_github_master(Path, DestDir);
|
|
|
|
{_, "ip"} -> extract(zip, Path, DestDir);
|
|
|
|
{_, "gz"} -> extract(tar, Path, DestDir);
|
|
|
|
_ -> {error, unsupported_source}
|
|
|
|
end;
|
|
|
|
Error ->
|
|
|
|
Error
|
|
|
|
end.
|
|
|
|
|
|
|
|
del_sources(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
del_sources(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
del_sources(Package) when is_binary(Package) ->
|
|
|
|
case uninstall(Package) of
|
|
|
|
ok ->
|
2017-04-11 12:13:58 +02:00
|
|
|
SrcDir = module_src_dir(misc:binary_to_atom(Package)),
|
2015-03-11 14:14:28 +01:00
|
|
|
delete_path(SrcDir);
|
|
|
|
Error ->
|
|
|
|
Error
|
|
|
|
end.
|
|
|
|
|
|
|
|
check(Module) when is_atom(Module) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
check(misc:atom_to_binary(Module));
|
2015-03-11 14:14:28 +01:00
|
|
|
check(Package) when is_binary(Package) ->
|
|
|
|
case {available(Package), installed(Package)} of
|
|
|
|
{false, _} ->
|
|
|
|
{error, not_available};
|
|
|
|
{_, false} ->
|
|
|
|
Status = install(Package),
|
|
|
|
uninstall(Package),
|
|
|
|
case Status of
|
2017-04-11 12:13:58 +02:00
|
|
|
ok -> check_sources(misc:binary_to_atom(Package));
|
2015-03-11 14:14:28 +01:00
|
|
|
Error -> Error
|
|
|
|
end;
|
|
|
|
_ ->
|
2017-04-11 12:13:58 +02:00
|
|
|
check_sources(misc:binary_to_atom(Package))
|
2015-03-11 14:14:28 +01:00
|
|
|
end.
|
|
|
|
|
|
|
|
%% -- archives and variables functions
|
|
|
|
|
|
|
|
geturl(Url) ->
|
2018-04-23 17:40:44 +02:00
|
|
|
case getenv("PROXY_SERVER", "", ":") of
|
|
|
|
[H, Port] ->
|
|
|
|
httpc:set_options([{proxy, {{H, list_to_integer(Port)}, []}}], ext_mod);
|
|
|
|
[H] ->
|
|
|
|
httpc:set_options([{proxy, {{H, 8080}, []}}], ext_mod);
|
|
|
|
_ ->
|
|
|
|
ok
|
2015-03-11 14:14:28 +01:00
|
|
|
end,
|
|
|
|
User = case getenv("PROXY_USER", "", [4]) of
|
2018-04-23 17:40:44 +02:00
|
|
|
[U, Pass] -> [{proxy_auth, {U, Pass}}];
|
2015-03-11 14:14:28 +01:00
|
|
|
_ -> []
|
|
|
|
end,
|
2018-04-23 17:40:44 +02:00
|
|
|
case httpc:request(get, {Url, []}, User, [{body_format, binary}], ext_mod) of
|
|
|
|
{ok, {{_, 200, _}, Headers, Response}} ->
|
2015-03-11 14:14:28 +01:00
|
|
|
{ok, Headers, Response};
|
2018-04-23 17:40:44 +02:00
|
|
|
{ok, {{_, Code, _}, _Headers, Response}} ->
|
2015-03-11 14:14:28 +01:00
|
|
|
{error, {Code, Response}};
|
|
|
|
{error, Reason} ->
|
|
|
|
{error, Reason}
|
|
|
|
end.
|
|
|
|
|
|
|
|
getenv(Env) ->
|
|
|
|
getenv(Env, "").
|
|
|
|
getenv(Env, Default) ->
|
|
|
|
case os:getenv(Env) of
|
|
|
|
false -> Default;
|
|
|
|
"" -> Default;
|
|
|
|
Value -> Value
|
|
|
|
end.
|
|
|
|
getenv(Env, Default, Separator) ->
|
|
|
|
string:tokens(getenv(Env, Default), Separator).
|
|
|
|
|
|
|
|
extract(zip, {ok, _, Body}, DestDir) ->
|
|
|
|
extract(zip, iolist_to_binary(Body), DestDir);
|
|
|
|
extract(tar, {ok, _, Body}, DestDir) ->
|
|
|
|
extract(tar, {binary, iolist_to_binary(Body)}, DestDir);
|
|
|
|
extract(_, {error, Reason}, _) ->
|
|
|
|
{error, Reason};
|
|
|
|
extract(zip, Zip, DestDir) ->
|
|
|
|
case zip:extract(Zip, [{cwd, DestDir}]) of
|
|
|
|
{ok, _} -> ok;
|
|
|
|
Error -> Error
|
|
|
|
end;
|
|
|
|
extract(tar, Tar, DestDir) ->
|
2015-03-11 17:15:42 +01:00
|
|
|
erl_tar:extract(Tar, [compressed, {cwd, DestDir}]).
|
2015-03-11 14:14:28 +01:00
|
|
|
|
|
|
|
extract_url(Path, DestDir) ->
|
|
|
|
hd([extract_github_master(Path, DestDir) || string:str(Path, "github") > 0]
|
|
|
|
++[{error, unsupported_source}]).
|
|
|
|
|
|
|
|
extract_github_master(Repos, DestDir) ->
|
2015-04-29 10:19:15 +02:00
|
|
|
Base = case string:tokens(Repos, ":") of
|
|
|
|
["git@github.com", T1] -> "https://github.com/"++T1;
|
|
|
|
_ -> Repos
|
|
|
|
end,
|
|
|
|
Url = case lists:reverse(Base) of
|
|
|
|
[$t,$i,$g,$.|T2] -> lists:reverse(T2);
|
|
|
|
_ -> Base
|
|
|
|
end,
|
|
|
|
case extract(zip, geturl(Url++"/archive/master.zip"), DestDir) of
|
2015-03-11 14:14:28 +01:00
|
|
|
ok ->
|
|
|
|
RepDir = filename:join(DestDir, module_name(Repos)),
|
|
|
|
file:rename(RepDir++"-master", RepDir);
|
|
|
|
Error ->
|
|
|
|
Error
|
|
|
|
end.
|
|
|
|
|
2015-04-29 13:30:03 +02:00
|
|
|
copy(From, To) ->
|
|
|
|
case filelib:is_dir(From) of
|
|
|
|
true ->
|
|
|
|
Copy = fun(F) ->
|
|
|
|
SubFrom = filename:join(From, F),
|
|
|
|
SubTo = filename:join(To, F),
|
|
|
|
copy(SubFrom, SubTo)
|
|
|
|
end,
|
2016-12-07 09:27:21 +01:00
|
|
|
lists:foldl(fun(ok, ok) -> ok;
|
|
|
|
(ok, Error) -> Error;
|
2015-04-29 13:30:03 +02:00
|
|
|
(Error, _) -> Error
|
2016-12-07 09:27:21 +01:00
|
|
|
end, ok,
|
2015-04-29 13:30:03 +02:00
|
|
|
[Copy(filename:basename(X)) || X<-filelib:wildcard(From++"/*")]);
|
|
|
|
false ->
|
|
|
|
filelib:ensure_dir(To),
|
2016-12-07 09:27:21 +01:00
|
|
|
case file:copy(From, To) of
|
|
|
|
{ok, _} -> ok;
|
|
|
|
Error -> Error
|
|
|
|
end
|
2015-04-29 13:30:03 +02:00
|
|
|
end.
|
2015-03-11 14:14:28 +01:00
|
|
|
|
|
|
|
delete_path(Path) ->
|
|
|
|
case filelib:is_dir(Path) of
|
|
|
|
true ->
|
|
|
|
[delete_path(SubPath) || SubPath <- filelib:wildcard(Path++"/*")],
|
|
|
|
file:del_dir(Path);
|
|
|
|
false ->
|
|
|
|
file:delete(Path)
|
|
|
|
end.
|
|
|
|
|
|
|
|
modules_dir() ->
|
|
|
|
DefaultDir = filename:join(getenv("HOME"), ".ejabberd-modules"),
|
|
|
|
getenv("CONTRIB_MODULES_PATH", DefaultDir).
|
|
|
|
|
|
|
|
sources_dir() ->
|
|
|
|
filename:join(modules_dir(), "sources").
|
|
|
|
|
2015-09-22 12:49:55 +02:00
|
|
|
config_dir() ->
|
|
|
|
DefaultDir = filename:join(modules_dir(), "conf"),
|
|
|
|
getenv("CONTRIB_MODULES_CONF_DIR", DefaultDir).
|
|
|
|
|
2019-11-07 08:47:11 +01:00
|
|
|
-spec modules_configs() -> [binary()].
|
|
|
|
modules_configs() ->
|
|
|
|
Fs = [{filename:rootname(filename:basename(F)), F}
|
|
|
|
|| F <- filelib:wildcard(config_dir() ++ "/*.{yml,yaml}")
|
|
|
|
++ filelib:wildcard(modules_dir() ++ "/*/conf/*.{yml,yaml}")],
|
|
|
|
[unicode:characters_to_binary(proplists:get_value(F, Fs))
|
|
|
|
|| F <- proplists:get_keys(Fs)].
|
|
|
|
|
2015-03-11 14:14:28 +01:00
|
|
|
module_lib_dir(Package) ->
|
|
|
|
filename:join(modules_dir(), Package).
|
|
|
|
|
|
|
|
module_ebin_dir(Package) ->
|
|
|
|
filename:join(module_lib_dir(Package), "ebin").
|
|
|
|
|
|
|
|
module_src_dir(Package) ->
|
|
|
|
Rep = module_name(Package),
|
|
|
|
SrcDir = sources_dir(),
|
|
|
|
Standalone = filelib:wildcard(Rep, SrcDir),
|
|
|
|
Jungle = filelib:wildcard("*/"++Rep, SrcDir),
|
|
|
|
case Standalone++Jungle of
|
|
|
|
[RepDir|_] -> filename:join(SrcDir, RepDir);
|
|
|
|
_ -> filename:join(SrcDir, Rep)
|
|
|
|
end.
|
|
|
|
|
|
|
|
module_name(Id) ->
|
|
|
|
filename:basename(filename:rootname(Id)).
|
|
|
|
|
|
|
|
module(Id) ->
|
2017-04-11 12:13:58 +02:00
|
|
|
misc:binary_to_atom(iolist_to_binary(module_name(Id))).
|
2015-03-11 14:14:28 +01:00
|
|
|
|
|
|
|
module_spec(Spec) ->
|
|
|
|
[{path, filename:dirname(Spec)}
|
|
|
|
| case consult(Spec) of
|
|
|
|
{ok, Meta} -> Meta;
|
|
|
|
_ -> []
|
|
|
|
end].
|
|
|
|
|
|
|
|
modules_spec(Dir, Path) ->
|
|
|
|
Wildcard = filename:join(Path, "*.spec"),
|
|
|
|
lists:sort(
|
|
|
|
[{module(Match), module_spec(filename:join(Dir, Match))}
|
|
|
|
|| Match <- filelib:wildcard(Wildcard, Dir)]).
|
|
|
|
|
|
|
|
short_spec({Module, Attrs}) when is_atom(Module), is_list(Attrs) ->
|
|
|
|
{Module, proplists:get_value(summary, Attrs, "")}.
|
|
|
|
|
|
|
|
is_contrib_allowed() ->
|
2019-06-14 11:33:26 +02:00
|
|
|
ejabberd_option:allow_contrib_modules().
|
2015-03-11 14:14:28 +01:00
|
|
|
|
|
|
|
%% -- build functions
|
|
|
|
|
|
|
|
check_sources(Module) ->
|
|
|
|
SrcDir = module_src_dir(Module),
|
|
|
|
SpecFile = filename:flatten([Module, ".spec"]),
|
|
|
|
{ok, Dir} = file:get_cwd(),
|
|
|
|
file:set_cwd(SrcDir),
|
|
|
|
HaveSrc = case filelib:is_dir("src") or filelib:is_dir("lib") of
|
|
|
|
true -> [];
|
|
|
|
false -> [{missing, "src (Erlang) or lib (Elixir) sources directory"}]
|
|
|
|
end,
|
|
|
|
DirCheck = lists:foldl(
|
|
|
|
fun({Type, Name}, Acc) ->
|
|
|
|
case filelib:Type(Name) of
|
|
|
|
true -> Acc;
|
|
|
|
false -> [{missing, Name}|Acc]
|
|
|
|
end
|
|
|
|
end, HaveSrc, [{is_file, "README.txt"},
|
|
|
|
{is_file, "COPYING"},
|
|
|
|
{is_file, SpecFile}]),
|
|
|
|
SpecCheck = case consult(SpecFile) of
|
|
|
|
{ok, Spec} ->
|
|
|
|
lists:foldl(
|
|
|
|
fun(Key, Acc) ->
|
|
|
|
case lists:keysearch(Key, 1, Spec) of
|
|
|
|
false -> [{missing_meta, Key}|Acc];
|
|
|
|
{value, {Key, [_NoEmpty|_]}} -> Acc;
|
|
|
|
{value, {Key, Val}} -> [{invalid_meta, {Key, Val}}|Acc]
|
|
|
|
end
|
|
|
|
end, [], [author, summary, home, url]);
|
|
|
|
{error, Error} ->
|
|
|
|
[{invalid_spec, Error}]
|
|
|
|
end,
|
|
|
|
file:set_cwd(Dir),
|
|
|
|
Result = DirCheck ++ SpecCheck,
|
|
|
|
case Result of
|
|
|
|
[] -> ok;
|
|
|
|
_ -> {error, Result}
|
|
|
|
end.
|
|
|
|
|
|
|
|
compile_and_install(Module, Spec) ->
|
|
|
|
SrcDir = module_src_dir(Module),
|
|
|
|
LibDir = module_lib_dir(Module),
|
|
|
|
case filelib:is_dir(SrcDir) of
|
|
|
|
true ->
|
2016-12-07 09:27:21 +01:00
|
|
|
case compile_deps(SrcDir) of
|
2015-07-22 10:48:44 +02:00
|
|
|
ok ->
|
2016-12-07 09:27:21 +01:00
|
|
|
case compile(SrcDir) of
|
|
|
|
ok -> install(Module, Spec, SrcDir, LibDir);
|
2015-07-22 10:48:44 +02:00
|
|
|
Error -> Error
|
|
|
|
end;
|
|
|
|
Error ->
|
|
|
|
Error
|
2016-12-07 09:27:21 +01:00
|
|
|
end;
|
2015-03-11 14:14:28 +01:00
|
|
|
false ->
|
|
|
|
Path = proplists:get_value(url, Spec, ""),
|
|
|
|
case add_sources(Module, Path) of
|
|
|
|
ok -> compile_and_install(Module, Spec);
|
|
|
|
Error -> Error
|
|
|
|
end
|
|
|
|
end.
|
|
|
|
|
2016-12-07 09:27:21 +01:00
|
|
|
compile_deps(LibDir) ->
|
|
|
|
Deps = filename:join(LibDir, "deps"),
|
|
|
|
case filelib:is_dir(Deps) of
|
|
|
|
true -> ok; % assume deps are included
|
|
|
|
false -> fetch_rebar_deps(LibDir)
|
2015-07-22 10:48:44 +02:00
|
|
|
end,
|
2016-12-07 09:27:21 +01:00
|
|
|
Rs = [compile(Dep) || Dep <- filelib:wildcard(filename:join(Deps, "*"))],
|
|
|
|
compile_result(Rs).
|
|
|
|
|
|
|
|
compile(LibDir) ->
|
|
|
|
Bin = filename:join(LibDir, "ebin"),
|
|
|
|
Inc = filename:join(LibDir, "include"),
|
|
|
|
Lib = filename:join(LibDir, "lib"),
|
|
|
|
Src = filename:join(LibDir, "src"),
|
|
|
|
Options = [{outdir, Bin}, {i, Inc} | compile_options()],
|
|
|
|
filelib:ensure_dir(filename:join(Bin, ".")),
|
|
|
|
[copy(App, Bin) || App <- filelib:wildcard(Src++"/*.app")],
|
|
|
|
Er = [compile_erlang_file(Bin, File, Options)
|
|
|
|
|| File <- filelib:wildcard(Src++"/*.erl")],
|
|
|
|
Ex = [compile_elixir_file(Bin, File)
|
|
|
|
|| File <- filelib:wildcard(Lib ++ "/*.ex")],
|
|
|
|
compile_result(Er++Ex).
|
|
|
|
|
|
|
|
compile_result(Results) ->
|
2015-07-22 10:48:44 +02:00
|
|
|
case lists:dropwhile(
|
2016-12-07 09:27:21 +01:00
|
|
|
fun({ok, _}) -> true;
|
|
|
|
(_) -> false
|
|
|
|
end, Results) of
|
2015-07-22 10:48:44 +02:00
|
|
|
[] -> ok;
|
|
|
|
[Error|_] -> Error
|
|
|
|
end.
|
|
|
|
|
2016-12-07 09:27:21 +01:00
|
|
|
compile_options() ->
|
2020-03-03 11:18:07 +01:00
|
|
|
[verbose, report_errors, report_warnings, ?ALL_DEFS]
|
2017-04-07 12:09:43 +02:00
|
|
|
++ [{i, filename:join(app_dir(App), "include")}
|
2017-08-01 13:33:14 +02:00
|
|
|
|| App <- [fast_xml, xmpp, p1_utils, ejabberd]]
|
|
|
|
++ [{i, filename:join(mod_dir(Mod), "include")}
|
|
|
|
|| Mod <- installed()].
|
2016-12-07 09:27:21 +01:00
|
|
|
|
2017-04-07 12:09:43 +02:00
|
|
|
app_dir(App) ->
|
|
|
|
case code:lib_dir(App) of
|
|
|
|
{error, bad_name} ->
|
|
|
|
case code:which(App) of
|
|
|
|
Beam when is_list(Beam) ->
|
|
|
|
filename:dirname(filename:dirname(Beam));
|
|
|
|
_ ->
|
|
|
|
"."
|
|
|
|
end;
|
|
|
|
Dir ->
|
|
|
|
Dir
|
|
|
|
end.
|
|
|
|
|
2017-08-01 13:33:14 +02:00
|
|
|
mod_dir({Package, Spec}) ->
|
|
|
|
Default = filename:join(modules_dir(), Package),
|
|
|
|
proplists:get_value(path, Spec, Default).
|
|
|
|
|
2016-12-07 09:27:21 +01:00
|
|
|
compile_erlang_file(Dest, File) ->
|
|
|
|
compile_erlang_file(Dest, File, compile_options()).
|
|
|
|
|
|
|
|
compile_erlang_file(Dest, File, ErlOptions) ->
|
|
|
|
Options = [{outdir, Dest} | ErlOptions],
|
|
|
|
case compile:file(File, Options) of
|
|
|
|
{ok, Module} -> {ok, Module};
|
|
|
|
{ok, Module, _} -> {ok, Module};
|
|
|
|
{ok, Module, _, _} -> {ok, Module};
|
|
|
|
error -> {error, {compilation_failed, File}};
|
|
|
|
{error, E, W} -> {error, {compilation_failed, File, E, W}}
|
2015-03-11 14:14:28 +01:00
|
|
|
end.
|
|
|
|
|
2019-06-14 11:33:26 +02:00
|
|
|
-ifdef(ELIXIR_ENABLED).
|
2016-07-05 12:36:49 +02:00
|
|
|
compile_elixir_file(Dest, File) when is_list(Dest) and is_list(File) ->
|
|
|
|
compile_elixir_file(list_to_binary(Dest), list_to_binary(File));
|
|
|
|
|
|
|
|
compile_elixir_file(Dest, File) ->
|
|
|
|
try 'Elixir.Kernel.ParallelCompiler':files_to_path([File], Dest, []) of
|
|
|
|
[Module] -> {ok, Module}
|
|
|
|
catch
|
2016-12-07 09:27:21 +01:00
|
|
|
_ -> {error, {compilation_failed, File}}
|
2016-07-05 12:36:49 +02:00
|
|
|
end.
|
2019-06-14 11:33:26 +02:00
|
|
|
-else.
|
|
|
|
compile_elixir_file(_, File) ->
|
|
|
|
{error, {compilation_failed, File}}.
|
|
|
|
-endif.
|
2016-07-05 12:36:49 +02:00
|
|
|
|
2016-12-07 09:27:21 +01:00
|
|
|
install(Module, Spec, SrcDir, LibDir) ->
|
|
|
|
{ok, CurDir} = file:get_cwd(),
|
|
|
|
file:set_cwd(SrcDir),
|
2017-03-13 11:26:58 +01:00
|
|
|
Files1 = [{File, copy(File, filename:join(LibDir, File))}
|
|
|
|
|| File <- filelib:wildcard("{ebin,priv,conf,include}/**")],
|
|
|
|
Files2 = [{File, copy(File, filename:join(LibDir, filename:join(lists:nthtail(2,filename:split(File)))))}
|
|
|
|
|| File <- filelib:wildcard("deps/*/{ebin,priv}/**")],
|
2016-12-07 09:27:21 +01:00
|
|
|
Errors = lists:dropwhile(fun({_, ok}) -> true;
|
2015-04-29 13:30:03 +02:00
|
|
|
(_) -> false
|
2017-03-13 11:26:58 +01:00
|
|
|
end, Files1++Files2),
|
2015-04-29 13:30:03 +02:00
|
|
|
Result = case Errors of
|
|
|
|
[{F, {error, E}}|_] ->
|
|
|
|
{error, {F, E}};
|
|
|
|
[] ->
|
|
|
|
SpecPath = proplists:get_value(path, Spec),
|
|
|
|
SpecFile = filename:flatten([Module, ".spec"]),
|
2016-12-07 09:27:21 +01:00
|
|
|
copy(filename:join(SpecPath, SpecFile), filename:join(LibDir, SpecFile))
|
2015-04-29 13:30:03 +02:00
|
|
|
end,
|
2016-12-07 09:27:21 +01:00
|
|
|
file:set_cwd(CurDir),
|
|
|
|
Result.
|
2015-03-11 14:14:28 +01:00
|
|
|
|
2015-07-22 10:48:44 +02:00
|
|
|
%% -- minimalist rebar spec parser, only support git
|
|
|
|
|
2016-12-07 09:27:21 +01:00
|
|
|
fetch_rebar_deps(SrcDir) ->
|
|
|
|
case rebar_deps(filename:join(SrcDir, "rebar.config"))
|
|
|
|
++ rebar_deps(filename:join(SrcDir, "rebar.config.script")) of
|
2015-07-22 10:48:44 +02:00
|
|
|
[] ->
|
|
|
|
ok;
|
|
|
|
Deps ->
|
2016-12-07 09:27:21 +01:00
|
|
|
{ok, CurDir} = file:get_cwd(),
|
|
|
|
file:set_cwd(SrcDir),
|
2015-07-22 10:48:44 +02:00
|
|
|
filelib:ensure_dir(filename:join("deps", ".")),
|
|
|
|
lists:foreach(fun({_App, Cmd}) ->
|
|
|
|
os:cmd("cd deps; "++Cmd++"; cd ..")
|
2016-12-07 09:27:21 +01:00
|
|
|
end, Deps),
|
|
|
|
file:set_cwd(CurDir)
|
2015-07-22 10:48:44 +02:00
|
|
|
end.
|
2016-12-07 09:27:21 +01:00
|
|
|
|
2015-07-22 10:48:44 +02:00
|
|
|
rebar_deps(Script) ->
|
|
|
|
case file:script(Script) of
|
|
|
|
{ok, Config} when is_list(Config) ->
|
|
|
|
[rebar_dep(Dep) || Dep <- proplists:get_value(deps, Config, [])];
|
|
|
|
{ok, {deps, Deps}} ->
|
|
|
|
[rebar_dep(Dep) || Dep <- Deps];
|
|
|
|
_ ->
|
|
|
|
[]
|
|
|
|
end.
|
|
|
|
rebar_dep({App, _, {git, Url}}) ->
|
|
|
|
{App, "git clone "++Url++" "++filename:basename(App)};
|
|
|
|
rebar_dep({App, _, {git, Url, {branch, Ref}}}) ->
|
|
|
|
{App, "git clone -n "++Url++" "++filename:basename(App)++
|
|
|
|
"; (cd "++filename:basename(App)++
|
|
|
|
"; git checkout -q origin/"++Ref++")"};
|
|
|
|
rebar_dep({App, _, {git, Url, {tag, Ref}}}) ->
|
|
|
|
{App, "git clone -n "++Url++" "++filename:basename(App)++
|
|
|
|
"; (cd "++filename:basename(App)++
|
|
|
|
"; git checkout -q "++Ref++")"};
|
|
|
|
rebar_dep({App, _, {git, Url, Ref}}) ->
|
|
|
|
{App, "git clone -n "++Url++" "++filename:basename(App)++
|
|
|
|
"; (cd "++filename:basename(App)++
|
|
|
|
"; git checkout -q "++Ref++")"}.
|
|
|
|
|
2015-03-11 14:14:28 +01:00
|
|
|
%% -- YAML spec parser
|
|
|
|
|
|
|
|
consult(File) ->
|
2016-02-03 11:30:48 +01:00
|
|
|
case fast_yaml:decode_from_file(File, [plain_as_atom]) of
|
2015-03-11 14:14:28 +01:00
|
|
|
{ok, []} -> {ok, []};
|
|
|
|
{ok, [Doc|_]} -> {ok, [format(Spec) || Spec <- Doc]};
|
2016-02-03 11:30:48 +01:00
|
|
|
{error, Err} -> {error, fast_yaml:format_error(Err)}
|
2015-03-11 14:14:28 +01:00
|
|
|
end.
|
|
|
|
|
|
|
|
format({Key, Val}) when is_binary(Val) ->
|
|
|
|
{Key, binary_to_list(Val)};
|
|
|
|
format({Key, Val}) -> % TODO: improve Yaml parsing
|
|
|
|
{Key, Val}.
|