findDeprecated.php

Go to the documentation of this file.

<?php
use MediaWiki\Maintenance\Maintenance;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
require_once __DIR__ . '/../vendor/autoload.php';
// @codeCoverageIgnoreEnd
 
class FileAwareNodeVisitor extends PhpParser\NodeVisitorAbstract {
    private $currentFile = null;
 
    public function enterNode( PhpParser\Node $node ) {
        $retVal = parent::enterNode( $node );
        $node->filename = $this->currentFile;
        return $retVal;
    }
 
    public function setCurrentFile( $filename ) {
        $this->currentFile = $filename;
    }
 
    public function getCurrentFile() {
        return $this->currentFile;
    }
}
 
class DeprecatedInterfaceFinder extends FileAwareNodeVisitor {
 
    private $currentClass = null;
 
    private $foundNodes = [];
 
    public function getFoundNodes() {
        // Sort results by version, then by filename, then by name.
        foreach ( $this->foundNodes as &$nodes ) {
            uasort( $nodes, static function ( $a, $b ) {
                return ( $a['filename'] . $a['name'] ) <=> ( $b['filename'] . $b['name'] );
            } );
        }
        ksort( $this->foundNodes );
        return $this->foundNodes;
    }
 
    public function isHardDeprecated( PhpParser\Node $node ) {
        if ( !$node->stmts ) {
            return false;
        }
        foreach ( $node->stmts as $stmt ) {
            $functionExpression = null;
            if ( $stmt instanceof PhpParser\Node\Expr\FuncCall ) {
                $functionExpression = $stmt;
            }
            if ( isset( $stmt->expr ) && $stmt->expr instanceof PhpParser\Node\Expr\FuncCall ) {
                $functionExpression = $stmt->expr;
            }
            if ( $functionExpression && $functionExpression->name->toString() === 'wfDeprecated' ) {
                return true;
            }
            return false;
        }
    }
 
    public function enterNode( PhpParser\Node $node ) {
        $retVal = parent::enterNode( $node );
 
        if ( $node instanceof PhpParser\Node\Stmt\ClassLike ) {
            $this->currentClass = $node->name;
        }
 
        if ( $node instanceof PhpParser\Node\FunctionLike ) {
            $docComment = $node->getDocComment();
            if ( !$docComment ) {
                return;
            }
            if ( !preg_match( '/@deprecated.*(\d+\.\d+)/', $docComment->getText(), $matches ) ) {
                return;
            }
            $version = $matches[1];
 
            if ( $node instanceof PhpParser\Node\Stmt\ClassMethod ) {
                $name = $this->currentClass . '::' . $node->name;
            } else {
                $name = $node->name;
            }
 
            $this->foundNodes[ $version ][] = [
                'filename' => $node->filename,
                'line'     => $node->getLine(),
                'name'     => $name,
                'hard'     => $this->isHardDeprecated( $node ),
            ];
        }
 
        return $retVal;
    }
}
 
class FindDeprecated extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Find deprecated interfaces' );
    }
 
    protected function getMwInstallPath() {
        return MW_INSTALL_PATH;
    }
 
    public function getFiles() {
        $files = new RecursiveDirectoryIterator( $this->getMwInstallPath() . '/includes' );
        $files = new RecursiveIteratorIterator( $files );
        $files = new RegexIterator( $files, '/\.php$/' );
        return iterator_to_array( $files, false );
    }
 
    public function execute() {
        global $IP;
 
        $files = $this->getFiles();
        $chunkSize = (int)ceil( count( $files ) / 72 );
 
        $parser = ( new PhpParser\ParserFactory )->createForVersion( PhpParser\PhpVersion::fromComponents( 7, 0 ) );
        $traverser = new PhpParser\NodeTraverser;
        $finder = new DeprecatedInterfaceFinder;
        $traverser->addVisitor( $finder );
 
        $fileCount = count( $files );
 
        $outputProgress = !defined( 'MW_PHPUNIT_TEST' );
 
        for ( $i = 0; $i < $fileCount; $i++ ) {
            $file = $files[$i];
            $code = file_get_contents( $file );
 
            if ( !str_contains( $code, '@deprecated' ) ) {
                continue;
            }
 
            $finder->setCurrentFile( substr( $file->getPathname(), strlen( $IP ) + 1 ) );
            $nodes = $parser->parse( $code );
            $traverser->traverse( $nodes );
 
            if ( $i % $chunkSize === 0 ) {
                $percentDone = 100 * $i / $fileCount;
                if ( $outputProgress ) {
                    fprintf( STDERR, "\r[%-72s] %d%%", str_repeat( '#', $i / $chunkSize ), $percentDone );
                }
            }
        }
 
        if ( $outputProgress ) {
            fprintf( STDERR, "\r[%'#-72s] 100%%\n", '' );
        }
 
        // Colorize output if STDOUT is an interactive terminal.
        if ( parent::posix_isatty( STDOUT ) ) {
            $versionFmt = "\n* Deprecated since \033[37;1m%s\033[0m:\n";
            $entryFmt = "  %s \033[33;1m%s\033[0m (%s:%d)\n";
        } else {
            $versionFmt = "\n* Deprecated since %s:\n";
            $entryFmt = "  %s %s (%s:%d)\n";
        }
 
        foreach ( $finder->getFoundNodes() as $version => $nodes ) {
            printf( $versionFmt, $version );
            foreach ( $nodes as $node ) {
                printf(
                    $entryFmt,
                    $node['hard'] ? '+' : '-',
                    $node['name'],
                    $node['filename'],
                    $node['line']
                );
            }
        }
        printf( "\nlegend:\n -: soft-deprecated\n +: hard-deprecated (via wfDeprecated())\n" );
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = FindDeprecated::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd