Go to the documentation of this file.
25 require_once __DIR__ .
'/../includes/PHPVersionCheck.php';
37 define(
'RUN_MAINTENANCE_IF_MAIN', __DIR__ .
'/doMaintenance.php' );
162 $IP = strval( getenv(
'MW_INSTALL_PATH' ) ) !==
''
163 ? getenv(
'MW_INSTALL_PATH' )
164 : realpath( __DIR__ .
'/..' );
167 register_shutdown_function( [ $this,
'outputChanneled' ],
false );
180 if ( !function_exists(
'debug_backtrace' ) ) {
185 $bt = debug_backtrace();
186 $count =
count( $bt );
190 if ( $bt[0][
'class'] !==
self::class || $bt[0][
'function'] !==
'shouldExecute' ) {
193 $includeFuncs = [
'require_once',
'require',
'include',
'include_once' ];
194 for ( $i = 1; $i < $count; $i++ ) {
195 if ( !in_array( $bt[$i][
'function'], $includeFuncs ) ) {
206 abstract public function execute();
220 $withArg =
false, $shortName =
false, $multiOccurrence =
false
222 $this->mParams[
$name] = [
223 'desc' => $description,
224 'require' => $required,
225 'withArg' => $withArg,
226 'shortName' => $shortName,
227 'multiOccurrence' => $multiOccurrence
230 if ( $shortName !==
false ) {
231 $this->mShortParamsMap[$shortName] =
$name;
241 return isset( $this->mOptions[
$name] );
256 return $this->mOptions[
$name];
259 $this->mOptions[
$name] = $default;
261 return $this->mOptions[
$name];
271 protected function addArg( $arg, $description, $required =
true ) {
272 $this->mArgList[] = [
274 'desc' => $description,
275 'require' => $required
284 unset( $this->mParams[
$name] );
292 $this->mDescription = $text;
300 protected function hasArg( $argId = 0 ) {
301 return isset( $this->mArgs[$argId] );
310 protected function getArg( $argId = 0, $default =
null ) {
311 return $this->
hasArg( $argId ) ? $this->mArgs[$argId] : $default;
330 $this->mBatchSize =
$s;
337 if ( $this->mBatchSize ) {
338 $this->
addOption(
'batch-size',
'Run this many operations ' .
339 'per batch, default: ' . $this->mBatchSize,
false,
true );
340 if ( isset( $this->mParams[
'batch-size'] ) ) {
342 $this->mDependantParameters[
'batch-size'] = $this->mParams[
'batch-size'];
362 if ( $len == self::STDIN_ALL ) {
363 return file_get_contents(
'php://stdin' );
365 $f = fopen(
'php://stdin',
'rt' );
369 $input = fgets( $f, $len );
392 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
393 if ( $stats->getDataCount() > 1000 ) {
398 if ( $this->mQuiet ) {
401 if ( $channel ===
null ) {
405 $out = preg_replace(
'/\n\z/',
'',
$out );
416 protected function error( $err, $die = 0 ) {
417 if ( intval( $die ) !== 0 ) {
423 ( PHP_SAPI ==
'cli' || PHP_SAPI ==
'phpdbg' ) &&
424 !defined(
'MW_PHPUNIT_TEST' )
426 fwrite( STDERR, $err .
"\n" );
440 $this->
error( $msg );
451 if ( !$this->atLineStart ) {
453 $this->atLineStart =
true;
466 if ( $msg ===
false ) {
473 if ( !$this->atLineStart && $channel !== $this->lastChannel ) {
479 $this->atLineStart =
false;
480 if ( $channel ===
null ) {
483 $this->atLineStart =
true;
485 $this->lastChannel = $channel;
506 # Generic (non script dependant) options:
508 $this->
addOption(
'help',
'Display this help message',
false,
false,
'h' );
509 $this->
addOption(
'quiet',
'Whether to supress non-error output',
false,
false,
'q' );
510 $this->
addOption(
'conf',
'Location of LocalSettings.php, if not default',
false,
true );
511 $this->
addOption(
'wiki',
'For specifying the wiki ID',
false,
true );
512 $this->
addOption(
'globals',
'Output globals at the end of processing for debugging' );
515 'Set a specific memory limit for the script, '
516 .
'"max" for no limit or "default" to avoid changing it',
520 $this->
addOption(
'server',
"The protocol and server name to use in URLs, e.g. " .
521 "http://en.wikipedia.org. This is sometimes necessary because " .
522 "server name detection may fail in command line scripts.",
false,
true );
523 $this->
addOption(
'profiler',
'Profiler output format (usually "text")',
false,
true );
525 $this->
addOption(
'mwdebug',
'Enable built-in MediaWiki development settings',
false,
true );
527 # Save generic options to display them separately in help
530 # Script dependant options:
534 $this->
addOption(
'dbuser',
'The DB user to use for this script',
false,
true );
535 $this->
addOption(
'dbpass',
'The password to use for this script',
false,
true );
538 # Save additional script dependant options to display
539 # Â them separately in help
540 $this->mDependantParameters = array_diff_key( $this->mParams, $this->mGenericParameters );
548 if ( $this->config ===
null ) {
549 $this->config = MediaWikiServices::getInstance()->getMainConfig();
573 $this->requiredExtensions[] =
$name;
584 foreach ( $this->requiredExtensions
as $name ) {
585 if ( !$registry->isLoaded(
$name ) ) {
591 $joined = implode(
', ', $missing );
592 $msg =
"The following extensions are required to be installed "
593 .
"for this script to run: $joined. Please enable them and then try again.";
603 if ( function_exists(
'posix_getpwuid' ) ) {
604 $agent = posix_getpwuid( posix_geteuid() )[
'name'];
610 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
612 $lbFactory->setAgentName(
613 mb_strlen( $agent ) > 15 ? mb_substr( $agent, 0, 15 ) .
'...' : $agent
624 $services = MediaWikiServices::getInstance();
625 $stats =
$services->getStatsdDataFactory();
627 $lbFactory =
$services->getDBLoadBalancerFactory();
628 $lbFactory->setWaitForReplicationListener(
641 $lbFactory->getMainLB()->setTransactionListener(
643 function ( $trigger )
use ( $stats,
$config ) {
645 if (
$config->
get(
'CommandLineMode' ) && $trigger === IDatabase::TRIGGER_COMMIT ) {
665 require_once $classFile;
668 $this->
error(
"Cannot spawn child: $maintClass" );
676 $child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
677 if ( !is_null( $this->mDb ) ) {
678 $child->setDB( $this->mDb );
690 # Abort if called from a web server
691 # wfIsCLI() is not available yet
692 if ( PHP_SAPI !==
'cli' && PHP_SAPI !==
'phpdbg' ) {
693 $this->
fatalError(
'This script must be run from the command line' );
696 if ( $IP ===
null ) {
697 $this->
fatalError(
"\$IP not set, aborting!\n" .
698 '(Did you forget to call parent::__construct() in your maintenance script?)' );
701 # Make sure we can handle script parameters
702 if ( !defined(
'HPHP_VERSION' ) && !ini_get(
'register_argc_argv' ) ) {
703 $this->
fatalError(
'Cannot get command line arguments, register_argc_argv is set to false' );
709 if ( ini_get(
'display_errors' ) ) {
710 ini_set(
'display_errors',
'stderr' );
716 # Set the memory limit
717 # Note we need to set it again later in cache LocalSettings changed it
720 # Set max execution time to 0 (no limit). PHP.net says that
721 # "When running PHP from the command line the default setting is 0."
722 # But sometimes this doesn't seem to be the case.
723 ini_set(
'max_execution_time', 0 );
725 # Define us as being in MediaWiki
726 define(
'MEDIAWIKI',
true );
730 # Turn off output buffering if it's on
731 while ( ob_get_level() > 0 ) {
748 $limit = $this->
getOption(
'memory-limit',
'max' );
749 $limit = trim( $limit,
"\" '" );
758 if ( $limit ==
'max' ) {
761 if ( $limit !=
'default' ) {
762 ini_set(
'memory_limit', $limit );
780 $profiler =
new $class(
781 [
'sampling' => 1,
'output' => [
$output ] ]
785 $profiler->setTemplated(
true );
790 $trxProfiler->setLogger( LoggerFactory::getInstance(
'DBPerformance' ) );
798 $this->mOptions = [];
800 $this->mInputLoaded =
false;
813 $this->orderedOptions = [];
816 for ( $arg = reset(
$argv ); $arg !==
false; $arg = next(
$argv ) ) {
817 if ( $arg ==
'--' ) {
818 # End of options, remainder should be considered arguments
819 $arg = next(
$argv );
820 while ( $arg !==
false ) {
822 $arg = next(
$argv );
825 } elseif ( substr( $arg, 0, 2 ) ==
'--' ) {
827 $option = substr( $arg, 2 );
828 if ( isset( $this->mParams[$option] ) && $this->mParams[$option][
'withArg'] ) {
829 $param = next(
$argv );
830 if ( $param ===
false ) {
831 $this->
error(
"\nERROR: $option parameter needs a value after it\n" );
837 $bits = explode(
'=', $option, 2 );
838 if (
count( $bits ) > 1 ) {
847 } elseif ( $arg ==
'-' ) {
848 # Lonely "-", often used to indicate stdin or stdout.
850 } elseif ( substr( $arg, 0, 1 ) ==
'-' ) {
852 $argLength = strlen( $arg );
853 for ( $p = 1; $p < $argLength; $p++ ) {
855 if ( !isset( $this->mParams[$option] ) && isset( $this->mShortParamsMap[$option] ) ) {
856 $option = $this->mShortParamsMap[$option];
859 if ( isset( $this->mParams[$option][
'withArg'] ) && $this->mParams[$option][
'withArg'] ) {
860 $param = next(
$argv );
861 if ( $param ===
false ) {
862 $this->
error(
"\nERROR: $option parameter needs a value after it\n" );
876 $this->mArgs =
$args;
878 $this->mInputLoaded =
true;
894 $this->orderedOptions[] = [ $option,
$value ];
896 if ( isset( $this->mParams[$option] ) ) {
897 $multi = $this->mParams[$option][
'multiOccurrence'];
901 $exists = array_key_exists( $option,
$options );
902 if ( $multi && $exists ) {
904 } elseif ( $multi ) {
906 } elseif ( !$exists ) {
909 $this->
error(
"\nERROR: $option parameter given twice\n" );
924 # If we were given opts or args, set those and return early
926 $this->mSelf =
$self;
927 $this->mInputLoaded =
true;
930 $this->mOptions = $opts;
931 $this->mInputLoaded =
true;
934 $this->mArgs =
$args;
935 $this->mInputLoaded =
true;
938 # If we've already loaded input (either by user values or from $argv)
939 # skip on loading it again. The array_shift() will corrupt values if
940 # it's run again and again
941 if ( $this->mInputLoaded ) {
948 $this->mSelf =
$argv[0];
957 # Check to make sure we've got all the required options
958 foreach ( $this->mParams
as $opt => $info ) {
960 $this->
error(
"Param $opt required!" );
965 foreach ( $this->mArgList
as $k => $info ) {
966 if ( $info[
'require'] && !$this->
hasArg( $k ) ) {
967 $this->
error(
'Argument <' . $info[
'name'] .
'> required!' );
982 $this->mDbUser = $this->
getOption(
'dbuser' );
985 $this->mDbPass = $this->
getOption(
'dbpass' );
988 $this->mQuiet =
true;
990 if ( $this->
hasOption(
'batch-size' ) ) {
991 $this->mBatchSize = intval( $this->
getOption(
'batch-size' ) );
1000 if ( !$force && !$this->
hasOption(
'help' ) ) {
1006 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
1008 ksort( $this->mParams );
1009 $this->mQuiet =
false;
1012 if ( $this->mDescription ) {
1013 $this->
output(
"\n" . wordwrap( $this->mDescription, $screenWidth ) .
"\n" );
1015 $output =
"\nUsage: php " . basename( $this->mSelf );
1018 if ( $this->mParams ) {
1019 $output .=
" [--" . implode(
"|--", array_keys( $this->mParams ) ) .
"]";
1023 if ( $this->mArgList ) {
1025 foreach ( $this->mArgList
as $k => $arg ) {
1026 if ( $arg[
'require'] ) {
1027 $output .=
'<' . $arg[
'name'] .
'>';
1029 $output .=
'[' . $arg[
'name'] .
']';
1031 if ( $k <
count( $this->mArgList ) - 1 ) {
1036 $this->
output(
"$output\n\n" );
1038 # TODO abstract some repetitive code below
1041 $this->
output(
"Generic maintenance parameters:\n" );
1042 foreach ( $this->mGenericParameters
as $par => $info ) {
1043 if ( $info[
'shortName'] !==
false ) {
1044 $par .=
" (-{$info['shortName']})";
1047 wordwrap(
"$tab--$par: " . $info[
'desc'], $descWidth,
1048 "\n$tab$tab" ) .
"\n"
1054 if (
count( $scriptDependantParams ) > 0 ) {
1055 $this->
output(
"Script dependant parameters:\n" );
1057 foreach ( $scriptDependantParams
as $par => $info ) {
1058 if ( $info[
'shortName'] !==
false ) {
1059 $par .=
" (-{$info['shortName']})";
1062 wordwrap(
"$tab--$par: " . $info[
'desc'], $descWidth,
1063 "\n$tab$tab" ) .
"\n"
1071 $scriptSpecificParams = array_diff_key(
1075 $this->mGenericParameters,
1076 $this->mDependantParameters
1078 if (
count( $scriptSpecificParams ) > 0 ) {
1079 $this->
output(
"Script specific parameters:\n" );
1081 foreach ( $scriptSpecificParams
as $par => $info ) {
1082 if ( $info[
'shortName'] !==
false ) {
1083 $par .=
" (-{$info['shortName']})";
1086 wordwrap(
"$tab--$par: " . $info[
'desc'], $descWidth,
1087 "\n$tab$tab" ) .
"\n"
1094 if (
count( $this->mArgList ) > 0 ) {
1095 $this->
output(
"Arguments:\n" );
1097 foreach ( $this->mArgList
as $info ) {
1098 $openChar = $info[
'require'] ?
'<' :
'[';
1099 $closeChar = $info[
'require'] ?
'>' :
']';
1101 wordwrap(
"$tab$openChar" . $info[
'name'] .
"$closeChar: " .
1102 $info[
'desc'], $descWidth,
"\n$tab$tab" ) .
"\n"
1119 # Turn off output buffering again, it might have been turned on in the settings files
1120 if ( ob_get_level() ) {
1126 # Override $wgServer
1128 $wgServer = $this->
getOption(
'server', $wgServer );
1131 # If these were passed, use them
1132 if ( $this->mDbUser ) {
1135 if ( $this->mDbPass ) {
1156 MediaWikiServices::getInstance()->getDBLoadBalancerFactory()->destroy();
1159 # Apply debug settings
1161 require __DIR__ .
'/../includes/DevelopmentSettings.php';
1169 $wgShowSQLErrors =
true;
1171 Wikimedia\suppressWarnings();
1172 set_time_limit( 0 );
1173 Wikimedia\restoreWarnings();
1182 if ( defined(
'MW_CMDLINE_CALLBACK' ) ) {
1183 call_user_func( MW_CMDLINE_CALLBACK );
1204 if ( isset( $this->mOptions[
'conf'] ) ) {
1205 $settingsFile = $this->mOptions[
'conf'];
1206 } elseif ( defined(
"MW_CONFIG_FILE" ) ) {
1207 $settingsFile = MW_CONFIG_FILE;
1209 $settingsFile =
"$IP/LocalSettings.php";
1211 if ( isset( $this->mOptions[
'wiki'] ) ) {
1212 $bits = explode(
'-', $this->mOptions[
'wiki'] );
1213 if (
count( $bits ) == 1 ) {
1216 define(
'MW_DB', $bits[0] );
1217 define(
'MW_PREFIX', $bits[1] );
1218 } elseif ( isset( $this->mOptions[
'server'] ) ) {
1223 $_SERVER[
'SERVER_NAME'] = $this->mOptions[
'server'];
1226 if ( !is_readable( $settingsFile ) ) {
1227 $this->
fatalError(
"A copy of your installation's LocalSettings.php\n" .
1228 "must exist and be readable in the source directory.\n" .
1229 "Use --conf to specify it." );
1231 $wgCommandLineMode =
true;
1233 return $settingsFile;
1242 # Data should come off the master, wrapped in a transaction
1246 # Get "active" text records from the revisions table
1248 $this->
output(
'Searching for active text records in revisions table...' );
1249 $res = $dbw->select(
'revision',
'rev_text_id', [], __METHOD__, [
'DISTINCT' ] );
1250 foreach (
$res as $row ) {
1251 $cur[] = $row->rev_text_id;
1253 $this->
output(
"done.\n" );
1255 # Get "active" text records from the archive table
1256 $this->
output(
'Searching for active text records in archive table...' );
1257 $res = $dbw->select(
'archive',
'ar_text_id', [], __METHOD__, [
'DISTINCT' ] );
1258 foreach (
$res as $row ) {
1259 # old pre-MW 1.5 records can have null ar_text_id's.
1260 if ( $row->ar_text_id !==
null ) {
1261 $cur[] = $row->ar_text_id;
1264 $this->
output(
"done.\n" );
1266 # Get the IDs of all text records not in these sets
1267 $this->
output(
'Searching for inactive text records...' );
1268 $cond =
'old_id NOT IN ( ' . $dbw->makeList( $cur ) .
' )';
1269 $res = $dbw->select(
'text',
'old_id', [ $cond ], __METHOD__, [
'DISTINCT' ] );
1271 foreach (
$res as $row ) {
1272 $old[] = $row->old_id;
1274 $this->
output(
"done.\n" );
1276 # Inform the user of what we're going to do
1277 $count =
count( $old );
1278 $this->
output(
"$count inactive items found.\n" );
1280 # Delete as appropriate
1281 if ( $delete && $count ) {
1282 $this->
output(
'Deleting...' );
1283 $dbw->delete(
'text', [
'old_id' => $old ], __METHOD__ );
1284 $this->
output(
"done.\n" );
1309 protected function getDB( $db, $groups = [], $wiki =
false ) {
1310 if ( is_null( $this->mDb ) ) {
1311 return wfGetDB( $db, $groups, $wiki );
1354 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
1355 $lbFactory->waitForReplication(
1356 [
'timeout' => 30,
'ifWritesSince' => $this->lastReplicationWait ]
1358 $this->lastReplicationWait = microtime(
true );
1385 $write = [
'searchindex' ];
1395 $db->lockTables( $read, $write, __CLASS__ .
'::' . __METHOD__ );
1403 $db->unlockTables( __CLASS__ .
'::' . __METHOD__ );
1427 if ( $maxLockTime ) {
1428 $this->
output(
" --- Waiting for lock ---" );
1434 # Loop through the results and do a search update
1435 foreach ( $results
as $row ) {
1436 # Allow reads to be processed
1437 if ( $maxLockTime && time() > $lockTime + $maxLockTime ) {
1438 $this->
output(
" --- Relocking ---" );
1443 call_user_func( $callback, $dbw, $row );
1446 # Unlock searchindex
1447 if ( $maxLockTime ) {
1448 $this->
output(
" --- Unlocking --" );
1465 $titleObj =
$rev->getTitle();
1466 $title = $titleObj->getPrefixedDBkey();
1467 $this->
output(
"$title..." );
1468 # Update searchindex
1469 $u =
new SearchUpdate( $pageId, $titleObj->getText(),
$rev->getContent() );
1491 for ( $i = $seconds; $i >= 0; $i-- ) {
1492 if ( $i != $seconds ) {
1493 $this->
output( str_repeat(
"\x08", strlen( $i + 1 ) ) );
1512 if ( !function_exists(
'posix_isatty' ) ) {
1525 static $isatty =
null;
1526 if ( is_null( $isatty ) ) {
1530 if ( $isatty && function_exists(
'readline' ) ) {
1531 return readline( $prompt );
1536 if ( feof( STDIN ) ) {
1539 $st = fgets( STDIN, 1024 );
1542 if ( $st ===
false ) {
1545 $resp = trim( $st );
1561 $command =
"read -er -p $encPrompt && echo \"\$REPLY\"";
1578 if ( feof( STDIN ) ) {
1583 return fgets( STDIN, 1024 );
1594 $default = [ 80, 50 ];
1605 $result = Shell::command(
'stty',
'size' )
1607 if (
$result->getExitCode() !== 0 ) {
1610 if ( !preg_match(
'/^(\d+) (\d+)$/',
$result->getStdout(), $m ) ) {
1613 return [ intval( $m[2] ), intval( $m[1] ) ];
1621 require_once __DIR__ .
'/../tests/common/TestsAutoLoader.php';
1642 parent::__construct();
1643 $this->
addOption(
'force',
'Run the update even if it was completed already' );
1652 && $db->selectRow(
'updatelog',
'1', [
'ul_key' => $key ], __METHOD__ )
1663 if ( $db->insert(
'updatelog', [
'ul_key' => $key ], __METHOD__,
'IGNORE' ) ) {
1679 return "Update '{$key}' already logged as completed.";
1689 return "Unable to log update '{$key}' as completed.";
$wgProfileLimit
Only record profiling info for pages that took longer than this.
const RUN_MAINTENANCE_IF_MAIN
int $mBatchSize
Batch size.
__construct()
Default constructor.
setParam(&$options, $option, $value)
Helper function used solely by loadParamsAndArgs to prevent code duplication.
static getTermSize()
Get the terminal size as a two-element array where the first element is the width (number of columns)...
$wgShowSQLErrors
Whether to show "we're sorry, but there has been a database error" pages.
getStdin( $len=null)
Return input from stdin.
static replaceStubInstance(Profiler $profiler)
Replace the current profiler with $profiler if no non-stub profiler is set.
static instance()
Singleton.
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
maybeHelp( $force=false)
Maybe show the help.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
addDescription( $text)
Set the description text.
setup()
Do some sanity checking and basic setup.
array $requiredExtensions
runChild( $maintClass, $classFile=null)
Run a child maintenance script.
static setLBFactoryTriggers(LBFactory $LBFactory, Config $config)
static readconsole( $prompt='> ')
Prompt the console for input.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
loadParamsAndArgs( $self=null, $opts=null, $args=null)
Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs be...
relockSearchindex( $db)
Unlock and lock again Since the lock is low-priority, queued reads will be able to complete.
getName()
Get the script's name.
wfHostname()
Fetch server name for use in error reporting etc.
$wgLBFactoryConf
Load balancer factory configuration To set up a multi-master wiki farm, set the class here to somethi...
hasArg( $argId=0)
Does a given argument exist?
setDB(IDatabase $db)
Sets database object to be returned by getDB().
Allows to change the fields on the form that will be generated $name
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
setConfig(Config $config)
$wgDBpassword
Database user's password.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
loadWithArgv( $argv)
Load params and arguments from a given array of command-line arguments.
checkRequiredExtensions()
Verify that the required extensions are installed.
script(document.cookie)%253c/script%253e</pre ></div > !! end !! test XSS is escaped(inline) !!input< source lang
finalSetup()
Handle some last-minute setup here.
rollbackTransaction(IDatabase $dbw, $fname)
Rollback the transcation on a DB handle.
wfEntryPointCheck( $entryPoint)
Check php version and that external dependencies are installed, and display an informative error if e...
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
afterFinalSetup()
Execute a callback function at the end of initialisation.
$wgDBadminuser
Separate username for maintenance tasks.
unlockSearchindex( $db)
Unlock the tables.
clearParamsAndArgs()
Clear all params and arguments.
Interface for configuration instances.
$wgDBservers
Database load balancer This is a two-dimensional array, an array of server info structures Fields are...
updateSearchIndex( $maxLockTime, $callback, $dbw, $results)
Perform a search index update with locking.
namespace and then decline to actually register it file or subcat img or subcat $title
loadSpecialVars()
Handle the special variables that are global to all scripts.
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
float $lastReplicationWait
UNIX timestamp.
if(is_array( $mode)) switch( $mode) $input
global $wgCommandLineMode
static loadFromPageId( $db, $pageid, $id=0)
Load either the current, or a specified, revision that's attached to a given page.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
requireExtension( $name)
Indicate that the specified extension must be loaded before the script can run.
array $orderedOptions
Used to read the options in the order they were passed.
globals()
Potentially debug globals.
updatelogFailedMessage()
Message to show that the update log was unable to log the completion of this update.
when a variable name is used in a it is silently declared as a new masking the global
Fake maintenance wrapper, mostly used for the web installer/updater.
addDefaultParams()
Add the default parameters to the scripts.
static readlineEmulation( $prompt)
Emulate readline()
countDown( $seconds)
Count down from $seconds to zero on the terminal, with a one-second pause between showing each number...
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title after the basic globals have been set but before ordinary actions take place or wrap services the preferred way to define a new service is the $wgServiceWiringFiles array $services
deleteOption( $name)
Remove an option.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
static shouldExecute()
Should we execute the maintenance script, or just allow it to be included as a standalone class?...
execute()
Do the actual work.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
updateSearchIndexForPage( $dbw, $pageId)
Update the searchindex table for a given pageid.
activateProfiler()
Activate the profiler (assuming $wgProfiler is set)
static tryOpportunisticExecute( $mode='run')
Run all deferred updates immediately if there are no DB writes active.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account incomplete not yet checked for validity & $retval
wfIsWindows()
Check if the operating system is Windows.
$wgServer
URL of the server.
wfEscapeShellArg()
Version of escapeshellarg() that works better on Windows.
static requireTestsAutoloader()
Call this to set up the autoloader to allow classes to be used from the tests directory.
static posix_isatty( $fd)
Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but trea...
updateSkippedMessage()
Message to show that the update was done already and was just skipped.
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
validateParamsAndArgs()
Run some validation checks on the params, etc.
Config $config
Accessible via getConfig()
if(!defined( 'MEDIAWIKI')) $wgProfiler
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
cleanupChanneled()
Clean up channeled output.
const DB_NONE
Constants for DB access type.
loadSettings()
Generic setup for most installs.
doDBUpdates()
Do the actual work.
adjustMemoryLimit()
Adjusts PHP's memory limit to better suit our needs, if needed.
getUpdateKey()
Get the update key name to go in the update log table.
purgeRedundantText( $delete=true)
Support function for cleaning up redundant text records.
resource $fileHandle
Used when creating separate schema files.
getOption( $name, $default=null)
Get an option, or return the default.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
addArg( $arg, $description, $required=true)
Add some args that are needed.
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
getBatchSize()
Returns batch size.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
setAgentAndTriggers()
Set triggers like when to try to run deferred updates.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
error( $err, $die=0)
Throw an error to the user.
output( $out, $channel=null)
Throw some output to the user.
getDir()
Get the maintenance directory.
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
$wgDBuser
Database username.
static findInDefaultPaths( $names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
hasOption( $name)
Checks to see if a particular param exists.
getArg( $argId=0, $default=null)
Get an argument.
public function execute()
$wgDBadminpassword
Separate password for maintenance tasks.
outputChanneled( $msg, $channel=null)
Message outputter with channeled message support.
__construct()
Default constructor.
Advanced database interface for IDatabase handles that include maintenance methods.
execute()
Do the actual work.
$wgTrxProfilerLimits
Performance expectations for DB usage.
lockSearchindex( $db)
Lock the search index.
the array() calling protocol came about after MediaWiki 1.4rc1.
setBatchSize( $s=0)
Set the batch size.
IMaintainableDatabase $mDb
Used by getDB() / setDB()
memoryLimit()
Normally we disable the memory_limit when running admin scripts.
wfShellExec( $cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out