With the introduction of a REST API into MediaWiki core, we're going to want to share parameter validation logic rather than having similar code in both the Action API and the REST API. This abstracts out parameter validation logic as a library. There will be at least two follow-up patches: * One to add calls in the REST API, plus the interface for the REST API to do body validation. Should be reasonably straightforward. * One to adjust the Action API to use this. That'll be much less straightforward, as the Action API needs some MediaWiki-specific types (which the REST API might use too in the future) and needs to override the defaults on some of the library's checks (to maintain back-compat). Bug: T142080 Bug: T223239 Change-Id: I5c0cc3a8d686ace97596df5832c450a6a50f902c Depends-On: Iea05dc439688871c574c639e617765ae88a75ff7
153 lines
5.2 KiB
PHP
153 lines
5.2 KiB
PHP
<?php
|
|
/**
|
|
* This defines autoloading handler for whole MediaWiki framework
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* Locations of core classes
|
|
* Extension classes are specified with $wgAutoloadClasses
|
|
* This array is a global instead of a static member of AutoLoader to work around a bug in APC
|
|
*/
|
|
require_once __DIR__ . '/../autoload.php';
|
|
|
|
class AutoLoader {
|
|
protected static $autoloadLocalClassesLower = null;
|
|
|
|
/**
|
|
* @private Only public for ExtensionRegistry
|
|
* @var string[] Namespace (ends with \) => Path (ends with /)
|
|
*/
|
|
public static $psr4Namespaces = [];
|
|
|
|
/**
|
|
* autoload - take a class name and attempt to load it
|
|
*
|
|
* @param string $className Name of class we're looking for.
|
|
*/
|
|
static function autoload( $className ) {
|
|
global $wgAutoloadClasses, $wgAutoloadLocalClasses,
|
|
$wgAutoloadAttemptLowercase;
|
|
|
|
$filename = false;
|
|
|
|
if ( isset( $wgAutoloadLocalClasses[$className] ) ) {
|
|
$filename = $wgAutoloadLocalClasses[$className];
|
|
} elseif ( isset( $wgAutoloadClasses[$className] ) ) {
|
|
$filename = $wgAutoloadClasses[$className];
|
|
} elseif ( $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
|
|
*/
|
|
$lowerClass = strtolower( $className );
|
|
|
|
if ( self::$autoloadLocalClassesLower === null ) {
|
|
self::$autoloadLocalClassesLower = array_change_key_case( $wgAutoloadLocalClasses, CASE_LOWER );
|
|
}
|
|
|
|
if ( isset( self::$autoloadLocalClassesLower[$lowerClass] ) ) {
|
|
if ( function_exists( 'wfDebugLog' ) ) {
|
|
wfDebugLog( 'autoloader', "Class {$className} was loaded using incorrect case" );
|
|
}
|
|
$filename = self::$autoloadLocalClassesLower[$lowerClass];
|
|
}
|
|
}
|
|
|
|
if ( !$filename && strpos( $className, '\\' ) !== false ) {
|
|
// This class is namespaced, so try looking at the namespace map
|
|
$prefix = $className;
|
|
while ( false !== $pos = strrpos( $prefix, '\\' ) ) {
|
|
// 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] . '/' .
|
|
str_replace( '\\', '/', $relativeClass ) . '.php';
|
|
if ( file_exists( $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;
|
|
}
|
|
|
|
// Make an absolute path, this improves performance by avoiding some stat calls
|
|
if ( substr( $filename, 0, 1 ) != '/' && substr( $filename, 1, 1 ) != ':' ) {
|
|
global $IP;
|
|
$filename = "$IP/$filename";
|
|
}
|
|
|
|
require $filename;
|
|
}
|
|
|
|
/**
|
|
* Method to clear the protected class property $autoloadLocalClassesLower.
|
|
* Used in tests.
|
|
*/
|
|
static function resetAutoloadLocalClassesLower() {
|
|
self::$autoloadLocalClassesLower = null;
|
|
}
|
|
|
|
/**
|
|
* Get a mapping of namespace => file path
|
|
* The namespaces should follow the PSR-4 standard for autoloading
|
|
*
|
|
* @see <http://www.php-fig.org/psr/psr-4/>
|
|
* @private Only public for usage in AutoloadGenerator
|
|
* @codeCoverageIgnore
|
|
* @since 1.31
|
|
* @return string[]
|
|
*/
|
|
public static function getAutoloadNamespaces() {
|
|
return [
|
|
'MediaWiki\\Auth\\' => __DIR__ . '/auth/',
|
|
'MediaWiki\\Block\\' => __DIR__ . '/block/',
|
|
'MediaWiki\\Edit\\' => __DIR__ . '/edit/',
|
|
'MediaWiki\\EditPage\\' => __DIR__ . '/editpage/',
|
|
'MediaWiki\\Linker\\' => __DIR__ . '/linker/',
|
|
'MediaWiki\\Permissions\\' => __DIR__ . '/Permissions/',
|
|
'MediaWiki\\Preferences\\' => __DIR__ . '/preferences/',
|
|
'MediaWiki\\Rest\\' => __DIR__ . '/Rest/',
|
|
'MediaWiki\\Revision\\' => __DIR__ . '/Revision/',
|
|
'MediaWiki\\Session\\' => __DIR__ . '/session/',
|
|
'MediaWiki\\Shell\\' => __DIR__ . '/shell/',
|
|
'MediaWiki\\Sparql\\' => __DIR__ . '/sparql/',
|
|
'MediaWiki\\Storage\\' => __DIR__ . '/Storage/',
|
|
'MediaWiki\\Tidy\\' => __DIR__ . '/tidy/',
|
|
'Wikimedia\\ParamValidator\\' => __DIR__ . '/libs/ParamValidator/',
|
|
'Wikimedia\\Services\\' => __DIR__ . '/libs/services/',
|
|
];
|
|
}
|
|
}
|
|
|
|
AutoLoader::$psr4Namespaces = AutoLoader::getAutoloadNamespaces();
|
|
spl_autoload_register( [ 'AutoLoader', 'autoload' ] );
|