3 * Check syntax of all PHP files in MediaWiki
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup Maintenance
24 require_once __DIR__
. '/Maintenance.php';
27 * Maintenance script to check syntax of all PHP files in MediaWiki.
29 * @ingroup Maintenance
31 class CheckSyntax
extends Maintenance
{
33 // List of files we're going to check
34 private $mFiles = [], $mFailures = [], $mWarnings = [];
35 private $mIgnorePaths = [], $mNoStyleCheckPaths = [];
37 public function __construct() {
38 parent
::__construct();
39 $this->addDescription( 'Check syntax for all PHP files in MediaWiki' );
40 $this->addOption( 'with-extensions', 'Also recurse the extensions folder' );
43 'Specific path (file or directory) to check, either with absolute path or '
44 . 'relative to the root of this MediaWiki installation',
50 'Text file containing list of files or directories to check',
56 'Check only files that were modified (requires Git command-line client)'
58 $this->addOption( 'syntax-only', 'Check for syntax validity only, skip code style warnings' );
61 public function getDbType() {
62 return Maintenance
::DB_NONE
;
65 public function execute() {
66 $this->buildFileList();
68 $this->output( "Checking syntax (using php -l, this can take a long time)\n" );
69 foreach ( $this->mFiles
as $f ) {
70 $this->checkFileWithCli( $f );
71 if ( !$this->hasOption( 'syntax-only' ) ) {
72 $this->checkForMistakes( $f );
75 $this->output( "\nDone! " . count( $this->mFiles
) . " files checked, " .
76 count( $this->mFailures
) . " failures and " . count( $this->mWarnings
) .
77 " warnings found\n" );
81 * Build the list of files we'll check for syntax errors
83 private function buildFileList() {
86 $this->mIgnorePaths
= [
89 $this->mNoStyleCheckPaths
= [
90 // Third-party code we don't care about
92 "EmailPage/PHPMailer",
93 "FCKeditor/fckeditor/",
103 if ( $this->hasOption( 'path' ) ) {
104 $path = $this->getOption( 'path' );
105 if ( !$this->addPath( $path ) ) {
106 $this->error( "Error: can't find file or directory $path\n", true );
109 return; // process only this path
110 } elseif ( $this->hasOption( 'list-file' ) ) {
111 $file = $this->getOption( 'list-file' );
112 MediaWiki\
suppressWarnings();
113 $f = fopen( $file, 'r' );
114 MediaWiki\restoreWarnings
();
116 $this->error( "Can't open file $file\n", true );
118 $path = trim( fgets( $f ) );
120 $this->addPath( $path );
125 } elseif ( $this->hasOption( 'modified' ) ) {
126 $this->output( "Retrieving list from Git... " );
127 $files = $this->getGitModifiedFiles( $IP );
128 $this->output( "done\n" );
129 foreach ( $files as $file ) {
130 if ( $this->isSuitableFile( $file ) && !is_dir( $file ) ) {
131 $this->mFiles
[] = $file;
138 $this->output( 'Building file list...', 'listfiles' );
140 // Only check files in these directories.
141 // Don't just put $IP, because the recursive dir thingie goes into all subdirs
146 $IP . '/maintenance',
149 if ( $this->hasOption( 'with-extensions' ) ) {
150 $dirs[] = $IP . '/extensions';
153 foreach ( $dirs as $d ) {
154 $this->addDirectoryContent( $d );
157 // Manually add two user-editable files that are usually sources of problems
158 if ( file_exists( "$IP/LocalSettings.php" ) ) {
159 $this->mFiles
[] = "$IP/LocalSettings.php";
162 $this->output( 'done.', 'listfiles' );
166 * Returns a list of tracked files in a Git work tree differing from the master branch.
167 * @param string $path Path to the repository
168 * @return array Resulting list of changed files
170 private function getGitModifiedFiles( $path ) {
171 global $wgMaxShellMemory;
173 if ( !is_dir( "$path/.git" ) ) {
174 $this->error( "Error: Not a Git repository!\n", true );
177 // git diff eats memory.
178 $oldMaxShellMemory = $wgMaxShellMemory;
179 if ( $wgMaxShellMemory < 1024000 ) {
180 $wgMaxShellMemory = 1024000;
183 $ePath = wfEscapeShellArg( $path );
185 // Find an ancestor in common with master (rather than just using its HEAD)
186 // to prevent files only modified there from showing up in the list.
187 $cmd = "cd $ePath && git merge-base master HEAD";
189 $output = wfShellExec( $cmd, $retval );
190 if ( $retval !== 0 ) {
191 $this->error( "Error retrieving base SHA1 from Git!\n", true );
194 // Find files in the working tree that changed since then.
195 $eBase = wfEscapeShellArg( rtrim( $output, "\n" ) );
196 $cmd = "cd $ePath && git diff --name-only --diff-filter AM $eBase";
198 $output = wfShellExec( $cmd, $retval );
199 if ( $retval !== 0 ) {
200 $this->error( "Error retrieving list from Git!\n", true );
203 $wgMaxShellMemory = $oldMaxShellMemory;
206 $filename = strtok( $output, "\n" );
207 while ( $filename !== false ) {
208 if ( $filename !== '' ) {
209 $arr[] = "$path/$filename";
211 $filename = strtok( "\n" );
218 * Returns true if $file is of a type we can check
219 * @param string $file
222 private function isSuitableFile( $file ) {
223 $file = str_replace( '\\', '/', $file );
224 $ext = pathinfo( $file, PATHINFO_EXTENSION
);
225 if ( $ext != 'php' && $ext != 'inc' && $ext != 'php5' ) {
228 foreach ( $this->mIgnorePaths
as $regex ) {
230 if ( preg_match( "~{$regex}~", $file, $m ) ) {
239 * Add given path to file list, searching it in include path if needed
240 * @param string $path
243 private function addPath( $path ) {
246 return $this->addFileOrDir( $path ) ||
$this->addFileOrDir( "$IP/$path" );
250 * Add given file to file list, or, if it's a directory, add its content
251 * @param string $path
254 private function addFileOrDir( $path ) {
255 if ( is_dir( $path ) ) {
256 $this->addDirectoryContent( $path );
257 } elseif ( file_exists( $path ) ) {
258 $this->mFiles
[] = $path;
267 * Add all suitable files in given directory or its subdirectories to the file list
269 * @param string $dir Directory to process
271 private function addDirectoryContent( $dir ) {
272 $iterator = new RecursiveIteratorIterator(
273 new RecursiveDirectoryIterator( $dir ),
274 RecursiveIteratorIterator
::SELF_FIRST
276 foreach ( $iterator as $file ) {
277 if ( $this->isSuitableFile( $file->getRealPath() ) ) {
278 $this->mFiles
[] = $file->getRealPath();
284 * Check a file for syntax errors using php -l
285 * @param string $file Path to a file to check for syntax errors
288 private function checkFileWithCli( $file ) {
289 $res = exec( 'php -l ' . wfEscapeShellArg( $file ) );
290 if ( strpos( $res, 'No syntax errors detected' ) === false ) {
291 $this->mFailures
[$file] = $res;
292 $this->output( $res . "\n" );
301 * Check a file for non-fatal coding errors, such as byte-order marks in the beginning
302 * or pointless ?> closing tags at the end.
304 * @param string $file String Path to a file to check for errors
306 private function checkForMistakes( $file ) {
307 foreach ( $this->mNoStyleCheckPaths
as $regex ) {
309 if ( preg_match( "~{$regex}~", $file, $m ) ) {
314 $text = file_get_contents( $file );
315 $tokens = token_get_all( $text );
317 $this->checkEvilToken( $file, $tokens, '@', 'Error supression operator (@)' );
318 $this->checkRegex( $file, $text, '/^[\s\r\n]+<\?/', 'leading whitespace' );
319 $this->checkRegex( $file, $text, '/\?>[\s\r\n]*$/', 'trailing ?>' );
320 $this->checkRegex( $file, $text, '/^[\xFF\xFE\xEF]/', 'byte-order mark' );
323 private function checkRegex( $file, $text, $regex, $desc ) {
324 if ( !preg_match( $regex, $text ) ) {
328 if ( !isset( $this->mWarnings
[$file] ) ) {
329 $this->mWarnings
[$file] = [];
331 $this->mWarnings
[$file][] = $desc;
332 $this->output( "Warning in file $file: $desc found.\n" );
335 private function checkEvilToken( $file, $tokens, $evilToken, $desc ) {
336 if ( !in_array( $evilToken, $tokens ) ) {
340 if ( !isset( $this->mWarnings
[$file] ) ) {
341 $this->mWarnings
[$file] = [];
343 $this->mWarnings
[$file][] = $desc;
344 $this->output( "Warning in file $file: $desc found.\n" );
348 $maintClass = "CheckSyntax";
349 require_once RUN_MAINTENANCE_IF_MAIN
;