aboutsummaryrefslogtreecommitdiffstats
path: root/includes/editpage/Constraint/LinkPurgeRateLimitConstraint.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/editpage/Constraint/LinkPurgeRateLimitConstraint.php')
-rw-r--r--includes/editpage/Constraint/LinkPurgeRateLimitConstraint.php78
1 files changed, 78 insertions, 0 deletions
diff --git a/includes/editpage/Constraint/LinkPurgeRateLimitConstraint.php b/includes/editpage/Constraint/LinkPurgeRateLimitConstraint.php
new file mode 100644
index 000000000000..d25cf9336d88
--- /dev/null
+++ b/includes/editpage/Constraint/LinkPurgeRateLimitConstraint.php
@@ -0,0 +1,78 @@
+<?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;
+ }
+
+}