MediaWiki  REL1_31
findDeprecated.php
Go to the documentation of this file.
1 <?php
25 require_once __DIR__ . '/Maintenance.php';
26 require_once __DIR__ . '/../vendor/autoload.php';
27 
31 class FileAwareNodeVisitor extends PhpParser\NodeVisitorAbstract {
32  private $currentFile = null;
33 
34  public function enterNode( PhpParser\Node $node ) {
35  $retVal = parent::enterNode( $node );
36  $node->filename = $this->currentFile;
37  return $retVal;
38  }
39 
40  public function setCurrentFile( $filename ) {
41  $this->currentFile = $filename;
42  }
43 
44  public function getCurrentFile() {
45  return $this->currentFile;
46  }
47 }
48 
53 
54  private $currentClass = null;
55 
56  private $foundNodes = [];
57 
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;
63  } );
64  }
65  ksort( $this->foundNodes );
66  return $this->foundNodes;
67  }
68 
75  public function isHardDeprecated( PhpParser\Node $node ) {
76  if ( !$node->stmts ) {
77  return false;
78  }
79  foreach ( $node->stmts as $stmt ) {
80  if (
81  $stmt instanceof PhpParser\Node\Expr\FuncCall
82  && $stmt->name->toString() === 'wfDeprecated'
83  ) {
84  return true;
85  }
86  return false;
87  }
88  }
89 
90  public function enterNode( PhpParser\Node $node ) {
91  $retVal = parent::enterNode( $node );
92 
93  if ( $node instanceof PhpParser\Node\Stmt\ClassLike ) {
94  $this->currentClass = $node->name;
95  }
96 
97  if ( $node instanceof PhpParser\Node\FunctionLike ) {
98  $docComment = $node->getDocComment();
99  if ( !$docComment ) {
100  return;
101  }
102  if ( !preg_match( '/@deprecated.*(\d+\.\d+)/', $docComment->getText(), $matches ) ) {
103  return;
104  }
105  $version = $matches[1];
106 
107  if ( $node instanceof PhpParser\Node\Stmt\ClassMethod ) {
108  $name = $this->currentClass . '::' . $node->name;
109  } else {
110  $name = $node->name;
111  }
112 
113  $this->foundNodes[ $version ][] = [
114  'filename' => $node->filename,
115  'line' => $node->getLine(),
116  'name' => $name,
117  'hard' => $this->isHardDeprecated( $node ),
118  ];
119  }
120 
121  return $retVal;
122  }
123 }
124 
130  public function __construct() {
131  parent::__construct();
132  $this->addDescription( 'Find deprecated interfaces' );
133  }
134 
138  public function getFiles() {
139  global $IP;
140 
141  $files = new RecursiveDirectoryIterator( $IP . '/includes' );
142  $files = new RecursiveIteratorIterator( $files );
143  $files = new RegexIterator( $files, '/\.php$/' );
144  return iterator_to_array( $files, false );
145  }
146 
147  public function execute() {
148  global $IP;
149 
150  $files = $this->getFiles();
151  $chunkSize = ceil( count( $files ) / 72 );
152 
153  $parser = ( new PhpParser\ParserFactory )->create( PhpParser\ParserFactory::PREFER_PHP7 );
154  $traverser = new PhpParser\NodeTraverser;
155  $finder = new DeprecatedInterfaceFinder;
156  $traverser->addVisitor( $finder );
157 
158  $fileCount = count( $files );
159 
160  for ( $i = 0; $i < $fileCount; $i++ ) {
161  $file = $files[$i];
162  $code = file_get_contents( $file );
163 
164  if ( strpos( $code, '@deprecated' ) === -1 ) {
165  continue;
166  }
167 
168  $finder->setCurrentFile( substr( $file->getPathname(), strlen( $IP ) + 1 ) );
169  $nodes = $parser->parse( $code );
170  $traverser->traverse( $nodes );
171 
172  if ( $i % $chunkSize === 0 ) {
173  $percentDone = 100 * $i / $fileCount;
174  fprintf( STDERR, "\r[%-72s] %d%%", str_repeat( '#', $i / $chunkSize ), $percentDone );
175  }
176  }
177 
178  fprintf( STDERR, "\r[%'#-72s] 100%%\n", '' );
179 
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";
184  } else {
185  $versionFmt = "\n* Deprecated since %s:\n";
186  $entryFmt = " %s %s (%s:%d)\n";
187  }
188 
189  foreach ( $finder->getFoundNodes() as $version => $nodes ) {
190  printf( $versionFmt, $version );
191  foreach ( $nodes as $node ) {
192  printf(
193  $entryFmt,
194  $node['hard'] ? '+' : '-',
195  $node['name'],
196  $node['filename'],
197  $node['line']
198  );
199  }
200  }
201  printf( "\nlegend:\n -: soft-deprecated\n +: hard-deprecated (via wfDeprecated())\n" );
202  }
203 }
204 
206 require_once RUN_MAINTENANCE_IF_MAIN;
DeprecatedInterfaceFinder\isHardDeprecated
isHardDeprecated(PhpParser\Node $node)
Check whether a function or method includes a call to wfDeprecated(), indicating that it is a hard-de...
Definition: findDeprecated.php:75
FindDeprecated
Maintenance task that recursively scans MediaWiki PHP files for deprecated functions and interfaces a...
Definition: findDeprecated.php:129
FindDeprecated\execute
execute()
Do the actual work.
Definition: findDeprecated.php:147
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
DeprecatedInterfaceFinder\enterNode
enterNode(PhpParser\Node $node)
Definition: findDeprecated.php:90
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
DeprecatedInterfaceFinder
A PHPParser node visitor that finds deprecated functions and methods.
Definition: findDeprecated.php:52
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
FindDeprecated\__construct
__construct()
Default constructor.
Definition: findDeprecated.php:130
php
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:37
FileAwareNodeVisitor
A PHPParser node visitor that associates each node with its file name.
Definition: findDeprecated.php:31
FileAwareNodeVisitor\enterNode
enterNode(PhpParser\Node $node)
Definition: findDeprecated.php:34
$matches
$matches
Definition: NoLocalSettings.php:24
$parser
do that in ParserLimitReportFormat instead $parser
Definition: hooks.txt:2603
$maintClass
$maintClass
Definition: findDeprecated.php:205
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DeprecatedInterfaceFinder\getFoundNodes
getFoundNodes()
Definition: findDeprecated.php:58
Maintenance\posix_isatty
static posix_isatty( $fd)
Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but trea...
Definition: Maintenance.php:1511
FileAwareNodeVisitor\getCurrentFile
getCurrentFile()
Definition: findDeprecated.php:44
FileAwareNodeVisitor\$currentFile
$currentFile
Definition: findDeprecated.php:32
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
$code
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:865
FileAwareNodeVisitor\setCurrentFile
setCurrentFile( $filename)
Definition: findDeprecated.php:40
as
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:22
DeprecatedInterfaceFinder\$foundNodes
$foundNodes
Definition: findDeprecated.php:56
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
$IP
$IP
Definition: WebStart.php:52
DeprecatedInterfaceFinder\$currentClass
$currentClass
Definition: findDeprecated.php:54
FindDeprecated\getFiles
getFiles()
Definition: findDeprecated.php:138