MediaWiki  master
runJobs.php
Go to the documentation of this file.
1 <?php
24 if ( !defined( 'MEDIAWIKI' ) ) {
25  // So extensions (and other code) can check whether they're running in job mode.
26  // This is not defined if this script is included from installer/updater or phpunit.
27  define( 'MEDIAWIKI_JOB_RUNNER', true );
28 }
29 
30 require_once __DIR__ . '/Maintenance.php';
31 
33 
39 class RunJobs extends Maintenance {
40  public function __construct() {
41  parent::__construct();
42  $this->addDescription( 'Run pending jobs' );
43  $this->addOption( 'maxjobs', 'Maximum number of jobs to run', false, true );
44  $this->addOption( 'maxtime', 'Maximum amount of wall-clock time', false, true );
45  $this->addOption( 'type', 'Type of job to run', false, true );
46  $this->addOption( 'procs', 'Number of processes to use', false, true );
47  $this->addOption( 'nothrottle', 'Ignore job throttling configuration', false, false );
48  $this->addOption( 'result', 'Set to "json" to print only a JSON response', false, true );
49  $this->addOption( 'wait', 'Wait for new jobs instead of exiting', false, false );
50  }
51 
52  public function memoryLimit() {
53  if ( $this->hasOption( 'memory-limit' ) ) {
54  return parent::memoryLimit();
55  }
56 
57  // Don't eat all memory on the machine if we get a bad job.
58  return "150M";
59  }
60 
61  public function execute() {
62  if ( $this->hasOption( 'procs' ) ) {
63  $procs = intval( $this->getOption( 'procs' ) );
64  if ( $procs < 1 || $procs > 1000 ) {
65  $this->fatalError( "Invalid argument to --procs" );
66  } elseif ( $procs != 1 ) {
67  $fc = new ForkController( $procs );
68  if ( $fc->start() != 'child' ) {
69  exit( 0 );
70  }
71  }
72  }
73 
74  $outputJSON = ( $this->getOption( 'result' ) === 'json' );
75  $wait = $this->hasOption( 'wait' );
76 
77  $runner = new JobRunner( LoggerFactory::getInstance( 'runJobs' ) );
78  if ( !$outputJSON ) {
79  $runner->setDebugHandler( [ $this, 'debugInternal' ] );
80  }
81 
82  $type = $this->getOption( 'type', false );
83  $maxJobs = $this->getOption( 'maxjobs', false );
84  $maxTime = $this->getOption( 'maxtime', false );
85  $throttle = !$this->hasOption( 'nothrottle' );
86 
87  while ( true ) {
88  $response = $runner->run( [
89  'type' => $type,
90  'maxJobs' => $maxJobs,
91  'maxTime' => $maxTime,
92  'throttle' => $throttle,
93  ] );
94 
95  if ( $outputJSON ) {
96  $this->output( FormatJson::encode( $response, true ) );
97  }
98 
99  if (
100  !$wait ||
101  $response['reached'] === 'time-limit' ||
102  $response['reached'] === 'job-limit' ||
103  $response['reached'] === 'memory-limit'
104  ) {
105  // If job queue is empty, output it
106  if ( !$outputJSON && $response['jobs'] === [] ) {
107  $this->output( "Job queue is empty.\n" );
108  }
109  break;
110  }
111 
112  if ( $maxJobs !== false ) {
113  $maxJobs -= count( $response['jobs'] );
114  }
115 
116  sleep( 1 );
117  }
118  }
119 
123  public function debugInternal( $s ) {
124  $this->output( $s );
125  }
126 }
127 
129 require_once RUN_MAINTENANCE_IF_MAIN;
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
debugInternal( $s)
Definition: runJobs.php:123
getOption( $name, $default=null)
Get an option, or return the default.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
hasOption( $name)
Checks to see if a particular option exists.
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
this hook is for auditing only $response
Definition: hooks.txt:767
execute()
Definition: runJobs.php:61
$wait
Class for managing forking command line scripts.
addDescription( $text)
Set the description text.
Maintenance script that runs pending jobs.
Definition: runJobs.php:39
output( $out, $channel=null)
Throw some output to the user.
__construct()
Definition: runJobs.php:40
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
Definition: injection.txt:35
memoryLimit()
Definition: runJobs.php:52
Job queue runner utility methods.
Definition: JobRunner.php:39
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
Definition: maintenance.txt:52
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
Definition: logger.txt:5
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
$maintClass
Definition: runJobs.php:128