Hooks.php
No OneTemporary
Actions

Size

10 KB

Referenced Files

None

Subscribers

None

Hooks.php
View Options

	<?php

	// phpcs:disable MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName

	namespace MediaWiki\Extension\ConfirmEdit;

	use MailAddress;
	use MediaWiki\Api\ApiBase;
	use MediaWiki\Api\Hook\APIGetAllowedParamsHook;
	use MediaWiki\Content\Content;
	use MediaWiki\Context\IContextSource;
	use MediaWiki\EditPage\EditPage;
	use MediaWiki\Extension\ConfirmEdit\SimpleCaptcha\SimpleCaptcha;
	use MediaWiki\Hook\AlternateEditPreviewHook;
	use MediaWiki\Hook\EditFilterMergedContentHook;
	use MediaWiki\Hook\EditPage__showEditForm_fieldsHook;
	use MediaWiki\Hook\EditPageBeforeEditButtonsHook;
	use MediaWiki\Hook\EmailUserFormHook;
	use MediaWiki\Hook\EmailUserHook;
	use MediaWiki\Html\Html;
	use MediaWiki\HTMLForm\HTMLForm;
	use MediaWiki\Output\OutputPage;
	use MediaWiki\Parser\ParserOutput;
	use MediaWiki\Permissions\Hook\TitleReadWhitelistHook;
	use MediaWiki\Registration\ExtensionRegistry;
	use MediaWiki\ResourceLoader\Hook\ResourceLoaderRegisterModulesHook;
	use MediaWiki\ResourceLoader\ResourceLoader;
	use MediaWiki\Revision\RevisionRecord;
	use MediaWiki\SpecialPage\Hook\AuthChangeFormFieldsHook;
	use MediaWiki\SpecialPage\SpecialPage;
	use MediaWiki\Status\Status;
	use MediaWiki\Storage\EditResult;
	use MediaWiki\Storage\Hook\PageSaveCompleteHook;
	use MediaWiki\Title\Title;
	use MediaWiki\User\User;
	use MediaWiki\User\UserIdentity;
	use Wikimedia\IPUtils;
	use Wikimedia\Message\MessageSpecifier;
	use Wikimedia\ObjectCache\WANObjectCache;
	use WikiPage;

	class Hooks implements
	AlternateEditPreviewHook,
	EditPageBeforeEditButtonsHook,
	EmailUserFormHook,
	EmailUserHook,
	TitleReadWhitelistHook,
	ResourceLoaderRegisterModulesHook,
	PageSaveCompleteHook,
	EditPage__showEditForm_fieldsHook,
	EditFilterMergedContentHook,
	APIGetAllowedParamsHook,
	AuthChangeFormFieldsHook
	{

	/** @var bool */
	protected static $instanceCreated = false;

	private WANObjectCache $cache;

	public function __construct(
	WANObjectCache $cache
	) {
	$this->cache = $cache;
	}

	/**
	* Get the global Captcha instance
	*
	* @return SimpleCaptcha
	*/
	public static function getInstance() {
	global $wgCaptcha, $wgCaptchaClass;

	if ( !static::$instanceCreated ) {
	static::$instanceCreated = true;
	$class = $wgCaptchaClass ?: SimpleCaptcha::class;
	$wgCaptcha = new $class;
	}

	return $wgCaptcha;
	}

	/**
	* @param IContextSource $context
	* @param Content $content
	* @param Status $status
	* @param string $summary
	* @param User $user
	* @param bool $minorEdit
	* @return bool
	*/
	public function onEditFilterMergedContent( IContextSource $context, Content $content, Status $status,
	$summary, User $user, $minorEdit
	) {
	$simpleCaptcha = self::getInstance();
	// Set a flag indicating that ConfirmEdit's implementation of
	// EditFilterMergedContent ran. This can be checked by other extensions
	// e.g. AbuseFilter.
	$simpleCaptcha->setEditFilterMergedContentHandlerInvoked();
	return $simpleCaptcha->confirmEditMerged( $context, $content, $status, $summary,
	$user, $minorEdit );
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/PageSaveComplete
	*
	* @param WikiPage $wikiPage
	* @param UserIdentity $user
	* @param string $summary
	* @param int $flags
	* @param RevisionRecord $revisionRecord
	* @param EditResult $editResult
	* @return bool\|void
	*/
	public function onPageSaveComplete(
	$wikiPage,
	$user,
	$summary,
	$flags,
	$revisionRecord,
	$editResult
	) {
	$title = $wikiPage->getTitle();
	if ( $title->getText() === 'Captcha-ip-whitelist' && $title->getNamespace() === NS_MEDIAWIKI ) {
	$this->cache->delete( $this->cache->makeKey( 'confirmedit', 'ipwhitelist' ) );
	}

	return true;
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/EditPageBeforeEditButtons
	*
	* @param EditPage $editpage Current EditPage object
	* @param array &$buttons Array of edit buttons, "Save", "Preview", "Live", and "Diff"
	* @param int &$tabindex HTML tabindex of the last edit check/button
	*/
	public function onEditPageBeforeEditButtons( $editpage, &$buttons, &$tabindex ) {
	self::getInstance()->editShowCaptcha( $editpage );
	}

	/**
	* @param EditPage $editPage
	* @param OutputPage $out
	*/
	public function onEditPage__showEditForm_fields( $editPage, $out ) {
	self::getInstance()->showEditFormFields( $editPage, $out );
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/EmailUserForm
	*
	* @param HTMLForm &$form HTMLForm object
	* @return bool\|void True or no return value to continue or false to abort
	*/
	public function onEmailUserForm( &$form ) {
	return self::getInstance()->injectEmailUser( $form );
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/EmailUser
	*
	* @param MailAddress &$to MailAddress object of receiving user
	* @param MailAddress &$from MailAddress object of sending user
	* @param string &$subject subject of the mail
	* @param string &$text text of the mail
	* @param bool\|Status\|MessageSpecifier\|array &$error Out-param for an error.
	* Should be set to a Status object or boolean false.
	* @return bool\|void True or no return value to continue or false to abort
	*/
	public function onEmailUser( &$to, &$from, &$subject, &$text, &$error ) {
	return self::getInstance()->confirmEmailUser( $from, $to, $subject, $text, $error );
	}

	/**
	* APIGetAllowedParams hook handler
	* Default $flags to 1 for backwards-compatible behavior
	* @param ApiBase $module
	* @param array &$params
	* @param int $flags
	* @return bool
	*/
	public function onAPIGetAllowedParams( $module, &$params, $flags ) {
	return self::getInstance()->apiGetAllowedParams( $module, $params, $flags );
	}

	/**
	* @param array $requests
	* @param array $fieldInfo
	* @param array &$formDescriptor
	* @param string $action
	*/
	public function onAuthChangeFormFields(
	$requests, $fieldInfo, &$formDescriptor, $action
	) {
	self::getInstance()->onAuthChangeFormFields( $requests, $fieldInfo, $formDescriptor, $action );
	}

	public static function confirmEditSetup() {
	global $wgCaptchaTriggers;

	// There is no need to run (core) tests with enabled ConfirmEdit - bug T44145
	if ( defined( 'MW_PHPUNIT_TEST' ) \|\| defined( 'MW_QUIBBLE_CI' ) ) {
	$wgCaptchaTriggers = array_fill_keys( array_keys( $wgCaptchaTriggers ), false );
	}
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/TitleReadWhitelist
	*
	* @param Title $title
	* @param User $user
	* @param bool &$whitelisted
	* @return bool\|void
	*/
	public function onTitleReadWhitelist( $title, $user, &$whitelisted ) {
	$image = SpecialPage::getTitleFor( 'Captcha', 'image' );
	$help = SpecialPage::getTitleFor( 'Captcha', 'help' );
	if ( $title->equals( $image ) \|\| $title->equals( $help ) ) {
	$whitelisted = true;
	}
	}

	/**
	*
	* Callback for extension.json of FancyCaptcha to set a default captcha directory,
	* which depends on wgUploadDirectory
	*/
	public static function onFancyCaptchaSetup() {
	global $wgCaptchaDirectory, $wgUploadDirectory;
	if ( !$wgCaptchaDirectory ) {
	$wgCaptchaDirectory = "$wgUploadDirectory/captcha";
	}
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/AlternateEditPreview
	*
	* @param EditPage $editPage
	* @param Content &$content
	* @param string &$previewHTML
	* @param ParserOutput &$parserOutput
	* @return bool\|void
	*/
	public function onAlternateEditPreview( $editPage, &$content, &$previewHTML,
	&$parserOutput
	) {
	$title = $editPage->getTitle();
	$exceptionTitle = Title::makeTitle( NS_MEDIAWIKI, 'Captcha-ip-whitelist' );

	if ( !$title->equals( $exceptionTitle ) ) {
	return true;
	}

	$ctx = $editPage->getArticle()->getContext();
	$out = $ctx->getOutput();
	$lang = $ctx->getLanguage();

	$lines = explode( "\n", $content->getNativeData() );
	$previewHTML .= Html::warningBox(
	$ctx->msg( 'confirmedit-preview-description' )->parse()
	) .
	Html::openElement(
	'table',
	[ 'class' => 'wikitable sortable' ]
	) .
	Html::openElement( 'thead' ) .
	Html::element( 'th', [], $ctx->msg( 'confirmedit-preview-line' )->text() ) .
	Html::element( 'th', [], $ctx->msg( 'confirmedit-preview-content' )->text() ) .
	Html::element( 'th', [], $ctx->msg( 'confirmedit-preview-validity' )->text() ) .
	Html::closeElement( 'thead' );

	foreach ( $lines as $count => $line ) {
	$ip = trim( $line );
	if ( $ip === '' \|\| strpos( $ip, '#' ) !== false ) {
	continue;
	}
	if ( IPUtils::isIPAddress( $ip ) ) {
	$validity = $ctx->msg( 'confirmedit-preview-valid' )->escaped();
	$css = 'valid';
	} else {
	$validity = $ctx->msg( 'confirmedit-preview-invalid' )->escaped();
	$css = 'notvalid';
	}
	$previewHTML .= Html::openElement( 'tr' ) .
	Html::element(
	'td',
	[],
	$lang->formatNum( $count + 1 )
	) .
	Html::element(
	'td',
	[],
	// IPv6 max length: 8 groups * 4 digits + 7 delimiter = 39
	// + 11 chars for safety
	$lang->truncateForVisual( $ip, 50 )
	) .
	Html::rawElement(
	'td',
	// possible values:
	// mw-confirmedit-ip-valid
	// mw-confirmedit-ip-notvalid
	[ 'class' => 'mw-confirmedit-ip-' . $css ],
	$validity
	) .
	Html::closeElement( 'tr' );
	}
	$previewHTML .= Html::closeElement( 'table' );
	$out->addModuleStyles( 'ext.confirmEdit.editPreview.ipwhitelist.styles' );

	return false;
	}

	/**
	* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderRegisterModules
	*
	* @param ResourceLoader $resourceLoader
	* @return void
	*/
	public function onResourceLoaderRegisterModules( ResourceLoader $resourceLoader ): void {
	$extensionRegistry = ExtensionRegistry::getInstance();
	$messages = [];

	$messages[] = 'colon-separator';
	$messages[] = 'captcha-edit';
	$messages[] = 'captcha-label';

	if ( $extensionRegistry->isLoaded( 'QuestyCaptcha' ) ) {
	$messages[] = 'questycaptcha-edit';
	}

	if ( $extensionRegistry->isLoaded( 'FancyCaptcha' ) ) {
	$messages[] = 'fancycaptcha-edit';
	$messages[] = 'fancycaptcha-reload-text';
	$messages[] = 'fancycaptcha-imgcaptcha-ph';
	}

	$resourceLoader->register( [
	'ext.confirmEdit.CaptchaInputWidget' => [
	'localBasePath' => dirname( __DIR__ ),
	'remoteExtPath' => 'ConfirmEdit',
	'scripts' => 'resources/libs/ext.confirmEdit.CaptchaInputWidget.js',
	'styles' => 'resources/libs/ext.confirmEdit.CaptchaInputWidget.less',
	'messages' => $messages,
	'dependencies' => 'oojs-ui-core',
	]
	] );
	}

	}

	class_alias( Hooks::class, 'ConfirmEditHooks' );

File Metadata

Mime Type: text/x-php
Expires: Sat, May 16, 14:21 (1 d, 9 h)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 8e/7e/62c0b1b70f8fd08cf3be3f339b37
Default Alt Text: Hooks.php (10 KB)

Hooks.phpNo OneTemporaryActions

Hooks.phpView Options

File Metadata

Event Timeline

Hooks.php
No OneTemporary
Actions

Hooks.php
View Options