AutoloadGenerator.php

Go to the documentation of this file.

<?php
class AutoloadGenerator {
    const FILETYPE_JSON = 'json';
    const FILETYPE_PHP = 'php';

    protected $basepath;

    protected $collector;

    protected $classes = [];

    protected $variableName = 'wgAutoloadClasses';

    protected $overrides = [];

    protected $excludePaths = [];

    protected $psr4Namespaces = [];

    public function __construct( $basepath, $flags = [] ) {
        if ( !is_array( $flags ) ) {
            $flags = [ $flags ];
        }
        $this->basepath = self::normalizePathSeparator( realpath( $basepath ) );
        $this->collector = new ClassCollector;
        if ( in_array( 'local', $flags ) ) {
            $this->variableName = 'wgAutoloadLocalClasses';
        }
    }

    public function setExcludePaths( array $paths ) {
        foreach ( $paths as $path ) {
            $this->excludePaths[] = self::normalizePathSeparator( $path );
        }
    }

    public function setPsr4Namespaces( array $namespaces ) {
        foreach ( $namespaces as $ns => $path ) {
            $ns = rtrim( $ns, '\\' ) . '\\';
            $this->psr4Namespaces[$ns] = rtrim( self::normalizePathSeparator( $path ), '/' );
        }
    }

    private function shouldExclude( $path ) {
        foreach ( $this->excludePaths as $dir ) {
            if ( strpos( $path, $dir ) === 0 ) {
                return true;
            }
        }

        return false;
    }

    public function forceClassPath( $fqcn, $inputPath ) {
        $path = self::normalizePathSeparator( realpath( $inputPath ) );
        if ( !$path ) {
            throw new \Exception( "Invalid path: $inputPath" );
        }
        $len = strlen( $this->basepath );
        if ( substr( $path, 0, $len ) !== $this->basepath ) {
            throw new \Exception( "Path is not within basepath: $inputPath" );
        }
        $shortpath = substr( $path, $len );
        $this->overrides[$fqcn] = $shortpath;
    }

    public function readFile( $inputPath ) {
        // NOTE: do NOT expand $inputPath using realpath(). It is perfectly
        // reasonable for LocalSettings.php and similiar files to be symlinks
        // to files that are outside of $this->basepath.
        $inputPath = self::normalizePathSeparator( $inputPath );
        $len = strlen( $this->basepath );
        if ( substr( $inputPath, 0, $len ) !== $this->basepath ) {
            throw new \Exception( "Path is not within basepath: $inputPath" );
        }
        if ( $this->shouldExclude( $inputPath ) ) {
            return;
        }
        $result = $this->collector->getClasses(
            file_get_contents( $inputPath )
        );

        // Filter out classes that will be found by PSR4
        $result = array_filter( $result, function ( $class ) use ( $inputPath ) {
            $parts = explode( '\\', $class );
            for ( $i = count( $parts ) - 1; $i > 0; $i-- ) {
                $ns = implode( '\\', array_slice( $parts, 0, $i ) ) . '\\';
                if ( isset( $this->psr4Namespaces[$ns] ) ) {
                    $expectedPath = $this->psr4Namespaces[$ns] . '/'
                        . implode( '/', array_slice( $parts, $i ) )
                        . '.php';
                    if ( $inputPath === $expectedPath ) {
                        return false;
                    }
                }
            }

            return true;
        } );

        if ( $result ) {
            $shortpath = substr( $inputPath, $len );
            $this->classes[$shortpath] = $result;
        }
    }

    public function readDir( $dir ) {
        $it = new RecursiveDirectoryIterator(
            self::normalizePathSeparator( realpath( $dir ) ) );
        $it = new RecursiveIteratorIterator( $it );

        foreach ( $it as $path => $file ) {
            $ext = pathinfo( $path, PATHINFO_EXTENSION );
            // some older files in mw use .inc
            if ( $ext === 'php' || $ext === 'inc' ) {
                $this->readFile( $path );
            }
        }
    }

    protected function generateJsonAutoload( $filename ) {
        $key = 'AutoloadClasses';
        $json = FormatJson::decode( file_get_contents( $filename ), true );
        unset( $json[$key] );
        // Inverting the key-value pairs so that they become of the
        // format class-name : path when they get converted into json.
        foreach ( $this->classes as $path => $contained ) {
            foreach ( $contained as $fqcn ) {
                // Using substr to remove the leading '/'
                $json[$key][$fqcn] = substr( $path, 1 );
            }
        }
        foreach ( $this->overrides as $path => $fqcn ) {
            // Using substr to remove the leading '/'
            $json[$key][$fqcn] = substr( $path, 1 );
        }

        // Sorting the list of autoload classes.
        ksort( $json[$key] );

        // Return the whole JSON file
        return FormatJson::encode( $json, "\t", FormatJson::ALL_OK ) . "\n";
    }

    protected function generatePHPAutoload( $commandName, $filename ) {
        // No existing JSON file found; update/generate PHP file
        $content = [];

        // We need to generate a line each rather than exporting the
        // full array so __DIR__ can be prepended to all the paths
        $format = "%s => __DIR__ . %s,";
        foreach ( $this->classes as $path => $contained ) {
            $exportedPath = var_export( $path, true );
            foreach ( $contained as $fqcn ) {
                $content[$fqcn] = sprintf(
                    $format,
                    var_export( $fqcn, true ),
                    $exportedPath
                );
            }
        }

        foreach ( $this->overrides as $fqcn => $path ) {
            $content[$fqcn] = sprintf(
                $format,
                var_export( $fqcn, true ),
                var_export( $path, true )
            );
        }

        // sort for stable output
        ksort( $content );

        // extensions using this generator are appending to the existing
        // autoload.
        if ( $this->variableName === 'wgAutoloadClasses' ) {
            $op = '+=';
        } else {
            $op = '=';
        }

        $output = implode( "\n\t", $content );
        return <<<EOD
<?php
// This file is generated by $commandName, do not adjust manually
// phpcs:disable Generic.Files.LineLength
global \${$this->variableName};

\${$this->variableName} {$op} [
    {$output}
];

EOD;
    }

    public function getAutoload( $commandName = 'AutoloadGenerator' ) {
        // We need to check whether an extension.json or skin.json exists or not, and
        // incase it doesn't, update the autoload.php file.

        $fileinfo = $this->getTargetFileinfo();

        if ( $fileinfo['type'] === self::FILETYPE_JSON ) {
            return $this->generateJsonAutoload( $fileinfo['filename'] );
        } else {
            return $this->generatePHPAutoload( $commandName, $fileinfo['filename'] );
        }
    }

    public function getTargetFileinfo() {
        $fileinfo = [
            'filename' => $this->basepath . '/autoload.php',
            'type' => self::FILETYPE_PHP
        ];
        if ( file_exists( $this->basepath . '/extension.json' ) ) {
            $fileinfo = [
                'filename' => $this->basepath . '/extension.json',
                'type' => self::FILETYPE_JSON
            ];
        } elseif ( file_exists( $this->basepath . '/skin.json' ) ) {
            $fileinfo = [
                'filename' => $this->basepath . '/skin.json',
                'type' => self::FILETYPE_JSON
            ];
        }

        return $fileinfo;
    }

    protected static function normalizePathSeparator( $path ) {
        return str_replace( '\\', '/', $path );
    }

    public function initMediaWikiDefault() {
        foreach ( [ 'includes', 'languages', 'maintenance', 'mw-config' ] as $dir ) {
            $this->readDir( $this->basepath . '/' . $dir );
        }
        foreach ( glob( $this->basepath . '/*.php' ) as $file ) {
            $this->readFile( $file );
        }
    }
}