MediaWiki REL1_30
ApiErrorFormatter.php
Go to the documentation of this file.
1<?php
32 private static $dummyTitle = null;
33
35 protected $result;
36
38 protected $lang;
39 protected $useDB = false;
40 protected $format = 'none';
41
54 public function __construct( ApiResult $result, Language $lang, $format, $useDB = false ) {
55 $this->result = $result;
56 $this->lang = $lang;
57 $this->useDB = $useDB;
58 $this->format = $format;
59 }
60
66 public function getLanguage() {
67 return $this->lang;
68 }
69
74 protected function getDummyTitle() {
75 if ( self::$dummyTitle === null ) {
76 self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
77 }
78 return self::$dummyTitle;
79 }
80
88 public function addWarning( $modulePath, $msg, $code = null, $data = null ) {
89 $msg = ApiMessage::create( $msg, $code, $data )
90 ->inLanguage( $this->lang )
91 ->title( $this->getDummyTitle() )
92 ->useDatabase( $this->useDB );
93 $this->addWarningOrError( 'warning', $modulePath, $msg );
94 }
95
103 public function addError( $modulePath, $msg, $code = null, $data = null ) {
104 $msg = ApiMessage::create( $msg, $code, $data )
105 ->inLanguage( $this->lang )
106 ->title( $this->getDummyTitle() )
107 ->useDatabase( $this->useDB );
108 $this->addWarningOrError( 'error', $modulePath, $msg );
109 }
110
117 public function addMessagesFromStatus(
118 $modulePath, StatusValue $status, $types = [ 'warning', 'error' ]
119 ) {
120 if ( $status->isGood() || !$status->getErrors() ) {
121 return;
122 }
123
124 $types = (array)$types;
125 foreach ( $status->getErrors() as $error ) {
126 if ( !in_array( $error['type'], $types, true ) ) {
127 continue;
128 }
129
130 if ( $error['type'] === 'error' ) {
131 $tag = 'error';
132 } else {
133 // Assume any unknown type is a warning
134 $tag = 'warning';
135 }
136
137 $msg = ApiMessage::create( $error )
138 ->inLanguage( $this->lang )
139 ->title( $this->getDummyTitle() )
140 ->useDatabase( $this->useDB );
141 $this->addWarningOrError( $tag, $modulePath, $msg );
142 }
143 }
144
157 public function getMessageFromException( $exception, array $options = [] ) {
158 $options += [ 'code' => null, 'data' => [] ];
159
160 if ( $exception instanceof ILocalizedException ) {
161 $msg = $exception->getMessageObject();
162 $params = [];
163 } else {
164 // Extract code and data from the exception, if applicable
165 if ( $exception instanceof UsageException ) {
166 $data = $exception->getMessageArray();
167 if ( !$options['code'] ) {
168 $options['code'] = $data['code'];
169 }
170 unset( $data['code'], $data['info'] );
171 $options['data'] = array_merge( $data, $options['data'] );
172 }
173
174 if ( isset( $options['wrap'] ) ) {
175 $msg = $options['wrap'];
176 } else {
177 $msg = new RawMessage( '$1' );
178 if ( !isset( $options['code'] ) ) {
179 $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $exception ) );
180 $options['code'] = 'internal_api_error_' . $class;
181 }
182 }
183 $params = [ wfEscapeWikiText( $exception->getMessage() ) ];
184 }
185 return ApiMessage::create( $msg, $options['code'], $options['data'] )
186 ->params( $params )
187 ->inLanguage( $this->lang )
188 ->title( $this->getDummyTitle() )
189 ->useDatabase( $this->useDB );
190 }
191
200 public function formatException( $exception, array $options = [] ) {
201 return $this->formatMessage(
202 $this->getMessageFromException( $exception, $options ),
203 isset( $options['format'] ) ? $options['format'] : null
204 );
205 }
206
213 public function formatMessage( $msg, $format = null ) {
214 $msg = ApiMessage::create( $msg )
215 ->inLanguage( $this->lang )
216 ->title( $this->getDummyTitle() )
217 ->useDatabase( $this->useDB );
218 return $this->formatMessageInternal( $msg, $format ?: $this->format );
219 }
220
228 public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
229 if ( $status->isGood() || !$status->getErrors() ) {
230 return [];
231 }
232
233 $result = new ApiResult( 1e6 );
234 $formatter = new ApiErrorFormatter(
235 $result, $this->lang, $format ?: $this->format, $this->useDB
236 );
237 $formatter->addMessagesFromStatus( null, $status, [ $type ] );
238 switch ( $type ) {
239 case 'error':
240 return (array)$result->getResultData( [ 'errors' ] );
241 case 'warning':
242 return (array)$result->getResultData( [ 'warnings' ] );
243 }
244 }
245
252 public static function stripMarkup( $text ) {
253 // Turn semantic quoting tags to quotes
254 $ret = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $text );
255
256 // Strip tags and decode.
257 $ret = Sanitizer::stripAllTags( $ret );
258
259 return $ret;
260 }
261
267 private function formatRawMessage( MessageSpecifier $msg ) {
268 $ret = [
269 'key' => $msg->getKey(),
270 'params' => $msg->getParams(),
271 ];
272 ApiResult::setIndexedTagName( $ret['params'], 'param' );
273
274 // Transform Messages as parameters in the style of Message::fooParam().
275 foreach ( $ret['params'] as $i => $param ) {
276 if ( $param instanceof MessageSpecifier ) {
277 $ret['params'][$i] = [ 'message' => $this->formatRawMessage( $param ) ];
278 }
279 }
280 return $ret;
281 }
282
290 protected function formatMessageInternal( $msg, $format ) {
291 $value = [ 'code' => $msg->getApiCode() ];
292 switch ( $format ) {
293 case 'plaintext':
294 $value += [
295 'text' => self::stripMarkup( $msg->text() ),
296 ApiResult::META_CONTENT => 'text',
297 ];
298 break;
299
300 case 'wikitext':
301 $value += [
302 'text' => $msg->text(),
303 ApiResult::META_CONTENT => 'text',
304 ];
305 break;
306
307 case 'html':
308 $value += [
309 'html' => $msg->parse(),
310 ApiResult::META_CONTENT => 'html',
311 ];
312 break;
313
314 case 'raw':
315 $value += $this->formatRawMessage( $msg );
316 break;
317
318 case 'none':
319 break;
320 }
321 $data = $msg->getApiData();
322 if ( $data ) {
323 $value['data'] = $msg->getApiData() + [
324 ApiResult::META_TYPE => 'assoc',
325 ];
326 }
327 return $value;
328 }
329
336 protected function addWarningOrError( $tag, $modulePath, $msg ) {
337 $value = $this->formatMessageInternal( $msg, $this->format );
338 if ( $modulePath !== null ) {
339 $value += [ 'module' => $modulePath ];
340 }
341
342 $path = [ $tag . 's' ];
343 $existing = $this->result->getResultData( $path );
344 if ( $existing === null || !in_array( $value, $existing ) ) {
346 if ( $existing === null ) {
348 }
349 $this->result->addValue( $path, null, $value, $flags );
350 $this->result->addIndexedTagName( $path, $tag );
351 }
352 }
353}
354
361// @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
363 // @codingStandardsIgnoreEnd
364
368 public function __construct( ApiResult $result ) {
369 parent::__construct( $result, Language::factory( 'en' ), 'none', false );
370 }
371
372 public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
373 if ( $status->isGood() || !$status->getErrors() ) {
374 return [];
375 }
376
377 $result = [];
378 foreach ( $status->getErrorsByType( $type ) as $error ) {
379 $msg = ApiMessage::create( $error );
380 $error = [
381 'message' => $msg->getKey(),
382 'params' => $msg->getParams(),
383 'code' => $msg->getApiCode(),
384 ] + $error;
385 ApiResult::setIndexedTagName( $error['params'], 'param' );
386 $result[] = $error;
387 }
389
390 return $result;
391 }
392
393 protected function formatMessageInternal( $msg, $format ) {
394 return [
395 'code' => $msg->getApiCode(),
396 'info' => $msg->text(),
397 ] + $msg->getApiData();
398 }
399
408 public function formatException( $exception, array $options = [] ) {
409 $ret = parent::formatException( $exception, $options );
410 return empty( $options['bc'] ) ? $ret : $ret['info'];
411 }
412
413 protected function addWarningOrError( $tag, $modulePath, $msg ) {
414 $value = self::stripMarkup( $msg->text() );
415
416 if ( $tag === 'error' ) {
417 // In BC mode, only one error
418 $existingError = $this->result->getResultData( [ 'error' ] );
419 if ( !is_array( $existingError ) ||
420 !isset( $existingError['code'] ) || !isset( $existingError['info'] )
421 ) {
422 $value = [
423 'code' => $msg->getApiCode(),
424 'info' => $value,
425 ] + $msg->getApiData();
426 $this->result->addValue( null, 'error', $value,
428 }
429 } else {
430 if ( $modulePath === null ) {
431 $moduleName = 'unknown';
432 } else {
433 $i = strrpos( $modulePath, '+' );
434 $moduleName = $i === false ? $modulePath : substr( $modulePath, $i + 1 );
435 }
436
437 // Don't add duplicate warnings
438 $tag .= 's';
439 $path = [ $tag, $moduleName ];
440 $oldWarning = $this->result->getResultData( [ $tag, $moduleName, $tag ] );
441 if ( $oldWarning !== null ) {
442 $warnPos = strpos( $oldWarning, $value );
443 // If $value was found in $oldWarning, check if it starts at 0 or after "\n"
444 if ( $warnPos !== false && ( $warnPos === 0 || $oldWarning[$warnPos - 1] === "\n" ) ) {
445 // Check if $value is followed by "\n" or the end of the $oldWarning
446 $warnPos += strlen( $value );
447 if ( strlen( $oldWarning ) <= $warnPos || $oldWarning[$warnPos] === "\n" ) {
448 return;
449 }
450 }
451 // If there is a warning already, append it to the existing one
452 $value = "$oldWarning\n$value";
453 }
454 $this->result->addContentValue( $path, $tag, $value,
456 }
457 }
458}
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Format errors and warnings in the old style, for backwards compatibility.
formatMessageInternal( $msg, $format)
Format a message as an array.
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
formatException( $exception, array $options=[])
Format an exception as an array.
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
Formats errors and warnings for the API, and add them to the associated ApiResult.
__construct(ApiResult $result, Language $lang, $format, $useDB=false)
formatRawMessage(MessageSpecifier $msg)
Format a Message object for raw format.
arrayFromStatus(StatusValue $status, $type='error', $format=null)
Format messages from a StatusValue as an array.
getMessageFromException( $exception, array $options=[])
Get an ApiMessage from an exception.
addWarningOrError( $tag, $modulePath, $msg)
Actually add the warning or error to the result.
addWarning( $modulePath, $msg, $code=null, $data=null)
Add a warning to the result.
getDummyTitle()
Fetch a dummy title to set on Messages.
addError( $modulePath, $msg, $code=null, $data=null)
Add an error to the result.
addMessagesFromStatus( $modulePath, StatusValue $status, $types=[ 'warning', 'error'])
Add warnings and errors from a StatusValue object to the result.
static stripMarkup( $text)
Turn wikitext into something resembling plaintext.
formatMessageInternal( $msg, $format)
Format a message as an array.
formatException( $exception, array $options=[])
Format an exception as an array.
formatMessage( $msg, $format=null)
Format a message as an array.
static Title $dummyTitle
Dummy title to silence warnings from MessageCache::parse()
getLanguage()
Fetch the Language for this formatter.
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
This class represents the result of the API operations.
Definition ApiResult.php:33
const META_TYPE
Key for the 'type' metadata item.
const NO_SIZE_CHECK
For addValue() and similar functions, do not check size while adding a value Don't use this unless yo...
Definition ApiResult.php:56
const META_CONTENT
Key for the 'content' metadata item.
Definition ApiResult.php:88
const OVERRIDE
Override existing value in addValue(), setValue(), and similar functions.
Definition ApiResult.php:39
const ADD_ON_TOP
For addValue(), setValue() and similar functions, if the value does not exist, add it as the first el...
Definition ApiResult.php:47
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Internationalisation code.
Definition Language.php:35
Variant of the Message class.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Represents a title within MediaWiki.
Definition Title.php:39
This exception will be thrown when dieUsage is called to stop module execution.
the array() calling protocol came about after MediaWiki 1.4rc1.
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:1971
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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 modifiable & $code
Definition hooks.txt:863
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2805
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition hooks.txt:1975
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1049
const NS_SPECIAL
Definition Defines.php:54
Interface for MediaWiki-localized exceptions.
$params