master/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

// phpcs:disable MediaWiki.Usage.StaticClosure.StaticClosure


class PHPVersionCheck {

    var $mwVersion = '1.46';


    var $functionsExtensionsMapping = array(

        'mb_substr'   => 'mbstring',

        'xml_parser_create' => 'xml',

        'ctype_digit' => 'ctype',

        'json_decode' => 'json',

        'iconv'       => 'iconv',

        'mime_content_type' => 'fileinfo',

        'intl_is_failure' => 'intl',

    );


    var $format = 'text';


    var $scriptPath = '/';


    function setFormat( $format ) {

        $this->format = $format;

    }


    function setScriptPath( $scriptPath ) {

        $this->scriptPath = $scriptPath;

    }


    function checkRequiredPHPVersion() {

        // This value should match the PHP version specified in composer.json,

        // .phan/config.php, and ScopeStructureTest.php

        $minimumVersion = '8.2.0';


        $knownBad = array(

        );


        $passes = version_compare( PHP_VERSION, $minimumVersion, '>=' );


        $versionString = "PHP $minimumVersion or higher";


        // Left as a programmatic check to make it easier to update.

        if ( count( $knownBad ) ) {

            $versionString .= ' (and not ' . implode( ', ', array_values( $knownBad ) ) . ')';


            foreach ( $knownBad as $range ) {

                // As we don't have composer at this point, we have to do our own version range checking.

                if ( strpos( $range, '-' ) ) {

                    $passes = $passes && !(

                        version_compare( PHP_VERSION, trim( strstr( $range, '-', true ) ), '>=' )

                        && version_compare( PHP_VERSION, trim( substr( strstr( $range, '-', false ), 1 ) ), '<' )

                    );

                } else {

                    $passes = $passes && version_compare( PHP_VERSION, trim( $range ), '<>' );

                }

            }

        }


        if ( !$passes ) {

            $cliText = "Error: You are using an unsupported PHP version (PHP " . PHP_VERSION . ").\n"

            . "MediaWiki $this->mwVersion needs $versionString.\n\nCheck if you might have a newer "

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


            $web = array();

            $web['intro'] = "MediaWiki $this->mwVersion requires $versionString; you are using PHP "

                . PHP_VERSION . ".";


            $web['longTitle'] = "Supported PHP versions";

            // phpcs:disable Generic.Files.LineLength

            $web['longHtml'] = <<<HTML

        <p>

            Please consider <a href="https://www.php.net/downloads.php">upgrading your copy of PHP</a>.

            PHP versions less than v8.2.0 are no longer <a href="https://www.php.net/supported-versions.php">supported</a>

            by the PHP Group and will not receive security or bugfix updates.

        </p>

        <p>

            If for some reason you are unable to upgrade your PHP 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 PHP.

        </p>

HTML;

            // phpcs:enable Generic.Files.LineLength

            $this->triggerError(

                $web,

                $cliText

            );

        }

    }


    function checkVendorExistence() {

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

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

                . "MediaWiki has dependencies that need to be installed via Composer\n"

                . "or from a separate repository. Please see\n"

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

                . "for help with installing them.";


            $web = array();

            $web['intro'] = "Installing some dependencies is required.";

            $web['longTitle'] = 'Dependencies';

            // phpcs:disable Generic.Files.LineLength

            $web['longHtml'] = <<<HTML

        <p>

        MediaWiki has dependencies that need to be installed via Composer

        or from a separate repository. Please see the

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

        for installing external libraries</a> on MediaWiki.org.

        </p>

HTML;

            // phpcs:enable Generic.Files.LineLength


            $this->triggerError( $web, $cliText );

        }

    }


    function checkExtensionExistence() {

        $missingExtensions = array();

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

            if ( !function_exists( $function ) ) {

                $missingExtensions[] = array( $extension );

            }

        }


        // Special case: either of those is required, but only on 32-bit systems (T391169)

        if ( PHP_INT_SIZE < 8 && !extension_loaded( 'gmp' ) && !extension_loaded( 'bcmath' ) ) {

            $missingExtensions[] = array( 'bcmath', 'gmp' );

        }


        if ( $missingExtensions ) {

            $missingExtText = '';

            $missingExtHtml = '';

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

            foreach ( $missingExtensions as $extNames ) {

                $plaintextLinks = array();

                $htmlLinks = array();

                foreach ( $extNames as $ext ) {

                    $plaintextLinks[] = "$ext <$baseUrl/$ext>";

                    $htmlLinks[] = "<b>$ext</b> (<a href=\"$baseUrl/$ext\">more information</a>)";

                }


                $missingExtText .= ' * ' . implode( ' or ', $plaintextLinks ) . "\n";

                $missingExtHtml .= "<li>" . implode( ' or ', $htmlLinks ) . "</li>";

            }


            $cliText = "Error: Missing one or more required PHP extensions. Please see\n"

                . "https://www.mediawiki.org/wiki/Manual:Installation_requirements#PHP\n"

                . "for help with installing them.\n"

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


            $web = array();

            $web['intro'] = "Installing some PHP extensions is required.";

            $web['longTitle'] = 'Required PHP extensions';

            $web['longHtml'] = <<<HTML

        <p>

        You are missing one or more extensions to PHP that MediaWiki requires to run. Please see the

        <a href="https://www.mediawiki.org/wiki/Manual:Installation_requirements#PHP">PHP

        installation requirements</a> on MediaWiki.org.

        </p>

        <p>Please install or enable:</p>

        <ul>

        $missingExtHtml

        </ul>

HTML;


            $this->triggerError( $web, $cliText );

        }

    }


    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: no-cache' );

    }


    function getIndexErrorOutput( $introText, $longTitle, $longHtml ) {

        $encLogo =

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

                'resources/assets/mediawiki.png' );


        $introHtml = htmlspecialchars( $introText );

        $longTitleHtml = htmlspecialchars( $longTitle );


        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>

        <p>

            {$introHtml}

        </p>

        <h2>{$longTitleHtml}</h2>

        {$longHtml}

    </body>

</html>

HTML;


        return $finalOutput;

    }


    function triggerError( $web, $cliText ) {

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

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

            $this->outputHTMLHeader();

            $finalOutput = $this->getIndexErrorOutput(

                $web['intro'],

                $web['longTitle'],

                $web['longHtml']

            );

        } else {

            // Used by Maintenance.php (CLI)

            $finalOutput = $cliText;

        }


        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:337

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

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

PHPVersionCheck\$mwVersion
string $mwVersion
The number of the MediaWiki version used.
Definition PHPVersionCheck.php:23

PHPVersionCheck\$scriptPath
string $scriptPath
Definition PHPVersionCheck.php:44

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

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

PHPVersionCheck\triggerError
triggerError( $web, $cliText)
Display something vaguely comprehensible in the event of a totally unrecoverable error.
Definition PHPVersionCheck.php:311

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

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:67

PHPVersionCheck\$functionsExtensionsMapping
string[] $functionsExtensionsMapping
A mapping of PHP functions to PHP extensions.
Definition PHPVersionCheck.php:26

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

PHPVersionCheck\$format
string $format
The format used for errors.
Definition PHPVersionCheck.php:39

MediaWiki
Helper trait for implementations \DAO.