maintenance/doMaintenance.php

   1 <?php
   2 /**
   3  * We want to make this whole thing as seamless as possible to the
   4  * end-user. Unfortunately, we can't do _all_ of the work in the class
   5  * because A) included files are not in global scope, but in the scope
   6  * of their caller, and B) MediaWiki has way too many globals. So instead
   7  * we'll kinda fake it, and do the requires() inline. <3 PHP
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @author Chad Horohoe <chad@anyonecanedit.org>
  25  * @file
  26  * @ingroup Maintenance
  27  */
  28 use MediaWiki\MediaWikiServices;
  29
  30 if ( !defined( 'RUN_MAINTENANCE_IF_MAIN' ) ) {
  31         echo "This file must be included after Maintenance.php\n";
  32         exit( 1 );
  33 }
  34
  35 // Wasn't included from the file scope, halt execution (probably wanted the class)
  36 // If a class is using commandLine.inc (old school maintenance), they definitely
  37 // cannot be included and will proceed with execution
  38 if ( !Maintenance::shouldExecute() && $maintClass != 'CommandLineInc' ) {
  39         return;
  40 }
  41
  42 if ( !$maintClass || !class_exists( $maintClass ) ) {
  43         echo "\$maintClass is not set or is set to a non-existent class.\n";
  44         exit( 1 );
  45 }
  46
  47 // Get an object to start us off
  48 /** @var Maintenance $maintenance */
  49 $maintenance = new $maintClass();
  50
  51 // Basic sanity checks and such
  52 $maintenance->setup();
  53
  54 // We used to call this variable $self, but it was moved
  55 // to $maintenance->mSelf. Keep that here for b/c
  56 $self = $maintenance->getName();
  57
  58 // Define how settings are loaded (e.g. LocalSettings.php)
  59 if ( !defined( 'MW_CONFIG_CALLBACK' ) && !defined( 'MW_CONFIG_FILE' ) ) {
  60         define( 'MW_CONFIG_FILE', $maintenance->loadSettings() );
  61 }
  62
  63 // Custom setup for Maintenance entry point
  64 if ( !defined( 'MW_SETUP_CALLBACK' ) ) {
  65         function wfMaintenanceSetup() {
  66                 // @codingStandardsIgnoreLine MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
  67                 global $maintenance, $wgLocalisationCacheConf, $wgCacheDirectory;
  68                 if ( $maintenance->getDbType() === Maintenance::DB_NONE ) {
  69                         if ( $wgLocalisationCacheConf['storeClass'] === false
  70                                 && ( $wgLocalisationCacheConf['store'] == 'db'
  71                                         || ( $wgLocalisationCacheConf['store'] == 'detect' && !$wgCacheDirectory ) )
  72                         ) {
  73                                 $wgLocalisationCacheConf['storeClass'] = 'LCStoreNull';
  74                         }
  75                 }
  76
  77                 $maintenance->finalSetup();
  78         }
  79         define( 'MW_SETUP_CALLBACK', 'wfMaintenanceSetup' );
  80 }
  81
  82 require_once "$IP/includes/Setup.php";
  83
  84 // Initialize main config instance
  85 $maintenance->setConfig( MediaWikiServices::getInstance()->getMainConfig() );
  86
  87 // Sanity-check required extensions are installed
  88 $maintenance->checkRequiredExtensions();
  89
  90 // A good time when no DBs have writes pending is around lag checks.
  91 // This avoids having long running scripts just OOM and lose all the updates.
  92 $maintenance->setAgentAndTriggers();
  93
  94 // Do the work
  95 $maintenance->execute();
  96
  97 // Potentially debug globals
  98 $maintenance->globals();
  99
 100 if ( $maintenance->getDbType() !== Maintenance::DB_NONE ) {
 101         // Perform deferred updates.
 102         $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 103         $lbFactory->commitMasterChanges( $maintClass );
 104         DeferredUpdates::doUpdates();
 105 }
 106
 107 // log profiling info
 108 wfLogProfilingData();
 109
 110 if ( isset( $lbFactory ) ) {
 111         // Commit and close up!
 112         $lbFactory->commitMasterChanges( 'doMaintenance' );
 113         $lbFactory->shutdown( $lbFactory::SHUTDOWN_NO_CHRONPROT );
 114 }