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