REL1_33/php/MWException_8php_source.html

<?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::class ) {

                return false;

            }

        }


        return $wgLang instanceof Language;

    }


    public function msg( $key, $fallback /*[, params...] */ ) {

        global $wgSitename;

        $args = array_slice( func_get_args(), 2 );


        // FIXME: Keep logic in sync with MWExceptionRenderer::msg.

        $res = false;

        if ( $this->useMessageCache() ) {

            try {

                $res = wfMessage( $key, $args )->text();

            } catch ( Exception $e ) {

            }

        }

        if ( $res === false ) {

            $res = wfMsgReplaceArgs( $fallback, $args );

            // If an exception happens inside message rendering,

            // {{SITENAME}} sometimes won't be replaced.

            $res = strtr( $res, [

                '{{SITENAME}}' => $wgSitename,

            ] );

        }

        return $res;

    }


    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 {

            $logId = WebRequest::getRequestId();

            $type = static::class;

            return Html::errorBox(

            htmlspecialchars(

                '[' . $logId . '] ' .

                gmdate( 'Y-m-d H:i:s' ) . ": " .

                $this->msg( "internalerror-fatal-exception",

                    "Fatal exception of type $1",

                    $type,

                    $logId,

                    MWExceptionHandler::getURL()

                )

            ) ) .

            "<!-- 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 reportHTML() {

        global $wgOut, $wgSitename;

        if ( $this->useOutputPage() ) {

            $wgOut->prepareErrorPage( $this->getPageTitle() );

            // Manually set the html title, since sometimes

            // {{SITENAME}} does not get replaced for exceptions

            // happening inside message rendering.

            $wgOut->setHTMLTitle(

                $this->msg(

                    'pagetitle',

                    "$1 - $wgSitename",

                    $this->getPageTitle()

                )

            );


            $wgOut->addHTML( $this->getHTML() );


            $wgOut->output();

        } else {

            self::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";


            echo $this->getHTML();


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

        }

    }


    public function report() {

        global $wgMimeType;


        if ( defined( 'MW_API' ) ) {

            // Unhandled API exception, we can't be sure that format printer is alive

            self::header( 'MediaWiki-API-Error: internal_api_error_' . static::class );

            wfHttpError( 500, 'Internal Server Error', $this->getText() );

        } elseif ( self::isCommandLine() ) {

            $message = $this->getText();

            $this->writeToCommandLine( $message );

        } else {

            self::statusHeader( 500 );

            self::header( "Content-Type: $wgMimeType; charset=utf-8" );


            $this->reportHTML();

        }

    }


    private function writeToCommandLine( $message ) {

        // T17602: STDERR may not be available

        if ( !defined( 'MW_PHPUNIT_TEST' ) && defined( 'STDERR' ) ) {

            fwrite( STDERR, $message );

        } else {

            echo $message;

        }

    }


    public static function isCommandLine() {

        return !empty( $GLOBALS['wgCommandLineMode'] );

    }


    private static function header( $header ) {

        if ( !headers_sent() ) {

            header( $header );

        }

    }


    private static function statusHeader( $code ) {

        if ( !headers_sent() ) {

            HttpStatus::header( $code );

        }

    }


}


$GLOBALS
$GLOBALS['IP']
Definition ComposerHookHandler.php:6

$wgMimeType
$wgMimeType
The default Content-Type header.
Definition DefaultSettings.php:3209

$wgSitename
$wgSitename
Name of the site.
Definition DefaultSettings.php:81

$wgShowExceptionDetails
$wgShowExceptionDetails
If set to true, uncaught exceptions will print the exception message and a complete stack trace to ou...
Definition DefaultSettings.php:6291

wfHttpError
wfHttpError( $code, $label, $desc)
Provide a simple HTTP error.
Definition GlobalFunctions.php:1697

wfMsgReplaceArgs
wfMsgReplaceArgs( $message, $args)
Replace message parameter keys on the given formatted output.
Definition GlobalFunctions.php:1337

$fallback
$fallback
Definition MessagesAb.php:11

$wgOut
$wgOut
Definition Setup.php:880

$wgLang
$wgLang
Definition Setup.php:875

$args
if( $line===false) $args
Definition cdb.php:64

HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition HttpStatus.php:96

Language
Internationalisation code.
Definition Language.php:36

MWException
MediaWiki exception.
Definition MWException.php:26

MWException\writeToCommandLine
writeToCommandLine( $message)
Write a message to stderr falling back to stdout if stderr unavailable.
Definition MWException.php:227

MWException\statusHeader
static statusHeader( $code)
Definition MWException.php:256

MWException\isLoggable
isLoggable()
Whether to log this exception in the exception debug log.
Definition MWException.php:45

MWException\useMessageCache
useMessageCache()
Can the extension use the Message class/wfMessage to get i18n-ed messages?
Definition MWException.php:54

MWException\header
static header( $header)
Send a header, if we haven't already sent them.
Definition MWException.php:251

MWException\getHTML
getHTML()
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error,...
Definition MWException.php:105

MWException\isCommandLine
static isCommandLine()
Check whether we are in command line mode or not to report the exception in the correct format.
Definition MWException.php:242

MWException\useOutputPage
useOutputPage()
Should the exception use $wgOut to output the error?
Definition MWException.php:32

MWException\report
report()
Output a report about the exception and takes care of formatting.
Definition MWException.php:203

MWException\getPageTitle
getPageTitle()
Return the title of the page when reporting this error in a HTTP response.
Definition MWException.php:157

MWException\reportHTML
reportHTML()
Output the exception report using HTML.
Definition MWException.php:164

MWException\getText
getText()
Get the text to display when reporting the error on the command line.
Definition MWException.php:140

MWException\msg
msg( $key, $fallback)
Get a message from i18n.
Definition MWException.php:75

$res
$res
Definition database.txt:21

as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition distributors.txt:22

$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:856

wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services

$e
returning false will NOT prevent logging $e
Definition hooks.txt:2175

php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37

$type
$type
Definition testCompression.php:48

$header
$header
Definition updateCredits.php:41