doMaintenance.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
if ( !defined( 'RUN_MAINTENANCE_IF_MAIN' ) ) {
    echo "This file must be included after Maintenance.php\n";
    exit( 1 );
}
 
// Wasn't included from the file scope, halt execution (probably wanted the class)
// If a class is using commandLine.inc (old school maintenance), they definitely
// cannot be included and will proceed with execution
if ( !Maintenance::shouldExecute() && $maintClass != 'CommandLineInc' ) {
    return;
}
 
if ( !$maintClass || !class_exists( $maintClass ) ) {
    echo "\$maintClass is not set or is set to a non-existent class.\n";
    exit( 1 );
}
 
// Get an object to start us off
$maintenance = new $maintClass();
 
// Basic sanity checks and such
$maintenance->setup();
 
// We used to call this variable $self, but it was moved
// to $maintenance->mSelf. Keep that here for b/c
$self = $maintenance->getName();
 
# Start the autoloader, so that extensions can derive classes from core files
require_once "$IP/includes/AutoLoader.php";
# Grab profiling functions
require_once "$IP/includes/profiler/ProfilerFunctions.php";
 
# Start the profiler
$wgProfiler = [];
if ( file_exists( "$IP/StartProfiler.php" ) ) {
    require "$IP/StartProfiler.php";
}
 
// Some other requires
require_once "$IP/includes/Defines.php";
require_once "$IP/includes/DefaultSettings.php";
require_once "$IP/includes/GlobalFunctions.php";
 
# Load composer's autoloader if present
if ( is_readable( "$IP/vendor/autoload.php" ) ) {
    require_once "$IP/vendor/autoload.php";
}
 
if ( defined( 'MW_CONFIG_CALLBACK' ) ) {
    # Use a callback function to configure MediaWiki
    call_user_func( MW_CONFIG_CALLBACK );
} else {
    // Require the configuration (probably LocalSettings.php)
    require $maintenance->loadSettings();
}
 
if ( $maintenance->getDbType() === Maintenance::DB_NONE ) {
    if ( $wgLocalisationCacheConf['storeClass'] === false
        && ( $wgLocalisationCacheConf['store'] == 'db'
            || ( $wgLocalisationCacheConf['store'] == 'detect' && !$wgCacheDirectory ) )
    ) {
        $wgLocalisationCacheConf['storeClass'] = 'LCStoreNull';
    }
}
 
$maintenance->finalSetup();
// Some last includes
require_once "$IP/includes/Setup.php";
 
// Initialize main config instance
$maintenance->setConfig( ConfigFactory::getDefaultInstance()->makeConfig( 'main' ) );
 
// Sanity-check required extensions are installed
$maintenance->checkRequiredExtensions();
 
// A good time when no DBs have writes pending is around lag checks.
// This avoids having long running scripts just OOM and lose all the updates.
$maintenance->setAgentAndTriggers();
 
// Do the work
$maintenance->execute();
 
// Potentially debug globals
$maintenance->globals();
 
// Perform deferred updates.
$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
$lbFactory->commitMasterChanges( $maintClass );
DeferredUpdates::doUpdates();
 
// log profiling info
wfLogProfilingData();
 
// Commit and close up!
$lbFactory->commitMasterChanges( 'doMaintenance' );
$lbFactory->shutdown( $lbFactory::SHUTDOWN_NO_CHRONPROT );