includes/installer/DatabaseInstaller.php

   1 <?php
   2 /**
   3  * DBMS-specific installation helper.
   4  *
   5  * @file
   6  * @ingroup Deployment
   7  */
   8
   9 /**
  10  * Base class for DBMS-specific installation helper classes.
  11  *
  12  * @ingroup Deployment
  13  * @since 1.17
  14  */
  15 abstract class DatabaseInstaller {
  16
  17         /**
  18          * The Installer object.
  19          *
  20          * TODO: naming this parent is confusing, 'installer' would be clearer.
  21          *
  22          * @var Installer
  23          */
  24         public $parent;
  25
  26         /**
  27          * The database connection.
  28          *
  29          * @var DatabaseBase
  30          */
  31         public $db = null;
  32
  33         /**
  34          * Internal variables for installation.
  35          *
  36          * @var array
  37          */
  38         protected $internalDefaults = array();
  39
  40         /**
  41          * Array of MW configuration globals this class uses.
  42          *
  43          * @var array
  44          */
  45         protected $globalNames = array();
  46
  47         /**
  48          * Return the internal name, e.g. 'mysql', or 'sqlite'.
  49          */
  50         public abstract function getName();
  51
  52         /**
  53          * @return true if the client library is compiled in.
  54          */
  55         public abstract function isCompiled();
  56
  57         /**
  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.
  61          *
  62          * If this is called, $this->parent can be assumed to be a WebInstaller.
  63          */
  64         public abstract function getConnectForm();
  65
  66         /**
  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.
  70          *
  71          * If this is called, $this->parent can be assumed to be a WebInstaller.
  72          *
  73          * @return Status
  74          */
  75         public abstract function submitConnectForm();
  76
  77         /**
  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.
  82          */
  83         public function getSettingsForm() {
  84                 return false;
  85         }
  86
  87         /**
  88          * Set variables based on the request array, assuming it was submitted via
  89          * the form return by getSettingsForm().
  90          *
  91          * @return Status
  92          */
  93         public function submitSettingsForm() {
  94                 return Status::newGood();
  95         }
  96
  97         /**
  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
 101          * its value member.
 102          *
 103          * @return Status
 104          */
 105         public abstract function openConnection();
 106
 107         /**
 108          * Create the database and return a Status object indicating success or
 109          * failure.
 110          *
 111          * @return Status
 112          */
 113         public abstract function setupDatabase();
 114
 115         /**
 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.
 119          *
 120          * This will return a cached connection if one is available.
 121          *
 122          * @return DatabaseBase
 123          */
 124         public function getConnection() {
 125                 if ( $this->db ) {
 126                         return Status::newGood( $this->db );
 127                 }
 128                 $status = $this->openConnection();
 129                 if ( $status->isOK() ) {
 130                         $this->db = $status->value;
 131                         // Enable autocommit
 132                         $this->db->clearFlag( DBO_TRX );
 133                         $this->db->commit();
 134                 }
 135                 return $status;
 136         }
 137
 138         /**
 139          * Create database tables from scratch.
 140          *
 141          * @return Status
 142          */
 143         public function createTables() {
 144                 $status = $this->getConnection();
 145                 if ( !$status->isOK() ) {
 146                         return $status;
 147                 }
 148                 $this->db->selectDB( $this->getVar( 'wgDBname' ) );
 149
 150                 if( $this->db->tableExists( 'user' ) ) {
 151                         $status->warning( 'config-install-tables-exist' );
 152                         return $status;
 153                 }
 154
 155                 $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
 156                 $this->db->begin( __METHOD__ );
 157
 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 );
 163                 } else {
 164                         $this->db->commit( __METHOD__ );
 165                 }
 166                 // Resume normal operations
 167                 if( $status->isOk() ) {
 168                         $this->enableLB();
 169                 }
 170                 return $status;
 171         }
 172
 173         /**
 174          * Get the DBMS-specific options for LocalSettings.php generation.
 175          *
 176          * @return String
 177          */
 178         public abstract function getLocalSettings();
 179
 180         /**
 181          * Override this to provide DBMS-specific schema variables, to be
 182          * substituted into tables.sql and other schema files.
 183          */
 184         public function getSchemaVars() {
 185                 return array();
 186         }
 187
 188         /**
 189          * Set appropriate schema variables in the current database connection.
 190          *
 191          * This should be called after any request data has been imported, but before
 192          * any write operations to the database.
 193          */
 194         public function setupSchemaVars() {
 195                 $status = $this->getConnection();
 196                 if ( $status->isOK() ) {
 197                         $status->value->setSchemaVars( $this->getSchemaVars() );
 198                 }
 199         }
 200
 201         /**
 202          * Set up LBFactory so that wfGetDB() etc. works.
 203          * We set up a special LBFactory instance which returns the current
 204          * installer connection.
 205          */
 206         public function enableLB() {
 207                 $status = $this->getConnection();
 208                 if ( !$status->isOK() ) {
 209                         throw new MWException( __METHOD__.': unexpected DB connection error' );
 210                 }
 211                 LBFactory::setInstance( new LBFactory_Single( array(
 212                         'connection' => $status->value ) ) );
 213         }
 214
 215         /**
 216          * Get a Database connection object. Throw an exception if we can't get one.
 217          *
 218          * @return DatabaseBase
 219          */
 220         public function getConnectionOrDie() {
 221         }
 222
 223         /**
 224          * Perform database upgrades
 225          *
 226          * @return Boolean
 227          */
 228         public function doUpgrade() {
 229                 $this->setupSchemaVars();
 230                 $this->enableLB();
 231
 232                 $ret = true;
 233                 ob_start( array( $this, 'outputHandler' ) );
 234                 try {
 235                         $up = DatabaseUpdater::newForDB( $this->db );
 236                         $up->doUpdates();
 237                 } catch ( MWException $e ) {
 238                         echo "\nAn error occured:\n";
 239                         echo $e->getText();
 240                         $ret = false;
 241                 }
 242                 ob_end_flush();
 243                 return $ret;
 244         }
 245
 246         /**
 247          * Allow DB installers a chance to make last-minute changes before installation
 248          * occurs. This happens before setupDatabase() or createTables() is called, but
 249          * long after the constructor. Helpful for things like modifying setup steps :)
 250          */
 251         public function preInstall() {
 252
 253         }
 254
 255         /**
 256          * Allow DB installers a chance to make checks before upgrade.
 257          */
 258         public function preUpgrade() {
 259
 260         }
 261
 262         /**
 263          * Get an array of MW configuration globals that will be configured by this class.
 264          */
 265         public function getGlobalNames() {
 266                 return $this->globalNames;
 267         }
 268
 269         /**
 270          * Construct and initialise parent.
 271          * This is typically only called from Installer::getDBInstaller()
 272          */
 273         public function __construct( $parent ) {
 274                 $this->parent = $parent;
 275         }
 276
 277         /**
 278          * Convenience function.
 279          * Check if a named extension is present.
 280          *
 281          * @see wfDl
 282          */
 283         protected static function checkExtension( $name ) {
 284                 wfSuppressWarnings();
 285                 $compiled = wfDl( $name );
 286                 wfRestoreWarnings();
 287                 return $compiled;
 288         }
 289
 290         /**
 291          * Get the internationalised name for this DBMS.
 292          */
 293         public function getReadableName() {
 294                 return wfMsg( 'config-type-' . $this->getName() );
 295         }
 296
 297         /**
 298          * Get a name=>value map of MW configuration globals that overrides.
 299          * DefaultSettings.php
 300          */
 301         public function getGlobalDefaults() {
 302                 return array();
 303         }
 304
 305         /**
 306          * Get a name=>value map of internal variables used during installation.
 307          */
 308         public function getInternalDefaults() {
 309                 return $this->internalDefaults;
 310         }
 311
 312         /**
 313          * Get a variable, taking local defaults into account.
 314          */
 315         public function getVar( $var, $default = null ) {
 316                 $defaults = $this->getGlobalDefaults();
 317                 $internal = $this->getInternalDefaults();
 318                 if ( isset( $defaults[$var] ) ) {
 319                         $default = $defaults[$var];
 320                 } elseif ( isset( $internal[$var] ) ) {
 321                         $default = $internal[$var];
 322                 }
 323                 return $this->parent->getVar( $var, $default );
 324         }
 325
 326         /**
 327          * Convenience alias for $this->parent->setVar()
 328          */
 329         public function setVar( $name, $value ) {
 330                 $this->parent->setVar( $name, $value );
 331         }
 332
 333         /**
 334          * Get a labelled text box to configure a local variable.
 335          */
 336         public function getTextBox( $var, $label, $attribs = array(), $helpData = "" ) {
 337                 $name = $this->getName() . '_' . $var;
 338                 $value = $this->getVar( $var );
 339                 if ( !isset( $attribs ) ) {
 340                         $attribs = array();
 341                 }
 342                 return $this->parent->getTextBox( array(
 343                         'var' => $var,
 344                         'label' => $label,
 345                         'attribs' => $attribs,
 346                         'controlName' => $name,
 347                         'value' => $value,
 348                         'help' => $helpData
 349                 ) );
 350         }
 351
 352         /**
 353          * Get a labelled password box to configure a local variable.
 354          * Implements password hiding.
 355          */
 356         public function getPasswordBox( $var, $label, $attribs = array(), $helpData = "" ) {
 357                 $name = $this->getName() . '_' . $var;
 358                 $value = $this->getVar( $var );
 359                 if ( !isset( $attribs ) ) {
 360                         $attribs = array();
 361                 }
 362                 return $this->parent->getPasswordBox( array(
 363                         'var' => $var,
 364                         'label' => $label,
 365                         'attribs' => $attribs,
 366                         'controlName' => $name,
 367                         'value' => $value,
 368                         'help' => $helpData
 369                 ) );
 370         }
 371
 372         /**
 373          * Get a labelled checkbox to configure a local boolean variable.
 374          */
 375         public function getCheckBox( $var, $label, $attribs = array(), $helpData = "" ) {
 376                 $name = $this->getName() . '_' . $var;
 377                 $value = $this->getVar( $var );
 378                 return $this->parent->getCheckBox( array(
 379                         'var' => $var,
 380                         'label' => $label,
 381                         'attribs' => $attribs,
 382                         'controlName' => $name,
 383                         'value' => $value,
 384                         'help' => $helpData
 385                 ));
 386         }
 387
 388         /**
 389          * Get a set of labelled radio buttons.
 390          *
 391          * @param $params Array:
 392          *    Parameters are:
 393          *      var:            The variable to be configured (required)
 394          *      label:          The message name for the label (required)
 395          *      itemLabelPrefix: The message name prefix for the item labels (required)
 396          *      values:         List of allowed values (required)
 397          *      itemAttribs     Array of attribute arrays, outer key is the value name (optional)
 398          *
 399          */
 400         public function getRadioSet( $params ) {
 401                 $params['controlName'] = $this->getName() . '_' . $params['var'];
 402                 $params['value'] = $this->getVar( $params['var'] );
 403                 return $this->parent->getRadioSet( $params );
 404         }
 405
 406         /**
 407          * Convenience function to set variables based on form data.
 408          * Assumes that variables containing "password" in the name are (potentially
 409          * fake) passwords.
 410          * @param $varNames Array
 411          */
 412         public function setVarsFromRequest( $varNames ) {
 413                 return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
 414         }
 415
 416         /**
 417          * Determine whether an existing installation of MediaWiki is present in
 418          * the configured administrative connection. Returns true if there is
 419          * such a wiki, false if the database doesn't exist.
 420          *
 421          * Traditionally, this is done by testing for the existence of either
 422          * the revision table or the cur table.
 423          *
 424          * @return Boolean
 425          */
 426         public function needsUpgrade() {
 427                 $status = $this->getConnection();
 428                 if ( !$status->isOK() ) {
 429                         return false;
 430                 }
 431
 432                 if ( !$this->db->selectDB( $this->getVar( 'wgDBname' ) ) ) {
 433                         return false;
 434                 }
 435                 return $this->db->tableExists( 'cur' ) || $this->db->tableExists( 'revision' );
 436         }
 437
 438         /**
 439          * Get a standard install-user fieldset.
 440          */
 441         public function getInstallUserBox() {
 442                 return
 443                         Html::openElement( 'fieldset' ) .
 444                         Html::element( 'legend', array(), wfMsg( 'config-db-install-account' ) ) .
 445                         $this->getTextBox( '_InstallUser', 'config-db-username', array(), $this->parent->getHelpBox( 'config-db-install-username' ) ) .
 446                         $this->getPasswordBox( '_InstallPassword', 'config-db-password', array(), $this->parent->getHelpBox( 'config-db-install-password' ) ) .
 447                         Html::closeElement( 'fieldset' );
 448         }
 449
 450         /**
 451          * Submit a standard install user fieldset.
 452          */
 453         public function submitInstallUserBox() {
 454                 $this->setVarsFromRequest( array( '_InstallUser', '_InstallPassword' ) );
 455                 return Status::newGood();
 456         }
 457
 458         /**
 459          * Get a standard web-user fieldset
 460          * @param $noCreateMsg String: Message to display instead of the creation checkbox.
 461          *   Set this to false to show a creation checkbox.
 462          */
 463         public function getWebUserBox( $noCreateMsg = false ) {
 464                 $s = Html::openElement( 'fieldset' ) .
 465                         Html::element( 'legend', array(), wfMsg( 'config-db-web-account' ) ) .
 466                         $this->getCheckBox(
 467                                 '_SameAccount', 'config-db-web-account-same',
 468                                 array( 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' )
 469                         ) .
 470                         Html::openElement( 'div', array( 'id' => 'dbOtherAccount', 'style' => 'display: none;' ) ) .
 471                         $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
 472                         $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
 473                         $this->parent->getHelpBox( 'config-db-web-help' );
 474                 if ( $noCreateMsg ) {
 475                         $s .= $this->parent->getWarningBox( wfMsgNoTrans( $noCreateMsg ) );
 476                 } else {
 477                         $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
 478                 }
 479                 $s .= Html::closeElement( 'div' ) . Html::closeElement( 'fieldset' );
 480                 return $s;
 481         }
 482
 483         /**
 484          * Submit the form from getWebUserBox().
 485          *
 486          * @return Status
 487          */
 488         public function submitWebUserBox() {
 489                 $this->setVarsFromRequest(
 490                         array( 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' )
 491                 );
 492
 493                 if ( $this->getVar( '_SameAccount' ) ) {
 494                         $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
 495                         $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
 496                 }
 497
 498                 return Status::newGood();
 499         }
 500
 501         /**
 502          * Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
 503          */
 504         public function populateInterwikiTable() {
 505                 $status = $this->getConnection();
 506                 if ( !$status->isOK() ) {
 507                         return $status;
 508                 }
 509                 $this->db->selectDB( $this->getVar( 'wgDBname' ) );
 510
 511                 if( $this->db->selectRow( 'interwiki', '*', array(), __METHOD__ ) ) {
 512                         $status->warning( 'config-install-interwiki-exists' );
 513                         return $status;
 514                 }
 515                 global $IP;
 516                 $rows = file( "$IP/maintenance/interwiki.list",
 517                         FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
 518                 $interwikis = array();
 519                 if ( !$rows ) {
 520                         return Status::newFatal( 'config-install-interwiki-sql' );
 521                 }
 522                 foreach( $rows as $row ) {
 523                         $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
 524                         if ( $row == "" ) continue;
 525                         $row .= "||";
 526                         $interwikis[] = array_combine(
 527                                 array( 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ),
 528                                 explode( '|', $row )
 529                         );
 530                 }
 531                 $this->db->insert( 'interwiki', $interwikis, __METHOD__ );
 532                 return Status::newGood();
 533         }
 534
 535         public function outputHandler( $string ) {
 536                 return htmlspecialchars( $string );
 537         }
 538 }