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::class ) {
    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();

// Define how settings are loaded (e.g. LocalSettings.php)
if ( !defined( 'MW_CONFIG_CALLBACK' ) && !defined( 'MW_CONFIG_FILE' ) ) {
    define( 'MW_CONFIG_FILE', $maintenance->loadSettings() );
}

// Custom setup for Maintenance entry point
if ( !defined( 'MW_SETUP_CALLBACK' ) ) {

    function wfMaintenanceSetup() {
        // phpcs:ignore MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
        global $maintenance, $wgLocalisationCacheConf, $wgCacheDirectory;
        if ( $maintenance->getDbType() === Maintenance::DB_NONE ) {
            if ( $wgLocalisationCacheConf['storeClass'] === false
                && ( $wgLocalisationCacheConf['store'] == 'db'
                    || ( $wgLocalisationCacheConf['store'] == 'detect' && !$wgCacheDirectory ) )
            ) {
                $wgLocalisationCacheConf['storeClass'] = LCStoreNull::class;
            }
        }

        $maintenance->finalSetup();
    }

    define( 'MW_SETUP_CALLBACK', 'wfMaintenanceSetup' );
}

require_once "$IP/includes/Setup.php";

// Initialize main config instance
$maintenance->setConfig( MediaWikiServices::getInstance()->getMainConfig() );

// 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();

$maintenance->validateParamsAndArgs();

// Do the work
try {
    $success = $maintenance->execute();
} catch ( Exception $ex ) {
    $success = false;
    $exReportMessage = '';
    while ( $ex ) {
        $cls = get_class( $ex );
        $exReportMessage .= "$cls from line {$ex->getLine()} of {$ex->getFile()}: {$ex->getMessage()}\n";
        $exReportMessage .= $ex->getTraceAsString() . "\n";
        $ex = $ex->getPrevious();
    }
    // Print the exception to stderr if possible, don't mix it in
    // with stdout output.
    if ( defined( 'STDERR' ) ) {
        fwrite( STDERR, $exReportMessage );
    } else {
        echo $exReportMessage;
    }
}

// Potentially debug globals
$maintenance->globals();

if ( $maintenance->getDbType() !== Maintenance::DB_NONE &&
    // Service might be disabled, e.g. when running install.php
    !MediaWikiServices::getInstance()->isServiceDisabled( 'DBLoadBalancerFactory' )
) {
    // Perform deferred updates.
    $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
    $lbFactory->commitMasterChanges( $maintClass );
    DeferredUpdates::doUpdates();
}

// log profiling info
wfLogProfilingData();

if ( isset( $lbFactory ) ) {
    // Commit and close up!
    $lbFactory->commitMasterChanges( 'doMaintenance' );
    $lbFactory->shutdown( $lbFactory::SHUTDOWN_NO_CHRONPROT );
}

// Exit with an error status if execute() returned false
if ( $success === false ) {
    exit( 1 );
}