MWException.php

Go to the documentation of this file.

<?php
class MWException extends Exception {
    public function useOutputPage() {
        return $this->useMessageCache() &&
        !empty( $GLOBALS['wgFullyInitialised'] ) &&
        !empty( $GLOBALS['wgOut'] ) &&
        !defined( 'MEDIAWIKI_INSTALL' );
    }

    public function isLoggable() {
        return true;
    }

    public function useMessageCache() {
        global $wgLang;

        foreach ( $this->getTrace() as $frame ) {
            if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
                return false;
            }
        }

        return $wgLang instanceof Language;
    }

    public function runHooks( $name, $args = array() ) {
        global $wgExceptionHooks;

        if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
            return null; // Just silently ignore
        }

        if ( !array_key_exists( $name, $wgExceptionHooks ) ||
            !is_array( $wgExceptionHooks[$name] )
        ) {
            return null;
        }

        $hooks = $wgExceptionHooks[$name];
        $callargs = array_merge( array( $this ), $args );

        foreach ( $hooks as $hook ) {
            if (
                is_string( $hook ) ||
                ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) )
            ) {
                // 'function' or array( 'class', hook' )
                $result = call_user_func_array( $hook, $callargs );
            } else {
                $result = null;
            }

            if ( is_string( $result ) ) {
                return $result;
            }
        }
        return null;
    }

    public function msg( $key, $fallback /*[, params...] */ ) {
        $args = array_slice( func_get_args(), 2 );

        if ( $this->useMessageCache() ) {
            return wfMessage( $key, $args )->text();
        } else {
            return wfMsgReplaceArgs( $fallback, $args );
        }
    }

    public function getHTML() {
        global $wgShowExceptionDetails;

        if ( $wgShowExceptionDetails ) {
            return '<p>' . nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $this ) ) ) .
            '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $this ) ) ) .
            "</p>\n";
        } else {
            return "<div class=\"errorbox\">" .
            '[' . MWExceptionHandler::getLogId( $this ) . '] ' .
            gmdate( 'Y-m-d H:i:s' ) .
            ": Fatal exception of type " . get_class( $this ) . "</div>\n" .
            "<!-- Set \$wgShowExceptionDetails = true; " .
            "at the bottom of LocalSettings.php to show detailed " .
            "debugging information. -->";
        }
    }

    public function getText() {
        global $wgShowExceptionDetails;

        if ( $wgShowExceptionDetails ) {
            return MWExceptionHandler::getLogMessage( $this ) .
            "\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $this ) . "\n";
        } else {
            return "Set \$wgShowExceptionDetails = true; " .
            "in LocalSettings.php to show detailed debugging information.\n";
        }
    }

    public function getPageTitle() {
        return $this->msg( 'internalerror', 'Internal error' );
    }

    public function getLogId() {
        wfDeprecated( __METHOD__, '1.22' );
        return MWExceptionHandler::getLogId( $this );
    }

    public function getLogMessage() {
        wfDeprecated( __METHOD__, '1.22' );
        return MWExceptionHandler::getLogMessage( $this );
    }

    public function reportHTML() {
        global $wgOut, $wgSitename;
        if ( $this->useOutputPage() ) {
            $wgOut->prepareErrorPage( $this->getPageTitle() );

            $hookResult = $this->runHooks( get_class( $this ) );
            if ( $hookResult ) {
                $wgOut->addHTML( $hookResult );
            } else {
                $wgOut->addHTML( $this->getHTML() );
            }

            $wgOut->output();
        } else {
            header( 'Content-Type: text/html; charset=utf-8' );
            echo "<!DOCTYPE html>\n" .
                '<html><head>' .
                // Mimick OutputPage::setPageTitle behaviour
                '<title>' . htmlspecialchars( $this->msg( 'pagetitle', "$1 - $wgSitename", $this->getPageTitle() ) ) . '</title>' .
                '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
                "</head><body>\n";

            $hookResult = $this->runHooks( get_class( $this ) . 'Raw' );
            if ( $hookResult ) {
                echo $hookResult;
            } else {
                echo $this->getHTML();
            }

            echo "</body></html>\n";
        }
    }

    public function report() {
        global $wgMimeType;

        MWExceptionHandler::logException( $this );

        if ( defined( 'MW_API' ) ) {
            // Unhandled API exception, we can't be sure that format printer is alive
            header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
            wfHttpError( 500, 'Internal Server Error', $this->getText() );
        } elseif ( self::isCommandLine() ) {
            MWExceptionHandler::printError( $this->getText() );
        } else {
            header( 'HTTP/1.1 500 MediaWiki exception' );
            header( 'Status: 500 MediaWiki exception', true );
            header( "Content-Type: $wgMimeType; charset=utf-8", true );

            $this->reportHTML();
        }
    }

    public static function isCommandLine() {
        return !empty( $GLOBALS['wgCommandLineMode'] );
    }
}