EditConstraintFactory.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

EditConstraintFactory.php
View Options

	<?php
	/**
	* 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
	*/

	namespace MediaWiki\EditPage\Constraint;

	use MediaWiki\Config\ServiceOptions;
	use MediaWiki\Content\Content;
	use MediaWiki\Context\IContextSource;
	use MediaWiki\EditPage\SpamChecker;
	use MediaWiki\HookContainer\HookContainer;
	use MediaWiki\Language\Language;
	use MediaWiki\Linker\LinkTarget;
	use MediaWiki\Logger\Spi;
	use MediaWiki\MainConfigNames;
	use MediaWiki\Permissions\PermissionManager;
	use MediaWiki\Permissions\RateLimiter;
	use MediaWiki\Permissions\RateLimitSubject;
	use MediaWiki\Title\Title;
	use MediaWiki\User\User;
	use MediaWiki\User\UserIdentity;
	use Wikimedia\Rdbms\ReadOnlyMode;

	/**
	* Constraints reflect possible errors that need to be checked
	*
	* @since 1.36
	* @internal
	* @author DannyS712
	*/
	class EditConstraintFactory {

	/** @internal */
	public const CONSTRUCTOR_OPTIONS = [
	// PageSizeConstraint
	MainConfigNames::MaxArticleSize,
	];

	private ServiceOptions $options;
	private Spi $loggerFactory;
	private PermissionManager $permissionManager;
	private HookContainer $hookContainer;
	private ReadOnlyMode $readOnlyMode;
	private SpamChecker $spamRegexChecker;
	private RateLimiter $rateLimiter;

	/**
	* Some constraints have dependencies that need to be injected,
	* this class serves as a factory for all of the different constraints
	* that need dependencies injected.
	*
	* The checks in EditPage use wfDebugLog and logged to different channels, hence the need
	* for multiple loggers retrieved from the Spi. The channels used are:
	* - SimpleAntiSpam (in SimpleAntiSpamConstraint)
	* - SpamRegex (in SpamRegexConstraint)
	*
	* TODO can they be combined into the same channel?
	*
	* @param ServiceOptions $options
	* @param Spi $loggerFactory
	* @param PermissionManager $permissionManager
	* @param HookContainer $hookContainer
	* @param ReadOnlyMode $readOnlyMode
	* @param SpamChecker $spamRegexChecker
	* @param RateLimiter $rateLimiter
	*/
	public function __construct(
	ServiceOptions $options,
	Spi $loggerFactory,
	PermissionManager $permissionManager,
	HookContainer $hookContainer,
	ReadOnlyMode $readOnlyMode,
	SpamChecker $spamRegexChecker,
	RateLimiter $rateLimiter
	) {
	$options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );

	// Multiple
	$this->options = $options;
	$this->loggerFactory = $loggerFactory;

	// UserBlockConstraint
	$this->permissionManager = $permissionManager;

	// EditFilterMergedContentHookConstraint
	$this->hookContainer = $hookContainer;

	// ReadOnlyConstraint
	$this->readOnlyMode = $readOnlyMode;

	// SpamRegexConstraint
	$this->spamRegexChecker = $spamRegexChecker;

	// UserRateLimitConstraint
	$this->rateLimiter = $rateLimiter;
	}

	/**
	* @param Content $content
	* @param IContextSource $context
	* @param string $summary
	* @param bool $minorEdit
	* @param Language $language
	* @param User $user
	* @return EditFilterMergedContentHookConstraint
	*/
	public function newEditFilterMergedContentHookConstraint(
	Content $content,
	IContextSource $context,
	string $summary,
	bool $minorEdit,
	Language $language,
	User $user
	): EditFilterMergedContentHookConstraint {
	return new EditFilterMergedContentHookConstraint(
	$this->hookContainer,
	$content,
	$context,
	$summary,
	$minorEdit,
	$language,
	$user
	);
	}

	/**
	* @param int $contentSize
	* @param string $type
	* @return PageSizeConstraint
	*/
	public function newPageSizeConstraint(
	int $contentSize,
	string $type
	): PageSizeConstraint {
	return new PageSizeConstraint(
	$this->options->get( MainConfigNames::MaxArticleSize ),
	$contentSize,
	$type
	);
	}

	/**
	* @return ReadOnlyConstraint
	*/
	public function newReadOnlyConstraint(): ReadOnlyConstraint {
	return new ReadOnlyConstraint(
	$this->readOnlyMode
	);
	}

	/**
	* @param RateLimitSubject $subject
	* @param string $oldModel
	* @param string $newModel
	*
	* @return UserRateLimitConstraint
	*/
	public function newUserRateLimitConstraint(
	RateLimitSubject $subject,
	string $oldModel,
	string $newModel
	): UserRateLimitConstraint {
	return new UserRateLimitConstraint(
	$this->rateLimiter,
	$subject,
	$oldModel,
	$newModel
	);
	}

	/**
	* @param string $input
	* @param UserIdentity $user
	* @param Title $title
	* @return SimpleAntiSpamConstraint
	*/
	public function newSimpleAntiSpamConstraint(
	string $input,
	UserIdentity $user,
	Title $title
	): SimpleAntiSpamConstraint {
	return new SimpleAntiSpamConstraint(
	$this->loggerFactory->getLogger( 'SimpleAntiSpam' ),
	$input,
	$user,
	$title
	);
	}

	/**
	* @param string $summary
	* @param ?string $sectionHeading
	* @param string $text
	* @param string $reqIP
	* @param Title $title
	* @return SpamRegexConstraint
	*/
	public function newSpamRegexConstraint(
	string $summary,
	?string $sectionHeading,
	string $text,
	string $reqIP,
	Title $title
	): SpamRegexConstraint {
	return new SpamRegexConstraint(
	$this->loggerFactory->getLogger( 'SpamRegex' ),
	$this->spamRegexChecker,
	$summary,
	$sectionHeading,
	$text,
	$reqIP,
	$title
	);
	}

	/**
	* @param LinkTarget $title
	* @param User $user
	* @return UserBlockConstraint
	*/
	public function newUserBlockConstraint(
	LinkTarget $title,
	User $user
	): UserBlockConstraint {
	return new UserBlockConstraint(
	$this->permissionManager,
	$title,
	$user
	);
	}

	/**
	* @param User $performer
	* @param Title $title
	* @param bool $new
	* @return EditRightConstraint
	*/
	public function newEditRightConstraint(
	User $performer,
	Title $title,
	bool $new
	): EditRightConstraint {
	return new EditRightConstraint(
	$performer,
	$this->permissionManager,
	$title,
	$new
	);
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sat, May 16, 20:01 (2 h, 56 m)
Storage Engine: local-disk
Storage Format: Raw Data
Storage Handle: 0e/05/dc503441bb3a0a383c3355bc6cba
Default Alt Text: EditConstraintFactory.php (6 KB)

EditConstraintFactory.phpNo OneTemporaryActions

EditConstraintFactory.phpView Options

File Metadata

Event Timeline

EditConstraintFactory.php
No OneTemporary
Actions

EditConstraintFactory.php
View Options