MediaWiki  1.23.2
PoolCounterWork.php
Go to the documentation of this file.
1 <?php
27 abstract class PoolCounterWork {
28  protected $cacheable = false; //Does this override getCachedWork() ?
29 
34  public function __construct( $type, $key ) {
35  $this->poolCounter = PoolCounter::factory( $type, $key );
36  }
37 
42  abstract public function doWork();
43 
48  public function getCachedWork() {
49  return false;
50  }
51 
57  public function fallback() {
58  return false;
59  }
60 
65  public function error( $status ) {
66  return false;
67  }
68 
75  public function logError( $status ) {
76  $key = $this->poolCounter->getKey();
77 
78  wfDebugLog( 'poolcounter', "Pool key '$key': "
79  . $status->getMessage()->inLanguage( 'en' )->useDatabase( false )->text() );
80  }
81 
97  public function execute( $skipcache = false ) {
98  if ( $this->cacheable && !$skipcache ) {
99  $status = $this->poolCounter->acquireForAnyone();
100  } else {
101  $status = $this->poolCounter->acquireForMe();
102  }
103 
104  if ( !$status->isOK() ) {
105  // Respond gracefully to complete server breakage: just log it and do the work
106  $this->logError( $status );
107  return $this->doWork();
108  }
109 
110  switch ( $status->value ) {
111  case PoolCounter::LOCKED:
112  $result = $this->doWork();
113  $this->poolCounter->release();
114  return $result;
115 
116  case PoolCounter::DONE:
117  $result = $this->getCachedWork();
118  if ( $result === false ) {
119  /* That someone else work didn't serve us.
120  * Acquire the lock for me
121  */
122  return $this->execute( true );
123  }
124  return $result;
125 
128  $result = $this->fallback();
129 
130  if ( $result !== false ) {
131  return $result;
132  }
133  /* no break */
134 
135  /* These two cases should never be hit... */
136  case PoolCounter::ERROR:
137  default:
138  $errors = array(
139  PoolCounter::QUEUE_FULL => 'pool-queuefull',
140  PoolCounter::TIMEOUT => 'pool-timeout' );
141 
142  $status = Status::newFatal( isset( $errors[$status->value] )
143  ? $errors[$status->value]
144  : 'pool-errorunknown' );
145  $this->logError( $status );
146  return $this->error( $status );
147  }
148  }
149 }
150 
157  protected $doWork;
159  protected $doCachedWork;
161  protected $fallback;
163  protected $error;
164 
179  public function __construct( $type, $key, array $callbacks ) {
180  parent::__construct( $type, $key );
181  foreach ( array( 'doWork', 'doCachedWork', 'fallback', 'error' ) as $name ) {
182  if ( isset( $callbacks[$name] ) ) {
183  if ( !is_callable( $callbacks[$name] ) ) {
184  throw new MWException( "Invalid callback provided for '$name' function." );
185  }
186  $this->$name = $callbacks[$name];
187  }
188  }
189  if ( !isset( $this->doWork ) ) {
190  throw new MWException( "No callback provided for 'doWork' function." );
191  }
192  $this->cacheable = isset( $this->doCachedWork );
193  }
194 
195  public function doWork() {
196  return call_user_func_array( $this->doWork, array() );
197  }
198 
199  public function getCachedWork() {
200  if ( $this->doCachedWork ) {
201  return call_user_func_array( $this->doCachedWork, array() );
202  }
203  return false;
204  }
205 
206  public function fallback() {
207  if ( $this->fallback ) {
208  return call_user_func_array( $this->fallback, array() );
209  }
210  return false;
211  }
212 
213  public function error( $status ) {
214  if ( $this->error ) {
215  return call_user_func_array( $this->error, array( $status ) );
216  }
217  return false;
218  }
219 }
$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
PoolCounterWork\fallback
fallback()
A work not so good (eg.
Definition: PoolCounterWork.php:57
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
PoolCounterWork\__construct
__construct( $type, $key)
Definition: PoolCounterWork.php:34
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
PoolCounter\LOCKED
const LOCKED
Definition: PoolCounter.php:44
PoolCounterWork\doWork
doWork()
Actually perform the work, caching it if needed.
PoolCounterWorkViaCallback
Convenience class for dealing with PoolCounters using callbacks.
Definition: PoolCounterWork.php:155
PoolCounterWorkViaCallback\fallback
fallback()
A work not so good (eg.
Definition: PoolCounterWork.php:202
PoolCounterWorkViaCallback\doWork
doWork()
Actually perform the work, caching it if needed.
Definition: PoolCounterWork.php:191
PoolCounterWorkViaCallback\$fallback
callable null $fallback
Definition: PoolCounterWork.php:158
PoolCounterWorkViaCallback\error
error( $status)
Do something with the error, like showing it to the user.
Definition: PoolCounterWork.php:209
MWException
MediaWiki exception.
Definition: MWException.php:26
PoolCounterWorkViaCallback\getCachedWork
getCachedWork()
Retrieve the work from cache.
Definition: PoolCounterWork.php:195
PoolCounterWorkViaCallback\$error
callable null $error
Definition: PoolCounterWork.php:159
PoolCounterWorkViaCallback\__construct
__construct( $type, $key, array $callbacks)
Build a PoolCounterWork class from a type, key, and callback map.
Definition: PoolCounterWork.php:175
PoolCounterWork\execute
execute( $skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
Definition: PoolCounterWork.php:97
PoolCounterWork\$cacheable
$cacheable
Definition: PoolCounterWork.php:28
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
PoolCounterWork\getCachedWork
getCachedWork()
Retrieve the work from cache.
Definition: PoolCounterWork.php:48
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
PoolCounter\QUEUE_FULL
const QUEUE_FULL
Definition: PoolCounter.php:50
PoolCounter\ERROR
const ERROR
Definition: PoolCounter.php:48
PoolCounter\factory
static factory( $type, $key)
Create a Pool counter.
Definition: PoolCounter.php:80
PoolCounterWork\error
error( $status)
Do something with the error, like showing it to the user.
Definition: PoolCounterWork.php:65
as
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
Definition: distributors.txt:9
PoolCounterWork
Class for dealing with PoolCounters using class members.
Definition: PoolCounterWork.php:27
PoolCounterWorkViaCallback\$doCachedWork
callable null $doCachedWork
Definition: PoolCounterWork.php:157
PoolCounterWorkViaCallback\$doWork
callable $doWork
Definition: PoolCounterWork.php:156
PoolCounter\TIMEOUT
const TIMEOUT
Definition: PoolCounter.php:51
PoolCounterWork\logError
logError( $status)
Log an error.
Definition: PoolCounterWork.php:75
PoolCounter\DONE
const DONE
Definition: PoolCounter.php:46
Status\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: Status.php:63
$type
$type
Definition: testCompression.php:46