MediaWiki REL1_32
AutoloadGenerator.php
Go to the documentation of this file.
1<?php
2
17 const FILETYPE_JSON = 'json';
18 const FILETYPE_PHP = 'php';
19
23 protected $basepath;
24
28 protected $collector;
29
33 protected $classes = [];
34
38 protected $variableName = 'wgAutoloadClasses';
39
43 protected $overrides = [];
44
50 protected $excludePaths = [];
51
57 protected $psr4Namespaces = [];
58
66 public function __construct( $basepath, $flags = [] ) {
67 if ( !is_array( $flags ) ) {
68 $flags = [ $flags ];
69 }
70 $this->basepath = self::normalizePathSeparator( realpath( $basepath ) );
71 $this->collector = new ClassCollector;
72 if ( in_array( 'local', $flags ) ) {
73 $this->variableName = 'wgAutoloadLocalClasses';
74 }
75 }
76
83 public function setExcludePaths( array $paths ) {
84 foreach ( $paths as $path ) {
85 $this->excludePaths[] = self::normalizePathSeparator( $path );
86 }
87 }
88
98 public function setPsr4Namespaces( array $namespaces ) {
99 foreach ( $namespaces as $ns => $path ) {
100 $ns = rtrim( $ns, '\\' ) . '\\';
101 $this->psr4Namespaces[$ns] = rtrim( self::normalizePathSeparator( $path ), '/' );
102 }
103 }
104
111 private function shouldExclude( $path ) {
112 foreach ( $this->excludePaths as $dir ) {
113 if ( strpos( $path, $dir ) === 0 ) {
114 return true;
115 }
116 }
117
118 return false;
119 }
120
129 public function forceClassPath( $fqcn, $inputPath ) {
130 $path = self::normalizePathSeparator( realpath( $inputPath ) );
131 if ( !$path ) {
132 throw new \Exception( "Invalid path: $inputPath" );
133 }
134 $len = strlen( $this->basepath );
135 if ( substr( $path, 0, $len ) !== $this->basepath ) {
136 throw new \Exception( "Path is not within basepath: $inputPath" );
137 }
138 $shortpath = substr( $path, $len );
139 $this->overrides[$fqcn] = $shortpath;
140 }
141
146 public function readFile( $inputPath ) {
147 // NOTE: do NOT expand $inputPath using realpath(). It is perfectly
148 // reasonable for LocalSettings.php and similiar files to be symlinks
149 // to files that are outside of $this->basepath.
150 $inputPath = self::normalizePathSeparator( $inputPath );
151 $len = strlen( $this->basepath );
152 if ( substr( $inputPath, 0, $len ) !== $this->basepath ) {
153 throw new \Exception( "Path is not within basepath: $inputPath" );
154 }
155 if ( $this->shouldExclude( $inputPath ) ) {
156 return;
157 }
158 $result = $this->collector->getClasses(
159 file_get_contents( $inputPath )
160 );
161
162 // Filter out classes that will be found by PSR4
163 $result = array_filter( $result, function ( $class ) use ( $inputPath ) {
164 $parts = explode( '\\', $class );
165 for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
166 $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
167 if ( isset( $this->psr4Namespaces[$ns] ) ) {
168 $expectedPath = $this->psr4Namespaces[$ns] . '/'
169 . implode( '/', array_slice( $parts, $i ) )
170 . '.php';
171 if ( $inputPath === $expectedPath ) {
172 return false;
173 }
174 }
175 }
176
177 return true;
178 } );
179
180 if ( $result ) {
181 $shortpath = substr( $inputPath, $len );
182 $this->classes[$shortpath] = $result;
183 }
184 }
185
190 public function readDir( $dir ) {
191 $it = new RecursiveDirectoryIterator(
192 self::normalizePathSeparator( realpath( $dir ) ) );
193 $it = new RecursiveIteratorIterator( $it );
194
195 foreach ( $it as $path => $file ) {
196 $ext = pathinfo( $path, PATHINFO_EXTENSION );
197 // some older files in mw use .inc
198 if ( $ext === 'php' || $ext === 'inc' ) {
199 $this->readFile( $path );
200 }
201 }
202 }
203
212 protected function generateJsonAutoload( $filename ) {
213 $key = 'AutoloadClasses';
214 $json = FormatJson::decode( file_get_contents( $filename ), true );
215 unset( $json[$key] );
216 // Inverting the key-value pairs so that they become of the
217 // format class-name : path when they get converted into json.
218 foreach ( $this->classes as $path => $contained ) {
219 foreach ( $contained as $fqcn ) {
220 // Using substr to remove the leading '/'
221 $json[$key][$fqcn] = substr( $path, 1 );
222 }
223 }
224 foreach ( $this->overrides as $path => $fqcn ) {
225 // Using substr to remove the leading '/'
226 $json[$key][$fqcn] = substr( $path, 1 );
227 }
228
229 // Sorting the list of autoload classes.
230 ksort( $json[$key] );
231
232 // Return the whole JSON file
233 return FormatJson::encode( $json, "\t", FormatJson::ALL_OK ) . "\n";
234 }
235
243 protected function generatePHPAutoload( $commandName, $filename ) {
244 // No existing JSON file found; update/generate PHP file
245 $content = [];
246
247 // We need to generate a line each rather than exporting the
248 // full array so __DIR__ can be prepended to all the paths
249 $format = "%s => __DIR__ . %s,";
250 foreach ( $this->classes as $path => $contained ) {
251 $exportedPath = var_export( $path, true );
252 foreach ( $contained as $fqcn ) {
253 $content[$fqcn] = sprintf(
254 $format,
255 var_export( $fqcn, true ),
256 $exportedPath
257 );
258 }
259 }
260
261 foreach ( $this->overrides as $fqcn => $path ) {
262 $content[$fqcn] = sprintf(
263 $format,
264 var_export( $fqcn, true ),
265 var_export( $path, true )
266 );
267 }
268
269 // sort for stable output
270 ksort( $content );
271
272 // extensions using this generator are appending to the existing
273 // autoload.
274 if ( $this->variableName === 'wgAutoloadClasses' ) {
275 $op = '+=';
276 } else {
277 $op = '=';
278 }
279
280 $output = implode( "\n\t", $content );
281 return <<<EOD
282<?php
283// This file is generated by $commandName, do not adjust manually
284// phpcs:disable Generic.Files.LineLength
285global \${$this->variableName};
286
287\${$this->variableName} {$op} [
288 {$output}
289];
290
291EOD;
292 }
293
302 public function getAutoload( $commandName = 'AutoloadGenerator' ) {
303 // We need to check whether an extension.json or skin.json exists or not, and
304 // incase it doesn't, update the autoload.php file.
305
306 $fileinfo = $this->getTargetFileinfo();
307
308 if ( $fileinfo['type'] === self::FILETYPE_JSON ) {
309 return $this->generateJsonAutoload( $fileinfo['filename'] );
310 } else {
311 return $this->generatePHPAutoload( $commandName, $fileinfo['filename'] );
312 }
313 }
314
323 public function getTargetFileinfo() {
324 $fileinfo = [
325 'filename' => $this->basepath . '/autoload.php',
326 'type' => self::FILETYPE_PHP
327 ];
328 if ( file_exists( $this->basepath . '/extension.json' ) ) {
329 $fileinfo = [
330 'filename' => $this->basepath . '/extension.json',
331 'type' => self::FILETYPE_JSON
332 ];
333 } elseif ( file_exists( $this->basepath . '/skin.json' ) ) {
334 $fileinfo = [
335 'filename' => $this->basepath . '/skin.json',
336 'type' => self::FILETYPE_JSON
337 ];
338 }
339
340 return $fileinfo;
341 }
342
349 protected static function normalizePathSeparator( $path ) {
350 return str_replace( '\\', '/', $path );
351 }
352
362 public function initMediaWikiDefault() {
363 foreach ( [ 'includes', 'languages', 'maintenance', 'mw-config' ] as $dir ) {
364 $this->readDir( $this->basepath . '/' . $dir );
365 }
366 foreach ( glob( $this->basepath . '/*.php' ) as $file ) {
367 $this->readFile( $file );
368 }
369 }
370}
371
376
380 protected $namespace = '';
381
385 protected $classes;
386
390 protected $startToken;
391
395 protected $tokens;
396
400 protected $alias;
401
406 public function getClasses( $code ) {
407 $this->namespace = '';
408 $this->classes = [];
409 $this->startToken = null;
410 $this->alias = null;
411 $this->tokens = [];
412
413 foreach ( token_get_all( $code ) as $token ) {
414 if ( $this->startToken === null ) {
415 $this->tryBeginExpect( $token );
416 } else {
417 $this->tryEndExpect( $token );
418 }
419 }
420
421 return $this->classes;
422 }
423
429 protected function tryBeginExpect( $token ) {
430 if ( is_string( $token ) ) {
431 return;
432 }
433 // Note: When changing class name discovery logic,
434 // AutoLoaderStructureTest.php may also need to be updated.
435 switch ( $token[0] ) {
436 case T_NAMESPACE:
437 case T_CLASS:
438 case T_INTERFACE:
439 case T_TRAIT:
440 case T_DOUBLE_COLON:
441 case T_NEW:
442 $this->startToken = $token;
443 break;
444 case T_STRING:
445 if ( $token[1] === 'class_alias' ) {
446 $this->startToken = $token;
447 $this->alias = [];
448 }
449 }
450 }
451
457 protected function tryEndExpect( $token ) {
458 switch ( $this->startToken[0] ) {
459 case T_DOUBLE_COLON:
460 // Skip over T_CLASS after T_DOUBLE_COLON because this is something like
461 // "self::static" which accesses the class name. It doens't define a new class.
462 $this->startToken = null;
463 break;
464 case T_NEW:
465 // Skip over T_CLASS after T_NEW because this is a PHP 7 anonymous class.
466 if ( !is_array( $token ) || $token[0] !== T_WHITESPACE ) {
467 $this->startToken = null;
468 }
469 break;
470 case T_NAMESPACE:
471 if ( $token === ';' || $token === '{' ) {
472 $this->namespace = $this->implodeTokens() . '\\';
473 } else {
474 $this->tokens[] = $token;
475 }
476 break;
477
478 case T_STRING:
479 if ( $this->alias !== null ) {
480 // Flow 1 - Two string literals:
481 // - T_STRING class_alias
482 // - '('
483 // - T_CONSTANT_ENCAPSED_STRING 'TargetClass'
484 // - ','
485 // - T_WHITESPACE
486 // - T_CONSTANT_ENCAPSED_STRING 'AliasName'
487 // - ')'
488 // Flow 2 - Use of ::class syntax for first parameter
489 // - T_STRING class_alias
490 // - '('
491 // - T_STRING TargetClass
492 // - T_DOUBLE_COLON ::
493 // - T_CLASS class
494 // - ','
495 // - T_WHITESPACE
496 // - T_CONSTANT_ENCAPSED_STRING 'AliasName'
497 // - ')'
498 if ( $token === '(' ) {
499 // Start of a function call to class_alias()
500 $this->alias = [ 'target' => false, 'name' => false ];
501 } elseif ( $token === ',' ) {
502 // Record that we're past the first parameter
503 if ( $this->alias['target'] === false ) {
504 $this->alias['target'] = true;
505 }
506 } elseif ( is_array( $token ) && $token[0] === T_CONSTANT_ENCAPSED_STRING ) {
507 if ( $this->alias['target'] === true ) {
508 // We already saw a first argument, this must be the second.
509 // Strip quotes from the string literal.
510 $this->alias['name'] = substr( $token[1], 1, -1 );
511 }
512 } elseif ( $token === ')' ) {
513 // End of function call
514 $this->classes[] = $this->alias['name'];
515 $this->alias = null;
516 $this->startToken = null;
517 } elseif ( !is_array( $token ) || (
518 $token[0] !== T_STRING &&
519 $token[0] !== T_DOUBLE_COLON &&
520 $token[0] !== T_CLASS &&
521 $token[0] !== T_WHITESPACE
522 ) ) {
523 // Ignore this call to class_alias() - compat/Timestamp.php
524 $this->alias = null;
525 $this->startToken = null;
526 }
527 }
528 break;
529
530 case T_CLASS:
531 case T_INTERFACE:
532 case T_TRAIT:
533 $this->tokens[] = $token;
534 if ( is_array( $token ) && $token[0] === T_STRING ) {
535 $this->classes[] = $this->namespace . $this->implodeTokens();
536 }
537 }
538 }
539
546 protected function implodeTokens() {
547 $content = [];
548 foreach ( $this->tokens as $token ) {
549 $content[] = is_string( $token ) ? $token : $token[1];
550 }
551
552 $this->tokens = [];
553 $this->startToken = null;
554
555 return trim( implode( '', $content ), " \n\t" );
556 }
557}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Accepts a list of files and directories to search for php files and generates $wgAutoloadLocalClasses...
shouldExclude( $path)
Whether the file should be excluded.
string $basepath
Root path of the project being scanned for classes.
setExcludePaths(array $paths)
Directories that should be excluded.
getTargetFileinfo()
Returns the filename of the extension.json of skin.json, if there's any, or otherwise the path to the...
generateJsonAutoload( $filename)
Updates the AutoloadClasses field at the given filename.
string[] $psr4Namespaces
Configured PSR4 namespaces.
__construct( $basepath, $flags=[])
getAutoload( $commandName='AutoloadGenerator')
Returns all known classes as a string, which can be used to put into a target file (e....
forceClassPath( $fqcn, $inputPath)
Force a class to be autoloaded from a specific path, regardless of where or if it was detected.
array $classes
Map of file shortpath to list of FQCN detected within file.
generatePHPAutoload( $commandName, $filename)
Generates a PHP file setting up autoload information.
string $variableName
The global variable to write output to.
initMediaWikiDefault()
Initialize the source files and directories which are used for the MediaWiki default autoloader in {m...
setPsr4Namespaces(array $namespaces)
Set PSR4 namespaces.
ClassCollector $collector
Helper class extracts class names from php files.
string[] $excludePaths
Directories that should be excluded.
static normalizePathSeparator( $path)
Ensure that Unix-style path separators ("/") are used in the path.
array $overrides
Map of FQCN to relative path(from self::$basepath)
Reads PHP code and returns the FQCN of every class defined within it.
implodeTokens()
Returns the string representation of the tokens within the current expect sequence and resets the seq...
string $namespace
Current namespace.
array $classes
List of FQCN detected in this pass.
tryEndExpect( $token)
Accepts the next token in an expect sequence.
array $startToken
Token from token_get_all() that started an expect sequence.
tryBeginExpect( $token)
Determine if $token begins the next expect sequence.
array $alias
Class alias with target/name fields.
array $tokens
List of tokens that are members of the current expect sequence.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED since 1.16! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:2042
namespace and then decline to actually register it & $namespaces
Definition hooks.txt:964
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:895
this hook is for auditing only RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those classes
Definition hooks.txt:1022
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition hooks.txt:2317
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$content
if(!is_readable( $file)) $ext
Definition router.php:55