26 require_once dirname( __FILE__ ) .
'/../includes/PHPVersionCheck.php';
36 define(
'RUN_MAINTENANCE_IF_MAIN', __DIR__ .
'/doMaintenance.php' );
148 $IP = strval( getenv(
'MW_INSTALL_PATH' ) ) !==
''
149 ? getenv(
'MW_INSTALL_PATH' )
150 : realpath( __DIR__ .
'/..' );
153 register_shutdown_function( [ $this,
'outputChanneled' ],
false );
166 if ( !function_exists(
'debug_backtrace' ) ) {
171 $bt = debug_backtrace();
176 if ( $bt[0][
'class'] !==
'Maintenance' || $bt[0][
'function'] !==
'shouldExecute' ) {
179 $includeFuncs = [
'require_once',
'require',
'include',
'include_once' ];
180 for ( $i = 1; $i <
$count; $i++ ) {
181 if ( !in_array( $bt[$i][
'function'], $includeFuncs ) ) {
192 abstract public function execute();
206 $withArg =
false, $shortName =
false, $multiOccurrence =
false
208 $this->mParams[
$name] = [
209 'desc' => $description,
210 'require' => $required,
211 'withArg' => $withArg,
212 'shortName' => $shortName,
213 'multiOccurrence' => $multiOccurrence
216 if ( $shortName !==
false ) {
217 $this->mShortParamsMap[$shortName] =
$name;
227 return isset( $this->mOptions[
$name] );
242 return $this->mOptions[
$name];
245 $this->mOptions[
$name] = $default;
247 return $this->mOptions[
$name];
257 protected function addArg( $arg, $description, $required =
true ) {
258 $this->mArgList[] = [
260 'desc' => $description,
261 'require' => $required
270 unset( $this->mParams[
$name] );
278 $this->mDescription = $text;
286 protected function hasArg( $argId = 0 ) {
287 return isset( $this->mArgs[$argId] );
296 protected function getArg( $argId = 0, $default = null ) {
297 return $this->
hasArg( $argId ) ? $this->mArgs[$argId] : $default;
305 $this->mBatchSize =
$s;
312 if ( $this->mBatchSize ) {
313 $this->
addOption(
'batch-size',
'Run this many operations ' .
314 'per batch, default: ' . $this->mBatchSize,
false,
true );
315 if ( isset( $this->mParams[
'batch-size'] ) ) {
317 $this->mDependantParameters[
'batch-size'] = $this->mParams[
'batch-size'];
338 return file_get_contents(
'php://stdin' );
340 $f = fopen(
'php://stdin',
'rt' );
344 $input = fgets( $f, $len );
347 return rtrim( $input );
364 if ( $this->mQuiet ) {
367 if ( $channel === null ) {
371 $out = preg_replace(
'/\n\z/',
'',
$out );
382 protected function error( $err, $die = 0 ) {
384 if ( PHP_SAPI ==
'cli' ) {
385 fwrite( STDERR, $err .
"\n" );
389 $die = intval( $die );
402 if ( !$this->atLineStart ) {
404 $this->atLineStart =
true;
417 if ( $msg ===
false ) {
424 if ( !$this->atLineStart && $channel !== $this->lastChannel ) {
430 $this->atLineStart =
false;
431 if ( $channel === null ) {
434 $this->atLineStart =
true;
436 $this->lastChannel = $channel;
458 # Generic (non script dependant) options:
460 $this->
addOption(
'help',
'Display this help message',
false,
false,
'h' );
461 $this->
addOption(
'quiet',
'Whether to supress non-error output',
false,
false,
'q' );
462 $this->
addOption(
'conf',
'Location of LocalSettings.php, if not default',
false,
true );
463 $this->
addOption(
'wiki',
'For specifying the wiki ID',
false,
true );
464 $this->
addOption(
'globals',
'Output globals at the end of processing for debugging' );
467 'Set a specific memory limit for the script, '
468 .
'"max" for no limit or "default" to avoid changing it'
470 $this->
addOption(
'server',
"The protocol and server name to use in URLs, e.g. " .
471 "http://en.wikipedia.org. This is sometimes necessary because " .
472 "server name detection may fail in command line scripts.",
false,
true );
473 $this->
addOption(
'profiler',
'Profiler output format (usually "text")',
false,
true );
475 # Save generic options to display them separately in help
478 # Script dependant options:
482 $this->
addOption(
'dbuser',
'The DB user to use for this script',
false,
true );
483 $this->
addOption(
'dbpass',
'The password to use for this script',
false,
true );
486 # Save additional script dependant options to display
487 # them separately in help
488 $this->mDependantParameters = array_diff_key( $this->mParams, $this->mGenericParameters );
496 if ( $this->config === null ) {
522 require_once $classFile;
525 $this->
error(
"Cannot spawn child: $maintClass" );
533 $child->loadParamsAndArgs( $this->mSelf, $this->mOptions, $this->mArgs );
534 if ( !is_null( $this->mDb ) ) {
535 $child->setDB( $this->mDb );
547 # Abort if called from a web server
548 if ( isset( $_SERVER ) && isset( $_SERVER[
'REQUEST_METHOD'] ) ) {
549 $this->
error(
'This script must be run from the command line',
true );
552 if ( $IP === null ) {
553 $this->
error(
"\$IP not set, aborting!\n" .
554 '(Did you forget to call parent::__construct() in your maintenance script?)', 1 );
557 # Make sure we can handle script parameters
558 if ( !defined(
'HPHP_VERSION' ) && !ini_get(
'register_argc_argv' ) ) {
559 $this->
error(
'Cannot get command line arguments, register_argc_argv is set to false',
true );
565 if ( ini_get(
'display_errors' ) ) {
566 ini_set(
'display_errors',
'stderr' );
572 # Set the memory limit
573 # Note we need to set it again later in cache LocalSettings changed it
576 # Set max execution time to 0 (no limit). PHP.net says that
577 # "When running PHP from the command line the default setting is 0."
578 # But sometimes this doesn't seem to be the case.
579 ini_set(
'max_execution_time', 0 );
581 $wgRequestTime = microtime(
true );
583 # Define us as being in MediaWiki
584 define(
'MEDIAWIKI',
true );
586 $wgCommandLineMode =
true;
588 # Turn off output buffering if it's on
589 while ( ob_get_level() > 0 ) {
619 if (
$limit !=
'default' ) {
620 ini_set(
'memory_limit',
$limit );
635 if ( is_array( $wgProfiler ) && isset( $wgProfiler[
'class'] ) ) {
636 $class = $wgProfiler[
'class'];
637 $profiler =
new $class(
638 [
'sampling' => 1,
'output' => [
$output ] ]
640 + [
'threshold' => $wgProfileLimit ]
642 $profiler->setTemplated(
true );
647 $trxProfiler->setLogger( LoggerFactory::getInstance(
'DBPerformance' ) );
648 $trxProfiler->setExpectations( $wgTrxProfilerLimits[
'Maintenance'], __METHOD__ );
655 $this->mOptions = [];
657 $this->mInputLoaded =
false;
670 $this->orderedOptions = [];
673 for ( $arg = reset( $argv ); $arg !==
false; $arg = next( $argv ) ) {
674 if ( $arg ==
'--' ) {
675 # End of options, remainder should be considered arguments
676 $arg = next( $argv );
677 while ( $arg !==
false ) {
679 $arg = next( $argv );
682 } elseif ( substr( $arg, 0, 2 ) ==
'--' ) {
684 $option = substr( $arg, 2 );
685 if ( isset( $this->mParams[$option] ) && $this->mParams[$option][
'withArg'] ) {
686 $param = next( $argv );
687 if ( $param ===
false ) {
688 $this->
error(
"\nERROR: $option parameter needs a value after it\n" );
694 $bits = explode(
'=', $option, 2 );
695 if ( count( $bits ) > 1 ) {
704 } elseif ( $arg ==
'-' ) {
705 # Lonely "-", often used to indicate stdin or stdout.
707 } elseif ( substr( $arg, 0, 1 ) ==
'-' ) {
709 $argLength = strlen( $arg );
710 for ( $p = 1; $p < $argLength; $p++ ) {
712 if ( !isset( $this->mParams[$option] ) && isset( $this->mShortParamsMap[$option] ) ) {
713 $option = $this->mShortParamsMap[$option];
716 if ( isset( $this->mParams[$option][
'withArg'] ) && $this->mParams[$option][
'withArg'] ) {
717 $param = next( $argv );
718 if ( $param ===
false ) {
719 $this->
error(
"\nERROR: $option parameter needs a value after it\n" );
733 $this->mArgs =
$args;
735 $this->mInputLoaded =
true;
751 $this->orderedOptions[] = [ $option,
$value ];
753 if ( isset( $this->mParams[$option] ) ) {
754 $multi = $this->mParams[$option][
'multiOccurrence'];
758 $exists = array_key_exists( $option,
$options );
759 if ( $multi && $exists ) {
761 } elseif ( $multi ) {
763 } elseif ( !$exists ) {
766 $this->
error(
"\nERROR: $option parameter given twice\n" );
781 # If we were given opts or args, set those and return early
783 $this->mSelf =
$self;
784 $this->mInputLoaded =
true;
787 $this->mOptions = $opts;
788 $this->mInputLoaded =
true;
791 $this->mArgs =
$args;
792 $this->mInputLoaded =
true;
795 # If we've already loaded input (either by user values or from $argv)
796 # skip on loading it again. The array_shift() will corrupt values if
797 # it's run again and again
798 if ( $this->mInputLoaded ) {
805 $this->mSelf = $argv[0];
814 # Check to make sure we've got all the required options
815 foreach ( $this->mParams
as $opt => $info ) {
816 if ( $info[
'require'] && !$this->
hasOption( $opt ) ) {
817 $this->
error(
"Param $opt required!" );
822 foreach ( $this->mArgList
as $k => $info ) {
823 if ( $info[
'require'] && !$this->
hasArg( $k ) ) {
824 $this->
error(
'Argument <' . $info[
'name'] .
'> required!' );
839 $this->mDbUser = $this->
getOption(
'dbuser' );
842 $this->mDbPass = $this->
getOption(
'dbpass' );
845 $this->mQuiet =
true;
847 if ( $this->
hasOption(
'batch-size' ) ) {
848 $this->mBatchSize = intval( $this->
getOption(
'batch-size' ) );
857 if ( !$force && !$this->
hasOption(
'help' ) ) {
863 $descWidth = $screenWidth - ( 2 * strlen( $tab ) );
865 ksort( $this->mParams );
866 $this->mQuiet =
false;
869 if ( $this->mDescription ) {
870 $this->
output(
"\n" . $this->mDescription .
"\n" );
872 $output =
"\nUsage: php " . basename( $this->mSelf );
875 if ( $this->mParams ) {
876 $output .=
" [--" . implode( array_keys( $this->mParams ),
"|--" ) .
"]";
880 if ( $this->mArgList ) {
882 foreach ( $this->mArgList
as $k => $arg ) {
883 if ( $arg[
'require'] ) {
884 $output .=
'<' . $arg[
'name'] .
'>';
886 $output .=
'[' . $arg[
'name'] .
']';
888 if ( $k < count( $this->mArgList ) - 1 ) {
893 $this->
output(
"$output\n\n" );
895 # TODO abstract some repetitive code below
898 $this->
output(
"Generic maintenance parameters:\n" );
899 foreach ( $this->mGenericParameters
as $par => $info ) {
900 if ( $info[
'shortName'] !==
false ) {
901 $par .=
" (-{$info['shortName']})";
904 wordwrap(
"$tab--$par: " . $info[
'desc'], $descWidth,
905 "\n$tab$tab" ) .
"\n"
911 if ( count( $scriptDependantParams ) > 0 ) {
912 $this->
output(
"Script dependant parameters:\n" );
914 foreach ( $scriptDependantParams
as $par => $info ) {
915 if ( $info[
'shortName'] !==
false ) {
916 $par .=
" (-{$info['shortName']})";
919 wordwrap(
"$tab--$par: " . $info[
'desc'], $descWidth,
920 "\n$tab$tab" ) .
"\n"
928 $scriptSpecificParams = array_diff_key(
929 # all script parameters:
932 $this->mGenericParameters,
933 $this->mDependantParameters
935 if ( count( $scriptSpecificParams ) > 0 ) {
936 $this->
output(
"Script specific parameters:\n" );
938 foreach ( $scriptSpecificParams
as $par => $info ) {
939 if ( $info[
'shortName'] !==
false ) {
940 $par .=
" (-{$info['shortName']})";
943 wordwrap(
"$tab--$par: " . $info[
'desc'], $descWidth,
944 "\n$tab$tab" ) .
"\n"
951 if ( count( $this->mArgList ) > 0 ) {
952 $this->
output(
"Arguments:\n" );
954 foreach ( $this->mArgList
as $info ) {
955 $openChar = $info[
'require'] ?
'<' :
'[';
956 $closeChar = $info[
'require'] ?
'>' :
']';
958 wordwrap(
"$tab$openChar" . $info[
'name'] .
"$closeChar: " .
959 $info[
'desc'], $descWidth,
"\n$tab$tab" ) .
"\n"
976 # Turn off output buffering again, it might have been turned on in the settings files
977 if ( ob_get_level() ) {
981 $wgCommandLineMode =
true;
985 $wgServer = $this->
getOption(
'server', $wgServer );
988 # If these were passed, use them
989 if ( $this->mDbUser ) {
992 if ( $this->mDbPass ) {
996 if ( $this->
getDbType() == self::DB_ADMIN && isset( $wgDBadminuser ) ) {
1000 if ( $wgDBservers ) {
1004 foreach ( $wgDBservers
as $i => $server ) {
1009 if ( isset( $wgLBFactoryConf[
'serverTemplate'] ) ) {
1010 $wgLBFactoryConf[
'serverTemplate'][
'user'] =
$wgDBuser;
1011 $wgLBFactoryConf[
'serverTemplate'][
'password'] =
$wgDBpassword;
1021 $wgShowSQLErrors =
true;
1023 MediaWiki\suppressWarnings();
1024 set_time_limit( 0 );
1025 MediaWiki\restoreWarnings();
1034 if ( defined(
'MW_CMDLINE_CALLBACK' ) ) {
1035 call_user_func( MW_CMDLINE_CALLBACK );
1056 if ( isset( $this->mOptions[
'conf'] ) ) {
1057 $settingsFile = $this->mOptions[
'conf'];
1058 } elseif ( defined(
"MW_CONFIG_FILE" ) ) {
1059 $settingsFile = MW_CONFIG_FILE;
1061 $settingsFile =
"$IP/LocalSettings.php";
1063 if ( isset( $this->mOptions[
'wiki'] ) ) {
1064 $bits = explode(
'-', $this->mOptions[
'wiki'] );
1065 if ( count( $bits ) == 1 ) {
1068 define(
'MW_DB', $bits[0] );
1069 define(
'MW_PREFIX', $bits[1] );
1072 if ( !is_readable( $settingsFile ) ) {
1073 $this->
error(
"A copy of your installation's LocalSettings.php\n" .
1074 "must exist and be readable in the source directory.\n" .
1075 "Use --conf to specify it.",
true );
1077 $wgCommandLineMode =
true;
1079 return $settingsFile;
1088 # Data should come off the master, wrapped in a transaction
1092 # Get "active" text records from the revisions table
1093 $this->
output(
'Searching for active text records in revisions table...' );
1094 $res = $dbw->select(
'revision',
'rev_text_id', [], __METHOD__, [
'DISTINCT' ] );
1095 foreach (
$res as $row ) {
1096 $cur[] = $row->rev_text_id;
1098 $this->
output(
"done.\n" );
1100 # Get "active" text records from the archive table
1101 $this->
output(
'Searching for active text records in archive table...' );
1102 $res = $dbw->select(
'archive',
'ar_text_id', [], __METHOD__, [
'DISTINCT' ] );
1103 foreach (
$res as $row ) {
1104 # old pre-MW 1.5 records can have null ar_text_id's.
1105 if ( $row->ar_text_id !== null ) {
1106 $cur[] = $row->ar_text_id;
1109 $this->
output(
"done.\n" );
1111 # Get the IDs of all text records not in these sets
1112 $this->
output(
'Searching for inactive text records...' );
1113 $cond =
'old_id NOT IN ( ' . $dbw->makeList( $cur ) .
' )';
1114 $res = $dbw->select(
'text',
'old_id', [ $cond ], __METHOD__, [
'DISTINCT' ] );
1116 foreach (
$res as $row ) {
1117 $old[] = $row->old_id;
1119 $this->
output(
"done.\n" );
1121 # Inform the user of what we're going to do
1123 $this->
output(
"$count inactive items found.\n" );
1125 # Delete as appropriate
1126 if ( $delete &&
$count ) {
1127 $this->
output(
'Deleting...' );
1128 $dbw->delete(
'text', [
'old_id' => $old ], __METHOD__ );
1129 $this->
output(
"done.\n" );
1154 protected function getDB( $db, $groups = [], $wiki =
false ) {
1155 if ( is_null( $this->mDb ) ) {
1156 return wfGetDB( $db, $groups, $wiki );
1200 $this->lastSlaveWait = microtime(
true );
1224 $write = [
'searchindex' ];
1234 $db->lockTables( $read, $write, __CLASS__ .
'::' . __METHOD__ );
1242 $db->unlockTables( __CLASS__ .
'::' . __METHOD__ );
1266 if ( $maxLockTime ) {
1267 $this->
output(
" --- Waiting for lock ---" );
1273 # Loop through the results and do a search update
1274 foreach ( $results
as $row ) {
1275 # Allow reads to be processed
1276 if ( $maxLockTime && time() > $lockTime + $maxLockTime ) {
1277 $this->
output(
" --- Relocking ---" );
1282 call_user_func( $callback, $dbw, $row );
1285 # Unlock searchindex
1286 if ( $maxLockTime ) {
1287 $this->
output(
" --- Unlocking --" );
1304 $titleObj =
$rev->getTitle();
1305 $title = $titleObj->getPrefixedDBkey();
1306 $this->
output(
"$title..." );
1307 # Update searchindex
1308 $u =
new SearchUpdate( $pageId, $titleObj->getText(),
$rev->getContent() );
1325 if ( !function_exists(
'posix_isatty' ) ) {
1338 static $isatty = null;
1339 if ( is_null( $isatty ) ) {
1340 $isatty = self::posix_isatty( 0 );
1343 if ( $isatty && function_exists(
'readline' ) ) {
1344 $resp = readline( $prompt );
1345 if ( $resp === null ) {
1353 $st = self::readlineEmulation( $prompt );
1355 if ( feof( STDIN ) ) {
1358 $st = fgets( STDIN, 1024 );
1361 if ( $st ===
false ) {
1364 $resp = trim( $st );
1380 $command =
"read -er -p $encPrompt && echo \"\$REPLY\"";
1397 if ( feof( STDIN ) ) {
1402 return fgets( STDIN, 1024 );
1423 parent::__construct();
1424 $this->
addOption(
'force',
'Run the update even if it was completed already' );
1433 && $db->selectRow(
'updatelog',
'1', [
'ul_key' =>
$key ], __METHOD__ )
1444 if ( $db->insert(
'updatelog', [
'ul_key' =>
$key ], __METHOD__,
'IGNORE' ) ) {
1460 return "Update '{$key}' already logged as completed.";
1470 return "Unable to log update '{$key}' as completed.";
#define the
table suitable for use with IDatabase::select()
unlockSearchindex($db)
Unlock the tables.
loadParamsAndArgs($self=null, $opts=null, $args=null)
Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs be...
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for slaves to catch up.
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
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
const DB_NONE
Constants for DB access type.
wfWaitForSlaves($ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the slaves to catch up to the master position.
const RUN_MAINTENANCE_IF_MAIN
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
float $lastSlaveWait
UNIX timestamp.
setParam(&$options, $option, $value)
Helper function used solely by loadParamsAndArgs to prevent code duplication.
$wgDBadminpassword
Separate password for maintenance tasks.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
addArg($arg, $description, $required=true)
Add some args that are needed.
getDir()
Get the maintenance directory.
array $orderedOptions
Used to read the options in the order they were passed.
static instance()
Singleton.
$wgDBpassword
Database user's password.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
begin($fname=__METHOD__)
Begin a transaction.
getName()
Get the script's name.
doUpdate()
Perform actual update for the entry.
addDefaultParams()
Add the default parameters to the scripts.
finalSetup()
Handle some last-minute setup here.
rollbackTransaction(IDatabase $dbw, $fname)
Rollback the transcation on a DB handle.
lockSearchindex($db)
Lock the search index.
afterFinalSetup()
Execute a callback function at the end of initialisation.
setConfig(Config $config)
getDB($db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption($name)
Checks to see if a particular param exists.
$wgDBuser
Database username.
static locateExecutableInDefaultPaths($names, $versionInfo=false)
Same as locateExecutable(), but checks in getPossibleBinPaths() by default.
loadSpecialVars()
Handle the special variables that are global to all scripts.
wfShellExec($cmd, &$retval=null, $environ=[], $limits=[], $options=[])
Execute a shell command, with time and memory limits mirrored from the PHP configuration if supported...
when a variable name is used in a it is silently declared as a new local masking the global
wfIsWindows()
Check if the operating system is Windows.
static posix_isatty($fd)
Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but trea...
getStdin($len=null)
Return input from stdin.
cleanupChanneled()
Clean up channeled output.
static replaceStubInstance(Profiler $profiler)
Replace the current profiler with $profiler if no non-stub profiler is set.
Database independant search index updater.
updatelogFailedMessage()
Message to show that the update log was unable to log the completion of this update.
Fake maintenance wrapper, mostly used for the web installer/updater.
activateProfiler()
Activate the profiler (assuming $wgProfiler is set)
addOption($name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
global $wgCommandLineMode
deleteOption($name)
Remove an option.
doDBUpdates()
Do the actual work.
updateSearchIndex($maxLockTime, $callback, $dbw, $results)
Perform a search index update with locking.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
relockSearchindex($db)
Unlock and lock again Since the lock is low-priority, queued reads will be able to complete...
setup()
Do some sanity checking and basic setup.
setDB(IDatabase $db)
Sets database object to be returned by getDB().
clearParamsAndArgs()
Clear all params and arguments.
hasArg($argId=0)
Does a given argument exist?
static destroyInstance()
Shut down, close connections and destroy the cached instance.
$wgDBservers
Database load balancer This is a two-dimensional array, an array of server info structures Fields are...
globals()
Potentially debug globals.
namespace and then decline to actually register it file or subcat img or subcat $title
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.
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
resource $fileHandle
Used when creating separate schema files.
addDescription($text)
Set the description text.
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
getOption($name, $default=null)
Get an option, or return the default.
IDatabase $mDb
Used by getDB() / setDB()
static shouldExecute()
Should we execute the maintenance script, or just allow it to be included as a standalone class...
output($out, $channel=null)
Throw some output to the user.
purgeRedundantText($delete=true)
Support function for cleaning up redundant text records.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
static getDefaultInstance()
commit($fname=__METHOD__, $flush= '')
Commits a transaction previously started using begin().
loadWithArgv($argv)
Load params and arguments from a given array of command-line arguments.
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
maybeHelp($force=false)
Maybe show the help.
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Class for scripts that perform database maintenance and want to log the update in updatelog so we can...
$wgDBadminuser
Separate username for maintenance tasks.
static readconsole($prompt= '> ')
Prompt the console for input.
static readlineEmulation($prompt)
Emulate readline()
memoryLimit()
Normally we disable the memory_limit when running admin scripts.
int $mBatchSize
Batch size.
error($err, $die=0)
Throw an error to the user.
static loadFromPageId($db, $pageid, $id=0)
Load either the current, or a specified, revision that's attached to a given page.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
wfEntryPointCheck($entryPoint)
Check php version and that external dependencies are installed, and display an informative error if e...
updateSearchIndexForPage($dbw, $pageId)
Update the searchindex table for a given pageid.
updateSkippedMessage()
Message to show that the update was done already and was just skipped.
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
wfEscapeShellArg()
Windows-compatible version of escapeshellarg() Windows doesn't recognise single-quotes in the shell...
$wgServer
URL of the server.
getArg($argId=0, $default=null)
Get an argument.
$wgLBFactoryConf
Load balancer factory configuration To set up a multi-master wiki farm, set the class here to somethi...
loadSettings()
Generic setup for most installs.
rollback($fname=__METHOD__, $flush= '')
Rollback a transaction previously started using begin().
setBatchSize($s=0)
Set the batch size.
float $wgRequestTime
Request start time as fractional seconds since epoch.
validateParamsAndArgs()
Run some validation checks on the params, etc.
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 local account incomplete not yet checked for validity & $retval
Config $config
Accessible via getConfig()
runChild($maintClass, $classFile=null)
Run a child maintenance script.
outputChanneled($msg, $channel=null)
Message outputter with channeled message support.
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
public function execute()
Basic database interface for live and lazy-loaded DB handles.
__construct()
Default constructor.
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
Allows to change the fields on the form that will be generated $name