includes/api/ApiProtect.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Sep 1, 2007
   6  *
   7  * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   8  *
   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.
  13  *
  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.
  18  *
  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
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * @ingroup API
  29  */
  30 class ApiProtect extends ApiBase {
  31         public function execute() {
  32                 global $wgRestrictionLevels;
  33                 $params = $this->extractRequestParams();
  34
  35                 $pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
  36                 $titleObj = $pageObj->getTitle();
  37
  38                 $errors = $titleObj->getUserPermissionsErrors( 'protect', $this->getUser() );
  39                 if ( $errors ) {
  40                         // We don't care about multiple errors, just report one of them
  41                         $this->dieUsageMsg( reset( $errors ) );
  42                 }
  43
  44                 $expiry = (array)$params['expiry'];
  45                 if ( count( $expiry ) != count( $params['protections'] ) ) {
  46                         if ( count( $expiry ) == 1 ) {
  47                                 $expiry = array_fill( 0, count( $params['protections'] ), $expiry[0] );
  48                         } else {
  49                                 $this->dieUsageMsg( array(
  50                                         'toofewexpiries',
  51                                         count( $expiry ),
  52                                         count( $params['protections'] )
  53                                 ) );
  54                         }
  55                 }
  56
  57                 $restrictionTypes = $titleObj->getRestrictionTypes();
  58                 $db = $this->getDB();
  59
  60                 $protections = array();
  61                 $expiryarray = array();
  62                 $resultProtections = array();
  63                 foreach ( $params['protections'] as $i => $prot ) {
  64                         $p = explode( '=', $prot );
  65                         $protections[$p[0]] = ( $p[1] == 'all' ? '' : $p[1] );
  66
  67                         if ( $titleObj->exists() && $p[0] == 'create' ) {
  68                                 $this->dieUsageMsg( 'create-titleexists' );
  69                         }
  70                         if ( !$titleObj->exists() && $p[0] != 'create' ) {
  71                                 $this->dieUsageMsg( 'missingtitle-createonly' );
  72                         }
  73
  74                         if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
  75                                 $this->dieUsageMsg( array( 'protect-invalidaction', $p[0] ) );
  76                         }
  77                         if ( !in_array( $p[1], $wgRestrictionLevels ) && $p[1] != 'all' ) {
  78                                 $this->dieUsageMsg( array( 'protect-invalidlevel', $p[1] ) );
  79                         }
  80
  81                         if ( in_array( $expiry[$i], array( 'infinite', 'indefinite', 'never' ) ) ) {
  82                                 $expiryarray[$p[0]] = $db->getInfinity();
  83                         } else {
  84                                 $exp = strtotime( $expiry[$i] );
  85                                 if ( $exp < 0 || !$exp ) {
  86                                         $this->dieUsageMsg( array( 'invalidexpiry', $expiry[$i] ) );
  87                                 }
  88
  89                                 $exp = wfTimestamp( TS_MW, $exp );
  90                                 if ( $exp < wfTimestampNow() ) {
  91                                         $this->dieUsageMsg( array( 'pastexpiry', $expiry[$i] ) );
  92                                 }
  93                                 $expiryarray[$p[0]] = $exp;
  94                         }
  95                         $resultProtections[] = array(
  96                                 $p[0] => $protections[$p[0]],
  97                                 'expiry' => ( $expiryarray[$p[0]] == $db->getInfinity()
  98                                         ? 'infinite'
  99                                         : wfTimestamp( TS_ISO_8601, $expiryarray[$p[0]] )
 100                                 )
 101                         );
 102                 }
 103
 104                 $cascade = $params['cascade'];
 105
 106                 $watch = $params['watch'] ? 'watch' : $params['watchlist'];
 107                 $this->setWatch( $watch, $titleObj, 'watchdefault' );
 108
 109                 $status = $pageObj->doUpdateRestrictions(
 110                         $protections,
 111                         $expiryarray,
 112                         $cascade,
 113                         $params['reason'],
 114                         $this->getUser()
 115                 );
 116
 117                 if ( !$status->isOK() ) {
 118                         $this->dieStatus( $status );
 119                 }
 120                 $res = array(
 121                         'title' => $titleObj->getPrefixedText(),
 122                         'reason' => $params['reason']
 123                 );
 124                 if ( $cascade ) {
 125                         $res['cascade'] = '';
 126                 }
 127                 $res['protections'] = $resultProtections;
 128                 $result = $this->getResult();
 129                 $result->setIndexedTagName( $res['protections'], 'protection' );
 130                 $result->addValue( null, $this->getModuleName(), $res );
 131         }
 132
 133         public function mustBePosted() {
 134                 return true;
 135         }
 136
 137         public function isWriteMode() {
 138                 return true;
 139         }
 140
 141         public function getAllowedParams() {
 142                 return array(
 143                         'title' => array(
 144                                 ApiBase::PARAM_TYPE => 'string',
 145                         ),
 146                         'pageid' => array(
 147                                 ApiBase::PARAM_TYPE => 'integer',
 148                         ),
 149                         'token' => array(
 150                                 ApiBase::PARAM_TYPE => 'string',
 151                                 ApiBase::PARAM_REQUIRED => true
 152                         ),
 153                         'protections' => array(
 154                                 ApiBase::PARAM_ISMULTI => true,
 155                                 ApiBase::PARAM_REQUIRED => true,
 156                         ),
 157                         'expiry' => array(
 158                                 ApiBase::PARAM_ISMULTI => true,
 159                                 ApiBase::PARAM_ALLOW_DUPLICATES => true,
 160                                 ApiBase::PARAM_DFLT => 'infinite',
 161                         ),
 162                         'reason' => '',
 163                         'cascade' => false,
 164                         'watch' => array(
 165                                 ApiBase::PARAM_DFLT => false,
 166                                 ApiBase::PARAM_DEPRECATED => true,
 167                         ),
 168                         'watchlist' => array(
 169                                 ApiBase::PARAM_DFLT => 'preferences',
 170                                 ApiBase::PARAM_TYPE => array(
 171                                         'watch',
 172                                         'unwatch',
 173                                         'preferences',
 174                                         'nochange'
 175                                 ),
 176                         ),
 177                 );
 178         }
 179
 180         public function getParamDescription() {
 181                 $p = $this->getModulePrefix();
 182
 183                 return array(
 184                         'title' => "Title of the page you want to (un)protect. Cannot be used together with {$p}pageid",
 185                         'pageid' => "ID of the page you want to (un)protect. Cannot be used together with {$p}title",
 186                         'token' => 'A protect token previously retrieved through prop=info',
 187                         'protections' => 'List of protection levels, formatted action=group (e.g. edit=sysop)',
 188                         'expiry' => array(
 189                                 'Expiry timestamps. If only one timestamp is ' .
 190                                         'set, it\'ll be used for all protections.',
 191                                 'Use \'infinite\', \'indefinite\' or \'never\', for a never-expiring protection.'
 192                         ),
 193                         'reason' => 'Reason for (un)protecting',
 194                         'cascade' => array(
 195                                 'Enable cascading protection (i.e. protect pages included in this page)',
 196                                 'Ignored if not all protection levels are \'sysop\' or \'protect\''
 197                         ),
 198                         'watch' => 'If set, add the page being (un)protected to your watchlist',
 199                         'watchlist' => 'Unconditionally add or remove the page from your ' .
 200                                 'watchlist, use preferences or do not change watch',
 201                 );
 202         }
 203
 204         public function getResultProperties() {
 205                 return array(
 206                         '' => array(
 207                                 'title' => 'string',
 208                                 'reason' => 'string',
 209                                 'cascade' => 'boolean'
 210                         )
 211                 );
 212         }
 213
 214         public function getDescription() {
 215                 return 'Change the protection level of a page.';
 216         }
 217
 218         public function getPossibleErrors() {
 219                 return array_merge( parent::getPossibleErrors(),
 220                         $this->getTitleOrPageIdErrorMessage(),
 221                         array(
 222                                 array( 'toofewexpiries', 'noofexpiries', 'noofprotections' ),
 223                                 array( 'create-titleexists' ),
 224                                 array( 'missingtitle-createonly' ),
 225                                 array( 'protect-invalidaction', 'action' ),
 226                                 array( 'protect-invalidlevel', 'level' ),
 227                                 array( 'invalidexpiry', 'expiry' ),
 228                                 array( 'pastexpiry', 'expiry' ),
 229                         )
 230                 );
 231         }
 232
 233         public function needsToken() {
 234                 return true;
 235         }
 236
 237         public function getTokenSalt() {
 238                 return '';
 239         }
 240
 241         public function getExamples() {
 242                 return array(
 243                         'api.php?action=protect&title=Main%20Page&token=123ABC&' .
 244                                 'protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never',
 245                         'api.php?action=protect&title=Main%20Page&token=123ABC&' .
 246                                 'protections=edit=all|move=all&reason=Lifting%20restrictions'
 247                 );
 248         }
 249
 250         public function getHelpUrls() {
 251                 return 'https://www.mediawiki.org/wiki/API:Protect';
 252         }
 253 }