2016-10-26 23:25:39 +08:00
|
|
|
## 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-2016 Pivotal Software, Inc. All rights reserved.
|
|
|
|
|
|
|
|
defmodule RabbitMQ.CLI.Formatters.Plugins do
|
2016-11-15 01:52:08 +08:00
|
|
|
@behaviour RabbitMQ.CLI.FormatterBehaviour
|
2016-10-26 23:25:39 +08:00
|
|
|
|
|
|
|
def format_error(err, _) when is_binary(err) do
|
|
|
|
err
|
|
|
|
end
|
|
|
|
|
|
|
|
def format_output(%{status: status, format: format, plugins: plugins},
|
|
|
|
options) do
|
|
|
|
legend(status, format, options) ++ format_plugins(plugins, format)
|
|
|
|
end
|
2016-10-27 01:11:35 +08:00
|
|
|
def format_output(%{enabled: enabled, mode: _} = output, options) do
|
|
|
|
case length(enabled) do
|
|
|
|
0 -> ["Plugin configuration unchanged."];
|
|
|
|
_ -> ["The following plugins have been enabled:" |
|
|
|
|
for plugin <- enabled do " #{plugin}" end] ++
|
|
|
|
applying(output, options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
def format_output(%{disabled: disabled, mode: _} = output, options) do
|
|
|
|
case length(disabled) do
|
|
|
|
0 -> ["Plugin configuration unchanged."];
|
|
|
|
_ -> ["The following plugins have been disabled:" |
|
|
|
|
for plugin <- disabled do " #{plugin}" end] ++
|
|
|
|
applying(output, options)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
def format_output(%{set: set, mode: _} = output, options) do
|
|
|
|
case length(set) do
|
|
|
|
0 -> ["Plugin configuration unchanged."];
|
|
|
|
_ -> ["The following plugins have been enabled:" |
|
|
|
|
for plugin <- set do " #{plugin}" end] ++
|
|
|
|
applying(output, options)
|
|
|
|
end
|
|
|
|
end
|
2016-10-26 23:25:39 +08:00
|
|
|
|
|
|
|
def format_stream(stream, options) do
|
|
|
|
## PLugins commands never return stream
|
|
|
|
format_output(stream, options)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp format_plugins(plugins, format) do
|
|
|
|
max_name_length = Enum.reduce(plugins, 0,
|
|
|
|
fn(%{name: name}, len) ->
|
|
|
|
max(String.length(to_string(name)), len)
|
|
|
|
end)
|
|
|
|
for plugin <- plugins do
|
|
|
|
format_plugin(plugin, format, max_name_length)
|
|
|
|
end
|
|
|
|
|> List.flatten
|
|
|
|
end
|
|
|
|
|
|
|
|
defp format_plugin(%{name: name}, :minimal, _) do
|
|
|
|
to_string(name)
|
|
|
|
end
|
|
|
|
defp format_plugin(plugin, :normal, max_name_length) do
|
|
|
|
[summary(plugin) <> inline_version(plugin, max_name_length)]
|
|
|
|
end
|
|
|
|
defp format_plugin(plugin, :verbose, _) do
|
|
|
|
[summary(plugin) | verbose(plugin)]
|
|
|
|
end
|
|
|
|
|
|
|
|
defp summary(%{name: name, enabled: enabled, running: running}) do
|
|
|
|
enabled_sign = case enabled do
|
|
|
|
:implicit -> "e";
|
2016-10-29 00:14:34 +08:00
|
|
|
:enabled -> "E";
|
|
|
|
:not_enabled -> " "
|
2016-10-26 23:25:39 +08:00
|
|
|
end
|
|
|
|
running_sign = case running do
|
|
|
|
true -> "*";
|
|
|
|
false -> " "
|
|
|
|
end
|
|
|
|
|
|
|
|
"[#{enabled_sign}#{running_sign}] #{name}"
|
|
|
|
end
|
|
|
|
|
2016-12-01 00:19:13 +08:00
|
|
|
defp inline_version(%{name: name} = plugin, max_name_length) do
|
2016-10-26 23:25:39 +08:00
|
|
|
spacing = String.duplicate(" ", max_name_length -
|
|
|
|
String.length(to_string(name)))
|
2016-11-30 00:33:41 +08:00
|
|
|
spacing <> " " <> augment_version(plugin)
|
2016-10-26 23:25:39 +08:00
|
|
|
end
|
|
|
|
|
2016-12-01 00:19:13 +08:00
|
|
|
defp verbose(%{dependencies: dependencies,
|
2016-11-30 00:33:41 +08:00
|
|
|
description: description} = plugin) do
|
2016-10-26 23:25:39 +08:00
|
|
|
prettified = to_string(:io_lib.format("~p", [dependencies]))
|
|
|
|
[
|
2016-11-30 00:33:41 +08:00
|
|
|
" Version: \t#{augment_version(plugin)}",
|
2016-10-26 23:25:39 +08:00
|
|
|
" Dependencies:\t#{prettified}",
|
|
|
|
" Description: \t#{description}"
|
|
|
|
]
|
|
|
|
|
|
|
|
end
|
|
|
|
|
2016-11-30 00:33:41 +08:00
|
|
|
defp augment_version(%{version: version, running_version: nil} ) do
|
|
|
|
to_string(version)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp augment_version(%{version: version, running_version: version}) do
|
|
|
|
to_string(version)
|
|
|
|
end
|
|
|
|
|
|
|
|
defp augment_version(%{version: version, running_version: running_version}) do
|
|
|
|
"#{running_version} (pending upgrade to #{version})"
|
|
|
|
end
|
|
|
|
|
2016-10-26 23:25:39 +08:00
|
|
|
## Do not print legend in minimal mode
|
|
|
|
defp legend(_, :minimal, _) do
|
|
|
|
[]
|
|
|
|
end
|
|
|
|
defp legend(status, _, %{node: node}) do
|
|
|
|
[" Configured: E = explicitly enabled; e = implicitly enabled",
|
|
|
|
" | Status: #{status_message(status, node)}",
|
|
|
|
" |/"]
|
|
|
|
end
|
|
|
|
|
|
|
|
defp status_message(:running, node) do
|
|
|
|
"* = running on #{node}"
|
|
|
|
end
|
|
|
|
defp status_message(:node_down, node) do
|
|
|
|
"[failed to contact #{node} - status not shown]"
|
|
|
|
end
|
|
|
|
|
2016-10-27 01:11:35 +08:00
|
|
|
defp applying(%{mode: :offline}, _) do
|
|
|
|
[]
|
|
|
|
end
|
|
|
|
defp applying(%{mode: :online, started: started, stopped: stopped}, %{node: node}) do
|
|
|
|
stopped_message = case length(stopped) do
|
|
|
|
0 -> [];
|
|
|
|
len -> ["stopped #{len} plugins"]
|
|
|
|
end
|
|
|
|
started_message = case length(started) do
|
|
|
|
0 -> [];
|
|
|
|
len -> ["started #{len} plugins"]
|
|
|
|
end
|
|
|
|
change_message = case Enum.join(started_message ++ stopped_message, " and ") do
|
|
|
|
"" -> "nothing to do";
|
|
|
|
msg -> msg
|
|
|
|
end
|
|
|
|
["",
|
|
|
|
"Applying plugin configuration to #{node}... " <> change_message <> "."]
|
|
|
|
end
|
|
|
|
|
2016-10-29 00:14:34 +08:00
|
|
|
end
|