includes/AutoLoader.php

   1 <?php
   2 /**
   3  * This defines autoloading handler for whole MediaWiki framework
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Locations of core classes
  25  * Extension classes are specified with $wgAutoloadClasses
  26  * This array is a global instead of a static member of AutoLoader to work around a bug in APC
  27  */
  28 require_once __DIR__ . '/../autoload.php';
  29
  30 class AutoLoader {
  31         static protected $autoloadLocalClassesLower = null;
  32
  33         /**
  34          * autoload - take a class name and attempt to load it
  35          *
  36          * @param string $className Name of class we're looking for.
  37          */
  38         static function autoload( $className ) {
  39                 global $wgAutoloadClasses, $wgAutoloadLocalClasses,
  40                         $wgAutoloadAttemptLowercase;
  41
  42                 $filename = false;
  43
  44                 if ( isset( $wgAutoloadLocalClasses[$className] ) ) {
  45                         $filename = $wgAutoloadLocalClasses[$className];
  46                 } elseif ( isset( $wgAutoloadClasses[$className] ) ) {
  47                         $filename = $wgAutoloadClasses[$className];
  48                 } elseif ( $wgAutoloadAttemptLowercase ) {
  49                         /*
  50                          * Try a different capitalisation.
  51                          *
  52                          * PHP 4 objects are always serialized with the classname coerced to lowercase,
  53                          * and we are plagued with several legacy uses created by MediaWiki < 1.5, see
  54                          * https://wikitech.wikimedia.org/wiki/Text_storage_data
  55                          */
  56                         $lowerClass = strtolower( $className );
  57
  58                         if ( self::$autoloadLocalClassesLower === null ) {
  59                                 self::$autoloadLocalClassesLower = array_change_key_case( $wgAutoloadLocalClasses, CASE_LOWER );
  60                         }
  61
  62                         if ( isset( self::$autoloadLocalClassesLower[$lowerClass] ) ) {
  63                                 if ( function_exists( 'wfDebugLog' ) ) {
  64                                         wfDebugLog( 'autoloader', "Class {$className} was loaded using incorrect case" );
  65                                 }
  66                                 $filename = self::$autoloadLocalClassesLower[$lowerClass];
  67                         }
  68                 }
  69
  70                 if ( !$filename ) {
  71                         // Class not found; let the next autoloader try to find it
  72                         return;
  73                 }
  74
  75                 // Make an absolute path, this improves performance by avoiding some stat calls
  76                 if ( substr( $filename, 0, 1 ) != '/' && substr( $filename, 1, 1 ) != ':' ) {
  77                         global $IP;
  78                         $filename = "$IP/$filename";
  79                 }
  80
  81                 require $filename;
  82         }
  83
  84         /**
  85          * Force a class to be run through the autoloader, helpful for things like
  86          * Sanitizer that have define()s outside of their class definition. Of course
  87          * this wouldn't be necessary if everything in MediaWiki was class-based. Sigh.
  88          *
  89          * @param string $class
  90          * @return bool Return the results of class_exists() so we know if we were successful
  91          */
  92         static function loadClass( $class ) {
  93                 return class_exists( $class );
  94         }
  95
  96         /**
  97          * Method to clear the protected class property $autoloadLocalClassesLower.
  98          * Used in tests.
  99          */
 100         static function resetAutoloadLocalClassesLower() {
 101                 self::$autoloadLocalClassesLower = null;
 102         }
 103 }
 104
 105 spl_autoload_register( [ 'AutoLoader', 'autoload' ] );