Page MenuHomeWickedGov Phorge
Files F4136332

Warn.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

Warn.php
View Options

<?php
namespace MediaWiki\Extension\AbuseFilter\Consequences\Consequence;
use MediaWiki\Extension\AbuseFilter\Consequences\ConsequenceNotPrecheckedException;
use MediaWiki\Extension\AbuseFilter\Consequences\Parameters;
use MediaWiki\Extension\AbuseFilter\GlobalNameUtils;
use MediaWiki\Session\Session;
/**
* Consequence that warns the user once, allowing the action on the second attempt.
*/
class Warn extends Consequence implements HookAborterConsequence, ConsequencesDisablerConsequence {
/** @var Session */
private $session;
/** @var string */
private $message;
/** @var bool|null */
private $shouldWarn;
/**
* @param Parameters $parameters
* @param string $message
* @param Session $session
*/
public function __construct( Parameters $parameters, string $message, Session $session ) {
parent::__construct( $parameters );
$this->message = $message;
$this->session = $session;
}
/**
* @return bool Whether the user should be warned (i.e. this is the first attempt)
* @throws ConsequenceNotPrecheckedException
*/
public function execute(): bool {
if ( $this->shouldWarn === null ) {
throw new ConsequenceNotPrecheckedException();
}
$this->setWarn();
return $this->shouldWarn;
}
/**
* @inheritDoc
*/
public function shouldDisableOtherConsequences(): bool {
$this->shouldWarn = $this->shouldBeWarned();
return $this->shouldWarn;
}
/**
* @inheritDoc
*/
public function getSort(): int {
return 5;
}
/**
* @inheritDoc
*/
public function getMessage(): array {
$filter = $this->parameters->getFilter();
return [
$this->message,
$filter->getName(),
GlobalNameUtils::buildGlobalName( $filter->getID(), $this->parameters->getIsGlobalFilter() )
];
}
/**
* @return bool
*/
private function shouldBeWarned(): bool {
// Make sure the session is started prior to using it
$this->session->persist();
$warnKey = $this->getWarnKey();
return ( !isset( $this->session[$warnKey] ) || !$this->session[$warnKey] );
}
/**
* Sets the parameters needed to warn the user, *without* checking if the user should be warned.
*/
private function setWarn(): void {
$warnKey = $this->getWarnKey();
$this->session[$warnKey] = $this->shouldWarn;
}
/**
* Generate a unique key to determine whether the user has already been warned.
* We'll warn again if one of these changes: session, page, triggered filter, or action
* @return string
*/
private function getWarnKey(): string {
$globalFilterName = GlobalNameUtils::buildGlobalName(
$this->parameters->getFilter()->getID(),
$this->parameters->getIsGlobalFilter()
);
$target = $this->parameters->getTarget();
$titleText = $target->getNamespace() . ':' . $target->getText();
return 'abusefilter-warned-' . md5( $titleText ) .
'-' . $globalFilterName . '-' . $this->parameters->getAction();
}
}

File Metadata

Mime Type
text/x-php
Expires
Wed, Aug 19, 13:38 (3 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
e7/9b/6bfb6a09a37ea6dcd4d80ebbff9f
Default Alt Text
Warn.php (2 KB)

Event Timeline