Page MenuHomeWickedGov Phorge
Files F2752455

PageSizeConstraint.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

PageSizeConstraint.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 InvalidArgumentException;
use StatusValue;
/**
* Verify the page isn't larger than the maximum
*
* This is used for both checking the size //before// merging the edit, and checking the size
* //after// applying the edit, and the result codes they return are different.
*
* @since 1.36
* @internal
* @author DannyS712
*/
class PageSizeConstraint implements IEditConstraint {
/**
* Same constraint is used for two different errors, use these
* to specify which one should be used
*/
public const BEFORE_MERGE = 'check-before-edit-merge';
public const AFTER_MERGE = 'check-after-edit-merge';
private int $contentSize;
private int $maxSize;
private int $errorCode;
private string $type;
/**
* @param int $maxSize In kibibytes, from $wgMaxArticleSize
* @param int $contentSize
* @param string $type
*/
public function __construct(
int $maxSize,
int $contentSize,
string $type
) {
$this->maxSize = $maxSize * 1024; // Convert from kibibytes
$this->contentSize = $contentSize;
if ( $type === self::BEFORE_MERGE ) {
$this->errorCode = self::AS_CONTENT_TOO_BIG;
} elseif ( $type === self::AFTER_MERGE ) {
$this->errorCode = self::AS_MAX_ARTICLE_SIZE_EXCEEDED;
} else {
throw new InvalidArgumentException( "Invalid type: $type" );
}
$this->type = $type;
}
public function checkConstraint(): string {
return $this->contentSize > $this->maxSize ?
self::CONSTRAINT_FAILED :
self::CONSTRAINT_PASSED;
}
public function getLegacyStatus(): StatusValue {
$statusValue = StatusValue::newGood();
if ( $this->contentSize > $this->maxSize ) {
// Either self::AS_CONTENT_TOO_BIG, if it was too big before merging,
// or self::AS_MAX_ARTICLE_SIZE_EXCEEDED, if it was too big after merging
$statusValue->setResult( false, $this->errorCode );
}
return $statusValue;
}
/**
* Get the type, so that the two different uses of this constraint can be told
* apart in debug logs.
* @internal
* @codeCoverageIgnore
* @return string
*/
public function getType(): string {
return $this->type;
}
}

File Metadata

Mime Type
text/x-php
Expires
Fri, Jul 3, 20:01 (1 d, 6 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ea/e2/fb1ec7a289812f45b0c8d143fda5
Default Alt Text
PageSizeConstraint.php (2 KB)

Event Timeline