MediaWiki 1.14.0

[autoinstallsdev/mediawiki.git] / maintenance / findhooks.php

diff --git a/maintenance/findhooks.php b/maintenance/findhooks.php
index 284e790668344000d486e5f3e7853e5b134c286c..d7cad253c642705af042f5e444188e157ffe1cab 100644 (file)
--- a/maintenance/findhooks.php
+++ b/maintenance/findhooks.php
@@ -7,7 +7,13 @@
  * - hooks names in hooks.txt are at the beginning of a line and single quoted.
  * - hooks names in code are the first parameter of wfRunHooks.
  *
- * @addtogroup Maintenance
+ * if --online option is passed, the script will compare the hooks in the code
+ * with the ones at http://www.mediawiki.org/wiki/Manual:Hooks
+ *
+ * Any instance of wfRunHooks that doesn't meet these parameters will be noted.
+ *
+ * @file
+ * @ingroup Maintenance
  *
  * @author Ashar Voultoiz <hashar@altern.org>
  * @copyright Copyright © Ashar voultoiz
@@ -17,12 +23,22 @@
 /** This is a command line script*/
 include('commandLine.inc');
 
-
 # GLOBALS
 
 $doc = $IP . '/docs/hooks.txt';
-$pathinc = $IP . '/includes/';
-
+$pathinc = array(
+       $IP.'/',
+       $IP.'/includes/',
+       $IP.'/includes/api/',
+       $IP.'/includes/db/',
+       $IP.'/includes/diff/',
+       $IP.'/includes/filerepo/',
+       $IP.'/includes/parser/',
+       $IP.'/includes/specials/',
+       $IP.'/languages/',
+       $IP.'/maintenance/',
+       $IP.'/skins/',
+);
 
 # FUNCTIONS
 
@@ -30,23 +46,28 @@ $pathinc = $IP . '/includes/';
  * @return array of documented hooks
  */
 function getHooksFromDoc() {
-       global $doc;
-       $content = file_get_contents( $doc );
+       global $doc, $options;
        $m = array();
-       preg_match_all( "/\n'(.*?)'/", $content, $m);
-       return $m[1];
+       if( isset( $options['online'] ) ){
+               $content = Http::get( 'http://www.mediawiki.org/w/index.php?title=Manual:Hooks&action=raw' );
+               preg_match_all( '/\[\[\/([a-zA-Z0-9-_:]+)\|/', $content, $m );
+       } else {
+               $content = file_get_contents( $doc );
+               preg_match_all( "/\n'(.*?)'/", $content, $m );
+       }
+       return array_unique( $m[1] );
 }
 
 /**
- * Get hooks from a php file
+ * Get hooks from a PHP file
  * @param $file Full filename to the PHP file.
  * @return array of hooks found.
  */
 function getHooksFromFile( $file ) {
        $content = file_get_contents( $file );
        $m = array();
-       preg_match_all( "/wfRunHooks\(\s*\'(.*?)\'/", $content, $m);
-       return $m[1];
+       preg_match_all( '/wfRunHooks\(\s*([\'"])(.*?)\1/', $content, $m);
+       return $m[2];
 }
 
 /**
@@ -67,6 +88,42 @@ function getHooksFromPath( $path ) {
        return $hooks;
 }
 
+/**
+ * Get bad hooks (where the hook name could not be determined) from a PHP file
+ * @param $file Full filename to the PHP file.
+ * @return array of bad wfRunHooks() lines
+ */
+function getBadHooksFromFile( $file ) {
+       $content = file_get_contents( $file );
+       $m = array();
+       # We want to skip the "function wfRunHooks()" one.  :)
+       preg_match_all( '/(?<!function )wfRunHooks\(\s*[^\s\'"].*/', $content, $m);
+       $list = array();
+       foreach( $m[0] as $match ){
+               $list[] = $match . "(" . $file . ")";
+       }
+       return $list;
+}
+
+/**
+ * Get bad hooks from the source code.
+ * @param $path Directory where the include files can be found
+ * @return array of bad wfRunHooks() lines
+ */
+function getBadHooksFromPath( $path ) {
+       $hooks = array();
+       if( $dh = opendir($path) ) {
+               while(($file = readdir($dh)) !== false) {
+                       # We don't want to read this file as it contains bad calls to wfRunHooks()
+                       if( filetype( $path.$file ) == 'file' && !$path.$file == __FILE__ ) {
+                               $hooks = array_merge( $hooks, getBadHooksFromFile($path.$file) );
+                       }
+               }
+               closedir($dh);
+       }
+       return $hooks;
+}
+
 /**
  * Nicely output the array
  * @param $msg A message to show before the value
@@ -75,20 +132,28 @@ function getHooksFromPath( $path ) {
  */
 function printArray( $msg, $arr, $sort = true ) {
        if($sort) asort($arr); 
-       foreach($arr as $v) print "$msg: $v\n";
+       foreach($arr as $v) echo "$msg: $v\n";
 }
 
-
-# MAIN
+# MAIN
 
 $documented = getHooksFromDoc($doc);
-$potential = getHooksFromPath($pathinc);
+$potential = array();
+$bad = array();
+foreach( $pathinc as $dir ) {
+       $potential = array_merge( $potential, getHooksFromPath( $dir ) );
+       $bad = array_merge( $bad, getBadHooksFromPath( $dir ) );
+}
 
-$todo = array_diff($potential, $documented);
-$deprecated = array_diff($documented, $potential);
+$potential = array_unique( $potential );
+$bad = array_unique( $bad );
+$todo = array_diff( $potential, $documented );
+$deprecated = array_diff( $documented, $potential );
 
 // let's show the results:
 printArray('undocumented', $todo );
 printArray('not found', $deprecated );
-
-
+printArray('unclear hook calls', $bad );
+ 
+if ( count( $todo ) == 0 && count( $deprecated ) == 0 && count( $bad ) == 0 ) 
+       echo "Looks good!\n";
\ No newline at end of file