DatabaseInstaller.php

Go to the documentation of this file.

<?php
use MediaWiki\Html\Html;
use Wikimedia\AtEase\AtEase;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\DatabaseDomain;
use Wikimedia\Rdbms\DBConnectionError;
use Wikimedia\Rdbms\DBExpectedError;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\LBFactorySingle;
 
abstract class DatabaseInstaller {
 
    public $parent;
 
    public static $minimumVersion;
 
    protected static $notMinimumVersionMessage;
 
    public $db = null;
 
    protected $internalDefaults = [];
 
    protected $globalNames = [];
 
    public static function meetsMinimumRequirement( $serverVersion ) {
        if ( version_compare( $serverVersion, static::$minimumVersion ) < 0 ) {
            return Status::newFatal(
                static::$notMinimumVersionMessage, static::$minimumVersion, $serverVersion
            );
        }
 
        return Status::newGood();
    }
 
    abstract public function getName();
 
    abstract public function isCompiled();
 
    public function checkPrerequisites() {
        return Status::newGood();
    }
 
    abstract public function getConnectForm();
 
    abstract public function submitConnectForm();
 
    public function getSettingsForm() {
        return false;
    }
 
    public function submitSettingsForm() {
        return Status::newGood();
    }
 
    abstract public function openConnection();
 
    abstract public function setupDatabase();
 
    public function getConnection() {
        if ( $this->db ) {
            return Status::newGood( $this->db );
        }
 
        $status = $this->openConnection();
        if ( $status->isOK() ) {
            $this->db = $status->value;
            // Enable autocommit
            $this->db->clearFlag( DBO_TRX );
            $this->db->commit( __METHOD__ );
        }
 
        return $status;
    }
 
    private function stepApplySourceFile(
        $sourceFileMethod,
        $stepName,
        $tableThatMustNotExist = false
    ) {
        $status = $this->getConnection();
        if ( !$status->isOK() ) {
            return $status;
        }
        $this->selectDatabase( $this->db, $this->getVar( 'wgDBname' ) );
 
        if ( $tableThatMustNotExist && $this->db->tableExists( $tableThatMustNotExist, __METHOD__ ) ) {
            $status->warning( "config-$stepName-tables-exist" );
            $this->enableLB();
 
            return $status;
        }
 
        $this->db->setFlag( DBO_DDLMODE );
        $this->db->begin( __METHOD__ );
 
        $error = $this->db->sourceFile(
            call_user_func( [ $this, $sourceFileMethod ], $this->db )
        );
        if ( $error !== true ) {
            $this->db->reportQueryError( $error, 0, '', __METHOD__ );
            $this->db->rollback( __METHOD__ );
            $status->fatal( "config-$stepName-tables-failed", $error );
        } else {
            $this->db->commit( __METHOD__ );
        }
        // Resume normal operations
        if ( $status->isOK() ) {
            $this->enableLB();
        }
 
        return $status;
    }
 
    public function createTables() {
        return $this->stepApplySourceFile( 'getGeneratedSchemaPath', 'install', 'archive' );
    }
 
    public function createManualTables() {
        return $this->stepApplySourceFile( 'getSchemaPath', 'install-manual' );
    }
 
    public function insertUpdateKeys() {
        return $this->stepApplySourceFile( 'getUpdateKeysPath', 'updates', false );
    }
 
    private function getSqlFilePath( $db, $filename ) {
        global $IP;
 
        $dbmsSpecificFilePath = "$IP/maintenance/" . $db->getType() . "/$filename";
        if ( file_exists( $dbmsSpecificFilePath ) ) {
            return $dbmsSpecificFilePath;
        } else {
            return "$IP/maintenance/$filename";
        }
    }
 
    public function getSchemaPath( $db ) {
        return $this->getSqlFilePath( $db, 'tables.sql' );
    }
 
    public function getGeneratedSchemaPath( $db ) {
        return $this->getSqlFilePath( $db, 'tables-generated.sql' );
    }
 
    public function getUpdateKeysPath( $db ) {
        return $this->getSqlFilePath( $db, 'update-keys.sql' );
    }
 
    public function createExtensionTables() {
        $status = $this->getConnection();
        if ( !$status->isOK() ) {
            return $status;
        }
 
        // Now run updates to create tables for old extensions
        $updater = DatabaseUpdater::newForDB( $this->db );
        $updater->setAutoExtensionHookContainer( $this->parent->getAutoExtensionHookContainer() );
        $updater->doUpdates( [ 'extensions' ] );
 
        return $status;
    }
 
    abstract public function getLocalSettings();
 
    public function getSchemaVars() {
        return [];
    }
 
    public function setupSchemaVars() {
        $status = $this->getConnection();
        if ( $status->isOK() ) {
            // @phan-suppress-next-line PhanUndeclaredMethod
            $status->value->setSchemaVars( $this->getSchemaVars() );
        } else {
            $msg = __METHOD__ . ': unexpected error while establishing'
                . ' a database connection with message: '
                . $status->getMessage()->plain();
            throw new MWException( $msg );
        }
    }
 
    public function enableLB() {
        $status = $this->getConnection();
        if ( !$status->isOK() ) {
            throw new MWException( __METHOD__ . ': unexpected DB connection error' );
        }
        $connection = $status->value;
 
        $this->parent->resetMediaWikiServices( null, [
            'DBLoadBalancerFactory' => static function () use ( $connection ) {
                return LBFactorySingle::newFromConnection( $connection );
            }
        ] );
    }
 
    public function doUpgrade() {
        $this->setupSchemaVars();
        $this->enableLB();
 
        $ret = true;
        ob_start( [ $this, 'outputHandler' ] );
        $up = DatabaseUpdater::newForDB( $this->db );
        try {
            $up->doUpdates();
            $up->purgeCache();
        } catch ( MWException $e ) {
            // TODO: Remove special casing in favour of MWExceptionRenderer
            echo "\nAn error occurred:\n";
            echo $e->getText();
            $ret = false;
        } catch ( Exception $e ) {
            echo "\nAn error occurred:\n";
            echo $e->getMessage();
            $ret = false;
        }
        ob_end_flush();
 
        return $ret;
    }
 
    public function preInstall() {
    }
 
    public function preUpgrade() {
    }
 
    public function getGlobalNames() {
        return $this->globalNames;
    }
 
    public function __construct( $parent ) {
        $this->parent = $parent;
    }
 
    protected static function checkExtension( $name ) {
        return extension_loaded( $name );
    }
 
    public function getReadableName() {
        // Messages: config-type-mysql, config-type-postgres, config-type-sqlite
        return wfMessage( 'config-type-' . $this->getName() )->text();
    }
 
    public function getGlobalDefaults() {
        $defaults = [];
        foreach ( $this->getGlobalNames() as $var ) {
            if ( isset( $GLOBALS[$var] ) ) {
                $defaults[$var] = $GLOBALS[$var];
            }
        }
        return $defaults;
    }
 
    public function getInternalDefaults() {
        return $this->internalDefaults;
    }
 
    public function getVar( $var, $default = null ) {
        $defaults = $this->getGlobalDefaults();
        $internal = $this->getInternalDefaults();
        if ( isset( $defaults[$var] ) ) {
            $default = $defaults[$var];
        } elseif ( isset( $internal[$var] ) ) {
            $default = $internal[$var];
        }
 
        return $this->parent->getVar( $var, $default );
    }
 
    public function setVar( $name, $value ) {
        $this->parent->setVar( $name, $value );
    }
 
    public function getTextBox( $var, $label, $attribs = [], $helpData = "" ) {
        $name = $this->getName() . '_' . $var;
        $value = $this->getVar( $var );
        if ( !isset( $attribs ) ) {
            $attribs = [];
        }
 
        return $this->parent->getTextBox( [
            'var' => $var,
            'label' => $label,
            'attribs' => $attribs,
            'controlName' => $name,
            'value' => $value,
            'help' => $helpData
        ] );
    }
 
    public function getPasswordBox( $var, $label, $attribs = [], $helpData = "" ) {
        $name = $this->getName() . '_' . $var;
        $value = $this->getVar( $var );
        if ( !isset( $attribs ) ) {
            $attribs = [];
        }
 
        return $this->parent->getPasswordBox( [
            'var' => $var,
            'label' => $label,
            'attribs' => $attribs,
            'controlName' => $name,
            'value' => $value,
            'help' => $helpData
        ] );
    }
 
    public function getCheckBox( $var, $label, $attribs = [], $helpData = "" ) {
        $name = $this->getName() . '_' . $var;
        $value = $this->getVar( $var );
 
        return $this->parent->getCheckBox( [
            'var' => $var,
            'label' => $label,
            'attribs' => $attribs,
            'controlName' => $name,
            'value' => $value,
            'help' => $helpData
        ] );
    }
 
    public function getRadioSet( $params ) {
        $params['controlName'] = $this->getName() . '_' . $params['var'];
        $params['value'] = $this->getVar( $params['var'] );
 
        return $this->parent->getRadioSet( $params );
    }
 
    public function setVarsFromRequest( $varNames ) {
        return $this->parent->setVarsFromRequest( $varNames, $this->getName() . '_' );
    }
 
    public function needsUpgrade() {
        $status = $this->getConnection();
        if ( !$status->isOK() ) {
            return false;
        }
 
        try {
            $this->selectDatabase( $this->db, $this->getVar( 'wgDBname' ) );
        } catch ( DBConnectionError $e ) {
            // Don't catch DBConnectionError
            throw $e;
        } catch ( DBExpectedError $e ) {
            return false;
        }
 
        return $this->db->tableExists( 'cur', __METHOD__ ) ||
            $this->db->tableExists( 'revision', __METHOD__ );
    }
 
    public function getInstallUserBox() {
        return Html::openElement( 'fieldset' ) .
            Html::element( 'legend', [], wfMessage( 'config-db-install-account' )->text() ) .
            // @phan-suppress-next-line SecurityCheck-DoubleEscaped taint cannot track the helpbox from the rest
            $this->getTextBox(
                '_InstallUser',
                'config-db-username',
                [ 'dir' => 'ltr' ],
                $this->parent->getHelpBox( 'config-db-install-username' )
            ) .
            // @phan-suppress-next-line SecurityCheck-DoubleEscaped taint cannot track the helpbox from the rest
            $this->getPasswordBox(
                '_InstallPassword',
                'config-db-password',
                [ 'dir' => 'ltr' ],
                $this->parent->getHelpBox( 'config-db-install-password' )
            ) .
            Html::closeElement( 'fieldset' );
    }
 
    public function submitInstallUserBox() {
        $this->setVarsFromRequest( [ '_InstallUser', '_InstallPassword' ] );
 
        return Status::newGood();
    }
 
    public function getWebUserBox( $noCreateMsg = false ) {
        $wrapperStyle = $this->getVar( '_SameAccount' ) ? 'display: none' : '';
        $s = Html::openElement( 'fieldset' ) .
            Html::element( 'legend', [], wfMessage( 'config-db-web-account' )->text() ) .
            $this->getCheckBox(
                '_SameAccount', 'config-db-web-account-same',
                [ 'class' => 'hideShowRadio', 'rel' => 'dbOtherAccount' ]
            ) .
            Html::openElement( 'div', [ 'id' => 'dbOtherAccount', 'style' => $wrapperStyle ] ) .
            $this->getTextBox( 'wgDBuser', 'config-db-username' ) .
            $this->getPasswordBox( 'wgDBpassword', 'config-db-password' ) .
            $this->parent->getHelpBox( 'config-db-web-help' );
        if ( $noCreateMsg ) {
            $s .= Html::warningBox( wfMessage( $noCreateMsg )->plain(), 'config-warning-box' );
        } else {
            $s .= $this->getCheckBox( '_CreateDBAccount', 'config-db-web-create' );
        }
        $s .= Html::closeElement( 'div' ) . Html::closeElement( 'fieldset' );
 
        return $s;
    }
 
    public function submitWebUserBox() {
        $this->setVarsFromRequest(
            [ 'wgDBuser', 'wgDBpassword', '_SameAccount', '_CreateDBAccount' ]
        );
 
        if ( $this->getVar( '_SameAccount' ) ) {
            $this->setVar( 'wgDBuser', $this->getVar( '_InstallUser' ) );
            $this->setVar( 'wgDBpassword', $this->getVar( '_InstallPassword' ) );
        }
 
        if ( $this->getVar( '_CreateDBAccount' ) && strval( $this->getVar( 'wgDBpassword' ) ) == '' ) {
            return Status::newFatal( 'config-db-password-empty', $this->getVar( 'wgDBuser' ) );
        }
 
        return Status::newGood();
    }
 
    public function populateInterwikiTable() {
        $status = $this->getConnection();
        if ( !$status->isOK() ) {
            return $status;
        }
        $this->selectDatabase( $this->db, $this->getVar( 'wgDBname' ) );
 
        if ( $this->db->selectRow( 'interwiki', '1', [], __METHOD__ ) ) {
            $status->warning( 'config-install-interwiki-exists' );
 
            return $status;
        }
        global $IP;
        AtEase::suppressWarnings();
        $rows = file( "$IP/maintenance/interwiki.list",
            FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES );
        AtEase::restoreWarnings();
        $interwikis = [];
        if ( !$rows ) {
            return Status::newFatal( 'config-install-interwiki-list' );
        }
        foreach ( $rows as $row ) {
            $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
            if ( $row == "" ) {
                continue;
            }
            $row .= "|";
            $interwikis[] = array_combine(
                [ 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ],
                explode( '|', $row )
            );
        }
        $this->db->insert( 'interwiki', $interwikis, __METHOD__ );
 
        return Status::newGood();
    }
 
    public function outputHandler( $string ) {
        return htmlspecialchars( $string );
    }
 
    protected function selectDatabase( Database $conn, string $database ) {
        $schema = $conn->dbSchema();
        $prefix = $conn->tablePrefix();
 
        $conn->selectDomain( new DatabaseDomain(
            $database,
            // DatabaseDomain uses null for unspecified schemas
            ( $schema !== '' ) ? $schema : null,
            $prefix
        ) );
 
        return true;
    }
}