maintenance/checkSyntax.php

   1 <?php
   2 /**
   3  * Check syntax of all PHP files in MediaWiki
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup Maintenance
  22  */
  23
  24 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
  25
  26 class CheckSyntax extends Maintenance {
  27
  28         // List of files we're going to check
  29         private $mFiles = array(), $mFailures = array(), $mWarnings = array();
  30         private $mIgnorePaths = array(), $mNoStyleCheckPaths = array();
  31
  32         public function __construct() {
  33                 parent::__construct();
  34                 $this->mDescription = "Check syntax for all PHP files in MediaWiki";
  35                 $this->addOption( 'with-extensions', 'Also recurse the extensions folder' );
  36                 $this->addOption( 'path', 'Specific path (file or directory) to check, either with absolute path or relative to the root of this MediaWiki installation',
  37                         false, true );
  38                 $this->addOption( 'list-file', 'Text file containing list of files or directories to check', false, true );
  39                 $this->addOption( 'modified', 'Check only files that were modified (requires SVN command-line client)' );
  40                 $this->addOption( 'syntax-only', 'Check for syntax validity only, skip code style warnings' );
  41         }
  42
  43         public function getDbType() {
  44                 return Maintenance::DB_NONE;
  45         }
  46
  47         public function execute() {
  48                 $this->buildFileList();
  49
  50                 // ParseKit is broken on PHP 5.3+, disabled until this is fixed
  51                 $useParseKit = function_exists( 'parsekit_compile_file' ) && version_compare( PHP_VERSION, '5.3', '<' );
  52
  53                 $str = 'Checking syntax (using ' . ( $useParseKit ?
  54                         'parsekit' : ' php -l, this can take a long time' ) . ")\n";
  55                 $this->output( $str );
  56                 foreach ( $this->mFiles as $f ) {
  57                         if ( $useParseKit ) {
  58                                 $this->checkFileWithParsekit( $f );
  59                         } else {
  60                                 $this->checkFileWithCli( $f );
  61                         }
  62                         if ( !$this->hasOption( 'syntax-only' ) ) {
  63                                 $this->checkForMistakes( $f );
  64                         }
  65                 }
  66                 $this->output( "\nDone! " . count( $this->mFiles ) . " files checked, " .
  67                         count( $this->mFailures ) . " failures and " . count( $this->mWarnings ) .
  68                         " warnings found\n" );
  69         }
  70
  71         /**
  72          * Build the list of files we'll check for syntax errors
  73          */
  74         private function buildFileList() {
  75                 global $IP;
  76
  77                 $this->mIgnorePaths = array(
  78                         // Compat stuff, explodes on PHP 5.3
  79                         "includes/NamespaceCompat.php$",
  80                         );
  81
  82                 $this->mNoStyleCheckPaths = array(
  83                         // Third-party code we don't care about
  84                         "/activemq_stomp/",
  85                         "EmailPage/PHPMailer",
  86                         "FCKeditor/fckeditor/",
  87                         '\bphplot-',
  88                         "/svggraph/",
  89                         "\bjsmin.php$",
  90                         "PEAR/File_Ogg/",
  91                         "QPoll/Excel/",
  92                         "/geshi/",
  93                         "/smarty/",
  94                         );
  95
  96                 if ( $this->hasOption( 'path' ) ) {
  97                         $path = $this->getOption( 'path' );
  98                         if ( !$this->addPath( $path ) ) {
  99                                 $this->error( "Error: can't find file or directory $path\n", true );
 100                         }
 101                         return; // process only this path
 102                 } elseif ( $this->hasOption( 'list-file' ) ) {
 103                         $file = $this->getOption( 'list-file' );
 104                         wfSuppressWarnings();
 105                         $f = fopen( $file, 'r' );
 106                         wfRestoreWarnings();
 107                         if ( !$f ) {
 108                                 $this->error( "Can't open file $file\n", true );
 109                         }
 110                         $path = trim( fgets( $f ) );
 111                         while ( $path ) {
 112                                 $this->addPath( $path );
 113                         }
 114                         fclose( $f );
 115                         return;
 116                 } elseif ( $this->hasOption( 'modified' ) ) {
 117                         $this->output( "Retrieving list from Subversion... " );
 118                         $parentDir = wfEscapeShellArg( dirname( __FILE__ ) . '/..' );
 119                         $retval = null;
 120                         $output = wfShellExec( "svn status --ignore-externals $parentDir", $retval );
 121                         if ( $retval ) {
 122                                 $this->error( "Error retrieving list from Subversion!\n", true );
 123                         } else {
 124                                 $this->output( "done\n" );
 125                         }
 126
 127                         preg_match_all( '/^\s*[AM].{7}(.*?)\r?$/m', $output, $matches );
 128                         foreach ( $matches[1] as $file ) {
 129                                 if ( $this->isSuitableFile( $file ) && !is_dir( $file ) ) {
 130                                         $this->mFiles[] = $file;
 131                                 }
 132                         }
 133                         return;
 134                 }
 135
 136                 $this->output( 'Building file list...', 'listfiles' );
 137
 138                 // Only check files in these directories.
 139                 // Don't just put $IP, because the recursive dir thingie goes into all subdirs
 140                 $dirs = array(
 141                         $IP . '/includes',
 142                         $IP . '/mw-config',
 143                         $IP . '/languages',
 144                         $IP . '/maintenance',
 145                         $IP . '/skins',
 146                 );
 147                 if ( $this->hasOption( 'with-extensions' ) ) {
 148                         $dirs[] = $IP . '/extensions';
 149                 }
 150
 151                 foreach ( $dirs as $d ) {
 152                         $this->addDirectoryContent( $d );
 153                 }
 154
 155                 // Manually add two user-editable files that are usually sources of problems
 156                 if ( file_exists( "$IP/LocalSettings.php" ) ) {
 157                         $this->mFiles[] = "$IP/LocalSettings.php";
 158                 }
 159                 if ( file_exists( "$IP/AdminSettings.php" ) ) {
 160                         $this->mFiles[] = "$IP/AdminSettings.php";
 161                 }
 162
 163                 $this->output( 'done.', 'listfiles' );
 164         }
 165
 166         /**
 167          * Returns true if $file is of a type we can check
 168          */
 169         private function isSuitableFile( $file ) {
 170                 $file = str_replace( '\\', '/', $file );
 171                 $ext = pathinfo( $file, PATHINFO_EXTENSION );
 172                 if ( $ext != 'php' && $ext != 'inc' && $ext != 'php5' )
 173                         return false;
 174                 foreach ( $this->mIgnorePaths as $regex ) {
 175                         $m = array();
 176                         if ( preg_match( "~{$regex}~", $file, $m ) )
 177                                 return false;
 178                 }
 179                 return true;
 180         }
 181
 182         /**
 183          * Add given path to file list, searching it in include path if needed
 184          */
 185         private function addPath( $path ) {
 186                 global $IP;
 187                 return $this->addFileOrDir( $path ) || $this->addFileOrDir( "$IP/$path" );
 188         }
 189
 190         /**
 191         * Add given file to file list, or, if it's a directory, add its content
 192         */
 193         private function addFileOrDir( $path ) {
 194                 if ( is_dir( $path ) ) {
 195                         $this->addDirectoryContent( $path );
 196                 } elseif ( file_exists( $path ) ) {
 197                         $this->mFiles[] = $path;
 198                 } else {
 199                         return false;
 200                 }
 201                 return true;
 202         }
 203
 204         /**
 205          * Add all suitable files in given directory or its subdirectories to the file list
 206          *
 207          * @param $dir String: directory to process
 208          */
 209         private function addDirectoryContent( $dir ) {
 210                 $iterator = new RecursiveIteratorIterator(
 211                         new RecursiveDirectoryIterator( $dir ),
 212                         RecursiveIteratorIterator::SELF_FIRST
 213                 );
 214                 foreach ( $iterator as $file ) {
 215                         if ( $this->isSuitableFile( $file->getRealPath() ) ) {
 216                                 $this->mFiles[] = $file->getRealPath();
 217                         }
 218                 }
 219         }
 220
 221         /**
 222          * Check a file for syntax errors using Parsekit. Shamelessly stolen
 223          * from tools/lint.php by TimStarling
 224          * @param $file String Path to a file to check for syntax errors
 225          * @return boolean
 226          */
 227         private function checkFileWithParsekit( $file ) {
 228                 static $okErrors = array(
 229                         'Redefining already defined constructor',
 230                         'Assigning the return value of new by reference is deprecated',
 231                 );
 232                 $errors = array();
 233                 parsekit_compile_file( $file, $errors, PARSEKIT_SIMPLE );
 234                 $ret = true;
 235                 if ( $errors ) {
 236                         foreach ( $errors as $error ) {
 237                                 foreach ( $okErrors as $okError ) {
 238                                         if ( substr( $error['errstr'], 0, strlen( $okError ) ) == $okError ) {
 239                                                 continue 2;
 240                                         }
 241                                 }
 242                                 $ret = false;
 243                                 $this->output( "Error in $file line {$error['lineno']}: {$error['errstr']}\n" );
 244                                 $this->mFailures[$file] = $errors;
 245                         }
 246                 }
 247                 return $ret;
 248         }
 249
 250         /**
 251          * Check a file for syntax errors using php -l
 252          * @param $file String Path to a file to check for syntax errors
 253          * @return boolean
 254          */
 255         private function checkFileWithCli( $file ) {
 256                 $res = exec( 'php -l ' . wfEscapeShellArg( $file ) );
 257                 if ( strpos( $res, 'No syntax errors detected' ) === false ) {
 258                         $this->mFailures[$file] = $res;
 259                         $this->output( $res . "\n" );
 260                         return false;
 261                 }
 262                 return true;
 263         }
 264
 265         /**
 266          * Check a file for non-fatal coding errors, such as byte-order marks in the beginning
 267          * or pointless ?> closing tags at the end.
 268          *
 269          * @param $file String String Path to a file to check for errors
 270          * @return boolean
 271          */
 272         private function checkForMistakes( $file ) {
 273                 foreach ( $this->mNoStyleCheckPaths as $regex ) {
 274                         $m = array();
 275                         if ( preg_match( "~{$regex}~", $file, $m ) )
 276                                 return;
 277                 }
 278
 279                 $text = file_get_contents( $file );
 280                 $tokens = token_get_all( $text );
 281
 282                 $this->checkEvilToken( $file, $tokens, '@', 'Error supression operator (@)');
 283                 $this->checkRegex( $file, $text, '/^[\s\r\n]+<\?/', 'leading whitespace' );
 284                 $this->checkRegex( $file, $text, '/\?>[\s\r\n]*$/', 'trailing ?>' );
 285                 $this->checkRegex( $file, $text, '/^[\xFF\xFE\xEF]/', 'byte-order mark' );
 286         }
 287
 288         private function checkRegex( $file, $text, $regex, $desc ) {
 289                 if ( !preg_match( $regex, $text ) ) {
 290                         return;
 291                 }
 292
 293                 if ( !isset( $this->mWarnings[$file] ) ) {
 294                         $this->mWarnings[$file] = array();
 295                 }
 296                 $this->mWarnings[$file][] = $desc;
 297                 $this->output( "Warning in file $file: $desc found.\n" );
 298         }
 299
 300         private function checkEvilToken( $file, $tokens, $evilToken, $desc ) {
 301                 if ( !in_array( $evilToken, $tokens ) ) {
 302                         return;
 303                 }
 304
 305                 if ( !isset( $this->mWarnings[$file] ) ) {
 306                         $this->mWarnings[$file] = array();
 307                 }
 308                 $this->mWarnings[$file][] = $desc;
 309                 $this->output( "Warning in file $file: $desc found.\n" );
 310         }
 311 }
 312
 313 $maintClass = "CheckSyntax";
 314 require_once( RUN_MAINTENANCE_IF_MAIN );
 315