3 * DBMS-specific installation helper.
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.
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.
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
25 * Base class for DBMS-specific installation helper classes.
30 abstract class DatabaseInstaller
{
33 * The Installer object.
35 * @todo Naming this parent is confusing, 'installer' would be clearer.
42 * The database connection.
49 * Internal variables for installation.
53 protected $internalDefaults = [];
56 * Array of MW configuration globals this class uses.
60 protected $globalNames = [];
63 * Return the internal name, e.g. 'mysql', or 'sqlite'.
65 abstract public function getName();
68 * @return bool Returns true if the client library is compiled in.
70 abstract public function isCompiled();
73 * Checks for installation prerequisites other than those checked by isCompiled()
77 public function checkPrerequisites() {
78 return Status
::newGood();
82 * Get HTML for a web form that configures this database. Configuration
83 * at this time should be the minimum needed to connect and test
84 * whether install or upgrade is required.
86 * If this is called, $this->parent can be assumed to be a WebInstaller.
88 abstract public function getConnectForm();
91 * Set variables based on the request array, assuming it was submitted
92 * via the form returned by getConnectForm(). Validate the connection
93 * settings by attempting to connect with them.
95 * If this is called, $this->parent can be assumed to be a WebInstaller.
99 abstract public function submitConnectForm();
102 * Get HTML for a web form that retrieves settings used for installation.
103 * $this->parent can be assumed to be a WebInstaller.
104 * If the DB type has no settings beyond those already configured with
105 * getConnectForm(), this should return false.
108 public function getSettingsForm() {
113 * Set variables based on the request array, assuming it was submitted via
114 * the form return by getSettingsForm().
118 public function submitSettingsForm() {
119 return Status
::newGood();
123 * Open a connection to the database using the administrative user/password
124 * currently defined in the session, without any caching. Returns a status
125 * object. On success, the status object will contain a Database object in
130 abstract public function openConnection();
133 * Create the database and return a Status object indicating success or
138 abstract public function setupDatabase();
141 * Connect to the database using the administrative user/password currently
142 * defined in the session. Returns a status object. On success, the status
143 * object will contain a Database object in its value member.
145 * This will return a cached connection if one is available.
149 public function getConnection() {
151 return Status
::newGood( $this->db
);
154 $status = $this->openConnection();
155 if ( $status->isOK() ) {
156 $this->db
= $status->value
;
158 $this->db
->clearFlag( DBO_TRX
);
159 $this->db
->commit( __METHOD__
);
166 * Apply a SQL source file to the database as part of running an installation step.
168 * @param string $sourceFileMethod
169 * @param string $stepName
170 * @param string $archiveTableMustNotExist
173 private function stepApplySourceFile(
176 $archiveTableMustNotExist = false
178 $status = $this->getConnection();
179 if ( !$status->isOK() ) {
182 $this->db
->selectDB( $this->getVar( 'wgDBname' ) );
184 if ( $archiveTableMustNotExist && $this->db
->tableExists( 'archive', __METHOD__
) ) {
185 $status->warning( "config-$stepName-tables-exist" );
191 $this->db
->setFlag( DBO_DDLMODE
); // For Oracle's handling of schema files
192 $this->db
->begin( __METHOD__
);
194 $error = $this->db
->sourceFile(
195 call_user_func( [ $this, $sourceFileMethod ], $this->db
)
197 if ( $error !== true ) {
198 $this->db
->reportQueryError( $error, 0, '', __METHOD__
);
199 $this->db
->rollback( __METHOD__
);
200 $status->fatal( "config-$stepName-tables-failed", $error );
202 $this->db
->commit( __METHOD__
);
204 // Resume normal operations
205 if ( $status->isOK() ) {
213 * Create database tables from scratch.
217 public function createTables() {
218 return $this->stepApplySourceFile( 'getSchemaPath', 'install', true );
222 * Insert update keys into table to prevent running unneded updates.
226 public function insertUpdateKeys() {
227 return $this->stepApplySourceFile( 'getUpdateKeysPath', 'updates', false );
231 * Return a path to the DBMS-specific SQL file if it exists,
232 * otherwise default SQL file
234 * @param IDatabase $db
235 * @param string $filename
238 private function getSqlFilePath( $db, $filename ) {
241 $dbmsSpecificFilePath = "$IP/maintenance/" . $db->getType() . "/$filename";
242 if ( file_exists( $dbmsSpecificFilePath ) ) {
243 return $dbmsSpecificFilePath;
245 return "$IP/maintenance/$filename";
250 * Return a path to the DBMS-specific schema file,
251 * otherwise default to tables.sql
253 * @param IDatabase $db
256 public function getSchemaPath( $db ) {
257 return $this->getSqlFilePath( $db, 'tables.sql' );
261 * Return a path to the DBMS-specific update key file,
262 * otherwise default to update-keys.sql
264 * @param IDatabase $db
267 public function getUpdateKeysPath( $db ) {
268 return $this->getSqlFilePath( $db, 'update-keys.sql' );
272 * Create the tables for each extension the user enabled
275 public function createExtensionTables() {
276 $status = $this->getConnection();
277 if ( !$status->isOK() ) {
281 // Now run updates to create tables for old extensions
282 DatabaseUpdater
::newForDB( $this->db
)->doUpdates( [ 'extensions' ] );
288 * Get the DBMS-specific options for LocalSettings.php generation.
292 abstract public function getLocalSettings();
295 * Override this to provide DBMS-specific schema variables, to be
296 * substituted into tables.sql and other schema files.
299 public function getSchemaVars() {
304 * Set appropriate schema variables in the current database connection.
306 * This should be called after any request data has been imported, but before
307 * any write operations to the database.
309 public function setupSchemaVars() {
310 $status = $this->getConnection();
311 if ( $status->isOK() ) {
312 $status->value
->setSchemaVars( $this->getSchemaVars() );
314 $msg = __METHOD__
. ': unexpected error while establishing'
315 . ' a database connection with message: '
316 . $status->getMessage()->plain();
317 throw new MWException( $msg );
322 * Set up LBFactory so that wfGetDB() etc. works.
323 * We set up a special LBFactory instance which returns the current
324 * installer connection.
326 public function enableLB() {
327 $status = $this->getConnection();
328 if ( !$status->isOK() ) {
329 throw new MWException( __METHOD__
. ': unexpected DB connection error' );
332 \MediaWiki\MediaWikiServices
::resetGlobalInstance();
333 $services = \MediaWiki\MediaWikiServices
::getInstance();
335 $connection = $status->value
;
336 $services->redefineService( 'DBLoadBalancerFactory', function() use ( $connection ) {
337 return LBFactorySingle
::newFromConnection( $connection );
343 * Perform database upgrades
347 public function doUpgrade() {
348 $this->setupSchemaVars();
352 ob_start( [ $this, 'outputHandler' ] );
353 $up = DatabaseUpdater
::newForDB( $this->db
);
356 } catch ( Exception
$e ) {
357 echo "\nAn error occurred:\n";
368 * Allow DB installers a chance to make last-minute changes before installation
369 * occurs. This happens before setupDatabase() or createTables() is called, but
370 * long after the constructor. Helpful for things like modifying setup steps :)
372 public function preInstall() {
376 * Allow DB installers a chance to make checks before upgrade.
378 public function preUpgrade() {
382 * Get an array of MW configuration globals that will be configured by this class.
385 public function getGlobalNames() {
386 return $this->globalNames
;
390 * Construct and initialise parent.
391 * This is typically only called from Installer::getDBInstaller()
392 * @param WebInstaller $parent
394 public function __construct( $parent ) {
395 $this->parent
= $parent;
399 * Convenience function.
400 * Check if a named extension is present.
402 * @param string $name
405 protected static function checkExtension( $name ) {
406 return extension_loaded( $name );
410 * Get the internationalised name for this DBMS.
413 public function getReadableName() {
414 // Messages: config-type-mysql, config-type-postgres, config-type-sqlite,
415 // config-type-oracle
416 return wfMessage( 'config-type-' . $this->getName() )->text();
420 * Get a name=>value map of MW configuration globals for the default values.
423 public function getGlobalDefaults() {
425 foreach ( $this->getGlobalNames() as $var ) {
426 if ( isset( $GLOBALS[$var] ) ) {
427 $defaults[$var] = $GLOBALS[$var];
434 * Get a name=>value map of internal variables used during installation.
437 public function getInternalDefaults() {
438 return $this->internalDefaults
;
442 * Get a variable, taking local defaults into account.
444 * @param mixed|null $default
447 public function getVar( $var, $default = null ) {
448 $defaults = $this->getGlobalDefaults();
449 $internal = $this->getInternalDefaults();
450 if ( isset( $defaults[$var] ) ) {
451 $default = $defaults[$var];
452 } elseif ( isset( $internal[$var] ) ) {
453 $default = $internal[$var];
456 return $this->parent
->getVar( $var, $default );
460 * Convenience alias for $this->parent->setVar()
461 * @param string $name
462 * @param mixed $value
464 public function setVar( $name, $value ) {
465 $this->parent
->setVar( $name, $value );
469 * Get a labelled text box to configure a local variable.
472 * @param string $label
473 * @param array $attribs
474 * @param string $helpData
477 public function getTextBox( $var, $label, $attribs = [], $helpData = "" ) {
478 $name = $this->getName() . '_' . $var;
479 $value = $this->getVar( $var );
480 if ( !isset( $attribs ) ) {
484 return $this->parent
->getTextBox( [
487 'attribs' => $attribs,
488 'controlName' => $name,
495 * Get a labelled password box to configure a local variable.
496 * Implements password hiding.
499 * @param string $label
500 * @param array $attribs
501 * @param string $helpData
504 public function getPasswordBox( $var, $label, $attribs = [], $helpData = "" ) {
505 $name = $this->getName() . '_' . $var;
506 $value = $this->getVar( $var );
507 if ( !isset( $attribs ) ) {
511 return $this->parent
->getPasswordBox( [
514 'attribs' => $attribs,
515 'controlName' => $name,
522 * Get a labelled checkbox to configure a local boolean variable.
525 * @param string $label
526 * @param array $attribs Optional.
527 * @param string $helpData Optional.
530 public function getCheckBox( $var, $label, $attribs = [], $helpData = "" ) {
531 $name = $this->getName() . '_' . $var;
532 $value = $this->getVar( $var );
534 return $this->parent
->getCheckBox( [
537 'attribs' => $attribs,
538 'controlName' => $name,
545 * Get a set of labelled radio buttons.
547 * @param array $params Parameters are:
548 * var: The variable to be configured (required)
549 * label: The message name for the label (required)
550 * itemLabelPrefix: The message name prefix for the item labels (required)
551 * values: List of allowed values (required)
552 * itemAttribs Array of attribute arrays, outer key is the value name (optional)
556 public function getRadioSet( $params ) {
557 $params['controlName'] = $this->getName() . '_' . $params['var'];
558 $params['value'] = $this->getVar( $params['var'] );
560 return $this->parent
->getRadioSet( $params );
564 * Convenience function to set variables based on form data.
565 * Assumes that variables containing "password" in the name are (potentially
567 * @param array $varNames
570 public function setVarsFromRequest( $varNames ) {
571 return $this->parent
->setVarsFromRequest( $varNames, $this->getName() . '_' );
575 * Determine whether an existing installation of MediaWiki is present in
576 * the configured administrative connection. Returns true if there is
577 * such a wiki, false if the database doesn't exist.
579 * Traditionally, this is done by testing for the existence of either
580 * the revision table or the cur table.
584 public function needsUpgrade() {
585 $status = $this->getConnection();
586 if ( !$status->isOK() ) {
590 if ( !$this->db
->selectDB( $this->getVar( 'wgDBname' ) ) ) {
594 return $this->db
->tableExists( 'cur', __METHOD__
) ||
595 $this->db
->tableExists( 'revision', __METHOD__
);
599 * Get a standard install-user fieldset.
603 public function getInstallUserBox() {
604 return Html
::openElement( 'fieldset' ) .
605 Html
::element( 'legend', [], wfMessage( 'config-db-install-account' )->text() ) .
608 'config-db-username',
610 $this->parent
->getHelpBox( 'config-db-install-username' )
612 $this->getPasswordBox(
614 'config-db-password',
616 $this->parent
->getHelpBox( 'config-db-install-password' )
618 Html
::closeElement( 'fieldset' );
622 * Submit a standard install user fieldset.
625 public function submitInstallUserBox() {
626 $this->setVarsFromRequest( [ '_InstallUser', '_InstallPassword' ] );
628 return Status
::newGood();
632 * Get a standard web-user fieldset
633 * @param string|bool $noCreateMsg Message to display instead of the creation checkbox.
634 * Set this to false to show a creation checkbox (default).
638 public function getWebUserBox( $noCreateMsg = false ) {
639 $wrapperStyle = $this->getVar( '_SameAccount' ) ?
'display: none' : '';
640 $s = Html
::openElement( 'fieldset' ) .
641 Html
::element( 'legend', [], wfMessage( 'config-db-web-account' )->text() ) .
643 '_SameAccount', 'config-db-web-account-same',
644 [ 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' ]
646 Html
::openElement( 'div', [ 'id' => 'dbOtherAccount', 'style' => $wrapperStyle ] ) .
647 $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
648 $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
649 $this->parent
->getHelpBox( 'config-db-web-help' );
650 if ( $noCreateMsg ) {
651 $s .= $this->parent
->getWarningBox( wfMessage( $noCreateMsg )->plain() );
653 $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
655 $s .= Html
::closeElement( 'div' ) . Html
::closeElement( 'fieldset' );
661 * Submit the form from getWebUserBox().
665 public function submitWebUserBox() {
666 $this->setVarsFromRequest(
667 [ 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' ]
670 if ( $this->getVar( '_SameAccount' ) ) {
671 $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
672 $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
675 if ( $this->getVar( '_CreateDBAccount' ) && strval( $this->getVar( 'wgDBpassword' ) ) == '' ) {
676 return Status
::newFatal( 'config-db-password-empty', $this->getVar( 'wgDBuser' ) );
679 return Status
::newGood();
683 * Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
687 public function populateInterwikiTable() {
688 $status = $this->getConnection();
689 if ( !$status->isOK() ) {
692 $this->db
->selectDB( $this->getVar( 'wgDBname' ) );
694 if ( $this->db
->selectRow( 'interwiki', '*', [], __METHOD__
) ) {
695 $status->warning( 'config-install-interwiki-exists' );
700 MediaWiki\
suppressWarnings();
701 $rows = file( "$IP/maintenance/interwiki.list",
702 FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES
);
703 MediaWiki\restoreWarnings
();
706 return Status
::newFatal( 'config-install-interwiki-list' );
708 foreach ( $rows as $row ) {
709 $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
714 $interwikis[] = array_combine(
715 [ 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ],
719 $this->db
->insert( 'interwiki', $interwikis, __METHOD__
);
721 return Status
::newGood();
724 public function outputHandler( $string ) {
725 return htmlspecialchars( $string );