summaryrefslogtreecommitdiffstats
path: root/modules/setup/library/Setup/Steps/DatabaseStep.php
blob: 32b2d15c0ee092a12b70043addb72093518c330a (plain)
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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Setup\Steps;

use Exception;
use PDOException;
use Icinga\Exception\IcingaException;
use Icinga\Module\Setup\Step;
use Icinga\Module\Setup\Utils\DbTool;
use Icinga\Module\Setup\Exception\SetupException;

class DatabaseStep extends Step
{
    protected $data;

    protected $error;

    protected $messages;

    public function __construct(array $data)
    {
        $this->data = $data;
        $this->messages = array();
    }

    public function apply()
    {
        $resourceConfig = $this->data['resourceConfig'];
        if (isset($this->data['adminName'])) {
            $resourceConfig['username'] = $this->data['adminName'];
            if (isset($this->data['adminPassword'])) {
                $resourceConfig['password'] = $this->data['adminPassword'];
            }
        }

        $db = new DbTool($resourceConfig);

        try {
            if ($resourceConfig['db'] === 'mysql') {
                $this->setupMysqlDatabase($db);
            } elseif ($resourceConfig['db'] === 'pgsql') {
                $this->setupPgsqlDatabase($db);
            }
        } catch (Exception $e) {
            $this->error = $e;
            throw new SetupException();
        }

        $this->error = false;
        return true;
    }

    protected function setupMysqlDatabase(DbTool $db)
    {
        try {
            $db->connectToDb();
            $this->log(
                mt('setup', 'Successfully connected to existing database "%s"...'),
                $this->data['resourceConfig']['dbname']
            );
        } catch (PDOException $_) {
            $db->connectToHost();
            $this->log(mt('setup', 'Creating new database "%s"...'), $this->data['resourceConfig']['dbname']);
            $db->exec('CREATE DATABASE ' . $db->quoteIdentifier($this->data['resourceConfig']['dbname']));
            $db->reconnect($this->data['resourceConfig']['dbname']);
        }

        if (array_search(reset($this->data['tables']), $db->listTables(), true) !== false) {
            $this->log(mt('setup', 'Database schema already exists...'));
        } else {
            $this->log(mt('setup', 'Creating database schema...'));
            $db->import($this->data['schemaPath'] . '/mysql.schema.sql');
        }

        if ($db->hasLogin($this->data['resourceConfig']['username'])) {
            $this->log(mt('setup', 'Login "%s" already exists...'), $this->data['resourceConfig']['username']);
        } else {
            $this->log(mt('setup', 'Creating login "%s"...'), $this->data['resourceConfig']['username']);
            $db->addLogin($this->data['resourceConfig']['username'], $this->data['resourceConfig']['password']);
        }

        $username = $this->data['resourceConfig']['username'];
        if ($db->checkPrivileges($this->data['privileges'], $this->data['tables'], $username)) {
            $this->log(
                mt('setup', 'Required privileges were already granted to login "%s".'),
                $this->data['resourceConfig']['username']
            );
        } else {
            $this->log(
                mt('setup', 'Granting required privileges to login "%s"...'),
                $this->data['resourceConfig']['username']
            );
            $db->grantPrivileges(
                $this->data['privileges'],
                $this->data['tables'],
                $this->data['resourceConfig']['username']
            );
        }
    }

    protected function setupPgsqlDatabase(DbTool $db)
    {
        try {
            $db->connectToDb();
            $this->log(
                mt('setup', 'Successfully connected to existing database "%s"...'),
                $this->data['resourceConfig']['dbname']
            );
        } catch (PDOException $_) {
            $db->connectToHost();
            $this->log(mt('setup', 'Creating new database "%s"...'), $this->data['resourceConfig']['dbname']);
            $db->exec(sprintf(
                "CREATE DATABASE %s WITH ENCODING 'UTF-8'",
                $db->quoteIdentifier($this->data['resourceConfig']['dbname'])
            ));
            $db->reconnect($this->data['resourceConfig']['dbname']);
        }

        if (array_search(reset($this->data['tables']), $db->listTables(), true) !== false) {
            $this->log(mt('setup', 'Database schema already exists...'));
        } else {
            $this->log(mt('setup', 'Creating database schema...'));
            $db->import($this->data['schemaPath'] . '/pgsql.schema.sql');
        }

        if ($db->hasLogin($this->data['resourceConfig']['username'])) {
            $this->log(mt('setup', 'Login "%s" already exists...'), $this->data['resourceConfig']['username']);
        } else {
            $this->log(mt('setup', 'Creating login "%s"...'), $this->data['resourceConfig']['username']);
            $db->addLogin($this->data['resourceConfig']['username'], $this->data['resourceConfig']['password']);
        }

        $username = $this->data['resourceConfig']['username'];
        if ($db->checkPrivileges($this->data['privileges'], $this->data['tables'], $username)) {
            $this->log(
                mt('setup', 'Required privileges were already granted to login "%s".'),
                $this->data['resourceConfig']['username']
            );
        } else {
            $this->log(
                mt('setup', 'Granting required privileges to login "%s"...'),
                $this->data['resourceConfig']['username']
            );
            $db->grantPrivileges(
                $this->data['privileges'],
                $this->data['tables'],
                $this->data['resourceConfig']['username']
            );
        }
    }

    public function getSummary()
    {
        $resourceConfig = $this->data['resourceConfig'];
        if (isset($this->data['adminName'])) {
            $resourceConfig['username'] = $this->data['adminName'];
            if (isset($this->data['adminPassword'])) {
                $resourceConfig['password'] = $this->data['adminPassword'];
            }
        }

        $db = new DbTool($resourceConfig);

        try {
            $db->connectToDb();
            if (array_search(reset($this->data['tables']), $db->listTables(), true) === false) {
                if ($resourceConfig['username'] !== $this->data['resourceConfig']['username']) {
                    $message = sprintf(
                        mt(
                            'setup',
                            'The database user "%s" will be used to setup the missing schema required by Icinga'
                            . ' Web 2 in database "%s" and to grant access to it to a new login called "%s".'
                        ),
                        $resourceConfig['username'],
                        $resourceConfig['dbname'],
                        $this->data['resourceConfig']['username']
                    );
                } else {
                    $message = sprintf(
                        mt(
                            'setup',
                            'The database user "%s" will be used to setup the missing'
                            . ' schema required by Icinga Web 2 in database "%s".'
                        ),
                        $resourceConfig['username'],
                        $resourceConfig['dbname']
                    );
                }
            } else {
                $message = sprintf(
                    mt('setup', 'The database "%s" already seems to be fully set up. No action required.'),
                    $resourceConfig['dbname']
                );
            }
        } catch (PDOException $_) {
            try {
                $db->connectToHost();
                if ($resourceConfig['username'] !== $this->data['resourceConfig']['username']) {
                    if ($db->hasLogin($this->data['resourceConfig']['username'])) {
                        $message = sprintf(
                            mt(
                                'setup',
                                'The database user "%s" will be used to create the missing database'
                                . ' "%s" with the schema required by Icinga Web 2 and to grant'
                                . ' access to it to an existing login called "%s".'
                            ),
                            $resourceConfig['username'],
                            $resourceConfig['dbname'],
                            $this->data['resourceConfig']['username']
                        );
                    } else {
                        $message = sprintf(
                            mt(
                                'setup',
                                'The database user "%s" will be used to create the missing database'
                                . ' "%s" with the schema required by Icinga Web 2 and to grant'
                                . ' access to it to a new login called "%s".'
                            ),
                            $resourceConfig['username'],
                            $resourceConfig['dbname'],
                            $this->data['resourceConfig']['username']
                        );
                    }
                } else {
                    $message = sprintf(
                        mt(
                            'setup',
                            'The database user "%s" will be used to create the missing'
                            . ' database "%s" with the schema required by Icinga Web 2.'
                        ),
                        $resourceConfig['username'],
                        $resourceConfig['dbname']
                    );
                }
            } catch (Exception $_) {
                $message = mt(
                    'setup',
                    'No connection to database host possible. You\'ll need to setup the'
                    . ' database with the schema required by Icinga Web 2 manually.'
                );
            }
        }

        return '<h2>' . mt('setup', 'Database Setup', 'setup.page.title') . '</h2><p>' . $message . '</p>';
    }

    public function getReport()
    {
        if ($this->error === false) {
            $report = $this->messages;
            $report[] = mt('setup', 'The database has been fully set up!');
            return $report;
        } elseif ($this->error !== null) {
            $report = $this->messages;
            $report[] = mt('setup', 'Failed to fully setup the database. An error occured:');
            $report[] = sprintf(mt('setup', 'ERROR: %s'), IcingaException::describe($this->error));
            return $report;
        }
    }

    protected function log()
    {
        $this->messages[] = call_user_func_array('sprintf', func_get_args());
    }
}