MediaWiki  1.28.0
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 
52  public function __construct( $basepath, $flags = [] ) {
53  if ( !is_array( $flags ) ) {
54  $flags = [ $flags ];
55  }
56  $this->basepath = self::normalizePathSeparator( realpath( $basepath ) );
57  $this->collector = new ClassCollector;
58  if ( in_array( 'local', $flags ) ) {
59  $this->variableName = 'wgAutoloadLocalClasses';
60  }
61  }
62 
71  public function forceClassPath( $fqcn, $inputPath ) {
72  $path = self::normalizePathSeparator( realpath( $inputPath ) );
73  if ( !$path ) {
74  throw new \Exception( "Invalid path: $inputPath" );
75  }
76  $len = strlen( $this->basepath );
77  if ( substr( $path, 0, $len ) !== $this->basepath ) {
78  throw new \Exception( "Path is not within basepath: $inputPath" );
79  }
80  $shortpath = substr( $path, $len );
81  $this->overrides[$fqcn] = $shortpath;
82  }
83 
88  public function readFile( $inputPath ) {
89  // NOTE: do NOT expand $inputPath using realpath(). It is perfectly
90  // reasonable for LocalSettings.php and similiar files to be symlinks
91  // to files that are outside of $this->basepath.
92  $inputPath = self::normalizePathSeparator( $inputPath );
93  $len = strlen( $this->basepath );
94  if ( substr( $inputPath, 0, $len ) !== $this->basepath ) {
95  throw new \Exception( "Path is not within basepath: $inputPath" );
96  }
97  $result = $this->collector->getClasses(
98  file_get_contents( $inputPath )
99  );
100  if ( $result ) {
101  $shortpath = substr( $inputPath, $len );
102  $this->classes[$shortpath] = $result;
103  }
104  }
105 
110  public function readDir( $dir ) {
111  $it = new RecursiveDirectoryIterator(
112  self::normalizePathSeparator( realpath( $dir ) ) );
113  $it = new RecursiveIteratorIterator( $it );
114 
115  foreach ( $it as $path => $file ) {
116  $ext = pathinfo( $path, PATHINFO_EXTENSION );
117  // some older files in mw use .inc
118  if ( $ext === 'php' || $ext === 'inc' ) {
119  $this->readFile( $path );
120  }
121  }
122  }
123 
132  protected function generateJsonAutoload( $filename ) {
133  $key = 'AutoloadClasses';
134  $json = FormatJson::decode( file_get_contents( $filename ), true );
135  unset( $json[$key] );
136  // Inverting the key-value pairs so that they become of the
137  // format class-name : path when they get converted into json.
138  foreach ( $this->classes as $path => $contained ) {
139  foreach ( $contained as $fqcn ) {
140 
141  // Using substr to remove the leading '/'
142  $json[$key][$fqcn] = substr( $path, 1 );
143  }
144  }
145  foreach ( $this->overrides as $path => $fqcn ) {
146 
147  // Using substr to remove the leading '/'
148  $json[$key][$fqcn] = substr( $path, 1 );
149  }
150 
151  // Sorting the list of autoload classes.
152  ksort( $json[$key] );
153 
154  // Return the whole JSON file
155  return FormatJson::encode( $json, true ) . "\n";
156  }
157 
165  protected function generatePHPAutoload( $commandName, $filename ) {
166  // No existing JSON file found; update/generate PHP file
167  $content = [];
168 
169  // We need to generate a line each rather than exporting the
170  // full array so __DIR__ can be prepended to all the paths
171  $format = "%s => __DIR__ . %s,";
172  foreach ( $this->classes as $path => $contained ) {
173  $exportedPath = var_export( $path, true );
174  foreach ( $contained as $fqcn ) {
175  $content[$fqcn] = sprintf(
176  $format,
177  var_export( $fqcn, true ),
178  $exportedPath
179  );
180  }
181  }
182 
183  foreach ( $this->overrides as $fqcn => $path ) {
184  $content[$fqcn] = sprintf(
185  $format,
186  var_export( $fqcn, true ),
187  var_export( $path, true )
188  );
189  }
190 
191  // sort for stable output
192  ksort( $content );
193 
194  // extensions using this generator are appending to the existing
195  // autoload.
196  if ( $this->variableName === 'wgAutoloadClasses' ) {
197  $op = '+=';
198  } else {
199  $op = '=';
200  }
201 
202  $output = implode( "\n\t", $content );
203  return
204  <<<EOD
205 <?php
206 // This file is generated by $commandName, do not adjust manually
207 // @codingStandardsIgnoreFile
208 global \${$this->variableName};
209 
210 \${$this->variableName} {$op} [
211  {$output}
212 ];
213 
214 EOD;
215 
216  }
217 
226  public function getAutoload( $commandName = 'AutoloadGenerator' ) {
227 
228  // We need to check whether an extenson.json or skin.json exists or not, and
229  // incase it doesn't, update the autoload.php file.
230 
231  $fileinfo = $this->getTargetFileinfo();
232 
233  if ( $fileinfo['type'] === self::FILETYPE_JSON ) {
234  return $this->generateJsonAutoload( $fileinfo['filename'] );
235  } else {
236  return $this->generatePHPAutoload( $commandName, $fileinfo['filename'] );
237  }
238  }
239 
248  public function getTargetFileinfo() {
249  $fileinfo = [
250  'filename' => $this->basepath . '/autoload.php',
251  'type' => self::FILETYPE_PHP
252  ];
253  if ( file_exists( $this->basepath . '/extension.json' ) ) {
254  $fileinfo = [
255  'filename' => $this->basepath . '/extension.json',
256  'type' => self::FILETYPE_JSON
257  ];
258  } elseif ( file_exists( $this->basepath . '/skin.json' ) ) {
259  $fileinfo = [
260  'filename' => $this->basepath . '/skin.json',
261  'type' => self::FILETYPE_JSON
262  ];
263  }
264 
265  return $fileinfo;
266  }
267 
274  protected static function normalizePathSeparator( $path ) {
275  return str_replace( '\\', '/', $path );
276  }
277 
287  public function initMediaWikiDefault() {
288  foreach ( [ 'includes', 'languages', 'maintenance', 'mw-config' ] as $dir ) {
289  $this->readDir( $this->basepath . '/' . $dir );
290  }
291  foreach ( glob( $this->basepath . '/*.php' ) as $file ) {
292  $this->readFile( $file );
293  }
295  // Legacy aliases
296  $this->forceClassPath( 'DatabaseBase',
297  $this->basepath . '/includes/libs/rdbms/database/Database.php' );
298  }
299 }
300 
305 
309  protected $namespace = '';
310 
314  protected $classes;
315 
319  protected $startToken;
324  protected $tokens;
325 
330  public function getClasses( $code ) {
331  $this->namespace = '';
332  $this->classes = [];
333  $this->startToken = null;
334  $this->tokens = [];
335 
336  foreach ( token_get_all( $code ) as $token ) {
337  if ( $this->startToken === null ) {
338  $this->tryBeginExpect( $token );
339  } else {
340  $this->tryEndExpect( $token );
341  }
342  }
343 
344  return $this->classes;
345  }
346 
352  protected function tryBeginExpect( $token ) {
353  if ( is_string( $token ) ) {
354  return;
355  }
356  switch ( $token[0] ) {
357  case T_NAMESPACE:
358  case T_CLASS:
359  case T_INTERFACE:
360  case T_TRAIT:
361  case T_DOUBLE_COLON:
362  $this->startToken = $token;
363  }
364  }
365 
371  protected function tryEndExpect( $token ) {
372  switch ( $this->startToken[0] ) {
373  case T_DOUBLE_COLON:
374  // Skip over T_CLASS after T_DOUBLE_COLON because this is something like
375  // "self::static" which accesses the class name. It doens't define a new class.
376  $this->startToken = null;
377  break;
378  case T_NAMESPACE:
379  if ( $token === ';' || $token === '{' ) {
380  $this->namespace = $this->implodeTokens() . '\\';
381  } else {
382  $this->tokens[] = $token;
383  }
384  break;
385 
386  case T_CLASS:
387  case T_INTERFACE:
388  case T_TRAIT:
389  $this->tokens[] = $token;
390  if ( is_array( $token ) && $token[0] === T_STRING ) {
391  $this->classes[] = $this->namespace . $this->implodeTokens();
392  }
393  }
394  }
395 
402  protected function implodeTokens() {
403  $content = [];
404  foreach ( $this->tokens as $token ) {
405  $content[] = is_string( $token ) ? $token : $token[1];
406  }
407 
408  $this->tokens = [];
409  $this->startToken = null;
410 
411  return trim( implode( '', $content ), " \n\t" );
412  }
413 }
initMediaWikiDefault()
Initialize the source files and directories which are used for the MediaWiki default autoloader in {m...
if(count($args)==0) $dir
array $tokens
List of tokens that are members of the current expect sequence.
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php For a description of the classes
Definition: globals.txt:25
Reads PHP code and returns the FQCN of every class defined within it.
string $variableName
The global variable to write output to.
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
array $startToken
Token from token_get_all() that started an expect sequence.
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. '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 '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!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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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:1934
array $overrides
Map of FQCN to relative path(from self::$basepath)
array $classes
List of FQCN detected in this pass.
__construct($basepath, $flags=[])
generateJsonAutoload($filename)
Updates the AutoloadClasses field at the given filename.
static encode($value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:127
implodeTokens()
Returns the string representation of the tokens within the current expect sequence and resets the seq...
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
Definition: distributors.txt:9
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:802
static normalizePathSeparator($path)
Ensure that Unix-style path separators ("/") are used in the path.
generatePHPAutoload($commandName, $filename)
Generates a PHP file setting up autoload information.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object & $output
Definition: hooks.txt:1046
getTargetFileinfo()
Returns the filename of the extension.json of skin.json, if there's any, or otherwise the path to the...
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:35
string $basepath
Root path of the project being scanned for classes.
forceClassPath($fqcn, $inputPath)
Force a class to be autoloaded from a specific path, regardless of where or if it was detected...
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1046
Accepts a list of files and directories to search for php files and generates $wgAutoloadLocalClasses...
getAutoload($commandName= 'AutoloadGenerator')
Returns all known classes as a string, which can be used to put into a target file (e...
tryEndExpect($token)
Accepts the next token in an expect sequence.
tryBeginExpect($token)
Determine if $token begins the next expect sequence.
static decode($value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:187
ClassCollector $collector
Helper class extracts class names from php files.