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 require_once "$IP/includes/PreConfigSetup.php";
  59
  60 if ( defined( 'MW_CONFIG_CALLBACK' ) ) {
  61         # Use a callback function to configure MediaWiki
  62         call_user_func( MW_CONFIG_CALLBACK );
  63 } else {
  64         // Require the configuration (probably LocalSettings.php)
  65         require $maintenance->loadSettings();
  66 }
  67
  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 // Some last includes
  79 require_once "$IP/includes/Setup.php";
  80
  81 // Initialize main config instance
  82 $maintenance->setConfig( MediaWikiServices::getInstance()->getMainConfig() );
  83
  84 // Sanity-check required extensions are installed
  85 $maintenance->checkRequiredExtensions();
  86
  87 // A good time when no DBs have writes pending is around lag checks.
  88 // This avoids having long running scripts just OOM and lose all the updates.
  89 $maintenance->setAgentAndTriggers();
  90
  91 // Do the work
  92 $maintenance->execute();
  93
  94 // Potentially debug globals
  95 $maintenance->globals();
  96
  97 if ( $maintenance->getDbType() !== Maintenance::DB_NONE ) {
  98         // Perform deferred updates.
  99         $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
 100         $lbFactory->commitMasterChanges( $maintClass );
 101         DeferredUpdates::doUpdates();
 102 }
 103
 104 // log profiling info
 105 wfLogProfilingData();
 106
 107 if ( isset( $lbFactory ) ) {
 108         // Commit and close up!
 109         $lbFactory->commitMasterChanges( 'doMaintenance' );
 110         $lbFactory->shutdown( $lbFactory::SHUTDOWN_NO_CHRONPROT );
 111 }