Page MenuHomeWickedGov Phorge
Files F5968137

ApiProtect.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

ApiProtect.php
View Options

<?php
/**
* Copyright © 2007 Roan Kattouw <roan.kattouw@gmail.com>
*
* 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\Api;
use ChangeTags;
use MediaWiki\MainConfigNames;
use MediaWiki\Permissions\RestrictionStore;
use MediaWiki\Title\Title;
use MediaWiki\User\Options\UserOptionsLookup;
use MediaWiki\Watchlist\WatchlistManager;
use Wikimedia\ParamValidator\ParamValidator;
/**
* @ingroup API
*/
class ApiProtect extends ApiBase {
use ApiWatchlistTrait;
private RestrictionStore $restrictionStore;
public function __construct(
ApiMain $mainModule,
string $moduleName,
WatchlistManager $watchlistManager,
UserOptionsLookup $userOptionsLookup,
RestrictionStore $restrictionStore
) {
parent::__construct( $mainModule, $moduleName );
$this->restrictionStore = $restrictionStore;
// Variables needed in ApiWatchlistTrait trait
$this->watchlistExpiryEnabled = $this->getConfig()->get( MainConfigNames::WatchlistExpiry );
$this->watchlistMaxDuration =
$this->getConfig()->get( MainConfigNames::WatchlistExpiryMaxDuration );
$this->watchlistManager = $watchlistManager;
$this->userOptionsLookup = $userOptionsLookup;
}
public function execute() {
$params = $this->extractRequestParams();
$pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
$titleObj = $pageObj->getTitle();
$this->getErrorFormatter()->setContextTitle( $titleObj );
$this->checkTitleUserPermissions( $titleObj, 'protect' );
$user = $this->getUser();
$tags = $params['tags'];
// Check if user can add tags
if ( $tags !== null ) {
$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $tags, $this->getAuthority() );
if ( !$ableToTag->isOK() ) {
$this->dieStatus( $ableToTag );
}
}
$expiry = (array)$params['expiry'];
if ( count( $expiry ) != count( $params['protections'] ) ) {
if ( count( $expiry ) == 1 ) {
$expiry = array_fill( 0, count( $params['protections'] ), $expiry[0] );
} else {
$this->dieWithError( [
'apierror-toofewexpiries',
count( $expiry ),
count( $params['protections'] )
] );
}
}
$restrictionTypes = $this->restrictionStore->listApplicableRestrictionTypes( $titleObj );
$levels = $this->getPermissionManager()->getNamespaceRestrictionLevels(
$titleObj->getNamespace(),
$user
);
$protections = [];
$expiryarray = [];
$resultProtections = [];
foreach ( $params['protections'] as $i => $prot ) {
$p = explode( '=', $prot );
$protections[$p[0]] = ( $p[1] == 'all' ? '' : $p[1] );
if ( $titleObj->exists() && $p[0] == 'create' ) {
$this->dieWithError( 'apierror-create-titleexists' );
}
if ( !$titleObj->exists() && $p[0] != 'create' ) {
$this->dieWithError( 'apierror-missingtitle-createonly' );
}
if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
$this->dieWithError( [ 'apierror-protect-invalidaction', wfEscapeWikiText( $p[0] ) ] );
}
if ( !in_array( $p[1], $levels ) && $p[1] != 'all' ) {
$this->dieWithError( [ 'apierror-protect-invalidlevel', wfEscapeWikiText( $p[1] ) ] );
}
if ( wfIsInfinity( $expiry[$i] ) ) {
$expiryarray[$p[0]] = 'infinity';
} else {
$exp = strtotime( $expiry[$i] );
if ( $exp < 0 || !$exp ) {
$this->dieWithError( [ 'apierror-invalidexpiry', wfEscapeWikiText( $expiry[$i] ) ] );
}
$exp = wfTimestamp( TS_MW, $exp );
if ( $exp < wfTimestampNow() ) {
$this->dieWithError( [ 'apierror-pastexpiry', wfEscapeWikiText( $expiry[$i] ) ] );
}
$expiryarray[$p[0]] = $exp;
}
$resultProtections[] = [
$p[0] => $protections[$p[0]],
'expiry' => ApiResult::formatExpiry( $expiryarray[$p[0]], 'infinite' ),
];
}
$cascade = $params['cascade'];
$watch = $params['watch'] ? 'watch' : $params['watchlist'];
$watchlistExpiry = $this->getExpiryFromParams( $params );
$this->setWatch( $watch, $titleObj, $user, 'watchdefault', $watchlistExpiry );
$status = $pageObj->doUpdateRestrictions(
$protections,
$expiryarray,
$cascade,
$params['reason'],
$user,
$tags ?? []
);
if ( !$status->isOK() ) {
$this->dieStatus( $status );
}
$res = [
'title' => $titleObj->getPrefixedText(),
'reason' => $params['reason']
];
if ( $cascade ) {
$res['cascade'] = true;
}
$res['protections'] = $resultProtections;
$result = $this->getResult();
ApiResult::setIndexedTagName( $res['protections'], 'protection' );
$result->addValue( null, $this->getModuleName(), $res );
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return [
'title' => [
ParamValidator::PARAM_TYPE => 'string',
],
'pageid' => [
ParamValidator::PARAM_TYPE => 'integer',
],
'protections' => [
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_REQUIRED => true,
],
'expiry' => [
ParamValidator::PARAM_ISMULTI => true,
ParamValidator::PARAM_ALLOW_DUPLICATES => true,
ParamValidator::PARAM_DEFAULT => 'infinite',
],
'reason' => '',
'tags' => [
ParamValidator::PARAM_TYPE => 'tags',
ParamValidator::PARAM_ISMULTI => true,
],
'cascade' => false,
'watch' => [
ParamValidator::PARAM_DEFAULT => false,
ParamValidator::PARAM_DEPRECATED => true,
],
] + $this->getWatchlistParams();
}
public function needsToken() {
return 'csrf';
}
protected function getExamplesMessages() {
$title = Title::newMainPage()->getPrefixedText();
$mp = rawurlencode( $title );
return [
"action=protect&title={$mp}&token=123ABC&" .
'protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never'
=> 'apihelp-protect-example-protect',
"action=protect&title={$mp}&token=123ABC&" .
'protections=edit=all|move=all&reason=Lifting%20restrictions'
=> 'apihelp-protect-example-unprotect',
"action=protect&title={$mp}&token=123ABC&" .
'protections=&reason=Lifting%20restrictions'
=> 'apihelp-protect-example-unprotect2',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protect';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiProtect::class, 'ApiProtect' );

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 12:51 (2 d, 8 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c6/8e/88c322842233cf20b8766e850424
Default Alt Text
ApiProtect.php (6 KB)

Event Timeline