ApiErrorFormatter.php

Go to the documentation of this file.

<?php
class ApiErrorFormatter {
    private static $dummyTitle = null;
 
    protected $result;
 
    protected $lang;
    protected $useDB = false;
    protected $format = 'none';
 
    public function __construct( ApiResult $result, Language $lang, $format, $useDB = false ) {
        $this->result = $result;
        $this->lang = $lang;
        $this->useDB = $useDB;
        $this->format = $format;
    }
 
    public static function isValidApiCode( $code ) {
        return is_string( $code ) && (
            preg_match( '/^[a-zA-Z0-9_-]+$/', $code ) ||
            // TODO: Deprecate this
            preg_match( '/^internal_api_error_[^\0\r\n]+$/', $code )
        );
    }
 
    public function newWithFormat( $format ) {
        return new self( $this->result, $this->lang, $format, $this->useDB );
    }
 
    public function getFormat() {
        return $this->format;
    }
 
    public function getLanguage() {
        return $this->lang;
    }
 
    protected function getDummyTitle() {
        if ( self::$dummyTitle === null ) {
            self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
        }
        return self::$dummyTitle;
    }
 
    public function addWarning( $modulePath, $msg, $code = null, $data = null ) {
        $msg = ApiMessage::create( $msg, $code, $data )
            ->inLanguage( $this->lang )
            ->title( $this->getDummyTitle() )
            ->useDatabase( $this->useDB );
        $this->addWarningOrError( 'warning', $modulePath, $msg );
    }
 
    public function addError( $modulePath, $msg, $code = null, $data = null ) {
        $msg = ApiMessage::create( $msg, $code, $data )
            ->inLanguage( $this->lang )
            ->title( $this->getDummyTitle() )
            ->useDatabase( $this->useDB );
        $this->addWarningOrError( 'error', $modulePath, $msg );
    }
 
    public function addMessagesFromStatus(
        $modulePath, StatusValue $status, $types = [ 'warning', 'error' ], array $filter = []
    ) {
        if ( $status->isGood() || !$status->getErrors() ) {
            return;
        }
 
        $types = (array)$types;
        foreach ( $status->getErrors() as $error ) {
            if ( !in_array( $error['type'], $types, true ) ) {
                continue;
            }
 
            if ( $error['type'] === 'error' ) {
                $tag = 'error';
            } else {
                // Assume any unknown type is a warning
                $tag = 'warning';
            }
 
            $msg = ApiMessage::create( $error )
                ->inLanguage( $this->lang )
                ->title( $this->getDummyTitle() )
                ->useDatabase( $this->useDB );
            if ( !in_array( $msg->getKey(), $filter, true ) ) {
                $this->addWarningOrError( $tag, $modulePath, $msg );
            }
        }
    }
 
    public function getMessageFromException( $exception, array $options = [] ) {
        $options += [ 'code' => null, 'data' => [] ];
 
        if ( $exception instanceof ILocalizedException ) {
            $msg = $exception->getMessageObject();
            $params = [];
        } elseif ( $exception instanceof MessageSpecifier ) {
            $msg = Message::newFromSpecifier( $exception );
            $params = [];
        } else {
            if ( isset( $options['wrap'] ) ) {
                $msg = $options['wrap'];
            } else {
                $msg = new RawMessage( '$1' );
                if ( !isset( $options['code'] ) ) {
                    $class = preg_replace( '#^Wikimedia\\\Rdbms\\\#', '', get_class( $exception ) );
                    $options['code'] = 'internal_api_error_' . $class;
                    $options['data']['errorclass'] = get_class( $exception );
                }
            }
            $params = [ wfEscapeWikiText( $exception->getMessage() ) ];
        }
        return ApiMessage::create( $msg, $options['code'], $options['data'] )
            ->params( $params )
            ->inLanguage( $this->lang )
            ->title( $this->getDummyTitle() )
            ->useDatabase( $this->useDB );
    }
 
    public function formatException( $exception, array $options = [] ) {
        return $this->formatMessage(
            $this->getMessageFromException( $exception, $options ),
            $options['format'] ?? null
        );
    }
 
    public function formatMessage( $msg, $format = null ) {
        $msg = ApiMessage::create( $msg )
            ->inLanguage( $this->lang )
            ->title( $this->getDummyTitle() )
            ->useDatabase( $this->useDB );
        return $this->formatMessageInternal( $msg, $format ?: $this->format );
    }
 
    public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
        if ( $status->isGood() || !$status->getErrors() ) {
            return [];
        }
 
        $result = new ApiResult( 1e6 );
        $formatter = new ApiErrorFormatter(
            $result, $this->lang, $format ?: $this->format, $this->useDB
        );
        $formatter->addMessagesFromStatus( null, $status, [ $type ] );
        switch ( $type ) {
            case 'error':
                return (array)$result->getResultData( [ 'errors' ] );
            case 'warning':
                return (array)$result->getResultData( [ 'warnings' ] );
        }
    }
 
    public static function stripMarkup( $text ) {
        // Turn semantic quoting tags to quotes
        $ret = preg_replace( '!</?(var|kbd|samp|code)>!', '"', $text );
 
        // Strip tags and decode.
        $ret = Sanitizer::stripAllTags( $ret );
 
        return $ret;
    }
 
    private function formatRawMessage( MessageSpecifier $msg ) {
        $ret = [
            'key' => $msg->getKey(),
            'params' => $msg->getParams(),
        ];
        ApiResult::setIndexedTagName( $ret['params'], 'param' );
 
        // Transform Messages as parameters in the style of Message::fooParam().
        foreach ( $ret['params'] as $i => $param ) {
            if ( $param instanceof MessageSpecifier ) {
                $ret['params'][$i] = [ 'message' => $this->formatRawMessage( $param ) ];
            }
        }
        return $ret;
    }
 
    protected function formatMessageInternal( $msg, $format ) {
        $value = [ 'code' => $msg->getApiCode() ];
        switch ( $format ) {
            case 'plaintext':
                $value += [
                    'text' => self::stripMarkup( $msg->text() ),
                    ApiResult::META_CONTENT => 'text',
                ];
                break;
 
            case 'wikitext':
                $value += [
                    'text' => $msg->text(),
                    ApiResult::META_CONTENT => 'text',
                ];
                break;
 
            case 'html':
                $value += [
                    'html' => $msg->parse(),
                    ApiResult::META_CONTENT => 'html',
                ];
                break;
 
            case 'raw':
                $value += $this->formatRawMessage( $msg );
                break;
 
            case 'none':
                break;
        }
        $data = $msg->getApiData();
        if ( $data ) {
            $value['data'] = $msg->getApiData() + [
                ApiResult::META_TYPE => 'assoc',
            ];
        }
        return $value;
    }
 
    protected function addWarningOrError( $tag, $modulePath, $msg ) {
        $value = $this->formatMessageInternal( $msg, $this->format );
        if ( $modulePath !== null ) {
            $value += [ 'module' => $modulePath ];
        }
 
        $path = [ $tag . 's' ];
        $existing = $this->result->getResultData( $path );
        if ( $existing === null || !in_array( $value, $existing ) ) {
            $flags = ApiResult::NO_SIZE_CHECK;
            if ( $existing === null ) {
                $flags |= ApiResult::ADD_ON_TOP;
            }
            $this->result->addValue( $path, null, $value, $flags );
            $this->result->addIndexedTagName( $path, $tag );
        }
    }
}
 
// phpcs:ignore Squiz.Classes.ValidClassName.NotCamelCaps
class ApiErrorFormatter_BackCompat extends ApiErrorFormatter {
 
    public function __construct( ApiResult $result ) {
        parent::__construct( $result, Language::factory( 'en' ), 'none', false );
    }
 
    public function getFormat() {
        return 'bc';
    }
 
    public function arrayFromStatus( StatusValue $status, $type = 'error', $format = null ) {
        if ( $status->isGood() || !$status->getErrors() ) {
            return [];
        }
 
        $result = [];
        foreach ( $status->getErrorsByType( $type ) as $error ) {
            $msg = ApiMessage::create( $error );
            $error = [
                'message' => $msg->getKey(),
                'params' => $msg->getParams(),
                'code' => $msg->getApiCode(),
            ] + $error;
            ApiResult::setIndexedTagName( $error['params'], 'param' );
            $result[] = $error;
        }
        ApiResult::setIndexedTagName( $result, $type );
 
        return $result;
    }
 
    protected function formatMessageInternal( $msg, $format ) {
        return [
            'code' => $msg->getApiCode(),
            'info' => $msg->text(),
        ] + $msg->getApiData();
    }
 
    public function formatException( $exception, array $options = [] ) {
        $ret = parent::formatException( $exception, $options );
        return empty( $options['bc'] ) ? $ret : $ret['info'];
    }
 
    protected function addWarningOrError( $tag, $modulePath, $msg ) {
        $value = self::stripMarkup( $msg->text() );
 
        if ( $tag === 'error' ) {
            // In BC mode, only one error
            $existingError = $this->result->getResultData( [ 'error' ] );
            if ( !is_array( $existingError ) ||
                !isset( $existingError['code'] ) || !isset( $existingError['info'] )
            ) {
                $value = [
                    'code' => $msg->getApiCode(),
                    'info' => $value,
                ] + $msg->getApiData();
                $this->result->addValue( null, 'error', $value,
                    ApiResult::OVERRIDE | ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
            }
        } else {
            if ( $modulePath === null ) {
                $moduleName = 'unknown';
            } else {
                $i = strrpos( $modulePath, '+' );
                $moduleName = $i === false ? $modulePath : substr( $modulePath, $i + 1 );
            }
 
            // Don't add duplicate warnings
            $tag .= 's';
            $path = [ $tag, $moduleName ];
            $oldWarning = $this->result->getResultData( [ $tag, $moduleName, $tag ] );
            if ( $oldWarning !== null ) {
                $warnPos = strpos( $oldWarning, $value );
                // If $value was found in $oldWarning, check if it starts at 0 or after "\n"
                if ( $warnPos !== false && ( $warnPos === 0 || $oldWarning[$warnPos - 1] === "\n" ) ) {
                    // Check if $value is followed by "\n" or the end of the $oldWarning
                    $warnPos += strlen( $value );
                    if ( strlen( $oldWarning ) <= $warnPos || $oldWarning[$warnPos] === "\n" ) {
                        return;
                    }
                }
                // If there is a warning already, append it to the existing one
                $value = "$oldWarning\n$value";
            }
            $this->result->addContentValue( $path, $tag, $value,
                ApiResult::OVERRIDE | ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
        }
    }
}