REL1_30/php/PHPVersionCheck_8php_source.html

<?php

// @codingStandardsIgnoreFile Generic.Arrays.DisallowLongArraySyntax

// @codingStandardsIgnoreFile Generic.Files.LineLength

// @codingStandardsIgnoreFile MediaWiki.Usage.DirUsage.FunctionFound


class PHPVersionCheck {

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

    var $mwVersion = '1.30';

    var $functionsExtensionsMapping = array(

        'mb_substr'   => 'mbstring',

        'utf8_encode' => 'xml',

        'ctype_digit' => 'ctype',

        'json_decode' => 'json',

        'iconv'       => 'iconv',

        'mime_content_type' => 'fileinfo',

    );


    var $entryPoint = null;


    function setEntryPoint( $entryPoint ) {

        $this->entryPoint = $entryPoint;

    }


    function getPHPInfo( $impl = false ) {

        if (

            ( defined( 'HHVM_VERSION' ) && $impl !== 'PHP' ) ||

            $impl === 'HHVM'

        ) {

            return array(

                'implementation' => 'HHVM',

                'version' => defined( 'HHVM_VERSION' ) ? HHVM_VERSION : 'undefined',

                'vendor' => 'Facebook',

                'upstreamSupported' => '3.6.5',

                'minSupported' => '3.6.5',

                'upgradeURL' => 'https://docs.hhvm.com/hhvm/installation/introduction',

            );

        }

        return array(

            'implementation' => 'PHP',

            'version' => PHP_VERSION,

            'vendor' => 'the PHP Group',

            'upstreamSupported' => '5.5.0',

            'minSupported' => '5.5.9',

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

        );

    }


    function checkRequiredPHPVersion() {

        $phpInfo = $this->getPHPInfo();

        $minimumVersion = $phpInfo['minSupported'];

        $otherInfo = $this->getPHPInfo( $phpInfo['implementation'] === 'HHVM' ? 'PHP' : 'HHVM' );

        if (

            !function_exists( 'version_compare' )

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

        ) {

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

                . " version $minimumVersion or {$otherInfo['implementation']} version "

                . "{$otherInfo['minSupported']}, you are using {$phpInfo['implementation']} "

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


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

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

                . " $minimumVersion or higher or {$otherInfo['implementation']} version "

                . "{$otherInfo['minSupported']}.\n\nCheck if you have a"

                . " newer php executable with a different name, such as php5.\n\n";


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

            $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.";


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


            $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://secure.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 ) {

        $pathinfo = pathinfo( $_SERVER['SCRIPT_NAME'] );

        if ( $this->entryPoint == 'mw-config/index.php' ) {

            $dirname = dirname( $pathinfo['dirname'] );

        } else {

            $dirname = $pathinfo['dirname'];

        }

        $encLogo =

            htmlspecialchars( str_replace( '//', '/', $dirname . '/' ) .

                '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 ) {

        switch ( $this->entryPoint ) {

            case 'cli':

                $finalOutput = $longText;

                break;

            case 'index.php':

            case 'mw-config/index.php':

                $this->outputHTMLHeader();

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

                break;

            case 'load.php':

                $this->outputHTMLHeader();

                $finalOutput = "/* $shortText */";

                break;

            default:

                $this->outputHTMLHeader();

                // Handle everything that's not index.php

                $finalOutput = $shortText;

        }


        echo "$finalOutput\n";

        die( 1 );

    }


}


function wfEntryPointCheck( $entryPoint ) {

    $phpVersionCheck = new PHPVersionCheck();

    $phpVersionCheck->setEntryPoint( $entryPoint );

    $phpVersionCheck->checkRequiredPHPVersion();

    $phpVersionCheck->checkVendorExistence();

    $phpVersionCheck->checkExtensionExistence();

}


href
shown</td >< td > a href
Definition All_system_messages.txt:2667

color
in the sidebar</td >< td > font color
Definition All_system_messages.txt:425

copy
and give any other recipients of the Program a copy of this License along with the Program You may charge a fee for the physical act of transferring a copy
Definition COPYING.txt:87

$ext
$ext
Definition NoLocalSettings.php:25

wfEntryPointCheck
wfEntryPointCheck( $entryPoint)
Check php version and that external dependencies are installed, and display an informative error if e...
Definition PHPVersionCheck.php:343

PHPVersionCheck
Definition PHPVersionCheck.php:30

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

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

PHPVersionCheck\$entryPoint
string $entryPoint
Which entry point we are protecting.
Definition PHPVersionCheck.php:50

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

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

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

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

PHPVersionCheck\getPHPInfo
getPHPInfo( $impl=false)
Returns the version of the installed php implementation.
Definition PHPVersionCheck.php:81

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

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

PHPVersionCheck\setEntryPoint
setEntryPoint( $entryPoint)
Definition PHPVersionCheck.php:61

PHP
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types as usual *javascript user provided javascript code *json simple implementation for use by etc *css user provided css code *text plain text In PHP
Definition contenthandler.txt:15

updates
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these updates(as a Java servelet could)

some
I won t presume to tell you how to I m just describing the methods I chose to use for myself If you do choose to follow these it will probably be easier for you to collaborate with others on the but if you want to contribute without by all means do which work well I also use K &R brace matching style I know that s a religious issue for some
Definition design.txt:79

array
the array() calling protocol came about after MediaWiki 1.4rc1.

version
Prior to version
Definition maintenance.txt:1

MediaWiki
A helper class for throttling authentication attempts.

style
Bar style
Definition parserTests.txt:192