DatabaseInstaller.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Installer;
 
use MediaWiki\Status\Status;
use RuntimeException;
use Wikimedia\AtEase\AtEase;
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\DatabaseDomain;
use Wikimedia\Rdbms\DBQueryError;
use Wikimedia\Rdbms\IDatabase;
 
abstract class DatabaseInstaller {
    public const CONN_CREATE_DATABASE = 'create-database';
 
    public const CONN_CREATE_SCHEMA = 'create-schema';
 
    public const CONN_CREATE_TABLES = 'create-tables';
 
    public const CONN_DONT_KNOW = 'dont-know';
 
    public $parent;
 
    public static $minimumVersion;
 
    protected static $notMinimumVersionMessage;
 
    public $db = null;
 
    private $cachedConn;
    private $cachedConnType;
 
    protected $internalDefaults = [];
 
    protected $globalNames = [];
 
    public static function meetsMinimumRequirement( IDatabase $conn ) {
        $serverVersion = $conn->getServerVersion();
        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 protected function openConnection( string $type );
 
    abstract public function setupDatabase();
 
    public function getConnection( $type = self::CONN_DONT_KNOW ) {
        if ( $type === self::CONN_DONT_KNOW ) {
            if ( $this->cachedConnType ) {
                $type = $this->cachedConnType;
            } else {
                $type = self::CONN_CREATE_DATABASE;
            }
        }
        if ( $this->cachedConn ) {
            if ( $this->cachedConnType === $type ) {
                return new ConnectionStatus( $this->cachedConn );
            } else {
                return $this->changeConnType( $this->cachedConn, $this->cachedConnType, $type );
            }
        }
        $status = $this->openConnection( $type );
        if ( $status->isOK() ) {
            $this->cachedConn = $status->getDB();
            $this->cachedConnType = $type;
            // Assign to $this->db for b/c
            $this->db = $this->cachedConn;
 
            if ( $type === self::CONN_CREATE_SCHEMA || $type === self::CONN_CREATE_TABLES ) {
                $this->cachedConn->setSchemaVars( $this->getSchemaVars() );
            }
        }
 
        return $status;
    }
 
    public function definitelyGetConnection( string $type ): Database {
        $status = $this->getConnection( $type );
        if ( !$status->isOK() ) {
            throw new RuntimeException( __METHOD__ . ': unexpected DB connection error' );
        }
        return $status->getDB();
    }
 
    protected function changeConnType( Database $conn, &$storedType, $newType ) {
        // Change type from database to schema, if requested
        if ( $storedType === self::CONN_CREATE_DATABASE ) {
            if ( $newType === self::CONN_CREATE_SCHEMA || $newType === self::CONN_CREATE_TABLES ) {
                // TODO: catch exceptions from selectDomain and report as a Status
                $conn->selectDomain( new DatabaseDomain(
                    $this->getVar( 'wgDBname' ),
                    $this->getVar( 'wgDBmwschema' ),
                    $this->getVar( 'wgDBprefix' ) ?? ''
                ) );
                $conn->setSchemaVars( $this->getSchemaVars() );
                $storedType = self::CONN_CREATE_SCHEMA;
            }
        }
        // Change type from schema to tables, if requested
        if ( $newType === self::CONN_CREATE_TABLES && $storedType === self::CONN_CREATE_SCHEMA ) {
            $status = $this->changeConnTypeFromSchemaToTables( $conn );
            if ( $status->isOK() ) {
                $storedType = self::CONN_CREATE_TABLES;
            }
            return $status;
        }
        return new ConnectionStatus( $conn );
    }
 
    protected function changeConnTypeFromSchemaToTables( Database $conn ) {
        return new ConnectionStatus( $conn );
    }
 
    private function applySourceFile( $conn, $sqlFile ) {
        $status = Status::newGood();
        try {
            $conn->doAtomicSection( __METHOD__,
                static function ( $conn ) use ( $sqlFile ) {
                    $conn->sourceFile( $sqlFile );
                },
                IDatabase::ATOMIC_CANCELABLE
            );
        } catch ( DBQueryError $e ) {
            $status->fatal( "config-install-tables-failed", $e->getMessage() );
        }
        return $status;
    }
 
    public function createTables() {
        $status = $this->getConnection( self::CONN_CREATE_TABLES );
        if ( !$status->isOK() ) {
            return $status;
        }
        $conn = $status->getDB();
        if ( $conn->tableExists( 'archive', __METHOD__ ) ) {
            $status->warning( "config-install-tables-exist" );
            return $status;
        }
        $status = $this->applySourceFile( $conn,
            $this->getSqlFilePath( 'tables-generated.sql' ) );
        if ( !$status->isOK() ) {
            return $status;
        }
        $status->merge( $this->applySourceFile( $conn,
            $this->getSqlFilePath( 'tables.sql' ) ) );
        return $status;
    }
 
    public function insertUpdateKeys() {
        $updater = DatabaseUpdater::newForDB(
            $this->definitelyGetConnection( self::CONN_CREATE_TABLES ) );
        $updater->insertInitialUpdateKeys();
        return Status::newGood();
    }
 
    private function getSqlFilePath( string $filename ) {
        global $IP;
 
        $dbmsSpecificFilePath = "$IP/maintenance/" . $this->getName() . "/$filename";
        if ( file_exists( $dbmsSpecificFilePath ) ) {
            return $dbmsSpecificFilePath;
        } else {
            return "$IP/maintenance/$filename";
        }
    }
 
    public function createExtensionTables() {
        $status = $this->getConnection( self::CONN_CREATE_TABLES );
        if ( !$status->isOK() ) {
            return $status;
        }
 
        // Now run updates to create tables for old extensions
        $updater = DatabaseUpdater::newForDB( $status->getDB() );
        $updater->setAutoExtensionHookContainer( $this->parent->getAutoExtensionHookContainer() );
        $updater->doUpdates( [ 'extensions' ] );
 
        return $status;
    }
 
    abstract public function getLocalSettings();
 
    public function getSchemaVars() {
        return [];
    }
 
    public function enableLB() {
    }
 
    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 );
    }
 
    abstract public function getConnectForm( WebInstaller $webInstaller ): DatabaseConnectForm;
 
    abstract public function getSettingsForm( WebInstaller $webInstaller ): DatabaseSettingsForm;
 
    public function needsUpgrade() {
        $status = $this->getConnection( self::CONN_CREATE_SCHEMA );
        if ( !$status->isOK() ) {
            return false;
        }
        $db = $status->getDB();
        return $db->tableExists( 'cur', __METHOD__ ) ||
            $db->tableExists( 'revision', __METHOD__ );
    }
 
    public function populateInterwikiTable() {
        $status = $this->getConnection( self::CONN_CREATE_TABLES );
        if ( !$status->isOK() ) {
            return $status;
        }
        $conn = $status->getDB();
 
        $row = $conn->newSelectQueryBuilder()
            ->select( '1' )
            ->from( 'interwiki' )
            ->caller( __METHOD__ )->fetchRow();
        if ( $row ) {
            $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();
        if ( !$rows ) {
            return Status::newFatal( 'config-install-interwiki-list' );
        }
        $insert = $conn->newInsertQueryBuilder()
            ->insertInto( 'interwiki' );
        foreach ( $rows as $row ) {
            $row = preg_replace( '/^\s*([^#]*?)\s*(#.*)?$/', '\\1', $row ); // strip comments - whee
            if ( $row == "" ) {
                continue;
            }
            $row .= "|";
            $insert->row(
                array_combine(
                    [ 'iw_prefix', 'iw_url', 'iw_local', 'iw_api', 'iw_wikiid' ],
                    explode( '|', $row )
                )
            );
        }
        $insert->caller( __METHOD__ )->execute();
 
        return Status::newGood();
    }
 
    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;
    }
}