Followup r86622: add initial QUnit test cases for jquery.textSelection module.
[lhc/web/wiklou.git] / includes / api / ApiProtect.php
index dc5197a..c87cf43 100644 (file)
@@ -1,10 +1,10 @@
 <?php
-
 /**
+ *
+ *
  * Created on Sep 1, 2007
- * API for MediaWiki 1.8+
  *
- * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@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
  *
  * 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -37,20 +39,8 @@ class ApiProtect extends ApiBase {
        }
 
        public function execute() {
-               global $wgUser, $wgRestrictionTypes, $wgRestrictionLevels;
+               global $wgUser, $wgRestrictionLevels;
                $params = $this->extractRequestParams();
-               
-               if ( isset( $params['watch'] ) && isset( $params['unwatch'] ) ) {
-                       $this->dieUsageMsg( array( 'show' ) );
-               }
-
-               $titleObj = null;
-               if ( !isset( $params['title'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'title' ) );
-               }
-               if ( empty( $params['protections'] ) ) {
-                       $this->dieUsageMsg( array( 'missingparam', 'protections' ) );
-               }
 
                $titleObj = Title::newFromText( $params['title'] );
                if ( !$titleObj ) {
@@ -73,6 +63,7 @@ class ApiProtect extends ApiBase {
                }
 
                $restrictionTypes = $titleObj->getRestrictionTypes();
+               $dbr = wfGetDB( DB_SLAVE );
 
                $protections = array();
                $expiryarray = array();
@@ -82,10 +73,10 @@ class ApiProtect extends ApiBase {
                        $protections[$p[0]] = ( $p[1] == 'all' ? '' : $p[1] );
 
                        if ( $titleObj->exists() && $p[0] == 'create' ) {
-                               $this->dieUsageMsg( array( 'create-titleexists' ) );
+                               $this->dieUsageMsg( 'create-titleexists' );
                        }
                        if ( !$titleObj->exists() && $p[0] != 'create' ) {
-                               $this->dieUsageMsg( array( 'missingtitle-createonly' ) );
+                               $this->dieUsageMsg( 'missingtitle-createonly' );
                        }
 
                        if ( !in_array( $p[0], $restrictionTypes ) && $p[0] != 'create' ) {
@@ -96,10 +87,10 @@ class ApiProtect extends ApiBase {
                        }
 
                        if ( in_array( $expiry[$i], array( 'infinite', 'indefinite', 'never' ) ) ) {
-                               $expiryarray[$p[0]] = Block::infinity();
+                               $expiryarray[$p[0]] = $dbr->getInfinity();
                        } else {
                                $exp = strtotime( $expiry[$i] );
-                               if ( $exp < 0 || $exp == false ) {
+                               if ( $exp < 0 || !$exp ) {
                                        $this->dieUsageMsg( array( 'invalidexpiry', $expiry[$i] ) );
                                }
 
@@ -110,19 +101,17 @@ class ApiProtect extends ApiBase {
                                $expiryarray[$p[0]] = $exp;
                        }
                        $resultProtections[] = array( $p[0] => $protections[$p[0]],
-                                       'expiry' => ( $expiryarray[$p[0]] == Block::infinity() ?
+                                       'expiry' => ( $expiryarray[$p[0]] == $dbr->getInfinity() ?
                                                                'infinite' :
                                                                wfTimestamp( TS_ISO_8601, $expiryarray[$p[0]] ) ) );
                }
 
                $cascade = $params['cascade'];
                $articleObj = new Article( $titleObj );
-               if ( $params['watch'] ) {
-                       $articleObj->doWatch();
-               } elseif ( $params['unwatch'] ) {
-                       $articleObj->doUnwatch();
-               }
-               
+
+               $watch = $params['watch'] ? 'watch' : $params['watchlist'];
+               $this->setWatch( $watch, $titleObj );
+
                if ( $titleObj->exists() ) {
                        $ok = $articleObj->updateRestrictions( $protections, $params['reason'], $cascade, $expiryarray );
                } else {
@@ -141,8 +130,9 @@ class ApiProtect extends ApiBase {
                        $res['cascade'] = '';
                }
                $res['protections'] = $resultProtections;
-               $this->getResult()->setIndexedTagName( $res['protections'], 'protection' );
-               $this->getResult()->addValue( null, $this->getModuleName(), $res );
+               $result = $this->getResult();
+               $result->setIndexedTagName( $res['protections'], 'protection' );
+               $result->addValue( null, $this->getModuleName(), $res );
        }
 
        public function mustBePosted() {
@@ -155,10 +145,14 @@ class ApiProtect extends ApiBase {
 
        public function getAllowedParams() {
                return array(
-                       'title' => null,
+                       'title' => array(
+                               ApiBase::PARAM_TYPE => 'string',
+                               ApiBase::PARAM_REQUIRED => true
+                       ),
                        'token' => null,
                        'protections' => array(
-                               ApiBase::PARAM_ISMULTI => true
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_REQUIRED => true,
                        ),
                        'expiry' => array(
                                ApiBase::PARAM_ISMULTI => true,
@@ -167,14 +161,25 @@ class ApiProtect extends ApiBase {
                        ),
                        'reason' => '',
                        'cascade' => false,
-                       'watch' => false,
-                       'unwatch' => false,
+                       'watch' => array(
+                               ApiBase::PARAM_DFLT => false,
+                               ApiBase::PARAM_DEPRECATED => true,
+                       ),
+                       'watchlist' => array(
+                               ApiBase::PARAM_DFLT => 'preferences',
+                               ApiBase::PARAM_TYPE => array(
+                                       'watch',
+                                       'unwatch',
+                                       'preferences',
+                                       'nochange'
+                               ),
+                       ),
                );
        }
 
        public function getParamDescription() {
                return array(
-                       'title' => 'Title of the page you want to (un)protect.',
+                       'title' => 'Title of the page you want to (un)protect',
                        'token' => 'A protect token previously retrieved through prop=info',
                        'protections' => 'Pipe-separated list of protection levels, formatted action=group (e.g. edit=sysop)',
                        'expiry' => array( 'Expiry timestamps. If only one timestamp is set, it\'ll be used for all protections.',
@@ -183,20 +188,16 @@ class ApiProtect extends ApiBase {
                        'cascade' => array( 'Enable cascading protection (i.e. protect pages included in this page)',
                                        'Ignored if not all protection levels are \'sysop\' or \'protect\'' ),
                        'watch' => 'If set, add the page being (un)protected to your watchlist',
-                       'unwatch' => 'Remove the page being (un)protected from your watchlist',
+                       'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
                );
        }
 
        public function getDescription() {
-               return array(
-                       'Change the protection level of a page.'
-               );
+               return 'Change the protection level of a page';
        }
 
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
-                       array( 'missingparam', 'title' ),
-                       array( 'missingparam', 'protections' ),
                        array( 'invalidtitle', 'title' ),
                        array( 'toofewexpiries', 'noofexpiries', 'noofprotections' ),
                        array( 'create-titleexists' ),
@@ -205,21 +206,28 @@ class ApiProtect extends ApiBase {
                        array( 'protect-invalidlevel', 'level' ),
                        array( 'invalidexpiry', 'expiry' ),
                        array( 'pastexpiry', 'expiry' ),
-                       array( 'show' ),
                ) );
        }
 
+       public function needsToken() {
+               return true;
+       }
+
        public function getTokenSalt() {
-               return null;
+               return '';
        }
 
        protected function getExamples() {
                return array(
-                       'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade&expiry=20070901163000|never',
+                       'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never',
                        'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions'
                );
        }
 
+       public function getHelpUrls() {
+               return 'http://www.mediawiki.org/wiki/API:Protect';
+       }
+
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }