MediaWiki  master
Status.php
Go to the documentation of this file.
1 <?php
40 class Status extends StatusValue {
42  public $cleanCallback = false;
43 
55  public static function wrap( $sv ) {
56  if ( $sv instanceof static ) {
57  return $sv;
58  }
59 
60  $result = new static();
61  $result->ok =& $sv->ok;
62  $result->errors =& $sv->errors;
63  $result->value =& $sv->value;
64  $result->successCount =& $sv->successCount;
65  $result->failCount =& $sv->failCount;
66  $result->success =& $sv->success;
67 
68  return $result;
69  }
70 
78  function __get( $name ) {
79  if ( $name === 'ok' ) {
80  return $this->isOK();
81  }
82  if ( $name === 'errors' ) {
83  return $this->getErrors();
84  }
85 
86  throw new RuntimeException( "Cannot get '$name' property." );
87  }
88 
97  function __set( $name, $value ) {
98  if ( $name === 'ok' ) {
99  $this->setOK( $value );
100  } elseif ( !property_exists( $this, $name ) ) {
101  // Caller is using undeclared ad-hoc properties
102  $this->$name = $value;
103  } else {
104  throw new RuntimeException( "Cannot set '$name' property." );
105  }
106  }
107 
119  public function splitByErrorType() {
120  list( $errorsOnlyStatus, $warningsOnlyStatus ) = parent::splitByErrorType();
121  $errorsOnlyStatus->cleanCallback =
122  $warningsOnlyStatus->cleanCallback = $this->cleanCallback;
123 
124  return [ $errorsOnlyStatus, $warningsOnlyStatus ];
125  }
126 
132  public function getStatusValue() {
133  return $this;
134  }
135 
140  protected function cleanParams( array $params ) {
141  if ( !$this->cleanCallback ) {
142  return $params;
143  }
144  $cleanParams = [];
145  foreach ( $params as $i => $param ) {
146  $cleanParams[$i] = call_user_func( $this->cleanCallback, $param );
147  }
148  return $cleanParams;
149  }
150 
156  protected function languageFromParam( $lang ) {
157  if ( $lang === null ) {
158  return RequestContext::getMain()->getLanguage();
159  }
160  if ( $lang instanceof Language || $lang instanceof StubUserLang ) {
161  return $lang;
162  }
163  return Language::factory( $lang );
164  }
165 
175  public function getWikiText( $shortContext = false, $longContext = false, $lang = null ) {
176  $lang = $this->languageFromParam( $lang );
177 
178  $rawErrors = $this->getErrors();
179  if ( count( $rawErrors ) === 0 ) {
180  if ( $this->isOK() ) {
181  $this->fatal( 'internalerror_info',
182  __METHOD__ . " called for a good result, this is incorrect\n" );
183  } else {
184  $this->fatal( 'internalerror_info',
185  __METHOD__ . ": Invalid result object: no error text but not OK\n" );
186  }
187  $rawErrors = $this->getErrors(); // just added a fatal
188  }
189  if ( count( $rawErrors ) === 1 ) {
190  $s = $this->getErrorMessage( $rawErrors[0], $lang )->plain();
191  if ( $shortContext ) {
192  $s = wfMessage( $shortContext, $s )->inLanguage( $lang )->plain();
193  } elseif ( $longContext ) {
194  $s = wfMessage( $longContext, "* $s\n" )->inLanguage( $lang )->plain();
195  }
196  } else {
197  $errors = $this->getErrorMessageArray( $rawErrors, $lang );
198  foreach ( $errors as &$error ) {
199  $error = $error->plain();
200  }
201  $s = '* ' . implode( "\n* ", $errors ) . "\n";
202  if ( $longContext ) {
203  $s = wfMessage( $longContext, $s )->inLanguage( $lang )->plain();
204  } elseif ( $shortContext ) {
205  $s = wfMessage( $shortContext, "\n$s\n" )->inLanguage( $lang )->plain();
206  }
207  }
208  return $s;
209  }
210 
231  public function getMessage( $shortContext = false, $longContext = false, $lang = null ) {
232  $lang = $this->languageFromParam( $lang );
233 
234  $rawErrors = $this->getErrors();
235  if ( count( $rawErrors ) === 0 ) {
236  if ( $this->isOK() ) {
237  $this->fatal( 'internalerror_info',
238  __METHOD__ . " called for a good result, this is incorrect\n" );
239  } else {
240  $this->fatal( 'internalerror_info',
241  __METHOD__ . ": Invalid result object: no error text but not OK\n" );
242  }
243  $rawErrors = $this->getErrors(); // just added a fatal
244  }
245  if ( count( $rawErrors ) === 1 ) {
246  $s = $this->getErrorMessage( $rawErrors[0], $lang );
247  if ( $shortContext ) {
248  $s = wfMessage( $shortContext, $s )->inLanguage( $lang );
249  } elseif ( $longContext ) {
250  $wrapper = new RawMessage( "* \$1\n" );
251  $wrapper->params( $s )->parse();
252  $s = wfMessage( $longContext, $wrapper )->inLanguage( $lang );
253  }
254  } else {
255  $msgs = $this->getErrorMessageArray( $rawErrors, $lang );
256  $msgCount = count( $msgs );
257 
258  $s = new RawMessage( '* $' . implode( "\n* \$", range( 1, $msgCount ) ) );
259  $s->params( $msgs )->parse();
260 
261  if ( $longContext ) {
262  $s = wfMessage( $longContext, $s )->inLanguage( $lang );
263  } elseif ( $shortContext ) {
264  $wrapper = new RawMessage( "\n\$1\n", [ $s ] );
265  $wrapper->parse();
266  $s = wfMessage( $shortContext, $wrapper )->inLanguage( $lang );
267  }
268  }
269 
270  return $s;
271  }
272 
283  protected function getErrorMessage( $error, $lang = null ) {
284  if ( is_array( $error ) ) {
285  if ( isset( $error['message'] ) && $error['message'] instanceof Message ) {
286  $msg = $error['message'];
287  } elseif ( isset( $error['message'] ) && isset( $error['params'] ) ) {
288  $msg = wfMessage( $error['message'],
289  array_map( 'wfEscapeWikiText', $this->cleanParams( $error['params'] ) ) );
290  } else {
291  $msgName = array_shift( $error );
292  $msg = wfMessage( $msgName,
293  array_map( 'wfEscapeWikiText', $this->cleanParams( $error ) ) );
294  }
295  } elseif ( is_string( $error ) ) {
296  $msg = wfMessage( $error );
297  } else {
298  throw new UnexpectedValueException( 'Got ' . get_class( $error ) . ' for key.' );
299  }
300 
301  $msg->inLanguage( $this->languageFromParam( $lang ) );
302  return $msg;
303  }
304 
313  public function getHTML( $shortContext = false, $longContext = false, $lang = null ) {
314  $lang = $this->languageFromParam( $lang );
315  $text = $this->getWikiText( $shortContext, $longContext, $lang );
316  $out = MessageCache::singleton()->parse( $text, null, true, true, $lang );
317  return $out instanceof ParserOutput
318  ? $out->getText( [ 'enableSectionEditLinks' => false ] )
319  : $out;
320  }
321 
328  protected function getErrorMessageArray( $errors, $lang = null ) {
329  $lang = $this->languageFromParam( $lang );
330  return array_map( function ( $e ) use ( $lang ) {
331  return $this->getErrorMessage( $e, $lang );
332  }, $errors );
333  }
334 
342  public function getErrorsArray() {
343  return $this->getStatusArray( 'error' );
344  }
345 
353  public function getWarningsArray() {
354  return $this->getStatusArray( 'warning' );
355  }
356 
365  protected function getStatusArray( $type = false ) {
366  $result = [];
367 
368  foreach ( $this->getErrors() as $error ) {
369  if ( $type === false || $error['type'] === $type ) {
370  if ( $error['message'] instanceof MessageSpecifier ) {
371  $result[] = array_merge(
372  [ $error['message']->getKey() ],
373  $error['message']->getParams()
374  );
375  } elseif ( $error['params'] ) {
376  $result[] = array_merge( [ $error['message'] ], $error['params'] );
377  } else {
378  $result[] = [ $error['message'] ];
379  }
380  }
381  }
382 
383  return $result;
384  }
385 
391  function __sleep() {
392  $keys = array_keys( get_object_vars( $this ) );
393  return array_diff( $keys, [ 'cleanCallback' ] );
394  }
395 
399  function __wakeup() {
400  $this->cleanCallback = false;
401  }
402 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
getStatusArray( $type=false)
Returns a list of status messages of the given type (or all if false)
Definition: Status.php:365
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
__wakeup()
Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
Definition: Status.php:399
array [] $errors
Definition: StatusValue.php:48
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
if(!isset( $args[0])) $lang
__sleep()
Don&#39;t save the callback when serializing, because Closures can&#39;t be serialized and we&#39;re going to cle...
Definition: Status.php:391
splitByErrorType()
Splits this Status object into two new Status objects, one which contains only the error messages...
Definition: Status.php:119
getWikiText( $shortContext=false, $longContext=false, $lang=null)
Get the error list as a wikitext formatted list.
Definition: Status.php:175
getWarningsArray()
Get the list of warnings (but not errors)
Definition: Status.php:353
callable false $cleanCallback
Definition: Status.php:42
getMessage( $shortContext=false, $longContext=false, $lang=null)
Get a bullet list of the errors as a Message object.
Definition: Status.php:231
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. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. '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 '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 '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 '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. '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 IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() '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 Sanitizer::validateEmail(), 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 '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:Array with elements of the form "language:title" in the order that they will be output. & $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. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. 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:1980
cleanParams(array $params)
Definition: Status.php:140
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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
Definition: hooks.txt:780
getStatusValue()
Returns the wrapped StatusValue object.
Definition: Status.php:132
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
getErrorsArray()
Get the list of errors (but not warnings)
Definition: Status.php:342
setOK( $ok)
Change operation status.
$params
__set( $name, $value)
Change operation result Backwards compatibility logic.
Definition: Status.php:97
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:215
isOK()
Returns whether the operation completed.
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
languageFromParam( $lang)
Definition: Status.php:156
mixed $value
Definition: StatusValue.php:51
getErrorMessageArray( $errors, $lang=null)
Return an array with a Message object for each error.
Definition: Status.php:328
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition: Status.php:55
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
__get( $name)
Backwards compatibility logic.
Definition: Status.php:78
Variant of the Message class.
Definition: RawMessage.php:34
Stub object for the user language.
getErrors()
Get the list of errors.
getHTML( $shortContext=false, $longContext=false, $lang=null)
Get the error message as HTML.
Definition: Status.php:313
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
fatal( $message)
Add an error and set OK to false, indicating that the operation as a whole was fatal.
getErrorMessage( $error, $lang=null)
Return the message for a single error.
Definition: Status.php:283
static singleton()
Get the signleton instance of this class.