Page MenuHomeWickedGov Phorge
Files F4118319

MediaWikiHooksHelper.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

MediaWikiHooksHelper.php
View Options

<?php
namespace SecurityCheckPlugin;
use Phan\CodeBase;
use Phan\Config;
use Phan\Language\FQSEN\FullyQualifiedClassName;
use Phan\Language\FQSEN\FullyQualifiedFunctionLikeName;
use Phan\Language\FQSEN\FullyQualifiedFunctionName;
use Phan\Language\FQSEN\FullyQualifiedMethodName;
/**
* 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.
*/
class MediaWikiHooksHelper {
/**
* @var bool Whether extension.json/skin.json was already loaded
*/
private $extensionJsonLoaded = false;
/**
* @var FullyQualifiedFunctionLikeName[][] A mapping from hook names to FQSEN that implement it
* @phan-var array<string,FullyQualifiedFunctionLikeName[]>
*/
private $hookSubscribers = [];
private ?FullyQualifiedClassName $parserFQSEN = null;
private ?FullyQualifiedClassName $ppFrameFQSEN = null;
/** @var self|null */
private static $instance;
/**
* @return self
*/
public static function getInstance(): self {
if ( !self::$instance ) {
self::$instance = new self;
}
return self::$instance;
}
/**
* Clear the extension.json cache, for testing purpose
*
* @suppress PhanUnreferencedPublicMethod
*/
public function clearCache(): void {
$this->extensionJsonLoaded = false;
}
/**
* Add a hook implementation to our list.
*
* This also handles parser hooks which aren't normal hooks.
* Non-normal hooks start their name with a "!"
*
* @param string $hookName Name of hook
* @param FullyQualifiedFunctionLikeName $fqsen The implementing method
* @return bool true if already registered, false otherwise
*/
public function registerHook( string $hookName, FullyQualifiedFunctionLikeName $fqsen ): bool {
if ( !isset( $this->hookSubscribers[$hookName] ) ) {
$this->hookSubscribers[$hookName] = [];
}
if ( in_array( $fqsen, $this->hookSubscribers[$hookName], true ) ) {
return true;
}
$this->hookSubscribers[$hookName][] = $fqsen;
return false;
}
/**
* Register hooks from extension.json/skin.json
*
* Assumes extension.json/skin.json is in project root directory
* unless SECURITY_CHECK_EXT_PATH is set
*/
protected function loadExtensionJson(): void {
if ( $this->extensionJsonLoaded ) {
return;
}
foreach ( [ 'extension.json', 'skin.json' ] as $filename ) {
$envPath = getenv( 'SECURITY_CHECK_EXT_PATH' );
if ( $envPath ) {
$jsonPath = $envPath . '/' . $filename;
} else {
$jsonPath = Config::projectPath( $filename );
}
if ( file_exists( $jsonPath ) ) {
$this->readJsonFile( $jsonPath );
}
}
$this->extensionJsonLoaded = true;
}
/**
* @param string $jsonPath
*/
private function readJsonFile( string $jsonPath ): void {
$json = json_decode( file_get_contents( $jsonPath ), true );
if ( !is_array( $json ) || !isset( $json['Hooks'] ) || !is_array( $json['Hooks'] ) ) {
return;
}
$namedHandlers = [];
foreach ( $json['HookHandlers'] ?? [] as $name => $handler ) {
// TODO: This key is not unique if more than one extension is being analyzed. Is that wanted, though?
$namedHandlers[$name] = $handler;
}
foreach ( $json['Hooks'] as $hookName => $cbList ) {
if ( isset( $cbList["handler"] ) ) {
$cbList = $cbList["handler"];
}
if ( is_string( $cbList ) ) {
$cbList = [ $cbList ];
}
foreach ( $cbList as $cb ) {
if ( isset( $namedHandlers[$cb] ) ) {
// TODO ObjectFactory not fully handled here. Would deserve some code in a general-purpose
// MediaWiki plugin, see T275742.
if ( isset( $namedHandlers[$cb]['class'] ) ) {
// Like core's HookContainer::run
$normalizedHookName = ucfirst( strtr( $hookName, ':-', '__' ) );
$callbackString = $namedHandlers[$cb]['class'] . "::on$normalizedHookName";
} elseif ( isset( $namedHandlers[$cb]['factory'] ) ) {
// TODO: We'd need a CodeBase to retrieve the factory method and check its return value
continue;
} else {
// @phan-suppress-previous-line PhanPluginDuplicateIfStatements
continue;
}
$callback = FullyQualifiedMethodName::fromFullyQualifiedString( $callbackString );
} elseif ( strpos( $cb, '::' ) === false ) {
$callback = FullyQualifiedFunctionName::fromFullyQualifiedString( $cb );
} else {
$callback = FullyQualifiedMethodName::fromFullyQualifiedString( $cb );
}
$this->registerHook( $hookName, $callback );
}
}
}
/**
* Get a list of subscribers for hook
*
* @param string $hookName Hook in question. Hooks starting with ! are special.
* @return FullyQualifiedFunctionLikeName[]
*/
public function getHookSubscribers( string $hookName ): array {
$this->loadExtensionJson();
return $this->hookSubscribers[$hookName] ?? [];
}
/**
* Is a particular function implementing a special hook.
*
* @note This assumes that any given func will only implement
* one hook
* @param FullyQualifiedFunctionLikeName $fqsen The function to check
* @return string|null The hook it is implementing or null if no hook
*/
public function isSpecialHookSubscriber( FullyQualifiedFunctionLikeName $fqsen ): ?string {
$this->loadExtensionJson();
$specialHooks = [
'!ParserFunctionHook',
'!ParserHook'
];
// @todo This is probably not the most efficient thing.
foreach ( $specialHooks as $hook ) {
if ( !isset( $this->hookSubscribers[$hook] ) ) {
continue;
}
if ( in_array( $fqsen, $this->hookSubscribers[$hook], true ) ) {
return $hook;
}
}
return null;
}
public function getMwParserClassFQSEN( CodeBase $codeBase ): FullyQualifiedClassName {
if ( !$this->parserFQSEN ) {
$namespacedFQSEN = FullyQualifiedClassName::fromFullyQualifiedString(
'\\MediaWiki\\Parser\\Parser'
);
if ( $codeBase->hasClassWithFQSEN( $namespacedFQSEN ) ) {
$this->parserFQSEN = $namespacedFQSEN;
} else {
$this->parserFQSEN = FullyQualifiedClassName::fromFullyQualifiedString(
'\\Parser'
);
}
}
return $this->parserFQSEN;
}
public function getPPFrameClassFQSEN( CodeBase $codeBase ): FullyQualifiedClassName {
if ( !$this->ppFrameFQSEN ) {
$namespacedFQSEN = FullyQualifiedClassName::fromFullyQualifiedString(
'\\MediaWiki\\Parser\\PPFrame'
);
if ( $codeBase->hasClassWithFQSEN( $namespacedFQSEN ) ) {
$this->ppFrameFQSEN = $namespacedFQSEN;
} else {
$this->ppFrameFQSEN = FullyQualifiedClassName::fromFullyQualifiedString(
'\\PPFrame'
);
}
}
return $this->ppFrameFQSEN;
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 02:43 (2 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
68/6f/4e4a69ea0e240d25a367090e7795
Default Alt Text
MediaWikiHooksHelper.php (6 KB)

Event Timeline