5 * Created on Sep 1, 2007
7 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
30 class ApiProtect
extends ApiBase
{
31 public function execute() {
34 $params = $this->extractRequestParams();
36 $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
37 $titleObj = $pageObj->getTitle();
39 $errors = $titleObj->getUserPermissionsErrors( 'protect', $this->getUser() );
41 // We don't care about multiple errors, just report one of them
42 $this->dieUsageMsg( reset( $errors ) );
45 $expiry = (array)$params['expiry'];
46 if ( count( $expiry ) != count( $params['protections'] ) ) {
47 if ( count( $expiry ) == 1 ) {
48 $expiry = array_fill( 0, count( $params['protections'] ), $expiry[0] );
50 $this->dieUsageMsg( array(
53 count( $params['protections'] )
58 $restrictionTypes = $titleObj->getRestrictionTypes();
61 $protections = array();
62 $expiryarray = array();
63 $resultProtections = array();
64 foreach ( $params['protections'] as $i => $prot ) {
65 $p = explode( '=', $prot );
66 $protections[$p[0]] = ( $p[1] == 'all' ?
'' : $p[1] );
68 if ( $titleObj->exists() && $p[0] == 'create' ) {
69 $this->dieUsageMsg( 'create-titleexists' );
71 if ( !$titleObj->exists() && $p[0] != 'create' ) {
72 $this->dieUsageMsg( 'missingtitle-createonly' );
75 if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
76 $this->dieUsageMsg( array( 'protect-invalidaction', $p[0] ) );
78 if ( !in_array( $p[1], $this->getConfig()->get( 'RestrictionLevels' ) ) && $p[1] != 'all' ) {
79 $this->dieUsageMsg( array( 'protect-invalidlevel', $p[1] ) );
82 if ( wfIsInfinity( $expiry[$i] ) ) {
83 $expiryarray[$p[0]] = 'infinity';
85 $exp = strtotime( $expiry[$i] );
86 if ( $exp < 0 ||
!$exp ) {
87 $this->dieUsageMsg( array( 'invalidexpiry', $expiry[$i] ) );
90 $exp = wfTimestamp( TS_MW
, $exp );
91 if ( $exp < wfTimestampNow() ) {
92 $this->dieUsageMsg( array( 'pastexpiry', $expiry[$i] ) );
94 $expiryarray[$p[0]] = $exp;
96 $resultProtections[] = array(
97 $p[0] => $protections[$p[0]],
98 'expiry' => $wgContLang->formatExpiry( $expiryarray[$p[0]], TS_ISO_8601
, 'infinite' ),
102 $cascade = $params['cascade'];
104 if ( $params['watch'] ) {
105 $this->logFeatureUsage( 'action=protect&watch' );
107 $watch = $params['watch'] ?
'watch' : $params['watchlist'];
108 $this->setWatch( $watch, $titleObj, 'watchdefault' );
110 $status = $pageObj->doUpdateRestrictions(
118 if ( !$status->isOK() ) {
119 $this->dieStatus( $status );
122 'title' => $titleObj->getPrefixedText(),
123 'reason' => $params['reason']
126 $res['cascade'] = true;
128 $res['protections'] = $resultProtections;
129 $result = $this->getResult();
130 ApiResult
::setIndexedTagName( $res['protections'], 'protection' );
131 $result->addValue( null, $this->getModuleName(), $res );
134 public function mustBePosted() {
138 public function isWriteMode() {
142 public function getAllowedParams() {
145 ApiBase
::PARAM_TYPE
=> 'string',
148 ApiBase
::PARAM_TYPE
=> 'integer',
150 'protections' => array(
151 ApiBase
::PARAM_ISMULTI
=> true,
152 ApiBase
::PARAM_REQUIRED
=> true,
155 ApiBase
::PARAM_ISMULTI
=> true,
156 ApiBase
::PARAM_ALLOW_DUPLICATES
=> true,
157 ApiBase
::PARAM_DFLT
=> 'infinite',
162 ApiBase
::PARAM_DFLT
=> false,
163 ApiBase
::PARAM_DEPRECATED
=> true,
165 'watchlist' => array(
166 ApiBase
::PARAM_DFLT
=> 'preferences',
167 ApiBase
::PARAM_TYPE
=> array(
177 public function needsToken() {
181 protected function getExamplesMessages() {
183 'action=protect&title=Main%20Page&token=123ABC&' .
184 'protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never'
185 => 'apihelp-protect-example-protect',
186 'action=protect&title=Main%20Page&token=123ABC&' .
187 'protections=edit=all|move=all&reason=Lifting%20restrictions'
188 => 'apihelp-protect-example-unprotect',
189 'action=protect&title=Main%20Page&token=123ABC&' .
190 'protections=&reason=Lifting%20restrictions'
191 => 'apihelp-protect-example-unprotect2',
195 public function getHelpUrls() {
196 return 'https://www.mediawiki.org/wiki/API:Protect';