3 * DBMS-specific installation helper.
10 * Base class for DBMS-specific installation helper classes.
15 abstract class DatabaseInstaller
{
18 * The Installer object.
20 * TODO: naming this parent is confusing, 'installer' would be clearer.
27 * The database connection.
34 * Internal variables for installation.
38 protected $internalDefaults = array();
41 * Array of MW configuration globals this class uses.
45 protected $globalNames = array();
48 * Return the internal name, e.g. 'mysql', or 'sqlite'.
50 public abstract function getName();
53 * @return true if the client library is compiled in.
55 public abstract function isCompiled();
58 * Get HTML for a web form that configures this database. Configuration
59 * at this time should be the minimum needed to connect and test
60 * whether install or upgrade is required.
62 * If this is called, $this->parent can be assumed to be a WebInstaller.
64 public abstract function getConnectForm();
67 * Set variables based on the request array, assuming it was submitted
68 * via the form returned by getConnectForm(). Validate the connection
69 * settings by attempting to connect with them.
71 * If this is called, $this->parent can be assumed to be a WebInstaller.
75 public abstract function submitConnectForm();
78 * Get HTML for a web form that retrieves settings used for installation.
79 * $this->parent can be assumed to be a WebInstaller.
80 * If the DB type has no settings beyond those already configured with
81 * getConnectForm(), this should return false.
83 public function getSettingsForm() {
88 * Set variables based on the request array, assuming it was submitted via
89 * the form return by getSettingsForm().
93 public function submitSettingsForm() {
94 return Status
::newGood();
98 * Open a connection to the database using the administrative user/password
99 * currently defined in the session, without any caching. Returns a status
100 * object. On success, the status object will contain a Database object in
105 public abstract function openConnection();
108 * Create the database and return a Status object indicating success or
113 public abstract function setupDatabase();
116 * Connect to the database using the administrative user/password currently
117 * defined in the session. Returns a status object. On success, the status
118 * object will contain a Database object in its value member.
120 * This will return a cached connection if one is available.
124 public function getConnection() {
126 return Status
::newGood( $this->db
);
128 $status = $this->openConnection();
129 if ( $status->isOK() ) {
130 $this->db
= $status->value
;
132 $this->db
->clearFlag( DBO_TRX
);
139 * Create database tables from scratch.
143 public function createTables() {
144 $status = $this->getConnection();
145 if ( !$status->isOK() ) {
148 $this->db
->selectDB( $this->getVar( 'wgDBname' ) );
150 if( $this->db
->tableExists( 'user' ) ) {
151 $status->warning( 'config-install-tables-exist' );
155 $this->db
->setFlag( DBO_DDLMODE
); // For Oracle's handling of schema files
156 $this->db
->begin( __METHOD__
);
158 $error = $this->db
->sourceFile( $this->db
->getSchema() );
159 if( $error !== true ) {
160 $this->db
->reportQueryError( $error, 0, '', __METHOD__
);
161 $this->db
->rollback( __METHOD__
);
162 $status->fatal( 'config-install-tables-failed', $error );
164 $this->db
->commit( __METHOD__
);
166 // Resume normal operations
167 if( $status->isOk() ) {
174 * Create the tables for each extension the user enabled
177 public function createExtensionTables() {
178 $status = $this->getConnection();
179 if ( !$status->isOK() ) {
182 $updater = DatabaseUpdater
::newForDB( $this->db
);
183 $extensionUpdates = $updater->getNewExtensions();
185 // No extensions need tables (or haven't updated to new installer support)
186 if( !count( $extensionUpdates ) ) {
190 $ourExtensions = array_map( 'strtolower', $this->getVar( '_Extensions' ) );
192 foreach( $ourExtensions as $ext ) {
193 if( isset( $extensionUpdates[$ext] ) ) {
194 $this->db
->begin( __METHOD__
);
195 $error = $this->db
->sourceFile( $extensionUpdates[$ext] );
196 if( $error !== true ) {
197 $this->db
->rollback( __METHOD__
);
198 $status->warning( 'config-install-tables-failed', $error );
200 $this->db
->commit( __METHOD__
);
208 * Get the DBMS-specific options for LocalSettings.php generation.
212 public abstract function getLocalSettings();
215 * Override this to provide DBMS-specific schema variables, to be
216 * substituted into tables.sql and other schema files.
218 public function getSchemaVars() {
223 * Set appropriate schema variables in the current database connection.
225 * This should be called after any request data has been imported, but before
226 * any write operations to the database.
228 public function setupSchemaVars() {
229 $status = $this->getConnection();
230 if ( $status->isOK() ) {
231 $status->value
->setSchemaVars( $this->getSchemaVars() );
233 throw new MWException( __METHOD__
.': unexpected DB connection error' );
238 * Set up LBFactory so that wfGetDB() etc. works.
239 * We set up a special LBFactory instance which returns the current
240 * installer connection.
242 public function enableLB() {
243 $status = $this->getConnection();
244 if ( !$status->isOK() ) {
245 throw new MWException( __METHOD__
.': unexpected DB connection error' );
247 LBFactory
::setInstance( new LBFactory_Single( array(
248 'connection' => $status->value
) ) );
252 * Perform database upgrades
256 public function doUpgrade() {
257 $this->setupSchemaVars();
261 ob_start( array( $this, 'outputHandler' ) );
263 $up = DatabaseUpdater
::newForDB( $this->db
);
265 } catch ( MWException
$e ) {
266 echo "\nAn error occured:\n";
275 * Allow DB installers a chance to make last-minute changes before installation
276 * occurs. This happens before setupDatabase() or createTables() is called, but
277 * long after the constructor. Helpful for things like modifying setup steps :)
279 public function preInstall() {
284 * Allow DB installers a chance to make checks before upgrade.
286 public function preUpgrade() {
291 * Get an array of MW configuration globals that will be configured by this class.
293 public function getGlobalNames() {
294 return $this->globalNames
;
298 * Construct and initialise parent.
299 * This is typically only called from Installer::getDBInstaller()
301 public function __construct( $parent ) {
302 $this->parent
= $parent;
306 * Convenience function.
307 * Check if a named extension is present.
311 protected static function checkExtension( $name ) {
312 wfSuppressWarnings();
313 $compiled = wfDl( $name );
319 * Get the internationalised name for this DBMS.
321 public function getReadableName() {
322 return wfMsg( 'config-type-' . $this->getName() );
326 * Get a name=>value map of MW configuration globals that overrides.
327 * DefaultSettings.php
329 public function getGlobalDefaults() {
334 * Get a name=>value map of internal variables used during installation.
336 public function getInternalDefaults() {
337 return $this->internalDefaults
;
341 * Get a variable, taking local defaults into account.
343 public function getVar( $var, $default = null ) {
344 $defaults = $this->getGlobalDefaults();
345 $internal = $this->getInternalDefaults();
346 if ( isset( $defaults[$var] ) ) {
347 $default = $defaults[$var];
348 } elseif ( isset( $internal[$var] ) ) {
349 $default = $internal[$var];
351 return $this->parent
->getVar( $var, $default );
355 * Convenience alias for $this->parent->setVar()
357 public function setVar( $name, $value ) {
358 $this->parent
->setVar( $name, $value );
362 * Get a labelled text box to configure a local variable.
364 public function getTextBox( $var, $label, $attribs = array(), $helpData = "" ) {
365 $name = $this->getName() . '_' . $var;
366 $value = $this->getVar( $var );
367 if ( !isset( $attribs ) ) {
370 return $this->parent
->getTextBox( array(
373 'attribs' => $attribs,
374 'controlName' => $name,
381 * Get a labelled password box to configure a local variable.
382 * Implements password hiding.
384 public function getPasswordBox( $var, $label, $attribs = array(), $helpData = "" ) {
385 $name = $this->getName() . '_' . $var;
386 $value = $this->getVar( $var );
387 if ( !isset( $attribs ) ) {
390 return $this->parent
->getPasswordBox( array(
393 'attribs' => $attribs,
394 'controlName' => $name,
401 * Get a labelled checkbox to configure a local boolean variable.
403 public function getCheckBox( $var, $label, $attribs = array(), $helpData = "" ) {
404 $name = $this->getName() . '_' . $var;
405 $value = $this->getVar( $var );
406 return $this->parent
->getCheckBox( array(
409 'attribs' => $attribs,
410 'controlName' => $name,
417 * Get a set of labelled radio buttons.
419 * @param $params Array:
421 * var: The variable to be configured (required)
422 * label: The message name for the label (required)
423 * itemLabelPrefix: The message name prefix for the item labels (required)
424 * values: List of allowed values (required)
425 * itemAttribs Array of attribute arrays, outer key is the value name (optional)
428 public function getRadioSet( $params ) {
429 $params['controlName'] = $this->getName() . '_' . $params['var'];
430 $params['value'] = $this->getVar( $params['var'] );
431 return $this->parent
->getRadioSet( $params );
435 * Convenience function to set variables based on form data.
436 * Assumes that variables containing "password" in the name are (potentially
438 * @param $varNames Array
440 public function setVarsFromRequest( $varNames ) {
441 return $this->parent
->setVarsFromRequest( $varNames, $this->getName() . '_' );
445 * Determine whether an existing installation of MediaWiki is present in
446 * the configured administrative connection. Returns true if there is
447 * such a wiki, false if the database doesn't exist.
449 * Traditionally, this is done by testing for the existence of either
450 * the revision table or the cur table.
454 public function needsUpgrade() {
455 $status = $this->getConnection();
456 if ( !$status->isOK() ) {
460 if ( !$this->db
->selectDB( $this->getVar( 'wgDBname' ) ) ) {
463 return $this->db
->tableExists( 'cur' ) ||
$this->db
->tableExists( 'revision' );
467 * Get a standard install-user fieldset.
471 public function getInstallUserBox() {
473 Html
::openElement( 'fieldset' ) .
474 Html
::element( 'legend', array(), wfMsg( 'config-db-install-account' ) ) .
475 $this->getTextBox( '_InstallUser', 'config-db-username', array(), $this->parent
->getHelpBox( 'config-db-install-username' ) ) .
476 $this->getPasswordBox( '_InstallPassword', 'config-db-password', array(), $this->parent
->getHelpBox( 'config-db-install-password' ) ) .
477 Html
::closeElement( 'fieldset' );
481 * Submit a standard install user fieldset.
483 public function submitInstallUserBox() {
484 $this->setVarsFromRequest( array( '_InstallUser', '_InstallPassword' ) );
485 return Status
::newGood();
489 * Get a standard web-user fieldset
490 * @param $noCreateMsg String: Message to display instead of the creation checkbox.
491 * Set this to false to show a creation checkbox.
495 public function getWebUserBox( $noCreateMsg = false ) {
496 $s = Html
::openElement( 'fieldset' ) .
497 Html
::element( 'legend', array(), wfMsg( 'config-db-web-account' ) ) .
499 '_SameAccount', 'config-db-web-account-same',
500 array( 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' )
502 Html
::openElement( 'div', array( 'id' => 'dbOtherAccount', 'style' => 'display: none;' ) ) .
503 $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
504 $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
505 $this->parent
->getHelpBox( 'config-db-web-help' );
506 if ( $noCreateMsg ) {
507 $s .= $this->parent
->getWarningBox( wfMsgNoTrans( $noCreateMsg ) );
509 $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
511 $s .= Html
::closeElement( 'div' ) . Html
::closeElement( 'fieldset' );
516 * Submit the form from getWebUserBox().
520 public function submitWebUserBox() {
521 $this->setVarsFromRequest(
522 array( 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' )
525 if ( $this->getVar( '_SameAccount' ) ) {
526 $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
527 $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
530 return Status
::newGood();
534 * Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
538 public function populateInterwikiTable() {
539 $status = $this->getConnection();
540 if ( !$status->isOK() ) {
543 $this->db
->selectDB( $this->getVar( 'wgDBname' ) );
545 if( $this->db
->selectRow( 'interwiki', '*', array(), __METHOD__
) ) {
546 $status->warning( 'config-install-interwiki-exists' );
550 wfSuppressWarnings();
551 $rows = file( "$IP/maintenance/interwiki.list",
552 FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES
);
554 $interwikis = array();
556 return Status
::newFatal( 'config-install-interwiki-list' );
558 foreach( $rows as $row ) {
559 $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
560 if ( $row == "" ) continue;
562 $interwikis[] = array_combine(
563 array( 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ),
567 $this->db
->insert( 'interwiki', $interwikis, __METHOD__
);
568 return Status
::newGood();
571 public function outputHandler( $string ) {
572 return htmlspecialchars( $string );