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;
    }

    protected function getDummyTitle() {
        if ( self::$dummyTitle === null ) {
            self::$dummyTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/' . __METHOD__ );
        }
        return self::$dummyTitle;
    }

    public function addWarning( $moduleName, $msg, $code = null, $data = null ) {
        $msg = ApiMessage::create( $msg, $code, $data )
            ->inLanguage( $this->lang )
            ->title( $this->getDummyTitle() )
            ->useDatabase( $this->useDB );
        $this->addWarningOrError( 'warning', $moduleName, $msg );
    }

    public function addError( $moduleName, $msg, $code = null, $data = null ) {
        $msg = ApiMessage::create( $msg, $code, $data )
            ->inLanguage( $this->lang )
            ->title( $this->getDummyTitle() )
            ->useDatabase( $this->useDB );
        $this->addWarningOrError( 'error', $moduleName, $msg );
    }

    public function addMessagesFromStatus(
        $moduleName, Status $status, $types = [ 'warning', 'error' ]
    ) {
        if ( $status->isGood() || !$status->errors ) {
            return;
        }

        $types = (array)$types;
        foreach ( $status->errors 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';
            }

            if ( is_array( $error ) && isset( $error['message'] ) ) {
                // Normal case
                if ( $error['message'] instanceof Message ) {
                    $msg = ApiMessage::create( $error['message'], null, [] );
                } else {
                    $args = isset( $error['params'] ) ? $error['params'] : [];
                    array_unshift( $args, $error['message'] );
                    $error += [ 'params' => [] ];
                    $msg = ApiMessage::create( $args, null, [] );
                }
            } elseif ( is_array( $error ) ) {
                // Weird case handled by Message::getErrorMessage
                $msg = ApiMessage::create( $error, null, [] );
            } else {
                // Another weird case handled by Message::getErrorMessage
                $msg = ApiMessage::create( $error, null, [] );
            }

            $msg->inLanguage( $this->lang )
                ->title( $this->getDummyTitle() )
                ->useDatabase( $this->useDB );
            $this->addWarningOrError( $tag, $moduleName, $msg );
        }
    }

    public function arrayFromStatus( Status $status, $type = 'error', $format = null ) {
        if ( $status->isGood() || !$status->errors ) {
            return [];
        }

        $result = new ApiResult( 1e6 );
        $formatter = new ApiErrorFormatter(
            $result, $this->lang, $format ?: $this->format, $this->useDB
        );
        $formatter->addMessagesFromStatus( 'dummy', $status, [ $type ] );
        switch ( $type ) {
            case 'error':
                return (array)$result->getResultData( [ 'errors', 'dummy' ] );
            case 'warning':
                return (array)$result->getResultData( [ 'warnings', 'dummy' ] );
        }
    }

    protected function addWarningOrError( $tag, $moduleName, $msg ) {
        $value = [ 'code' => $msg->getApiCode() ];
        switch ( $this->format ) {
            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 += [
                    'message' => $msg->getKey(),
                    'params' => $msg->getParams(),
                ];
                ApiResult::setIndexedTagName( $value['params'], 'param' );
                break;

            case 'none':
                break;
        }
        $value += $msg->getApiData();

        $path = [ $tag . 's', $moduleName ];
        $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 );
        }
    }
}

// @codingStandardsIgnoreStart Squiz.Classes.ValidClassName.NotCamelCaps
class ApiErrorFormatter_BackCompat extends ApiErrorFormatter {
    // @codingStandardsIgnoreEnd

    public function __construct( ApiResult $result ) {
        parent::__construct( $result, Language::factory( 'en' ), 'none', false );
    }

    public function arrayFromStatus( Status $status, $type = 'error', $format = null ) {
        if ( $status->isGood() || !$status->errors ) {
            return [];
        }

        $result = [];
        foreach ( $status->getErrorsByType( $type ) as $error ) {
            if ( $error['message'] instanceof Message ) {
                $error = [
                    'message' => $error['message']->getKey(),
                    'params' => $error['message']->getParams(),
                ] + $error;
            }
            ApiResult::setIndexedTagName( $error['params'], 'param' );
            $result[] = $error;
        }
        ApiResult::setIndexedTagName( $result, $type );

        return $result;
    }

    protected function addWarningOrError( $tag, $moduleName, $msg ) {
        $value = $msg->plain();

        if ( $tag === 'error' ) {
            // In BC mode, only one error
            $code = $msg->getApiCode();
            if ( isset( ApiBase::$messageMap[$code] ) ) {
                // Backwards compatibility
                $code = ApiBase::$messageMap[$code]['code'];
            }

            $value = [
                'code' => $code,
                'info' => $value,
            ] + $msg->getApiData();
            $this->result->addValue( null, 'error', $value,
                ApiResult::OVERRIDE | ApiResult::ADD_ON_TOP | ApiResult::NO_SIZE_CHECK );
        } else {
            // 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 );
        }
    }
}