DatabaseInstaller.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Installer;
 
use MediaWiki\Installer\Task\ITaskContext;
use MediaWiki\Status\Status;
use RuntimeException;
use Wikimedia\Rdbms\DatabaseDomain;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\IMaintainableDatabase;
 
abstract class DatabaseInstaller implements ITaskContext {
 
    public $parent;
 
    public static $minimumVersion;
 
    protected static $notMinimumVersionMessage;
 
    public $db = null;
 
    private $cachedConn;
    private $cachedConnType;
 
    protected $internalDefaults = [];
 
    protected $globalNames = [];
 
    private $provisions = [];
 
    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 );
 
    public function getConnection( $type = self::CONN_DONT_KNOW ): ConnectionStatus {
        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 ): IMaintainableDatabase {
        $status = $this->getConnection( $type );
        if ( !$status->isOK() ) {
            throw new RuntimeException( __METHOD__ . ': unexpected DB connection error' );
        }
        return $status->getDB();
    }
 
    protected function changeConnType( IMaintainableDatabase $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( IMaintainableDatabase $conn ) {
        return new ConnectionStatus( $conn );
    }
 
    public function getDbType(): string {
        return $this->getName();
    }
 
    public function getConfigVar( string $name ) {
        return $this->getVar( "wg$name" );
    }
 
    public function getOption( string $name ) {
        return $this->getVar( "_$name" );
    }
 
    public function provide( string $name, $value ) {
        $this->provisions[$name] = $value;
    }
 
    public function getProvision( string $name ) {
        if ( isset( $this->provisions[$name] ) ) {
            return $this->provisions[$name];
        } else {
            throw new \RuntimeException( "Can't find provided data \"$name\"" );
        }
    }
 
    abstract public function getLocalSettings();
 
    public function getSchemaVars() {
        return [];
    }
 
    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__ );
    }
 
}