1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (the "License"); you may not use this file except in
%% compliance with the License. You may obtain a copy of the License
%% at http://www.mozilla.org/MPL/
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and
%% limitations under the License.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developer of the Original Code is GoPivotal, Inc.
%% Copyright (c) 2011-2014 GoPivotal, Inc. All rights reserved.
%%
-module(rabbit_plugins).
-include("rabbit.hrl").
-export([setup/0, active/0, read_enabled/1, list/1, dependencies/3]).
-export([ensure/1]).
%%----------------------------------------------------------------------------
-ifdef(use_specs).
-type(plugin_name() :: atom()).
-spec(setup/0 :: () -> [plugin_name()]).
-spec(active/0 :: () -> [plugin_name()]).
-spec(list/1 :: (string()) -> [#plugin{}]).
-spec(read_enabled/1 :: (file:filename()) -> [plugin_name()]).
-spec(dependencies/3 :: (boolean(), [plugin_name()], [#plugin{}]) ->
[plugin_name()]).
-spec(ensure/1 :: (string()) -> {'ok', [atom()], [atom()]} | {error, any()}).
-endif.
%%----------------------------------------------------------------------------
ensure(FileJustChanged) ->
{ok, OurFile} = application:get_env(rabbit, enabled_plugins_file),
case OurFile of
FileJustChanged ->
{ok, Dir} = application:get_env(rabbit, plugins_dir),
Enabled = read_enabled(OurFile),
Wanted = dependencies(false, Enabled, list(Dir)),
prepare_plugins(Enabled),
Current = active(),
Start = Wanted -- Current,
Stop = Current -- Wanted,
rabbit:start_apps(Start),
%% We need sync_notify here since mgmt will attempt to look at all
%% the modules for the disabled plugins - if they are unloaded
%% that won't work.
ok = rabbit_event:sync_notify(plugins_changed, [{enabled, Start},
{disabled, Stop}]),
rabbit:stop_apps(Stop),
clean_plugins(Stop),
{ok, Start, Stop};
_ ->
{error, {enabled_plugins_mismatch, FileJustChanged, OurFile}}
end.
%% @doc Prepares the file system and installs all enabled plugins.
setup() ->
{ok, ExpandDir} = application:get_env(rabbit, plugins_expand_dir),
%% Eliminate the contents of the destination directory
case delete_recursively(ExpandDir) of
ok -> ok;
{error, E1} -> throw({error, {cannot_delete_plugins_expand_dir,
[ExpandDir, E1]}})
end,
{ok, EnabledFile} = application:get_env(rabbit, enabled_plugins_file),
Enabled = read_enabled(EnabledFile),
prepare_plugins(Enabled).
%% @doc Lists the plugins which are currently running.
active() ->
{ok, ExpandDir} = application:get_env(rabbit, plugins_expand_dir),
InstalledPlugins = plugin_names(list(ExpandDir)),
[App || {App, _, _} <- rabbit_misc:which_applications(),
lists:member(App, InstalledPlugins)].
%% @doc Get the list of plugins which are ready to be enabled.
list(PluginsDir) ->
EZs = [{ez, EZ} || EZ <- filelib:wildcard("*.ez", PluginsDir)],
FreeApps = [{app, App} ||
App <- filelib:wildcard("*/ebin/*.app", PluginsDir)],
{Plugins, Problems} =
lists:foldl(fun ({error, EZ, Reason}, {Plugins1, Problems1}) ->
{Plugins1, [{EZ, Reason} | Problems1]};
(Plugin = #plugin{}, {Plugins1, Problems1}) ->
{[Plugin|Plugins1], Problems1}
end, {[], []},
[plugin_info(PluginsDir, Plug) || Plug <- EZs ++ FreeApps]),
case Problems of
[] -> ok;
_ -> error_logger:warning_msg(
"Problem reading some plugins: ~p~n", [Problems])
end,
ensure_dependencies(Plugins).
%% @doc Read the list of enabled plugins from the supplied term file.
read_enabled(PluginsFile) ->
case rabbit_file:read_term_file(PluginsFile) of
{ok, [Plugins]} -> Plugins;
{ok, []} -> [];
{ok, [_|_]} -> throw({error, {malformed_enabled_plugins_file,
PluginsFile}});
{error, enoent} -> [];
{error, Reason} -> throw({error, {cannot_read_enabled_plugins_file,
PluginsFile, Reason}})
end.
%% @doc Calculate the dependency graph from <i>Sources</i>.
%% When Reverse =:= true the bottom/leaf level applications are returned in
%% the resulting list, otherwise they're skipped.
dependencies(Reverse, Sources, AllPlugins) ->
{ok, G} = rabbit_misc:build_acyclic_graph(
fun ({App, _Deps}) -> [{App, App}] end,
fun ({App, Deps}) -> [{App, Dep} || Dep <- Deps] end,
[{Name, Deps} || #plugin{name = Name,
dependencies = Deps} <- AllPlugins]),
Dests = case Reverse of
false -> digraph_utils:reachable(Sources, G);
true -> digraph_utils:reaching(Sources, G)
end,
true = digraph:delete(G),
Dests.
%% Make sure we don't list OTP apps in here, and also that we detect
%% missing dependencies.
ensure_dependencies(Plugins) ->
Names = plugin_names(Plugins),
NotThere = [Dep || #plugin{dependencies = Deps} <- Plugins,
Dep <- Deps,
not lists:member(Dep, Names)],
{OTP, Missing} = lists:partition(fun is_loadable/1, lists:usort(NotThere)),
case Missing of
[] -> ok;
_ -> Blame = [Name || #plugin{name = Name,
dependencies = Deps} <- Plugins,
lists:any(fun (Dep) ->
lists:member(Dep, Missing)
end, Deps)],
throw({error, {missing_dependencies, Missing, Blame}})
end,
[P#plugin{dependencies = Deps -- OTP}
|| P = #plugin{dependencies = Deps} <- Plugins].
is_loadable(App) ->
case application:load(App) of
{error, {already_loaded, _}} -> true;
ok -> application:unload(App),
true;
_ -> false
end.
%%----------------------------------------------------------------------------
prepare_plugins(Enabled) ->
{ok, PluginsDistDir} = application:get_env(rabbit, plugins_dir),
{ok, ExpandDir} = application:get_env(rabbit, plugins_expand_dir),
AllPlugins = list(PluginsDistDir),
ToUnpack = dependencies(false, Enabled, AllPlugins),
ToUnpackPlugins = lookup_plugins(ToUnpack, AllPlugins),
case filelib:ensure_dir(ExpandDir ++ "/") of
ok -> ok;
{error, E2} -> throw({error, {cannot_create_plugins_expand_dir,
[ExpandDir, E2]}})
end,
[prepare_plugin(Plugin, ExpandDir) || Plugin <- ToUnpackPlugins],
[prepare_dir_plugin(PluginAppDescPath) ||
PluginAppDescPath <- filelib:wildcard(ExpandDir ++ "/*/ebin/*.app")].
clean_plugins(Plugins) ->
{ok, ExpandDir} = application:get_env(rabbit, plugins_expand_dir),
[clean_plugin(Plugin, ExpandDir) || Plugin <- Plugins].
clean_plugin(Plugin, ExpandDir) ->
{ok, Mods} = application:get_key(Plugin, modules),
application:unload(Plugin),
[begin
code:soft_purge(Mod),
code:delete(Mod),
false = code:is_loaded(Mod)
end || Mod <- Mods],
delete_recursively(rabbit_misc:format("~s/~s", [ExpandDir, Plugin])).
prepare_dir_plugin(PluginAppDescPath) ->
code:add_path(filename:dirname(PluginAppDescPath)),
list_to_atom(filename:basename(PluginAppDescPath, ".app")).
%%----------------------------------------------------------------------------
delete_recursively(Fn) ->
case rabbit_file:recursive_delete([Fn]) of
ok -> ok;
{error, {Path, E}} -> {error, {cannot_delete, Path, E}}
end.
prepare_plugin(#plugin{type = ez, location = Location}, ExpandDir) ->
zip:unzip(Location, [{cwd, ExpandDir}]);
prepare_plugin(#plugin{type = dir, name = Name, location = Location},
ExpandDir) ->
rabbit_file:recursive_copy(Location, filename:join([ExpandDir, Name])).
plugin_info(Base, {ez, EZ0}) ->
EZ = filename:join([Base, EZ0]),
case read_app_file(EZ) of
{application, Name, Props} -> mkplugin(Name, Props, ez, EZ);
{error, Reason} -> {error, EZ, Reason}
end;
plugin_info(Base, {app, App0}) ->
App = filename:join([Base, App0]),
case rabbit_file:read_term_file(App) of
{ok, [{application, Name, Props}]} ->
mkplugin(Name, Props, dir,
filename:absname(
filename:dirname(filename:dirname(App))));
{error, Reason} ->
{error, App, {invalid_app, Reason}}
end.
mkplugin(Name, Props, Type, Location) ->
Version = proplists:get_value(vsn, Props, "0"),
Description = proplists:get_value(description, Props, ""),
Dependencies = proplists:get_value(applications, Props, []),
#plugin{name = Name, version = Version, description = Description,
dependencies = Dependencies, location = Location, type = Type}.
read_app_file(EZ) ->
case zip:list_dir(EZ) of
{ok, [_|ZippedFiles]} ->
case find_app_files(ZippedFiles) of
[AppPath|_] ->
{ok, [{AppPath, AppFile}]} =
zip:extract(EZ, [{file_list, [AppPath]}, memory]),
parse_binary(AppFile);
[] ->
{error, no_app_file}
end;
{error, Reason} ->
{error, {invalid_ez, Reason}}
end.
find_app_files(ZippedFiles) ->
{ok, RE} = re:compile("^.*/ebin/.*.app$"),
[Path || {zip_file, Path, _, _, _, _} <- ZippedFiles,
re:run(Path, RE, [{capture, none}]) =:= match].
parse_binary(Bin) ->
try
{ok, Ts, _} = erl_scan:string(binary_to_list(Bin)),
{ok, Term} = erl_parse:parse_term(Ts),
Term
catch
Err -> {error, {invalid_app, Err}}
end.
plugin_names(Plugins) ->
[Name || #plugin{name = Name} <- Plugins].
lookup_plugins(Names, AllPlugins) ->
[P || P = #plugin{name = Name} <- AllPlugins, lists:member(Name, Names)].
|
