3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
19 * @ingroup Maintenance
20 * @defgroup Maintenance Maintenance
23 // Make sure we're on PHP5.3.2 or better
24 if ( !function_exists( 'version_compare' ) ||
version_compare( PHP_VERSION
, '5.3.2' ) < 0 ) {
25 // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
26 require_once dirname( __FILE__
) . '/../includes/PHPVersionError.php';
27 wfPHPVersionError( 'cli' );
31 * @defgroup MaintenanceArchive Maintenance archives
32 * @ingroup Maintenance
35 // Define this so scripts can easily find doMaintenance.php
36 define( 'RUN_MAINTENANCE_IF_MAIN', __DIR__
. '/doMaintenance.php' );
37 define( 'DO_MAINTENANCE', RUN_MAINTENANCE_IF_MAIN
); // original name, harmless
42 * Abstract maintenance class for quickly writing and churning out
43 * maintenance scripts with minimal effort. All that _must_ be defined
44 * is the execute() method. See docs/maintenance.txt for more info
45 * and a quick demo of how to use it.
47 * @author Chad Horohoe <chad@anyonecanedit.org>
49 * @ingroup Maintenance
51 abstract class Maintenance
{
54 * Constants for DB access type
55 * @see Maintenance::getDbType()
61 // Const for getStdin()
62 const STDIN_ALL
= 'all';
64 // This is the desired params
65 protected $mParams = array();
67 // Array of mapping short parameters to long ones
68 protected $mShortParamsMap = array();
70 // Array of desired args
71 protected $mArgList = array();
73 // This is the list of options that were actually passed
74 protected $mOptions = array();
76 // This is the list of arguments that were actually passed
77 protected $mArgs = array();
79 // Name of the script currently running
82 // Special vars for params that are always used
83 protected $mQuiet = false;
84 protected $mDbUser, $mDbPass;
86 // A description of the script, children should change this
87 protected $mDescription = '';
89 // Have we already loaded our user input?
90 protected $mInputLoaded = false;
93 * Batch size. If a script supports this, they should set
94 * a default with setBatchSize()
98 protected $mBatchSize = null;
100 // Generic options added by addDefaultParams()
101 private $mGenericParameters = array();
102 // Generic options which might or not be supported by the script
103 private $mDependantParameters = array();
106 * Used by getDD() / setDB()
112 * Used when creating separate schema files.
118 * Default constructor. Children should call this *first* if implementing
119 * their own constructors
121 public function __construct() {
122 // Setup $IP, using MW_INSTALL_PATH if it exists
124 $IP = strval( getenv( 'MW_INSTALL_PATH' ) ) !== ''
125 ?
getenv( 'MW_INSTALL_PATH' )
126 : realpath( __DIR__
. '/..' );
128 $this->addDefaultParams();
129 register_shutdown_function( array( $this, 'outputChanneled' ), false );
133 * Should we execute the maintenance script, or just allow it to be included
134 * as a standalone class? It checks that the call stack only includes this
135 * function and "requires" (meaning was called from the file scope)
139 public static function shouldExecute() {
140 $bt = debug_backtrace();
141 $count = count( $bt );
143 return false; // sanity
145 if ( $bt[0]['class'] !== 'Maintenance' ||
$bt[0]['function'] !== 'shouldExecute' ) {
146 return false; // last call should be to this function
148 $includeFuncs = array( 'require_once', 'require', 'include', 'include_once' );
149 for ( $i = 1; $i < $count; $i++
) {
150 if ( !in_array( $bt[$i]['function'], $includeFuncs ) ) {
151 return false; // previous calls should all be "requires"
158 * Do the actual work. All child classes will need to implement this
160 abstract public function execute();
163 * Add a parameter to the script. Will be displayed on --help
164 * with the associated description
166 * @param $name String: the name of the param (help, version, etc)
167 * @param $description String: the description of the param to show on --help
168 * @param $required Boolean: is the param required?
169 * @param $withArg Boolean: is an argument required with this option?
170 * @param $shortName String: character to use as short name
172 protected function addOption( $name, $description, $required = false, $withArg = false, $shortName = false ) {
173 $this->mParams
[$name] = array( 'desc' => $description, 'require' => $required, 'withArg' => $withArg, 'shortName' => $shortName );
174 if ( $shortName !== false ) {
175 $this->mShortParamsMap
[$shortName] = $name;
180 * Checks to see if a particular param exists.
181 * @param $name String: the name of the param
184 protected function hasOption( $name ) {
185 return isset( $this->mOptions
[$name] );
189 * Get an option, or return the default
190 * @param $name String: the name of the param
191 * @param $default Mixed: anything you want, default null
194 protected function getOption( $name, $default = null ) {
195 if ( $this->hasOption( $name ) ) {
196 return $this->mOptions
[$name];
198 // Set it so we don't have to provide the default again
199 $this->mOptions
[$name] = $default;
200 return $this->mOptions
[$name];
205 * Add some args that are needed
206 * @param $arg String: name of the arg, like 'start'
207 * @param $description String: short description of the arg
208 * @param $required Boolean: is this required?
210 protected function addArg( $arg, $description, $required = true ) {
211 $this->mArgList
[] = array(
213 'desc' => $description,
214 'require' => $required
219 * Remove an option. Useful for removing options that won't be used in your script.
220 * @param $name String: the option to remove.
222 protected function deleteOption( $name ) {
223 unset( $this->mParams
[$name] );
227 * Set the description text.
228 * @param $text String: the text of the description
230 protected function addDescription( $text ) {
231 $this->mDescription
= $text;
235 * Does a given argument exist?
236 * @param $argId Integer: the integer value (from zero) for the arg
239 protected function hasArg( $argId = 0 ) {
240 return isset( $this->mArgs
[$argId] );
245 * @param $argId Integer: the integer value (from zero) for the arg
246 * @param $default Mixed: the default if it doesn't exist
249 protected function getArg( $argId = 0, $default = null ) {
250 return $this->hasArg( $argId ) ?
$this->mArgs
[$argId] : $default;
254 * Set the batch size.
255 * @param $s Integer: the number of operations to do in a batch
257 protected function setBatchSize( $s = 0 ) {
258 $this->mBatchSize
= $s;
260 // If we support $mBatchSize, show the option.
261 // Used to be in addDefaultParams, but in order for that to
262 // work, subclasses would have to call this function in the constructor
263 // before they called parent::__construct which is just weird
264 // (and really wasn't done).
265 if ( $this->mBatchSize
) {
266 $this->addOption( 'batch-size', 'Run this many operations ' .
267 'per batch, default: ' . $this->mBatchSize
, false, true );
268 if ( isset( $this->mParams
['batch-size'] ) ) {
269 // This seems a little ugly...
270 $this->mDependantParameters
['batch-size'] = $this->mParams
['batch-size'];
276 * Get the script's name
279 public function getName() {
284 * Return input from stdin.
285 * @param $len Integer: the number of bytes to read. If null,
286 * just return the handle. Maintenance::STDIN_ALL returns
290 protected function getStdin( $len = null ) {
291 if ( $len == Maintenance
::STDIN_ALL
) {
292 return file_get_contents( 'php://stdin' );
294 $f = fopen( 'php://stdin', 'rt' );
298 $input = fgets( $f, $len );
300 return rtrim( $input );
306 public function isQuiet() {
307 return $this->mQuiet
;
311 * Throw some output to the user. Scripts can call this with no fears,
312 * as we handle all --quiet stuff here
313 * @param $out String: the text to show to the user
314 * @param $channel Mixed: unique identifier for the channel. See
315 * function outputChanneled.
317 protected function output( $out, $channel = null ) {
318 if ( $this->mQuiet
) {
321 if ( $channel === null ) {
322 $this->cleanupChanneled();
325 $out = preg_replace( '/\n\z/', '', $out );
326 $this->outputChanneled( $out, $channel );
331 * Throw an error to the user. Doesn't respect --quiet, so don't use
332 * this for non-error output
333 * @param $err String: the error to display
334 * @param $die Int: if > 0, go ahead and die out using this int as the code
336 protected function error( $err, $die = 0 ) {
337 $this->outputChanneled( false );
338 if ( PHP_SAPI
== 'cli' ) {
339 fwrite( STDERR
, $err . "\n" );
343 $die = intval( $die );
349 private $atLineStart = true;
350 private $lastChannel = null;
353 * Clean up channeled output. Output a newline if necessary.
355 public function cleanupChanneled() {
356 if ( !$this->atLineStart
) {
358 $this->atLineStart
= true;
363 * Message outputter with channeled message support. Messages on the
364 * same channel are concatenated, but any intervening messages in another
365 * channel start a new line.
366 * @param $msg String: the message without trailing newline
367 * @param $channel string Channel identifier or null for no
368 * channel. Channel comparison uses ===.
370 public function outputChanneled( $msg, $channel = null ) {
371 if ( $msg === false ) {
372 $this->cleanupChanneled();
376 // End the current line if necessary
377 if ( !$this->atLineStart
&& $channel !== $this->lastChannel
) {
383 $this->atLineStart
= false;
384 if ( $channel === null ) {
385 // For unchanneled messages, output trailing newline immediately
387 $this->atLineStart
= true;
389 $this->lastChannel
= $channel;
393 * Does the script need different DB access? By default, we give Maintenance
394 * scripts normal rights to the DB. Sometimes, a script needs admin rights
395 * access for a reason and sometimes they want no access. Subclasses should
396 * override and return one of the following values, as needed:
397 * Maintenance::DB_NONE - For no DB access at all
398 * Maintenance::DB_STD - For normal DB access, default
399 * Maintenance::DB_ADMIN - For admin DB access
402 public function getDbType() {
403 return Maintenance
::DB_STD
;
407 * Add the default parameters to the scripts
409 protected function addDefaultParams() {
411 # Generic (non script dependant) options:
413 $this->addOption( 'help', 'Display this help message', false, false, 'h' );
414 $this->addOption( 'quiet', 'Whether to supress non-error output', false, false, 'q' );
415 $this->addOption( 'conf', 'Location of LocalSettings.php, if not default', false, true );
416 $this->addOption( 'wiki', 'For specifying the wiki ID', false, true );
417 $this->addOption( 'globals', 'Output globals at the end of processing for debugging' );
418 $this->addOption( 'memory-limit', 'Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it' );
419 $this->addOption( 'server', "The protocol and server name to use in URLs, e.g. " .
420 "http://en.wikipedia.org. This is sometimes necessary because " .
421 "server name detection may fail in command line scripts.", false, true );
422 $this->addOption( 'profiler', 'Set to "text" or "trace" to show profiling output', false, true );
424 # Save generic options to display them separately in help
425 $this->mGenericParameters
= $this->mParams
;
427 # Script dependant options:
429 // If we support a DB, show the options
430 if ( $this->getDbType() > 0 ) {
431 $this->addOption( 'dbuser', 'The DB user to use for this script', false, true );
432 $this->addOption( 'dbpass', 'The password to use for this script', false, true );
435 # Save additional script dependant options to display
436 #Â them separately in help
437 $this->mDependantParameters
= array_diff_key( $this->mParams
, $this->mGenericParameters
);
441 * Run a child maintenance script. Pass all of the current arguments
443 * @param $maintClass String: a name of a child maintenance class
444 * @param $classFile String: full path of where the child is
445 * @return Maintenance child
447 public function runChild( $maintClass, $classFile = null ) {
448 // Make sure the class is loaded first
449 if ( !class_exists( $maintClass ) ) {
451 require_once $classFile;
453 if ( !class_exists( $maintClass ) ) {
454 $this->error( "Cannot spawn child: $maintClass" );
459 * @var $child Maintenance
461 $child = new $maintClass();
462 $child->loadParamsAndArgs( $this->mSelf
, $this->mOptions
, $this->mArgs
);
463 if ( !is_null( $this->mDb
) ) {
464 $child->setDB( $this->mDb
);
470 * Do some sanity checking and basic setup
472 public function setup() {
473 global $IP, $wgCommandLineMode, $wgRequestTime;
475 # Abort if called from a web server
476 if ( isset( $_SERVER ) && isset( $_SERVER['REQUEST_METHOD'] ) ) {
477 $this->error( 'This script must be run from the command line', true );
480 if ( $IP === null ) {
481 $this->error( "\$IP not set, aborting!\n" .
482 '(Did you forget to call parent::__construct() in your maintenance script?)', 1 );
485 # Make sure we can handle script parameters
486 if ( !defined( 'HPHP_VERSION' ) && !ini_get( 'register_argc_argv' ) ) {
487 $this->error( 'Cannot get command line arguments, register_argc_argv is set to false', true );
490 // Send PHP warnings and errors to stderr instead of stdout.
491 // This aids in diagnosing problems, while keeping messages
492 // out of redirected output.
493 if ( ini_get( 'display_errors' ) ) {
494 ini_set( 'display_errors', 'stderr' );
497 $this->loadParamsAndArgs();
500 # Set the memory limit
501 # Note we need to set it again later in cache LocalSettings changed it
502 $this->adjustMemoryLimit();
504 # Set max execution time to 0 (no limit). PHP.net says that
505 # "When running PHP from the command line the default setting is 0."
506 # But sometimes this doesn't seem to be the case.
507 ini_set( 'max_execution_time', 0 );
509 $wgRequestTime = microtime( true );
511 # Define us as being in MediaWiki
512 define( 'MEDIAWIKI', true );
514 $wgCommandLineMode = true;
516 # Turn off output buffering if it's on
517 while ( ob_get_level() > 0 ) {
521 $this->validateParamsAndArgs();
525 * Normally we disable the memory_limit when running admin scripts.
526 * Some scripts may wish to actually set a limit, however, to avoid
527 * blowing up unexpectedly. We also support a --memory-limit option,
528 * to allow sysadmins to explicitly set one if they'd prefer to override
529 * defaults (or for people using Suhosin which yells at you for trying
530 * to disable the limits)
533 public function memoryLimit() {
534 $limit = $this->getOption( 'memory-limit', 'max' );
535 $limit = trim( $limit, "\" '" ); // trim quotes in case someone misunderstood
540 * Adjusts PHP's memory limit to better suit our needs, if needed.
542 protected function adjustMemoryLimit() {
543 $limit = $this->memoryLimit();
544 if ( $limit == 'max' ) {
545 $limit = -1; // no memory limit
547 if ( $limit != 'default' ) {
548 ini_set( 'memory_limit', $limit );
553 * Clear all params and arguments.
555 public function clearParamsAndArgs() {
556 $this->mOptions
= array();
557 $this->mArgs
= array();
558 $this->mInputLoaded
= false;
562 * Process command line arguments
563 * $mOptions becomes an array with keys set to the option names
564 * $mArgs becomes a zero-based array containing the non-option arguments
566 * @param $self String The name of the script, if any
567 * @param $opts Array An array of options, in form of key=>value
568 * @param $args Array An array of command line arguments
570 public function loadParamsAndArgs( $self = null, $opts = null, $args = null ) {
571 # If we were given opts or args, set those and return early
573 $this->mSelf
= $self;
574 $this->mInputLoaded
= true;
577 $this->mOptions
= $opts;
578 $this->mInputLoaded
= true;
581 $this->mArgs
= $args;
582 $this->mInputLoaded
= true;
585 # If we've already loaded input (either by user values or from $argv)
586 # skip on loading it again. The array_shift() will corrupt values if
587 # it's run again and again
588 if ( $this->mInputLoaded
) {
589 $this->loadSpecialVars();
594 $this->mSelf
= array_shift( $argv );
600 for ( $arg = reset( $argv ); $arg !== false; $arg = next( $argv ) ) {
601 if ( $arg == '--' ) {
602 # End of options, remainder should be considered arguments
603 $arg = next( $argv );
604 while ( $arg !== false ) {
606 $arg = next( $argv );
609 } elseif ( substr( $arg, 0, 2 ) == '--' ) {
611 $option = substr( $arg, 2 );
612 if ( array_key_exists( $option, $options ) ) {
613 $this->error( "\nERROR: $option parameter given twice\n" );
614 $this->maybeHelp( true );
616 if ( isset( $this->mParams
[$option] ) && $this->mParams
[$option]['withArg'] ) {
617 $param = next( $argv );
618 if ( $param === false ) {
619 $this->error( "\nERROR: $option parameter needs a value after it\n" );
620 $this->maybeHelp( true );
622 $options[$option] = $param;
624 $bits = explode( '=', $option, 2 );
625 if ( count( $bits ) > 1 ) {
631 $options[$option] = $param;
633 } elseif ( substr( $arg, 0, 1 ) == '-' ) {
635 for ( $p = 1; $p < strlen( $arg ); $p++
) {
636 $option = $arg { $p };
637 if ( !isset( $this->mParams
[$option] ) && isset( $this->mShortParamsMap
[$option] ) ) {
638 $option = $this->mShortParamsMap
[$option];
640 if ( array_key_exists( $option, $options ) ) {
641 $this->error( "\nERROR: $option parameter given twice\n" );
642 $this->maybeHelp( true );
644 if ( isset( $this->mParams
[$option]['withArg'] ) && $this->mParams
[$option]['withArg'] ) {
645 $param = next( $argv );
646 if ( $param === false ) {
647 $this->error( "\nERROR: $option parameter needs a value after it\n" );
648 $this->maybeHelp( true );
650 $options[$option] = $param;
652 $options[$option] = 1;
660 $this->mOptions
= $options;
661 $this->mArgs
= $args;
662 $this->loadSpecialVars();
663 $this->mInputLoaded
= true;
667 * Run some validation checks on the params, etc
669 protected function validateParamsAndArgs() {
671 # Check to make sure we've got all the required options
672 foreach ( $this->mParams
as $opt => $info ) {
673 if ( $info['require'] && !$this->hasOption( $opt ) ) {
674 $this->error( "Param $opt required!" );
679 foreach ( $this->mArgList
as $k => $info ) {
680 if ( $info['require'] && !$this->hasArg( $k ) ) {
681 $this->error( 'Argument <' . $info['name'] . '> required!' );
687 $this->maybeHelp( true );
692 * Handle the special variables that are global to all scripts
694 protected function loadSpecialVars() {
695 if ( $this->hasOption( 'dbuser' ) ) {
696 $this->mDbUser
= $this->getOption( 'dbuser' );
698 if ( $this->hasOption( 'dbpass' ) ) {
699 $this->mDbPass
= $this->getOption( 'dbpass' );
701 if ( $this->hasOption( 'quiet' ) ) {
702 $this->mQuiet
= true;
704 if ( $this->hasOption( 'batch-size' ) ) {
705 $this->mBatchSize
= intval( $this->getOption( 'batch-size' ) );
710 * Maybe show the help.
711 * @param $force boolean Whether to force the help to show, default false
713 protected function maybeHelp( $force = false ) {
714 if ( !$force && !$this->hasOption( 'help' ) ) {
718 $screenWidth = 80; // TODO: Caculate this!
720 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
722 ksort( $this->mParams
);
723 $this->mQuiet
= false;
726 if ( $this->mDescription
) {
727 $this->output( "\n" . $this->mDescription
. "\n" );
729 $output = "\nUsage: php " . basename( $this->mSelf
);
731 // ... append parameters ...
732 if ( $this->mParams
) {
733 $output .= " [--" . implode( array_keys( $this->mParams
), "|--" ) . "]";
736 // ... and append arguments.
737 if ( $this->mArgList
) {
739 foreach ( $this->mArgList
as $k => $arg ) {
740 if ( $arg['require'] ) {
741 $output .= '<' . $arg['name'] . '>';
743 $output .= '[' . $arg['name'] . ']';
745 if ( $k < count( $this->mArgList
) - 1 ) {
750 $this->output( "$output\n\n" );
752 # TODO abstract some repetitive code below
754 // Generic parameters
755 $this->output( "Generic maintenance parameters:\n" );
756 foreach ( $this->mGenericParameters
as $par => $info ) {
757 if ( $info['shortName'] !== false ) {
758 $par .= " (-{$info['shortName']})";
761 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
762 "\n$tab$tab" ) . "\n"
765 $this->output( "\n" );
767 $scriptDependantParams = $this->mDependantParameters
;
768 if ( count( $scriptDependantParams ) > 0 ) {
769 $this->output( "Script dependant parameters:\n" );
770 // Parameters description
771 foreach ( $scriptDependantParams as $par => $info ) {
772 if ( $info['shortName'] !== false ) {
773 $par .= " (-{$info['shortName']})";
776 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
777 "\n$tab$tab" ) . "\n"
780 $this->output( "\n" );
783 // Script specific parameters not defined on construction by
784 // Maintenance::addDefaultParams()
785 $scriptSpecificParams = array_diff_key(
786 # all script parameters:
788 # remove the Maintenance default parameters:
789 $this->mGenericParameters
,
790 $this->mDependantParameters
792 if ( count( $scriptSpecificParams ) > 0 ) {
793 $this->output( "Script specific parameters:\n" );
794 // Parameters description
795 foreach ( $scriptSpecificParams as $par => $info ) {
796 if ( $info['shortName'] !== false ) {
797 $par .= " (-{$info['shortName']})";
800 wordwrap( "$tab--$par: " . $info['desc'], $descWidth,
801 "\n$tab$tab" ) . "\n"
804 $this->output( "\n" );
808 if ( count( $this->mArgList
) > 0 ) {
809 $this->output( "Arguments:\n" );
810 // Arguments description
811 foreach ( $this->mArgList
as $info ) {
812 $openChar = $info['require'] ?
'<' : '[';
813 $closeChar = $info['require'] ?
'>' : ']';
815 wordwrap( "$tab$openChar" . $info['name'] . "$closeChar: " .
816 $info['desc'], $descWidth, "\n$tab$tab" ) . "\n"
819 $this->output( "\n" );
826 * Handle some last-minute setup here.
828 public function finalSetup() {
829 global $wgCommandLineMode, $wgShowSQLErrors, $wgServer;
830 global $wgDBadminuser, $wgDBadminpassword;
831 global $wgDBuser, $wgDBpassword, $wgDBservers, $wgLBFactoryConf;
833 # Turn off output buffering again, it might have been turned on in the settings files
834 if ( ob_get_level() ) {
838 $wgCommandLineMode = true;
841 if ( $this->hasOption( 'server' ) ) {
842 $wgServer = $this->getOption( 'server', $wgServer );
845 # If these were passed, use them
846 if ( $this->mDbUser
) {
847 $wgDBadminuser = $this->mDbUser
;
849 if ( $this->mDbPass
) {
850 $wgDBadminpassword = $this->mDbPass
;
853 if ( $this->getDbType() == self
::DB_ADMIN
&& isset( $wgDBadminuser ) ) {
854 $wgDBuser = $wgDBadminuser;
855 $wgDBpassword = $wgDBadminpassword;
857 if ( $wgDBservers ) {
859 * @var $wgDBservers array
861 foreach ( $wgDBservers as $i => $server ) {
862 $wgDBservers[$i]['user'] = $wgDBuser;
863 $wgDBservers[$i]['password'] = $wgDBpassword;
866 if ( isset( $wgLBFactoryConf['serverTemplate'] ) ) {
867 $wgLBFactoryConf['serverTemplate']['user'] = $wgDBuser;
868 $wgLBFactoryConf['serverTemplate']['password'] = $wgDBpassword;
870 LBFactory
::destroyInstance();
873 $this->afterFinalSetup();
875 $wgShowSQLErrors = true;
876 @set_time_limit
( 0 );
877 $this->adjustMemoryLimit();
879 // Per-script profiling; useful for debugging
880 $forcedProfiler = $this->getOption( 'profiler' );
881 if ( $forcedProfiler === 'text' ) {
882 Profiler
::setInstance( new ProfilerSimpleText( array() ) );
883 Profiler
::instance()->setTemplated( true );
884 } elseif ( $forcedProfiler === 'trace' ) {
885 Profiler
::setInstance( new ProfilerSimpleTrace( array() ) );
886 Profiler
::instance()->setTemplated( true );
891 * Execute a callback function at the end of initialisation
893 protected function afterFinalSetup() {
894 if ( defined( 'MW_CMDLINE_CALLBACK' ) ) {
895 call_user_func( MW_CMDLINE_CALLBACK
);
900 * Potentially debug globals. Originally a feature only
903 public function globals() {
904 if ( $this->hasOption( 'globals' ) ) {
910 * Generic setup for most installs. Returns the location of LocalSettings
913 public function loadSettings() {
914 global $wgCommandLineMode, $IP;
916 if ( isset( $this->mOptions
['conf'] ) ) {
917 $settingsFile = $this->mOptions
['conf'];
918 } elseif ( defined( "MW_CONFIG_FILE" ) ) {
919 $settingsFile = MW_CONFIG_FILE
;
921 $settingsFile = "$IP/LocalSettings.php";
923 if ( isset( $this->mOptions
['wiki'] ) ) {
924 $bits = explode( '-', $this->mOptions
['wiki'] );
925 if ( count( $bits ) == 1 ) {
928 define( 'MW_DB', $bits[0] );
929 define( 'MW_PREFIX', $bits[1] );
932 if ( !is_readable( $settingsFile ) ) {
933 $this->error( "A copy of your installation's LocalSettings.php\n" .
934 "must exist and be readable in the source directory.\n" .
935 "Use --conf to specify it.", true );
937 $wgCommandLineMode = true;
938 return $settingsFile;
942 * Support function for cleaning up redundant text records
943 * @param $delete Boolean: whether or not to actually delete the records
944 * @author Rob Church <robchur@gmail.com>
946 public function purgeRedundantText( $delete = true ) {
947 # Data should come off the master, wrapped in a transaction
948 $dbw = $this->getDB( DB_MASTER
);
949 $dbw->begin( __METHOD__
);
951 # Get "active" text records from the revisions table
952 $this->output( 'Searching for active text records in revisions table...' );
953 $res = $dbw->select( 'revision', 'rev_text_id', array(), __METHOD__
, array( 'DISTINCT' ) );
954 foreach ( $res as $row ) {
955 $cur[] = $row->rev_text_id
;
957 $this->output( "done.\n" );
959 # Get "active" text records from the archive table
960 $this->output( 'Searching for active text records in archive table...' );
961 $res = $dbw->select( 'archive', 'ar_text_id', array(), __METHOD__
, array( 'DISTINCT' ) );
962 foreach ( $res as $row ) {
963 # old pre-MW 1.5 records can have null ar_text_id's.
964 if ( $row->ar_text_id
!== null ) {
965 $cur[] = $row->ar_text_id
;
968 $this->output( "done.\n" );
970 # Get the IDs of all text records not in these sets
971 $this->output( 'Searching for inactive text records...' );
972 $cond = 'old_id NOT IN ( ' . $dbw->makeList( $cur ) . ' )';
973 $res = $dbw->select( 'text', 'old_id', array( $cond ), __METHOD__
, array( 'DISTINCT' ) );
975 foreach ( $res as $row ) {
976 $old[] = $row->old_id
;
978 $this->output( "done.\n" );
980 # Inform the user of what we're going to do
981 $count = count( $old );
982 $this->output( "$count inactive items found.\n" );
984 # Delete as appropriate
985 if ( $delete && $count ) {
986 $this->output( 'Deleting...' );
987 $dbw->delete( 'text', array( 'old_id' => $old ), __METHOD__
);
988 $this->output( "done.\n" );
992 $dbw->commit( __METHOD__
);
996 * Get the maintenance directory.
999 protected function getDir() {
1004 * Returns a database to be used by current maintenance script. It can be set by setDB().
1005 * If not set, wfGetDB() will be used.
1006 * This function has the same parameters as wfGetDB()
1008 * @return DatabaseBase
1010 protected function &getDB( $db, $groups = array(), $wiki = false ) {
1011 if ( is_null( $this->mDb
) ) {
1012 return wfGetDB( $db, $groups, $wiki );
1019 * Sets database object to be returned by getDB().
1021 * @param $db DatabaseBase: Database object to be used
1023 public function setDB( &$db ) {
1028 * Lock the search index
1029 * @param &$db DatabaseBase object
1031 private function lockSearchindex( &$db ) {
1032 $write = array( 'searchindex' );
1033 $read = array( 'page', 'revision', 'text', 'interwiki', 'l10n_cache', 'user' );
1034 $db->lockTables( $read, $write, __CLASS__
. '::' . __METHOD__
);
1039 * @param &$db DatabaseBase object
1041 private function unlockSearchindex( &$db ) {
1042 $db->unlockTables( __CLASS__
. '::' . __METHOD__
);
1046 * Unlock and lock again
1047 * Since the lock is low-priority, queued reads will be able to complete
1048 * @param &$db DatabaseBase object
1050 private function relockSearchindex( &$db ) {
1051 $this->unlockSearchindex( $db );
1052 $this->lockSearchindex( $db );
1056 * Perform a search index update with locking
1057 * @param $maxLockTime Integer: the maximum time to keep the search index locked.
1058 * @param $callback callback String: the function that will update the function.
1059 * @param $dbw DatabaseBase object
1062 public function updateSearchIndex( $maxLockTime, $callback, $dbw, $results ) {
1066 if ( $maxLockTime ) {
1067 $this->output( " --- Waiting for lock ---" );
1068 $this->lockSearchindex( $dbw );
1070 $this->output( "\n" );
1073 # Loop through the results and do a search update
1074 foreach ( $results as $row ) {
1075 # Allow reads to be processed
1076 if ( $maxLockTime && time() > $lockTime +
$maxLockTime ) {
1077 $this->output( " --- Relocking ---" );
1078 $this->relockSearchindex( $dbw );
1080 $this->output( "\n" );
1082 call_user_func( $callback, $dbw, $row );
1085 # Unlock searchindex
1086 if ( $maxLockTime ) {
1087 $this->output( " --- Unlocking --" );
1088 $this->unlockSearchindex( $dbw );
1089 $this->output( "\n" );
1095 * Update the searchindex table for a given pageid
1096 * @param $dbw DatabaseBase a database write handle
1097 * @param $pageId Integer: the page ID to update.
1098 * @return null|string
1100 public function updateSearchIndexForPage( $dbw, $pageId ) {
1101 // Get current revision
1102 $rev = Revision
::loadFromPageId( $dbw, $pageId );
1105 $titleObj = $rev->getTitle();
1106 $title = $titleObj->getPrefixedDBkey();
1107 $this->output( "$title..." );
1108 # Update searchindex
1109 $u = new SearchUpdate( $pageId, $titleObj->getText(), $rev->getContent() );
1111 $this->output( "\n" );
1117 * Wrapper for posix_isatty()
1118 * We default as considering stdin a tty (for nice readline methods)
1119 * but treating stout as not a tty to avoid color codes
1121 * @param $fd int File descriptor
1124 public static function posix_isatty( $fd ) {
1125 if ( !function_exists( 'posix_isatty' ) ) {
1128 return posix_isatty( $fd );
1133 * Prompt the console for input
1134 * @param $prompt String what to begin the line with, like '> '
1135 * @return String response
1137 public static function readconsole( $prompt = '> ' ) {
1138 static $isatty = null;
1139 if ( is_null( $isatty ) ) {
1140 $isatty = self
::posix_isatty( 0 /*STDIN*/ );
1143 if ( $isatty && function_exists( 'readline' ) ) {
1144 return readline( $prompt );
1147 $st = self
::readlineEmulation( $prompt );
1149 if ( feof( STDIN
) ) {
1152 $st = fgets( STDIN
, 1024 );
1155 if ( $st === false ) {
1158 $resp = trim( $st );
1164 * Emulate readline()
1165 * @param $prompt String what to begin the line with, like '> '
1168 private static function readlineEmulation( $prompt ) {
1169 $bash = Installer
::locateExecutableInDefaultPaths( array( 'bash' ) );
1170 if ( !wfIsWindows() && $bash ) {
1172 $encPrompt = wfEscapeShellArg( $prompt );
1173 $command = "read -er -p $encPrompt && echo \"\$REPLY\"";
1174 $encCommand = wfEscapeShellArg( $command );
1175 $line = wfShellExec( "$bash -c $encCommand", $retval, array(), array( 'walltime' => 0 ) );
1177 if ( $retval == 0 ) {
1179 } elseif ( $retval == 127 ) {
1180 // Couldn't execute bash even though we thought we saw it.
1181 // Shell probably spit out an error message, sorry :(
1182 // Fall through to fgets()...
1189 // Fallback... we'll have no editing controls, EWWW
1190 if ( feof( STDIN
) ) {
1194 return fgets( STDIN
, 1024 );
1199 * Fake maintenance wrapper, mostly used for the web installer/updater
1201 class FakeMaintenance
extends Maintenance
{
1202 protected $mSelf = "FakeMaintenanceScript";
1203 public function execute() {
1209 * Class for scripts that perform database maintenance and want to log the
1210 * update in `updatelog` so we can later skip it
1212 abstract class LoggedUpdateMaintenance
extends Maintenance
{
1213 public function __construct() {
1214 parent
::__construct();
1215 $this->addOption( 'force', 'Run the update even if it was completed already' );
1216 $this->setBatchSize( 200 );
1219 public function execute() {
1220 $db = $this->getDB( DB_MASTER
);
1221 $key = $this->getUpdateKey();
1223 if ( !$this->hasOption( 'force' )
1224 && $db->selectRow( 'updatelog', '1', array( 'ul_key' => $key ), __METHOD__
)
1226 $this->output( "..." . $this->updateSkippedMessage() . "\n" );
1230 if ( !$this->doDBUpdates() ) {
1234 if ( $db->insert( 'updatelog', array( 'ul_key' => $key ), __METHOD__
, 'IGNORE' ) ) {
1237 $this->output( $this->updatelogFailedMessage() . "\n" );
1243 * Message to show that the update was done already and was just skipped
1246 protected function updateSkippedMessage() {
1247 $key = $this->getUpdateKey();
1248 return "Update '{$key}' already logged as completed.";
1252 * Message to show the the update log was unable to log the completion of this update
1255 protected function updatelogFailedMessage() {
1256 $key = $this->getUpdateKey();
1257 return "Unable to log update '{$key}' as completed.";
1261 * Do the actual work. All child classes will need to implement this.
1262 * Return true to log the update as done or false (usually on failure).
1265 abstract protected function doDBUpdates();
1268 * Get the update key name to go in the update log table
1271 abstract protected function getUpdateKey();