MediaWiki  master
AutoloadGenerator.php
Go to the documentation of this file.
1 <?php
35  const FILETYPE_JSON = 'json';
36  const FILETYPE_PHP = 'php';
37 
41  protected $basepath;
42 
46  protected $collector;
47 
51  protected $classes = [];
52 
56  protected $variableName = 'wgAutoloadClasses';
57 
61  protected $overrides = [];
62 
68  protected $excludePaths = [];
69 
75  protected $psr4Namespaces = [];
76 
84  public function __construct( $basepath, $flags = [] ) {
85  if ( !is_array( $flags ) ) {
86  $flags = [ $flags ];
87  }
88  $this->basepath = self::normalizePathSeparator( realpath( $basepath ) );
89  $this->collector = new ClassCollector;
90  if ( in_array( 'local', $flags ) ) {
91  $this->variableName = 'wgAutoloadLocalClasses';
92  }
93  }
94 
101  public function setExcludePaths( array $paths ) {
102  foreach ( $paths as $path ) {
103  $this->excludePaths[] = self::normalizePathSeparator( $path );
104  }
105  }
106 
116  public function setPsr4Namespaces( array $namespaces ) {
117  foreach ( $namespaces as $ns => $path ) {
118  $ns = rtrim( $ns, '\\' ) . '\\';
119  $this->psr4Namespaces[$ns] = rtrim( self::normalizePathSeparator( $path ), '/' );
120  }
121  }
122 
129  private function shouldExclude( $path ) {
130  foreach ( $this->excludePaths as $dir ) {
131  if ( strpos( $path, $dir ) === 0 ) {
132  return true;
133  }
134  }
135 
136  return false;
137  }
138 
147  public function forceClassPath( $fqcn, $inputPath ) {
148  $path = self::normalizePathSeparator( realpath( $inputPath ) );
149  if ( !$path ) {
150  throw new \Exception( "Invalid path: $inputPath" );
151  }
152  $len = strlen( $this->basepath );
153  if ( substr( $path, 0, $len ) !== $this->basepath ) {
154  throw new \Exception( "Path is not within basepath: $inputPath" );
155  }
156  $shortpath = substr( $path, $len );
157  $this->overrides[$fqcn] = $shortpath;
158  }
159 
164  public function readFile( $inputPath ) {
165  // NOTE: do NOT expand $inputPath using realpath(). It is perfectly
166  // reasonable for LocalSettings.php and similiar files to be symlinks
167  // to files that are outside of $this->basepath.
168  $inputPath = self::normalizePathSeparator( $inputPath );
169  $len = strlen( $this->basepath );
170  if ( substr( $inputPath, 0, $len ) !== $this->basepath ) {
171  throw new \Exception( "Path is not within basepath: $inputPath" );
172  }
173  if ( $this->shouldExclude( $inputPath ) ) {
174  return;
175  }
176  $result = $this->collector->getClasses(
177  file_get_contents( $inputPath )
178  );
179 
180  // Filter out classes that will be found by PSR4
181  $result = array_filter( $result, function ( $class ) use ( $inputPath ) {
182  $parts = explode( '\\', $class );
183  for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
184  $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
185  if ( isset( $this->psr4Namespaces[$ns] ) ) {
186  $expectedPath = $this->psr4Namespaces[$ns] . '/'
187  . implode( '/', array_slice( $parts, $i ) )
188  . '.php';
189  if ( $inputPath === $expectedPath ) {
190  return false;
191  }
192  }
193  }
194 
195  return true;
196  } );
197 
198  if ( $result ) {
199  $shortpath = substr( $inputPath, $len );
200  $this->classes[$shortpath] = $result;
201  }
202  }
203 
208  public function readDir( $dir ) {
209  $it = new RecursiveDirectoryIterator(
210  self::normalizePathSeparator( realpath( $dir ) ) );
211  $it = new RecursiveIteratorIterator( $it );
212 
213  foreach ( $it as $path => $file ) {
214  $ext = pathinfo( $path, PATHINFO_EXTENSION );
215  // some older files in mw use .inc
216  if ( $ext === 'php' || $ext === 'inc' ) {
217  $this->readFile( $path );
218  }
219  }
220  }
221 
230  protected function generateJsonAutoload( $filename ) {
231  $key = 'AutoloadClasses';
232  $json = FormatJson::decode( file_get_contents( $filename ), true );
233  unset( $json[$key] );
234  // Inverting the key-value pairs so that they become of the
235  // format class-name : path when they get converted into json.
236  foreach ( $this->classes as $path => $contained ) {
237  foreach ( $contained as $fqcn ) {
238  // Using substr to remove the leading '/'
239  $json[$key][$fqcn] = substr( $path, 1 );
240  }
241  }
242  foreach ( $this->overrides as $path => $fqcn ) {
243  // Using substr to remove the leading '/'
244  $json[$key][$fqcn] = substr( $path, 1 );
245  }
246 
247  // Sorting the list of autoload classes.
248  ksort( $json[$key] );
249 
250  // Return the whole JSON file
251  return FormatJson::encode( $json, "\t", FormatJson::ALL_OK ) . "\n";
252  }
253 
261  protected function generatePHPAutoload( $commandName, $filename ) {
262  // No existing JSON file found; update/generate PHP file
263  $content = [];
264 
265  // We need to generate a line each rather than exporting the
266  // full array so __DIR__ can be prepended to all the paths
267  $format = "%s => __DIR__ . %s,";
268  foreach ( $this->classes as $path => $contained ) {
269  $exportedPath = var_export( $path, true );
270  foreach ( $contained as $fqcn ) {
271  $content[$fqcn] = sprintf(
272  $format,
273  var_export( $fqcn, true ),
274  $exportedPath
275  );
276  }
277  }
278 
279  foreach ( $this->overrides as $fqcn => $path ) {
280  $content[$fqcn] = sprintf(
281  $format,
282  var_export( $fqcn, true ),
283  var_export( $path, true )
284  );
285  }
286 
287  // sort for stable output
288  ksort( $content );
289 
290  // extensions using this generator are appending to the existing
291  // autoload.
292  if ( $this->variableName === 'wgAutoloadClasses' ) {
293  $op = '+=';
294  } else {
295  $op = '=';
296  }
297 
298  $output = implode( "\n\t", $content );
299  return <<<EOD
300 <?php
301 // This file is generated by $commandName, do not adjust manually
302 // phpcs:disable Generic.Files.LineLength
303 global \${$this->variableName};
304 
305 \${$this->variableName} {$op} [
306  {$output}
307 ];
308 
309 EOD;
310  }
311 
320  public function getAutoload( $commandName = 'AutoloadGenerator' ) {
321  // We need to check whether an extension.json or skin.json exists or not, and
322  // incase it doesn't, update the autoload.php file.
323 
324  $fileinfo = $this->getTargetFileinfo();
325 
326  if ( $fileinfo['type'] === self::FILETYPE_JSON ) {
327  return $this->generateJsonAutoload( $fileinfo['filename'] );
328  } else {
329  return $this->generatePHPAutoload( $commandName, $fileinfo['filename'] );
330  }
331  }
332 
341  public function getTargetFileinfo() {
342  $fileinfo = [
343  'filename' => $this->basepath . '/autoload.php',
344  'type' => self::FILETYPE_PHP
345  ];
346  if ( file_exists( $this->basepath . '/extension.json' ) ) {
347  $fileinfo = [
348  'filename' => $this->basepath . '/extension.json',
349  'type' => self::FILETYPE_JSON
350  ];
351  } elseif ( file_exists( $this->basepath . '/skin.json' ) ) {
352  $fileinfo = [
353  'filename' => $this->basepath . '/skin.json',
354  'type' => self::FILETYPE_JSON
355  ];
356  }
357 
358  return $fileinfo;
359  }
360 
367  protected static function normalizePathSeparator( $path ) {
368  return str_replace( '\\', '/', $path );
369  }
370 
380  public function initMediaWikiDefault() {
381  foreach ( [ 'includes', 'languages', 'maintenance', 'mw-config' ] as $dir ) {
382  $this->readDir( $this->basepath . '/' . $dir );
383  }
384  foreach ( glob( $this->basepath . '/*.php' ) as $file ) {
385  $this->readFile( $file );
386  }
387  }
388 }
initMediaWikiDefault()
Initialize the source files and directories which are used for the MediaWiki default autoloader in {m...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
Reads PHP code and returns the FQCN of every class defined within it.
setPsr4Namespaces(array $namespaces)
Set PSR4 namespaces.
const ALL_OK
Skip escaping as many characters as reasonably possible.
Definition: FormatJson.php:55
string $variableName
The global variable to write output to.
forceClassPath( $fqcn, $inputPath)
Force a class to be autoloaded from a specific path, regardless of where or if it was detected...
static encode( $value, $pretty=false, $escaping=0)
Returns the JSON representation of a value.
Definition: FormatJson.php:115
setExcludePaths(array $paths)
Directories that should be excluded.
array $classes
Map of file shortpath to list of FQCN detected within file.
__construct( $basepath, $flags=[])
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:2204
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=(\*-\*)") 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. '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 '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:1969
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)
shouldExclude( $path)
Whether the file should be excluded.
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:174
string [] $psr4Namespaces
Configured PSR4 namespaces.
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:912
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
string [] $excludePaths
Directories that should be excluded.
getTargetFileinfo()
Returns the filename of the extension.json of skin.json, if there&#39;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.
generatePHPAutoload( $commandName, $filename)
Generates a PHP file setting up autoload information.
Accepts a list of files and directories to search for php files and generates $wgAutoloadLocalClasses...
if(!is_readable( $file)) $ext
Definition: router.php:48
generateJsonAutoload( $filename)
Updates the AutoloadClasses field at the given filename.
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:960
getAutoload( $commandName='AutoloadGenerator')
Returns all known classes as a string, which can be used to put into a target file (e...
$content
Definition: pageupdater.txt:72
ClassCollector $collector
Helper class extracts class names from php files.