Page MenuHomeWickedGov Phorge

LinkPurgeRateLimitConstraint.php
No OneTemporary

Size
2 KB
Referenced Files
None
Subscribers
None

LinkPurgeRateLimitConstraint.php

<?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\Permissions\RateLimiter;
use MediaWiki\Permissions\RateLimitSubject;
use StatusValue;
/**
* Verify that the user doesn't exceed 'linkpurge' limits, which are weird and special.
* Other rate limits have been integrated into their respective permission checks.
*
* @since 1.44
* @internal
* @author DannyS712
*/
class LinkPurgeRateLimitConstraint implements IEditConstraint {
private RateLimitSubject $subject;
private RateLimiter $limiter;
private string $result;
public function __construct(
RateLimiter $limiter,
RateLimitSubject $subject
) {
$this->limiter = $limiter;
$this->subject = $subject;
}
private function limit( string $action, int $inc = 1 ): bool {
return $this->limiter->limit( $this->subject, $action, $inc );
}
public function checkConstraint(): string {
// TODO inject and use a ThrottleStore once available, see T261744
// Checking if the user is rate limited increments the counts, so we cannot perform
// the check again when getting the status; thus, store the result
if ( $this->limit( 'linkpurge', /* only counted after the fact */ 0 ) ) {
$this->result = self::CONSTRAINT_FAILED;
} else {
$this->result = self::CONSTRAINT_PASSED;
}
return $this->result;
}
public function getLegacyStatus(): StatusValue {
$statusValue = StatusValue::newGood();
if ( $this->result === self::CONSTRAINT_FAILED ) {
$statusValue->fatal( 'actionthrottledtext' );
$statusValue->value = self::AS_RATE_LIMITED;
}
return $statusValue;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Nov 21, 22:49 (1 d, 22 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
28/a0/fc2f96052d7238d2ee848b330441
Default Alt Text
LinkPurgeRateLimitConstraint.php (2 KB)

Event Timeline