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
|
## 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.ListCommand do
import RabbitCommon.Records
alias RabbitMQ.CLI.Core.{Helpers, Validators}
alias RabbitMQ.CLI.Plugins.Helpers, as: PluginHelpers
@behaviour RabbitMQ.CLI.CommandBehaviour
use RabbitMQ.CLI.DefaultOutput
def formatter(), do: RabbitMQ.CLI.Formatters.Plugins
def merge_defaults([], opts), do: merge_defaults([".*"], opts)
def merge_defaults(args, opts), do: {args, Map.merge(default_opts(), opts)}
def switches(),
do: [verbose: :boolean, minimal: :boolean, enabled: :boolean, implicitly_enabled: :boolean]
def aliases(), do: [v: :verbose, m: :minimal, E: :enabled, e: :implicitly_enabled]
def validate(args, _) when length(args) > 1 do
{:validation_failure, :too_many_args}
end
def validate(_, %{verbose: true, minimal: true}) do
{:validation_failure, {:bad_argument, "Cannot set both verbose and minimal"}}
end
def validate(_, _) do
:ok
end
def validate_execution_environment(args, opts) do
Validators.chain(
[
&Helpers.require_rabbit_and_plugins/2,
&PluginHelpers.enabled_plugins_file/2,
&Helpers.plugins_dir/2
],
[args, opts]
)
end
def run([pattern], %{node: node_name} = opts) do
%{verbose: verbose, minimal: minimal, enabled: only_enabled, implicitly_enabled: all_enabled} =
opts
all = PluginHelpers.list(opts)
enabled = PluginHelpers.read_enabled(opts)
missing = MapSet.difference(MapSet.new(enabled), MapSet.new(PluginHelpers.plugin_names(all)))
case Enum.empty?(missing) do
true ->
:ok
false ->
names = Enum.join(Enum.to_list(missing), ", ")
IO.puts("WARNING - plugins currently enabled but missing: #{names}\n")
end
implicit = :rabbit_plugins.dependencies(false, enabled, all)
enabled_implicitly = implicit -- enabled
{status, running} =
case remote_running_plugins(node_name) do
:error -> {:node_down, []}
{:ok, active} -> {:running, active}
end
{:ok, re} = Regex.compile(pattern)
format =
case {verbose, minimal} do
{true, false} -> :verbose
{false, true} -> :minimal
{false, false} -> :normal
end
plugins =
Enum.filter(
all,
fn plugin ->
name = PluginHelpers.plugin_name(plugin)
:rabbit_plugins.is_strictly_plugin(plugin) and
Regex.match?(re, to_string(name)) and
cond do
only_enabled -> Enum.member?(enabled, name)
all_enabled -> Enum.member?(enabled ++ enabled_implicitly, name)
true -> true
end
end
)
%{
status: status,
format: format,
plugins: format_plugins(plugins, format, enabled, enabled_implicitly, running)
}
end
def banner([pattern], _), do: "Listing plugins with pattern \"#{pattern}\" ..."
def usage, do: "list [pattern] [--verbose] [--minimal] [--enabled] [--implicitly-enabled]"
def usage_additional() do
[
"<pattern>: only list plugins that match a regular expression pattern",
"--verbose: output more information",
"--minimal: only print plugin names. Most useful in compbination with --silent and --enabled.",
"--enabled: only list enabled plugins",
"--implicitly-enabled: include plugins enabled as dependencies of other plugins"
]
end
def help_section(), do: :plugin_management
def description(), do: "Lists plugins and their state"
#
# Implementation
#
defp remote_running_plugins(node) do
case :rabbit_misc.rpc_call(node, :rabbit_plugins, :running_plugins, []) do
{:badrpc, _} -> :error
active_with_version -> active_with_version
end
end
defp format_plugins(plugins, format, enabled, enabled_implicitly, running) do
plugins
|> sort_plugins
|> Enum.map(fn plugin ->
format_plugin(plugin, format, enabled, enabled_implicitly, running)
end)
end
defp sort_plugins(plugins) do
Enum.sort_by(plugins, &PluginHelpers.plugin_name/1)
end
defp format_plugin(plugin, :minimal, _, _, _) do
%{name: PluginHelpers.plugin_name(plugin)}
end
defp format_plugin(plugin, :normal, enabled, enabled_implicitly, running) do
plugin(name: name, version: version) = plugin
enabled_mode =
case {Enum.member?(enabled, name), Enum.member?(enabled_implicitly, name)} do
{true, false} -> :enabled
{false, true} -> :implicit
{false, false} -> :not_enabled
end
%{
name: name,
version: version,
running_version: running[name],
enabled: enabled_mode,
running: Keyword.has_key?(running, name)
}
end
defp format_plugin(plugin, :verbose, enabled, enabled_implicitly, running) do
normal = format_plugin(plugin, :normal, enabled, enabled_implicitly, running)
plugin(dependencies: dependencies, description: description) = plugin
Map.merge(normal, %{dependencies: dependencies, description: description})
end
defp default_opts() do
%{minimal: false, verbose: false, enabled: false, implicitly_enabled: false}
end
end
|
