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
|
<?php
/* Icinga Web 2 | (c) 2021 Icinga GmbH | GPLv2+ */
namespace Icinga\Module\Migrate\Clicommands;
use Icinga\Application\Config;
use Icinga\Application\Icinga;
use Icinga\Application\Logger;
use Icinga\Cli\Command;
use Icinga\Data\ConfigObject;
use Icinga\Exception\NotReadableError;
use Icinga\Exception\NotWritableError;
use Icinga\Module\Icingadb\Compat\UrlMigrator;
use Icinga\Util\DirectoryIterator;
use Icinga\Web\Request;
use ipl\Web\Filter\QueryString;
use ipl\Web\Url;
class NavigationCommand extends Command
{
/**
* Migrate local user monitoring navigation items to the Icinga DB Web actions
*
* USAGE
*
* icingacli migrate navigation [options]
*
* OPTIONS:
*
* --user=<username> Migrate monitoring navigation items only for
* the given user. (Default *)
*
* --delete Remove the legacy files after successfully
* migrated the navigation items.
*/
public function indexAction()
{
$moduleManager = Icinga::app()->getModuleManager();
if (! $moduleManager->hasEnabled('icingadb')) {
Logger::error('Icinga DB module is not enabled. Please verify that the module is installed and enabled.');
return;
}
$preferencesPath = Config::resolvePath('preferences');
$sharedNavigation = Config::resolvePath('navigation');
if (! file_exists($preferencesPath) && ! file_exists($sharedNavigation)) {
Logger::info('There are no local user navigation items to migrate');
return;
}
$rc = 0;
$user = $this->params->get('user');
$directories = new DirectoryIterator($preferencesPath);
foreach ($directories as $directory) {
$username = $user;
if ($username !== null && $directories->key() !== $username) {
continue;
}
if ($username === null) {
$username = $directories->key();
}
$hostActions = $this->readFromIni($directory . '/host-actions.ini', $rc);
$serviceActions = $this->readFromIni($directory . '/service-actions.ini', $rc);
Logger::info('Migrating monitoring navigation items for user "%s" to the Icinga DB Web actions', $username);
if (! $hostActions->isEmpty()) {
$this->migrateNavigationItems($hostActions, $directory . '/icingadb-host-actions.ini', $rc);
}
if (! $serviceActions->isEmpty()) {
$this->migrateNavigationItems($serviceActions, $directory . '/icingadb-service-actions.ini', $rc);
}
}
// Start migrating shared navigation items
$hostActions = $this->readFromIni($sharedNavigation . '/host-actions.ini', $rc);
$serviceActions = $this->readFromIni($sharedNavigation . '/service-actions.ini', $rc);
Logger::info('Migrating shared monitoring navigation items to the Icinga DB Web actions');
if (! $hostActions->isEmpty()) {
$this->migrateNavigationItems($hostActions, $sharedNavigation . '/icingadb-host-actions.ini', $rc);
}
if (! $serviceActions->isEmpty()) {
$this->migrateNavigationItems($serviceActions, $sharedNavigation . '/icingadb-service-actions.ini', $rc);
}
if ($rc > 0) {
Logger::error('Failed to migrate some monitoring navigation items');
exit($rc);
}
Logger::info('Successfully migrated all local user monitoring navigation items');
}
/**
* Migrate the given config to the given new config path
*
* @param Config $config
* @param string $path
* @param int $rc
*/
private function migrateNavigationItems($config, $path, &$rc)
{
$deleteLegacyFiles = $this->params->get('delete');
$newConfig = $this->readFromIni($path, $rc);
$counter = 1;
/** @var ConfigObject $configObject */
foreach ($config->getConfigObject() as $configObject) {
// Change the config type from "host-action" to icingadb's new action
if (strpos($path, 'icingadb-host-actions') !== false) {
$configObject->type = 'icingadb-host-action';
} else {
$configObject->type = 'icingadb-service-action';
}
$urlString = $configObject->get('url');
if ($urlString !== null) {
$url = Url::fromPath($urlString, [], new Request());
try {
$urlString = UrlMigrator::transformUrl($url)->getAbsoluteUrl();
$configObject->url = rawurldecode($urlString);
} catch (\InvalidArgumentException $err) {
// Do nothing
}
}
$legacyFilter = $configObject->get('filter');
if ($legacyFilter !== null) {
$filter = QueryString::parse($legacyFilter);
$filter = UrlMigrator::transformFilter($filter);
if ($filter !== false) {
$configObject->filter = rawurldecode(QueryString::render($filter));
} else {
unset($configObject->filter);
}
}
$section = $config->key();
while ($newConfig->hasSection($section)) {
$section = $config->key() . $counter++;
}
$newConfig->setSection($section, $configObject);
}
try {
if (! $newConfig->isEmpty()) {
$newConfig->saveIni();
// Remove the legacy file only if explicitly requested
if ($deleteLegacyFiles) {
unlink($config->getConfigFile());
}
}
} catch (NotWritableError $error) {
Logger::error('%s: %s', $error->getMessage(), $error->getPrevious()->getMessage());
$rc = 256;
}
}
/**
* Get the navigation items config from the given ini path
*
* @param string $path Absolute path of the ini file
* @param int $rc The return code used to exit the action
*
* @return Config
*/
private function readFromIni($path, &$rc)
{
try {
$config = Config::fromIni($path);
} catch (NotReadableError $error) {
if ($error->getPrevious() !== null) {
Logger::error('%s: %s', $error->getMessage(), $error->getPrevious()->getMessage());
} else {
Logger::error($error->getMessage());
}
$config = new Config();
$rc = 128;
}
return $config;
}
}
|
