3 * Maintenance script that recursively scans MediaWiki's PHP source tree
4 * for deprecated functions and methods and pretty-prints the results.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
25 require_once __DIR__
. '/Maintenance.php';
26 require_once __DIR__
. '/../vendor/autoload.php';
29 * A PHPParser node visitor that associates each node with its file name.
31 class FileAwareNodeVisitor
extends PhpParser\NodeVisitorAbstract
{
32 private $currentFile = null;
34 public function enterNode( PhpParser\Node
$node ) {
35 $retVal = parent
::enterNode( $node );
36 $node->filename
= $this->currentFile
;
40 public function setCurrentFile( $filename ) {
41 $this->currentFile
= $filename;
44 public function getCurrentFile() {
45 return $this->currentFile
;
50 * A PHPParser node visitor that finds deprecated functions and methods.
52 class DeprecatedInterfaceFinder
extends FileAwareNodeVisitor
{
54 private $currentClass = null;
56 private $foundNodes = [];
58 public function getFoundNodes() {
59 // Sort results by version, then by filename, then by name.
60 foreach ( $this->foundNodes
as $version => &$nodes ) {
61 uasort( $nodes, function ( $a, $b ) {
62 return ( $a['filename'] . $a['name'] ) < ( $b['filename'] . $b['name'] ) ?
-1 : 1;
65 ksort( $this->foundNodes
);
66 return $this->foundNodes
;
70 * Check whether a function or method includes a call to wfDeprecated(),
71 * indicating that it is a hard-deprecated interface.
72 * @param PhpParser\Node $node
75 public function isHardDeprecated( PhpParser\Node
$node ) {
76 if ( !$node->stmts
) {
79 foreach ( $node->stmts
as $stmt ) {
81 $stmt instanceof PhpParser\Node\Expr\FuncCall
82 && $stmt->name
->toString() === 'wfDeprecated'
90 public function enterNode( PhpParser\Node
$node ) {
91 $retVal = parent
::enterNode( $node );
93 if ( $node instanceof PhpParser\Node\Stmt\ClassLike
) {
94 $this->currentClass
= $node->name
;
97 if ( $node instanceof PhpParser\Node\FunctionLike
) {
98 $docComment = $node->getDocComment();
102 if ( !preg_match( '/@deprecated.*(\d+\.\d+)/', $docComment->getText(), $matches ) ) {
105 $version = $matches[1];
107 if ( $node instanceof PhpParser\Node\Stmt\ClassMethod
) {
108 $name = $this->currentClass
. '::' . $node->name
;
113 $this->foundNodes
[ $version ][] = [
114 'filename' => $node->filename
,
115 'line' => $node->getLine(),
117 'hard' => $this->isHardDeprecated( $node ),
126 * Maintenance task that recursively scans MediaWiki PHP files for deprecated
127 * functions and interfaces and produces a report.
129 class FindDeprecated
extends Maintenance
{
130 public function __construct() {
131 parent
::__construct();
132 $this->addDescription( 'Find deprecated interfaces' );
136 * @return SplFileInfo[]
138 public function getFiles() {
141 $files = new RecursiveDirectoryIterator( $IP . '/includes' );
142 $files = new RecursiveIteratorIterator( $files );
143 $files = new RegexIterator( $files, '/\.php$/' );
144 return iterator_to_array( $files, false );
147 public function execute() {
150 $files = $this->getFiles();
151 $chunkSize = ceil( count( $files ) / 72 );
153 $parser = ( new PhpParser\ParserFactory
)->create( PhpParser\ParserFactory
::PREFER_PHP7
);
154 $traverser = new PhpParser\NodeTraverser
;
155 $finder = new DeprecatedInterfaceFinder
;
156 $traverser->addVisitor( $finder );
158 $fileCount = count( $files );
160 for ( $i = 0; $i < $fileCount; $i++
) {
162 $code = file_get_contents( $file );
164 if ( strpos( $code, '@deprecated' ) === -1 ) {
168 $finder->setCurrentFile( substr( $file->getPathname(), strlen( $IP ) +
1 ) );
169 $nodes = $parser->parse( $code );
170 $traverser->traverse( $nodes );
172 if ( $i %
$chunkSize === 0 ) {
173 $percentDone = 100 * $i / $fileCount;
174 fprintf( STDERR
, "\r[%-72s] %d%%", str_repeat( '#', $i / $chunkSize ), $percentDone );
178 fprintf( STDERR
, "\r[%'#-72s] 100%%\n", '' );
180 // Colorize output if STDOUT is an interactive terminal.
181 if ( posix_isatty( STDOUT
) ) {
182 $versionFmt = "\n* Deprecated since \033[37;1m%s\033[0m:\n";
183 $entryFmt = " %s \033[33;1m%s\033[0m (%s:%d)\n";
185 $versionFmt = "\n* Deprecated since %s:\n";
186 $entryFmt = " %s %s (%s:%d)\n";
189 foreach ( $finder->getFoundNodes() as $version => $nodes ) {
190 printf( $versionFmt, $version );
191 foreach ( $nodes as $node ) {
194 $node['hard'] ?
'+' : '-',
201 printf( "\nlegend:\n -: soft-deprecated\n +: hard-deprecated (via wfDeprecated())\n" );
205 $maintClass = 'FindDeprecated';
206 require_once RUN_MAINTENANCE_IF_MAIN
;