includes/installer/DatabaseInstaller.php

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