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 WebInstaller
  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 Status
 123          */
 124         public function getConnection() {
 125                 if ( $this->db ) {
 126                         return Status::newGood( $this->db );
 127                 }
 128
 129                 $status = $this->openConnection();
 130                 if ( $status->isOK() ) {
 131                         $this->db = $status->value;
 132                         // Enable autocommit
 133                         $this->db->clearFlag( DBO_TRX );
 134                         $this->db->commit();
 135                 }
 136                 return $status;
 137         }
 138
 139         /**
 140          * Create database tables from scratch.
 141          *
 142          * @return Status
 143          */
 144         public function createTables() {
 145                 $status = $this->getConnection();
 146                 if ( !$status->isOK() ) {
 147                         return $status;
 148                 }
 149                 $this->db->selectDB( $this->getVar( 'wgDBname' ) );
 150
 151                 if( $this->db->tableExists( 'user' ) ) {
 152                         $status->warning( 'config-install-tables-exist' );
 153                         $this->enableLB();
 154                         return $status;
 155                 }
 156
 157                 $this->db->setFlag( DBO_DDLMODE ); // For Oracle's handling of schema files
 158                 $this->db->begin( __METHOD__ );
 159
 160                 $error = $this->db->sourceFile( $this->db->getSchemaPath() );
 161                 if( $error !== true ) {
 162                         $this->db->reportQueryError( $error, 0, '', __METHOD__ );
 163                         $this->db->rollback( __METHOD__ );
 164                         $status->fatal( 'config-install-tables-failed', $error );
 165                 } else {
 166                         $this->db->commit( __METHOD__ );
 167                 }
 168                 // Resume normal operations
 169                 if( $status->isOk() ) {
 170                         $this->enableLB();
 171                 }
 172                 return $status;
 173         }
 174
 175         /**
 176          * Create the tables for each extension the user enabled
 177          * @return Status
 178          */
 179         public function createExtensionTables() {
 180                 $status = $this->getConnection();
 181                 if ( !$status->isOK() ) {
 182                         return $status;
 183                 }
 184
 185                 // Now run updates to create tables for old extensions
 186                 DatabaseUpdater::newForDB( $this->db )->doUpdates( array( 'extensions' ) );
 187
 188                 return $status;
 189         }
 190
 191         /**
 192          * Get the DBMS-specific options for LocalSettings.php generation.
 193          *
 194          * @return String
 195          */
 196         public abstract function getLocalSettings();
 197
 198         /**
 199          * Override this to provide DBMS-specific schema variables, to be
 200          * substituted into tables.sql and other schema files.
 201          */
 202         public function getSchemaVars() {
 203                 return array();
 204         }
 205
 206         /**
 207          * Set appropriate schema variables in the current database connection.
 208          *
 209          * This should be called after any request data has been imported, but before
 210          * any write operations to the database.
 211          */
 212         public function setupSchemaVars() {
 213                 $status = $this->getConnection();
 214                 if ( $status->isOK() ) {
 215                         $status->value->setSchemaVars( $this->getSchemaVars() );
 216                 } else {
 217                         throw new MWException( __METHOD__.': unexpected DB connection error' );
 218                 }
 219         }
 220
 221         /**
 222          * Set up LBFactory so that wfGetDB() etc. works.
 223          * We set up a special LBFactory instance which returns the current
 224          * installer connection.
 225          */
 226         public function enableLB() {
 227                 $status = $this->getConnection();
 228                 if ( !$status->isOK() ) {
 229                         throw new MWException( __METHOD__.': unexpected DB connection error' );
 230                 }
 231                 LBFactory::setInstance( new LBFactory_Single( array(
 232                         'connection' => $status->value ) ) );
 233         }
 234
 235         /**
 236          * Perform database upgrades
 237          *
 238          * @return Boolean
 239          */
 240         public function doUpgrade() {
 241                 $this->setupSchemaVars();
 242                 $this->enableLB();
 243
 244                 $ret = true;
 245                 ob_start( array( $this, 'outputHandler' ) );
 246                 try {
 247                         $up = DatabaseUpdater::newForDB( $this->db );
 248                         $up->doUpdates();
 249                 } catch ( MWException $e ) {
 250                         echo "\nAn error occured:\n";
 251                         echo $e->getText();
 252                         $ret = false;
 253                 }
 254                 ob_end_flush();
 255                 return $ret;
 256         }
 257
 258         /**
 259          * Allow DB installers a chance to make last-minute changes before installation
 260          * occurs. This happens before setupDatabase() or createTables() is called, but
 261          * long after the constructor. Helpful for things like modifying setup steps :)
 262          */
 263         public function preInstall() {
 264
 265         }
 266
 267         /**
 268          * Allow DB installers a chance to make checks before upgrade.
 269          */
 270         public function preUpgrade() {
 271
 272         }
 273
 274         /**
 275          * Get an array of MW configuration globals that will be configured by this class.
 276          */
 277         public function getGlobalNames() {
 278                 return $this->globalNames;
 279         }
 280
 281         /**
 282          * Construct and initialise parent.
 283          * This is typically only called from Installer::getDBInstaller()
 284          */
 285         public function __construct( $parent ) {
 286                 $this->parent = $parent;
 287         }
 288
 289         /**
 290          * Convenience function.
 291          * Check if a named extension is present.
 292          *
 293          * @see wfDl
 294          */
 295         protected static function checkExtension( $name ) {
 296                 wfSuppressWarnings();
 297                 $compiled = wfDl( $name );
 298                 wfRestoreWarnings();
 299                 return $compiled;
 300         }
 301
 302         /**
 303          * Get the internationalised name for this DBMS.
 304          */
 305         public function getReadableName() {
 306                 return wfMsg( 'config-type-' . $this->getName() );
 307         }
 308
 309         /**
 310          * Get a name=>value map of MW configuration globals that overrides.
 311          * DefaultSettings.php
 312          */
 313         public function getGlobalDefaults() {
 314                 return array();
 315         }
 316
 317         /**
 318          * Get a name=>value map of internal variables used during installation.
 319          */
 320         public function getInternalDefaults() {
 321                 return $this->internalDefaults;
 322         }
 323
 324         /**
 325          * Get a variable, taking local defaults into account.
 326          */
 327         public function getVar( $var, $default = null ) {
 328                 $defaults = $this->getGlobalDefaults();
 329                 $internal = $this->getInternalDefaults();
 330                 if ( isset( $defaults[$var] ) ) {
 331                         $default = $defaults[$var];
 332                 } elseif ( isset( $internal[$var] ) ) {
 333                         $default = $internal[$var];
 334                 }
 335                 return $this->parent->getVar( $var, $default );
 336         }
 337
 338         /**
 339          * Convenience alias for $this->parent->setVar()
 340          */
 341         public function setVar( $name, $value ) {
 342                 $this->parent->setVar( $name, $value );
 343         }
 344
 345         /**
 346          * Get a labelled text box to configure a local variable.
 347          *
 348          * @return string
 349          */
 350         public function getTextBox( $var, $label, $attribs = array(), $helpData = "" ) {
 351                 $name = $this->getName() . '_' . $var;
 352                 $value = $this->getVar( $var );
 353                 if ( !isset( $attribs ) ) {
 354                         $attribs = array();
 355                 }
 356                 return $this->parent->getTextBox( array(
 357                         'var' => $var,
 358                         'label' => $label,
 359                         'attribs' => $attribs,
 360                         'controlName' => $name,
 361                         'value' => $value,
 362                         'help' => $helpData
 363                 ) );
 364         }
 365
 366         /**
 367          * Get a labelled password box to configure a local variable.
 368          * Implements password hiding.
 369          *
 370          * @return string
 371          */
 372         public function getPasswordBox( $var, $label, $attribs = array(), $helpData = "" ) {
 373                 $name = $this->getName() . '_' . $var;
 374                 $value = $this->getVar( $var );
 375                 if ( !isset( $attribs ) ) {
 376                         $attribs = array();
 377                 }
 378                 return $this->parent->getPasswordBox( 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 labelled checkbox to configure a local boolean variable.
 390          *
 391          * @return string
 392          */
 393         public function getCheckBox( $var, $label, $attribs = array(), $helpData = "" ) {
 394                 $name = $this->getName() . '_' . $var;
 395                 $value = $this->getVar( $var );
 396                 return $this->parent->getCheckBox( array(
 397                         'var' => $var,
 398                         'label' => $label,
 399                         'attribs' => $attribs,
 400                         'controlName' => $name,
 401                         'value' => $value,
 402                         'help' => $helpData
 403                 ));
 404         }
 405
 406         /**
 407          * Get a set of labelled radio buttons.
 408          *
 409          * @param $params Array:
 410          *    Parameters are:
 411          *      var:            The variable to be configured (required)
 412          *      label:          The message name for the label (required)
 413          *      itemLabelPrefix: The message name prefix for the item labels (required)
 414          *      values:         List of allowed values (required)
 415          *      itemAttribs     Array of attribute arrays, outer key is the value name (optional)
 416          *
 417          */
 418         public function getRadioSet( $params ) {
 419                 $params['controlName'] = $this->getName() . '_' . $params['var'];
 420                 $params['value'] = $this->getVar( $params['var'] );
 421                 return $this->parent->getRadioSet( $params );
 422         }
 423
 424         /**
 425          * Convenience function to set variables based on form data.
 426          * Assumes that variables containing "password" in the name are (potentially
 427          * fake) passwords.
 428          * @param $varNames Array
 429          */
 430         public function setVarsFromRequest( $varNames ) {
 431                 return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
 432         }
 433
 434         /**
 435          * Determine whether an existing installation of MediaWiki is present in
 436          * the configured administrative connection. Returns true if there is
 437          * such a wiki, false if the database doesn't exist.
 438          *
 439          * Traditionally, this is done by testing for the existence of either
 440          * the revision table or the cur table.
 441          *
 442          * @return Boolean
 443          */
 444         public function needsUpgrade() {
 445                 $status = $this->getConnection();
 446                 if ( !$status->isOK() ) {
 447                         return false;
 448                 }
 449
 450                 if ( !$this->db->selectDB( $this->getVar( 'wgDBname' ) ) ) {
 451                         return false;
 452                 }
 453                 return $this->db->tableExists( 'cur' ) || $this->db->tableExists( 'revision' );
 454         }
 455
 456         /**
 457          * Get a standard install-user fieldset.
 458          *
 459          * @return String
 460          */
 461         public function getInstallUserBox() {
 462                 return
 463                         Html::openElement( 'fieldset' ) .
 464                         Html::element( 'legend', array(), wfMsg( 'config-db-install-account' ) ) .
 465                         $this->getTextBox( '_InstallUser', 'config-db-username', array(), $this->parent->getHelpBox( 'config-db-install-username' ) ) .
 466                         $this->getPasswordBox( '_InstallPassword', 'config-db-password', array(), $this->parent->getHelpBox( 'config-db-install-password' ) ) .
 467                         Html::closeElement( 'fieldset' );
 468         }
 469
 470         /**
 471          * Submit a standard install user fieldset.
 472          */
 473         public function submitInstallUserBox() {
 474                 $this->setVarsFromRequest( array( '_InstallUser', '_InstallPassword' ) );
 475                 return Status::newGood();
 476         }
 477
 478         /**
 479          * Get a standard web-user fieldset
 480          * @param $noCreateMsg String: Message to display instead of the creation checkbox.
 481          *   Set this to false to show a creation checkbox.
 482          *
 483          * @return String
 484          */
 485         public function getWebUserBox( $noCreateMsg = false ) {
 486                 $wrapperStyle = $this->getVar( '_SameAccount' ) ? 'display: none' : '';
 487                 $s = Html::openElement( 'fieldset' ) .
 488                         Html::element( 'legend', array(), wfMsg( 'config-db-web-account' ) ) .
 489                         $this->getCheckBox(
 490                                 '_SameAccount', 'config-db-web-account-same',
 491                                 array( 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' )
 492                         ) .
 493                         Html::openElement( 'div', array( 'id' => 'dbOtherAccount', 'style' => $wrapperStyle ) ) .
 494                         $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
 495                         $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
 496                         $this->parent->getHelpBox( 'config-db-web-help' );
 497                 if ( $noCreateMsg ) {
 498                         $s .= $this->parent->getWarningBox( wfMsgNoTrans( $noCreateMsg ) );
 499                 } else {
 500                         $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
 501                 }
 502                 $s .= Html::closeElement( 'div' ) . Html::closeElement( 'fieldset' );
 503                 return $s;
 504         }
 505
 506         /**
 507          * Submit the form from getWebUserBox().
 508          *
 509          * @return Status
 510          */
 511         public function submitWebUserBox() {
 512                 $this->setVarsFromRequest(
 513                         array( 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' )
 514                 );
 515
 516                 if ( $this->getVar( '_SameAccount' ) ) {
 517                         $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
 518                         $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
 519                 }
 520
 521                 if( $this->getVar( '_CreateDBAccount' ) && strval( $this->getVar( 'wgDBpassword' ) ) == '' ) {
 522                         return Status::newFatal( 'config-db-password-empty', $this->getVar( 'wgDBuser' ) );
 523                 }
 524
 525                 return Status::newGood();
 526         }
 527
 528         /**
 529          * Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
 530          *
 531          * @return Status
 532          */
 533         public function populateInterwikiTable() {
 534                 $status = $this->getConnection();
 535                 if ( !$status->isOK() ) {
 536                         return $status;
 537                 }
 538                 $this->db->selectDB( $this->getVar( 'wgDBname' ) );
 539
 540                 if( $this->db->selectRow( 'interwiki', '*', array(), __METHOD__ ) ) {
 541                         $status->warning( 'config-install-interwiki-exists' );
 542                         return $status;
 543                 }
 544                 global $IP;
 545                 wfSuppressWarnings();
 546                 $rows = file( "$IP/maintenance/interwiki.list",
 547                         FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
 548                 wfRestoreWarnings();
 549                 $interwikis = array();
 550                 if ( !$rows ) {
 551                         return Status::newFatal( 'config-install-interwiki-list' );
 552                 }
 553                 foreach( $rows as $row ) {
 554                         $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
 555                         if ( $row == "" ) continue;
 556                         $row .= "||";
 557                         $interwikis[] = array_combine(
 558                                 array( 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ),
 559                                 explode( '|', $row )
 560                         );
 561                 }
 562                 $this->db->insert( 'interwiki', $interwikis, __METHOD__ );
 563                 return Status::newGood();
 564         }
 565
 566         public function outputHandler( $string ) {
 567                 return htmlspecialchars( $string );
 568         }
 569 }