123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815 |
- <?php
- /**
- * Base code for MediaWiki installer.
- *
- * DO NOT PATCH THIS FILE IF YOU NEED TO CHANGE INSTALLER BEHAVIOR IN YOUR PACKAGE!
- * See mw-config/overrides/README for details.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- * http://www.gnu.org/copyleft/gpl.html
- *
- * @file
- * @ingroup Deployment
- */
- use MediaWiki\Interwiki\NullInterwikiLookup;
- use MediaWiki\MediaWikiServices;
- use MediaWiki\Shell\Shell;
- /**
- * This documentation group collects source code files with deployment functionality.
- *
- * @defgroup Deployment Deployment
- */
- /**
- * Base installer class.
- *
- * This class provides the base for installation and update functionality
- * for both MediaWiki core and extensions.
- *
- * @ingroup Deployment
- * @since 1.17
- */
- abstract class Installer {
- /**
- * The oldest version of PCRE we can support.
- *
- * Defining this is necessary because PHP may be linked with a system version
- * of PCRE, which may be older than that bundled with the minimum PHP version.
- */
- const MINIMUM_PCRE_VERSION = '7.2';
- /**
- * @var array
- */
- protected $settings;
- /**
- * List of detected DBs, access using getCompiledDBs().
- *
- * @var array
- */
- protected $compiledDBs;
- /**
- * Cached DB installer instances, access using getDBInstaller().
- *
- * @var array
- */
- protected $dbInstallers = [];
- /**
- * Minimum memory size in MB.
- *
- * @var int
- */
- protected $minMemorySize = 50;
- /**
- * Cached Title, used by parse().
- *
- * @var Title
- */
- protected $parserTitle;
- /**
- * Cached ParserOptions, used by parse().
- *
- * @var ParserOptions
- */
- protected $parserOptions;
- /**
- * Known database types. These correspond to the class names <type>Installer,
- * and are also MediaWiki database types valid for $wgDBtype.
- *
- * To add a new type, create a <type>Installer class and a Database<type>
- * class, and add a config-type-<type> message to MessagesEn.php.
- *
- * @var array
- */
- protected static $dbTypes = [
- 'mysql',
- 'postgres',
- 'oracle',
- 'mssql',
- 'sqlite',
- ];
- /**
- * A list of environment check methods called by doEnvironmentChecks().
- * These may output warnings using showMessage(), and/or abort the
- * installation process by returning false.
- *
- * For the WebInstaller these are only called on the Welcome page,
- * if these methods have side-effects that should affect later page loads
- * (as well as the generated stylesheet), use envPreps instead.
- *
- * @var array
- */
- protected $envChecks = [
- 'envCheckDB',
- 'envCheckBrokenXML',
- 'envCheckPCRE',
- 'envCheckMemory',
- 'envCheckCache',
- 'envCheckModSecurity',
- 'envCheckDiff3',
- 'envCheckGraphics',
- 'envCheckGit',
- 'envCheckServer',
- 'envCheckPath',
- 'envCheckShellLocale',
- 'envCheckUploadsDirectory',
- 'envCheckLibicu',
- 'envCheckSuhosinMaxValueLength',
- 'envCheck64Bit',
- ];
- /**
- * A list of environment preparation methods called by doEnvironmentPreps().
- *
- * @var array
- */
- protected $envPreps = [
- 'envPrepServer',
- 'envPrepPath',
- ];
- /**
- * MediaWiki configuration globals that will eventually be passed through
- * to LocalSettings.php. The names only are given here, the defaults
- * typically come from DefaultSettings.php.
- *
- * @var array
- */
- protected $defaultVarNames = [
- 'wgSitename',
- 'wgPasswordSender',
- 'wgLanguageCode',
- 'wgRightsIcon',
- 'wgRightsText',
- 'wgRightsUrl',
- 'wgEnableEmail',
- 'wgEnableUserEmail',
- 'wgEnotifUserTalk',
- 'wgEnotifWatchlist',
- 'wgEmailAuthentication',
- 'wgDBname',
- 'wgDBtype',
- 'wgDiff3',
- 'wgImageMagickConvertCommand',
- 'wgGitBin',
- 'IP',
- 'wgScriptPath',
- 'wgMetaNamespace',
- 'wgDeletedDirectory',
- 'wgEnableUploads',
- 'wgShellLocale',
- 'wgSecretKey',
- 'wgUseInstantCommons',
- 'wgUpgradeKey',
- 'wgDefaultSkin',
- 'wgPingback',
- ];
- /**
- * Variables that are stored alongside globals, and are used for any
- * configuration of the installation process aside from the MediaWiki
- * configuration. Map of names to defaults.
- *
- * @var array
- */
- 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,
- // $wgLogo is probably wrong (T50084); set something that will work.
- // Single quotes work fine here, as LocalSettingsGenerator outputs this unescaped.
- 'wgLogo' => '$wgResourceBasePath/resources/assets/wiki.png',
- 'wgAuthenticationTokenVersion' => 1,
- ];
- /**
- * The actual list of installation steps. This will be initialized by getInstallSteps()
- *
- * @var array
- */
- private $installSteps = [];
- /**
- * Extra steps for installation, for things like DatabaseInstallers to modify
- *
- * @var array
- */
- protected $extraInstallSteps = [];
- /**
- * Known object cache types and the functions used to test for their existence.
- *
- * @var array
- */
- protected $objectCaches = [
- 'apc' => 'apc_fetch',
- 'apcu' => 'apcu_fetch',
- 'wincache' => 'wincache_ucache_get'
- ];
- /**
- * User rights profiles.
- *
- * @var array
- */
- public $rightsProfiles = [
- 'wiki' => [],
- 'no-anon' => [
- '*' => [ 'edit' => false ]
- ],
- 'fishbowl' => [
- '*' => [
- 'createaccount' => false,
- 'edit' => false,
- ],
- ],
- 'private' => [
- '*' => [
- 'createaccount' => false,
- 'edit' => false,
- 'read' => false,
- ],
- ],
- ];
- /**
- * License types.
- *
- * @var array
- */
- 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' => '',
- ],
- ];
- /**
- * URL to mediawiki-announce subscription
- */
- protected $mediaWikiAnnounceUrl =
- 'https://lists.wikimedia.org/mailman/subscribe/mediawiki-announce';
- /**
- * Supported language codes for Mailman
- */
- protected $mediaWikiAnnounceLanguages = [
- 'ca', 'cs', 'da', 'de', 'en', 'es', 'et', 'eu', 'fi', 'fr', 'hr', 'hu',
- 'it', 'ja', 'ko', 'lt', 'nl', 'no', 'pl', 'pt', 'pt-br', 'ro', 'ru',
- 'sl', 'sr', 'sv', 'tr', 'uk'
- ];
- /**
- * UI interface for displaying a short message
- * The parameters are like parameters to wfMessage().
- * The messages will be in wikitext format, which will be converted to an
- * output format such as HTML or text before being sent to the user.
- * @param string $msg
- */
- abstract public function showMessage( $msg /*, ... */ );
- /**
- * Same as showMessage(), but for displaying errors
- * @param string $msg
- */
- abstract public function showError( $msg /*, ... */ );
- /**
- * Show a message to the installing user by using a Status object
- * @param Status $status
- */
- abstract public function showStatusMessage( Status $status );
- /**
- * Constructs a Config object that contains configuration settings that should be
- * overwritten for the installation process.
- *
- * @since 1.27
- *
- * @param Config $baseConfig
- *
- * @return Config The config to use during installation.
- */
- 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( 'ObjectCaches' );
- $configOverrides->set( 'ObjectCaches', $objectCaches );
- // Load the installer's i18n.
- $messageDirs = $baseConfig->get( 'MessagesDirs' );
- $messageDirs['MediawikiInstaller'] = __DIR__ . '/i18n';
- $configOverrides->set( 'MessagesDirs', $messageDirs );
- $installerConfig = new MultiConfig( [ $configOverrides, $baseConfig ] );
- // make sure we use the installer config as the main config
- $configRegistry = $baseConfig->get( 'ConfigRegistry' );
- $configRegistry['main'] = function () use ( $installerConfig ) {
- return $installerConfig;
- };
- $configOverrides->set( 'ConfigRegistry', $configRegistry );
- return $installerConfig;
- }
- /**
- * Constructor, always call this from child classes.
- */
- public function __construct() {
- global $wgMemc, $wgUser, $wgObjectCaches;
- $defaultConfig = new GlobalVarConfig(); // all the stuff from DefaultSettings.php
- $installerConfig = self::getInstallerConfig( $defaultConfig );
- // Reset all services and inject config overrides
- MediaWikiServices::resetGlobalInstance( $installerConfig );
- // Don't attempt to load user language options (T126177)
- // This will be overridden in the web installer with the user-specified language
- RequestContext::getMain()->setLanguage( 'en' );
- // Disable the i18n cache
- // TODO: manage LocalisationCache singleton in MediaWikiServices
- Language::getLocalisationCache()->disableBackend();
- // Disable all global services, since we don't have any configuration yet!
- MediaWikiServices::disableStorageBackend();
- $mwServices = MediaWikiServices::getInstance();
- // Disable object cache (otherwise CACHE_ANYTHING will try CACHE_DB and
- // SqlBagOStuff will then throw since we just disabled wfGetDB)
- $wgObjectCaches = $mwServices->getMainConfig()->get( 'ObjectCaches' );
- $wgMemc = ObjectCache::getInstance( CACHE_NONE );
- // Disable interwiki lookup, to avoid database access during parses
- $mwServices->redefineService( 'InterwikiLookup', function () {
- return new NullInterwikiLookup();
- } );
- // Having a user with id = 0 safeguards us from DB access via User::loadOptions().
- $wgUser = User::newFromId( 0 );
- RequestContext::getMain()->setUser( $wgUser );
- $this->settings = $this->internalDefaults;
- foreach ( $this->defaultVarNames as $var ) {
- $this->settings[$var] = $GLOBALS[$var];
- }
- $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' );
- $this->parserOptions = new ParserOptions( $wgUser ); // language will be wrong :(
- // Don't try to access DB before user language is initialised
- $this->setParserLanguage( Language::factory( 'en' ) );
- }
- /**
- * Get a list of known DB types.
- *
- * @return array
- */
- public static function getDBTypes() {
- return self::$dbTypes;
- }
- /**
- * Do initial checks of the PHP environment. Set variables according to
- * the observed environment.
- *
- * It's possible that this may be called under the CLI SAPI, not the SAPI
- * that the wiki will primarily run under. In that case, the subclass should
- * initialise variables such as wgScriptPath, before calling this function.
- *
- * Under the web subclass, it can already be assumed that PHP 5+ is in use
- * and that sessions are working.
- *
- * @return Status
- */
- public function doEnvironmentChecks() {
- // Php version has already been checked by entry scripts
- // Show message here for information purposes
- if ( wfIsHHVM() ) {
- $this->showMessage( 'config-env-hhvm', HHVM_VERSION );
- } else {
- $this->showMessage( 'config-env-php', PHP_VERSION );
- }
- $good = true;
- // Must go here because an old version of PCRE can prevent other checks from completing
- list( $pcreVersion ) = explode( ' ', PCRE_VERSION, 2 );
- 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();
- }
- }
- /**
- * Set a MW configuration variable, or internal installer configuration variable.
- *
- * @param string $name
- * @param mixed $value
- */
- public function setVar( $name, $value ) {
- $this->settings[$name] = $value;
- }
- /**
- * Get an MW configuration variable, or internal installer configuration variable.
- * The defaults come from $GLOBALS (ultimately DefaultSettings.php).
- * Installer variables are typically prefixed by an underscore.
- *
- * @param string $name
- * @param mixed $default
- *
- * @return mixed
- */
- public function getVar( $name, $default = null ) {
- if ( !isset( $this->settings[$name] ) ) {
- return $default;
- } else {
- return $this->settings[$name];
- }
- }
- /**
- * Get a list of DBs supported by current PHP setup
- *
- * @return array
- */
- public function getCompiledDBs() {
- return $this->compiledDBs;
- }
- /**
- * Get the DatabaseInstaller class name for this type
- *
- * @param string $type database type ($wgDBtype)
- * @return string Class name
- * @since 1.30
- */
- public static function getDBInstallerClass( $type ) {
- return ucfirst( $type ) . 'Installer';
- }
- /**
- * Get an instance of DatabaseInstaller for the specified DB type.
- *
- * @param mixed $type DB installer for which is needed, false to use default.
- *
- * @return DatabaseInstaller
- */
- 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];
- }
- /**
- * Determine if LocalSettings.php exists. If it does, return its variables.
- *
- * @return array|false
- */
- public static function getExistingLocalSettings() {
- global $IP;
- // 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;
- Wikimedia\suppressWarnings();
- $_lsExists = file_exists( "$IP/LocalSettings.php" );
- Wikimedia\restoreWarnings();
- if ( !$_lsExists ) {
- return false;
- }
- unset( $_lsExists );
- require "$IP/includes/DefaultSettings.php";
- require "$IP/LocalSettings.php";
- return get_defined_vars();
- }
- /**
- * Get a fake password for sending back to the user in HTML.
- * This is a security mechanism to avoid compromise of the password in the
- * event of session ID compromise.
- *
- * @param string $realPassword
- *
- * @return string
- */
- public function getFakePassword( $realPassword ) {
- return str_repeat( '*', strlen( $realPassword ) );
- }
- /**
- * Set a variable which stores a password, except if the new value is a
- * fake password in which case leave it as it is.
- *
- * @param string $name
- * @param mixed $value
- */
- public function setPassword( $name, $value ) {
- if ( !preg_match( '/^\*+$/', $value ) ) {
- $this->setVar( $name, $value );
- }
- }
- /**
- * On POSIX systems return the primary group of the webserver we're running under.
- * On other systems just returns null.
- *
- * This is used to advice the user that he should chgrp his mw-config/data/images directory as the
- * webserver user before he can install.
- *
- * Public because SqliteInstaller needs it, and doesn't subclass Installer.
- *
- * @return mixed
- */
- 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();
- $group = posix_getpwuid( $gid )['name'];
- return $group;
- }
- /**
- * Convert wikitext $text to HTML.
- *
- * This is potentially error prone since many parser features require a complete
- * installed MW database. The solution is to just not use those features when you
- * write your messages. This appears to work well enough. Basic formatting and
- * external links work just fine.
- *
- * But in case a translator decides to throw in a "#ifexist" or internal link or
- * whatever, this function is guarded to catch the attempted DB access and to present
- * some fallback text.
- *
- * @param string $text
- * @param bool $lineStart
- * @return string
- */
- public function parse( $text, $lineStart = false ) {
- global $wgParser;
- try {
- $out = $wgParser->parse( $text, $this->parserTitle, $this->parserOptions, $lineStart );
- $html = $out->getText( [
- 'enableSectionEditLinks' => false,
- 'unwrap' => true,
- ] );
- } catch ( MediaWiki\Services\ServiceDisabledException $e ) {
- $html = '<!--DB access attempted during parse--> ' . htmlspecialchars( $text );
- }
- return $html;
- }
- /**
- * @return ParserOptions
- */
- public function getParserOptions() {
- return $this->parserOptions;
- }
- public function disableLinkPopups() {
- $this->parserOptions->setExternalLinkTarget( false );
- }
- public function restoreLinkPopups() {
- global $wgExternalLinkTarget;
- $this->parserOptions->setExternalLinkTarget( $wgExternalLinkTarget );
- }
- /**
- * Install step which adds a row to the site_stats table with appropriate
- * initial values.
- *
- * @param DatabaseInstaller $installer
- *
- * @return Status
- */
- public function populateSiteStats( DatabaseInstaller $installer ) {
- $status = $installer->getConnection();
- if ( !$status->isOK() ) {
- return $status;
- }
- $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();
- }
- /**
- * Environment check for DB types.
- * @return bool
- */
- protected function envCheckDB() {
- global $wgLang;
- $allNames = [];
- // Messages: config-type-mysql, config-type-postgres, config-type-oracle,
- // config-type-sqlite
- foreach ( self::getDBTypes() as $name ) {
- $allNames[] = wfMessage( "config-type-$name" )->text();
- }
- $databases = $this->getCompiledDBs();
- $databases = array_flip( $databases );
- foreach ( array_keys( $databases ) as $db ) {
- $installer = $this->getDBInstaller( $db );
- $status = $installer->checkPrerequisites();
- if ( !$status->isGood() ) {
- $this->showStatusMessage( $status );
- }
- if ( !$status->isOK() ) {
- unset( $databases[$db] );
- }
- }
- $databases = array_flip( $databases );
- if ( !$databases ) {
- $this->showError( 'config-no-db', $wgLang->commaList( $allNames ), count( $allNames ) );
- // @todo FIXME: This only works for the web installer!
- return false;
- }
- return true;
- }
- /**
- * Some versions of libxml+PHP break < and > encoding horribly
- * @return bool
- */
- protected function envCheckBrokenXML() {
- $test = new PhpXmlBugTester();
- if ( !$test->ok ) {
- $this->showError( 'config-brokenlibxml' );
- return false;
- }
- return true;
- }
- /**
- * Environment check for the PCRE module.
- *
- * @note If this check were to fail, the parser would
- * probably throw an exception before the result
- * of this check is shown to the user.
- * @return bool
- */
- protected function envCheckPCRE() {
- Wikimedia\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', '', "-\xE3\x80\x80-" );
- Wikimedia\restoreWarnings();
- if ( $regexd != '--' || $regexprop != '--' ) {
- $this->showError( 'config-pcre-no-utf8' );
- return false;
- }
- return true;
- }
- /**
- * Environment check for available memory.
- * @return bool
- */
- 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;
- }
- /**
- * Environment check for compiled object cache types.
- */
- protected function envCheckCache() {
- $caches = [];
- foreach ( $this->objectCaches as $name => $function ) {
- if ( function_exists( $function ) ) {
- $caches[$name] = true;
- }
- }
- if ( !$caches ) {
- $key = 'config-no-cache-apcu';
- $this->showMessage( $key );
- }
- $this->setVar( '_Caches', $caches );
- }
- /**
- * Scare user to death if they have mod_security or mod_security2
- * @return bool
- */
- protected function envCheckModSecurity() {
- if ( self::apacheModulePresent( 'mod_security' )
- || self::apacheModulePresent( 'mod_security2' ) ) {
- $this->showMessage( 'config-mod-security' );
- }
- return true;
- }
- /**
- * Search for GNU diff3.
- * @return bool
- */
- 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;
- }
- /**
- * Environment check for ImageMagick and GD.
- * @return bool
- */
- 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 );
- return true;
- } elseif ( function_exists( 'imagejpeg' ) ) {
- $this->showMessage( 'config-gd' );
- } else {
- $this->showMessage( 'config-no-scaling' );
- }
- return true;
- }
- /**
- * Search for git.
- *
- * @since 1.22
- * @return bool
- */
- 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;
- }
- /**
- * Environment check to inform user which server we've assumed.
- *
- * @return bool
- */
- protected function envCheckServer() {
- $server = $this->envGetDefaultServer();
- if ( $server !== null ) {
- $this->showMessage( 'config-using-server', $server );
- }
- return true;
- }
- /**
- * Environment check to inform user which paths we've assumed.
- *
- * @return bool
- */
- protected function envCheckPath() {
- $this->showMessage(
- 'config-using-uri',
- $this->getVar( 'wgServer' ),
- $this->getVar( 'wgScriptPath' )
- );
- return true;
- }
- /**
- * Environment check for preferred locale in shell
- * @return bool
- */
- protected function envCheckShellLocale() {
- $os = php_uname( 's' );
- $supported = [ 'Linux', 'SunOS', 'HP-UX', 'Darwin' ]; # Tested these
- if ( !in_array( $os, $supported ) ) {
- return true;
- }
- if ( Shell::isDisabled() ) {
- return true;
- }
- # Get a list of available locales.
- $result = Shell::command( '/usr/bin/locale', '-a' )
- ->execute();
- if ( $result->getExitCode() != 0 ) {
- return true;
- }
- $lines = $result->getStdout();
- $lines = array_map( 'trim', explode( "\n", $lines ) );
- $candidatesByLocale = [];
- $candidatesByLang = [];
- foreach ( $lines as $line ) {
- if ( $line === '' ) {
- continue;
- }
- if ( !preg_match( '/^([a-zA-Z]+)(_[a-zA-Z]+|)\.(utf8|UTF-8)(@[a-zA-Z_]*|)$/i', $line, $m ) ) {
- continue;
- }
- list( , $lang, , , ) = $m;
- $candidatesByLocale[$m[0]] = $m;
- $candidatesByLang[$lang][] = $m;
- }
- # Try the current value of LANG.
- if ( isset( $candidatesByLocale[getenv( 'LANG' )] ) ) {
- $this->setVar( 'wgShellLocale', getenv( 'LANG' ) );
- return true;
- }
- # Try the most common ones.
- $commonLocales = [ 'C.UTF-8', 'en_US.UTF-8', 'en_US.utf8', 'de_DE.UTF-8', 'de_DE.utf8' ];
- foreach ( $commonLocales as $commonLocale ) {
- if ( isset( $candidatesByLocale[$commonLocale] ) ) {
- $this->setVar( 'wgShellLocale', $commonLocale );
- return true;
- }
- }
- # Is there an available locale in the Wiki's language?
- $wikiLang = $this->getVar( 'wgLanguageCode' );
- if ( isset( $candidatesByLang[$wikiLang] ) ) {
- $m = reset( $candidatesByLang[$wikiLang] );
- $this->setVar( 'wgShellLocale', $m[0] );
- return true;
- }
- # Are there any at all?
- if ( count( $candidatesByLocale ) ) {
- $m = reset( $candidatesByLocale );
- $this->setVar( 'wgShellLocale', $m[0] );
- return true;
- }
- # Give up.
- return true;
- }
- /**
- * Environment check for the permissions of the uploads directory
- * @return bool
- */
- 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;
- }
- /**
- * Checks if suhosin.get.max_value_length is set, and if so generate
- * a warning because it decreases ResourceLoader performance.
- * @return bool
- */
- protected function envCheckSuhosinMaxValueLength() {
- $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
- if ( $maxValueLength > 0 && $maxValueLength < 1024 ) {
- // Only warn if the value is below the sane 1024
- $this->showMessage( 'config-suhosin-max-value-length', $maxValueLength );
- }
- return true;
- }
- /**
- * Checks if we're running on 64 bit or not. 32 bit is becoming increasingly
- * hard to support, so let's at least warn people.
- *
- * @return bool
- */
- protected function envCheck64Bit() {
- if ( PHP_INT_SIZE == 4 ) {
- $this->showMessage( 'config-using-32bit' );
- }
- return true;
- }
- /**
- * Convert a hex string representing a Unicode code point to that code point.
- * @param string $c
- * @return string|false
- */
- protected function unicodeChar( $c ) {
- $c = hexdec( $c );
- if ( $c <= 0x7F ) {
- return chr( $c );
- } elseif ( $c <= 0x7FF ) {
- return chr( 0xC0 | $c >> 6 ) . chr( 0x80 | $c & 0x3F );
- } elseif ( $c <= 0xFFFF ) {
- return chr( 0xE0 | $c >> 12 ) . chr( 0x80 | $c >> 6 & 0x3F ) .
- chr( 0x80 | $c & 0x3F );
- } elseif ( $c <= 0x10FFFF ) {
- return chr( 0xF0 | $c >> 18 ) . chr( 0x80 | $c >> 12 & 0x3F ) .
- chr( 0x80 | $c >> 6 & 0x3F ) .
- chr( 0x80 | $c & 0x3F );
- } else {
- return false;
- }
- }
- /**
- * Check the libicu version
- */
- protected function envCheckLibicu() {
- /**
- * This needs to be updated something that the latest libicu
- * will properly normalize. This normalization was found at
- * http://www.unicode.org/versions/Unicode5.2.0/#Character_Additions
- * Note that we use the hex representation to create the code
- * points in order to avoid any Unicode-destroying during transit.
- */
- $not_normal_c = $this->unicodeChar( "FA6C" );
- $normal_c = $this->unicodeChar( "242EE" );
- $useNormalizer = 'php';
- $needsUpdate = false;
- if ( function_exists( 'normalizer_normalize' ) ) {
- $useNormalizer = 'intl';
- $intl = normalizer_normalize( $not_normal_c, Normalizer::FORM_C );
- if ( $intl !== $normal_c ) {
- $needsUpdate = true;
- }
- }
- // Uses messages 'config-unicode-using-php' and 'config-unicode-using-intl'
- if ( $useNormalizer === 'php' ) {
- $this->showMessage( 'config-unicode-pure-php-warning' );
- } else {
- $this->showMessage( 'config-unicode-using-' . $useNormalizer );
- if ( $needsUpdate ) {
- $this->showMessage( 'config-unicode-update-warning' );
- }
- }
- }
- /**
- * Environment prep for the server hostname.
- */
- protected function envPrepServer() {
- $server = $this->envGetDefaultServer();
- if ( $server !== null ) {
- $this->setVar( 'wgServer', $server );
- }
- }
- /**
- * Helper function to be called from envPrepServer()
- * @return string
- */
- abstract protected function envGetDefaultServer();
- /**
- * Environment prep for setting $IP and $wgScriptPath.
- */
- protected function envPrepPath() {
- global $IP;
- $IP = dirname( dirname( __DIR__ ) );
- $this->setVar( 'IP', $IP );
- }
- /**
- * Checks if scripts located in the given directory can be executed via the given URL.
- *
- * Used only by environment checks.
- * @param string $dir
- * @param string $url
- * @return bool|int|string
- */
- public function dirIsExecutable( $dir, $url ) {
- $scriptTypes = [
- 'php' => [
- "<?php echo 'ex' . 'ec';",
- "#!/var/env php\n<?php echo 'ex' . 'ec';",
- ],
- ];
- // it would be good to check other popular languages here, but it'll be slow.
- Wikimedia\suppressWarnings();
- foreach ( $scriptTypes as $ext => $contents ) {
- foreach ( $contents as $source ) {
- $file = 'exectest.' . $ext;
- if ( !file_put_contents( $dir . $file, $source ) ) {
- break;
- }
- try {
- $text = Http::get( $url . $file, [ 'timeout' => 3 ], __METHOD__ );
- } catch ( Exception $e ) {
- // Http::get throws with allow_url_fopen = false and no curl extension.
- $text = null;
- }
- unlink( $dir . $file );
- if ( $text == 'exec' ) {
- Wikimedia\restoreWarnings();
- return $ext;
- }
- }
- }
- Wikimedia\restoreWarnings();
- return false;
- }
- /**
- * Checks for presence of an Apache module. Works only if PHP is running as an Apache module, too.
- *
- * @param string $moduleName Name of module to check.
- * @return bool
- */
- 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;
- }
- /**
- * ParserOptions are constructed before we determined the language, so fix it
- *
- * @param Language $lang
- */
- public function setParserLanguage( $lang ) {
- $this->parserOptions->setTargetLanguage( $lang );
- $this->parserOptions->setUserLang( $lang );
- }
- /**
- * Overridden by WebInstaller to provide lastPage parameters.
- * @param string $page
- * @return string
- */
- protected function getDocUrl( $page ) {
- return "{$_SERVER['PHP_SELF']}?page=" . urlencode( $page );
- }
- /**
- * Finds extensions that follow the format /$directory/Name/Name.php,
- * and returns an array containing the value for 'Name' for each found extension.
- *
- * Reasonable values for $directory include 'extensions' (the default) and 'skins'.
- *
- * @param string $directory Directory to search in
- * @return array [ $extName => [ 'screenshots' => [ '...' ] ]
- */
- public function findExtensions( $directory = 'extensions' ) {
- if ( $this->getVar( 'IP' ) === null ) {
- return [];
- }
- $extDir = $this->getVar( 'IP' ) . '/' . $directory;
- if ( !is_readable( $extDir ) || !is_dir( $extDir ) ) {
- return [];
- }
- // extensions -> extension.json, skins -> skin.json
- $jsonFile = substr( $directory, 0, strlen( $directory ) - 1 ) . '.json';
- $dh = opendir( $extDir );
- $exts = [];
- while ( ( $file = readdir( $dh ) ) !== false ) {
- if ( !is_dir( "$extDir/$file" ) ) {
- continue;
- }
- $fullJsonFile = "$extDir/$file/$jsonFile";
- $isJson = file_exists( $fullJsonFile );
- $isPhp = false;
- if ( !$isJson ) {
- // Only fallback to PHP file if JSON doesn't exist
- $fullPhpFile = "$extDir/$file/$file.php";
- $isPhp = file_exists( $fullPhpFile );
- }
- if ( $isJson || $isPhp ) {
- // Extension exists. Now see if there are screenshots
- $exts[$file] = [];
- if ( is_dir( "$extDir/$file/screenshots" ) ) {
- $paths = glob( "$extDir/$file/screenshots/*.png" );
- foreach ( $paths as $path ) {
- $exts[$file]['screenshots'][] = str_replace( $extDir, "../$directory", $path );
- }
- }
- }
- if ( $isJson ) {
- $info = $this->readExtension( $fullJsonFile );
- if ( $info === false ) {
- continue;
- }
- $exts[$file] += $info;
- }
- }
- closedir( $dh );
- uksort( $exts, 'strnatcasecmp' );
- return $exts;
- }
- /**
- * @param string $fullJsonFile
- * @param array $extDeps
- * @param array $skinDeps
- *
- * @return array|bool False if this extension can't be loaded
- */
- 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 false;
- }
- $load[$fname] = 1;
- }
- }
- if ( $skinDeps ) {
- $skinDir = $this->getVar( 'IP' ) . '/skins';
- foreach ( $skinDeps as $dep ) {
- $fname = "$skinDir/$dep/skin.json";
- if ( !file_exists( $fname ) ) {
- return false;
- }
- $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 false;
- } elseif ( $e->missingExtensions || $e->missingSkins ) {
- // There's an extension missing in the dependency tree,
- // so add those to the dependency list and try again
- return $this->readExtension(
- $fullJsonFile,
- array_merge( $extDeps, $e->missingExtensions ),
- array_merge( $skinDeps, $e->missingSkins )
- );
- }
- // Some other kind of dependency error?
- return false;
- }
- $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 $ret;
- }
- /**
- * Returns a default value to be used for $wgDefaultSkin: normally the one set in DefaultSettings,
- * but will fall back to another if the default skin is missing and some other one is present
- * instead.
- *
- * @param string[] $skinNames Names of installed skins.
- * @return string
- */
- public function getDefaultSkin( array $skinNames ) {
- $defaultSkin = $GLOBALS['wgDefaultSkin'];
- if ( !$skinNames || in_array( $defaultSkin, $skinNames ) ) {
- return $defaultSkin;
- } else {
- return $skinNames[0];
- }
- }
- /**
- * Installs the auto-detected extensions.
- *
- * @return Status
- */
- protected function includeExtensions() {
- global $IP;
- $exts = $this->getVar( '_Extensions' );
- $IP = $this->getVar( 'IP' );
- // Marker for DatabaseUpdater::loadExtensions so we don't
- // double load extensions
- define( 'MW_EXTENSIONS_LOADED', true );
- /**
- * We need to include DefaultSettings before including extensions to avoid
- * warnings about unset variables. However, the only thing we really
- * want here is $wgHooks['LoadExtensionSchemaUpdates']. This won't work
- * if the extension has hidden hook registration in $wgExtensionFunctions,
- * but we're not opening that can of worms
- * @see https://phabricator.wikimedia.org/T28857
- */
- global $wgAutoloadClasses;
- $wgAutoloadClasses = [];
- $queue = [];
- require "$IP/includes/DefaultSettings.php";
- foreach ( $exts as $e ) {
- if ( file_exists( "$IP/extensions/$e/extension.json" ) ) {
- $queue["$IP/extensions/$e/extension.json"] = 1;
- } else {
- require_once "$IP/extensions/$e/$e.php";
- }
- }
- $registry = new ExtensionRegistry();
- $data = $registry->readFromQueue( $queue );
- $wgAutoloadClasses += $data['autoload'];
- $hooksWeWant = isset( $wgHooks['LoadExtensionSchemaUpdates'] ) ?
- /** @suppress PhanUndeclaredVariable $wgHooks is set by DefaultSettings */
- $wgHooks['LoadExtensionSchemaUpdates'] : [];
- if ( isset( $data['globals']['wgHooks']['LoadExtensionSchemaUpdates'] ) ) {
- $hooksWeWant = array_merge_recursive(
- $hooksWeWant,
- $data['globals']['wgHooks']['LoadExtensionSchemaUpdates']
- );
- }
- // Unset everyone else's hooks. Lord knows what someone might be doing
- // in ParserFirstCallInit (see T29171)
- $GLOBALS['wgHooks'] = [ 'LoadExtensionSchemaUpdates' => $hooksWeWant ];
- return Status::newGood();
- }
- /**
- * Get an array of install steps. Should always be in the format of
- * [
- * 'name' => 'someuniquename',
- * 'callback' => [ $obj, 'method' ],
- * ]
- * There must be a config-install-$name message defined per step, which will
- * be shown on install.
- *
- * @param DatabaseInstaller $installer DatabaseInstaller so we can make callbacks
- * @return array
- */
- protected function getInstallSteps( DatabaseInstaller $installer ) {
- $coreInstallSteps = [
- [ 'name' => 'database', 'callback' => [ $installer, 'setupDatabase' ] ],
- [ 'name' => 'tables', 'callback' => [ $installer, 'createTables' ] ],
- [ 'name' => 'interwiki', 'callback' => [ $installer, 'populateInterwikiTable' ] ],
- [ 'name' => 'stats', 'callback' => [ $this, 'populateSiteStats' ] ],
- [ 'name' => 'keys', 'callback' => [ $this, 'generateKeys' ] ],
- [ 'name' => 'updates', 'callback' => [ $installer, 'insertUpdateKeys' ] ],
- [ '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;
- }
- /**
- * Actually perform the installation.
- *
- * @param callable $startCB A callback array for the beginning of each step
- * @param callable $endCB A callback array for the end of each step
- *
- * @return array Array of Status objects
- */
- 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;
- }
- }
- if ( $status->isOk() ) {
- $this->showMessage(
- 'config-install-success',
- $this->getVar( 'wgServer' ),
- $this->getVar( 'wgScriptPath' )
- );
- $this->setVar( '_InstallDone', true );
- }
- return $installResults;
- }
- /**
- * Generate $wgSecretKey. Will warn if we had to use an insecure random source.
- *
- * @return Status
- */
- public function generateKeys() {
- $keys = [ 'wgSecretKey' => 64 ];
- if ( strval( $this->getVar( 'wgUpgradeKey' ) ) === '' ) {
- $keys['wgUpgradeKey'] = 16;
- }
- return $this->doGenerateKeys( $keys );
- }
- /**
- * Generate a secret value for variables using our CryptRand generator.
- * Produce a warning if the random source was insecure.
- *
- * @param array $keys
- * @return Status
- */
- protected function doGenerateKeys( $keys ) {
- $status = Status::newGood();
- $strong = true;
- foreach ( $keys as $name => $length ) {
- $secretKey = MWCryptRand::generateHex( $length, true );
- if ( !MWCryptRand::wasStrong() ) {
- $strong = false;
- }
- $this->setVar( $name, $secretKey );
- }
- if ( !$strong ) {
- $names = array_keys( $keys );
- $names = preg_replace( '/^(.*)$/', '\$$1', $names );
- global $wgLang;
- $status->warning( 'config-insecure-keys', $wgLang->listToText( $names ), count( $names ) );
- }
- return $status;
- }
- /**
- * Create the first user account, grant it sysop and bureaucrat rights
- *
- * @return Status
- */
- 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();
- try {
- $user->setPassword( $this->getVar( '_AdminPassword' ) );
- } catch ( PasswordError $pwe ) {
- return Status::newFatal( 'config-admin-error-password', $name, $pwe->getMessage() );
- }
- $user->addGroup( 'sysop' );
- $user->addGroup( 'bureaucrat' );
- if ( $this->getVar( '_AdminEmail' ) ) {
- $user->setEmail( $this->getVar( '_AdminEmail' ) );
- }
- $user->saveSettings();
- // Update user count
- $ssUpdate = SiteStatsUpdate::factory( [ 'users' => 1 ] );
- $ssUpdate->doUpdate();
- }
- $status = Status::newGood();
- if ( $this->getVar( '_Subscribe' ) && $this->getVar( '_AdminEmail' ) ) {
- $this->subscribeToMediaWikiAnnounce( $status );
- }
- return $status;
- }
- /**
- * @param Status $s
- */
- private function subscribeToMediaWikiAnnounce( Status $s ) {
- $params = [
- 'email' => $this->getVar( '_AdminEmail' ),
- 'language' => 'en',
- 'digest' => 0
- ];
- // Mailman doesn't support as many languages as we do, so check to make
- // sure their selected language is available
- $myLang = $this->getVar( '_UserLang' );
- if ( in_array( $myLang, $this->mediaWikiAnnounceLanguages ) ) {
- $myLang = $myLang == 'pt-br' ? 'pt_BR' : $myLang; // rewrite to Mailman's pt_BR
- $params['language'] = $myLang;
- }
- if ( MWHttpRequest::canMakeRequests() ) {
- $res = MWHttpRequest::factory( $this->mediaWikiAnnounceUrl,
- [ 'method' => 'POST', 'postData' => $params ], __METHOD__ )->execute();
- if ( !$res->isOK() ) {
- $s->warning( 'config-install-subscribe-fail', $res->getMessage() );
- }
- } else {
- $s->warning( 'config-install-subscribe-notpossible' );
- }
- }
- /**
- * Insert Main Page with default content.
- *
- * @param DatabaseInstaller $installer
- * @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 = WikiPage::factory( $title );
- $content = new WikitextContent(
- wfMessage( 'mainpagetext' )->inContentLanguage()->text() . "\n\n" .
- wfMessage( 'mainpagedocfooter' )->inContentLanguage()->text()
- );
- $status = $page->doEditContent( $content,
- '',
- EDIT_NEW,
- false,
- User::newFromName( 'MediaWiki default' )
- );
- } catch ( Exception $e ) {
- // using raw, because $wgShowExceptionDetails can not be set yet
- $status->fatal( 'config-install-mainpage-failed', $e->getMessage() );
- }
- return $status;
- }
- /**
- * Override the necessary bits of the config to run an installation.
- */
- public static function overrideConfig() {
- // Use PHP's built-in session handling, since MediaWiki's
- // SessionHandler can't work before we have an object cache set up.
- define( 'MW_NO_SESSION_HANDLER', 1 );
- // Don't access the database
- $GLOBALS['wgUseDatabaseMessages'] = false;
- // Don't cache langconv tables
- $GLOBALS['wgLanguageConverterCacheType'] = CACHE_NONE;
- // Debug-friendly
- $GLOBALS['wgShowExceptionDetails'] = true;
- // Don't break forms
- $GLOBALS['wgExternalLinkTarget'] = '_blank';
- // Extended debugging
- $GLOBALS['wgShowSQLErrors'] = true;
- $GLOBALS['wgShowDBErrorBacktrace'] = true;
- // Allow multiple ob_flush() calls
- $GLOBALS['wgDisableOutputCompression'] = true;
- // Use a sensible cookie prefix (not my_wiki)
- $GLOBALS['wgCookiePrefix'] = 'mw_installer';
- // Some of the environment checks make shell requests, remove limits
- $GLOBALS['wgMaxShellMemory'] = 0;
- // Override the default CookieSessionProvider with a dummy
- // implementation that won't stomp on PHP's cookies.
- $GLOBALS['wgSessionProviders'] = [
- [
- 'class' => InstallerSessionProvider::class,
- 'args' => [ [
- 'priority' => 1,
- ] ]
- ]
- ];
- // Don't try to use any object cache for SessionManager either.
- $GLOBALS['wgSessionCacheType'] = CACHE_NONE;
- }
- /**
- * Add an installation step following the given step.
- *
- * @param callable $callback A valid installation callback array, in this form:
- * [ 'name' => 'some-unique-name', 'callback' => [ $obj, 'function' ] ];
- * @param string $findStep The step to find. Omit to put the step at the beginning
- */
- public function addInstallStep( $callback, $findStep = 'BEGINNING' ) {
- $this->extraInstallSteps[$findStep][] = $callback;
- }
- /**
- * Disable the time limit for execution.
- * Some long-running pages (Install, Upgrade) will want to do this
- */
- protected function disableTimeLimit() {
- Wikimedia\suppressWarnings();
- set_time_limit( 0 );
- Wikimedia\restoreWarnings();
- }
- }
|