3 * Simple script that try to find documented hook and hooks actually
4 * in the code and show what's missing.
6 * This script assumes that:
7 * - hooks names in hooks.txt are at the beginning of a line and single quoted.
8 * - hooks names in code are the first parameter of wfRunHooks.
10 * if --online option is passed, the script will compare the hooks in the code
11 * with the ones at http://www.mediawiki.org/wiki/Manual:Hooks
13 * Any instance of wfRunHooks that doesn't meet these parameters will be noted.
15 * Copyright © Ashar Voultoiz
17 * This program is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation; either version 2 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License along
28 * with this program; if not, write to the Free Software Foundation, Inc.,
29 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30 * http://www.gnu.org/copyleft/gpl.html
33 * @ingroup Maintenance
34 * @author Ashar Voultoiz <hashar@altern.org>
37 require_once( dirname( __FILE__
) . '/Maintenance.php' );
39 class FindHooks
extends Maintenance
{
40 public function __construct() {
41 parent
::__construct();
42 $this->mDescription
= "Find hooks that are undocumented, missing, or just plain wrong";
43 $this->addOption( 'online', 'Check against mediawiki.org hook documentation' );
46 public function getDbType() {
47 return Maintenance
::DB_NONE
;
50 public function execute() {
53 $documented = $this->getHooksFromDoc( $IP . '/docs/hooks.txt' );
59 $IP . '/includes/api/',
60 $IP . '/includes/db/',
61 $IP . '/includes/diff/',
62 $IP . '/includes/filerepo/',
63 $IP . '/includes/parser/',
64 $IP . '/includes/search/',
65 $IP . '/includes/specials/',
66 $IP . '/includes/upload/',
68 $IP . '/maintenance/',
69 $IP . '/maintenance/tests/',
73 foreach ( $pathinc as $dir ) {
74 $potential = array_merge( $potential, $this->getHooksFromPath( $dir ) );
75 $bad = array_merge( $bad, $this->getBadHooksFromPath( $dir ) );
78 $potential = array_unique( $potential );
79 $bad = array_unique( $bad );
80 $todo = array_diff( $potential, $documented );
81 $deprecated = array_diff( $documented, $potential );
83 // let's show the results:
84 $this->printArray( 'Undocumented', $todo );
85 $this->printArray( 'Documented and not found', $deprecated );
86 $this->printArray( 'Unclear hook calls', $bad );
88 if ( count( $todo ) == 0 && count( $deprecated ) == 0 && count( $bad ) == 0 )
89 $this->output( "Looks good!\n" );
93 * Get the hook documentation, either locally or from mediawiki.org
94 * @return array of documented hooks
96 private function getHooksFromDoc( $doc ) {
97 if ( $this->hasOption( 'online' ) ) {
99 $allhookdata = Http
::get( 'http://www.mediawiki.org/w/api.php?action=query&list=categorymembers&cmtitle=Category:MediaWiki_hooks&cmlimit=500&format=php' );
100 $allhookdata = unserialize( $allhookdata );
102 foreach ( $allhookdata['query']['categorymembers'] as $page ) {
103 $found = preg_match( '/Manual\:Hooks\/([a-zA-Z0-9- :]+)/', $page['title'], $matches );
105 $hook = str_replace( ' ', '_', $matches[1] );
110 $oldhookdata = Http
::get( 'http://www.mediawiki.org/w/api.php?action=query&list=categorymembers&cmtitle=Category:Removed_hooks&cmlimit=500&format=php' );
111 $oldhookdata = unserialize( $oldhookdata );
113 foreach ( $oldhookdata['query']['categorymembers'] as $page ) {
114 $found = preg_match( '/Manual\:Hooks\/([a-zA-Z0-9- :]+)/', $page['title'], $matches );
116 $hook = str_replace( ' ', '_', $matches[1] );
120 return array_diff( $allhooks, $removed );
123 $content = file_get_contents( $doc );
124 preg_match_all( "/\n'(.*?)'/", $content, $m );
125 return array_unique( $m[1] );
130 * Get hooks from a PHP file
131 * @param $file Full filename to the PHP file.
132 * @return array of hooks found.
134 private function getHooksFromFile( $file ) {
135 $content = file_get_contents( $file );
137 preg_match_all( '/wfRunHooks\(\s*([\'"])(.*?)\1/', $content, $m );
142 * Get hooks from the source code.
143 * @param $path Directory where the include files can be found
144 * @return array of hooks found.
146 private function getHooksFromPath( $path ) {
148 if ( $dh = opendir( $path ) ) {
149 while ( ( $file = readdir( $dh ) ) !== false ) {
150 if ( filetype( $path . $file ) == 'file' ) {
151 $hooks = array_merge( $hooks, $this->getHooksFromFile( $path . $file ) );
160 * Get bad hooks (where the hook name could not be determined) from a PHP file
161 * @param $file Full filename to the PHP file.
162 * @return array of bad wfRunHooks() lines
164 private function getBadHooksFromFile( $file ) {
165 $content = file_get_contents( $file );
167 # We want to skip the "function wfRunHooks()" one. :)
168 preg_match_all( '/(?<!function )wfRunHooks\(\s*[^\s\'"].*/', $content, $m );
170 foreach ( $m[0] as $match ) {
171 $list[] = $match . "(" . $file . ")";
177 * Get bad hooks from the source code.
178 * @param $path Directory where the include files can be found
179 * @return array of bad wfRunHooks() lines
181 private function getBadHooksFromPath( $path ) {
183 if ( $dh = opendir( $path ) ) {
184 while ( ( $file = readdir( $dh ) ) !== false ) {
185 # We don't want to read this file as it contains bad calls to wfRunHooks()
186 if ( filetype( $path . $file ) == 'file' && !$path . $file == __FILE__
) {
187 $hooks = array_merge( $hooks, $this->getBadHooksFromFile( $path . $file ) );
196 * Nicely output the array
197 * @param $msg A message to show before the value
198 * @param $arr An array
199 * @param $sort Boolean : wheter to sort the array (Default: true)
201 private function printArray( $msg, $arr, $sort = true ) {
202 if ( $sort ) asort( $arr );
203 foreach ( $arr as $v ) $this->output( "$msg: $v\n" );
207 $maintClass = "FindHooks";
208 require_once( DO_MAINTENANCE
);