API: Changing all modules' getParamDescription(), getAllowedParams() and getDescripti...
[lhc/web/wiklou.git] / includes / api / ApiProtect.php
index e48bfe6..bd7fa90 100644 (file)
-<?php\r
-\r
-/*\r
- * Created on Sep 1, 2007\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl\r
- *\r
- * This program is free software; you can redistribute it and/or modify\r
- * it under the terms of the GNU General Public License as published by\r
- * the Free Software Foundation; either version 2 of the License, or\r
- * (at your option) any later version.\r
- *\r
- * This program is distributed in the hope that it will be useful,\r
- * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
- * GNU General Public License for more details.\r
- *\r
- * You should have received a copy of the GNU General Public License along\r
- * with this program; if not, write to the Free Software Foundation, Inc.,\r
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
- * http://www.gnu.org/copyleft/gpl.html\r
- */\r
-\r
-if (!defined('MEDIAWIKI')) {\r
-       // Eclipse helper - will be ignored in production\r
-       require_once ("ApiBase.php");\r
-}\r
-\r
-/**\r
- * @addtogroup API\r
- */\r
-class ApiProtect extends ApiBase {\r
-\r
-       public function __construct($main, $action) {\r
-               parent :: __construct($main, $action);\r
-       }\r
-\r
-       public function execute() {\r
-               global $wgUser;\r
-               $this->getMain()->requestWriteMode();\r
-               $params = $this->extractRequestParams();\r
-               \r
-               $titleObj = NULL;\r
-               if(!isset($params['title']))\r
-                       $this->dieUsage('The title parameter must be set', 'notitle');\r
-               if(!isset($params['token']))\r
-                       $this->dieUsage('The token parameter must be set', 'notoken');\r
-               if(!isset($params['protections']) || empty($params['protections']))\r
-                       $this->dieUsage('The protections parameter must be set', 'noprotections');\r
-\r
-               if($wgUser->isBlocked())\r
-                       $this->dieUsage('You have been blocked from editing', 'blocked');\r
-               if(wfReadOnly())\r
-                       $this->dieUsage('The wiki is in read-only mode', 'readonly');\r
-               if(!$wgUser->matchEditToken($params['token']))\r
-                       $this->dieUsage('Invalid token', 'badtoken');\r
-\r
-               $titleObj = Title::newFromText($params['title']);\r
-               if(!$titleObj)\r
-                       $this->dieUsage("Bad title ``{$params['title']}''", 'invalidtitle');\r
-               if(!$titleObj->exists())\r
-                       $this->dieUsage("``{$params['title']}'' doesn't exist", 'missingtitle');\r
-               if(!$titleObj->userCan('protect'))\r
-                       $this->dieUsage('You don\'t have permission to change protection levels', 'permissiondenied');\r
-               $articleObj = new Article($titleObj);\r
-               \r
-               if(in_array($params['expiry'], array('infinite', 'indefinite', 'never')))\r
-                       $expiry = Block::infinity();\r
-               else\r
-               {\r
-                       $expiry = strtotime($params['expiry']);\r
-                       if($expiry < 0 || $expiry == false)\r
-                               $this->dieUsage('Invalid expiry time', 'invalidexpiry');\r
-                       \r
-                       $expiry = wfTimestamp(TS_MW, $expiry);\r
-                       if($expiry < wfTimestampNow())\r
-                               $this->dieUsage('Expiry time is in the past', 'pastexpiry');\r
-               }\r
-\r
-               $protections = array();\r
-               foreach($params['protections'] as $prot)\r
-               {\r
-                       $p = explode('=', $prot);\r
-                       $protections[$p[0]] = ($p[1] == 'all' ? '' : $p[1]);\r
-               }\r
-\r
-               $dbw = wfGetDb(DB_MASTER);\r
-               $dbw->begin();\r
-               $ok = $articleObj->updateRestrictions($protections, $params['reason'], $params['cascade'], $expiry);\r
-               if(!$ok)\r
-                       // This is very weird. Maybe the article was deleted or the user was blocked/desysopped in the meantime?\r
-                       $this->dieUsage('Unknown error', 'unknownerror');\r
-               $dbw->commit();\r
-               $res = array('title' => $titleObj->getPrefixedText(), 'reason' => $params['reason'], 'expiry' => $expiry);\r
-               if($params['cascade'])\r
-                       $res['cascade'] = '';\r
-               $res['protections'] = $protections;\r
-               $this->getResult()->addValue(null, $this->getModuleName(), $res);\r
-       }\r
-\r
-       protected function getAllowedParams() {\r
-               return array (\r
-                       'title' => null,\r
-                       'token' => null,\r
-                       'protections' => array(\r
-                               ApiBase :: PARAM_ISMULTI => true\r
-                       ),\r
-                       'expiry' => 'infinite',\r
-                       'reason' => '',\r
-                       'cascade' => false\r
-               );\r
-       }\r
-\r
-       protected function getParamDescription() {\r
-               return array (\r
-                       'title' => 'Title of the page you want to restore.',\r
-                       'token' => 'A protect token previously retrieved through prop=info',\r
-                       'protections' => 'Pipe-separated list of protection levels, formatted action=group (e.g. edit=sysop)',\r
-                       'expiry' => 'Expiry timestamp. If set to \'infinite\', \'indefinite\' or \'never\', the protection will never expire.',\r
-                       'reason' => 'Reason for (un)protecting (optional)',\r
-                       'cascade' => 'Enable cascading protection (i.e. protect pages included in this page)'\r
-               );\r
-       }\r
-\r
-       protected function getDescription() {\r
-               return array(\r
-                       'Change the protection level of a page.'\r
-               );\r
-       }\r
-\r
-       protected function getExamples() {\r
-               return array (\r
-                       'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade&expiry=20070901163000',\r
-                       'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions'\r
-               );\r
-       }\r
-\r
-       public function getVersion() {\r
-               return __CLASS__ . ': $Id$';\r
-       }\r
-}\r
+<?php
+
+/*
+ * Created on Sep 1, 2007
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+if (!defined('MEDIAWIKI')) {
+       // Eclipse helper - will be ignored in production
+       require_once ("ApiBase.php");
+}
+
+/**
+ * @addtogroup API
+ */
+class ApiProtect extends ApiBase {
+
+       public function __construct($main, $action) {
+               parent :: __construct($main, $action);
+       }
+
+       public function execute() {
+               global $wgUser;
+               $this->getMain()->requestWriteMode();
+               $params = $this->extractRequestParams();
+               
+               $titleObj = NULL;
+               if(!isset($params['title']))
+                       $this->dieUsageMsg(array('missingparam', 'title'));
+               if(!isset($params['token']))
+                       $this->dieUsageMsg(array('missingparam', 'token'));
+               if(!isset($params['protections']) || empty($params['protections']))
+                       $this->dieUsageMsg(array('missingparam', 'protections'));
+
+               if(!$wgUser->matchEditToken($params['token']))
+                       $this->dieUsageMsg(array('sessionfailure'));
+
+               $titleObj = Title::newFromText($params['title']);
+               if(!$titleObj)
+                       $this->dieUsageMsg(array('invalidtitle', $params['title']));
+                       
+               $errors = $titleObj->getUserPermissionsErrors('protect', $wgUser);
+               if(!empty($errors))
+                       // We don't care about multiple errors, just report one of them
+                       $this->dieUsageMsg(current($errors));
+               
+               if(in_array($params['expiry'], array('infinite', 'indefinite', 'never')))
+                       $expiry = Block::infinity();
+               else
+               {
+                       $expiry = strtotime($params['expiry']);
+                       if($expiry < 0 || $expiry == false)
+                               $this->dieUsageMsg(array('invalidexpiry'));
+                       
+                       $expiry = wfTimestamp(TS_MW, $expiry);
+                       if($expiry < wfTimestampNow())
+                               $this->dieUsageMsg(array('pastexpiry'));
+               }
+
+               $protections = array();
+               foreach($params['protections'] as $prot)
+               {
+                       $p = explode('=', $prot);
+                       $protections[$p[0]] = ($p[1] == 'all' ? '' : $p[1]);
+                       if($titleObj->exists() && $p[0] == 'create')
+                               $this->dieUsageMsg(array('create-titleexists'));
+                       if(!$titleObj->exists() && $p[0] != 'create')
+                               $this->dieUsageMsg(array('missingtitles-createonly'));
+               }
+
+               $dbw = wfGetDb(DB_MASTER);
+               $dbw->begin();
+               if($titleObj->exists()) {
+                       $articleObj = new Article($titleObj);
+                       $ok = $articleObj->updateRestrictions($protections, $params['reason'], $params['cascade'], $expiry);
+               } else
+                       $ok = $titleObj->updateTitleProtection($protections['create'], $params['reason'], $expiry);
+               if(!$ok)
+                       // This is very weird. Maybe the article was deleted or the user was blocked/desysopped in the meantime?
+                       // Just throw an unknown error in this case, as it's very likely to be a race condition
+                       $this->dieUsageMsg(array());
+               $dbw->commit();
+               $res = array('title' => $titleObj->getPrefixedText(), 'reason' => $params['reason']);
+               if($expiry == Block::infinity())
+                       $res['expiry'] = 'infinity';
+               else
+                       $res['expiry'] = wfTimestamp(TS_ISO_8601, $expiry);
+
+               if($params['cascade'])
+                       $res['cascade'] = '';
+               $res['protections'] = $protections;
+               $this->getResult()->addValue(null, $this->getModuleName(), $res);
+       }
+
+       public function mustBePosted() { return true; }
+
+       public function getAllowedParams() {
+               return array (
+                       'title' => null,
+                       'token' => null,
+                       'protections' => array(
+                               ApiBase :: PARAM_ISMULTI => true
+                       ),
+                       'expiry' => 'infinite',
+                       'reason' => '',
+                       'cascade' => false
+               );
+       }
+
+       public function getParamDescription() {
+               return array (
+                       'title' => 'Title of the page you want to restore.',
+                       'token' => 'A protect token previously retrieved through prop=info',
+                       'protections' => 'Pipe-separated list of protection levels, formatted action=group (e.g. edit=sysop)',
+                       'expiry' => 'Expiry timestamp. If set to \'infinite\', \'indefinite\' or \'never\', the protection will never expire.',
+                       'reason' => 'Reason for (un)protecting (optional)',
+                       'cascade' => 'Enable cascading protection (i.e. protect pages included in this page)'
+               );
+       }
+
+       public function getDescription() {
+               return array(
+                       'Change the protection level of a page.'
+               );
+       }
+
+       protected function getExamples() {
+               return array (
+                       'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade&expiry=20070901163000',
+                       'api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions'
+               );
+       }
+
+       public function getVersion() {
+               return __CLASS__ . ': $Id$';
+       }
+}