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
|
<?php
/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
namespace Icinga\Clicommands;
use Icinga\Application\Logger;
use Icinga\Application\Modules\Manager;
use Icinga\Cli\Command;
/**
* List and handle modules
*
* The module command allows you to handle your IcingaWeb modules
*
* Usage: icingacli module [<action>] [<modulename>]
*/
class ModuleCommand extends Command
{
/**
* @var Manager
*/
protected $modules;
public function init()
{
$this->modules = $this->app->getModuleManager();
}
/**
* List all enabled modules
*
* If you are interested in all installed modules pass 'installed' (or
* even --installed) as a command parameter. If you enable --verbose even
* more details will be shown
*
* Usage: icingacli module list [installed] [--verbose]
*/
public function listAction()
{
if ($type = $this->params->shift()) {
if (! in_array($type, array('enabled', 'installed'))) {
return $this->showUsage();
}
} else {
$type = 'enabled';
$this->params->shift('enabled');
if ($this->params->shift('installed')) {
$type = 'installed';
}
}
if ($this->hasRemainingParams()) {
return $this->showUsage();
}
if ($type === 'enabled') {
$modules = $this->modules->listEnabledModules();
} else {
$modules = $this->modules->listInstalledModules();
}
if (empty($modules)) {
echo "There are no $type modules\n";
return;
}
if ($this->isVerbose) {
printf("%-14s %-9s %-9s DIRECTORY\n", 'MODULE', 'VERSION', 'STATE');
} else {
printf("%-14s %-9s %-9s %s\n", 'MODULE', 'VERSION', 'STATE', 'DESCRIPTION');
}
foreach ($modules as $module) {
$mod = $this->modules->loadModule($module)->getModule($module);
if ($this->isVerbose) {
$dir = ' ' . $this->modules->getModuleDir($module);
} else {
$dir = $mod->getTitle();
}
printf(
"%-14s %-9s %-9s %s\n",
$module,
$mod->getVersion(),
($type === 'enabled' || $this->modules->hasEnabled($module))
? $this->modules->hasInstalled($module) ? 'enabled' : 'dangling'
: 'disabled',
$dir
);
}
echo "\n";
}
/**
* Enable a given module
*
* Usage: icingacli module enable <module-name>
*/
public function enableAction()
{
if (! $module = $this->params->shift()) {
$module = $this->params->shift('module');
}
if (! $module || $this->hasRemainingParams()) {
return $this->showUsage();
}
$this->modules->enableModule($module, true);
}
/**
* Disable a given module
*
* Usage: icingacli module disable <module-name>
*/
public function disableAction()
{
if (! $module = $this->params->shift()) {
$module = $this->params->shift('module');
}
if (! $module || $this->hasRemainingParams()) {
return $this->showUsage();
}
if ($this->modules->hasEnabled($module)) {
$this->modules->disableModule($module);
} else {
Logger::info('Module "%s" is already disabled', $module);
}
}
/**
* Show all restrictions provided by your modules
*
* Asks each enabled module for all available restriction names and
* descriptions and shows a quick overview
*
* Usage: icingacli module restrictions
*/
public function restrictionsAction()
{
printf("%-14s %-16s %s\n", 'MODULE', 'RESTRICTION', 'DESCRIPTION');
foreach ($this->modules->listEnabledModules() as $moduleName) {
$module = $this->modules->loadModule($moduleName)->getModule($moduleName);
foreach ($module->getProvidedRestrictions() as $restriction) {
printf(
"%-14s %-16s %s\n",
$moduleName,
$restriction->name,
$restriction->description
);
}
}
}
/**
* Show all permissions provided by your modules
*
* Asks each enabled module for it's available permission names and
* descriptions and shows a quick overview
*
* Usage: icingacli module permissions
*/
public function permissionsAction()
{
printf("%-14s %-24s %s\n", 'MODULE', 'PERMISSION', 'DESCRIPTION');
foreach ($this->modules->listEnabledModules() as $moduleName) {
$module = $this->modules->loadModule($moduleName)->getModule($moduleName);
foreach ($module->getProvidedPermissions() as $restriction) {
printf(
"%-14s %-24s %s\n",
$moduleName,
$restriction->name,
$restriction->description
);
}
}
}
/**
* Search for a given module
*
* Does a lookup against your configured IcingaWeb app stores and tries to
* find modules matching your search string
*
* Usage: icingacli module search <search-string>
*/
public function searchAction()
{
$this->fail("Not implemented yet");
}
/**
* Install a given module
*
* Downloads a given module or installes a module from a given archive
*
* Usage: icingacli module install <module-name>
* icingacli module install </path/to/archive.tar.gz>
*/
public function installAction()
{
$this->fail("Not implemented yet");
}
/**
* Remove a given module
*
* Removes the given module from your disk. Module configuration will be
* preserved
*
* Usage: icingacli module remove <module-name>
*/
public function removeAction()
{
$this->fail("Not implemented yet");
}
/**
* Purge a given module
*
* Removes the given module from your disk. Also wipes configuration files
* and other data stored and/or generated by this module
*
* Usage: icingacli module remove <module-name>
*/
public function purgeAction()
{
$this->fail("Not implemented yet");
}
}
|
