37require_once __DIR__ .
'/Maintenance.php';
54 parent::__construct();
55 $this->
addDescription(
'Find hooks that are undocumented, missing, or just plain wrong' );
56 $this->
addOption(
'online',
'Check against MediaWiki.org hook documentation' );
77 "$IP/tests/phpunit/suites",
83 "$IP/tests/phpunit/MediaWikiTestCase.php",
86 foreach ( $recurseDirs
as $dir ) {
88 $potentialHooks = array_merge( $potentialHooks,
$ret[
'good'] );
89 $badHooks = array_merge( $badHooks,
$ret[
'bad'] );
91 foreach ( $nonRecurseDirs
as $dir ) {
93 $potentialHooks = array_merge( $potentialHooks,
$ret[
'good'] );
94 $badHooks = array_merge( $badHooks,
$ret[
'bad'] );
96 foreach ( $extraFiles
as $file ) {
97 $potentialHooks = array_merge( $potentialHooks, $this->
getHooksFromFile( $file ) );
101 $documented = array_keys( $documentedHooks );
102 $potential = array_keys( $potentialHooks );
103 $potential = array_unique( $potential );
104 $badHooks = array_diff( array_unique( $badHooks ), self::$ignore );
105 $todo = array_diff( $potential, $documented, self::$ignore );
106 $deprecated = array_diff( $documented, $potential, self::$ignore );
109 $badParameterCount = $badParameterReference = [];
110 foreach ( $potentialHooks
as $hook =>
$args ) {
111 if ( !isset( $documentedHooks[$hook] ) ) {
115 $argsDoc = $documentedHooks[$hook];
116 if (
$args ===
'unknown' || $argsDoc ===
'unknown' ) {
120 if ( count( $argsDoc ) !== count(
$args ) ) {
121 $badParameterCount[] = $hook .
': Doc: ' . count( $argsDoc ) .
' vs. Code: ' . count(
$args );
124 foreach ( $argsDoc
as $index => $argDoc ) {
125 $arg =
$args[$index];
126 if ( ( $arg[0] ===
'&' ) !== ( $argDoc[0] ===
'&' ) ) {
127 $badParameterReference[] = $hook .
': References different: Doc: ' . $argDoc .
128 ' vs. Code: ' . $arg;
136 $this->
printArray(
'Documented and not found', $deprecated );
137 $this->
printArray(
'Unclear hook calls', $badHooks );
138 $this->
printArray(
'Different parameter count', $badParameterCount );
139 $this->
printArray(
'Different parameter reference', $badParameterReference );
141 if ( !$todo && !$deprecated && !$badHooks
142 && !$badParameterCount && !$badParameterReference
144 $this->
output(
"Looks good!\n" );
146 $this->
error(
'The script finished with errors.', 1 );
170 $content = file_get_contents( $doc );
172 "/\n'(.*?)':.*((?:\n.+)*)/",
180 foreach ( $m
as $match ) {
182 if ( isset( $match[2] ) ) {
184 if ( preg_match_all(
"/\n(&?\\$\w+):.+/", $match[2], $n ) ) {
188 $hooks[$match[1]] =
$args;
200 return array_diff_key( $allhooks, $removed );
210 'list' =>
'categorymembers',
211 'cmtitle' =>
"Category:$title",
224 $data = FormatJson::decode( $json,
true );
225 foreach ( $data[
'query'][
'categorymembers']
as $page ) {
226 if ( preg_match(
'/Manual\:Hooks\/([a-zA-Z0-9- :]+)/', $page[
'title'], $m ) ) {
228 $retval[str_replace(
' ',
'_', $m[1] )] =
'unknown';
231 if ( !isset( $data[
'continue'] ) ) {
244 $content = file_get_contents( $filePath );
248 '/(?:wfRunHooks|Hooks\:\:run)\s*\(\s*' .
254 '(?:\s*(?:array\s*\(|\[)' .
256 '((?:[^\(\)\[\]]|\((?-1)\)|\[(?-1)\])*)' .
266 foreach ( $m
as $match ) {
268 if ( isset( $match[4] ) ) {
270 if ( preg_match_all(
'/((?:[^,\(\)]|\([^\(\)]*\))+)/', $match[4], $n ) ) {
271 $args = array_map(
'trim', $n[1] );
275 } elseif ( isset( $match[3] ) ) {
281 $hooks[$match[2]] =
$args;
293 $content = file_get_contents( $filePath );
296 preg_match_all(
'/(?<!function )wfRunHooks\(\s*[^\s\'"].*/', $content, $m );
298 foreach ( $m[0]
as $match ) {
299 $list[] = $match .
"(" . $filePath .
")";
315 if ( $recurse === self::FIND_RECURSIVE ) {
316 $iterator =
new RecursiveIteratorIterator(
317 new RecursiveDirectoryIterator( $dir, RecursiveDirectoryIterator::SKIP_DOTS ),
318 RecursiveIteratorIterator::SELF_FIRST
321 $iterator =
new DirectoryIterator( $dir );
324 foreach ( $iterator
as $info ) {
326 if ( $info->isFile() && in_array( $info->getExtension(), [
'php',
'inc' ] )
328 && $info->getRealPath() !== __FILE__
330 $good = array_merge( $good, $this->
getHooksFromFile( $info->getRealPath() ) );
335 return [
'good' => $good,
'bad' => $bad ];
346 foreach ( $arr
as $v ) {
347 $this->
output(
"$msg: $v\n" );
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Maintenance script that compares documented and actually present mismatches.
printArray( $msg, $arr)
Nicely sort an print an array.
getHooksFromFile( $filePath)
Get hooks from a PHP file.
getBadHooksFromFile( $filePath)
Get bad hooks (where the hook name could not be determined) from a PHP file.
getHooksFromDoc( $doc)
Get the hook documentation, either locally or from MediaWiki.org.
getHooksFromOnlineDoc()
Get hooks from www.mediawiki.org using the API.
getHooksFromLocalDoc( $doc)
Get hooks from a local file (for example docs/hooks.txt)
getDbType()
Does the script need different DB access? By default, we give Maintenance scripts normal rights to th...
getHooksFromDir( $dir, $recurse=0)
Get hooks from a directory of PHP files.
execute()
Do the actual work.
__construct()
Default constructor.
getHooksFromOnlineDocCategory( $title)
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
const DB_NONE
Constants for DB access type.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
when a variable name is used in a it is silently declared as a new local masking the global
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
require_once RUN_MAINTENANCE_IF_MAIN