CliInstaller.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Installer;
 
use MediaWiki\Context\RequestContext;
use MediaWiki\MediaWikiServices;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\Password\UserPasswordPolicy;
use MediaWiki\Status\Status;
use MediaWiki\User\User;
use Wikimedia\Message\MessageSpecifier;
 
class CliInstaller extends Installer {
    private $specifiedScriptPath = false;
 
    private const OPTION_MAP = [
        'dbtype' => 'wgDBtype',
        'dbserver' => 'wgDBserver',
        'dbname' => 'wgDBname',
        'dbuser' => 'wgDBuser',
        'dbpass' => 'wgDBpassword',
        'dbprefix' => 'wgDBprefix',
        'dbtableoptions' => 'wgDBTableOptions',
        'dbport' => 'wgDBport',
        'dbssl' => 'wgDBssl',
        'dbschema' => 'wgDBmwschema',
        'dbpath' => 'wgSQLiteDataDir',
        'server' => 'wgServer',
        'scriptpath' => 'wgScriptPath',
    ];
 
    public function __construct( $siteName, $admin = null, array $options = [] ) {
        global $wgPasswordPolicy;
 
        parent::__construct();
 
        if ( isset( $options['scriptpath'] ) ) {
            $this->specifiedScriptPath = true;
        }
 
        foreach ( self::OPTION_MAP as $opt => $global ) {
            if ( isset( $options[$opt] ) ) {
                $GLOBALS[$global] = $options[$opt];
                $this->setVar( $global, $options[$opt] );
            }
        }
 
        if ( isset( $options['lang'] ) ) {
            global $wgLang, $wgLanguageCode;
            $this->setVar( '_UserLang', $options['lang'] );
            $wgLanguageCode = $options['lang'];
            $this->setVar( 'wgLanguageCode', $wgLanguageCode );
            $wgLang = MediaWikiServices::getInstance()->getLanguageFactory()
                ->getLanguage( $options['lang'] );
            RequestContext::getMain()->setLanguage( $wgLang );
        }
 
        $this->setVar( 'wgSitename', $siteName );
 
        $contLang = MediaWikiServices::getInstance()->getContentLanguage();
        $metaNS = $contLang->ucfirst( str_replace( ' ', '_', $siteName ) );
        if ( $metaNS == 'MediaWiki' ) {
            $metaNS = 'Project';
        }
        $this->setVar( 'wgMetaNamespace', $metaNS );
 
        if ( !isset( $options['installdbuser'] ) ) {
            $this->setVar( '_InstallUser',
                $this->getVar( 'wgDBuser' ) );
            $this->setVar( '_InstallPassword',
                $this->getVar( 'wgDBpassword' ) );
        } else {
            $this->setVar( '_InstallUser',
                $options['installdbuser'] );
            $this->setVar( '_InstallPassword',
                $options['installdbpass'] ?? "" );
 
            // Assume that if we're given the installer user, we'll create the account.
            $this->setVar( '_CreateDBAccount', true );
        }
 
        if ( $admin ) {
            $this->setVar( '_AdminName', $admin );
            if ( isset( $options['pass'] ) ) {
                $adminUser = User::newFromName( $admin );
                if ( !$adminUser ) {
                    throw new InstallException( Status::newFatal( 'config-admin-name-invalid' ) );
                }
                $upp = new UserPasswordPolicy(
                    $wgPasswordPolicy['policies'],
                    $wgPasswordPolicy['checks']
                );
                $status = $upp->checkUserPasswordForGroups( $adminUser, $options['pass'],
                    [ 'bureaucrat', 'sysop', 'interface-admin' ] ); // per Installer::createSysop()
                if ( !$status->isGood() ) {
                    throw new InstallException( Status::newFatal(
                        $status->getMessage( 'config-admin-error-password-invalid' ) ) );
                }
                $this->setVar( '_AdminPassword', $options['pass'] );
            }
        }
 
        // Detect and inject any extension found
        if ( isset( $options['extensions'] ) ) {
            $status = $this->validateExtensions(
                'extension', 'extensions', $options['extensions'] );
            if ( !$status->isOK() ) {
                throw new InstallException( $status );
            }
            $this->setVar( '_Extensions', $status->value );
        } elseif ( isset( $options['with-extensions'] ) ) {
            $status = $this->findExtensions();
            if ( !$status->isOK() ) {
                throw new InstallException( $status );
            }
            $this->setVar( '_Extensions', array_keys( $status->value ) );
        }
 
        // Set up the default skins
        if ( isset( $options['skins'] ) ) {
            $status = $this->validateExtensions( 'skin', 'skins', $options['skins'] );
            if ( !$status->isOK() ) {
                throw new InstallException( $status );
            }
            $skins = $status->value;
        } else {
            $status = $this->findExtensions( 'skins' );
            if ( !$status->isOK() ) {
                throw new InstallException( $status );
            }
            $skins = array_keys( $status->value );
        }
        $this->setVar( '_Skins', $skins );
 
        if ( $skins ) {
            $skinNames = array_map( 'strtolower', $skins );
            $this->setVar( 'wgDefaultSkin', $this->getDefaultSkin( $skinNames ) );
        }
 
        $this->setVar( '_WithDevelopmentSettings', isset( $options['with-developmentsettings'] ) );
    }
 
    private function validateExtensions( $type, $directory, $nameLists ) {
        $extensions = [];
        $status = new Status;
        foreach ( (array)$nameLists as $nameList ) {
            foreach ( explode( ',', $nameList ) as $name ) {
                $name = trim( $name );
                if ( $name === '' ) {
                    continue;
                }
                $extStatus = $this->getExtensionInfo( $type, $directory, $name );
                if ( $extStatus->isOK() ) {
                    $extensions[] = $name;
                } else {
                    $status->merge( $extStatus );
                }
            }
        }
        $extensions = array_unique( $extensions );
        $status->value = $extensions;
        return $status;
    }
 
    public function execute() {
        // If APC is available, use that as the MainCacheType, instead of nothing.
        // This is hacky and should be consolidated with WebInstallerOptions.
        // This is here instead of in __construct(), because it should run after
        // doEnvironmentChecks(), which populates '_Caches'.
        if ( count( $this->getVar( '_Caches' ) ) ) {
            // We detected a CACHE_ACCEL implementation, use it.
            $this->setVar( '_MainCacheType', 'accel' );
        }
 
        $vars = Installer::getExistingLocalSettings();
        if ( $vars ) {
            $status = Status::newFatal( "config-localsettings-cli-upgrade" );
            $this->showStatusMessage( $status );
            return $status;
        }
 
        $result = $this->performInstallation(
            [ $this, 'startStage' ],
            [ $this, 'endStage' ]
        );
        // PerformInstallation bails on a fatal, so make sure the last item
        // completed before giving 'next.' Likewise, only provide back on failure
        $lastStepStatus = end( $result );
        if ( $lastStepStatus->isOK() ) {
            return Status::newGood();
        } else {
            return $lastStepStatus;
        }
    }
 
    public function writeConfigurationFile( $path ) {
        $ls = InstallerOverrides::getLocalSettingsGenerator( $this );
        $ls->writeFile( "$path/LocalSettings.php" );
    }
 
    public function startStage( $step ) {
        // Messages: config-install-database, config-install-tables, config-install-interwiki,
        // config-install-stats, config-install-keys, config-install-sysop, config-install-mainpage,
        // config-install-extensions
        $this->showMessage( "config-install-$step" );
    }
 
    public function endStage( $step, $status ) {
        $this->showStatusMessage( $status );
        if ( $status->isOK() ) {
            $this->showMessage( 'config-install-step-done' );
        } else {
            $this->showError( 'config-install-step-failed' );
        }
    }
 
    public function showMessage( $msg, ...$params ) {
        // @phan-suppress-next-line SecurityCheck-XSS
        echo $this->getMessageText( $msg, $params ) . "\n";
        flush();
    }
 
    public function showSuccess( $msg, ...$params ) {
        // @phan-suppress-next-line SecurityCheck-XSS
        echo $this->getMessageText( $msg, $params ) . "\n";
        flush();
    }
 
    public function showWarning( $msg, ...$params ) {
        // @phan-suppress-next-line SecurityCheck-XSS
        echo $this->getMessageText( $msg, $params ) . "\n";
        flush();
    }
 
    public function showError( $msg, ...$params ) {
        // @phan-suppress-next-line SecurityCheck-XSS
        echo "***{$this->getMessageText( $msg, $params )}***\n";
        flush();
    }
 
    protected function getMessageText( $msg, $params ) {
        $text = wfMessage( $msg, $params )->parse();
 
        $text = preg_replace( '/<a href="(.*?)".*?>(.*?)<\/a>/', '$2 &lt;$1&gt;', $text );
 
        return Sanitizer::stripAllTags( $text );
    }
 
    public function showHelpBox( $msg, ...$params ) {
    }
 
    public function showStatusMessage( Status $status ) {
        // Show errors at the end in CLI installer to make them easier to notice
        foreach ( $status->getMessages( 'warning' ) as $msg ) {
            $this->showMessage( $msg );
        }
        foreach ( $status->getMessages( 'error' ) as $msg ) {
            $this->showMessage( $msg );
        }
    }
 
    public function envCheckPath() {
        if ( !$this->specifiedScriptPath ) {
            $this->showMessage( 'config-no-cli-uri', $this->getVar( "wgScriptPath" ) );
        }
 
        return parent::envCheckPath();
    }
 
    protected function envGetDefaultServer() {
        // Use a basic value if the user didn't pass in --server
        return 'http://localhost';
    }
 
    public function dirIsExecutable( $dir, $url ) {
        $this->showMessage( 'config-no-cli-uploads-check', $dir );
 
        return false;
    }
}