5 * Created on August 16, 2007
7 * Copyright © 2007 Iker Labarga "<Firstname><Lastname>@gmail.com"
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.
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.
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
28 * A module that allows for editing and creating pages.
30 * Currently, this wraps around the EditPage class in an ugly way,
31 * EditPage.php should be rewritten to provide a cleaner interface
34 class ApiEditPage
extends ApiBase
{
36 public function execute() {
37 $user = $this->getUser();
38 $params = $this->extractRequestParams();
40 if ( is_null( $params['text'] ) && is_null( $params['appendtext'] ) &&
41 is_null( $params['prependtext'] ) &&
42 $params['undo'] == 0 )
44 $this->dieUsageMsg( 'missingtext' );
47 $pageObj = $this->getTitleOrPageId( $params );
48 $titleObj = $pageObj->getTitle();
49 if ( $titleObj->isExternal() ) {
50 $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
53 $apiResult = $this->getResult();
55 if ( $params['redirect'] ) {
56 if ( $titleObj->isRedirect() ) {
57 $oldTitle = $titleObj;
59 $titles = Revision
::newFromTitle( $oldTitle, false, Revision
::READ_LATEST
)
60 ->getContent( Revision
::FOR_THIS_USER
, $user )
62 // array_shift( $titles );
64 $redirValues = array();
65 foreach ( $titles as $id => $newTitle ) {
67 if ( !isset( $titles[$id - 1] ) ) {
68 $titles[$id - 1] = $oldTitle;
71 $redirValues[] = array(
72 'from' => $titles[$id - 1]->getPrefixedText(),
73 'to' => $newTitle->getPrefixedText()
76 $titleObj = $newTitle;
79 $apiResult->setIndexedTagName( $redirValues, 'r' );
80 $apiResult->addValue( null, 'redirects', $redirValues );
82 // Since the page changed, update $pageObj
83 $pageObj = WikiPage
::factory( $titleObj );
87 if ( !isset( $params['contentmodel'] ) ||
$params['contentmodel'] == '' ) {
88 $contentHandler = $pageObj->getContentHandler();
90 $contentHandler = ContentHandler
::getForModelID( $params['contentmodel'] );
93 // @todo ask handler whether direct editing is supported at all! make allowFlatEdit() method or some such
95 if ( !isset( $params['contentformat'] ) ||
$params['contentformat'] == '' ) {
96 $params['contentformat'] = $contentHandler->getDefaultFormat();
99 $contentFormat = $params['contentformat'];
101 if ( !$contentHandler->isSupportedFormat( $contentFormat ) ) {
102 $name = $titleObj->getPrefixedDBkey();
103 $model = $contentHandler->getModelID();
105 $this->dieUsage( "The requested format $contentFormat is not supported for content model ".
106 " $model used by $name", 'badformat' );
109 if ( $params['createonly'] && $titleObj->exists() ) {
110 $this->dieUsageMsg( 'createonly-exists' );
112 if ( $params['nocreate'] && !$titleObj->exists() ) {
113 $this->dieUsageMsg( 'nocreate-missing' );
116 // Now let's check whether we're even allowed to do this
117 $errors = $titleObj->getUserPermissionsErrors( 'edit', $user );
118 if ( !$titleObj->exists() ) {
119 $errors = array_merge( $errors, $titleObj->getUserPermissionsErrors( 'create', $user ) );
121 if ( count( $errors ) ) {
122 $this->dieUsageMsg( $errors[0] );
125 $toMD5 = $params['text'];
126 if ( !is_null( $params['appendtext'] ) ||
!is_null( $params['prependtext'] ) )
128 $content = $pageObj->getContent();
131 if ( $titleObj->getNamespace() == NS_MEDIAWIKI
) {
132 # If this is a MediaWiki:x message, then load the messages
133 # and return the message value for x.
134 $text = $titleObj->getDefaultMessageText();
135 if ( $text === false ) {
140 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
141 } catch ( MWContentSerializationException
$ex ) {
142 $this->dieUsage( $ex->getMessage(), 'parseerror' );
146 # Otherwise, make a new empty content.
147 $content = $contentHandler->makeEmptyContent();
151 // @todo: Add support for appending/prepending to the Content interface
153 if ( !( $content instanceof TextContent
) ) {
154 $mode = $contentHandler->getModelID();
155 $this->dieUsage( "Can't append to pages using content model $mode", 'appendnotsupported' );
158 if ( !is_null( $params['section'] ) ) {
159 if ( !$contentHandler->supportsSections() ) {
160 $modelName = $contentHandler->getModelID();
161 $this->dieUsage( "Sections are not supported for this content model: $modelName.", 'sectionsnotsupported' );
164 // Process the content for section edits
165 $section = intval( $params['section'] );
166 $content = $content->getSection( $section );
169 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
176 $text = $content->serialize( $contentFormat );
179 $params['text'] = $params['prependtext'] . $text . $params['appendtext'];
180 $toMD5 = $params['prependtext'] . $params['appendtext'];
183 if ( $params['undo'] > 0 ) {
184 if ( $params['undoafter'] > 0 ) {
185 if ( $params['undo'] < $params['undoafter'] ) {
186 list( $params['undo'], $params['undoafter'] ) =
187 array( $params['undoafter'], $params['undo'] );
189 $undoafterRev = Revision
::newFromID( $params['undoafter'] );
191 $undoRev = Revision
::newFromID( $params['undo'] );
192 if ( is_null( $undoRev ) ||
$undoRev->isDeleted( Revision
::DELETED_TEXT
) ) {
193 $this->dieUsageMsg( array( 'nosuchrevid', $params['undo'] ) );
196 if ( $params['undoafter'] == 0 ) {
197 $undoafterRev = $undoRev->getPrevious();
199 if ( is_null( $undoafterRev ) ||
$undoafterRev->isDeleted( Revision
::DELETED_TEXT
) ) {
200 $this->dieUsageMsg( array( 'nosuchrevid', $params['undoafter'] ) );
203 if ( $undoRev->getPage() != $pageObj->getID() ) {
204 $this->dieUsageMsg( array( 'revwrongpage', $undoRev->getID(), $titleObj->getPrefixedText() ) );
206 if ( $undoafterRev->getPage() != $pageObj->getID() ) {
207 $this->dieUsageMsg( array( 'revwrongpage', $undoafterRev->getID(), $titleObj->getPrefixedText() ) );
210 $newContent = $contentHandler->getUndoContent( $pageObj->getRevision(), $undoRev, $undoafterRev );
212 if ( !$newContent ) {
213 $this->dieUsageMsg( 'undo-failure' );
216 $params['text'] = $newContent->serialize( $params['contentformat'] );
218 // If no summary was given and we only undid one rev,
219 // use an autosummary
220 if ( is_null( $params['summary'] ) && $titleObj->getNextRevisionID( $undoafterRev->getID() ) == $params['undo'] ) {
221 $params['summary'] = wfMessage( 'undo-summary', $params['undo'], $undoRev->getUserText() )->inContentLanguage()->text();
225 // See if the MD5 hash checks out
226 if ( !is_null( $params['md5'] ) && md5( $toMD5 ) !== $params['md5'] ) {
227 $this->dieUsageMsg( 'hashcheckfailed' );
230 // EditPage wants to parse its stuff from a WebRequest
231 // That interface kind of sucks, but it's workable
232 $requestArray = array(
233 'wpTextbox1' => $params['text'],
234 'format' => $contentFormat,
235 'model' => $contentHandler->getModelID(),
236 'wpEditToken' => $params['token'],
237 'wpIgnoreBlankSummary' => ''
240 if ( !is_null( $params['summary'] ) ) {
241 $requestArray['wpSummary'] = $params['summary'];
244 if ( !is_null( $params['sectiontitle'] ) ) {
245 $requestArray['wpSectionTitle'] = $params['sectiontitle'];
248 // TODO: Pass along information from 'undoafter' as well
249 if ( $params['undo'] > 0 ) {
250 $requestArray['wpUndidRevision'] = $params['undo'];
253 // Watch out for basetimestamp == ''
254 // wfTimestamp() treats it as NOW, almost certainly causing an edit conflict
255 if ( !is_null( $params['basetimestamp'] ) && $params['basetimestamp'] != '' ) {
256 $requestArray['wpEdittime'] = wfTimestamp( TS_MW
, $params['basetimestamp'] );
258 $requestArray['wpEdittime'] = $pageObj->getTimestamp();
261 if ( !is_null( $params['starttimestamp'] ) && $params['starttimestamp'] != '' ) {
262 $requestArray['wpStarttime'] = wfTimestamp( TS_MW
, $params['starttimestamp'] );
264 $requestArray['wpStarttime'] = wfTimestampNow(); // Fake wpStartime
267 if ( $params['minor'] ||
( !$params['notminor'] && $user->getOption( 'minordefault' ) ) ) {
268 $requestArray['wpMinoredit'] = '';
271 if ( $params['recreate'] ) {
272 $requestArray['wpRecreate'] = '';
275 if ( !is_null( $params['section'] ) ) {
276 $section = intval( $params['section'] );
277 if ( $section == 0 && $params['section'] != '0' && $params['section'] != 'new' ) {
278 $this->dieUsage( "The section parameter must be set to an integer or 'new'", "invalidsection" );
280 $requestArray['wpSection'] = $params['section'];
282 $requestArray['wpSection'] = '';
285 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
287 // Deprecated parameters
288 if ( $params['watch'] ) {
290 } elseif ( $params['unwatch'] ) {
295 $requestArray['wpWatchthis'] = '';
298 global $wgTitle, $wgRequest;
300 $req = new DerivativeRequest( $this->getRequest(), $requestArray, true );
302 // Some functions depend on $wgTitle == $ep->mTitle
303 // TODO: Make them not or check if they still do
304 $wgTitle = $titleObj;
306 $articleObject = new Article( $titleObj );
308 $articleContext = new RequestContext
;
309 $articleContext->setRequest( $req );
310 $articleContext->setTitle( $titleObj );
311 $articleObject->setContext( $articleContext );
313 $ep = new EditPage( $articleObject );
315 // allow editing of non-textual content.
316 $ep->allowNonTextContent
= true;
318 $ep->setContextTitle( $titleObj );
319 $ep->importFormData( $req );
322 // Handle APIEditBeforeSave parameters
324 if ( !wfRunHooks( 'APIEditBeforeSave', array( $ep, $ep->textbox1
, &$r ) ) ) {
326 $r['result'] = 'Failure';
327 $apiResult->addValue( null, $this->getModuleName(), $r );
330 $this->dieUsageMsg( 'hookaborted' );
334 // Do the actual save
335 $oldRevId = $articleObject->getRevIdFetched();
337 // Fake $wgRequest for some hooks inside EditPage
338 // @todo FIXME: This interface SUCKS
339 $oldRequest = $wgRequest;
342 $status = $ep->internalAttemptSave( $result, $user->isAllowed( 'bot' ) && $params['bot'] );
343 $wgRequest = $oldRequest;
344 global $wgMaxArticleSize;
346 switch( $status->value
) {
347 case EditPage
::AS_HOOK_ERROR
:
348 case EditPage
::AS_HOOK_ERROR_EXPECTED
:
349 $this->dieUsageMsg( 'hookaborted' );
351 case EditPage
::AS_PARSE_ERROR
:
352 $this->dieUsage( $status->getMessage(), 'parseerror' );
354 case EditPage
::AS_IMAGE_REDIRECT_ANON
:
355 $this->dieUsageMsg( 'noimageredirect-anon' );
357 case EditPage
::AS_IMAGE_REDIRECT_LOGGED
:
358 $this->dieUsageMsg( 'noimageredirect-logged' );
360 case EditPage
::AS_SPAM_ERROR
:
361 $this->dieUsageMsg( array( 'spamdetected', $result['spam'] ) );
363 case EditPage
::AS_BLOCKED_PAGE_FOR_USER
:
364 $this->dieUsageMsg( 'blockedtext' );
366 case EditPage
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
367 case EditPage
::AS_CONTENT_TOO_BIG
:
368 $this->dieUsageMsg( array( 'contenttoobig', $wgMaxArticleSize ) );
370 case EditPage
::AS_READ_ONLY_PAGE_ANON
:
371 $this->dieUsageMsg( 'noedit-anon' );
373 case EditPage
::AS_READ_ONLY_PAGE_LOGGED
:
374 $this->dieUsageMsg( 'noedit' );
376 case EditPage
::AS_READ_ONLY_PAGE
:
377 $this->dieReadOnly();
379 case EditPage
::AS_RATE_LIMITED
:
380 $this->dieUsageMsg( 'actionthrottledtext' );
382 case EditPage
::AS_ARTICLE_WAS_DELETED
:
383 $this->dieUsageMsg( 'wasdeleted' );
385 case EditPage
::AS_NO_CREATE_PERMISSION
:
386 $this->dieUsageMsg( 'nocreate-loggedin' );
388 case EditPage
::AS_BLANK_ARTICLE
:
389 $this->dieUsageMsg( 'blankpage' );
391 case EditPage
::AS_CONFLICT_DETECTED
:
392 $this->dieUsageMsg( 'editconflict' );
394 // case EditPage::AS_SUMMARY_NEEDED: Can't happen since we set wpIgnoreBlankSummary
395 case EditPage
::AS_TEXTBOX_EMPTY
:
396 $this->dieUsageMsg( 'emptynewsection' );
398 case EditPage
::AS_SUCCESS_NEW_ARTICLE
:
401 case EditPage
::AS_SUCCESS_UPDATE
:
402 $r['result'] = 'Success';
403 $r['pageid'] = intval( $titleObj->getArticleID() );
404 $r['title'] = $titleObj->getPrefixedText();
405 $r['contentmodel'] = $titleObj->getContentModel();
406 $newRevId = $articleObject->getLatest();
407 if ( $newRevId == $oldRevId ) {
410 $r['oldrevid'] = intval( $oldRevId );
411 $r['newrevid'] = intval( $newRevId );
413 $r['newtimestamp'] = wfTimestamp( TS_ISO_8601
,
414 $pageObj->getTimestamp() );
418 case EditPage
::AS_SUMMARY_NEEDED
:
419 $this->dieUsageMsg( 'summaryrequired' );
421 case EditPage
::AS_END
:
423 // $status came from WikiPage::doEdit()
424 $errors = $status->getErrorsArray();
425 $this->dieUsageMsg( $errors[0] ); // TODO: Add new errors to message map
428 $apiResult->addValue( null, $this->getModuleName(), $r );
431 public function mustBePosted() {
435 public function isWriteMode() {
439 public function getDescription() {
440 return 'Create and edit pages.';
443 public function getPossibleErrors() {
444 global $wgMaxArticleSize;
446 return array_merge( parent
::getPossibleErrors(),
447 $this->getTitleOrPageIdErrorMessage(),
449 array( 'missingtext' ),
450 array( 'createonly-exists' ),
451 array( 'nocreate-missing' ),
452 array( 'nosuchrevid', 'undo' ),
453 array( 'nosuchrevid', 'undoafter' ),
454 array( 'revwrongpage', 'id', 'text' ),
455 array( 'undo-failure' ),
456 array( 'hashcheckfailed' ),
457 array( 'hookaborted' ),
458 array( 'code' => 'parseerror', 'info' => 'Failed to parse the given text.' ),
459 array( 'noimageredirect-anon' ),
460 array( 'noimageredirect-logged' ),
461 array( 'spamdetected', 'spam' ),
462 array( 'summaryrequired' ),
463 array( 'blockedtext' ),
464 array( 'contenttoobig', $wgMaxArticleSize ),
465 array( 'noedit-anon' ),
467 array( 'actionthrottledtext' ),
468 array( 'wasdeleted' ),
469 array( 'nocreate-loggedin' ),
470 array( 'blankpage' ),
471 array( 'editconflict' ),
472 array( 'emptynewsection' ),
473 array( 'unknownerror', 'retval' ),
474 array( 'code' => 'nosuchsection', 'info' => 'There is no section section.' ),
475 array( 'code' => 'invalidsection', 'info' => 'The section parameter must be set to an integer or \'new\'' ),
476 array( 'code' => 'sectionsnotsupported', 'info' => 'Sections are not supported for this type of page.' ),
477 array( 'code' => 'editnotsupported', 'info' => 'Editing of this type of page is not supported using '
478 . 'the text based edit API.' ),
479 array( 'code' => 'appendnotsupported', 'info' => 'This type of page can not be edited by appending '
480 . 'or prepending text.' ),
481 array( 'code' => 'badformat', 'info' => 'The requested serialization format can not be applied to '
482 . 'the page\'s content model' ),
483 array( 'customcssprotected' ),
484 array( 'customjsprotected' ),
489 public function getAllowedParams() {
492 ApiBase
::PARAM_TYPE
=> 'string',
495 ApiBase
::PARAM_TYPE
=> 'integer',
498 'sectiontitle' => array(
499 ApiBase
::PARAM_TYPE
=> 'string',
500 ApiBase
::PARAM_REQUIRED
=> false,
504 ApiBase
::PARAM_TYPE
=> 'string',
505 ApiBase
::PARAM_REQUIRED
=> true
511 'basetimestamp' => null,
512 'starttimestamp' => null,
514 'createonly' => false,
517 ApiBase
::PARAM_DFLT
=> false,
518 ApiBase
::PARAM_DEPRECATED
=> true,
521 ApiBase
::PARAM_DFLT
=> false,
522 ApiBase
::PARAM_DEPRECATED
=> true,
524 'watchlist' => array(
525 ApiBase
::PARAM_DFLT
=> 'preferences',
526 ApiBase
::PARAM_TYPE
=> array(
534 'prependtext' => null,
535 'appendtext' => null,
537 ApiBase
::PARAM_TYPE
=> 'integer'
539 'undoafter' => array(
540 ApiBase
::PARAM_TYPE
=> 'integer'
543 ApiBase
::PARAM_TYPE
=> 'boolean',
544 ApiBase
::PARAM_DFLT
=> false,
546 'contentformat' => array(
547 ApiBase
::PARAM_TYPE
=> ContentHandler
::getAllContentFormats(),
549 'contentmodel' => array(
550 ApiBase
::PARAM_TYPE
=> ContentHandler
::getContentModels(),
555 public function getParamDescription() {
556 $p = $this->getModulePrefix();
558 'title' => "Title of the page you want to edit. Cannot be used together with {$p}pageid",
559 'pageid' => "Page ID of the page you want to edit. Cannot be used together with {$p}title",
560 'section' => 'Section number. 0 for the top section, \'new\' for a new section',
561 'sectiontitle' => 'The title for a new section',
562 'text' => 'Page content',
563 'token' => array( 'Edit token. You can get one of these through prop=info.',
564 "The token should always be sent as the last parameter, or at least, after the {$p}text parameter"
566 'summary' => "Edit summary. Also section title when {$p}section=new and {$p}sectiontitle is not set",
567 'minor' => 'Minor edit',
568 'notminor' => 'Non-minor edit',
569 'bot' => 'Mark this edit as bot',
570 'basetimestamp' => array( 'Timestamp of the base revision (obtained through prop=revisions&rvprop=timestamp).',
571 'Used to detect edit conflicts; leave unset to ignore conflicts'
573 'starttimestamp' => array( 'Timestamp when you obtained the edit token.',
574 'Used to detect edit conflicts; leave unset to ignore conflicts'
576 'recreate' => 'Override any errors about the article having been deleted in the meantime',
577 'createonly' => 'Don\'t edit the page if it exists already',
578 'nocreate' => 'Throw an error if the page doesn\'t exist',
579 'watch' => 'Add the page to your watchlist',
580 'unwatch' => 'Remove the page from your watchlist',
581 'watchlist' => 'Unconditionally add or remove the page from your watchlist, use preferences or do not change watch',
582 'md5' => array( "The MD5 hash of the {$p}text parameter, or the {$p}prependtext and {$p}appendtext parameters concatenated.",
583 'If set, the edit won\'t be done unless the hash is correct' ),
584 'prependtext' => "Add this text to the beginning of the page. Overrides {$p}text",
585 'appendtext' => array( "Add this text to the end of the page. Overrides {$p}text.",
586 "Use {$p}section=new to append a new section" ),
587 'undo' => "Undo this revision. Overrides {$p}text, {$p}prependtext and {$p}appendtext",
588 'undoafter' => 'Undo all revisions from undo to this one. If not set, just undo one revision',
589 'redirect' => 'Automatically resolve redirects',
590 'contentformat' => 'Content serialization format used for the input text',
591 'contentmodel' => 'Content model of the new content',
595 public function getResultProperties() {
600 ApiBase
::PROP_TYPE
=> array(
606 ApiBase
::PROP_TYPE
=> 'integer',
607 ApiBase
::PROP_NULLABLE
=> true
610 ApiBase
::PROP_TYPE
=> 'string',
611 ApiBase
::PROP_NULLABLE
=> true
613 'nochange' => 'boolean',
615 ApiBase
::PROP_TYPE
=> 'integer',
616 ApiBase
::PROP_NULLABLE
=> true
619 ApiBase
::PROP_TYPE
=> 'integer',
620 ApiBase
::PROP_NULLABLE
=> true
622 'newtimestamp' => array(
623 ApiBase
::PROP_TYPE
=> 'string',
624 ApiBase
::PROP_NULLABLE
=> true
630 public function needsToken() {
634 public function getTokenSalt() {
638 public function getExamples() {
641 'api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=20070824123454&token=%2B\\'
642 => 'Edit a page (anonymous user)',
644 'api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=20070824123454&token=%2B\\'
645 => 'Prepend __NOTOC__ to a page (anonymous user)',
646 'api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=20070824123454&token=%2B\\'
647 => 'Undo r13579 through r13585 with autosummary (anonymous user)',
651 public function getHelpUrls() {
652 return 'https://www.mediawiki.org/wiki/API:Edit';