Setup.php

Go to the documentation of this file.

<?php
if ( !defined( 'MEDIAWIKI' ) ) {
    exit( 1 );
}

$fname = 'Setup.php';
wfProfileIn( $fname );
wfProfileIn( $fname . '-defaults' );

// Check to see if we are at the file scope
if ( !isset( $wgVersion ) ) {
    echo "Error, Setup.php must be included from the file scope, after DefaultSettings.php\n";
    die( 1 );
}

// Set various default paths sensibly...

if ( $wgScript === false ) {
    $wgScript = "$wgScriptPath/index$wgScriptExtension";
}
if ( $wgLoadScript === false ) {
    $wgLoadScript = "$wgScriptPath/load$wgScriptExtension";
}

if ( $wgArticlePath === false ) {
    if ( $wgUsePathInfo ) {
        $wgArticlePath = "$wgScript/$1";
    } else {
        $wgArticlePath = "$wgScript?title=$1";
    }
}

if ( !empty( $wgActionPaths ) && !isset( $wgActionPaths['view'] ) ) {
    // 'view' is assumed the default action path everywhere in the code
    // but is rarely filled in $wgActionPaths
    $wgActionPaths['view'] = $wgArticlePath;
}

if ( $wgStylePath === false ) {
    $wgStylePath = "$wgScriptPath/skins";
}
if ( $wgLocalStylePath === false ) {
    $wgLocalStylePath = "$wgScriptPath/skins";
}
if ( $wgStyleDirectory === false ) {
    $wgStyleDirectory = "$IP/skins";
}
if ( $wgExtensionAssetsPath === false ) {
    $wgExtensionAssetsPath = "$wgScriptPath/extensions";
}
if ( $wgResourceBasePath === null ) {
    $wgResourceBasePath = $wgScriptPath;
}

if ( $wgLogo === false ) {
    $wgLogo = "$wgResourceBasePath/resources/assets/wiki.png";
}

if ( $wgUploadPath === false ) {
    $wgUploadPath = "$wgScriptPath/images";
}
if ( $wgUploadDirectory === false ) {
    $wgUploadDirectory = "$IP/images";
}
if ( $wgReadOnlyFile === false ) {
    $wgReadOnlyFile = "{$wgUploadDirectory}/lock_yBgMBwiR";
}
if ( $wgFileCacheDirectory === false ) {
    $wgFileCacheDirectory = "{$wgUploadDirectory}/cache";
}
if ( $wgDeletedDirectory === false ) {
    $wgDeletedDirectory = "{$wgUploadDirectory}/deleted";
}

if ( $wgGitInfoCacheDirectory === false && $wgCacheDirectory !== false ) {
    $wgGitInfoCacheDirectory = "{$wgCacheDirectory}/gitinfo";
}

// Fix path to icon images after they were moved in 1.24
if ( $wgRightsIcon ) {
    $wgRightsIcon = str_replace(
        "{$wgStylePath}/common/images/",
        "{$wgResourceBasePath}/resources/assets/licenses/",
        $wgRightsIcon
    );
}

if ( isset( $wgFooterIcons['copyright'] )
    && isset( $wgFooterIcons['copyright']['copyright'] )
    && $wgFooterIcons['copyright']['copyright'] === array()
) {
    if ( $wgCopyrightIcon ) {
        $wgFooterIcons['copyright']['copyright'] = $wgCopyrightIcon;
    } elseif ( $wgRightsIcon || $wgRightsText ) {
        $wgFooterIcons['copyright']['copyright'] = array(
            'url' => $wgRightsUrl,
            'src' => $wgRightsIcon,
            'alt' => $wgRightsText,
        );
    } else {
        unset( $wgFooterIcons['copyright']['copyright'] );
    }
}

if ( isset( $wgFooterIcons['poweredby'] )
    && isset( $wgFooterIcons['poweredby']['mediawiki'] )
    && $wgFooterIcons['poweredby']['mediawiki']['src'] === null
) {
    $wgFooterIcons['poweredby']['mediawiki']['src'] =
        "$wgResourceBasePath/resources/assets/poweredby_mediawiki_88x31.png";
}

$wgNamespaceProtection[NS_MEDIAWIKI] = 'editinterface';

$wgNamespaceAliases['Image'] = NS_FILE;
$wgNamespaceAliases['Image_talk'] = NS_FILE_TALK;

$wgLockManagers[] = array(
    'name' => 'fsLockManager',
    'class' => 'FSLockManager',
    'lockDirectory' => "{$wgUploadDirectory}/lockdir",
);
$wgLockManagers[] = array(
    'name' => 'nullLockManager',
    'class' => 'NullLockManager',
);

if ( !$wgLocalFileRepo ) {
    $wgLocalFileRepo = array(
        'class' => 'LocalRepo',
        'name' => 'local',
        'directory' => $wgUploadDirectory,
        'scriptDirUrl' => $wgScriptPath,
        'scriptExtension' => $wgScriptExtension,
        'url' => $wgUploadBaseUrl ? $wgUploadBaseUrl . $wgUploadPath : $wgUploadPath,
        'hashLevels' => $wgHashedUploadDirectory ? 2 : 0,
        'thumbScriptUrl' => $wgThumbnailScriptPath,
        'transformVia404' => !$wgGenerateThumbnailOnParse,
        'deletedDir' => $wgDeletedDirectory,
        'deletedHashLevels' => $wgHashedUploadDirectory ? 3 : 0
    );
}
if ( $wgUseSharedUploads ) {
    if ( $wgSharedUploadDBname ) {
        $wgForeignFileRepos[] = array(
            'class' => 'ForeignDBRepo',
            'name' => 'shared',
            'directory' => $wgSharedUploadDirectory,
            'url' => $wgSharedUploadPath,
            'hashLevels' => $wgHashedSharedUploadDirectory ? 2 : 0,
            'thumbScriptUrl' => $wgSharedThumbnailScriptPath,
            'transformVia404' => !$wgGenerateThumbnailOnParse,
            'dbType' => $wgDBtype,
            'dbServer' => $wgDBserver,
            'dbUser' => $wgDBuser,
            'dbPassword' => $wgDBpassword,
            'dbName' => $wgSharedUploadDBname,
            'dbFlags' => ( $wgDebugDumpSql ? DBO_DEBUG : 0 ) | DBO_DEFAULT,
            'tablePrefix' => $wgSharedUploadDBprefix,
            'hasSharedCache' => $wgCacheSharedUploads,
            'descBaseUrl' => $wgRepositoryBaseUrl,
            'fetchDescription' => $wgFetchCommonsDescriptions,
        );
    } else {
        $wgForeignFileRepos[] = array(
            'class' => 'FileRepo',
            'name' => 'shared',
            'directory' => $wgSharedUploadDirectory,
            'url' => $wgSharedUploadPath,
            'hashLevels' => $wgHashedSharedUploadDirectory ? 2 : 0,
            'thumbScriptUrl' => $wgSharedThumbnailScriptPath,
            'transformVia404' => !$wgGenerateThumbnailOnParse,
            'descBaseUrl' => $wgRepositoryBaseUrl,
            'fetchDescription' => $wgFetchCommonsDescriptions,
        );
    }
}
if ( $wgUseInstantCommons ) {
    $wgForeignFileRepos[] = array(
        'class' => 'ForeignAPIRepo',
        'name' => 'wikimediacommons',
        'apibase' => WebRequest::detectProtocol() === 'https' ?
            'https://commons.wikimedia.org/w/api.php' :
            'http://commons.wikimedia.org/w/api.php',
        'hashLevels' => 2,
        'fetchDescription' => true,
        'descriptionCacheExpiry' => 43200,
        'apiThumbCacheExpiry' => 86400,
    );
}
/*
 * Add on default file backend config for file repos.
 * FileBackendGroup will handle initializing the backends.
 */
if ( !isset( $wgLocalFileRepo['backend'] ) ) {
    $wgLocalFileRepo['backend'] = $wgLocalFileRepo['name'] . '-backend';
}
foreach ( $wgForeignFileRepos as &$repo ) {
    if ( !isset( $repo['directory'] ) && $repo['class'] === 'ForeignAPIRepo' ) {
        $repo['directory'] = $wgUploadDirectory; // b/c
    }
    if ( !isset( $repo['backend'] ) ) {
        $repo['backend'] = $repo['name'] . '-backend';
    }
}
unset( $repo ); // no global pollution; destroy reference

if ( $wgRCFilterByAge ) {
    // Trim down $wgRCLinkDays so that it only lists links which are valid
    // as determined by $wgRCMaxAge.
    // Note that we allow 1 link higher than the max for things like 56 days but a 60 day link.
    sort( $wgRCLinkDays );

    // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
    for ( $i = 0; $i < count( $wgRCLinkDays ); $i++ ) {
        // @codingStandardsIgnoreEnd
        if ( $wgRCLinkDays[$i] >= $wgRCMaxAge / ( 3600 * 24 ) ) {
            $wgRCLinkDays = array_slice( $wgRCLinkDays, 0, $i + 1, false );
            break;
        }
    }
}

if ( $wgSkipSkin ) {
    $wgSkipSkins[] = $wgSkipSkin;
}

// Register skins
// Use a closure to avoid leaking into global state
call_user_func( function () use ( $wgValidSkinNames ) {
    $factory = SkinFactory::getDefaultInstance();
    foreach ( $wgValidSkinNames as $name => $skin ) {
        $factory->register( $name, $skin, function () use ( $name, $skin ) {
            $class = "Skin$skin";
            return new $class( $name );
        } );
    }
    // Register a hidden "fallback" skin
    $factory->register( 'fallback', 'Fallback', function () {
        return new SkinFallback;
    } );
} );
$wgSkipSkins[] = 'fallback';

if ( $wgLocalInterwiki ) {
    array_unshift( $wgLocalInterwikis, $wgLocalInterwiki );
}

// Set default shared prefix
if ( $wgSharedPrefix === false ) {
    $wgSharedPrefix = $wgDBprefix;
}

if ( !$wgCookiePrefix ) {
    if ( $wgSharedDB && $wgSharedPrefix && in_array( 'user', $wgSharedTables ) ) {
        $wgCookiePrefix = $wgSharedDB . '_' . $wgSharedPrefix;
    } elseif ( $wgSharedDB && in_array( 'user', $wgSharedTables ) ) {
        $wgCookiePrefix = $wgSharedDB;
    } elseif ( $wgDBprefix ) {
        $wgCookiePrefix = $wgDBname . '_' . $wgDBprefix;
    } else {
        $wgCookiePrefix = $wgDBname;
    }
}
$wgCookiePrefix = strtr( $wgCookiePrefix, '=,; +."\'\\[', '__________' );

if ( $wgEnableEmail ) {
    $wgUseEnotif = $wgEnotifUserTalk || $wgEnotifWatchlist;
} else {
    // Disable all other email settings automatically if $wgEnableEmail
    // is set to false. - bug 63678
    $wgAllowHTMLEmail = false;
    $wgEmailAuthentication = false; // do not require auth if you're not sending email anyway
    $wgEnableUserEmail = false;
    $wgEnotifFromEditor = false;
    $wgEnotifImpersonal = false;
    $wgEnotifMaxRecips = 0;
    $wgEnotifMinorEdits = false;
    $wgEnotifRevealEditorAddress = false;
    $wgEnotifUseJobQ = false;
    $wgEnotifUseRealName = false;
    $wgEnotifUserTalk = false;
    $wgEnotifWatchlist = false;
    unset( $wgGroupPermissions['user']['sendemail'] );
    $wgUseEnotif = false;
    $wgUserEmailUseReplyTo = false;
    $wgUsersNotifiedOnAllChanges = array();
}

// Doesn't make sense to have if disabled.
if ( !$wgEnotifMinorEdits ) {
    $wgHiddenPrefs[] = 'enotifminoredits';
}

if ( $wgMetaNamespace === false ) {
    $wgMetaNamespace = str_replace( ' ', '_', $wgSitename );
}

// Default value is either the suhosin limit or -1 for unlimited
if ( $wgResourceLoaderMaxQueryLength === false ) {
    $maxValueLength = ini_get( 'suhosin.get.max_value_length' );
    $wgResourceLoaderMaxQueryLength = $maxValueLength > 0 ? $maxValueLength : -1;
}

$wgCanonicalNamespaceNames = array(
    NS_MEDIA            => 'Media',
    NS_SPECIAL          => 'Special',
    NS_TALK             => 'Talk',
    NS_USER             => 'User',
    NS_USER_TALK        => 'User_talk',
    NS_PROJECT          => 'Project',
    NS_PROJECT_TALK     => 'Project_talk',
    NS_FILE             => 'File',
    NS_FILE_TALK        => 'File_talk',
    NS_MEDIAWIKI        => 'MediaWiki',
    NS_MEDIAWIKI_TALK   => 'MediaWiki_talk',
    NS_TEMPLATE         => 'Template',
    NS_TEMPLATE_TALK    => 'Template_talk',
    NS_HELP             => 'Help',
    NS_HELP_TALK        => 'Help_talk',
    NS_CATEGORY         => 'Category',
    NS_CATEGORY_TALK    => 'Category_talk',
);

if ( is_array( $wgExtraNamespaces ) ) {
    $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
}

// These are now the same, always
// To determine the user language, use $wgLang->getCode()
$wgContLanguageCode = $wgLanguageCode;

// Easy to forget to falsify $wgShowIPinHeader for static caches.
// If file cache or squid cache is on, just disable this (DWIMD).
// Do the same for $wgDebugToolbar.
if ( $wgUseFileCache || $wgUseSquid ) {
    $wgShowIPinHeader = false;
    $wgDebugToolbar = false;
}

// We always output HTML5 since 1.22, overriding these is no longer supported
// we set them here for extensions that depend on its value.
$wgHtml5 = true;
$wgXhtmlDefaultNamespace = 'http://www.w3.org/1999/xhtml';
$wgJsMimeType = 'text/javascript';

if ( !$wgHtml5Version && $wgAllowRdfaAttributes ) {
    // see http://www.w3.org/TR/rdfa-in-html/#document-conformance
    if ( $wgMimeType == 'application/xhtml+xml' ) {
        $wgHtml5Version = 'XHTML+RDFa 1.0';
    } else {
        $wgHtml5Version = 'HTML+RDFa 1.0';
    }
}

// Blacklisted file extensions shouldn't appear on the "allowed" list
$wgFileExtensions = array_values( array_diff ( $wgFileExtensions, $wgFileBlacklist ) );

if ( $wgInvalidateCacheOnLocalSettingsChange ) {
    // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged - No GlobalFunction here yet.
    $wgCacheEpoch = max( $wgCacheEpoch, gmdate( 'YmdHis', @filemtime( "$IP/LocalSettings.php" ) ) );
    // @codingStandardsIgnoreEnd
}

if ( $wgNewUserLog ) {
    // Add a new log type
    $wgLogTypes[] = 'newusers';
    $wgLogNames['newusers'] = 'newuserlogpage';
    $wgLogHeaders['newusers'] = 'newuserlogpagetext';
    $wgLogActionsHandlers['newusers/newusers'] = 'NewUsersLogFormatter';
    $wgLogActionsHandlers['newusers/create'] = 'NewUsersLogFormatter';
    $wgLogActionsHandlers['newusers/create2'] = 'NewUsersLogFormatter';
    $wgLogActionsHandlers['newusers/byemail'] = 'NewUsersLogFormatter';
    $wgLogActionsHandlers['newusers/autocreate'] = 'NewUsersLogFormatter';
}

if ( $wgPageLanguageUseDB ) {
    $wgLogTypes[] = 'pagelang';
    $wgLogActionsHandlers['pagelang/pagelang'] = 'PageLangLogFormatter';
}

if ( $wgCookieSecure === 'detect' ) {
    $wgCookieSecure = ( WebRequest::detectProtocol() === 'https' );
}

// Back compatibility for $wgRateLimitLog deprecated with 1.23
if ( $wgRateLimitLog && !array_key_exists( 'ratelimit', $wgDebugLogGroups ) ) {
    $wgDebugLogGroups['ratelimit'] = $wgRateLimitLog;
}

if ( $wgProfileOnly ) {
    $wgDebugLogGroups['profileoutput'] = $wgDebugLogFile;
    $wgDebugLogFile = '';
}

wfProfileOut( $fname . '-defaults' );

// Disable MWDebug for command line mode, this prevents MWDebug from eating up
// all the memory from logging SQL queries on maintenance scripts
global $wgCommandLineMode;
if ( $wgDebugToolbar && !$wgCommandLineMode ) {
    wfProfileIn( $fname . '-debugtoolbar' );
    MWDebug::init();
    wfProfileOut( $fname . '-debugtoolbar' );
}

if ( !class_exists( 'AutoLoader' ) ) {
    require_once "$IP/includes/AutoLoader.php";
}

wfProfileIn( $fname . '-exception' );
MWExceptionHandler::installHandler();
wfProfileOut( $fname . '-exception' );

wfProfileIn( $fname . '-includes' );
require_once "$IP/includes/normal/UtfNormalUtil.php";
require_once "$IP/includes/GlobalFunctions.php";
require_once "$IP/includes/normal/UtfNormalDefines.php";
wfProfileOut( $fname . '-includes' );

wfProfileIn( $fname . '-defaults2' );

if ( $wgCanonicalServer === false ) {
    $wgCanonicalServer = wfExpandUrl( $wgServer, PROTO_HTTP );
}

// Set server name
$serverParts = wfParseUrl( $wgCanonicalServer );
if ( $wgServerName !== false ) {
    wfWarn( '$wgServerName should be derived from $wgCanonicalServer, '
        . 'not customized. Overwriting $wgServerName.' );
}
$wgServerName = $serverParts['host'];
unset( $serverParts );

// Set defaults for configuration variables
// that are derived from the server name by default
if ( $wgEmergencyContact === false ) {
    $wgEmergencyContact = 'wikiadmin@' . $wgServerName;
}

if ( $wgPasswordSender === false ) {
    $wgPasswordSender = 'apache@' . $wgServerName;
}

if ( $wgSecureLogin && substr( $wgServer, 0, 2 ) !== '//' ) {
    $wgSecureLogin = false;
    wfWarn( 'Secure login was enabled on a server that only supports '
        . 'HTTP or HTTPS. Disabling secure login.' );
}

// Now that GlobalFunctions is loaded, set defaults that depend
// on it.
if ( $wgTmpDirectory === false ) {
    wfProfileIn( $fname . '-tempDir' );
    $wgTmpDirectory = wfTempDir();
    wfProfileOut( $fname . '-tempDir' );
}

wfProfileOut( $fname . '-defaults2' );
wfProfileIn( $fname . '-misc1' );

// Raise the memory limit if it's too low
wfMemoryLimit();

if ( is_null( $wgLocaltimezone ) ) {
    wfSuppressWarnings();
    $wgLocaltimezone = date_default_timezone_get();
    wfRestoreWarnings();
}

date_default_timezone_set( $wgLocaltimezone );
if ( is_null( $wgLocalTZoffset ) ) {
    $wgLocalTZoffset = date( 'Z' ) / 60;
}

// Useful debug output
if ( $wgCommandLineMode ) {
    $wgRequest = new FauxRequest( array() );

    wfDebug( "\n\nStart command line script $self\n" );
} else {
    // Can't stub this one, it sets up $_GET and $_REQUEST in its constructor
    $wgRequest = new WebRequest;

    $debug = "\n\nStart request {$wgRequest->getMethod()} {$wgRequest->getRequestURL()}\n";

    if ( $wgDebugPrintHttpHeaders ) {
        $debug .= "HTTP HEADERS:\n";

        foreach ( $wgRequest->getAllHeaders() as $name => $value ) {
            $debug .= "$name: $value\n";
        }
    }
    wfDebug( $debug );
}

wfProfileOut( $fname . '-misc1' );
wfProfileIn( $fname . '-memcached' );

$wgMemc = wfGetMainCache();
$messageMemc = wfGetMessageCacheStorage();
$parserMemc = wfGetParserCacheStorage();
$wgLangConvMemc = wfGetLangConverterCacheStorage();

wfDebugLog( 'caches', 'main: ' . get_class( $wgMemc ) .
    ', message: ' . get_class( $messageMemc ) .
    ', parser: ' . get_class( $parserMemc ) );

wfProfileOut( $fname . '-memcached' );

// Most of the config is out, some might want to run hooks here.
wfRunHooks( 'SetupAfterCache' );

wfProfileIn( $fname . '-session' );

if ( !defined( 'MW_NO_SESSION' ) && !$wgCommandLineMode ) {
    // If session.auto_start is there, we can't touch session name
    if ( !wfIniGetBool( 'session.auto_start' ) ) {
        session_name( $wgSessionName ? $wgSessionName : $wgCookiePrefix . '_session' );
    }

    if ( $wgRequest->checkSessionCookie() || isset( $_COOKIE[$wgCookiePrefix . 'Token'] ) ) {
        wfSetupSession();
    }
}

wfProfileOut( $fname . '-session' );
wfProfileIn( $fname . '-globals' );

$wgContLang = Language::factory( $wgLanguageCode );
$wgContLang->initEncoding();
$wgContLang->initContLang();

// Now that variant lists may be available...
$wgRequest->interpolateTitle();

$wgUser = RequestContext::getMain()->getUser(); // BackCompat

$wgLang = new StubUserLang;

$wgOut = RequestContext::getMain()->getOutput(); // BackCompat

$wgParser = new StubObject( 'wgParser', $wgParserConf['class'], array( $wgParserConf ) );

if ( !is_object( $wgAuth ) ) {
    $wgAuth = new AuthPlugin;
    wfRunHooks( 'AuthPluginSetup', array( &$wgAuth ) );
}

$wgTitle = null;

$wgDeferredUpdateList = array();

wfProfileOut( $fname . '-globals' );
wfProfileIn( $fname . '-extensions' );

// Extension setup functions for extensions other than skins
// Entries should be added to this variable during the inclusion
// of the extension file. This allows the extension to perform
// any necessary initialisation in the fully initialised environment
foreach ( $wgExtensionFunctions as $func ) {
    // Allow closures in PHP 5.3+
    if ( is_object( $func ) && $func instanceof Closure ) {
        $profName = $fname . '-extensions-closure';
    } elseif ( is_array( $func ) ) {
        if ( is_object( $func[0] ) ) {
            $profName = $fname . '-extensions-' . get_class( $func[0] ) . '::' . $func[1];
        } else {
            $profName = $fname . '-extensions-' . implode( '::', $func );
        }
    } else {
        $profName = $fname . '-extensions-' . strval( $func );
    }

    wfProfileIn( $profName );
    call_user_func( $func );
    wfProfileOut( $profName );
}

wfDebug( "Fully initialised\n" );
$wgFullyInitialised = true;

wfProfileOut( $fname . '-extensions' );
wfProfileOut( $fname );