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
  29 if ( !defined( 'RUN_MAINTENANCE_IF_MAIN' ) ) {
  30         echo "This file must be included after Maintenance.php\n";
  31         exit( 1 );
  32 }
  33
  34 // Wasn't included from the file scope, halt execution (probably wanted the class)
  35 // If a class is using commandLine.inc (old school maintenance), they definitely
  36 // cannot be included and will proceed with execution
  37 if ( !Maintenance::shouldExecute() && $maintClass != 'CommandLineInc' ) {
  38         return;
  39 }
  40
  41 if ( !$maintClass || !class_exists( $maintClass ) ) {
  42         echo "\$maintClass is not set or is set to a non-existent class.\n";
  43         exit( 1 );
  44 }
  45
  46 // Get an object to start us off
  47 $maintenance = new $maintClass();
  48
  49 // Basic sanity checks and such
  50 $maintenance->setup();
  51
  52 // We used to call this variable $self, but it was moved
  53 // to $maintenance->mSelf. Keep that here for b/c
  54 $self = $maintenance->getName();
  55
  56 # Start the autoloader, so that extensions can derive classes from core files
  57 require_once "$IP/includes/AutoLoader.php";
  58 # Stub the profiler
  59 require_once "$IP/includes/profiler/Profiler.php";
  60
  61 # Start the profiler
  62 $wgProfiler = array();
  63 if ( file_exists( "$IP/StartProfiler.php" ) ) {
  64         require "$IP/StartProfiler.php";
  65 }
  66
  67 // Some other requires
  68 require_once "$IP/includes/Defines.php";
  69 require_once "$IP/includes/DefaultSettings.php";
  70
  71 # Load composer's autoloader if present
  72 if ( is_readable( "$IP/vendor/autoload.php" ) ) {
  73         require_once "$IP/vendor/autoload.php";
  74 }
  75
  76 if ( defined( 'MW_CONFIG_CALLBACK' ) ) {
  77         # Use a callback function to configure MediaWiki
  78         call_user_func( MW_CONFIG_CALLBACK );
  79 } else {
  80         if ( file_exists( "$IP/../wmf-config/wikimedia-mode" ) ) {
  81                 // Load settings, using wikimedia-mode if needed
  82                 // @todo FIXME: Replace this hack with general farm-friendly code
  83                 # @todo FIXME: Wikimedia-specific stuff needs to go away to an ext
  84                 # Maybe a hook?
  85                 // @codingStandardsIgnoreStart MediaWiki.NamingConventions.ValidGlobalName.wgPrefix
  86                 global $cluster;
  87                 $cluster = 'pmtpa';
  88                 // @codingStandardsIgnoreEnd
  89                 require "$IP/../wmf-config/wgConf.php";
  90         }
  91         // Require the configuration (probably LocalSettings.php)
  92         require $maintenance->loadSettings();
  93 }
  94
  95 if ( $maintenance->getDbType() === Maintenance::DB_NONE ) {
  96         if ( $wgLocalisationCacheConf['storeClass'] === false
  97                 && ( $wgLocalisationCacheConf['store'] == 'db'
  98                         || ( $wgLocalisationCacheConf['store'] == 'detect' && !$wgCacheDirectory ) )
  99         ) {
 100                 $wgLocalisationCacheConf['storeClass'] = 'LCStoreNull';
 101         }
 102 }
 103 $maintenance->finalSetup();
 104 // Some last includes
 105 require_once "$IP/includes/Setup.php";
 106
 107 // Do the work
 108 try {
 109         $maintenance->execute();
 110
 111         // Potentially debug globals
 112         $maintenance->globals();
 113
 114         // Perform deferred updates.
 115         DeferredUpdates::doUpdates( 'commit' );
 116
 117         // log profiling info
 118         wfLogProfilingData();
 119
 120         // Commit and close up!
 121         $factory = wfGetLBFactory();
 122         $factory->commitMasterChanges();
 123         $factory->shutdown();
 124 } catch ( MWException $mwe ) {
 125         echo $mwe->getText();
 126         exit( 1 );
 127 }