Status.php

Go to the documentation of this file.

<?php
class Status {
    protected $sv;

    public $value;
    public $success = [];
    public $successCount = 0;
    public $failCount = 0;

    public $cleanCallback = false;

    public function __construct( StatusValue $sv = null ) {
        $this->sv = ( $sv === null ) ? new StatusValue() : $sv;
        // B/C field aliases
        $this->value =& $this->sv->value;
        $this->successCount =& $this->sv->successCount;
        $this->failCount =& $this->sv->failCount;
        $this->success =& $this->sv->success;
    }

    public static function wrap( $sv ) {
        return $sv instanceof Status ? $sv : new self( $sv );
    }

    public static function newFatal( $message /*, parameters...*/ ) {
        return new self( call_user_func_array(
            [ 'StatusValue', 'newFatal' ], func_get_args()
        ) );
    }

    public static function newGood( $value = null ) {
        $sv = new StatusValue();
        $sv->value = $value;

        return new self( $sv );
    }

    public function setResult( $ok, $value = null ) {
        $this->sv->setResult( $ok, $value );
    }

    public function getStatusValue() {
        return $this->sv;
    }

    public function isGood() {
        return $this->sv->isGood();
    }

    public function isOK() {
        return $this->sv->isOK();
    }

    public function warning( $message /*, parameters... */ ) {
        call_user_func_array( [ $this->sv, 'warning' ], func_get_args() );
    }

    public function error( $message /*, parameters... */ ) {
        call_user_func_array( [ $this->sv, 'error' ], func_get_args() );
    }

    public function fatal( $message /*, parameters... */ ) {
        call_user_func_array( [ $this->sv, 'fatal' ], func_get_args() );
    }

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

    protected function languageFromParam( $lang ) {
        global $wgLang;

        if ( $lang === null ) {
            // @todo: Use RequestContext::getMain()->getLanguage() instead
            return $wgLang;
        } elseif ( $lang instanceof Language || $lang instanceof StubUserLang ) {
            return $lang;
        } else {
            return Language::factory( $lang );
        }
    }

    public function getWikiText( $shortContext = false, $longContext = false, $lang = null ) {
        $lang = $this->languageFromParam( $lang );

        $rawErrors = $this->sv->getErrors();
        if ( count( $rawErrors ) == 0 ) {
            if ( $this->sv->isOK() ) {
                $this->sv->fatal( 'internalerror_info',
                    __METHOD__ . " called for a good result, this is incorrect\n" );
            } else {
                $this->sv->fatal( 'internalerror_info',
                    __METHOD__ . ": Invalid result object: no error text but not OK\n" );
            }
            $rawErrors = $this->sv->getErrors(); // just added a fatal
        }
        if ( count( $rawErrors ) == 1 ) {
            $s = $this->getErrorMessage( $rawErrors[0], $lang )->plain();
            if ( $shortContext ) {
                $s = wfMessage( $shortContext, $s )->inLanguage( $lang )->plain();
            } elseif ( $longContext ) {
                $s = wfMessage( $longContext, "* $s\n" )->inLanguage( $lang )->plain();
            }
        } else {
            $errors = $this->getErrorMessageArray( $rawErrors, $lang );
            foreach ( $errors as &$error ) {
                $error = $error->plain();
            }
            $s = '* ' . implode( "\n* ", $errors ) . "\n";
            if ( $longContext ) {
                $s = wfMessage( $longContext, $s )->inLanguage( $lang )->plain();
            } elseif ( $shortContext ) {
                $s = wfMessage( $shortContext, "\n$s\n" )->inLanguage( $lang )->plain();
            }
        }
        return $s;
    }

    public function getMessage( $shortContext = false, $longContext = false, $lang = null ) {
        $lang = $this->languageFromParam( $lang );

        $rawErrors = $this->sv->getErrors();
        if ( count( $rawErrors ) == 0 ) {
            if ( $this->sv->isOK() ) {
                $this->sv->fatal( 'internalerror_info',
                    __METHOD__ . " called for a good result, this is incorrect\n" );
            } else {
                $this->sv->fatal( 'internalerror_info',
                    __METHOD__ . ": Invalid result object: no error text but not OK\n" );
            }
            $rawErrors = $this->sv->getErrors(); // just added a fatal
        }
        if ( count( $rawErrors ) == 1 ) {
            $s = $this->getErrorMessage( $rawErrors[0], $lang );
            if ( $shortContext ) {
                $s = wfMessage( $shortContext, $s )->inLanguage( $lang );
            } elseif ( $longContext ) {
                $wrapper = new RawMessage( "* \$1\n" );
                $wrapper->params( $s )->parse();
                $s = wfMessage( $longContext, $wrapper )->inLanguage( $lang );
            }
        } else {
            $msgs = $this->getErrorMessageArray( $rawErrors, $lang );
            $msgCount = count( $msgs );

            $s = new RawMessage( '* $' . implode( "\n* \$", range( 1, $msgCount ) ) );
            $s->params( $msgs )->parse();

            if ( $longContext ) {
                $s = wfMessage( $longContext, $s )->inLanguage( $lang );
            } elseif ( $shortContext ) {
                $wrapper = new RawMessage( "\n\$1\n", [ $s ] );
                $wrapper->parse();
                $s = wfMessage( $shortContext, $wrapper )->inLanguage( $lang );
            }
        }

        return $s;
    }

    protected function getErrorMessage( $error, $lang = null ) {
        if ( is_array( $error ) ) {
            if ( isset( $error['message'] ) && $error['message'] instanceof Message ) {
                $msg = $error['message'];
            } elseif ( isset( $error['message'] ) && isset( $error['params'] ) ) {
                $msg = wfMessage( $error['message'],
                    array_map( 'wfEscapeWikiText', $this->cleanParams( $error['params'] ) ) );
            } else {
                $msgName = array_shift( $error );
                $msg = wfMessage( $msgName,
                    array_map( 'wfEscapeWikiText', $this->cleanParams( $error ) ) );
            }
        } else {
            $msg = wfMessage( $error );
        }

        $msg->inLanguage( $this->languageFromParam( $lang ) );
        return $msg;
    }

    public function getHTML( $shortContext = false, $longContext = false, $lang = null ) {
        $lang = $this->languageFromParam( $lang );
        $text = $this->getWikiText( $shortContext, $longContext, $lang );
        $out = MessageCache::singleton()->parse( $text, null, true, true, $lang );
        return $out instanceof ParserOutput ? $out->getText() : $out;
    }

    protected function getErrorMessageArray( $errors, $lang = null ) {
        $lang = $this->languageFromParam( $lang );
        return array_map( function ( $e ) use ( $lang ) {
            return $this->getErrorMessage( $e, $lang );
        }, $errors );
    }

    public function merge( $other, $overwriteValue = false ) {
        $this->sv->merge( $other->sv, $overwriteValue );
    }

    public function getErrorsArray() {
        return $this->getStatusArray( 'error' );
    }

    public function getWarningsArray() {
        return $this->getStatusArray( 'warning' );
    }

    protected function getStatusArray( $type = false ) {
        $result = [];

        foreach ( $this->sv->getErrors() as $error ) {
            if ( $type === false || $error['type'] === $type ) {
                if ( $error['message'] instanceof MessageSpecifier ) {
                    $result[] = array_merge(
                        [ $error['message']->getKey() ],
                        $error['message']->getParams()
                    );
                } elseif ( $error['params'] ) {
                    $result[] = array_merge( [ $error['message'] ], $error['params'] );
                } else {
                    $result[] = [ $error['message'] ];
                }
            }
        }

        return $result;
    }

    public function getErrorsByType( $type ) {
        return $this->sv->getErrorsByType( $type );
    }

    public function hasMessage( $message ) {
        return $this->sv->hasMessage( $message );
    }

    public function replaceMessage( $source, $dest ) {
        return $this->sv->replaceMessage( $source, $dest );
    }

    public function getValue() {
        return $this->sv->getValue();
    }

    function __get( $name ) {
        if ( $name === 'ok' ) {
            return $this->sv->isOK();
        } elseif ( $name === 'errors' ) {
            return $this->sv->getErrors();
        }
        throw new Exception( "Cannot get '$name' property." );
    }

    function __set( $name, $value ) {
        if ( $name === 'ok' ) {
            $this->sv->setOK( $value );
        } elseif ( !property_exists( $this, $name ) ) {
            // Caller is using undeclared ad-hoc properties
            $this->$name = $value;
        } else {
            throw new Exception( "Cannot set '$name' property." );
        }
    }

    public function __toString() {
        return $this->sv->__toString();
    }

    function __sleep() {
        $keys = array_keys( get_object_vars( $this ) );
        return array_diff( $keys, [ 'cleanCallback' ] );
    }

    function __wakeup() {
        $this->cleanCallback = false;
    }
}