setting svn:eol-style native on ApiEditPage.php
authorAlexandre Emsenhuber <ialex@users.mediawiki.org>
Mon, 3 Mar 2008 18:19:52 +0000 (18:19 +0000)
committerAlexandre Emsenhuber <ialex@users.mediawiki.org>
Mon, 3 Mar 2008 18:19:52 +0000 (18:19 +0000)
includes/api/ApiEditPage.php

index b9a1120..9dad44f 100644 (file)
-<?php\r
-\r
-/*\r
- * Created on August 16, 2007\r
- *\r
- * API for MediaWiki 1.8+\r
- *\r
- * Copyright (C) 2007 Iker Labarga <Firstname><Lastname>@gmail.com\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
- * A query module to list all external URLs found on a given set of pages.\r
- *\r
- * @addtogroup API\r
- */\r
-class ApiEditPage extends ApiBase {\r
-\r
-       public function __construct($query, $moduleName) {\r
-               parent :: __construct($query, $moduleName);\r
-       }\r
-\r
-       public function execute() {\r
-               global $wgUser;\r
-               $this->getMain()->requestWriteMode();\r
-\r
-               $params = $this->extractRequestParams();\r
-               if(is_null($params['title']))\r
-                       $this->dieUsageMsg(array('missingparam', 'title'));\r
-               if(is_null($params['text']))\r
-                       $this->dieUsageMsg(array('missingparam', 'text'));\r
-               if(is_null($params['token']))\r
-                       $this->dieUsageMsg(array('missingparam', 'token'));\r
-               if(!$wgUser->matchEditToken($params['token']))\r
-                       $this->dieUsageMsg(array('sessionfailure'));\r
-               \r
-               $titleObj = Title::newFromText($params['title']);\r
-               if(!$titleObj)\r
-                       $this->dieUsageMsg(array('invalidtitle', $params['title']));\r
-               \r
-               // Now let's check whether we're even allowed to do this\r
-               $errors = $titleObj->getUserPermissionsErrors('edit', $wgUser);\r
-               if(!$titleObj->exists())\r
-                       $errors = array_merge($errors, $titleObj->getUserPermissionsErrors('create', $wgUser));\r
-               if(!empty($errors))\r
-                       $this->dieUsageMsg($errors[0]);\r
-\r
-               $articleObj = new Article($titleObj);\r
-               $ep = new EditPage($articleObj);\r
-\r
-               // EditPage wants to parse its stuff from a WebRequest\r
-               // That interface kind of sucks, but it's workable\r
-               $reqArr = array('wpTextbox1' => $params['text'],\r
-                               'wpEdittoken' => $params['token'],\r
-                               'wpIgnoreBlankSummary' => ''\r
-               );\r
-               if(!is_null($params['summary']))\r
-                       $reqArr['wpSummary'] = $params['summary'];\r
-               # Watch out for basetimestamp == ''\r
-               # wfTimestamp() treats it as NOW, almost certainly causing an edit conflict\r
-               if(!is_null($params['basetimestamp']) && $params['basetimestamp'] != '')\r
-                       $reqArr['wpEdittime'] = wfTimestamp(TS_MW, $params['basetimestamp']);\r
-               else\r
-                       $reqArr['wpEdittime'] = $articleObj->getTimestamp();\r
-               # Fake wpStartime\r
-               $reqArr['wpStarttime'] = $reqArr['wpEdittime'];\r
-               if($params['minor'] || (!$params['notminor'] && $wgUser->getOption('minordefault')))\r
-                       $reqArr['wpMinoredit'] = '';\r
-               if($params['recreate'])\r
-                       $reqArr['wpRecreate'] = '';\r
-               if(!is_null($params['captchaid']))\r
-                       $reqArr['wpCaptchaId'] = $params['captchaid'];\r
-               if(!is_null($params['captchaword']))\r
-                       $reqArr['wpCaptchaWord'] = $params['captchaword'];\r
-               \r
-               if($params['watch'])\r
-                       $watch = true;\r
-               else if($params['unwatch'])\r
-                       $watch = false;\r
-               else if($titleObj->userIsWatching())\r
-                       $watch = true;\r
-               else if($wgUser->getOption('watchdefault'))\r
-                       $watch = true;\r
-               else if($wgUser->getOption('watchcreations') && !$titleObj->exists())\r
-                       $watch = true;\r
-               else\r
-                       $watch = false;\r
-               if($watch)\r
-                       $reqArr['wpWatchthis'] = '';\r
-\r
-               $req = new FauxRequest($reqArr, true);\r
-               $ep->importFormData($req);\r
-\r
-               # Run hooks\r
-               # We need to fake $wgRequest for some of them\r
-               global $wgRequest;\r
-               $wgRequest = $req;\r
-               $r = array();\r
-               if(!wfRunHooks('APIEditBeforeSave', array(&$ep, $ep->textbox1, &$r)))\r
-               {\r
-                       if(!empty($r))\r
-                       {\r
-                               $r['result'] = "Failure";\r
-                               $this->getResult()->addValue(null, $this->getModuleName(), $r);\r
-                               return; \r
-                       }       \r
-                       else\r
-                               $this->dieUsageMsg(array('hookaborted'));\r
-               }\r
-               \r
-               # Do the actual save\r
-               $oldRevId = $articleObj->getRevIdFetched();\r
-               $result = null;\r
-               # *Something* is setting $wgTitle to a title corresponding to "Msg",\r
-               # but that breaks API mode detection through is_null($wgTitle)\r
-               global $wgTitle;\r
-               $wgTitle = null;\r
-               $retval = $ep->internalAttemptSave($result, $wgUser->isAllowed('bot') && $params['bot']);\r
-               switch($retval)\r
-               {\r
-                       case EditPage::AS_HOOK_ERROR:\r
-                       case EditPage::AS_HOOK_ERROR_EXPECTED:\r
-                               $this->dieUsageMsg(array('hookaborted'));\r
-                       case EditPage::AS_IMAGE_REDIRECT_ANON:\r
-                               $this->dieUsageMsg(array('noimageredirect-anon'));\r
-                       case EditPage::AS_IMAGE_REDIRECT_LOGGED:\r
-                               $this->dieUsageMsg(array('noimageredirect-logged'));\r
-                       case EditPage::AS_SPAM_ERROR:\r
-                               $this->dieUsageMsg(array('spamdetected', $result['spam']));\r
-                       case EditPage::AS_FILTERING:\r
-                               $this->dieUsageMsg(array('filtered'));\r
-                       case EditPage::AS_BLOCKED_PAGE_FOR_USER:\r
-                               $this->dieUsageMsg(array('blockedtext'));\r
-                       case EditPage::AS_MAX_ARTICLE_SIZE_EXCEEDED:\r
-                       case EditPage::AS_CONTENT_TOO_BIG:\r
-                               global $wgMaxArticleSize;\r
-                               $this->dieUsageMsg(array('contenttoobig', $wgMaxArticleSize));\r
-                       case EditPage::AS_READ_ONLY_PAGE_ANON:\r
-                               $this->dieUsageMsg(array('noedit-anon'));\r
-                       case EditPage::AS_READ_ONLY_PAGE_LOGGED:\r
-                               $this->dieUsageMsg(array('noedit'));\r
-                       case EditPage::AS_READ_ONLY_PAGE:\r
-                               $this->dieUsageMsg(array('readonlytext'));\r
-                       case EditPage::AS_RATE_LIMITED:\r
-                               $this->dieUsageMsg(array('actionthrottledtext'));\r
-                       case EditPage::AS_ARTICLE_WAS_DELETED:\r
-                               $this->dieUsageMsg(array('wasdeleted'));\r
-                       case EditPage::AS_NO_CREATE_PERMISSION:\r
-                               $this->dieUsageMsg(array('nocreate-loggedin'));\r
-                       case EditPage::AS_BLANK_ARTICLE:\r
-                               $this->dieUsageMsg(array('blankpage'));\r
-                       case EditPage::AS_CONFLICT_DETECTED:\r
-                               $this->dieUsageMsg(array('editconflict'));\r
-                       #case EditPage::AS_SUMMARY_NEEDED: Can't happen since we set wpIgnoreBlankSummary\r
-                       #case EditPage::AS_TEXTBOX_EMPTY: Can't happen since we don't do sections\r
-                       case EditPage::AS_END:\r
-                               # This usually means some kind of race condition\r
-                               # or DB weirdness occurred. Throw an unknown error here.\r
-                               $this->dieUsageMsg(array('unknownerror', 'AS_END'));\r
-                       case EditPage::AS_SUCCESS_NEW_ARTICLE:\r
-                               $r['new'] = '';\r
-                       case EditPage::AS_SUCCESS_UPDATE:\r
-                               $r['result'] = "Success";\r
-                               $r['pageid'] = $titleObj->getArticleID();\r
-                               $r['title'] = $titleObj->getPrefixedText();\r
-                               $newRevId = $titleObj->getLatestRevId();\r
-                               if($newRevId == $oldRevId)\r
-                                       $r['nochange'] = '';\r
-                               else\r
-                               {\r
-                                       $r['oldrevid'] = $oldRevId;\r
-                                       $r['newrevid'] = $newRevId;\r
-                               }\r
-                               break;\r
-                       default:\r
-                               $this->dieUsageMsg(array('unknownerror', $retval));\r
-               }\r
-               $this->getResult()->addValue(null, $this->getModuleName(), $r);\r
-       }\r
-\r
-       protected function getDescription() {\r
-               return 'Create and edit pages.';\r
-       }\r
-\r
-       protected function getAllowedParams() {\r
-               return array (\r
-                       'title' => null,\r
-                       'text' => null,\r
-                       'token' => null,\r
-                       'summary' => null,\r
-                       'minor' => false,\r
-                       'notminor' => false,\r
-                       'bot' => false,\r
-                       'basetimestamp' => null,\r
-                       'recreate' => false,\r
-                       'captchaword' => null,\r
-                       'captchaid' => null,\r
-                       'watch' => false,\r
-                       'unwatch' => false,\r
-               );\r
-       }\r
-\r
-       protected function getParamDescription() {\r
-               return array (\r
-                       'title' => 'Page title',\r
-                       'text' => 'Page content',\r
-                       'token' => 'Edit token. You can get one of these through prop=info',\r
-                       'summary' => 'Edit summary',\r
-                       'minor' => 'Minor edit',\r
-                       'notminor' => 'Non-minor edit',\r
-                       'bot' => 'Mark this edit as bot',\r
-                       'basetimestamp' => array('Timestamp of the base revision (gotten through prop=revisions&rvprop=timestamp).',\r
-                                               'Used to detect edit conflicts; leave unset to ignore conflicts.'\r
-                       ),\r
-                       'recreate' => 'Override any errors about the article having been deleted in the meantime',\r
-                       'watch' => 'Add the page to your watchlist',\r
-                       'unwatch' => 'Remove the page from your watchlist',\r
-                       'captchaid' => 'CAPTCHA ID from previous request',\r
-                       'captchaword' => 'Answer to the CAPTCHA',\r
-               );\r
-       }\r
-\r
-       protected function getExamples() {\r
-               return array (\r
-                       "Edit a page (anonymous user):",\r
-                       "    api.php?action=edit&eptitle=Test&epsummary=test%20summary&eptext=article%20content&epedittime=20070824123454&eptokenid=+%5C"\r
-               );\r
-       }\r
-\r
-       public function getVersion() {\r
-               return __CLASS__ . ': $Id: ApiEditPage.php 22289 2007-08-16 13:27:44Z ilabarg1 $';\r
-       }\r
+<?php
+
+/*
+ * Created on August 16, 2007
+ *
+ * API for MediaWiki 1.8+
+ *
+ * Copyright (C) 2007 Iker Labarga <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
+ * 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");
+}
+
+/**
+ * A query module to list all external URLs found on a given set of pages.
+ *
+ * @addtogroup API
+ */
+class ApiEditPage extends ApiBase {
+
+       public function __construct($query, $moduleName) {
+               parent :: __construct($query, $moduleName);
+       }
+
+       public function execute() {
+               global $wgUser;
+               $this->getMain()->requestWriteMode();
+
+               $params = $this->extractRequestParams();
+               if(is_null($params['title']))
+                       $this->dieUsageMsg(array('missingparam', 'title'));
+               if(is_null($params['text']))
+                       $this->dieUsageMsg(array('missingparam', 'text'));
+               if(is_null($params['token']))
+                       $this->dieUsageMsg(array('missingparam', 'token'));
+               if(!$wgUser->matchEditToken($params['token']))
+                       $this->dieUsageMsg(array('sessionfailure'));
+               
+               $titleObj = Title::newFromText($params['title']);
+               if(!$titleObj)
+                       $this->dieUsageMsg(array('invalidtitle', $params['title']));
+               
+               // Now let's check whether we're even allowed to do this
+               $errors = $titleObj->getUserPermissionsErrors('edit', $wgUser);
+               if(!$titleObj->exists())
+                       $errors = array_merge($errors, $titleObj->getUserPermissionsErrors('create', $wgUser));
+               if(!empty($errors))
+                       $this->dieUsageMsg($errors[0]);
+
+               $articleObj = new Article($titleObj);
+               $ep = new EditPage($articleObj);
+
+               // EditPage wants to parse its stuff from a WebRequest
+               // That interface kind of sucks, but it's workable
+               $reqArr = array('wpTextbox1' => $params['text'],
+                               'wpEdittoken' => $params['token'],
+                               'wpIgnoreBlankSummary' => ''
+               );
+               if(!is_null($params['summary']))
+                       $reqArr['wpSummary'] = $params['summary'];
+               # Watch out for basetimestamp == ''
+               # wfTimestamp() treats it as NOW, almost certainly causing an edit conflict
+               if(!is_null($params['basetimestamp']) && $params['basetimestamp'] != '')
+                       $reqArr['wpEdittime'] = wfTimestamp(TS_MW, $params['basetimestamp']);
+               else
+                       $reqArr['wpEdittime'] = $articleObj->getTimestamp();
+               # Fake wpStartime
+               $reqArr['wpStarttime'] = $reqArr['wpEdittime'];
+               if($params['minor'] || (!$params['notminor'] && $wgUser->getOption('minordefault')))
+                       $reqArr['wpMinoredit'] = '';
+               if($params['recreate'])
+                       $reqArr['wpRecreate'] = '';
+               if(!is_null($params['captchaid']))
+                       $reqArr['wpCaptchaId'] = $params['captchaid'];
+               if(!is_null($params['captchaword']))
+                       $reqArr['wpCaptchaWord'] = $params['captchaword'];
+               
+               if($params['watch'])
+                       $watch = true;
+               else if($params['unwatch'])
+                       $watch = false;
+               else if($titleObj->userIsWatching())
+                       $watch = true;
+               else if($wgUser->getOption('watchdefault'))
+                       $watch = true;
+               else if($wgUser->getOption('watchcreations') && !$titleObj->exists())
+                       $watch = true;
+               else
+                       $watch = false;
+               if($watch)
+                       $reqArr['wpWatchthis'] = '';
+
+               $req = new FauxRequest($reqArr, true);
+               $ep->importFormData($req);
+
+               # Run hooks
+               # We need to fake $wgRequest for some of them
+               global $wgRequest;
+               $wgRequest = $req;
+               $r = array();
+               if(!wfRunHooks('APIEditBeforeSave', array(&$ep, $ep->textbox1, &$r)))
+               {
+                       if(!empty($r))
+                       {
+                               $r['result'] = "Failure";
+                               $this->getResult()->addValue(null, $this->getModuleName(), $r);
+                               return; 
+                       }       
+                       else
+                               $this->dieUsageMsg(array('hookaborted'));
+               }
+               
+               # Do the actual save
+               $oldRevId = $articleObj->getRevIdFetched();
+               $result = null;
+               # *Something* is setting $wgTitle to a title corresponding to "Msg",
+               # but that breaks API mode detection through is_null($wgTitle)
+               global $wgTitle;
+               $wgTitle = null;
+               $retval = $ep->internalAttemptSave($result, $wgUser->isAllowed('bot') && $params['bot']);
+               switch($retval)
+               {
+                       case EditPage::AS_HOOK_ERROR:
+                       case EditPage::AS_HOOK_ERROR_EXPECTED:
+                               $this->dieUsageMsg(array('hookaborted'));
+                       case EditPage::AS_IMAGE_REDIRECT_ANON:
+                               $this->dieUsageMsg(array('noimageredirect-anon'));
+                       case EditPage::AS_IMAGE_REDIRECT_LOGGED:
+                               $this->dieUsageMsg(array('noimageredirect-logged'));
+                       case EditPage::AS_SPAM_ERROR:
+                               $this->dieUsageMsg(array('spamdetected', $result['spam']));
+                       case EditPage::AS_FILTERING:
+                               $this->dieUsageMsg(array('filtered'));
+                       case EditPage::AS_BLOCKED_PAGE_FOR_USER:
+                               $this->dieUsageMsg(array('blockedtext'));
+                       case EditPage::AS_MAX_ARTICLE_SIZE_EXCEEDED:
+                       case EditPage::AS_CONTENT_TOO_BIG:
+                               global $wgMaxArticleSize;
+                               $this->dieUsageMsg(array('contenttoobig', $wgMaxArticleSize));
+                       case EditPage::AS_READ_ONLY_PAGE_ANON:
+                               $this->dieUsageMsg(array('noedit-anon'));
+                       case EditPage::AS_READ_ONLY_PAGE_LOGGED:
+                               $this->dieUsageMsg(array('noedit'));
+                       case EditPage::AS_READ_ONLY_PAGE:
+                               $this->dieUsageMsg(array('readonlytext'));
+                       case EditPage::AS_RATE_LIMITED:
+                               $this->dieUsageMsg(array('actionthrottledtext'));
+                       case EditPage::AS_ARTICLE_WAS_DELETED:
+                               $this->dieUsageMsg(array('wasdeleted'));
+                       case EditPage::AS_NO_CREATE_PERMISSION:
+                               $this->dieUsageMsg(array('nocreate-loggedin'));
+                       case EditPage::AS_BLANK_ARTICLE:
+                               $this->dieUsageMsg(array('blankpage'));
+                       case EditPage::AS_CONFLICT_DETECTED:
+                               $this->dieUsageMsg(array('editconflict'));
+                       #case EditPage::AS_SUMMARY_NEEDED: Can't happen since we set wpIgnoreBlankSummary
+                       #case EditPage::AS_TEXTBOX_EMPTY: Can't happen since we don't do sections
+                       case EditPage::AS_END:
+                               # This usually means some kind of race condition
+                               # or DB weirdness occurred. Throw an unknown error here.
+                               $this->dieUsageMsg(array('unknownerror', 'AS_END'));
+                       case EditPage::AS_SUCCESS_NEW_ARTICLE:
+                               $r['new'] = '';
+                       case EditPage::AS_SUCCESS_UPDATE:
+                               $r['result'] = "Success";
+                               $r['pageid'] = $titleObj->getArticleID();
+                               $r['title'] = $titleObj->getPrefixedText();
+                               $newRevId = $titleObj->getLatestRevId();
+                               if($newRevId == $oldRevId)
+                                       $r['nochange'] = '';
+                               else
+                               {
+                                       $r['oldrevid'] = $oldRevId;
+                                       $r['newrevid'] = $newRevId;
+                               }
+                               break;
+                       default:
+                               $this->dieUsageMsg(array('unknownerror', $retval));
+               }
+               $this->getResult()->addValue(null, $this->getModuleName(), $r);
+       }
+
+       protected function getDescription() {
+               return 'Create and edit pages.';
+       }
+
+       protected function getAllowedParams() {
+               return array (
+                       'title' => null,
+                       'text' => null,
+                       'token' => null,
+                       'summary' => null,
+                       'minor' => false,
+                       'notminor' => false,
+                       'bot' => false,
+                       'basetimestamp' => null,
+                       'recreate' => false,
+                       'captchaword' => null,
+                       'captchaid' => null,
+                       'watch' => false,
+                       'unwatch' => false,
+               );
+       }
+
+       protected function getParamDescription() {
+               return array (
+                       'title' => 'Page title',
+                       'text' => 'Page content',
+                       'token' => 'Edit token. You can get one of these through prop=info',
+                       'summary' => 'Edit summary',
+                       'minor' => 'Minor edit',
+                       'notminor' => 'Non-minor edit',
+                       'bot' => 'Mark this edit as bot',
+                       'basetimestamp' => array('Timestamp of the base revision (gotten through prop=revisions&rvprop=timestamp).',
+                                               'Used to detect edit conflicts; leave unset to ignore conflicts.'
+                       ),
+                       'recreate' => 'Override any errors about the article having been deleted in the meantime',
+                       'watch' => 'Add the page to your watchlist',
+                       'unwatch' => 'Remove the page from your watchlist',
+                       'captchaid' => 'CAPTCHA ID from previous request',
+                       'captchaword' => 'Answer to the CAPTCHA',
+               );
+       }
+
+       protected function getExamples() {
+               return array (
+                       "Edit a page (anonymous user):",
+                       "    api.php?action=edit&eptitle=Test&epsummary=test%20summary&eptext=article%20content&epedittime=20070824123454&eptokenid=+%5C"
+               );
+       }
+
+       public function getVersion() {
+               return __CLASS__ . ': $Id: ApiEditPage.php 22289 2007-08-16 13:27:44Z ilabarg1 $';
+       }
 }
\ No newline at end of file