REL1_34/php/PHPVersionCheck_8php_source.html

<?php

// phpcs:disable Generic.Arrays.DisallowLongArraySyntax,PSR2.Classes.PropertyDeclaration,MediaWiki.Usage.DirUsage

// phpcs:disable Squiz.Scope.MemberVarScope.Missing,Squiz.Scope.MethodScope.Missing

// @phan-file-suppress PhanPluginDuplicateConditionalNullCoalescing


class PHPVersionCheck {

    /* @var string The number of the MediaWiki version used. */

    var $mwVersion = '1.34';


    /* @var array A mapping of PHP functions to PHP extensions. */

    var $functionsExtensionsMapping = array(

        'mb_substr'   => 'mbstring',

        'xml_parser_create' => 'xml',

        'ctype_digit' => 'ctype',

        'json_decode' => 'json',

        'iconv'       => 'iconv',

        'mime_content_type' => 'fileinfo',

    );


    var $format = 'text';


    var $scriptPath = '/';


    function setFormat( $format ) {

        $this->format = $format;

    }


    function setScriptPath( $scriptPath ) {

        $this->scriptPath = $scriptPath;

    }


    function getPHPInfo() {

        return array(

            'implementation' => 'PHP',

            'version' => PHP_VERSION,

            'vendor' => 'the PHP Group',

            'upstreamSupported' => '7.2.0',

            'minSupported' => '7.2.9',

            'upgradeURL' => 'https://www.php.net/downloads.php',

        );

    }


    function checkRequiredPHPVersion() {

        $phpInfo = $this->getPHPInfo();

        $minimumVersion = $phpInfo['minSupported'];

        if ( version_compare( $phpInfo['version'], $minimumVersion ) < 0 ) {

            $shortText = "MediaWiki $this->mwVersion requires at least {$phpInfo['implementation']}"

                . " version $minimumVersion, you are using {$phpInfo['implementation']} "

                . "{$phpInfo['version']}.";


            $longText = "Error: You might be using an older {$phpInfo['implementation']} version "

                . "({$phpInfo['implementation']} {$phpInfo['version']}). \n"

                . "MediaWiki $this->mwVersion needs {$phpInfo['implementation']}"

                . " $minimumVersion or higher.\n\nCheck if you have a"

                . " newer PHP executable with a different name.\n\n";


            // phpcs:disable Generic.Files.LineLength

            $longHtml = <<<HTML

            Please consider <a href="{$phpInfo['upgradeURL']}">upgrading your copy of

            {$phpInfo['implementation']}</a>.

            {$phpInfo['implementation']} versions less than {$phpInfo['upstreamSupported']} are no

            longer supported by {$phpInfo['vendor']} and will not receive

            security or bugfix updates.

        </p>

        <p>

            If for some reason you are unable to upgrade your {$phpInfo['implementation']} version,

            you will need to <a href="https://www.mediawiki.org/wiki/Download">download</a> an

            older version of MediaWiki from our website.

            See our <a href="https://www.mediawiki.org/wiki/Compatibility#PHP">compatibility page</a>

            for details of which versions are compatible with prior versions of {$phpInfo['implementation']}.

HTML;

            // phpcs:enable Generic.Files.LineLength

            $this->triggerError(

                "Supported {$phpInfo['implementation']} versions",

                $shortText,

                $longText,

                $longHtml

            );

        }

    }


    function checkVendorExistence() {

        if ( !file_exists( dirname( __FILE__ ) . '/../vendor/autoload.php' ) ) {

            $shortText = "Installing some external dependencies (e.g. via composer) is required.";


            $longText = "Error: You are missing some external dependencies. \n"

                . "MediaWiki now also has some external dependencies that need to be installed\n"

                . "via composer or from a separate git repo. Please see\n"

                . "https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries\n"

                . "for help on installing the required components.";


            // phpcs:disable Generic.Files.LineLength

            $longHtml = <<<HTML

        MediaWiki now also has some external dependencies that need to be installed via

        composer or from a separate git repo. Please see

        <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a>

        for help on installing the required components.

HTML;

            // phpcs:enable Generic.Files.LineLength


            $this->triggerError( 'External dependencies', $shortText, $longText, $longHtml );

        }

    }


    function checkExtensionExistence() {

        $missingExtensions = array();

        foreach ( $this->functionsExtensionsMapping as $function => $extension ) {

            if ( !function_exists( $function ) ) {

                $missingExtensions[] = $extension;

            }

        }


        if ( $missingExtensions ) {

            $shortText = "Installing some PHP extensions is required.";


            $missingExtText = '';

            $missingExtHtml = '';

            $baseUrl = 'https://www.php.net';

            foreach ( $missingExtensions as $ext ) {

                $missingExtText .= " * $ext <$baseUrl/$ext>\n";

                $missingExtHtml .= "<li><b>$ext</b> "

                    . "(<a href=\"$baseUrl/$ext\">more information</a>)</li>";

            }


            $cliText = "Error: Missing one or more required components of PHP.\n"

                . "You are missing a required extension to PHP that MediaWiki needs.\n"

                . "Please install:\n" . $missingExtText;


            $longHtml = <<<HTML

        You are missing a required extension to PHP that MediaWiki

        requires to run. Please install:

        <ul>

        $missingExtHtml

        </ul>

HTML;


            $this->triggerError( 'Required components', $shortText, $cliText, $longHtml );

        }

    }


    function outputHTMLHeader() {

        $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';


        header( "$protocol 500 MediaWiki configuration Error" );

        // Don't cache error pages!  They cause no end of trouble...

        header( 'Cache-control: none' );

        header( 'Pragma: no-cache' );

    }


    function getIndexErrorOutput( $title, $longHtml, $shortText ) {

        $encLogo =

            htmlspecialchars( str_replace( '//', '/', $this->scriptPath . '/' ) .

                'resources/assets/mediawiki.png' );

        $shortHtml = htmlspecialchars( $shortText );


        header( 'Content-type: text/html; charset=UTF-8' );


        $finalOutput = <<<HTML

<!DOCTYPE html>

<html lang="en" dir="ltr">

    <head>

        <meta charset="UTF-8" />

        <title>MediaWiki {$this->mwVersion}</title>

        <style media="screen">

            body {

                color: #000;

                background-color: #fff;

                font-family: sans-serif;

                padding: 2em;

                text-align: center;

            }

            p, img, h1, h2, ul {

                text-align: left;

                margin: 0.5em 0 1em;

            }

            h1 {

                font-size: 120%;

            }

            h2 {

                font-size: 110%;

            }

        </style>

    </head>

    <body>

        <img src="{$encLogo}" alt="The MediaWiki logo" />

        <h1>MediaWiki {$this->mwVersion} internal error</h1>

        <div class="error">

        <p>

            {$shortHtml}

        </p>

        <h2>{$title}</h2>

        <p>

            {$longHtml}

        </p>

        </div>

    </body>

</html>

HTML;


        return $finalOutput;

    }


    function triggerError( $title, $shortText, $longText, $longHtml ) {

        if ( $this->format === 'html' ) {

            // Used by index.php and mw-config/index.php

            $this->outputHTMLHeader();

            $finalOutput = $this->getIndexErrorOutput( $title, $longHtml, $shortText );

        } else {

            // Used by Maintenance.php (CLI)

            $finalOutput = $longText;

        }


        echo "$finalOutput\n";

        die( 1 );

    }


}


function wfEntryPointCheck( $format = 'text', $scriptPath = '/' ) {

    $phpVersionCheck = new PHPVersionCheck();

    $phpVersionCheck->setFormat( $format );

    $phpVersionCheck->setScriptPath( $scriptPath );

    $phpVersionCheck->checkRequiredPHPVersion();

    $phpVersionCheck->checkVendorExistence();

    $phpVersionCheck->checkExtensionExistence();

}


wfEntryPointCheck
wfEntryPointCheck( $format='text', $scriptPath='/')
Check PHP version and that external dependencies are installed, and display an informative error if e...
Definition PHPVersionCheck.php:318

PHPVersionCheck
Check PHP Version, as well as for composer dependencies in entry points, and display something vaguel...
Definition PHPVersionCheck.php:35

PHPVersionCheck\triggerError
triggerError( $title, $shortText, $longText, $longHtml)
Display something vaguely comprehensible in the event of a totally unrecoverable error.
Definition PHPVersionCheck.php:296

PHPVersionCheck\setFormat
setFormat( $format)
Set the format used for errors.
Definition PHPVersionCheck.php:64

PHPVersionCheck\getPHPInfo
getPHPInfo()
Return the version of the installed PHP implementation.
Definition PHPVersionCheck.php:92

PHPVersionCheck\$scriptPath
$scriptPath
Definition PHPVersionCheck.php:57

PHPVersionCheck\outputHTMLHeader
outputHTMLHeader()
Output headers that prevents error pages to be cached.
Definition PHPVersionCheck.php:213

PHPVersionCheck\setScriptPath
setScriptPath( $scriptPath)
Set the script path used for images in HTML-formatted errors.
Definition PHPVersionCheck.php:73

PHPVersionCheck\$format
$format
Definition PHPVersionCheck.php:52

PHPVersionCheck\checkExtensionExistence
checkExtensionExistence()
Displays an error, if a PHP extension does not exist.
Definition PHPVersionCheck.php:174

PHPVersionCheck\checkRequiredPHPVersion
checkRequiredPHPVersion()
Displays an error, if the installed PHP version does not meet the minimum requirement.
Definition PHPVersionCheck.php:106

PHPVersionCheck\checkVendorExistence
checkVendorExistence()
Displays an error, if the vendor/autoload.php file could not be found.
Definition PHPVersionCheck.php:148

PHPVersionCheck\$functionsExtensionsMapping
$functionsExtensionsMapping
Definition PHPVersionCheck.php:40

PHPVersionCheck\getIndexErrorOutput
getIndexErrorOutput( $title, $longHtml, $shortText)
Returns an error page, which is suitable for output to the end user via a web browser.
Definition PHPVersionCheck.php:230

PHPVersionCheck\$mwVersion
$mwVersion
Definition PHPVersionCheck.php:37

MediaWiki
A helper class for throttling authentication attempts.

$ext
if(!is_readable( $file)) $ext
Definition router.php:48

$title
$title
Definition testCompression.php:34