Localisation updates from https://translatewiki.net.
[mediawiki.git] / includes / api / ApiProtect.php
blobae7d42b2d0fdd8549923a61bab3f1dce26aebf5e
1 <?php
2 /**
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
24 * @file
27 /**
28 * @ingroup API
30 class ApiProtect extends ApiBase {
31 public function execute() {
32 $params = $this->extractRequestParams();
34 $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
35 $titleObj = $pageObj->getTitle();
37 $errors = $titleObj->getUserPermissionsErrors( 'protect', $this->getUser() );
38 if ( $errors ) {
39 // We don't care about multiple errors, just report one of them
40 $this->dieUsageMsg( reset( $errors ) );
43 $expiry = (array)$params['expiry'];
44 if ( count( $expiry ) != count( $params['protections'] ) ) {
45 if ( count( $expiry ) == 1 ) {
46 $expiry = array_fill( 0, count( $params['protections'] ), $expiry[0] );
47 } else {
48 $this->dieUsageMsg( array(
49 'toofewexpiries',
50 count( $expiry ),
51 count( $params['protections'] )
52 ) );
56 $restrictionTypes = $titleObj->getRestrictionTypes();
57 $db = $this->getDB();
59 $protections = array();
60 $expiryarray = array();
61 $resultProtections = array();
62 foreach ( $params['protections'] as $i => $prot ) {
63 $p = explode( '=', $prot );
64 $protections[$p[0]] = ( $p[1] == 'all' ? '' : $p[1] );
66 if ( $titleObj->exists() && $p[0] == 'create' ) {
67 $this->dieUsageMsg( 'create-titleexists' );
69 if ( !$titleObj->exists() && $p[0] != 'create' ) {
70 $this->dieUsageMsg( 'missingtitle-createonly' );
73 if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
74 $this->dieUsageMsg( array( 'protect-invalidaction', $p[0] ) );
76 if ( !in_array( $p[1], $this->getConfig()->get( 'RestrictionLevels' ) ) && $p[1] != 'all' ) {
77 $this->dieUsageMsg( array( 'protect-invalidlevel', $p[1] ) );
80 if ( in_array( $expiry[$i], array( 'infinite', 'indefinite', 'infinity', 'never' ) ) ) {
81 $expiryarray[$p[0]] = $db->getInfinity();
82 } else {
83 $exp = strtotime( $expiry[$i] );
84 if ( $exp < 0 || !$exp ) {
85 $this->dieUsageMsg( array( 'invalidexpiry', $expiry[$i] ) );
88 $exp = wfTimestamp( TS_MW, $exp );
89 if ( $exp < wfTimestampNow() ) {
90 $this->dieUsageMsg( array( 'pastexpiry', $expiry[$i] ) );
92 $expiryarray[$p[0]] = $exp;
94 $resultProtections[] = array(
95 $p[0] => $protections[$p[0]],
96 'expiry' => ( $expiryarray[$p[0]] == $db->getInfinity()
97 ? 'infinite'
98 : wfTimestamp( TS_ISO_8601, $expiryarray[$p[0]] )
103 $cascade = $params['cascade'];
105 if ( $params['watch'] ) {
106 $this->logFeatureUsage( 'action=protect&watch' );
108 $watch = $params['watch'] ? 'watch' : $params['watchlist'];
109 $this->setWatch( $watch, $titleObj, 'watchdefault' );
111 $status = $pageObj->doUpdateRestrictions(
112 $protections,
113 $expiryarray,
114 $cascade,
115 $params['reason'],
116 $this->getUser()
119 if ( !$status->isOK() ) {
120 $this->dieStatus( $status );
122 $res = array(
123 'title' => $titleObj->getPrefixedText(),
124 'reason' => $params['reason']
126 if ( $cascade ) {
127 $res['cascade'] = '';
129 $res['protections'] = $resultProtections;
130 $result = $this->getResult();
131 $result->setIndexedTagName( $res['protections'], 'protection' );
132 $result->addValue( null, $this->getModuleName(), $res );
135 public function mustBePosted() {
136 return true;
139 public function isWriteMode() {
140 return true;
143 public function getAllowedParams() {
144 return array(
145 'title' => array(
146 ApiBase::PARAM_TYPE => 'string',
148 'pageid' => array(
149 ApiBase::PARAM_TYPE => 'integer',
151 'protections' => array(
152 ApiBase::PARAM_ISMULTI => true,
153 ApiBase::PARAM_REQUIRED => true,
155 'expiry' => array(
156 ApiBase::PARAM_ISMULTI => true,
157 ApiBase::PARAM_ALLOW_DUPLICATES => true,
158 ApiBase::PARAM_DFLT => 'infinite',
160 'reason' => '',
161 'cascade' => false,
162 'watch' => array(
163 ApiBase::PARAM_DFLT => false,
164 ApiBase::PARAM_DEPRECATED => true,
166 'watchlist' => array(
167 ApiBase::PARAM_DFLT => 'preferences',
168 ApiBase::PARAM_TYPE => array(
169 'watch',
170 'unwatch',
171 'preferences',
172 'nochange'
178 public function needsToken() {
179 return 'csrf';
182 protected function getExamplesMessages() {
183 return array(
184 'action=protect&title=Main%20Page&token=123ABC&' .
185 'protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never'
186 => 'apihelp-protect-example-protect',
187 'action=protect&title=Main%20Page&token=123ABC&' .
188 'protections=edit=all|move=all&reason=Lifting%20restrictions'
189 => 'apihelp-protect-example-unprotect',
190 'action=protect&title=Main%20Page&token=123ABC&' .
191 'protections=&reason=Lifting%20restrictions'
192 => 'apihelp-protect-example-unprotect2',
196 public function getHelpUrls() {
197 return 'https://www.mediawiki.org/wiki/API:Protect';