Status.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Status;
 
use ApiMessage;
use ApiRawMessage;
use Language;
use MediaWiki\Language\RawMessage;
use MediaWiki\MediaWikiServices;
use MediaWiki\StubObject\StubUserLang;
use Message;
use MessageLocalizer;
use MessageSpecifier;
use ParserOutput;
use RuntimeException;
use StatusValue;
use UnexpectedValueException;
 
class Status extends StatusValue {
    public $cleanCallback = false;
 
    protected $messageLocalizer;
 
    public static function wrap( $sv ) {
        if ( $sv instanceof static ) {
            return $sv;
        }
 
        $result = new static();
        $result->ok =& $sv->ok;
        $result->errors =& $sv->errors;
        $result->value =& $sv->value;
        $result->successCount =& $sv->successCount;
        $result->failCount =& $sv->failCount;
        $result->success =& $sv->success;
 
        return $result;
    }
 
    public function __get( $name ) {
        if ( $name === 'ok' ) {
            return $this->isOK();
        }
        if ( $name === 'errors' ) {
            return $this->getErrors();
        }
 
        throw new RuntimeException( "Cannot get '$name' property." );
    }
 
    public function __set( $name, $value ) {
        if ( $name === 'ok' ) {
            $this->setOK( $value );
        } elseif ( !property_exists( $this, $name ) ) {
            // Caller is using undeclared ad-hoc properties
            $this->$name = $value;
        } else {
            throw new RuntimeException( "Cannot set '$name' property." );
        }
    }
 
    public function setMessageLocalizer( MessageLocalizer $messageLocalizer ) {
        $this->messageLocalizer = $messageLocalizer;
    }
 
    public function splitByErrorType() {
        [ $errorsOnlyStatus, $warningsOnlyStatus ] = parent::splitByErrorType();
        // phan/phan#2133?
        '@phan-var Status $errorsOnlyStatus';
        '@phan-var Status $warningsOnlyStatus';
 
        if ( $this->messageLocalizer ) {
            $errorsOnlyStatus->setMessageLocalizer( $this->messageLocalizer );
            $warningsOnlyStatus->setMessageLocalizer( $this->messageLocalizer );
        }
        $errorsOnlyStatus->cleanCallback = $warningsOnlyStatus->cleanCallback = $this->cleanCallback;
 
        return [ $errorsOnlyStatus, $warningsOnlyStatus ];
    }
 
    public function getStatusValue() {
        return $this;
    }
 
    protected function cleanParams( array $params ) {
        if ( !$this->cleanCallback ) {
            return $params;
        }
        $cleanParams = [];
        foreach ( $params as $i => $param ) {
            $cleanParams[$i] = call_user_func( $this->cleanCallback, $param );
        }
        return $cleanParams;
    }
 
    public function getWikiText( $shortContext = false, $longContext = false, $lang = null ) {
        $rawErrors = $this->getErrors();
        if ( count( $rawErrors ) === 0 ) {
            if ( $this->isOK() ) {
                $this->fatal(
                    'internalerror_info',
                    __METHOD__ . " called for a good result, this is incorrect\n"
                );
            } else {
                $this->fatal(
                    'internalerror_info',
                    __METHOD__ . ": Invalid result object: no error text but not OK\n"
                );
            }
            $rawErrors = $this->getErrors(); // just added a fatal
        }
        if ( count( $rawErrors ) === 1 ) {
            $s = $this->getErrorMessage( $rawErrors[0], $lang )->plain();
            if ( $shortContext ) {
                $s = $this->msgInLang( $shortContext, $lang, $s )->plain();
            } elseif ( $longContext ) {
                $s = $this->msgInLang( $longContext, $lang, "* $s\n" )->plain();
            }
        } else {
            $errors = $this->getErrorMessageArray( $rawErrors, $lang );
            foreach ( $errors as &$error ) {
                $error = $error->plain();
            }
            $s = '* ' . implode( "\n* ", $errors ) . "\n";
            if ( $longContext ) {
                $s = $this->msgInLang( $longContext, $lang, $s )->plain();
            } elseif ( $shortContext ) {
                $s = $this->msgInLang( $shortContext, $lang, "\n$s\n" )->plain();
            }
        }
        return $s;
    }
 
    public function getMessage( $shortContext = false, $longContext = false, $lang = null ) {
        $rawErrors = $this->getErrors();
        if ( count( $rawErrors ) === 0 ) {
            if ( $this->isOK() ) {
                $this->fatal(
                    'internalerror_info',
                    __METHOD__ . " called for a good result, this is incorrect\n"
                );
            } else {
                $this->fatal(
                    'internalerror_info',
                    __METHOD__ . ": Invalid result object: no error text but not OK\n"
                );
            }
            $rawErrors = $this->getErrors(); // just added a fatal
        }
        if ( count( $rawErrors ) === 1 ) {
            $s = $this->getErrorMessage( $rawErrors[0], $lang );
            if ( $shortContext ) {
                $s = $this->msgInLang( $shortContext, $lang, $s );
            } elseif ( $longContext ) {
                $wrapper = new RawMessage( "* \$1\n" );
                $wrapper->params( $s )->parse();
                $s = $this->msgInLang( $longContext, $lang, $wrapper );
            }
        } else {
            $msgs = $this->getErrorMessageArray( $rawErrors, $lang );
            $msgCount = count( $msgs );
 
            $s = new RawMessage( '* $' . implode( "\n* \$", range( 1, $msgCount ) ) );
            $s->params( $msgs )->parse();
 
            if ( $longContext ) {
                $s = $this->msgInLang( $longContext, $lang, $s );
            } elseif ( $shortContext ) {
                $wrapper = new RawMessage( "\n\$1\n", [ $s ] );
                $wrapper->parse();
                $s = $this->msgInLang( $shortContext, $lang, $wrapper );
            }
        }
 
        return $s;
    }
 
    public function getPsr3MessageAndContext(): array {
        if ( count( $this->errors ) === 1 ) {
            // identical to getMessage( false, false, 'en' ) when there's just one error
            $message = $this->getErrorMessage( $this->errors[0], 'en' );
 
            $text = null;
            if ( in_array( get_class( $message ), [ Message::class, ApiMessage::class ], true ) ) {
                // Fall back to getWikiText for rawmessage, which is just a placeholder for non-translated text.
                // Turning the entire message into a context parameter wouldn't be useful.
                if ( $message->getKey() === 'rawmessage' ) {
                    return [ $this->getWikiText( false, false, 'en' ), [] ];
                }
                // $1,$2... will be left as-is when no parameters are provided.
                $text = $this->msgInLang( $message->getKey(), 'en' )->plain();
            } elseif ( in_array( get_class( $message ), [ RawMessage::class, ApiRawMessage::class ], true ) ) {
                $text = $message->getKey();
            } else {
                // Unknown Message subclass, we can't be sure how it marks parameters. Fall back to getWikiText.
                return [ $this->getWikiText( false, false, 'en' ), [] ];
            }
 
            $context = [];
            $i = 1;
            foreach ( $message->getParams() as $param ) {
                if ( is_array( $param ) && count( $param ) === 1 ) {
                    // probably Message::numParam() or similar
                    $param = reset( $param );
                }
                if ( is_int( $param ) || is_float( $param ) || is_string( $param ) ) {
                    $context["parameter$i"] = $param;
                } else {
                    // Parameter is not of a safe type, fall back to getWikiText.
                    return [ $this->getWikiText( false, false, 'en' ), [] ];
                }
 
                $text = str_replace( "\$$i", "{parameter$i}", $text );
 
                $i++;
            }
 
            return [ $text, $context ];
        }
        // Parameters cannot be easily extracted, fall back to getWikiText,
        return [ $this->getWikiText( false, false, 'en' ), [] ];
    }
 
    protected function getErrorMessage( $error, $lang = null ) {
        if ( is_array( $error ) ) {
            if ( isset( $error['message'] ) && $error['message'] instanceof Message ) {
                // Apply context from MessageLocalizer even if we have a Message object already
                $msg = $this->msg( $error['message'] );
            } elseif ( isset( $error['message'] ) && isset( $error['params'] ) ) {
                $msg = $this->msg(
                    $error['message'],
                    array_map( static function ( $param ) {
                        return is_string( $param ) ? wfEscapeWikiText( $param ) : $param;
                    }, $this->cleanParams( $error['params'] ) )
                );
            } else {
                $msgName = array_shift( $error );
                $msg = $this->msg(
                    $msgName,
                    array_map( static function ( $param ) {
                        return is_string( $param ) ? wfEscapeWikiText( $param ) : $param;
                    }, $this->cleanParams( $error ) )
                );
            }
        } elseif ( is_string( $error ) ) {
            $msg = $this->msg( $error );
        } else {
            throw new UnexpectedValueException( 'Got ' . get_class( $error ) . ' for key.' );
        }
 
        if ( $lang ) {
            $msg->inLanguage( $lang );
        }
        return $msg;
    }
 
    public function getHTML( $shortContext = false, $longContext = false, $lang = null ) {
        $text = $this->getWikiText( $shortContext, $longContext, $lang );
        $out = MediaWikiServices::getInstance()->getMessageCache()
            ->parse( $text, null, true, true, $lang );
        return $out instanceof ParserOutput
            ? $out->getText( [ 'enableSectionEditLinks' => false ] )
            : $out;
    }
 
    protected function getErrorMessageArray( $errors, $lang = null ) {
        return array_map( function ( $e ) use ( $lang ) {
            return $this->getErrorMessage( $e, $lang );
        }, $errors );
    }
 
    public function getErrorsArray() {
        return $this->getStatusArray( 'error' );
    }
 
    public function getWarningsArray() {
        return $this->getStatusArray( 'warning' );
    }
 
    public function __sleep() {
        $keys = array_keys( get_object_vars( $this ) );
        return array_diff( $keys, [ 'cleanCallback', 'messageLocalizer' ] );
    }
 
    public function __wakeup() {
        $this->cleanCallback = false;
        $this->messageLocalizer = null;
    }
 
    private function msg( $key, ...$params ): Message {
        if ( $this->messageLocalizer ) {
            return $this->messageLocalizer->msg( $key, ...$params );
        } else {
            return wfMessage( $key, ...$params );
        }
    }
 
    private function msgInLang( $key, $lang, ...$params ): Message {
        $msg = $this->msg( $key, ...$params );
        if ( $lang ) {
            $msg->inLanguage( $lang );
        }
        return $msg;
    }
}
 
class_alias( Status::class, 'Status' );