Installer.php

Go to the documentation of this file.

<?php
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\StaticHookRegistry;
use MediaWiki\Interwiki\NullInterwikiLookup;
use MediaWiki\MainConfigNames;
use MediaWiki\MainConfigSchema;
use MediaWiki\MediaWikiServices;
use MediaWiki\Settings\SettingsBuilder;
use Wikimedia\AtEase\AtEase;
 
abstract class Installer {
 
    public const MINIMUM_PCRE_VERSION = '7.2';
 
    private const MEDIAWIKI_ANNOUNCE_URL =
        'https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/';
 
    protected $settings;
 
    protected $compiledDBs;
 
    protected $dbInstallers = [];
 
    protected $minMemorySize = 50;
 
    protected $parserTitle;
 
    protected $parserOptions;
 
    protected static $dbTypes = [
        'mysql',
        'postgres',
        'sqlite',
    ];
 
    protected $envChecks = [
        'envCheckDB',
        'envCheckPCRE',
        'envCheckMemory',
        'envCheckCache',
        'envCheckModSecurity',
        'envCheckDiff3',
        'envCheckGraphics',
        'envCheckGit',
        'envCheckServer',
        'envCheckPath',
        'envCheckUploadsDirectory',
        'envCheckLibicu',
        'envCheckSuhosinMaxValueLength',
        'envCheck64Bit',
    ];
 
    protected $envPreps = [
        'envPrepServer',
        'envPrepPath',
    ];
 
    private const DEFAULT_VAR_NAMES = [
        MainConfigNames::Sitename,
        MainConfigNames::PasswordSender,
        MainConfigNames::LanguageCode,
        MainConfigNames::Localtimezone,
        MainConfigNames::RightsIcon,
        MainConfigNames::RightsText,
        MainConfigNames::RightsUrl,
        MainConfigNames::EnableEmail,
        MainConfigNames::EnableUserEmail,
        MainConfigNames::EnotifUserTalk,
        MainConfigNames::EnotifWatchlist,
        MainConfigNames::EmailAuthentication,
        MainConfigNames::DBname,
        MainConfigNames::DBtype,
        MainConfigNames::Diff3,
        MainConfigNames::ImageMagickConvertCommand,
        MainConfigNames::GitBin,
        MainConfigNames::ScriptPath,
        MainConfigNames::MetaNamespace,
        MainConfigNames::DeletedDirectory,
        MainConfigNames::EnableUploads,
        MainConfigNames::SecretKey,
        MainConfigNames::UseInstantCommons,
        MainConfigNames::UpgradeKey,
        MainConfigNames::DefaultSkin,
        MainConfigNames::Pingback,
    ];
 
    protected $internalDefaults = [
        '_UserLang' => 'en',
        '_Environment' => false,
        '_RaiseMemory' => false,
        '_UpgradeDone' => false,
        '_InstallDone' => false,
        '_Caches' => [],
        '_InstallPassword' => '',
        '_SameAccount' => true,
        '_CreateDBAccount' => false,
        '_NamespaceType' => 'site-name',
        '_AdminName' => '', // will be set later, when the user selects language
        '_AdminPassword' => '',
        '_AdminPasswordConfirm' => '',
        '_AdminEmail' => '',
        '_Subscribe' => false,
        '_SkipOptional' => 'continue',
        '_RightsProfile' => 'wiki',
        '_LicenseCode' => 'none',
        '_CCDone' => false,
        '_Extensions' => [],
        '_Skins' => [],
        '_MemCachedServers' => '',
        '_UpgradeKeySupplied' => false,
        '_ExistingDBSettings' => false,
        '_LogoWordmark' => '',
        '_LogoWordmarkWidth' => 119,
        '_LogoWordmarkHeight' => 18,
        // Single quotes are intentional, LocalSettingsGenerator must output this unescaped.
        '_Logo1x' => '$wgResourceBasePath/resources/assets/change-your-logo.svg',
        '_LogoIcon' => '$wgResourceBasePath/resources/assets/change-your-logo-icon.svg',
        '_LogoTagline' => '',
        '_LogoTaglineWidth' => 117,
        '_LogoTaglineHeight' => 13,
 
        'wgAuthenticationTokenVersion' => 1,
    ];
 
    private $installSteps = [];
 
    protected $extraInstallSteps = [];
 
    protected $objectCaches = [
        'apcu' => 'apcu_fetch',
        'wincache' => 'wincache_ucache_get'
    ];
 
    public $rightsProfiles = [
        'wiki' => [],
        'no-anon' => [
            '*' => [ 'edit' => false ]
        ],
        'fishbowl' => [
            '*' => [
                'createaccount' => false,
                'edit' => false,
            ],
        ],
        'private' => [
            '*' => [
                'createaccount' => false,
                'edit' => false,
                'read' => false,
            ],
        ],
    ];
 
    public $licenses = [
        'cc-by' => [
            'url' => 'https://creativecommons.org/licenses/by/4.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by.png',
        ],
        'cc-by-sa' => [
            'url' => 'https://creativecommons.org/licenses/by-sa/4.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png',
        ],
        'cc-by-nc-sa' => [
            'url' => 'https://creativecommons.org/licenses/by-nc-sa/4.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-by-nc-sa.png',
        ],
        'cc-0' => [
            'url' => 'https://creativecommons.org/publicdomain/zero/1.0/',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/cc-0.png',
        ],
        'gfdl' => [
            'url' => 'https://www.gnu.org/copyleft/fdl.html',
            'icon' => '$wgResourceBasePath/resources/assets/licenses/gnu-fdl.png',
        ],
        'none' => [
            'url' => '',
            'icon' => '',
            'text' => ''
        ],
        'cc-choose' => [
            // Details will be filled in by the selector.
            'url' => '',
            'icon' => '',
            'text' => '',
        ],
    ];
 
    protected $autoExtensionHookContainer;
 
    abstract public function showMessage( $msg, ...$params );
 
    abstract public function showError( $msg, ...$params );
 
    abstract public function showStatusMessage( Status $status );
 
    public static function getInstallerConfig( Config $baseConfig ) {
        $configOverrides = new HashConfig();
 
        // disable (problematic) object cache types explicitly, preserving all other (working) ones
        // bug T113843
        $emptyCache = [ 'class' => EmptyBagOStuff::class ];
 
        $objectCaches = [
                CACHE_NONE => $emptyCache,
                CACHE_DB => $emptyCache,
                CACHE_ANYTHING => $emptyCache,
                CACHE_MEMCACHED => $emptyCache,
            ] + $baseConfig->get( MainConfigNames::ObjectCaches );
 
        $configOverrides->set( MainConfigNames::ObjectCaches, $objectCaches );
 
        // Load the installer's i18n.
        $messageDirs = $baseConfig->get( MainConfigNames::MessagesDirs );
        $messageDirs['MediawikiInstaller'] = __DIR__ . '/i18n';
 
        $configOverrides->set( MainConfigNames::MessagesDirs, $messageDirs );
 
        $installerConfig = new MultiConfig( [ $configOverrides, $baseConfig ] );
 
        // make sure we use the installer config as the main config
        $configRegistry = $baseConfig->get( MainConfigNames::ConfigRegistry );
        $configRegistry['main'] = static function () use ( $installerConfig ) {
            return $installerConfig;
        };
 
        $configOverrides->set( MainConfigNames::ConfigRegistry, $configRegistry );
 
        return $installerConfig;
    }
 
    public function __construct() {
        $defaultConfig = new GlobalVarConfig(); // all the defaults from config-schema.yaml.
        $installerConfig = self::getInstallerConfig( $defaultConfig );
 
        $this->resetMediaWikiServices( $installerConfig );
 
        // Disable all storage services, since we don't have any configuration yet!
        MediaWikiServices::disableStorageBackend();
 
        $this->settings = $this->getDefaultSettings();
 
        $this->doEnvironmentPreps();
 
        $this->compiledDBs = [];
        foreach ( self::getDBTypes() as $type ) {
            $installer = $this->getDBInstaller( $type );
 
            if ( !$installer->isCompiled() ) {
                continue;
            }
            $this->compiledDBs[] = $type;
        }
 
        $this->parserTitle = Title::newFromText( 'Installer' );
    }
 
    private function getDefaultSettings(): array {
        global $wgLocaltimezone;
 
        $ret = $this->internalDefaults;
 
        foreach ( self::DEFAULT_VAR_NAMES as $name ) {
            $var = "wg{$name}";
            $ret[$var] = MainConfigSchema::getDefaultValue( $name );
        }
 
        // Set $wgLocaltimezone to the value of the global, which SetupDynamicConfig.php will have
        // set to something that is a valid timezone.
        $ret['wgLocaltimezone'] = $wgLocaltimezone;
 
        return $ret;
    }
 
    public function resetMediaWikiServices( Config $installerConfig = null, $serviceOverrides = [] ) {
        global $wgObjectCaches, $wgLang;
 
        $serviceOverrides += [
            // Disable interwiki lookup, to avoid database access during parses
            'InterwikiLookup' => static function () {
                return new NullInterwikiLookup();
            },
 
            // Disable user options database fetching, only rely on default options.
            'UserOptionsLookup' => static function ( MediaWikiServices $services ) {
                return $services->get( '_DefaultOptionsLookup' );
            }
        ];
 
        $lang = $this->getVar( '_UserLang', 'en' );
 
        // Reset all services and inject config overrides
        MediaWikiServices::resetGlobalInstance( $installerConfig );
 
        $mwServices = MediaWikiServices::getInstance();
 
        foreach ( $serviceOverrides as $name => $callback ) {
            // Skip if the caller set $callback to null
            // to suppress default overrides.
            if ( $callback ) {
                $mwServices->redefineService( $name, $callback );
            }
        }
 
        // Disable i18n cache
        $mwServices->getLocalisationCache()->disableBackend();
 
        // Set a fake user.
        // Note that this will reset the context's language,
        // so set the user before setting the language.
        $user = User::newFromId( 0 );
        StubGlobalUser::setUser( $user );
 
        RequestContext::getMain()->setUser( $user );
 
        // Don't attempt to load user language options (T126177)
        // This will be overridden in the web installer with the user-specified language
        // Ensure $wgLang does not have a reference to a stale LocalisationCache instance
        // (T241638, T261081)
        RequestContext::getMain()->setLanguage( $lang );
        $wgLang = RequestContext::getMain()->getLanguage();
 
        // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
        // SqlBagOStuff will then throw since we just disabled wfGetDB)
        $wgObjectCaches = $mwServices->getMainConfig()->get( MainConfigNames::ObjectCaches );
 
        $this->parserOptions = new ParserOptions( $user ); // language will be wrong :(
        // Don't try to access DB before user language is initialised
        $this->setParserLanguage( $mwServices->getLanguageFactory()->getLanguage( 'en' ) );
 
        return $mwServices;
    }
 
    public static function getDBTypes() {
        return self::$dbTypes;
    }
 
    public function doEnvironmentChecks() {
        // PHP version has already been checked by entry scripts
        // Show message here for information purposes
        $this->showMessage( 'config-env-php', PHP_VERSION );
 
        $good = true;
        // Must go here because an old version of PCRE can prevent other checks from completing
        $pcreVersion = explode( ' ', PCRE_VERSION, 2 )[0];
        if ( version_compare( $pcreVersion, self::MINIMUM_PCRE_VERSION, '<' ) ) {
            $this->showError( 'config-pcre-old', self::MINIMUM_PCRE_VERSION, $pcreVersion );
            $good = false;
        } else {
            foreach ( $this->envChecks as $check ) {
                $status = $this->$check();
                if ( $status === false ) {
                    $good = false;
                }
            }
        }
 
        $this->setVar( '_Environment', $good );
 
        return $good ? Status::newGood() : Status::newFatal( 'config-env-bad' );
    }
 
    public function doEnvironmentPreps() {
        foreach ( $this->envPreps as $prep ) {
            $this->$prep();
        }
    }
 
    public function setVar( $name, $value ) {
        $this->settings[$name] = $value;
    }
 
    public function getVar( $name, $default = null ) {
        return $this->settings[$name] ?? $default;
    }
 
    public function getCompiledDBs() {
        return $this->compiledDBs;
    }
 
    public static function getDBInstallerClass( $type ) {
        return ucfirst( $type ) . 'Installer';
    }
 
    public function getDBInstaller( $type = false ) {
        if ( !$type ) {
            $type = $this->getVar( 'wgDBtype' );
        }
 
        $type = strtolower( $type );
 
        if ( !isset( $this->dbInstallers[$type] ) ) {
            $class = self::getDBInstallerClass( $type );
            $this->dbInstallers[$type] = new $class( $this );
        }
 
        return $this->dbInstallers[$type];
    }
 
    public static function getExistingLocalSettings() {
        $IP = wfDetectInstallPath();
 
        // You might be wondering why this is here. Well if you don't do this
        // then some poorly-formed extensions try to call their own classes
        // after immediately registering them. We really need to get extension
        // registration out of the global scope and into a real format.
        // @see https://phabricator.wikimedia.org/T69440
        global $wgAutoloadClasses;
        $wgAutoloadClasses = [];
 
        // LocalSettings.php should not call functions, except wfLoadSkin/wfLoadExtensions
        // Define the required globals here, to ensure, the functions can do it work correctly.
        // phpcs:ignore MediaWiki.VariableAnalysis.UnusedGlobalVariables
        global $wgExtensionDirectory, $wgStyleDirectory;
 
        // This will also define MW_CONFIG_FILE
        $lsFile = wfDetectLocalSettingsFile( $IP );
        // phpcs:ignore Generic.PHP.NoSilencedErrors
        $lsExists = @file_exists( $lsFile );
 
        if ( !$lsExists ) {
            return false;
        }
 
        if ( !str_ends_with( $lsFile, '.php' ) ) {
            throw new Exception(
                'The installer cannot yet handle non-php settings files: ' . $lsFile . '. ' .
                'Use maintenance/update.php to update an existing installation.'
            );
        }
        unset( $lsExists );
 
        // Extract the defaults into the current scope
        foreach ( MainConfigSchema::listDefaultValues( 'wg' ) as $var => $value ) {
            $$var = $value;
        }
 
        $wgExtensionDirectory = "$IP/extensions";
        $wgStyleDirectory = "$IP/skins";
 
        // NOTE: To support YAML settings files, this needs to start using SettingsBuilder.
        //       However, as of 1.38, YAML settings files are still experimental and
        //       SettingsBuilder is still unstable. For now, the installer will fail if
        //       the existing settings file is not PHP. The updater should still work though.
        // NOTE: When adding support for YAML settings file, all references to LocalSettings.php
        //       in localisation messages need to be replaced.
        // NOTE: This assumes simple variable assignments. More complex setups may involve
        //       settings coming from sub-required and/or functions that assign globals
        //       directly. This is fine here because this isn't used as the "real" include.
        //       It is only used for reading out a small set of variables that the installer
        //       validates and/or displays.
        require $lsFile;
 
        return get_defined_vars();
    }
 
    public function getFakePassword( $realPassword ) {
        return str_repeat( '*', strlen( $realPassword ) );
    }
 
    public function setPassword( $name, $value ) {
        if ( !preg_match( '/^\*+$/', $value ) ) {
            $this->setVar( $name, $value );
        }
    }
 
    public static function maybeGetWebserverPrimaryGroup() {
        if ( !function_exists( 'posix_getegid' ) || !function_exists( 'posix_getpwuid' ) ) {
            # I don't know this, this isn't UNIX.
            return null;
        }
 
        # posix_getegid() *not* getmygid() because we want the group of the webserver,
        # not whoever owns the current script.
        $gid = posix_getegid();
        return posix_getpwuid( $gid )['name'] ?? null;
    }
 
    public function parse( $text, $lineStart = false ) {
        $parser = MediaWikiServices::getInstance()->getParser();
 
        try {
            $out = $parser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
            $html = $out->getText( [
                'enableSectionEditLinks' => false,
                'unwrap' => true,
            ] );
            $html = Parser::stripOuterParagraph( $html );
        } catch ( Wikimedia\Services\ServiceDisabledException $e ) {
            $html = '<!--DB access attempted during parse-->  ' . htmlspecialchars( $text );
        }
 
        return $html;
    }
 
    public function getParserOptions() {
        return $this->parserOptions;
    }
 
    public function disableLinkPopups() {
        $this->parserOptions->setExternalLinkTarget( false );
    }
 
    public function restoreLinkPopups() {
        global $wgExternalLinkTarget;
        $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
    }
 
    public function populateSiteStats( DatabaseInstaller $installer ) {
        $status = $installer->getConnection();
        if ( !$status->isOK() ) {
            return $status;
        }
        // @phan-suppress-next-line PhanUndeclaredMethod
        $status->value->insert(
            'site_stats',
            [
                'ss_row_id' => 1,
                'ss_total_edits' => 0,
                'ss_good_articles' => 0,
                'ss_total_pages' => 0,
                'ss_users' => 0,
                'ss_active_users' => 0,
                'ss_images' => 0
            ],
            __METHOD__,
            'IGNORE'
        );
 
        return Status::newGood();
    }
 
    protected function envCheckDB() {
        global $wgLang;
        $dbType = $this->getVar( 'wgDBtype' );
 
        $allNames = [];
 
        // Messages: config-type-mysql, config-type-postgres, config-type-sqlite
        foreach ( self::getDBTypes() as $name ) {
            $allNames[] = wfMessage( "config-type-$name" )->text();
        }
 
        $databases = $this->getCompiledDBs();
 
        $databases = array_flip( $databases );
        $ok = true;
        foreach ( array_keys( $databases ) as $db ) {
            $installer = $this->getDBInstaller( $db );
            $status = $installer->checkPrerequisites();
            if ( !$status->isGood() ) {
                if ( !$this instanceof WebInstaller && $db === $dbType ) {
                    // Strictly check the key database type instead of just outputting message
                    // Note: No perform this check run from the web installer, since this method always called by
                    // the welcome page under web installation, so $dbType will always be 'mysql'
                    $ok = false;
                }
                $this->showStatusMessage( $status );
                unset( $databases[$db] );
            }
        }
        $databases = array_flip( $databases );
        if ( !$databases ) {
            $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
            return false;
        }
        return $ok;
    }
 
    protected function envCheckPCRE() {
        AtEase::suppressWarnings();
        $regexd = preg_replace( '/[\x{0430}-\x{04FF}]/iu', '', '-АБВГД-' );
        // Need to check for \p support too, as PCRE can be compiled
        // with utf8 support, but not unicode property support.
        // check that \p{Zs} (space separators) matches
        // U+3000 (Ideographic space)
        $regexprop = preg_replace( '/\p{Zs}/u', '', "-\u{3000}-" );
        AtEase::restoreWarnings();
        if ( $regexd != '--' || $regexprop != '--' ) {
            $this->showError( 'config-pcre-no-utf8' );
 
            return false;
        }
 
        // PCRE must be compiled using PCRE_CONFIG_NEWLINE other than -1 (any)
        // otherwise it will misidentify some unicode characters containing 0x85
        // code with break lines
        if ( preg_match( '/^b.*c$/', 'bąc' ) === 0 ) {
            $this->showError( 'config-pcre-invalid-newline' );
 
            return false;
        }
 
        return true;
    }
 
    protected function envCheckMemory() {
        $limit = ini_get( 'memory_limit' );
 
        if ( !$limit || $limit == -1 ) {
            return true;
        }
 
        $n = wfShorthandToInteger( $limit );
 
        if ( $n < $this->minMemorySize * 1024 * 1024 ) {
            $newLimit = "{$this->minMemorySize}M";
 
            if ( ini_set( "memory_limit", $newLimit ) === false ) {
                $this->showMessage( 'config-memory-bad', $limit );
            } else {
                $this->showMessage( 'config-memory-raised', $limit, $newLimit );
                $this->setVar( '_RaiseMemory', true );
            }
        }
 
        return true;
    }
 
    protected function envCheckCache() {
        $caches = [];
        foreach ( $this->objectCaches as $name => $function ) {
            if ( function_exists( $function ) ) {
                $caches[$name] = true;
            }
        }
 
        if ( !$caches ) {
            $this->showMessage( 'config-no-cache-apcu' );
        }
 
        $this->setVar( '_Caches', $caches );
    }
 
    protected function envCheckModSecurity() {
        if ( self::apacheModulePresent( 'mod_security' )
            || self::apacheModulePresent( 'mod_security2' ) ) {
            $this->showMessage( 'config-mod-security' );
        }
 
        return true;
    }
 
    protected function envCheckDiff3() {
        $names = [ "gdiff3", "diff3" ];
        if ( wfIsWindows() ) {
            $names[] = 'diff3.exe';
        }
        $versionInfo = [ '--version', 'GNU diffutils' ];
 
        $diff3 = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
 
        if ( $diff3 ) {
            $this->setVar( 'wgDiff3', $diff3 );
        } else {
            $this->setVar( 'wgDiff3', false );
            $this->showMessage( 'config-diff3-bad' );
        }
 
        return true;
    }
 
    protected function envCheckGraphics() {
        $names = wfIsWindows() ? 'convert.exe' : 'convert';
        $versionInfo = [ '-version', 'ImageMagick' ];
        $convert = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
 
        $this->setVar( 'wgImageMagickConvertCommand', '' );
        if ( $convert ) {
            $this->setVar( 'wgImageMagickConvertCommand', $convert );
            $this->showMessage( 'config-imagemagick', $convert );
        } elseif ( function_exists( 'imagejpeg' ) ) {
            $this->showMessage( 'config-gd' );
        } else {
            $this->showMessage( 'config-no-scaling' );
        }
 
        return true;
    }
 
    protected function envCheckGit() {
        $names = wfIsWindows() ? 'git.exe' : 'git';
        $versionInfo = [ '--version', 'git version' ];
 
        $git = ExecutableFinder::findInDefaultPaths( $names, $versionInfo );
 
        if ( $git ) {
            $this->setVar( 'wgGitBin', $git );
            $this->showMessage( 'config-git', $git );
        } else {
            $this->setVar( 'wgGitBin', false );
            $this->showMessage( 'config-git-bad' );
        }
 
        return true;
    }
 
    protected function envCheckServer() {
        $server = $this->envGetDefaultServer();
        if ( $server !== null ) {
            $this->showMessage( 'config-using-server', $server );
        }
        return true;
    }
 
    protected function envCheckPath() {
        $this->showMessage(
            'config-using-uri',
            $this->getVar( 'wgServer' ),
            $this->getVar( 'wgScriptPath' )
        );
        return true;
    }
 
    protected function envCheckUploadsDirectory() {
        global $IP;
 
        $dir = $IP . '/images/';
        $url = $this->getVar( 'wgServer' ) . $this->getVar( 'wgScriptPath' ) . '/images/';
        $safe = !$this->dirIsExecutable( $dir, $url );
 
        if ( !$safe ) {
            $this->showMessage( 'config-uploads-not-safe', $dir );
        }
 
        return true;
    }
 
    protected function envCheckSuhosinMaxValueLength() {
        $currentValue = ini_get( 'suhosin.get.max_value_length' );
        $minRequired = 2000;
        $recommended = 5000;
        if ( $currentValue > 0 && $currentValue < $minRequired ) {
            $this->showError( 'config-suhosin-max-value-length', $currentValue, $minRequired, $recommended );
            return false;
        }
 
        return true;
    }
 
    protected function envCheck64Bit() {
        if ( PHP_INT_SIZE == 4 ) {
            $this->showMessage( 'config-using-32bit' );
        }
 
        return true;
    }
 
    protected function envCheckLibicu() {
        $not_normal_c = "\u{FA6C}";
        $normal_c = "\u{242EE}";
 
        $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
 
        $this->showMessage( 'config-unicode-using-intl' );
        if ( $intl !== $normal_c ) {
            $this->showMessage( 'config-unicode-update-warning' );
        }
    }
 
    protected function envPrepServer() {
        $server = $this->envGetDefaultServer();
        if ( $server !== null ) {
            $this->setVar( 'wgServer', $server );
        }
    }
 
    abstract protected function envGetDefaultServer();
 
    protected function envPrepPath() {
        global $IP;
        $IP = dirname( dirname( __DIR__ ) );
        $this->setVar( 'IP', $IP );
    }
 
    public function dirIsExecutable( $dir, $url ) {
        $scriptTypes = [
            'php' => [
                "<?php echo 'exec';",
                "#!/var/env php\n<?php echo 'exec';",
            ],
        ];
 
        // it would be good to check other popular languages here, but it'll be slow.
        // TODO no need to have a loop if there is going to only be one script type
 
        $httpRequestFactory = MediaWikiServices::getInstance()->getHttpRequestFactory();
 
        AtEase::suppressWarnings();
 
        foreach ( $scriptTypes as $ext => $contents ) {
            foreach ( $contents as $source ) {
                $file = 'exectest.' . $ext;
 
                if ( !file_put_contents( $dir . $file, $source ) ) {
                    break;
                }
 
                try {
                    $text = $httpRequestFactory->get(
                        $url . $file,
                        [ 'timeout' => 3 ],
                        __METHOD__
                    );
                } catch ( Exception $e ) {
                    // HttpRequestFactory::get can throw with allow_url_fopen = false and no curl
                    // extension.
                    $text = null;
                }
                unlink( $dir . $file );
 
                if ( $text == 'exec' ) {
                    AtEase::restoreWarnings();
 
                    return $ext;
                }
            }
        }
 
        AtEase::restoreWarnings();
 
        return false;
    }
 
    public static function apacheModulePresent( $moduleName ) {
        if ( function_exists( 'apache_get_modules' ) && in_array( $moduleName, apache_get_modules() ) ) {
            return true;
        }
        // try it the hard way
        ob_start();
        phpinfo( INFO_MODULES );
        $info = ob_get_clean();
 
        return strpos( $info, $moduleName ) !== false;
    }
 
    public function setParserLanguage( $lang ) {
        $this->parserOptions->setTargetLanguage( $lang );
        $this->parserOptions->setUserLang( $lang );
    }
 
    protected function getDocUrl( $page ) {
        return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
    }
 
    public function findExtensions( $directory = 'extensions' ) {
        switch ( $directory ) {
            case 'extensions':
                return $this->findExtensionsByType( 'extension', 'extensions' );
            case 'skins':
                return $this->findExtensionsByType( 'skin', 'skins' );
            default:
                throw new InvalidArgumentException( "Invalid extension type" );
        }
    }
 
    protected function findExtensionsByType( $type = 'extension', $directory = 'extensions' ) {
        if ( $this->getVar( 'IP' ) === null ) {
            return Status::newGood( [] );
        }
 
        $extDir = $this->getVar( 'IP' ) . '/' . $directory;
        if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
            return Status::newGood( [] );
        }
 
        $dh = opendir( $extDir );
        $exts = [];
        $status = new Status;
        while ( ( $file = readdir( $dh ) ) !== false ) {
            // skip non-dirs and hidden directories
            if ( !is_dir( "$extDir/$file" ) || $file[0] === '.' ) {
                continue;
            }
            $extStatus = $this->getExtensionInfo( $type, $directory, $file );
            if ( $extStatus->isOK() ) {
                $exts[$file] = $extStatus->value;
            } elseif ( $extStatus->hasMessage( 'config-extension-not-found' ) ) {
                // (T225512) The directory is not actually an extension. Downgrade to warning.
                $status->warning( 'config-extension-not-found', $file );
            } else {
                $status->merge( $extStatus );
            }
        }
        closedir( $dh );
        uksort( $exts, 'strnatcasecmp' );
 
        $status->value = $exts;
 
        return $status;
    }
 
    protected function getExtensionInfo( $type, $parentRelPath, $name ) {
        if ( $this->getVar( 'IP' ) === null ) {
            throw new Exception( 'Cannot find extensions since the IP variable is not yet set' );
        }
        if ( $type !== 'extension' && $type !== 'skin' ) {
            throw new InvalidArgumentException( "Invalid extension type" );
        }
        $absDir = $this->getVar( 'IP' ) . "/$parentRelPath/$name";
        $relDir = "../$parentRelPath/$name";
        if ( !is_dir( $absDir ) ) {
            return Status::newFatal( 'config-extension-not-found', $name );
        }
        $jsonFile = $type . '.json';
        $fullJsonFile = "$absDir/$jsonFile";
        $isJson = file_exists( $fullJsonFile );
        $isPhp = false;
        if ( !$isJson ) {
            // Only fallback to PHP file if JSON doesn't exist
            $fullPhpFile = "$absDir/$name.php";
            $isPhp = file_exists( $fullPhpFile );
        }
        if ( !$isJson && !$isPhp ) {
            return Status::newFatal( 'config-extension-not-found', $name );
        }
 
        // Extension exists. Now see if there are screenshots
        $info = [];
        if ( is_dir( "$absDir/screenshots" ) ) {
            $paths = glob( "$absDir/screenshots/*.png" );
            foreach ( $paths as $path ) {
                $info['screenshots'][] = str_replace( $absDir, $relDir, $path );
            }
        }
 
        if ( $isJson ) {
            $jsonStatus = $this->readExtension( $fullJsonFile );
            if ( !$jsonStatus->isOK() ) {
                return $jsonStatus;
            }
            $info += $jsonStatus->value;
        }
 
        return Status::newGood( $info );
    }
 
    private function readExtension( $fullJsonFile, $extDeps = [], $skinDeps = [] ) {
        $load = [
            $fullJsonFile => 1
        ];
        if ( $extDeps ) {
            $extDir = $this->getVar( 'IP' ) . '/extensions';
            foreach ( $extDeps as $dep ) {
                $fname = "$extDir/$dep/extension.json";
                if ( !file_exists( $fname ) ) {
                    return Status::newFatal( 'config-extension-not-found', $dep );
                }
                $load[$fname] = 1;
            }
        }
        if ( $skinDeps ) {
            $skinDir = $this->getVar( 'IP' ) . '/skins';
            foreach ( $skinDeps as $dep ) {
                $fname = "$skinDir/$dep/skin.json";
                if ( !file_exists( $fname ) ) {
                    return Status::newFatal( 'config-extension-not-found', $dep );
                }
                $load[$fname] = 1;
            }
        }
        $registry = new ExtensionRegistry();
        try {
            $info = $registry->readFromQueue( $load );
        } catch ( ExtensionDependencyError $e ) {
            if ( $e->incompatibleCore || $e->incompatibleSkins
                || $e->incompatibleExtensions
            ) {
                // If something is incompatible with a dependency, we have no real
                // option besides skipping it
                return Status::newFatal( 'config-extension-dependency',
                    basename( dirname( $fullJsonFile ) ), $e->getMessage() );
            } elseif ( $e->missingExtensions || $e->missingSkins ) {
                // There's an extension missing in the dependency tree,
                // so add those to the dependency list and try again
                $status = $this->readExtension(
                    $fullJsonFile,
                    array_merge( $extDeps, $e->missingExtensions ),
                    array_merge( $skinDeps, $e->missingSkins )
                );
                if ( !$status->isOK() && !$status->hasMessage( 'config-extension-dependency' ) ) {
                    $status = Status::newFatal( 'config-extension-dependency',
                        basename( dirname( $fullJsonFile ) ), $status->getMessage() );
                }
                return $status;
            }
            // Some other kind of dependency error?
            return Status::newFatal( 'config-extension-dependency',
                basename( dirname( $fullJsonFile ) ), $e->getMessage() );
        }
        $ret = [];
        // The order of credits will be the order of $load,
        // so the first extension is the one we want to load,
        // everything else is a dependency
        $i = 0;
        foreach ( $info['credits'] as $name => $credit ) {
            $i++;
            if ( $i == 1 ) {
                // Extension we want to load
                continue;
            }
            $type = basename( $credit['path'] ) === 'skin.json' ? 'skins' : 'extensions';
            $ret['requires'][$type][] = $credit['name'];
        }
        $credits = array_values( $info['credits'] )[0];
        if ( isset( $credits['url'] ) ) {
            $ret['url'] = $credits['url'];
        }
        $ret['type'] = $credits['type'];
 
        return Status::newGood( $ret );
    }
 
    public function getDefaultSkin( array $skinNames ) {
        $defaultSkin = $GLOBALS['wgDefaultSkin'];
        if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
            return $defaultSkin;
        } else {
            return $skinNames[0];
        }
    }
 
    protected function includeExtensions() {
        // Marker for DatabaseUpdater::loadExtensions so we don't
        // double load extensions
        define( 'MW_EXTENSIONS_LOADED', true );
 
        $legacySchemaHooks = $this->getAutoExtensionLegacyHooks();
        $data = $this->getAutoExtensionData();
        if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
            $legacySchemaHooks = array_merge( $legacySchemaHooks,
                $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] );
        }
        $extDeprecatedHooks = $data['attributes']['DeprecatedHooks'] ?? [];
 
        $this->autoExtensionHookContainer = new HookContainer(
            new StaticHookRegistry(
                [ 'LoadExtensionSchemaUpdates' => $legacySchemaHooks ],
                $data['attributes']['Hooks'] ?? [],
                $extDeprecatedHooks
            ),
            MediaWikiServices::getInstance()->getObjectFactory()
        );
 
        return Status::newGood();
    }
 
    protected function getAutoExtensionLegacyHooks() {
        $exts = $this->getVar( '_Extensions' );
        $installPath = $this->getVar( 'IP' );
        $files = [];
        foreach ( $exts as $e ) {
            if ( file_exists( "$installPath/extensions/$e/$e.php" ) ) {
                $files[] = "$installPath/extensions/$e/$e.php";
            }
        }
 
        if ( $files ) {
            return $this->includeExtensionFiles( $files );
        } else {
            return [];
        }
    }
 
    protected function includeExtensionFiles( $files ) {
        global $IP;
        $IP = $this->getVar( 'IP' );
 
        // Extract the defaults into the current scope
        foreach ( MainConfigSchema::listDefaultValues( 'wg' ) as $var => $value ) {
            $$var = $value;
        }
 
        // phpcs:ignore MediaWiki.VariableAnalysis.UnusedGlobalVariables
        global $wgAutoloadClasses, $wgExtensionDirectory, $wgStyleDirectory;
        $wgExtensionDirectory = "$IP/extensions";
        $wgStyleDirectory = "$IP/skins";
 
        foreach ( $files as $file ) {
            require_once $file;
        }
 
        // @phpcs:disable MediaWiki.VariableAnalysis.MisleadingGlobalNames.Misleading$wgHooks
        // @phpcs:ignore Generic.Files.LineLength.TooLong
        // @phan-suppress-next-line PhanUndeclaredVariable,PhanCoalescingAlwaysNull $wgHooks is defined by MainConfigSchema
        $hooksWeWant = $wgHooks['LoadExtensionSchemaUpdates'] ?? [];
        // @phpcs:enable MediaWiki.VariableAnalysis.MisleadingGlobalNames.Misleading$wgHooks
 
        // Ignore everyone else's hooks. Lord knows what someone might be doing
        // in ParserFirstCallInit (see T29171)
        return [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
    }
 
    protected function getAutoExtensionData() {
        $exts = $this->getVar( '_Extensions' );
        $installPath = $this->getVar( 'IP' );
 
        $extensionProcessor = new ExtensionProcessor();
        foreach ( $exts as $e ) {
            $jsonPath = "$installPath/extensions/$e/extension.json";
            if ( file_exists( $jsonPath ) ) {
                $extensionProcessor->extractInfoFromFile( $jsonPath );
            }
        }
 
        $autoload = $extensionProcessor->getExtractedAutoloadInfo();
        AutoLoader::loadFiles( $autoload['files'] );
        AutoLoader::registerClasses( $autoload['classes'] );
        AutoLoader::registerNamespaces( $autoload['namespaces'] );
 
        return $extensionProcessor->getExtractedInfo();
    }
 
    public function getAutoExtensionHookContainer() {
        if ( !$this->autoExtensionHookContainer ) {
            throw new \Exception( __METHOD__ .
                ': includeExtensions() has not been called' );
        }
        return $this->autoExtensionHookContainer;
    }
 
    protected function getInstallSteps( DatabaseInstaller $installer ) {
        $coreInstallSteps = [
            [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
            [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
            [ 'name' => 'tables-manual', 'callback' => [ $installer, 'createManualTables' ] ],
            [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
            [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
            [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
            [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
            [ 'name' => 'restore-services', 'callback' => [ $this, 'restoreServices' ] ],
            [ 'name' => 'sysop', 'callback' => [ $this, 'createSysop' ] ],
            [ 'name' => 'mainpage', 'callback' => [ $this, 'createMainpage' ] ],
        ];
 
        // Build the array of install steps starting from the core install list,
        // then adding any callbacks that wanted to attach after a given step
        foreach ( $coreInstallSteps as $step ) {
            $this->installSteps[] = $step;
            if ( isset( $this->extraInstallSteps[$step['name']] ) ) {
                $this->installSteps = array_merge(
                    $this->installSteps,
                    $this->extraInstallSteps[$step['name']]
                );
            }
        }
 
        // Prepend any steps that want to be at the beginning
        if ( isset( $this->extraInstallSteps['BEGINNING'] ) ) {
            $this->installSteps = array_merge(
                $this->extraInstallSteps['BEGINNING'],
                $this->installSteps
            );
        }
 
        // Extensions should always go first, chance to tie into hooks and such
        if ( count( $this->getVar( '_Extensions' ) ) ) {
            array_unshift( $this->installSteps,
                [ 'name' => 'extensions', 'callback' => [ $this, 'includeExtensions' ] ]
            );
            $this->installSteps[] = [
                'name' => 'extension-tables',
                'callback' => [ $installer, 'createExtensionTables' ]
            ];
        }
 
        return $this->installSteps;
    }
 
    public function performInstallation( $startCB, $endCB ) {
        $installResults = [];
        $installer = $this->getDBInstaller();
        $installer->preInstall();
        $steps = $this->getInstallSteps( $installer );
        foreach ( $steps as $stepObj ) {
            $name = $stepObj['name'];
            call_user_func_array( $startCB, [ $name ] );
 
            // Perform the callback step
            $status = call_user_func( $stepObj['callback'], $installer );
 
            // Output and save the results
            call_user_func( $endCB, $name, $status );
            $installResults[$name] = $status;
 
            // If we've hit some sort of fatal, we need to bail.
            // Callback already had a chance to do output above.
            if ( !$status->isOK() ) {
                break;
            }
        }
        // @phan-suppress-next-next-line PhanPossiblyUndeclaredVariable
        // $steps has at least one element and that defines $status
        if ( $status->isOK() ) {
            $this->showMessage(
                'config-install-db-success'
            );
            $this->setVar( '_InstallDone', true );
        }
 
        return $installResults;
    }
 
    public function generateKeys() {
        $keys = [ 'wgSecretKey' => 64 ];
        if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
            $keys['wgUpgradeKey'] = 16;
        }
 
        return $this->doGenerateKeys( $keys );
    }
 
    public function restoreServices() {
        $this->resetMediaWikiServices( null, [
            'UserOptionsLookup' => static function ( MediaWikiServices $services ) {
                return $services->get( 'UserOptionsManager' );
            }
        ] );
        return Status::newGood();
    }
 
    protected function doGenerateKeys( $keys ) {
        foreach ( $keys as $name => $length ) {
            $secretKey = MWCryptRand::generateHex( $length );
            $this->setVar( $name, $secretKey );
        }
        return Status::newGood();
    }
 
    protected function createSysop() {
        $name = $this->getVar( '_AdminName' );
        $user = User::newFromName( $name );
 
        if ( !$user ) {
            // We should've validated this earlier anyway!
            return Status::newFatal( 'config-admin-error-user', $name );
        }
 
        if ( $user->idForName() == 0 ) {
            $user->addToDatabase();
 
            $password = $this->getVar( '_AdminPassword' );
            $status = $user->changeAuthenticationData( [
                'username' => $user->getName(),
                'password' => $password,
                'retype' => $password,
            ] );
            if ( !$status->isGood() ) {
                return Status::newFatal( 'config-admin-error-password',
                    $name, $status->getWikiText( false, false, $this->getVar( '_UserLang' ) ) );
            }
 
            $userGroupManager = MediaWikiServices::getInstance()->getUserGroupManager();
            $userGroupManager->addUserToGroup( $user, 'sysop' );
            $userGroupManager->addUserToGroup( $user, 'bureaucrat' );
            $userGroupManager->addUserToGroup( $user, 'interface-admin' );
            if ( $this->getVar( '_AdminEmail' ) ) {
                $user->setEmail( $this->getVar( '_AdminEmail' ) );
            }
            $user->saveSettings();
 
            // Update user count
            $ssUpdate = SiteStatsUpdate::factory( [ 'users' => 1 ] );
            $ssUpdate->doUpdate();
        }
 
        if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
            return $this->subscribeToMediaWikiAnnounce();
        }
        return Status::newGood();
    }
 
    private function subscribeToMediaWikiAnnounce() {
        $status = Status::newGood();
        $http = MediaWikiServices::getInstance()->getHttpRequestFactory();
        if ( !$http->canMakeRequests() ) {
            $status->warning( 'config-install-subscribe-fail',
                wfMessage( 'config-install-subscribe-notpossible' ) );
            return $status;
        }
 
        // Create subscription request
        $params = [ 'email' => $this->getVar( '_AdminEmail' ) ];
        $req = $http->create( self::MEDIAWIKI_ANNOUNCE_URL . 'anonymous_subscribe',
            [ 'method' => 'POST', 'postData' => $params ], __METHOD__ );
 
        // Add headers needed to pass Django's CSRF checks
        $token = str_repeat( 'a', 64 );
        $req->setHeader( 'Referer', self::MEDIAWIKI_ANNOUNCE_URL );
        $req->setHeader( 'Cookie', "csrftoken=$token" );
        $req->setHeader( 'X-CSRFToken', $token );
 
        // Send subscription request
        $reqStatus = $req->execute();
        if ( !$reqStatus->isOK() ) {
            $status->warning( 'config-install-subscribe-fail',
                Status::wrap( $reqStatus )->getMessage() );
            return $status;
        }
 
        // Was the request submitted successfully?
        // The status message is displayed after a redirect, using Django's messages
        // framework, so load the list summary page and look for the expected text.
        // (Though parsing the cookie set by the framework may be possible, it isn't
        // simple, since the format of the cookie has changed between versions.)
        $checkReq = $http->create( self::MEDIAWIKI_ANNOUNCE_URL, [], __METHOD__ );
        $checkReq->setCookieJar( $req->getCookieJar() );
        if ( !$checkReq->execute()->isOK() ) {
            $status->warning( 'config-install-subscribe-possiblefail' );
            return $status;
        }
        $html = $checkReq->getContent();
        if ( strpos( $html, 'Please check your inbox for further instructions' ) !== false ) {
            // Success
        } elseif ( strpos( $html, 'Member already subscribed' ) !== false ) {
            $status->warning( 'config-install-subscribe-alreadysubscribed' );
        } elseif ( strpos( $html, 'Subscription request already pending' ) !== false ) {
            $status->warning( 'config-install-subscribe-alreadypending' );
        } else {
            $status->warning( 'config-install-subscribe-possiblefail' );
        }
        return $status;
    }
 
    protected function createMainpage( DatabaseInstaller $installer ) {
        $status = Status::newGood();
        $title = Title::newMainPage();
        if ( $title->exists() ) {
            $status->warning( 'config-install-mainpage-exists' );
            return $status;
        }
        try {
            $page = MediaWikiServices::getInstance()->getWikiPageFactory()->newFromTitle( $title );
            $content = new WikitextContent(
                wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
                wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
            );
 
            $status = $page->doUserEditContent(
                $content,
                User::newSystemUser( 'MediaWiki default' ),
                '',
                EDIT_NEW
            );
        } catch ( Exception $e ) {
            // using raw, because $wgShowExceptionDetails can not be set yet
            $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
        }
 
        return $status;
    }
 
    public static function overrideConfig( SettingsBuilder $settings ) {
        // Use PHP's built-in session handling, since MediaWiki's
        // SessionHandler can't work before we have an object cache set up.
        if ( !defined( 'MW_NO_SESSION_HANDLER' ) ) {
            define( 'MW_NO_SESSION_HANDLER', 1 );
        }
 
        $settings->overrideConfigValues( [
 
            // Don't access the database
            MainConfigNames::UseDatabaseMessages => false,
 
            // Don't cache langconv tables
            MainConfigNames::LanguageConverterCacheType => CACHE_NONE,
 
            // Don't try to cache ResourceLoader dependencies in the database
            MainConfigNames::ResourceLoaderUseObjectCacheForDeps => true,
 
            // Debug-friendly
            MainConfigNames::ShowExceptionDetails => true,
            MainConfigNames::ShowHostnames => true,
 
            // Don't break forms
            MainConfigNames::ExternalLinkTarget => '_blank',
 
            // Allow multiple ob_flush() calls
            MainConfigNames::DisableOutputCompression => true,
 
            // Use a sensible cookie prefix (not my_wiki)
            MainConfigNames::CookiePrefix => 'mw_installer',
 
            // Some of the environment checks make shell requests, remove limits
            MainConfigNames::MaxShellMemory => 0,
 
            // Override the default CookieSessionProvider with a dummy
            // implementation that won't stomp on PHP's cookies.
            MainConfigNames::SessionProviders => [
                [
                    'class' => InstallerSessionProvider::class,
                    'args' => [ [
                        'priority' => 1,
                    ] ]
                ]
            ],
 
            // Don't use the DB as the main stash
            MainConfigNames::MainStash => CACHE_NONE,
 
            // Don't try to use any object cache for SessionManager either.
            MainConfigNames::SessionCacheType => CACHE_NONE,
 
            // Set a dummy $wgServer to bypass the check in Setup.php, the
            // web installer will automatically detect it and not use this value.
            MainConfigNames::Server => 'https://🌻.invalid',
        ] );
    }
 
    public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
        $this->extraInstallSteps[$findStep][] = $callback;
    }
 
    protected function disableTimeLimit() {
        AtEase::suppressWarnings();
        set_time_limit( 0 );
        AtEase::restoreWarnings();
    }
}