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
|
## 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) 2007-2019 Pivotal Software, Inc. All rights reserved.
defmodule RabbitMQ.CLI.Plugins.Commands.EnableCommand do
alias RabbitMQ.CLI.Plugins.Helpers, as: PluginHelpers
alias RabbitMQ.CLI.Core.{Helpers, Validators}
@behaviour RabbitMQ.CLI.CommandBehaviour
def formatter(), do: RabbitMQ.CLI.Formatters.Plugins
def merge_defaults(args, opts) do
{args, Map.merge(%{online: false, offline: false, all: false}, opts)}
end
def distribution(%{offline: true}), do: :none
def distribution(%{offline: false}), do: :cli
def switches(), do: [online: :boolean, offline: :boolean, all: :boolean]
def validate([], %{all: false}) do
{:validation_failure, :not_enough_args}
end
def validate([_ | _], %{all: true}) do
{:validation_failure, {:bad_argument, "Cannot set both --all and a list of plugins"}}
end
def validate(_, %{online: true, offline: true}) do
{:validation_failure, {:bad_argument, "Cannot set both online and offline"}}
end
def validate(_, _) do
:ok
end
def validate_execution_environment(args, opts) do
Validators.chain(
[
&PluginHelpers.can_set_plugins_with_mode/2,
&Helpers.require_rabbit_and_plugins/2,
&PluginHelpers.enabled_plugins_file/2,
&Helpers.plugins_dir/2
],
[args, opts]
)
end
def run(plugin_names, %{all: all_flag} = opts) do
plugins =
case all_flag do
false -> for s <- plugin_names, do: String.to_atom(s)
true -> PluginHelpers.plugin_names(PluginHelpers.list(opts))
end
case PluginHelpers.validate_plugins(plugins, opts) do
:ok -> do_run(plugins, opts)
other -> other
end
end
use RabbitMQ.CLI.Plugins.ErrorOutput
def banner([], %{all: true, node: node_name}) do
"Enabling ALL plugins on node #{node_name}"
end
def banner(plugins, %{node: node_name}) do
["Enabling plugins on node #{node_name}:" | plugins]
end
def usage, do: "enable <plugin1> [ <plugin2>] | --all [--offline] [--online]"
def usage_additional() do
[
"<plugin1> [ <plugin2>]: names of plugins to enable separated by a space",
"--online: contact target node to enable the plugins. Changes are applied immediately.",
"--offline: update enabled plugins file directly without contacting target node. Changes will be delayed until the node is restarted.",
"--all: enable all available plugins. Not recommended as some plugins may conflict or otherwise be incompatible!"
]
end
def help_section(), do: :plugin_management
def description(), do: "Enables one or more plugins"
#
# Implementation
#
def do_run(plugins, %{node: node_name} = opts) do
enabled = PluginHelpers.read_enabled(opts)
all = PluginHelpers.list(opts)
implicit = :rabbit_plugins.dependencies(false, enabled, all)
enabled_implicitly = MapSet.difference(MapSet.new(implicit), MapSet.new(enabled))
plugins_to_set =
MapSet.union(
MapSet.new(enabled),
MapSet.difference(MapSet.new(plugins), enabled_implicitly)
)
mode = PluginHelpers.mode(opts)
case PluginHelpers.set_enabled_plugins(MapSet.to_list(plugins_to_set), opts) do
{:ok, enabled_plugins} ->
{:stream,
Stream.concat([
[:rabbit_plugins.strictly_plugins(enabled_plugins, all)],
RabbitMQ.CLI.Core.Helpers.defer(fn ->
case PluginHelpers.update_enabled_plugins(enabled_plugins, mode, node_name, opts) do
%{set: new_enabled} = result ->
enabled = new_enabled -- implicit
filter_strictly_plugins(
Map.put(result, :enabled, :rabbit_plugins.strictly_plugins(enabled, all)),
all,
[:set, :started, :stopped]
)
other ->
other
end
end)
])}
{:error, _} = err ->
err
end
end
defp filter_strictly_plugins(map, _all, []) do
map
end
defp filter_strictly_plugins(map, all, [head | tail]) do
case map[head] do
nil ->
filter_strictly_plugins(map, all, tail)
other ->
value = :rabbit_plugins.strictly_plugins(other, all)
filter_strictly_plugins(Map.put(map, head, value), all, tail)
end
end
end
|