MediaWiki  1.23.8
SpecialRunJobs.php
Go to the documentation of this file.
1 <?php
31  public function __construct() {
32  parent::__construct( 'RunJobs' );
33  }
34 
35  public function execute( $par = '' ) {
36  $this->getOutput()->disable();
37 
38  if ( wfReadOnly() ) {
39  header( "HTTP/1.0 423 Locked" );
40  print 'Wiki is in read-only mode';
41 
42  return;
43  } elseif ( !$this->getRequest()->wasPosted() ) {
44  header( "HTTP/1.0 400 Bad Request" );
45  print 'Request must be POSTed';
46 
47  return;
48  }
49 
50  $optional = array( 'maxjobs' => 0 );
51  $required = array_flip( array( 'title', 'tasks', 'signature', 'sigexpiry' ) );
52 
53  $params = array_intersect_key( $this->getRequest()->getValues(), $required + $optional );
54  $missing = array_diff_key( $required, $params );
55  if ( count( $missing ) ) {
56  header( "HTTP/1.0 400 Bad Request" );
57  print 'Missing parameters: ' . implode( ', ', array_keys( $missing ) );
58 
59  return;
60  }
61 
62  $squery = $params;
63  unset( $squery['signature'] );
64  $cSig = self::getQuerySignature( $squery ); // correct signature
65  $rSig = $params['signature']; // provided signature
66 
67  // Constant-time signature verification
68  // http://www.emerose.com/timing-attacks-explained
69  // @todo: make a common method for this
70  if ( !is_string( $rSig ) || strlen( $rSig ) !== strlen( $cSig ) ) {
71  $verified = false;
72  } else {
73  $result = 0;
74  for ( $i = 0; $i < strlen( $cSig ); $i++ ) {
75  $result |= ord( $cSig[$i] ) ^ ord( $rSig[$i] );
76  }
77  $verified = ( $result == 0 );
78  }
79  if ( !$verified || $params['sigexpiry'] < time() ) {
80  header( "HTTP/1.0 400 Bad Request" );
81  print 'Invalid or stale signature provided';
82 
83  return;
84  }
85 
86  // Apply any default parameter values
87  $params += $optional;
88 
89  // Client will usually disconnect before checking the response,
90  // but it needs to know when it is safe to disconnect. Until this
91  // reaches ignore_user_abort(), it is not safe as the jobs won't run.
92  ignore_user_abort( true ); // jobs may take a bit of time
93  header( "HTTP/1.0 202 Accepted" );
94  ob_flush();
95  flush();
96  // Once the client receives this response, it can disconnect
97 
98  // Do all of the specified tasks...
99  if ( in_array( 'jobs', explode( '|', $params['tasks'] ) ) ) {
100  self::executeJobs( (int)$params['maxjobs'] );
101  }
102  }
103 
108  public static function getQuerySignature( array $query ) {
109  global $wgSecretKey;
110 
111  ksort( $query ); // stable order
112  return hash_hmac( 'sha1', wfArrayToCgi( $query ), $wgSecretKey );
113  }
114 
123  public static function executeJobs( $maxJobs ) {
124  $n = $maxJobs; // number of jobs to run
125  if ( $n < 1 ) {
126  return;
127  }
128  try {
129  $group = JobQueueGroup::singleton();
130  $count = $group->executeReadyPeriodicTasks();
131  if ( $count > 0 ) {
132  wfDebugLog( 'jobqueue', "Executed $count periodic queue task(s)." );
133  }
134 
135  do {
137  if ( $job ) {
138  $output = $job->toString() . "\n";
139  $t = -microtime( true );
140  wfProfileIn( __METHOD__ . '-' . get_class( $job ) );
141  $success = $job->run();
142  wfProfileOut( __METHOD__ . '-' . get_class( $job ) );
143  $group->ack( $job ); // done
144  $t += microtime( true );
145  $t = round( $t * 1000 );
146  if ( $success === false ) {
147  $output .= "Error: " . $job->getLastError() . ", Time: $t ms\n";
148  } else {
149  $output .= "Success, Time: $t ms\n";
150  }
151  wfDebugLog( 'jobqueue', $output );
152  }
153  } while ( --$n && $job );
154  } catch ( MWException $e ) {
156  // We don't want exceptions thrown during job execution to
157  // be reported to the user since the output is already sent.
158  // Instead we just log them.
160  }
161  }
162 }
SpecialRunJobs\__construct
__construct()
Definition: SpecialRunJobs.php:31
JobQueueGroup\USE_CACHE
const USE_CACHE
Definition: JobQueueGroup.php:43
$result
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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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
Definition: hooks.txt:1528
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:535
UnlistedSpecialPage
Shortcut to construct a special page which is unlisted by default.
Definition: UnlistedSpecialPage.php:29
JobQueueGroup\TYPE_DEFAULT
const TYPE_DEFAULT
Definition: JobQueueGroup.php:40
wfDebugLog
wfDebugLog( $logGroup, $text, $dest='all')
Send a line to a supplementary debug log file, if configured, or main debug log if not.
Definition: GlobalFunctions.php:1040
wfProfileIn
wfProfileIn( $functionname)
Begin profiling of a function.
Definition: Profiler.php:33
$n
$n
Definition: RandomTest.php:76
$params
$params
Definition: styleTest.css.php:40
wfReadOnly
wfReadOnly()
Check whether the wiki is in read-only mode.
Definition: GlobalFunctions.php:1313
$success
$success
Definition: Utf8Test.php:91
MWException
MediaWiki exception.
Definition: MWException.php:26
wfProfileOut
wfProfileOut( $functionname='missing')
Stop profiling of a function.
Definition: Profiler.php:46
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
SpecialRunJobs\executeJobs
static executeJobs( $maxJobs)
Run jobs from the job queue.
Definition: SpecialRunJobs.php:123
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:525
SpecialRunJobs\getQuerySignature
static getQuerySignature(array $query)
Definition: SpecialRunJobs.php:108
$count
$count
Definition: UtfNormalTest2.php:96
$job
if(count( $args)< 1) $job
Definition: recompressTracked.php:42
MWExceptionHandler\rollbackMasterChangesAndLog
static rollbackMasterChangesAndLog(Exception $e)
If there are any open database transactions, roll them back and log the stack trace of the exception ...
Definition: MWExceptionHandler.php:111
$output
& $output
Definition: hooks.txt:375
JobQueueGroup\singleton
static singleton( $wiki=false)
Definition: JobQueueGroup.php:61
MWExceptionHandler\logException
static logException(Exception $e)
Log an exception to the exception log (if enabled).
Definition: MWExceptionHandler.php:351
SpecialRunJobs
Special page designed for running background tasks (internal use only)
Definition: SpecialRunJobs.php:30
$t
$t
Definition: testCompression.php:65
SpecialRunJobs\execute
execute( $par='')
Default execute method Checks user permissions, calls the function given in mFunction.
Definition: SpecialRunJobs.php:35
$e
if( $useReadline) $e
Definition: eval.php:66
$query
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes two arrays as input, and returns a CGI-style string, e.g.
Definition: GlobalFunctions.php:367