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                 } else {
 199                         throw new MWException( __METHOD__.': unexpected DB connection error' );
 200                 }
 201         }
 202
 203         /**
 204          * Set up LBFactory so that wfGetDB() etc. works.
 205          * We set up a special LBFactory instance which returns the current
 206          * installer connection.
 207          */
 208         public function enableLB() {
 209                 $status = $this->getConnection();
 210                 if ( !$status->isOK() ) {
 211                         throw new MWException( __METHOD__.': unexpected DB connection error' );
 212                 }
 213                 LBFactory::setInstance( new LBFactory_Single( array(
 214                         'connection' => $status->value ) ) );
 215         }
 216
 217         /**
 218          * Perform database upgrades
 219          *
 220          * @return Boolean
 221          */
 222         public function doUpgrade() {
 223                 $this->setupSchemaVars();
 224                 $this->enableLB();
 225
 226                 $ret = true;
 227                 ob_start( array( $this, 'outputHandler' ) );
 228                 try {
 229                         $up = DatabaseUpdater::newForDB( $this->db );
 230                         $up->doUpdates();
 231                 } catch ( MWException $e ) {
 232                         echo "\nAn error occured:\n";
 233                         echo $e->getText();
 234                         $ret = false;
 235                 }
 236                 ob_end_flush();
 237                 return $ret;
 238         }
 239
 240         /**
 241          * Allow DB installers a chance to make last-minute changes before installation
 242          * occurs. This happens before setupDatabase() or createTables() is called, but
 243          * long after the constructor. Helpful for things like modifying setup steps :)
 244          */
 245         public function preInstall() {
 246
 247         }
 248
 249         /**
 250          * Allow DB installers a chance to make checks before upgrade.
 251          */
 252         public function preUpgrade() {
 253
 254         }
 255
 256         /**
 257          * Get an array of MW configuration globals that will be configured by this class.
 258          */
 259         public function getGlobalNames() {
 260                 return $this->globalNames;
 261         }
 262
 263         /**
 264          * Construct and initialise parent.
 265          * This is typically only called from Installer::getDBInstaller()
 266          */
 267         public function __construct( $parent ) {
 268                 $this->parent = $parent;
 269         }
 270
 271         /**
 272          * Convenience function.
 273          * Check if a named extension is present.
 274          *
 275          * @see wfDl
 276          */
 277         protected static function checkExtension( $name ) {
 278                 wfSuppressWarnings();
 279                 $compiled = wfDl( $name );
 280                 wfRestoreWarnings();
 281                 return $compiled;
 282         }
 283
 284         /**
 285          * Get the internationalised name for this DBMS.
 286          */
 287         public function getReadableName() {
 288                 return wfMsg( 'config-type-' . $this->getName() );
 289         }
 290
 291         /**
 292          * Get a name=>value map of MW configuration globals that overrides.
 293          * DefaultSettings.php
 294          */
 295         public function getGlobalDefaults() {
 296                 return array();
 297         }
 298
 299         /**
 300          * Get a name=>value map of internal variables used during installation.
 301          */
 302         public function getInternalDefaults() {
 303                 return $this->internalDefaults;
 304         }
 305
 306         /**
 307          * Get a variable, taking local defaults into account.
 308          */
 309         public function getVar( $var, $default = null ) {
 310                 $defaults = $this->getGlobalDefaults();
 311                 $internal = $this->getInternalDefaults();
 312                 if ( isset( $defaults[$var] ) ) {
 313                         $default = $defaults[$var];
 314                 } elseif ( isset( $internal[$var] ) ) {
 315                         $default = $internal[$var];
 316                 }
 317                 return $this->parent->getVar( $var, $default );
 318         }
 319
 320         /**
 321          * Convenience alias for $this->parent->setVar()
 322          */
 323         public function setVar( $name, $value ) {
 324                 $this->parent->setVar( $name, $value );
 325         }
 326
 327         /**
 328          * Get a labelled text box to configure a local variable.
 329          */
 330         public function getTextBox( $var, $label, $attribs = array(), $helpData = "" ) {
 331                 $name = $this->getName() . '_' . $var;
 332                 $value = $this->getVar( $var );
 333                 if ( !isset( $attribs ) ) {
 334                         $attribs = array();
 335                 }
 336                 return $this->parent->getTextBox( array(
 337                         'var' => $var,
 338                         'label' => $label,
 339                         'attribs' => $attribs,
 340                         'controlName' => $name,
 341                         'value' => $value,
 342                         'help' => $helpData
 343                 ) );
 344         }
 345
 346         /**
 347          * Get a labelled password box to configure a local variable.
 348          * Implements password hiding.
 349          */
 350         public function getPasswordBox( $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->getPasswordBox( 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 checkbox to configure a local boolean variable.
 368          */
 369         public function getCheckBox( $var, $label, $attribs = array(), $helpData = "" ) {
 370                 $name = $this->getName() . '_' . $var;
 371                 $value = $this->getVar( $var );
 372                 return $this->parent->getCheckBox( array(
 373                         'var' => $var,
 374                         'label' => $label,
 375                         'attribs' => $attribs,
 376                         'controlName' => $name,
 377                         'value' => $value,
 378                         'help' => $helpData
 379                 ));
 380         }
 381
 382         /**
 383          * Get a set of labelled radio buttons.
 384          *
 385          * @param $params Array:
 386          *    Parameters are:
 387          *      var:            The variable to be configured (required)
 388          *      label:          The message name for the label (required)
 389          *      itemLabelPrefix: The message name prefix for the item labels (required)
 390          *      values:         List of allowed values (required)
 391          *      itemAttribs     Array of attribute arrays, outer key is the value name (optional)
 392          *
 393          */
 394         public function getRadioSet( $params ) {
 395                 $params['controlName'] = $this->getName() . '_' . $params['var'];
 396                 $params['value'] = $this->getVar( $params['var'] );
 397                 return $this->parent->getRadioSet( $params );
 398         }
 399
 400         /**
 401          * Convenience function to set variables based on form data.
 402          * Assumes that variables containing "password" in the name are (potentially
 403          * fake) passwords.
 404          * @param $varNames Array
 405          */
 406         public function setVarsFromRequest( $varNames ) {
 407                 return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
 408         }
 409
 410         /**
 411          * Determine whether an existing installation of MediaWiki is present in
 412          * the configured administrative connection. Returns true if there is
 413          * such a wiki, false if the database doesn't exist.
 414          *
 415          * Traditionally, this is done by testing for the existence of either
 416          * the revision table or the cur table.
 417          *
 418          * @return Boolean
 419          */
 420         public function needsUpgrade() {
 421                 $status = $this->getConnection();
 422                 if ( !$status->isOK() ) {
 423                         return false;
 424                 }
 425
 426                 if ( !$this->db->selectDB( $this->getVar( 'wgDBname' ) ) ) {
 427                         return false;
 428                 }
 429                 return $this->db->tableExists( 'cur' ) || $this->db->tableExists( 'revision' );
 430         }
 431
 432         /**
 433          * Get a standard install-user fieldset.
 434          */
 435         public function getInstallUserBox() {
 436                 return
 437                         Html::openElement( 'fieldset' ) .
 438                         Html::element( 'legend', array(), wfMsg( 'config-db-install-account' ) ) .
 439                         $this->getTextBox( '_InstallUser', 'config-db-username', array(), $this->parent->getHelpBox( 'config-db-install-username' ) ) .
 440                         $this->getPasswordBox( '_InstallPassword', 'config-db-password', array(), $this->parent->getHelpBox( 'config-db-install-password' ) ) .
 441                         Html::closeElement( 'fieldset' );
 442         }
 443
 444         /**
 445          * Submit a standard install user fieldset.
 446          */
 447         public function submitInstallUserBox() {
 448                 $this->setVarsFromRequest( array( '_InstallUser', '_InstallPassword' ) );
 449                 return Status::newGood();
 450         }
 451
 452         /**
 453          * Get a standard web-user fieldset
 454          * @param $noCreateMsg String: Message to display instead of the creation checkbox.
 455          *   Set this to false to show a creation checkbox.
 456          */
 457         public function getWebUserBox( $noCreateMsg = false ) {
 458                 $s = Html::openElement( 'fieldset' ) .
 459                         Html::element( 'legend', array(), wfMsg( 'config-db-web-account' ) ) .
 460                         $this->getCheckBox(
 461                                 '_SameAccount', 'config-db-web-account-same',
 462                                 array( 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' )
 463                         ) .
 464                         Html::openElement( 'div', array( 'id' => 'dbOtherAccount', 'style' => 'display: none;' ) ) .
 465                         $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
 466                         $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
 467                         $this->parent->getHelpBox( 'config-db-web-help' );
 468                 if ( $noCreateMsg ) {
 469                         $s .= $this->parent->getWarningBox( wfMsgNoTrans( $noCreateMsg ) );
 470                 } else {
 471                         $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
 472                 }
 473                 $s .= Html::closeElement( 'div' ) . Html::closeElement( 'fieldset' );
 474                 return $s;
 475         }
 476
 477         /**
 478          * Submit the form from getWebUserBox().
 479          *
 480          * @return Status
 481          */
 482         public function submitWebUserBox() {
 483                 $this->setVarsFromRequest(
 484                         array( 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' )
 485                 );
 486
 487                 if ( $this->getVar( '_SameAccount' ) ) {
 488                         $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
 489                         $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
 490                 }
 491
 492                 return Status::newGood();
 493         }
 494
 495         /**
 496          * Common function for databases that don't understand the MySQLish syntax of interwiki.sql.
 497          */
 498         public function populateInterwikiTable() {
 499                 $status = $this->getConnection();
 500                 if ( !$status->isOK() ) {
 501                         return $status;
 502                 }
 503                 $this->db->selectDB( $this->getVar( 'wgDBname' ) );
 504
 505                 if( $this->db->selectRow( 'interwiki', '*', array(), __METHOD__ ) ) {
 506                         $status->warning( 'config-install-interwiki-exists' );
 507                         return $status;
 508                 }
 509                 global $IP;
 510                 $rows = file( "$IP/maintenance/interwiki.list",
 511                         FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
 512                 $interwikis = array();
 513                 if ( !$rows ) {
 514                         return Status::newFatal( 'config-install-interwiki-sql' );
 515                 }
 516                 foreach( $rows as $row ) {
 517                         $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
 518                         if ( $row == "" ) continue;
 519                         $row .= "||";
 520                         $interwikis[] = array_combine(
 521                                 array( 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ),
 522                                 explode( '|', $row )
 523                         );
 524                 }
 525                 $this->db->insert( 'interwiki', $interwikis, __METHOD__ );
 526                 return Status::newGood();
 527         }
 528
 529         public function outputHandler( $string ) {
 530                 return htmlspecialchars( $string );
 531         }
 532 }