/**
* Simple script that try to find documented hook and hooks actually
* in the code and show what's missing.
- *
+ *
* This script assumes that:
* - 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.
+ *
+ * Copyright © Ashar Voultoiz
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * @author Ashar Voultoiz <hashar@altern.org>
- * @copyright Copyright © Ashar voultoiz
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public Licence 2.0 or later
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Maintenance
+ * @author Ashar Voultoiz <hashar at free dot fr>
*/
-/** This is a command line script*/
-include('commandLine.inc');
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+class FindHooks extends Maintenance {
+ public function __construct() {
+ parent::__construct();
+ $this->mDescription = "Find hooks that are undocumented, missing, or just plain wrong";
+ $this->addOption( 'online', 'Check against mediawiki.org hook documentation' );
+ }
-# GLOBALS
+ public function getDbType() {
+ return Maintenance::DB_NONE;
+ }
-$doc = $IP . '/docs/hooks.txt';
-$pathinc = $IP . '/includes/';
+ public function execute() {
+ global $IP;
+
+ $documented = $this->getHooksFromDoc( $IP . '/docs/hooks.txt' );
+ $potential = array();
+ $bad = array();
+ $pathinc = array(
+ $IP . '/',
+ $IP . '/includes/',
+ $IP . '/includes/api/',
+ $IP . '/includes/db/',
+ $IP . '/includes/diff/',
+ $IP . '/includes/filerepo/',
+ $IP . '/includes/installer/',
+ $IP . '/includes/parser/',
+ $IP . '/includes/resourceloader/',
+ $IP . '/includes/revisiondelete/',
+ $IP . '/includes/search/',
+ $IP . '/includes/specials/',
+ $IP . '/includes/upload/',
+ $IP . '/languages/',
+ $IP . '/maintenance/',
+ $IP . '/maintenance/tests/',
+ $IP . '/maintenance/tests/parser/',
+ $IP . '/skins/',
+ );
+
+ foreach ( $pathinc as $dir ) {
+ $potential = array_merge( $potential, $this->getHooksFromPath( $dir ) );
+ $bad = array_merge( $bad, $this->getBadHooksFromPath( $dir ) );
+ }
+ $potential = array_unique( $potential );
+ $bad = array_unique( $bad );
+ $todo = array_diff( $potential, $documented );
+ $deprecated = array_diff( $documented, $potential );
-# FUNCTIONS
+ // let's show the results:
+ $this->printArray( 'Undocumented', $todo );
+ $this->printArray( 'Documented and not found', $deprecated );
+ $this->printArray( 'Unclear hook calls', $bad );
-/**
- * @return array of documented hooks
- */
-function getHooksFromDoc() {
- global $doc;
- $content = file_get_contents( $doc );
- $m = array();
- preg_match_all( "/\n'(.*?)'/", $content, $m);
- return $m[1];
-}
-
-/**
- * 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];
-}
+ if ( count( $todo ) == 0 && count( $deprecated ) == 0 && count( $bad ) == 0 )
+ $this->output( "Looks good!\n" );
+ }
-/**
- * Get hooks from the source code.
- * @param $path Directory where the include files can be found
- * @return array of hooks found.
- */
-function getHooksFromPath( $path ) {
- $hooks = array();
- if( $dh = opendir($path) ) {
- while(($file = readdir($dh)) !== false) {
- if( filetype($path.$file) == 'file' ) {
- $hooks = array_merge( $hooks, getHooksFromFile($path.$file) );
+ /**
+ * Get the hook documentation, either locally or from mediawiki.org
+ * @return array of documented hooks
+ */
+ private function getHooksFromDoc( $doc ) {
+ if ( $this->hasOption( 'online' ) ) {
+ // All hooks
+ $allhookdata = Http::get( 'http://www.mediawiki.org/w/api.php?action=query&list=categorymembers&cmtitle=Category:MediaWiki_hooks&cmlimit=500&format=php' );
+ $allhookdata = unserialize( $allhookdata );
+ $allhooks = array();
+ foreach ( $allhookdata['query']['categorymembers'] as $page ) {
+ $found = preg_match( '/Manual\:Hooks\/([a-zA-Z0-9- :]+)/', $page['title'], $matches );
+ if ( $found ) {
+ $hook = str_replace( ' ', '_', $matches[1] );
+ $allhooks[] = $hook;
+ }
}
+ // Removed hooks
+ $oldhookdata = Http::get( 'http://www.mediawiki.org/w/api.php?action=query&list=categorymembers&cmtitle=Category:Removed_hooks&cmlimit=500&format=php' );
+ $oldhookdata = unserialize( $oldhookdata );
+ $removed = array();
+ foreach ( $oldhookdata['query']['categorymembers'] as $page ) {
+ $found = preg_match( '/Manual\:Hooks\/([a-zA-Z0-9- :]+)/', $page['title'], $matches );
+ if ( $found ) {
+ $hook = str_replace( ' ', '_', $matches[1] );
+ $removed[] = $hook;
+ }
+ }
+ return array_diff( $allhooks, $removed );
+ } else {
+ $m = array();
+ $content = file_get_contents( $doc );
+ preg_match_all( "/\n'(.*?)'/", $content, $m );
+ return array_unique( $m[1] );
}
- closedir($dh);
}
- return $hooks;
-}
-/**
- * Nicely output the array
- * @param $msg A message to show before the value
- * @param $arr An array
- * @param $sort Boolean : wheter to sort the array (Default: true)
- */
-function printArray( $msg, $arr, $sort = true ) {
- if($sort) asort($arr);
- foreach($arr as $v) print "$msg: $v\n";
-}
-
-
-# MAIN
+ /**
+ * Get hooks from a PHP file
+ * @param $file Full filename to the PHP file.
+ * @return array of hooks found.
+ */
+ private function getHooksFromFile( $file ) {
+ $content = file_get_contents( $file );
+ $m = array();
+ preg_match_all( '/wfRunHooks\(\s*([\'"])(.*?)\1/', $content, $m );
+ return $m[2];
+ }
-$documented = getHooksFromDoc($doc);
-$potential = getHooksFromPath($pathinc);
+ /**
+ * Get hooks from the source code.
+ * @param $path Directory where the include files can be found
+ * @return array of hooks found.
+ */
+ private function getHooksFromPath( $path ) {
+ $hooks = array();
+ $dh = opendir( $path );
+ if ( $dh ) {
+ while ( ( $file = readdir( $dh ) ) !== false ) {
+ if ( filetype( $path . $file ) == 'file' ) {
+ $hooks = array_merge( $hooks, $this->getHooksFromFile( $path . $file ) );
+ }
+ }
+ closedir( $dh );
+ }
+ return $hooks;
+ }
-$todo = array_diff($potential, $documented);
-$deprecated = array_diff($documented, $potential);
+ /**
+ * 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
+ */
+ private 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;
+ }
-// let's show the results:
-printArray('undocumented', $todo );
-printArray('not found', $deprecated );
+ /**
+ * Get bad hooks from the source code.
+ * @param $path Directory where the include files can be found
+ * @return array of bad wfRunHooks() lines
+ */
+ private function getBadHooksFromPath( $path ) {
+ $hooks = array();
+ $dh = opendir( $path );
+ if ( $dh ) {
+ 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, $this->getBadHooksFromFile( $path . $file ) );
+ }
+ }
+ closedir( $dh );
+ }
+ return $hooks;
+ }
+ /**
+ * Nicely output the array
+ * @param $msg A message to show before the value
+ * @param $arr An array
+ * @param $sort Boolean : wheter to sort the array (Default: true)
+ */
+ private function printArray( $msg, $arr, $sort = true ) {
+ if ( $sort ) asort( $arr );
+ foreach ( $arr as $v ) $this->output( "$msg: $v\n" );
+ }
+}
+$maintClass = "FindHooks";
+require_once( RUN_MAINTENANCE_IF_MAIN );
scripts.mit.edu / autoinstalls / mediawiki.git / blobdiff