includes/api/ApiErrorFormatter.php

   1 <?php
   2 /**
   3  * This file contains the ApiErrorFormatter definition, plus implementations of
   4  * specific formatters.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23
  24 /**
  25  * Formats errors and warnings for the API, and add them to the associated
  26  * ApiResult.
  27  * @since 1.25
  28  * @ingroup API
  29  */
  30 class ApiErrorFormatter {
  31         /** @var Title Dummy title to silence warnings from MessageCache::parse() */
  32         private static $dummyTitle = null;
  33
  34         /** @var ApiResult */
  35         protected $result;
  36
  37         /** @var Language */
  38         protected $lang;
  39         protected $useDB = false;
  40         protected $format = 'none';
  41
  42         /**
  43          * @param ApiResult $result Into which data will be added
  44          * @param Language $lang Used for i18n
  45          * @param string $format
  46          *  - plaintext: Error message as something vaguely like plaintext
  47          *    (it's basically wikitext with HTML tags stripped and entities decoded)
  48          *  - wikitext: Error message as wikitext
  49          *  - html: Error message as HTML
  50          *  - raw: Raw message key and parameters, no human-readable text
  51          *  - none: Code and data only, no human-readable text
  52          * @param bool $useDB Whether to use local translations for errors and warnings.
  53          */
  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
  61         /**
  62          * Fetch the Language for this formatter
  63          * @since 1.29
  64          * @return Language
  65          */
  66         public function getLanguage() {
  67                 return $this->lang;
  68         }
  69
  70         /**
  71          * Fetch a dummy title to set on Messages
  72          * @return Title
  73          */
  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
  81         /**
  82          * Add a warning to the result
  83          * @param string|null $modulePath
  84          * @param Message|array|string $msg Warning message. See ApiMessage::create().
  85          * @param string|null $code See ApiMessage::create().
  86          * @param array|null $data See ApiMessage::create().
  87          */
  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
  96         /**
  97          * Add an error to the result
  98          * @param string|null $modulePath
  99          * @param Message|array|string $msg Warning message. See ApiMessage::create().
 100          * @param string|null $code See ApiMessage::create().
 101          * @param array|null $data See ApiMessage::create().
 102          */
 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
 111         /**
 112          * Add warnings and errors from a StatusValue object to the result
 113          * @param string|null $modulePath
 114          * @param StatusValue $status
 115          * @param string[] $types 'warning' and/or 'error'
 116          */
 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
 145         /**
 146          * Get an ApiMessage from an exception
 147          * @since 1.29
 148          * @param Exception|Throwable $exception
 149          * @param array $options
 150          *  - wrap: (string|array|MessageSpecifier) Used to wrap the exception's
 151          *    message if it's not an ILocalizedException. The exception's message
 152          *    will be added as the final parameter.
 153          *  - code: (string) Default code
 154          *  - data: (array) Default extra data
 155          * @return IApiMessage
 156          */
 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
 192         /**
 193          * Format an exception as an array
 194          * @since 1.29
 195          * @param Exception|Throwable $exception
 196          * @param array $options See self::getMessageFromException(), plus
 197          *  - format: (string) Format override
 198          * @return array
 199          */
 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
 207         /**
 208          * Format a message as an array
 209          * @param Message|array|string $msg Message. See ApiMessage::create().
 210          * @param string|null $format
 211          * @return array
 212          */
 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
 221         /**
 222          * Format messages from a StatusValue as an array
 223          * @param StatusValue $status
 224          * @param string $type 'warning' or 'error'
 225          * @param string|null $format
 226          * @return array
 227          */
 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
 246         /**
 247          * Turn wikitext into something resembling plaintext
 248          * @since 1.29
 249          * @param string $text
 250          * @return string
 251          */
 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
 262         /**
 263          * Format a Message object for raw format
 264          * @param MessageSpecifier $msg
 265          * @return array
 266          */
 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
 283         /**
 284          * Format a message as an array
 285          * @since 1.29
 286          * @param ApiMessage|ApiRawMessage $msg
 287          * @param string|null $format
 288          * @return array
 289          */
 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
 330         /**
 331          * Actually add the warning or error to the result
 332          * @param string $tag 'warning' or 'error'
 333          * @param string|null $modulePath
 334          * @param ApiMessage|ApiRawMessage $msg
 335          */
 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 ) ) {
 345                         $flags = ApiResult::NO_SIZE_CHECK;
 346                         if ( $existing === null ) {
 347                                 $flags |= ApiResult::ADD_ON_TOP;
 348                         }
 349                         $this->result->addValue( $path, null, $value, $flags );
 350                         $this->result->addIndexedTagName( $path, $tag );
 351                 }
 352         }
 353 }
 354
 355 /**
 356  * Format errors and warnings in the old style, for backwards compatibility.
 357  * @since 1.25
 358  * @deprecated Only for backwards compatibility, do not use
 359  * @ingroup API
 360  */
 361 // @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
 362 class ApiErrorFormatter_BackCompat extends ApiErrorFormatter {
 363         // @codingStandardsIgnoreEnd
 364
 365         /**
 366          * @param ApiResult $result Into which data will be added
 367          */
 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                 }
 388                 ApiResult::setIndexedTagName( $result, $type );
 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
 400         /**
 401          * Format an exception as an array
 402          * @since 1.29
 403          * @param Exception|Throwable $exception
 404          * @param array $options See parent::formatException(), plus
 405          *  - bc: (bool) Return only the string, not an array
 406          * @return array|string
 407          */
 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,
 427                                         ApiResult::OVERRIDE | ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
 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,
 455                                 ApiResult::OVERRIDE | ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
 456                 }
 457         }
 458 }