MediaWiki  1.23.6
RunJobs Class Reference

Maintenance script that runs pending jobs. More...

Inheritance diagram for RunJobs:
Collaboration diagram for RunJobs:

Public Member Functions

 __construct ()
 Default constructor. More...
 
 execute ()
 Do the actual work. More...
 
 memoryLimit ()
 Normally we disable the memory_limit when running admin scripts. More...
 
- Public Member Functions inherited from Maintenance
 cleanupChanneled ()
 Clean up channeled output. More...
 
 clearParamsAndArgs ()
 Clear all params and arguments. More...
 
 finalSetup ()
 Handle some last-minute setup here. More...
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB. More...
 
 getName ()
 Get the script's name. More...
 
 globals ()
 Potentially debug globals. More...
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments. More...
 
 loadSettings ()
 Generic setup for most installs. More...
 
 outputChanneled ( $msg, $channel=null)
 Message outputter with channeled message support. More...
 
 purgeRedundantText ( $delete=true)
 Support function for cleaning up redundant text records. More...
 
 runChild ( $maintClass, $classFile=null)
 Run a child maintenance script. More...
 
 setDB (&$db)
 Sets database object to be returned by getDB(). More...
 
 setup ()
 Do some sanity checking and basic setup. More...
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking. More...
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid. More...
 

Private Member Functions

 assertMemoryOK ()
 Make sure that this script is not too close to the memory usage limit. More...
 
 getBackoffTimeToWait (Job $job)
 
 loadBackoffs ()
 Get the previous backoff expiries from persistent storage. More...
 
 runJobsLog ( $msg)
 Log the job message. More...
 
 syncBackoffs (array $backoffs)
 Merge the current backoff expiries from persistent storage. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
static posix_isatty ( $fd)
 Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes. More...
 
static readconsole ( $prompt='> ')
 Prompt the console for input. More...
 
static shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope) More...
 
- Public Attributes inherited from Maintenance
resource $fileHandle
 Used when creating separate schema files. More...
 
 $mDbPass
 
const DB_ADMIN = 2
 
const DB_NONE = 0
 Constants for DB access type. More...
 
const DB_STD = 1
 
const STDIN_ALL = 'all'
 
- Protected Member Functions inherited from Maintenance
 addArg ( $arg, $description, $required=true)
 Add some args that are needed. More...
 
 addDefaultParams ()
 Add the default parameters to the scripts. More...
 
 addDescription ( $text)
 Set the description text. More...
 
 addOption ( $name, $description, $required=false, $withArg=false, $shortName=false)
 Add a parameter to the script. More...
 
 adjustMemoryLimit ()
 Adjusts PHP's memory limit to better suit our needs, if needed. More...
 
 afterFinalSetup ()
 Execute a callback function at the end of initialisation. More...
 
 deleteOption ( $name)
 Remove an option. More...
 
 error ( $err, $die=0)
 Throw an error to the user. More...
 
 getArg ( $argId=0, $default=null)
 Get an argument. More...
 
getDB ( $db, $groups=array(), $wiki=false)
 Returns a database to be used by current maintenance script. More...
 
 getDir ()
 Get the maintenance directory. More...
 
 getOption ( $name, $default=null)
 Get an option, or return the default. More...
 
 getStdin ( $len=null)
 Return input from stdin. More...
 
 hasArg ( $argId=0)
 Does a given argument exist? More...
 
 hasOption ( $name)
 Checks to see if a particular param exists. More...
 
 loadSpecialVars ()
 Handle the special variables that are global to all scripts. More...
 
 maybeHelp ( $force=false)
 Maybe show the help. More...
 
 output ( $out, $channel=null)
 Throw some output to the user. More...
 
 setBatchSize ( $s=0)
 Set the batch size. More...
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc. More...
 
- Protected Attributes inherited from Maintenance
 $mArgList = array()
 
 $mArgs = array()
 
int $mBatchSize = null
 Batch size. More...
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = array()
 
 $mParams = array()
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = array()
 

Detailed Description

Maintenance script that runs pending jobs.

Definition at line 31 of file runJobs.php.

Constructor & Destructor Documentation

◆ __construct()

RunJobs::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 32 of file runJobs.php.

References Maintenance\addOption().

Member Function Documentation

◆ assertMemoryOK()

RunJobs::assertMemoryOK ( )
private

Make sure that this script is not too close to the memory usage limit.

It is better to die in between jobs than OOM right in the middle of one.

Exceptions
MWException

Definition at line 244 of file runJobs.php.

References array(), and list.

Referenced by execute().

◆ execute()

◆ getBackoffTimeToWait()

RunJobs::getBackoffTimeToWait ( Job  $job)
private
Parameters
Job$job
Returns
integer Seconds for this runner to avoid doing more jobs of this type
See also
$wgJobBackoffThrottling

Definition at line 173 of file runJobs.php.

References $job, and global.

Referenced by execute().

◆ loadBackoffs()

RunJobs::loadBackoffs ( )
private

Get the previous backoff expiries from persistent storage.

Returns
array Map of (job type => backoff expiry timestamp)

Definition at line 199 of file runJobs.php.

References $file, $section, array(), and wfTempDir().

Referenced by execute().

◆ memoryLimit()

RunJobs::memoryLimit ( )

Normally we disable the memory_limit when running admin scripts.

Some scripts may wish to actually set a limit, however, to avoid blowing up unexpectedly. We also support a –memory-limit option, to allow sysadmins to explicitly set one if they'd prefer to override defaults (or for people using Suhosin which yells at you for trying to disable the limits)

Returns
string

Reimplemented from Maintenance.

Definition at line 42 of file runJobs.php.

References Maintenance\hasOption().

◆ runJobsLog()

RunJobs::runJobsLog (   $msg)
private

Log the job message.

Parameters
$msgString The message to log

Definition at line 266 of file runJobs.php.

References Maintenance\output(), TS_DB, wfDebugLog(), and wfTimestamp().

Referenced by execute().

◆ syncBackoffs()

RunJobs::syncBackoffs ( array  $backoffs)
private

Merge the current backoff expiries from persistent storage.

Parameters
array$backoffsMap of (job type => backoff expiry timestamp)

Definition at line 221 of file runJobs.php.

References $file, $section, $timestamp, $type, array(), as, and wfTempDir().

Referenced by execute().


The documentation for this class was generated from the following file: