AutoLoader.php

Go to the documentation of this file.

<?php
// NO_AUTOLOAD -- file scope code, can't load self
 
require_once __DIR__ . '/../autoload.php';
 
class AutoLoader {
 
    public const CORE_NAMESPACES = [
        'MediaWiki\\' => __DIR__ . '/',
        'MediaWiki\\Actions\\' => __DIR__ . '/actions/',
        'MediaWiki\\Api\\' => __DIR__ . '/api/',
        'MediaWiki\\Auth\\' => __DIR__ . '/auth/',
        'MediaWiki\\Block\\' => __DIR__ . '/block/',
        'MediaWiki\\Cache\\' => __DIR__ . '/cache/',
        'MediaWiki\\ChangeTags\\' => __DIR__ . '/changetags/',
        'MediaWiki\\Config\\' => __DIR__ . '/config/',
        'MediaWiki\\Content\\' => __DIR__ . '/content/',
        'MediaWiki\\DB\\' => __DIR__ . '/db/',
        'MediaWiki\\Deferred\\LinksUpdate\\' => __DIR__ . '/deferred/LinksUpdate/',
        'MediaWiki\\Diff\\' => __DIR__ . '/diff/',
        'MediaWiki\\EditPage\\' => __DIR__ . '/editpage/',
        'MediaWiki\\Edit\\' => __DIR__ . '/edit/',
        'MediaWiki\\FileBackend\\LockManager\\' => __DIR__ . '/filebackend/lockmanager/',
        'MediaWiki\\Http\\' => __DIR__ . '/http/',
        'MediaWiki\\Installer\\' => __DIR__ . '/installer/',
        'MediaWiki\\Interwiki\\' => __DIR__ . '/interwiki/',
        'MediaWiki\\JobQueue\\' => __DIR__ . '/jobqueue/',
        'MediaWiki\\Json\\' => __DIR__ . '/json/',
        'MediaWiki\\Languages\\Data\\' => __DIR__ . '/languages/data/',
        'MediaWiki\\Linker\\' => __DIR__ . '/linker/',
        'MediaWiki\\Logger\\' => __DIR__ . '/debug/logger/',
        'MediaWiki\\Logger\\Monolog\\' => __DIR__ . '/debug/logger/monolog/',
        'MediaWiki\\Mail\\' => __DIR__ . '/mail/',
        'MediaWiki\\Page\\' => __DIR__ . '/page/',
        'MediaWiki\\Parser\\' => __DIR__ . '/parser/',
        'MediaWiki\\Preferences\\' => __DIR__ . '/preferences/',
        'MediaWiki\\Search\\' => __DIR__ . '/search/',
        'MediaWiki\\Search\\SearchWidgets\\' => __DIR__ . '/search/searchwidgets/',
        'MediaWiki\\Session\\' => __DIR__ . '/session/',
        'MediaWiki\\Shell\\' => __DIR__ . '/shell/',
        'MediaWiki\\Site\\' => __DIR__ . '/site/',
        'MediaWiki\\Sparql\\' => __DIR__ . '/sparql/',
        'MediaWiki\\SpecialPage\\' => __DIR__ . '/specialpage/',
        'MediaWiki\\Tidy\\' => __DIR__ . '/tidy/',
        'MediaWiki\\User\\' => __DIR__ . '/user/',
        'MediaWiki\\Utils\\' => __DIR__ . '/utils/',
        'MediaWiki\\Widget\\' => __DIR__ . '/widget/',
        'Wikimedia\\' => __DIR__ . '/libs/',
        'Wikimedia\\Http\\' => __DIR__ . '/libs/http/',
        'Wikimedia\\Rdbms\\Platform\\' => __DIR__ . '/libs/rdbms/platform/',
        'Wikimedia\\UUID\\' => __DIR__ . '/libs/uuid/',
    ];
 
    private static $autoloadLocalClassesLower = null;
 
    public static $psr4Namespaces = self::CORE_NAMESPACES;
 
    private static $classFiles = [];
 
    public static function registerNamespaces( array $dirs ): void {
        self::$psr4Namespaces += $dirs;
    }
 
    public static function registerClasses( array $files ): void {
        self::$classFiles += $files;
    }
 
    public static function loadFile( string $file ): void {
        require_once $file;
    }
 
    public static function loadFiles( array $files ): void {
        foreach ( $files as $f ) {
            self::loadFile( $f );
        }
    }
 
    public static function find( $className ): ?string {
        global $wgAutoloadLocalClasses, $wgAutoloadClasses, $wgAutoloadAttemptLowercase;
 
        // NOTE: $wgAutoloadClasses is supported for compatibility with old-style extension
        //       registration files.
 
        $filename = $wgAutoloadLocalClasses[$className] ??
            self::$classFiles[$className] ??
            $wgAutoloadClasses[$className] ??
            false;
 
        if ( !$filename && $wgAutoloadAttemptLowercase ) {
            // Try a different capitalisation.
            //
            // PHP 4 objects are always serialized with the classname coerced to lowercase,
            // and we are plagued with several legacy uses created by MediaWiki < 1.5, see
            // https://wikitech.wikimedia.org/wiki/Text_storage_data
            if ( self::$autoloadLocalClassesLower === null ) {
                self::$autoloadLocalClassesLower = array_change_key_case( $wgAutoloadLocalClasses, CASE_LOWER );
            }
            $lowerClass = strtolower( $className );
            if ( isset( self::$autoloadLocalClassesLower[$lowerClass] ) ) {
                if ( function_exists( 'wfDebugLog' ) ) {
                    wfDebugLog( 'autoloader', "Class {$className} was loaded using incorrect case" );
                }
                // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
                $filename = self::$autoloadLocalClassesLower[$lowerClass];
            }
        }
 
        if ( !$filename && strpos( $className, '\\' ) !== false ) {
            // This class is namespaced, so look in the namespace map
            $prefix = $className;
            while ( ( $pos = strrpos( $prefix, '\\' ) ) !== false ) {
                // Check to see if this namespace prefix is in the map
                $prefix = substr( $className, 0, $pos + 1 );
                if ( isset( self::$psr4Namespaces[$prefix] ) ) {
                    $relativeClass = substr( $className, $pos + 1 );
                    // Build the expected filename, and see if it exists
                    $file = self::$psr4Namespaces[$prefix] .
                        '/' .
                        strtr( $relativeClass, '\\', '/' ) .
                        '.php';
                    if ( is_file( $file ) ) {
                        $filename = $file;
                        break;
                    }
                }
 
                // Remove trailing separator for next iteration
                $prefix = rtrim( $prefix, '\\' );
            }
        }
 
        if ( !$filename ) {
            // Class not found; let the next autoloader try to find it
            return null;
        }
 
        // Make an absolute path, this improves performance by avoiding some stat calls
        // Optimisation: use string offset access instead of substr
        if ( $filename[0] !== '/' && $filename[1] !== ':' ) {
            $filename = __DIR__ . '/../' . $filename;
        }
 
        return $filename;
    }
 
    public static function autoload( $className ) {
        $filename = self::find( $className );
 
        if ( $filename !== null ) {
            require $filename;
        }
    }
 
    public static function resetAutoloadLocalClassesLower() {
        self::$autoloadLocalClassesLower = null;
    }
 
    private static function assertTesting( $method ) {
        if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
            throw new LogicException( "$method is not supported outside phpunit tests!" );
        }
    }
 
    public static function getClassFiles(): array {
        global $wgAutoloadLocalClasses, $wgAutoloadClasses;
 
        self::assertTesting( __METHOD__ );
 
        // NOTE: ensure the order of preference is the same as used by find().
        return array_merge(
            $wgAutoloadClasses,
            self::$classFiles,
            $wgAutoloadLocalClasses
        );
    }
 
    public static function getNamespaceDirectories(): array {
        self::assertTesting( __METHOD__ );
        return self::$psr4Namespaces;
    }
 
    public static function getState(): array {
        self::assertTesting( __METHOD__ );
        return [
            'classFiles' => self::$classFiles,
            'psr4Namespaces' => self::$psr4Namespaces,
        ];
    }
 
    public static function restoreState( $state ): void {
        self::assertTesting( __METHOD__ );
 
        self::$classFiles = $state['classFiles'];
        self::$psr4Namespaces = $state['psr4Namespaces'];
    }
 
}
 
spl_autoload_register( [ 'AutoLoader', 'autoload' ] );
 
// Load composer's autoloader if present
if ( is_readable( __DIR__ . '/../vendor/autoload.php' ) ) {
    require_once __DIR__ . '/../vendor/autoload.php';
} elseif ( file_exists( __DIR__ . '/../vendor/autoload.php' ) ) {
    die( __DIR__ . '/../vendor/autoload.php exists but is not readable' );
}