Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wiki.techinc.nl/maintenance/generateLocalAutoload.php

23 lines
672 B
PHP
Raw Normal View History

Generate $wgAutoloadLocalClasses with a maint script Currently all new classes in core need to be registered with the autoloader. This is acceptable but inconvenient. This patch adds a script to read the output of php's tokenizer to determine the names of all the classes within mediawiki core. Patches with new or removed classes will just need to rerun the maint script rather than manually adjusting the arrays. A full conversion to psr-0 + composer would solve this as well, but this is a very non-intrusive patch that can get us some portion of the benefit(reduced manual maintenance) today rather than months down the line once we figure out all the intricacies of mediawiki + composer. Change-Id: I8b1bdb84a9699de79f8b9951fa61e5437d083c55
2014-09-26 23:13:23 +00:00
<?php
Treat phpdbg as run from the command line when checking PHP_SAPI phpdbg is a gdb-style debugger for PHP that is run from the command line. However, it has a different PHP_SAPI value, so it was impossible to run maintenance scripts with it (until now). To avoid having to check both PHP_SAPI values in a bunch of places, introduce wfIsCLI() to easily check whether running from the command-line or not. We're (CI team) interested in generating code coverage with phpdbg instead of xdebug, hence this patch. Bug: T184043 Change-Id: Id1f994ca146d7858cd8bb6ab6cdbb7718ff524fb
2018-01-03 06:51:44 +00:00
if ( PHP_SAPI != 'cli' && PHP_SAPI != 'phpdbg' ) {
generateLocalAutoload.php: Abort for web requests The Maintenance class already does this, though this script does not use it for the obvious reason that when there is a missing or incorrect autoloader entry, it may not be possible to initialize MediaWiki. Hence it is necessary to do that explicitly in this script. Overwriting autoload.php potentially could disrupt the operation of a production wiki (the file is truncated when it is opened). Change-Id: I05d5d4b7c30c4643e71ca5819783627688e15da7
2014-11-14 22:27:16 +00:00
die( "This script can only be run from the command line.\n" );
}
Enable using PSR-4 autoloader for MediaWiki core and extensions This adds support for a PSR-4 (<http://www.php-fig.org/psr/psr-4/>) autoloader, so instead of needing to manually list each class, just the namespace prefix is needed. Extensions can set a "AutoloadNamespaces" property in extension.json to register PSR-4 compatible namespaces to be autoloaded. The implementation is based off of the example implementation (<http://www.php-fig.org/psr/psr-4/examples/>) with some modifications for performance, notably cutting down on function calls, and only trying to look up classes that are namespaced. The generateLocalAutoload.php script will ignore any directory that is registered as a PSR-4 namespace. Bug: T99865 Bug: T173799 Change-Id: Id095dde37cbb40aa424fb628bd3c94e684ca2f65
2017-08-24 18:05:26 +00:00
require_once __DIR__ . '/../includes/AutoLoader.php';
Generate $wgAutoloadLocalClasses with a maint script Currently all new classes in core need to be registered with the autoloader. This is acceptable but inconvenient. This patch adds a script to read the output of php's tokenizer to determine the names of all the classes within mediawiki core. Patches with new or removed classes will just need to rerun the maint script rather than manually adjusting the arrays. A full conversion to psr-0 + composer would solve this as well, but this is a very non-intrusive patch that can get us some portion of the benefit(reduced manual maintenance) today rather than months down the line once we figure out all the intricacies of mediawiki + composer. Change-Id: I8b1bdb84a9699de79f8b9951fa61e5437d083c55
2014-09-26 23:13:23 +00:00
require_once __DIR__ . '/../includes/utils/AutoloadGenerator.php';
// Mediawiki installation directory
$base = dirname( __DIR__ );
$generator = new AutoloadGenerator( $base, 'local' );
Enable using PSR-4 autoloader for MediaWiki core and extensions This adds support for a PSR-4 (<http://www.php-fig.org/psr/psr-4/>) autoloader, so instead of needing to manually list each class, just the namespace prefix is needed. Extensions can set a "AutoloadNamespaces" property in extension.json to register PSR-4 compatible namespaces to be autoloaded. The implementation is based off of the example implementation (<http://www.php-fig.org/psr/psr-4/examples/>) with some modifications for performance, notably cutting down on function calls, and only trying to look up classes that are namespaced. The generateLocalAutoload.php script will ignore any directory that is registered as a PSR-4 namespace. Bug: T99865 Bug: T173799 Change-Id: Id095dde37cbb40aa424fb628bd3c94e684ca2f65
2017-08-24 18:05:26 +00:00
$generator->setExcludePaths( array_values( AutoLoader::getAutoloadNamespaces() ) );
Structure test: Add autoload.php order check If a class is added manually to the autoload.php another run of the maintenance script will probably add unnecessary noise to another change. The added structure test checks, if the output of the maintenance script equals to the contents of the commited autoload.php. Bug: T121921 Change-Id: I3a426b92892f4c00cab33a13f6a717751120367c
2016-01-20 18:27:47 +00:00
$generator->initMediaWikiDefault();
Generate $wgAutoloadLocalClasses with a maint script Currently all new classes in core need to be registered with the autoloader. This is acceptable but inconvenient. This patch adds a script to read the output of php's tokenizer to determine the names of all the classes within mediawiki core. Patches with new or removed classes will just need to rerun the maint script rather than manually adjusting the arrays. A full conversion to psr-0 + composer would solve this as well, but this is a very non-intrusive patch that can get us some portion of the benefit(reduced manual maintenance) today rather than months down the line once we figure out all the intricacies of mediawiki + composer. Change-Id: I8b1bdb84a9699de79f8b9951fa61e5437d083c55
2014-09-26 23:13:23 +00:00
// Write out the autoload
Structure test: Add autoload.php order check If a class is added manually to the autoload.php another run of the maintenance script will probably add unnecessary noise to another change. The added structure test checks, if the output of the maintenance script equals to the contents of the commited autoload.php. Bug: T121921 Change-Id: I3a426b92892f4c00cab33a13f6a717751120367c
2016-01-20 18:27:47 +00:00
$fileinfo = $generator->getTargetFileinfo();
file_put_contents(
$fileinfo['filename'],
$generator->getAutoload( 'maintenance/generateLocalAutoload.php' )
);
Reference in a new issue Copy permalink