MediaWiki  master
Status.php
Go to the documentation of this file.
1 <?php
26 
46 class Status extends StatusValue {
48  public $cleanCallback = false;
49 
51  protected $messageLocalizer;
52 
64  public static function wrap( $sv ) {
65  if ( $sv instanceof static ) {
66  return $sv;
67  }
68 
69  $result = new static();
70  $result->ok =& $sv->ok;
71  $result->errors =& $sv->errors;
72  $result->value =& $sv->value;
73  $result->successCount =& $sv->successCount;
74  $result->failCount =& $sv->failCount;
75  $result->success =& $sv->success;
76 
77  return $result;
78  }
79 
87  public function __get( $name ) {
88  if ( $name === 'ok' ) {
89  return $this->isOK();
90  }
91  if ( $name === 'errors' ) {
92  return $this->getErrors();
93  }
94 
95  throw new RuntimeException( "Cannot get '$name' property." );
96  }
97 
106  public function __set( $name, $value ) {
107  if ( $name === 'ok' ) {
108  $this->setOK( $value );
109  } elseif ( !property_exists( $this, $name ) ) {
110  // Caller is using undeclared ad-hoc properties
111  $this->$name = $value;
112  } else {
113  throw new RuntimeException( "Cannot set '$name' property." );
114  }
115  }
116 
128  $this->messageLocalizer = $messageLocalizer;
129  }
130 
142  public function splitByErrorType() {
143  [ $errorsOnlyStatus, $warningsOnlyStatus ] = parent::splitByErrorType();
144  // phan/phan#2133?
145  '@phan-var Status $errorsOnlyStatus';
146  '@phan-var Status $warningsOnlyStatus';
147 
148  if ( $this->messageLocalizer ) {
149  $errorsOnlyStatus->setMessageLocalizer( $this->messageLocalizer );
150  $warningsOnlyStatus->setMessageLocalizer( $this->messageLocalizer );
151  }
152  $errorsOnlyStatus->cleanCallback =
153  $warningsOnlyStatus->cleanCallback = $this->cleanCallback;
154 
155  return [ $errorsOnlyStatus, $warningsOnlyStatus ];
156  }
157 
163  public function getStatusValue() {
164  return $this;
165  }
166 
171  protected function cleanParams( array $params ) {
172  if ( !$this->cleanCallback ) {
173  return $params;
174  }
175  $cleanParams = [];
176  foreach ( $params as $i => $param ) {
177  $cleanParams[$i] = call_user_func( $this->cleanCallback, $param );
178  }
179  return $cleanParams;
180  }
181 
191  public function getWikiText( $shortContext = false, $longContext = false, $lang = null ) {
192  $rawErrors = $this->getErrors();
193  if ( count( $rawErrors ) === 0 ) {
194  if ( $this->isOK() ) {
195  $this->fatal( 'internalerror_info',
196  __METHOD__ . " called for a good result, this is incorrect\n" );
197  } else {
198  $this->fatal( 'internalerror_info',
199  __METHOD__ . ": Invalid result object: no error text but not OK\n" );
200  }
201  $rawErrors = $this->getErrors(); // just added a fatal
202  }
203  if ( count( $rawErrors ) === 1 ) {
204  $s = $this->getErrorMessage( $rawErrors[0], $lang )->plain();
205  if ( $shortContext ) {
206  $s = $this->msgInLang( $shortContext, $lang, $s )->plain();
207  } elseif ( $longContext ) {
208  $s = $this->msgInLang( $longContext, $lang, "* $s\n" )->plain();
209  }
210  } else {
211  $errors = $this->getErrorMessageArray( $rawErrors, $lang );
212  foreach ( $errors as &$error ) {
213  $error = $error->plain();
214  }
215  $s = '* ' . implode( "\n* ", $errors ) . "\n";
216  if ( $longContext ) {
217  $s = $this->msgInLang( $longContext, $lang, $s )->plain();
218  } elseif ( $shortContext ) {
219  $s = $this->msgInLang( $shortContext, $lang, "\n$s\n" )->plain();
220  }
221  }
222  return $s;
223  }
224 
245  public function getMessage( $shortContext = false, $longContext = false, $lang = null ) {
246  $rawErrors = $this->getErrors();
247  if ( count( $rawErrors ) === 0 ) {
248  if ( $this->isOK() ) {
249  $this->fatal( 'internalerror_info',
250  __METHOD__ . " called for a good result, this is incorrect\n" );
251  } else {
252  $this->fatal( 'internalerror_info',
253  __METHOD__ . ": Invalid result object: no error text but not OK\n" );
254  }
255  $rawErrors = $this->getErrors(); // just added a fatal
256  }
257  if ( count( $rawErrors ) === 1 ) {
258  $s = $this->getErrorMessage( $rawErrors[0], $lang );
259  if ( $shortContext ) {
260  $s = $this->msgInLang( $shortContext, $lang, $s );
261  } elseif ( $longContext ) {
262  $wrapper = new RawMessage( "* \$1\n" );
263  $wrapper->params( $s )->parse();
264  $s = $this->msgInLang( $longContext, $lang, $wrapper );
265  }
266  } else {
267  $msgs = $this->getErrorMessageArray( $rawErrors, $lang );
268  $msgCount = count( $msgs );
269 
270  $s = new RawMessage( '* $' . implode( "\n* \$", range( 1, $msgCount ) ) );
271  $s->params( $msgs )->parse();
272 
273  if ( $longContext ) {
274  $s = $this->msgInLang( $longContext, $lang, $s );
275  } elseif ( $shortContext ) {
276  $wrapper = new RawMessage( "\n\$1\n", [ $s ] );
277  $wrapper->parse();
278  $s = $this->msgInLang( $shortContext, $lang, $wrapper );
279  }
280  }
281 
282  return $s;
283  }
284 
295  protected function getErrorMessage( $error, $lang = null ) {
296  if ( is_array( $error ) ) {
297  if ( isset( $error['message'] ) && $error['message'] instanceof Message ) {
298  // Apply context from MessageLocalizer even if we have a Message object already
299  $msg = $this->msg( $error['message'] );
300  } elseif ( isset( $error['message'] ) && isset( $error['params'] ) ) {
301  $msg = $this->msg( $error['message'], array_map( static function ( $param ) {
302  return is_string( $param ) ? wfEscapeWikiText( $param ) : $param;
303  }, $this->cleanParams( $error['params'] ) ) );
304  } else {
305  $msgName = array_shift( $error );
306  $msg = $this->msg( $msgName, array_map( static function ( $param ) {
307  return is_string( $param ) ? wfEscapeWikiText( $param ) : $param;
308  }, $this->cleanParams( $error ) ) );
309  }
310  } elseif ( is_string( $error ) ) {
311  $msg = $this->msg( $error );
312  } else {
313  throw new UnexpectedValueException( 'Got ' . get_class( $error ) . ' for key.' );
314  }
315 
316  if ( $lang ) {
317  $msg->inLanguage( $lang );
318  }
319  return $msg;
320  }
321 
330  public function getHTML( $shortContext = false, $longContext = false, $lang = null ) {
331  $text = $this->getWikiText( $shortContext, $longContext, $lang );
332  $out = MediaWikiServices::getInstance()->getMessageCache()
333  ->parse( $text, null, true, true, $lang );
334  return $out instanceof ParserOutput
335  ? $out->getText( [ 'enableSectionEditLinks' => false ] )
336  : $out;
337  }
338 
345  protected function getErrorMessageArray( $errors, $lang = null ) {
346  return array_map( function ( $e ) use ( $lang ) {
347  return $this->getErrorMessage( $e, $lang );
348  }, $errors );
349  }
350 
359  public function getErrorsArray() {
360  return $this->getStatusArray( 'error' );
361  }
362 
371  public function getWarningsArray() {
372  return $this->getStatusArray( 'warning' );
373  }
374 
382  public function __sleep() {
383  $keys = array_keys( get_object_vars( $this ) );
384  return array_diff( $keys, [ 'cleanCallback', 'messageLocalizer' ] );
385  }
386 
390  public function __wakeup() {
391  $this->cleanCallback = false;
392  $this->messageLocalizer = null;
393  }
394 
400  private function msg( $key, ...$params ): Message {
401  if ( $this->messageLocalizer ) {
402  return $this->messageLocalizer->msg( $key, ...$params );
403  } else {
404  return wfMessage( $key, ...$params );
405  }
406  }
407 
414  private function msgInLang( $key, $lang, ...$params ): Message {
415  $msg = $this->msg( $key, ...$params );
416  if ( $lang ) {
417  $msg->inLanguage( $lang );
418  }
419  return $msg;
420  }
421 }
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
if(!defined('MW_SETUP_CALLBACK'))
The persistent session ID (if any) loaded at startup.
Definition: WebStart.php:82
Variant of the Message class.
Definition: RawMessage.php:40
Service locator for MediaWiki core services.
Stub object for the user language.
The Message class deals with fetching and processing of interface message into a variety of formats.
Definition: Message.php:143
inLanguage( $lang)
Request the message in any language that is supported.
Definition: Message.php:834
getText( $options=[])
Get the output HTML.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:46
array[] $errors
Definition: StatusValue.php:52
getErrors()
Get the list of errors.
setOK( $ok)
Change operation status.
getStatusArray( $type=false)
Returns a list of status messages of the given type (or all if false)
isOK()
Returns whether the operation completed.
fatal( $message,... $parameters)
Add an error and set OK to false, indicating that the operation as a whole was fatal.
mixed $value
Definition: StatusValue.php:55
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:46
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition: Status.php:64
setMessageLocalizer(MessageLocalizer $messageLocalizer)
Makes this Status object use the given localizer instead of the global one.
Definition: Status.php:127
getWikiText( $shortContext=false, $longContext=false, $lang=null)
Get the error list as a wikitext formatted list.
Definition: Status.php:191
splitByErrorType()
Splits this Status object into two new Status objects, one which contains only the error messages,...
Definition: Status.php:142
getErrorsArray()
Get the list of errors (but not warnings)
Definition: Status.php:359
getErrorMessage( $error, $lang=null)
Return the message for a single error.
Definition: Status.php:295
callable false $cleanCallback
Definition: Status.php:48
MessageLocalizer null $messageLocalizer
Definition: Status.php:51
__sleep()
Don't save the callback when serializing, because Closures can't be serialized and we're going to cle...
Definition: Status.php:382
cleanParams(array $params)
Definition: Status.php:171
__set( $name, $value)
Change operation result Backwards compatibility logic.
Definition: Status.php:106
getErrorMessageArray( $errors, $lang=null)
Return an array with a Message object for each error.
Definition: Status.php:345
getWarningsArray()
Get the list of warnings (but not errors)
Definition: Status.php:371
getStatusValue()
Returns the wrapped StatusValue object.
Definition: Status.php:163
getHTML( $shortContext=false, $longContext=false, $lang=null)
Get the error message as HTML.
Definition: Status.php:330
__wakeup()
Sanitize the callback parameter on wakeup, to avoid arbitrary execution.
Definition: Status.php:390
__get( $name)
Backwards compatibility logic.
Definition: Status.php:87
getMessage( $shortContext=false, $longContext=false, $lang=null)
Get a bullet list of the errors as a Message object.
Definition: Status.php:245
Interface for localizing messages in MediaWiki.
foreach( $mmfl['setupFiles'] as $fileName) if( $queue) if(empty( $mmfl['quiet'])) $s
if(!isset( $args[0])) $lang