maintenance/syntaxChecker.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  * @ingroup Maintenance
  21  */
  22
  23 require_once( dirname( __FILE__ ) . '/Maintenance.php' );
  24
  25 class SyntaxChecker extends Maintenance {
  26
  27         // List of files we're going to check
  28         private $mFiles, $mFailures = array();
  29
  30         public function __construct() {
  31                 parent::__construct();
  32                 $this->mDescription = "Check syntax for all PHP files in MediaWiki";
  33                 $this->addOption( 'with-extensions', 'Also recurse the extensions folder' );
  34         }
  35
  36         protected function getDbType() {
  37                 return Maintenance::DB_NONE;
  38         }
  39
  40         public function execute() {
  41                 $this->output( "Building file list..." );
  42                 $this->buildFileList();
  43                 $this->output( "done.\n" );
  44
  45                 $this->output( "Checking syntax (this can take a really long time)...\n\n" );
  46                 $res = $this->checkSyntax();
  47         }
  48
  49         /**
  50          * Build the list of files we'll check for syntax errors
  51          */
  52         private function buildFileList() {
  53                 global $IP;
  54
  55                 // Only check files in these directories.
  56                 // Don't just put $IP, because the recursive dir thingie goes into all subdirs
  57                 $dirs = array(
  58                         $IP . '/includes',
  59                         $IP . '/config',
  60                         $IP . '/languages',
  61                         $IP . '/maintenance',
  62                         $IP . '/skins',
  63                 );
  64                 if( $this->hasOption( 'with-extensions' ) ) {
  65                         $dirs[] = $IP . '/extensions';
  66                 }
  67
  68                 foreach( $dirs as $d ) {
  69                         $iterator = new RecursiveIteratorIterator(
  70                                 new RecursiveDirectoryIterator( $d ),
  71                                 RecursiveIteratorIterator::SELF_FIRST
  72                         );
  73                         foreach ( $iterator as $file ) {
  74                                 $ext = pathinfo( $file->getFilename(), PATHINFO_EXTENSION );
  75                                 if ( $ext == 'php' || $ext == 'inc' || $ext == 'php5' ) {
  76                                         $this->mFiles[] = $file->getRealPath();
  77                                 }
  78                         }
  79                 }
  80         }
  81
  82         /**
  83          * Check the files for syntax errors
  84          * @return boolean
  85          */
  86         private function checkSyntax() {
  87                 foreach( $this->mFiles as $f ) {
  88                         $res = exec( 'php -l ' . $f );
  89                         if( strpos( $res, 'No syntax errors detected' ) === false ) {
  90                                 $this->mFailures[] = $f;
  91                                 $this->error( $res . "\n" );
  92                         }
  93                 }
  94                 $this->output( count($this->mFiles) . " files checked, "
  95                         . count($this->mFailures) . " failures\n" );
  96         }
  97 }
  98
  99 $maintClass = "SyntaxChecker";
 100 require_once( DO_MAINTENANCE );