Use PHP 7 '??' operator instead of if-then-else
[lhc/web/wiklou.git] / includes / installer / MysqlInstaller.php
1 <?php
2 /**
3 * MySQL-specific installer.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Deployment
22 */
23
24 use Wikimedia\Rdbms\Database;
25 use Wikimedia\Rdbms\DBQueryError;
26 use Wikimedia\Rdbms\DBConnectionError;
27
28 /**
29 * Class for setting up the MediaWiki database using MySQL.
30 *
31 * @ingroup Deployment
32 * @since 1.17
33 */
34 class MysqlInstaller extends DatabaseInstaller {
35
36 protected $globalNames = [
37 'wgDBserver',
38 'wgDBname',
39 'wgDBuser',
40 'wgDBpassword',
41 'wgDBprefix',
42 'wgDBTableOptions',
43 ];
44
45 protected $internalDefaults = [
46 '_MysqlEngine' => 'InnoDB',
47 '_MysqlCharset' => 'binary',
48 '_InstallUser' => 'root',
49 ];
50
51 public $supportedEngines = [ 'InnoDB', 'MyISAM' ];
52
53 public static $minimumVersion = '5.5.8';
54 protected static $notMiniumumVerisonMessage = 'config-mysql-old';
55
56 public $webUserPrivs = [
57 'DELETE',
58 'INSERT',
59 'SELECT',
60 'UPDATE',
61 'CREATE TEMPORARY TABLES',
62 ];
63
64 /**
65 * @return string
66 */
67 public function getName() {
68 return 'mysql';
69 }
70
71 /**
72 * @return bool
73 */
74 public function isCompiled() {
75 return self::checkExtension( 'mysqli' );
76 }
77
78 /**
79 * @return string
80 */
81 public function getConnectForm() {
82 return $this->getTextBox(
83 'wgDBserver',
84 'config-db-host',
85 [],
86 $this->parent->getHelpBox( 'config-db-host-help' )
87 ) .
88 Html::openElement( 'fieldset' ) .
89 Html::element( 'legend', [], wfMessage( 'config-db-wiki-settings' )->text() ) .
90 $this->getTextBox( 'wgDBname', 'config-db-name', [ 'dir' => 'ltr' ],
91 $this->parent->getHelpBox( 'config-db-name-help' ) ) .
92 $this->getTextBox( 'wgDBprefix', 'config-db-prefix', [ 'dir' => 'ltr' ],
93 $this->parent->getHelpBox( 'config-db-prefix-help' ) ) .
94 Html::closeElement( 'fieldset' ) .
95 $this->getInstallUserBox();
96 }
97
98 public function submitConnectForm() {
99 // Get variables from the request.
100 $newValues = $this->setVarsFromRequest( [ 'wgDBserver', 'wgDBname', 'wgDBprefix' ] );
101
102 // Validate them.
103 $status = Status::newGood();
104 if ( !strlen( $newValues['wgDBserver'] ) ) {
105 $status->fatal( 'config-missing-db-host' );
106 }
107 if ( !strlen( $newValues['wgDBname'] ) ) {
108 $status->fatal( 'config-missing-db-name' );
109 } elseif ( !preg_match( '/^[a-z0-9+_-]+$/i', $newValues['wgDBname'] ) ) {
110 $status->fatal( 'config-invalid-db-name', $newValues['wgDBname'] );
111 }
112 if ( !preg_match( '/^[a-z0-9_-]*$/i', $newValues['wgDBprefix'] ) ) {
113 $status->fatal( 'config-invalid-db-prefix', $newValues['wgDBprefix'] );
114 }
115 if ( !$status->isOK() ) {
116 return $status;
117 }
118
119 // Submit user box
120 $status = $this->submitInstallUserBox();
121 if ( !$status->isOK() ) {
122 return $status;
123 }
124
125 // Try to connect
126 $status = $this->getConnection();
127 if ( !$status->isOK() ) {
128 return $status;
129 }
130 /**
131 * @var $conn Database
132 */
133 $conn = $status->value;
134
135 // Check version
136 return static::meetsMinimumRequirement( $conn->getServerVersion() );
137 }
138
139 /**
140 * @return Status
141 */
142 public function openConnection() {
143 $status = Status::newGood();
144 try {
145 $db = Database::factory( 'mysql', [
146 'host' => $this->getVar( 'wgDBserver' ),
147 'user' => $this->getVar( '_InstallUser' ),
148 'password' => $this->getVar( '_InstallPassword' ),
149 'dbname' => false,
150 'flags' => 0,
151 'tablePrefix' => $this->getVar( 'wgDBprefix' ) ] );
152 $status->value = $db;
153 } catch ( DBConnectionError $e ) {
154 $status->fatal( 'config-connection-error', $e->getMessage() );
155 }
156
157 return $status;
158 }
159
160 public function preUpgrade() {
161 global $wgDBuser, $wgDBpassword;
162
163 $status = $this->getConnection();
164 if ( !$status->isOK() ) {
165 $this->parent->showStatusError( $status );
166
167 return;
168 }
169 /**
170 * @var $conn Database
171 */
172 $conn = $status->value;
173 $conn->selectDB( $this->getVar( 'wgDBname' ) );
174
175 # Determine existing default character set
176 if ( $conn->tableExists( "revision", __METHOD__ ) ) {
177 $revision = $this->escapeLikeInternal( $this->getVar( 'wgDBprefix' ) . 'revision', '\\' );
178 $res = $conn->query( "SHOW TABLE STATUS LIKE '$revision'", __METHOD__ );
179 $row = $conn->fetchObject( $res );
180 if ( !$row ) {
181 $this->parent->showMessage( 'config-show-table-status' );
182 $existingSchema = false;
183 $existingEngine = false;
184 } else {
185 if ( preg_match( '/^latin1/', $row->Collation ) ) {
186 $existingSchema = 'latin1';
187 } elseif ( preg_match( '/^utf8/', $row->Collation ) ) {
188 $existingSchema = 'utf8';
189 } elseif ( preg_match( '/^binary/', $row->Collation ) ) {
190 $existingSchema = 'binary';
191 } else {
192 $existingSchema = false;
193 $this->parent->showMessage( 'config-unknown-collation' );
194 }
195 $existingEngine = $row->Engine ?? $row->Type;
196 }
197 } else {
198 $existingSchema = false;
199 $existingEngine = false;
200 }
201
202 if ( $existingSchema && $existingSchema != $this->getVar( '_MysqlCharset' ) ) {
203 $this->setVar( '_MysqlCharset', $existingSchema );
204 }
205 if ( $existingEngine && $existingEngine != $this->getVar( '_MysqlEngine' ) ) {
206 $this->setVar( '_MysqlEngine', $existingEngine );
207 }
208
209 # Normal user and password are selected after this step, so for now
210 # just copy these two
211 $wgDBuser = $this->getVar( '_InstallUser' );
212 $wgDBpassword = $this->getVar( '_InstallPassword' );
213 }
214
215 /**
216 * @param string $s
217 * @param string $escapeChar
218 * @return string
219 */
220 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
221 return str_replace( [ $escapeChar, '%', '_' ],
222 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
223 $s );
224 }
225
226 /**
227 * Get a list of storage engines that are available and supported
228 *
229 * @return array
230 */
231 public function getEngines() {
232 $status = $this->getConnection();
233
234 /**
235 * @var $conn Database
236 */
237 $conn = $status->value;
238
239 $engines = [];
240 $res = $conn->query( 'SHOW ENGINES', __METHOD__ );
241 foreach ( $res as $row ) {
242 if ( $row->Support == 'YES' || $row->Support == 'DEFAULT' ) {
243 $engines[] = $row->Engine;
244 }
245 }
246 $engines = array_intersect( $this->supportedEngines, $engines );
247
248 return $engines;
249 }
250
251 /**
252 * Get a list of character sets that are available and supported
253 *
254 * @return array
255 */
256 public function getCharsets() {
257 return [ 'binary', 'utf8' ];
258 }
259
260 /**
261 * Return true if the install user can create accounts
262 *
263 * @return bool
264 */
265 public function canCreateAccounts() {
266 $status = $this->getConnection();
267 if ( !$status->isOK() ) {
268 return false;
269 }
270 /** @var Database $conn */
271 $conn = $status->value;
272
273 // Get current account name
274 $currentName = $conn->selectField( '', 'CURRENT_USER()', '', __METHOD__ );
275 $parts = explode( '@', $currentName );
276 if ( count( $parts ) != 2 ) {
277 return false;
278 }
279 $quotedUser = $conn->addQuotes( $parts[0] ) .
280 '@' . $conn->addQuotes( $parts[1] );
281
282 // The user needs to have INSERT on mysql.* to be able to CREATE USER
283 // The grantee will be double-quoted in this query, as required
284 $res = $conn->select( 'INFORMATION_SCHEMA.USER_PRIVILEGES', '*',
285 [ 'GRANTEE' => $quotedUser ], __METHOD__ );
286 $insertMysql = false;
287 $grantOptions = array_flip( $this->webUserPrivs );
288 foreach ( $res as $row ) {
289 if ( $row->PRIVILEGE_TYPE == 'INSERT' ) {
290 $insertMysql = true;
291 }
292 if ( $row->IS_GRANTABLE ) {
293 unset( $grantOptions[$row->PRIVILEGE_TYPE] );
294 }
295 }
296
297 // Check for DB-specific privs for mysql.*
298 if ( !$insertMysql ) {
299 $row = $conn->selectRow( 'INFORMATION_SCHEMA.SCHEMA_PRIVILEGES', '*',
300 [
301 'GRANTEE' => $quotedUser,
302 'TABLE_SCHEMA' => 'mysql',
303 'PRIVILEGE_TYPE' => 'INSERT',
304 ], __METHOD__ );
305 if ( $row ) {
306 $insertMysql = true;
307 }
308 }
309
310 if ( !$insertMysql ) {
311 return false;
312 }
313
314 // Check for DB-level grant options
315 $res = $conn->select( 'INFORMATION_SCHEMA.SCHEMA_PRIVILEGES', '*',
316 [
317 'GRANTEE' => $quotedUser,
318 'IS_GRANTABLE' => 1,
319 ], __METHOD__ );
320 foreach ( $res as $row ) {
321 $regex = $this->likeToRegex( $row->TABLE_SCHEMA );
322 if ( preg_match( $regex, $this->getVar( 'wgDBname' ) ) ) {
323 unset( $grantOptions[$row->PRIVILEGE_TYPE] );
324 }
325 }
326 if ( count( $grantOptions ) ) {
327 // Can't grant everything
328 return false;
329 }
330
331 return true;
332 }
333
334 /**
335 * Convert a wildcard (as used in LIKE) to a regex
336 * Slashes are escaped, slash terminators included
337 * @param string $wildcard
338 * @return string
339 */
340 protected function likeToRegex( $wildcard ) {
341 $r = preg_quote( $wildcard, '/' );
342 $r = strtr( $r, [
343 '%' => '.*',
344 '_' => '.'
345 ] );
346 return "/$r/s";
347 }
348
349 /**
350 * @return string
351 */
352 public function getSettingsForm() {
353 if ( $this->canCreateAccounts() ) {
354 $noCreateMsg = false;
355 } else {
356 $noCreateMsg = 'config-db-web-no-create-privs';
357 }
358 $s = $this->getWebUserBox( $noCreateMsg );
359
360 // Do engine selector
361 $engines = $this->getEngines();
362 // If the current default engine is not supported, use an engine that is
363 if ( !in_array( $this->getVar( '_MysqlEngine' ), $engines ) ) {
364 $this->setVar( '_MysqlEngine', reset( $engines ) );
365 }
366
367 $s .= Xml::openElement( 'div', [
368 'id' => 'dbMyisamWarning'
369 ] );
370 $myisamWarning = 'config-mysql-myisam-dep';
371 if ( count( $engines ) === 1 ) {
372 $myisamWarning = 'config-mysql-only-myisam-dep';
373 }
374 $s .= $this->parent->getWarningBox( wfMessage( $myisamWarning )->text() );
375 $s .= Xml::closeElement( 'div' );
376
377 if ( $this->getVar( '_MysqlEngine' ) != 'MyISAM' ) {
378 $s .= Xml::openElement( 'script' );
379 $s .= '$(\'#dbMyisamWarning\').hide();';
380 $s .= Xml::closeElement( 'script' );
381 }
382
383 if ( count( $engines ) >= 2 ) {
384 // getRadioSet() builds a set of labeled radio buttons.
385 // For grep: The following messages are used as the item labels:
386 // config-mysql-innodb, config-mysql-myisam
387 $s .= $this->getRadioSet( [
388 'var' => '_MysqlEngine',
389 'label' => 'config-mysql-engine',
390 'itemLabelPrefix' => 'config-mysql-',
391 'values' => $engines,
392 'itemAttribs' => [
393 'MyISAM' => [
394 'class' => 'showHideRadio',
395 'rel' => 'dbMyisamWarning'
396 ],
397 'InnoDB' => [
398 'class' => 'hideShowRadio',
399 'rel' => 'dbMyisamWarning'
400 ]
401 ]
402 ] );
403 $s .= $this->parent->getHelpBox( 'config-mysql-engine-help' );
404 }
405
406 // If the current default charset is not supported, use a charset that is
407 $charsets = $this->getCharsets();
408 if ( !in_array( $this->getVar( '_MysqlCharset' ), $charsets ) ) {
409 $this->setVar( '_MysqlCharset', reset( $charsets ) );
410 }
411
412 return $s;
413 }
414
415 /**
416 * @return Status
417 */
418 public function submitSettingsForm() {
419 $this->setVarsFromRequest( [ '_MysqlEngine', '_MysqlCharset' ] );
420 $status = $this->submitWebUserBox();
421 if ( !$status->isOK() ) {
422 return $status;
423 }
424
425 // Validate the create checkbox
426 $canCreate = $this->canCreateAccounts();
427 if ( !$canCreate ) {
428 $this->setVar( '_CreateDBAccount', false );
429 $create = false;
430 } else {
431 $create = $this->getVar( '_CreateDBAccount' );
432 }
433
434 if ( !$create ) {
435 // Test the web account
436 try {
437 Database::factory( 'mysql', [
438 'host' => $this->getVar( 'wgDBserver' ),
439 'user' => $this->getVar( 'wgDBuser' ),
440 'password' => $this->getVar( 'wgDBpassword' ),
441 'dbname' => false,
442 'flags' => 0,
443 'tablePrefix' => $this->getVar( 'wgDBprefix' )
444 ] );
445 } catch ( DBConnectionError $e ) {
446 return Status::newFatal( 'config-connection-error', $e->getMessage() );
447 }
448 }
449
450 // Validate engines and charsets
451 // This is done pre-submit already so it's just for security
452 $engines = $this->getEngines();
453 if ( !in_array( $this->getVar( '_MysqlEngine' ), $engines ) ) {
454 $this->setVar( '_MysqlEngine', reset( $engines ) );
455 }
456 $charsets = $this->getCharsets();
457 if ( !in_array( $this->getVar( '_MysqlCharset' ), $charsets ) ) {
458 $this->setVar( '_MysqlCharset', reset( $charsets ) );
459 }
460
461 return Status::newGood();
462 }
463
464 public function preInstall() {
465 # Add our user callback to installSteps, right before the tables are created.
466 $callback = [
467 'name' => 'user',
468 'callback' => [ $this, 'setupUser' ],
469 ];
470 $this->parent->addInstallStep( $callback, 'tables' );
471 }
472
473 /**
474 * @return Status
475 */
476 public function setupDatabase() {
477 $status = $this->getConnection();
478 if ( !$status->isOK() ) {
479 return $status;
480 }
481 /** @var Database $conn */
482 $conn = $status->value;
483 $dbName = $this->getVar( 'wgDBname' );
484 if ( !$this->databaseExists( $dbName ) ) {
485 $conn->query(
486 "CREATE DATABASE " . $conn->addIdentifierQuotes( $dbName ) . "CHARACTER SET utf8",
487 __METHOD__
488 );
489 }
490 $conn->selectDB( $dbName );
491 $this->setupSchemaVars();
492
493 return $status;
494 }
495
496 /**
497 * Try to see if a given database exists
498 * @param string $dbName Database name to check
499 * @return bool
500 */
501 private function databaseExists( $dbName ) {
502 $encDatabase = $this->db->addQuotes( $dbName );
503
504 return $this->db->query(
505 "SELECT 1 FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = $encDatabase",
506 __METHOD__
507 )->numRows() > 0;
508 }
509
510 /**
511 * @return Status
512 */
513 public function setupUser() {
514 $dbUser = $this->getVar( 'wgDBuser' );
515 if ( $dbUser == $this->getVar( '_InstallUser' ) ) {
516 return Status::newGood();
517 }
518 $status = $this->getConnection();
519 if ( !$status->isOK() ) {
520 return $status;
521 }
522
523 $this->setupSchemaVars();
524 $dbName = $this->getVar( 'wgDBname' );
525 $this->db->selectDB( $dbName );
526 $server = $this->getVar( 'wgDBserver' );
527 $password = $this->getVar( 'wgDBpassword' );
528 $grantableNames = [];
529
530 if ( $this->getVar( '_CreateDBAccount' ) ) {
531 // Before we blindly try to create a user that already has access,
532 try { // first attempt to connect to the database
533 Database::factory( 'mysql', [
534 'host' => $server,
535 'user' => $dbUser,
536 'password' => $password,
537 'dbname' => false,
538 'flags' => 0,
539 'tablePrefix' => $this->getVar( 'wgDBprefix' )
540 ] );
541 $grantableNames[] = $this->buildFullUserName( $dbUser, $server );
542 $tryToCreate = false;
543 } catch ( DBConnectionError $e ) {
544 $tryToCreate = true;
545 }
546 } else {
547 $grantableNames[] = $this->buildFullUserName( $dbUser, $server );
548 $tryToCreate = false;
549 }
550
551 if ( $tryToCreate ) {
552 $createHostList = [
553 $server,
554 'localhost',
555 'localhost.localdomain',
556 '%'
557 ];
558
559 $createHostList = array_unique( $createHostList );
560 $escPass = $this->db->addQuotes( $password );
561
562 foreach ( $createHostList as $host ) {
563 $fullName = $this->buildFullUserName( $dbUser, $host );
564 if ( !$this->userDefinitelyExists( $host, $dbUser ) ) {
565 try {
566 $this->db->begin( __METHOD__ );
567 $this->db->query( "CREATE USER $fullName IDENTIFIED BY $escPass", __METHOD__ );
568 $this->db->commit( __METHOD__ );
569 $grantableNames[] = $fullName;
570 } catch ( DBQueryError $dqe ) {
571 if ( $this->db->lastErrno() == 1396 /* ER_CANNOT_USER */ ) {
572 // User (probably) already exists
573 $this->db->rollback( __METHOD__ );
574 $status->warning( 'config-install-user-alreadyexists', $dbUser );
575 $grantableNames[] = $fullName;
576 break;
577 } else {
578 // If we couldn't create for some bizzare reason and the
579 // user probably doesn't exist, skip the grant
580 $this->db->rollback( __METHOD__ );
581 $status->warning( 'config-install-user-create-failed', $dbUser, $dqe->getMessage() );
582 }
583 }
584 } else {
585 $status->warning( 'config-install-user-alreadyexists', $dbUser );
586 $grantableNames[] = $fullName;
587 break;
588 }
589 }
590 }
591
592 // Try to grant to all the users we know exist or we were able to create
593 $dbAllTables = $this->db->addIdentifierQuotes( $dbName ) . '.*';
594 foreach ( $grantableNames as $name ) {
595 try {
596 $this->db->begin( __METHOD__ );
597 $this->db->query( "GRANT ALL PRIVILEGES ON $dbAllTables TO $name", __METHOD__ );
598 $this->db->commit( __METHOD__ );
599 } catch ( DBQueryError $dqe ) {
600 $this->db->rollback( __METHOD__ );
601 $status->fatal( 'config-install-user-grant-failed', $dbUser, $dqe->getMessage() );
602 }
603 }
604
605 return $status;
606 }
607
608 /**
609 * Return a formal 'User'@'Host' username for use in queries
610 * @param string $name Username, quotes will be added
611 * @param string $host Hostname, quotes will be added
612 * @return string
613 */
614 private function buildFullUserName( $name, $host ) {
615 return $this->db->addQuotes( $name ) . '@' . $this->db->addQuotes( $host );
616 }
617
618 /**
619 * Try to see if the user account exists. Our "superuser" may not have
620 * access to mysql.user, so false means "no" or "maybe"
621 * @param string $host Hostname to check
622 * @param string $user Username to check
623 * @return bool
624 */
625 private function userDefinitelyExists( $host, $user ) {
626 try {
627 $res = $this->db->selectRow( 'mysql.user', [ 'Host', 'User' ],
628 [ 'Host' => $host, 'User' => $user ], __METHOD__ );
629
630 return (bool)$res;
631 } catch ( DBQueryError $dqe ) {
632 return false;
633 }
634 }
635
636 /**
637 * Return any table options to be applied to all tables that don't
638 * override them.
639 *
640 * @return string
641 */
642 protected function getTableOptions() {
643 $options = [];
644 if ( $this->getVar( '_MysqlEngine' ) !== null ) {
645 $options[] = "ENGINE=" . $this->getVar( '_MysqlEngine' );
646 }
647 if ( $this->getVar( '_MysqlCharset' ) !== null ) {
648 $options[] = 'DEFAULT CHARSET=' . $this->getVar( '_MysqlCharset' );
649 }
650
651 return implode( ', ', $options );
652 }
653
654 /**
655 * Get variables to substitute into tables.sql and the SQL patch files.
656 *
657 * @return array
658 */
659 public function getSchemaVars() {
660 return [
661 'wgDBTableOptions' => $this->getTableOptions(),
662 'wgDBname' => $this->getVar( 'wgDBname' ),
663 'wgDBuser' => $this->getVar( 'wgDBuser' ),
664 'wgDBpassword' => $this->getVar( 'wgDBpassword' ),
665 ];
666 }
667
668 public function getLocalSettings() {
669 $prefix = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgDBprefix' ) );
670 $tblOpts = LocalSettingsGenerator::escapePhpString( $this->getTableOptions() );
671
672 return "# MySQL specific settings
673 \$wgDBprefix = \"{$prefix}\";
674
675 # MySQL table options to use during installation or update
676 \$wgDBTableOptions = \"{$tblOpts}\";";
677 }
678 }