MysqlInstaller.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Installer;
 
use Wikimedia\Rdbms\DatabaseFactory;
use Wikimedia\Rdbms\DatabaseMySQL;
use Wikimedia\Rdbms\DBConnectionError;
use Wikimedia\Rdbms\IDatabase;
 
class MysqlInstaller extends DatabaseInstaller {
 
    protected $globalNames = [
        'wgDBserver',
        'wgDBname',
        'wgDBuser',
        'wgDBpassword',
        'wgDBssl',
        'wgDBprefix',
        'wgDBTableOptions',
    ];
 
    protected $internalDefaults = [
        '_MysqlEngine' => 'InnoDB',
        '_MysqlCharset' => 'binary',
        '_InstallUser' => 'root',
    ];
 
    public $supportedEngines = [ 'InnoDB' ];
 
    private const MIN_VERSIONS = [
        'MySQL' => '5.7.0',
        'MariaDB' => '10.3',
    ];
    public static $minimumVersion;
    protected static $notMinimumVersionMessage;
 
    public $webUserPrivs = [
        'DELETE',
        'INSERT',
        'SELECT',
        'UPDATE',
        'CREATE TEMPORARY TABLES',
    ];
 
    public function getName() {
        return 'mysql';
    }
 
    public function isCompiled() {
        return self::checkExtension( 'mysqli' );
    }
 
    public function getConnectForm( WebInstaller $webInstaller ): DatabaseConnectForm {
        return new MysqlConnectForm( $webInstaller, $this );
    }
 
    public function getSettingsForm( WebInstaller $webInstaller ): DatabaseSettingsForm {
        return new MysqlSettingsForm( $webInstaller, $this );
    }
 
    public static function meetsMinimumRequirement( IDatabase $conn ) {
        $type = str_contains( $conn->getSoftwareLink(), 'MariaDB' ) ? 'MariaDB' : 'MySQL';
        self::$minimumVersion = self::MIN_VERSIONS[$type];
        // Used messages: config-mysql-old, config-mariadb-old
        self::$notMinimumVersionMessage = 'config-' . strtolower( $type ) . '-old';
        return parent::meetsMinimumRequirement( $conn );
    }
 
    protected function openConnection( string $type ) {
        $status = new ConnectionStatus;
        $dbName = $type === DatabaseInstaller::CONN_CREATE_DATABASE
            ? null : $this->getVar( 'wgDBname' );
        try {
            $db = ( new DatabaseFactory() )->create( 'mysql', [
                'host' => $this->getVar( 'wgDBserver' ),
                'user' => $this->getVar( '_InstallUser' ),
                'password' => $this->getVar( '_InstallPassword' ),
                'ssl' => $this->getVar( 'wgDBssl' ),
                'dbname' => $dbName,
                'flags' => 0,
                'tablePrefix' => $this->getVar( 'wgDBprefix' ) ] );
            $status->setDB( $db );
        } catch ( DBConnectionError $e ) {
            $status->fatal( 'config-connection-error', $e->getMessage() );
        }
 
        return $status;
    }
 
    public function preUpgrade() {
        global $wgDBuser, $wgDBpassword;
 
        $status = $this->getConnection( self::CONN_CREATE_TABLES );
        if ( !$status->isOK() ) {
            $this->parent->showStatusMessage( $status );
 
            return;
        }
        $conn = $status->getDB();
        # Determine existing default character set
        if ( $conn->tableExists( "revision", __METHOD__ ) ) {
            $revision = $this->escapeLikeInternal( $this->getVar( 'wgDBprefix' ) . 'revision', '\\' );
            $res = $conn->query( "SHOW TABLE STATUS LIKE '$revision'", __METHOD__ );
            $row = $res->fetchObject();
            if ( !$row ) {
                $this->parent->showMessage( 'config-show-table-status' );
                $existingSchema = false;
                $existingEngine = false;
            } else {
                if ( preg_match( '/^latin1/', $row->Collation ) ) {
                    $existingSchema = 'latin1';
                } elseif ( preg_match( '/^utf8/', $row->Collation ) ) {
                    $existingSchema = 'utf8';
                } elseif ( preg_match( '/^binary/', $row->Collation ) ) {
                    $existingSchema = 'binary';
                } else {
                    $existingSchema = false;
                    $this->parent->showMessage( 'config-unknown-collation' );
                }
                $existingEngine = $row->Engine ?? $row->Type;
            }
        } else {
            $existingSchema = false;
            $existingEngine = false;
        }
 
        if ( $existingSchema && $existingSchema != $this->getVar( '_MysqlCharset' ) ) {
            $this->setVar( '_MysqlCharset', $existingSchema );
        }
        if ( $existingEngine && $existingEngine != $this->getVar( '_MysqlEngine' ) ) {
            $this->setVar( '_MysqlEngine', $existingEngine );
        }
 
        # Normal user and password are selected after this step, so for now
        # just copy these two
        $wgDBuser = $this->getVar( '_InstallUser' );
        $wgDBpassword = $this->getVar( '_InstallPassword' );
    }
 
    protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
        return str_replace( [ $escapeChar, '%', '_' ],
            [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
            $s );
    }
 
    public function getEngines() {
        $status = $this->getConnection( self::CONN_CREATE_DATABASE );
        $conn = $status->getDB();
 
        $engines = [];
        $res = $conn->query( 'SHOW ENGINES', __METHOD__ );
        foreach ( $res as $row ) {
            if ( $row->Support == 'YES' || $row->Support == 'DEFAULT' ) {
                $engines[] = $row->Engine;
            }
        }
        $engines = array_intersect( $this->supportedEngines, $engines );
 
        return $engines;
    }
 
    public function getCharsets() {
        return [ 'binary', 'utf8' ];
    }
 
    public function canCreateAccounts() {
        $status = $this->getConnection( self::CONN_CREATE_DATABASE );
        if ( !$status->isOK() ) {
            return false;
        }
        $conn = $status->getDB();
 
        // Get current account name
        $currentName = $conn->selectField( '', 'CURRENT_USER()', '', __METHOD__ );
        $parts = explode( '@', $currentName );
        if ( count( $parts ) != 2 ) {
            return false;
        }
        $quotedUser = $conn->addQuotes( $parts[0] ) .
            '@' . $conn->addQuotes( $parts[1] );
 
        // The user needs to have INSERT on mysql.* or (global) CREATE USER to be able to CREATE USER
        // The grantee will be double-quoted in this query, as required
        $res = $conn->select( 'INFORMATION_SCHEMA.USER_PRIVILEGES', '*',
            [ 'GRANTEE' => $quotedUser ], __METHOD__ );
        $insertMysql = false;
        // The user needs to have permission to GRANT all necessary permissions to the newly created user.
        // This starts as a list of all necessary permissions and they are removed as they are found.
        // If any are left in the list after checking for permissions, those are the missing permissions.
        $missingGrantOptions = array_fill_keys( $this->webUserPrivs, true );
        foreach ( $res as $row ) {
            if ( $row->PRIVILEGE_TYPE == 'INSERT' ) {
                $insertMysql = true;
            } elseif ( $row->PRIVILEGE_TYPE == 'CREATE USER' ) {
                $insertMysql = true;
            }
            if ( $row->IS_GRANTABLE === 'YES' ) {
                unset( $missingGrantOptions[$row->PRIVILEGE_TYPE] );
            }
        }
 
        // Check for DB-specific privs for mysql.*
        if ( !$insertMysql ) {
            $row = $conn->selectRow( 'INFORMATION_SCHEMA.SCHEMA_PRIVILEGES', '*',
                [
                    'GRANTEE' => $quotedUser,
                    'TABLE_SCHEMA' => 'mysql',
                    'PRIVILEGE_TYPE' => 'INSERT',
                ], __METHOD__ );
            if ( $row ) {
                $insertMysql = true;
            }
        }
 
        if ( !$insertMysql ) {
            return false;
        }
 
        // Check for DB-level grant options
        $res = $conn->select( 'INFORMATION_SCHEMA.SCHEMA_PRIVILEGES', '*',
            [
                'GRANTEE' => $quotedUser,
                'IS_GRANTABLE' => 'YES',
            ], __METHOD__ );
        foreach ( $res as $row ) {
            $regex = $this->likeToRegex( $row->TABLE_SCHEMA );
            if ( preg_match( $regex, $this->getVar( 'wgDBname' ) ) ) {
                unset( $missingGrantOptions[$row->PRIVILEGE_TYPE] );
            }
        }
        if ( count( $missingGrantOptions ) ) {
            // Can't grant everything
            return false;
        }
 
        return true;
    }
 
    protected function likeToRegex( $wildcard ) {
        $r = preg_quote( $wildcard, '/' );
        $r = strtr( $r, [
            '%' => '.*',
            '_' => '.'
        ] );
        return "/$r/s";
    }
 
    protected function getTableOptions() {
        $options = [];
        if ( $this->getVar( '_MysqlEngine' ) !== null ) {
            $options[] = "ENGINE=" . $this->getVar( '_MysqlEngine' );
        }
        if ( $this->getVar( '_MysqlCharset' ) !== null ) {
            $options[] = 'DEFAULT CHARSET=' . $this->getVar( '_MysqlCharset' );
        }
 
        return implode( ', ', $options );
    }
 
    public function getSchemaVars() {
        return [
            'wgDBTableOptions' => $this->getTableOptions(),
        ];
    }
 
    public function getLocalSettings() {
        $prefix = LocalSettingsGenerator::escapePhpString( $this->getVar( 'wgDBprefix' ) );
        $useSsl = $this->getVar( 'wgDBssl' ) ? 'true' : 'false';
        $tblOpts = LocalSettingsGenerator::escapePhpString( $this->getTableOptions() );
 
        return "# MySQL specific settings
\$wgDBprefix = \"{$prefix}\";
\$wgDBssl = {$useSsl};
 
# MySQL table options to use during installation or update
\$wgDBTableOptions = \"{$tblOpts}\";";
    }
}