%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
/**
* 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.
*
* 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 © Antoine Musso
*
* 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.
*
* 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 Antoine Musso <hashar at free dot fr>
*/
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script that compares documented and actually present mismatches.
*
* @ingroup Maintenance
*/
class FindHooks extends Maintenance {
/*
* Hooks that are ignored
*/
protected static $ignore = array( 'testRunLegacyHooks' );
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' );
}
public function getDbType() {
return Maintenance::DB_NONE;
}
public function execute() {
global $IP;
$documented = $this->getHooksFromDoc( $IP . '/docs/hooks.txt' );
$potential = array();
$bad = array();
// TODO: Don't hardcode the list of directories
$pathinc = array(
$IP . '/',
$IP . '/includes/',
$IP . '/includes/actions/',
$IP . '/includes/api/',
$IP . '/includes/cache/',
$IP . '/includes/changes/',
$IP . '/includes/clientpool/',
$IP . '/includes/content/',
$IP . '/includes/context/',
$IP . '/includes/dao/',
$IP . '/includes/db/',
$IP . '/includes/debug/',
$IP . '/includes/deferred/',
$IP . '/includes/diff/',
$IP . '/includes/externalstore/',
$IP . '/includes/filebackend/',
$IP . '/includes/filerepo/',
$IP . '/includes/filerepo/file/',
$IP . '/includes/gallery/',
$IP . '/includes/htmlform/',
$IP . '/includes/installer/',
$IP . '/includes/interwiki/',
$IP . '/includes/jobqueue/',
$IP . '/includes/json/',
$IP . '/includes/logging/',
$IP . '/includes/mail/',
$IP . '/includes/media/',
$IP . '/includes/page/',
$IP . '/includes/parser/',
$IP . '/includes/rcfeed/',
$IP . '/includes/resourceloader/',
$IP . '/includes/revisiondelete/',
$IP . '/includes/search/',
$IP . '/includes/site/',
$IP . '/includes/skins/',
$IP . '/includes/specialpage/',
$IP . '/includes/specials/',
$IP . '/includes/upload/',
$IP . '/includes/utils/',
$IP . '/languages/',
$IP . '/maintenance/',
$IP . '/maintenance/language/',
$IP . '/tests/',
$IP . '/tests/parser/',
$IP . '/tests/phpunit/suites/',
);
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 );
// let's show the results:
$this->printArray( 'Undocumented', $todo );
$this->printArray( 'Documented and not found', $deprecated );
$this->printArray( 'Unclear hook calls', $bad );
if ( count( $todo ) == 0 && count( $deprecated ) == 0 && count( $bad ) == 0 ) {
$this->output( "Looks good!\n" );
}
}
/**
* Get the hook documentation, either locally or from MediaWiki.org
* @param string $doc
* @return array Array of documented hooks
*/
private function getHooksFromDoc( $doc ) {
if ( $this->hasOption( 'online' ) ) {
return $this->getHooksFromOnlineDoc();
} else {
return $this->getHooksFromLocalDoc( $doc );
}
}
/**
* Get hooks from a local file (for example docs/hooks.txt)
* @param string $doc Filename to look in
* @return array Array of documented hooks
*/
private function getHooksFromLocalDoc( $doc ) {
$m = array();
$content = file_get_contents( $doc );
preg_match_all( "/\n'(.*?)':/", $content, $m );
return array_unique( $m[1] );
}
/**
* Get hooks from www.mediawiki.org using the API
* @return array Array of documented hooks
*/
private function getHooksFromOnlineDoc() {
$allhooks = $this->getHooksFromOnlineDocCategory( 'MediaWiki_hooks' );
$removed = $this->getHooksFromOnlineDocCategory( 'Removed_hooks' );
return array_diff( $allhooks, $removed );
}
/**
* @param string $title
* @return array
*/
private function getHooksFromOnlineDocCategory( $title ) {
$params = array(
'action' => 'query',
'list' => 'categorymembers',
'cmtitle' => "Category:$title",
'cmlimit' => 500,
'format' => 'json',
'continue' => '',
);
$retval = array();
while ( true ) {
$json = Http::get( wfAppendQuery( 'http://www.mediawiki.org/w/api.php', $params ), array(), __METHOD__ );
$data = FormatJson::decode( $json, true );
foreach ( $data['query']['categorymembers'] as $page ) {
if ( preg_match( '/Manual\:Hooks\/([a-zA-Z0-9- :]+)/', $page['title'], $m ) ) {
$retval[] = str_replace( ' ', '_', $m[1] );
}
}
if ( !isset( $data['continue'] ) ) {
return $retval;
}
$params = array_replace( $params, $data['continue'] );
}
}
/**
* Get hooks from a PHP file
* @param string $file Full filename to the PHP file.
* @return array Array of hooks found
*/
private function getHooksFromFile( $file ) {
$content = file_get_contents( $file );
$m = array();
preg_match_all(
'/(?:wfRunHooks|Hooks\:\:run|ContentHandler\:\:runLegacyHooks)\(\s*([\'"])(.*?)\1/',
$content,
$m
);
return $m[2];
}
/**
* Get hooks from the source code.
* @param string $path Directory where the include files can be found
* @return array 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;
}
/**
* Get bad hooks (where the hook name could not be determined) from a PHP file
* @param string $file Full filename to the PHP file.
* @return array 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;
}
/**
* Get bad hooks from the source code.
* @param string $path Directory where the include files can be found
* @return array 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 string $msg A message to show before the value
* @param array $arr
* @param bool $sort Whether to sort the array (Default: true)
*/
private function printArray( $msg, $arr, $sort = true ) {
if ( $sort ) {
asort( $arr );
}
foreach ( $arr as $v ) {
if ( !in_array( $v, self::$ignore ) ) {
$this->output( "$msg: $v\n" );
}
}
}
}
$maintClass = 'FindHooks';
require_once RUN_MAINTENANCE_IF_MAIN;
Zerion Mini Shell 1.0