includes/utils/AutoloadGenerator.php

   1 <?php
   2
   3 /**
   4  * Accepts a list of files and directories to search for
   5  * php files and generates $wgAutoloadLocalClasses or $wgAutoloadClasses
   6  * lines for all detected classes. These lines are written out
   7  * to an autoload.php file in the projects provided basedir.
   8  *
   9  * Usage:
  10  *
  11  *     $gen = new AutoloadGenerator( __DIR__ );
  12  *     $gen->readDir( __DIR__ . '/includes' );
  13  *     $gen->readFile( __DIR__ . '/foo.php' )
  14  *     $gen->generateAutoload();
  15  */
  16 class AutoloadGenerator {
  17         /**
  18          * @var string Root path of the project being scanned for classes
  19          */
  20         protected $basepath;
  21
  22         /**
  23          * @var ClassCollector Helper class extracts class names from php files
  24          */
  25         protected $collector;
  26
  27         /**
  28          * @var array Map of file shortpath to list of FQCN detected within file
  29          */
  30         protected $classes = array();
  31
  32         /**
  33          * @var string The global variable to write output to
  34          */
  35         protected $variableName = 'wgAutoloadClasses';
  36
  37         /**
  38          * @var array Map of FQCN to relative path(from self::$basepath)
  39          */
  40         protected $overrides = array();
  41
  42         /**
  43          * @param string $basepath Root path of the project being scanned for classes
  44          * @param array|string $flags
  45          *
  46          *  local - If this flag is set $wgAutoloadLocalClasses will be build instead
  47          *          of $wgAutoloadClasses
  48          */
  49         public function __construct( $basepath, $flags = array() ) {
  50                 if ( !is_array( $flags ) ) {
  51                         $flags = array( $flags );
  52                 }
  53                 $this->basepath = self::normalizePathSeparator( realpath( $basepath ) );
  54                 $this->collector = new ClassCollector;
  55                 if ( in_array( 'local', $flags ) ) {
  56                         $this->variableName = 'wgAutoloadLocalClasses';
  57                 }
  58         }
  59
  60         /**
  61          * Force a class to be autoloaded from a specific path, regardless of where
  62          * or if it was detected.
  63          *
  64          * @param string $fqcn FQCN to force the location of
  65          * @param string $inputPath Full path to the file containing the class
  66          */
  67         public function forceClassPath( $fqcn, $inputPath ) {
  68                 $path = self::normalizePathSeparator( realpath( $inputPath ) );
  69                 if ( !$path ) {
  70                         throw new \Exception( "Invalid path: $inputPath" );
  71                 }
  72                 $len = strlen( $this->basepath );
  73                 if ( substr( $path, 0, $len ) !== $this->basepath ) {
  74                         throw new \Exception( "Path is not within basepath: $inputPath" );
  75                 }
  76                 $shortpath = substr( $path, $len );
  77                 $this->overrides[$fqcn] = $shortpath;
  78         }
  79
  80         /**
  81          * @param string $inputPath Path to a php file to find classes within
  82          */
  83         public function readFile( $inputPath ) {
  84                 // NOTE: do NOT expand $inputPath using realpath(). It is perfectly
  85                 // reasonable for LocalSettings.php and similiar files to be symlinks
  86                 // to files that are outside of $this->basepath.
  87                 $inputPath = self::normalizePathSeparator( $inputPath );
  88                 $len = strlen( $this->basepath );
  89                 if ( substr( $inputPath, 0, $len ) !== $this->basepath ) {
  90                         throw new \Exception( "Path is not within basepath: $inputPath" );
  91                 }
  92                 $result = $this->collector->getClasses(
  93                         file_get_contents( $inputPath )
  94                 );
  95                 if ( $result ) {
  96                         $shortpath = substr( $inputPath, $len );
  97                         $this->classes[$shortpath] = $result;
  98                 }
  99         }
 100
 101         /**
 102          * @param string $dir Path to a directory to recursively search
 103          *  for php files with either .php or .inc extensions
 104          */
 105         public function readDir( $dir ) {
 106                 $it = new RecursiveDirectoryIterator(
 107                         self::normalizePathSeparator( realpath( $dir ) ) );
 108                 $it = new RecursiveIteratorIterator( $it );
 109
 110                 foreach ( $it as $path => $file ) {
 111                         $ext = pathinfo( $path, PATHINFO_EXTENSION );
 112                         // some older files in mw use .inc
 113                         if ( $ext === 'php' || $ext === 'inc' ) {
 114                                 $this->readFile( $path );
 115                         }
 116                 }
 117         }
 118
 119         /**
 120          * Write out all known classes to autoload.php in
 121          * the provided basedir
 122          *
 123          * @param string $commandName Value used in file comment to direct
 124          *  developers towards the appropriate way to update the autoload.
 125          */
 126         public function generateAutoload( $commandName = 'AutoloadGenerator' ) {
 127                 $content = array();
 128
 129                 // We need to generate a line each rather than exporting the
 130                 // full array so __DIR__ can be prepended to all the paths
 131                 $format = "%s => __DIR__ . %s,";
 132                 foreach ( $this->classes as $path => $contained ) {
 133                         $exportedPath = var_export( $path, true );
 134                         foreach ( $contained as $fqcn ) {
 135                                 $content[$fqcn] = sprintf(
 136                                         $format,
 137                                         var_export( $fqcn, true ),
 138                                         $exportedPath
 139                                 );
 140                         }
 141                 }
 142
 143                 foreach ( $this->overrides as $fqcn => $path ) {
 144                         $content[$fqcn] = sprintf(
 145                                 $format,
 146                                 var_export( $fqcn, true ),
 147                                 var_export( $path, true )
 148                         );
 149                 }
 150
 151                 // sort for stable output
 152                 ksort( $content );
 153
 154                 // extensions using this generator are appending to the existing
 155                 // autoload.
 156                 if ( $this->variableName === 'wgAutoloadClasses' ) {
 157                         $op = '+=';
 158                 } else {
 159                         $op = '=';
 160                 }
 161
 162                 $output = implode( "\n\t", $content );
 163                 file_put_contents(
 164                         $this->basepath . '/autoload.php',
 165                         <<<EOD
 166 <?php
 167 // This file is generated by $commandName, do not adjust manually
 168
 169 global \${$this->variableName};
 170
 171 \${$this->variableName} {$op} array(
 172         {$output}
 173 );
 174
 175 EOD
 176                 );
 177         }
 178
 179         /**
 180          * Ensure that Unix-style path separators ("/") are used in the path.
 181          *
 182          * @param string $path
 183          * @return string
 184          */
 185         protected static function normalizePathSeparator( $path ) {
 186                 return str_replace( '\\', '/', $path );
 187         }
 188 }
 189
 190 /**
 191  * Reads PHP code and returns the FQCN of every class defined within it.
 192  */
 193 class ClassCollector {
 194
 195         /**
 196          * @var string Current namespace
 197          */
 198         protected $namespace = '';
 199
 200         /**
 201          * @var array List of FQCN detected in this pass
 202          */
 203         protected $classes;
 204
 205         /**
 206          * @var array Token from token_get_all() that started an expect sequence
 207          */
 208         protected $startToken;
 209
 210         /**
 211          * @var array List of tokens that are members of the current expect sequence
 212          */
 213         protected $tokens;
 214
 215         /**
 216          * @var string $code PHP code (including <?php) to detect class names from
 217          * @return array List of FQCN detected within the tokens
 218          */
 219         public function getClasses( $code ) {
 220                 $this->namespace = '';
 221                 $this->classes = array();
 222                 $this->startToken = null;
 223                 $this->tokens = array();
 224
 225                 foreach ( token_get_all( $code ) as $token ) {
 226                         if ( $this->startToken === null ) {
 227                                 $this->tryBeginExpect( $token );
 228                         } else {
 229                                 $this->tryEndExpect( $token );
 230                         }
 231                 }
 232
 233                 return $this->classes;
 234         }
 235
 236         /**
 237          * Determine if $token begins the next expect sequence.
 238          *
 239          * @param array $token
 240          */
 241         protected function tryBeginExpect( $token ) {
 242                 if ( is_string( $token ) ) {
 243                         return;
 244                 }
 245                 switch ( $token[0] ) {
 246                 case T_NAMESPACE:
 247                 case T_CLASS:
 248                 case T_INTERFACE:
 249                         $this->startToken = $token;
 250                 }
 251         }
 252
 253         /**
 254          * Accepts the next token in an expect sequence
 255          *
 256          * @param array
 257          */
 258         protected function tryEndExpect( $token ) {
 259                 switch ( $this->startToken[0] ) {
 260                 case T_NAMESPACE:
 261                         if ( $token === ';' || $token === '{' ) {
 262                                 $this->namespace = $this->implodeTokens() . '\\';
 263                         } else {
 264                                 $this->tokens[] = $token;
 265                         }
 266                         break;
 267
 268                 case T_CLASS:
 269                 case T_INTERFACE:
 270                         $this->tokens[] = $token;
 271                         if ( is_array( $token ) && $token[0] === T_STRING ) {
 272                                 $this->classes[] = $this->namespace . $this->implodeTokens();
 273                         }
 274                 }
 275         }
 276
 277         /**
 278          * Returns the string representation of the tokens within the
 279          * current expect sequence and resets the sequence.
 280          *
 281          * @return string
 282          */
 283         protected function implodeTokens() {
 284                 $content = array();
 285                 foreach ( $this->tokens as $token ) {
 286                         $content[] = is_string( $token ) ? $token : $token[1];
 287                 }
 288
 289                 $this->tokens = array();
 290                 $this->startToken = null;
 291
 292                 return trim( implode( '', $content ), " \n\t" );
 293         }
 294 }