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,
32 * see T20654 if you're inspired to fix this.
36 class ApiEditPage
extends ApiBase
{
37 public function execute() {
38 $this->useTransactionalTimeLimit();
40 $user = $this->getUser();
41 $params = $this->extractRequestParams();
43 if ( is_null( $params['text'] ) && is_null( $params['appendtext'] ) &&
44 is_null( $params['prependtext'] ) &&
47 $this->dieUsageMsg( 'missingtext' );
50 $pageObj = $this->getTitleOrPageId( $params );
51 $titleObj = $pageObj->getTitle();
52 $apiResult = $this->getResult();
54 if ( $params['redirect'] ) {
55 if ( $params['prependtext'] === null && $params['appendtext'] === null
56 && $params['section'] !== 'new'
58 $this->dieUsage( 'You have attempted to edit using the "redirect"-following'
59 . ' mode, which must be used in conjuction with section=new, prependtext'
60 . ', or appendtext.', 'redirect-appendonly' );
62 if ( $titleObj->isRedirect() ) {
63 $oldTitle = $titleObj;
65 $titles = Revision
::newFromTitle( $oldTitle, false, Revision
::READ_LATEST
)
66 ->getContent( Revision
::FOR_THIS_USER
, $user )
68 // array_shift( $titles );
72 /** @var $newTitle Title */
73 foreach ( $titles as $id => $newTitle ) {
75 if ( !isset( $titles[$id - 1] ) ) {
76 $titles[$id - 1] = $oldTitle;
80 'from' => $titles[$id - 1]->getPrefixedText(),
81 'to' => $newTitle->getPrefixedText()
84 $titleObj = $newTitle;
87 ApiResult
::setIndexedTagName( $redirValues, 'r' );
88 $apiResult->addValue( null, 'redirects', $redirValues );
90 // Since the page changed, update $pageObj
91 $pageObj = WikiPage
::factory( $titleObj );
95 if ( !isset( $params['contentmodel'] ) ||
$params['contentmodel'] == '' ) {
96 $contentHandler = $pageObj->getContentHandler();
98 $contentHandler = ContentHandler
::getForModelID( $params['contentmodel'] );
101 $name = $titleObj->getPrefixedDBkey();
102 $model = $contentHandler->getModelID();
104 if ( $params['undo'] > 0 ) {
105 // allow undo via api
106 } elseif ( $contentHandler->supportsDirectApiEditing() === false ) {
108 "Direct editing via API is not supported for content model $model used by $name",
113 if ( !isset( $params['contentformat'] ) ||
$params['contentformat'] == '' ) {
114 $params['contentformat'] = $contentHandler->getDefaultFormat();
117 $contentFormat = $params['contentformat'];
119 if ( !$contentHandler->isSupportedFormat( $contentFormat ) ) {
121 $this->dieUsage( "The requested format $contentFormat is not supported for content model " .
122 " $model used by $name", 'badformat' );
125 if ( $params['createonly'] && $titleObj->exists() ) {
126 $this->dieUsageMsg( 'createonly-exists' );
128 if ( $params['nocreate'] && !$titleObj->exists() ) {
129 $this->dieUsageMsg( 'nocreate-missing' );
132 // Now let's check whether we're even allowed to do this
133 $errors = $titleObj->getUserPermissionsErrors( 'edit', $user );
134 if ( !$titleObj->exists() ) {
135 $errors = array_merge( $errors, $titleObj->getUserPermissionsErrors( 'create', $user ) );
137 if ( count( $errors ) ) {
138 if ( is_array( $errors[0] ) ) {
139 switch ( $errors[0][0] ) {
142 'You have been blocked from editing',
145 [ 'blockinfo' => ApiQueryUserInfo
::getBlockInfo( $user->getBlock() ) ]
148 case 'autoblockedtext':
150 'Your IP address has been blocked automatically, because it was used by a blocked user',
153 [ 'blockinfo' => ApiQueryUserInfo
::getBlockInfo( $user->getBlock() ) ]
157 $this->dieUsageMsg( $errors[0] );
160 $this->dieUsageMsg( $errors[0] );
164 $toMD5 = $params['text'];
165 if ( !is_null( $params['appendtext'] ) ||
!is_null( $params['prependtext'] ) ) {
166 $content = $pageObj->getContent();
169 if ( $titleObj->getNamespace() == NS_MEDIAWIKI
) {
170 # If this is a MediaWiki:x message, then load the messages
171 # and return the message value for x.
172 $text = $titleObj->getDefaultMessageText();
173 if ( $text === false ) {
178 $content = ContentHandler
::makeContent( $text, $this->getTitle() );
179 } catch ( MWContentSerializationException
$ex ) {
180 $this->dieUsage( $ex->getMessage(), 'parseerror' );
185 # Otherwise, make a new empty content.
186 $content = $contentHandler->makeEmptyContent();
190 // @todo Add support for appending/prepending to the Content interface
192 if ( !( $content instanceof TextContent
) ) {
193 $mode = $contentHandler->getModelID();
194 $this->dieUsage( "Can't append to pages using content model $mode", 'appendnotsupported' );
197 if ( !is_null( $params['section'] ) ) {
198 if ( !$contentHandler->supportsSections() ) {
199 $modelName = $contentHandler->getModelID();
201 "Sections are not supported for this content model: $modelName.",
202 'sectionsnotsupported'
206 if ( $params['section'] == 'new' ) {
207 // DWIM if they're trying to prepend/append to a new section.
210 // Process the content for section edits
211 $section = $params['section'];
212 $content = $content->getSection( $section );
215 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
223 $text = $content->serialize( $contentFormat );
226 $params['text'] = $params['prependtext'] . $text . $params['appendtext'];
227 $toMD5 = $params['prependtext'] . $params['appendtext'];
230 if ( $params['undo'] > 0 ) {
231 if ( $params['undoafter'] > 0 ) {
232 if ( $params['undo'] < $params['undoafter'] ) {
233 list( $params['undo'], $params['undoafter'] ) =
234 [ $params['undoafter'], $params['undo'] ];
236 $undoafterRev = Revision
::newFromId( $params['undoafter'] );
238 $undoRev = Revision
::newFromId( $params['undo'] );
239 if ( is_null( $undoRev ) ||
$undoRev->isDeleted( Revision
::DELETED_TEXT
) ) {
240 $this->dieUsageMsg( [ 'nosuchrevid', $params['undo'] ] );
243 if ( $params['undoafter'] == 0 ) {
244 $undoafterRev = $undoRev->getPrevious();
246 if ( is_null( $undoafterRev ) ||
$undoafterRev->isDeleted( Revision
::DELETED_TEXT
) ) {
247 $this->dieUsageMsg( [ 'nosuchrevid', $params['undoafter'] ] );
250 if ( $undoRev->getPage() != $pageObj->getId() ) {
251 $this->dieUsageMsg( [ 'revwrongpage', $undoRev->getId(),
252 $titleObj->getPrefixedText() ] );
254 if ( $undoafterRev->getPage() != $pageObj->getId() ) {
255 $this->dieUsageMsg( [ 'revwrongpage', $undoafterRev->getId(),
256 $titleObj->getPrefixedText() ] );
259 $newContent = $contentHandler->getUndoContent(
260 $pageObj->getRevision(),
265 if ( !$newContent ) {
266 $this->dieUsageMsg( 'undo-failure' );
269 $params['text'] = $newContent->serialize( $params['contentformat'] );
271 // If no summary was given and we only undid one rev,
272 // use an autosummary
273 if ( is_null( $params['summary'] ) &&
274 $titleObj->getNextRevisionID( $undoafterRev->getId() ) == $params['undo']
276 $params['summary'] = wfMessage( 'undo-summary' )
277 ->params( $params['undo'], $undoRev->getUserText() )->inContentLanguage()->text();
281 // See if the MD5 hash checks out
282 if ( !is_null( $params['md5'] ) && md5( $toMD5 ) !== $params['md5'] ) {
283 $this->dieUsageMsg( 'hashcheckfailed' );
286 // EditPage wants to parse its stuff from a WebRequest
287 // That interface kind of sucks, but it's workable
289 'wpTextbox1' => $params['text'],
290 'format' => $contentFormat,
291 'model' => $contentHandler->getModelID(),
292 'wpEditToken' => $params['token'],
293 'wpIgnoreBlankSummary' => true,
294 'wpIgnoreBlankArticle' => true,
295 'wpIgnoreSelfRedirect' => true,
296 'bot' => $params['bot'],
299 if ( !is_null( $params['summary'] ) ) {
300 $requestArray['wpSummary'] = $params['summary'];
303 if ( !is_null( $params['sectiontitle'] ) ) {
304 $requestArray['wpSectionTitle'] = $params['sectiontitle'];
307 // TODO: Pass along information from 'undoafter' as well
308 if ( $params['undo'] > 0 ) {
309 $requestArray['wpUndidRevision'] = $params['undo'];
312 // Watch out for basetimestamp == '' or '0'
313 // It gets treated as NOW, almost certainly causing an edit conflict
314 if ( $params['basetimestamp'] !== null && (bool)$this->getMain()->getVal( 'basetimestamp' ) ) {
315 $requestArray['wpEdittime'] = $params['basetimestamp'];
317 $requestArray['wpEdittime'] = $pageObj->getTimestamp();
320 if ( $params['starttimestamp'] !== null ) {
321 $requestArray['wpStarttime'] = $params['starttimestamp'];
323 $requestArray['wpStarttime'] = wfTimestampNow(); // Fake wpStartime
326 if ( $params['minor'] ||
( !$params['notminor'] && $user->getOption( 'minordefault' ) ) ) {
327 $requestArray['wpMinoredit'] = '';
330 if ( $params['recreate'] ) {
331 $requestArray['wpRecreate'] = '';
334 if ( !is_null( $params['section'] ) ) {
335 $section = $params['section'];
336 if ( !preg_match( '/^((T-)?\d+|new)$/', $section ) ) {
337 $this->dieUsage( "The section parameter must be a valid section id or 'new'",
340 $content = $pageObj->getContent();
341 if ( $section !== '0' && $section != 'new'
342 && ( !$content ||
!$content->getSection( $section ) )
344 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
346 $requestArray['wpSection'] = $params['section'];
348 $requestArray['wpSection'] = '';
351 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
353 // Deprecated parameters
354 if ( $params['watch'] ) {
356 } elseif ( $params['unwatch'] ) {
361 $requestArray['wpWatchthis'] = '';
365 if ( count( $params['tags'] ) ) {
366 $tagStatus = ChangeTags
::canAddTagsAccompanyingChange( $params['tags'], $user );
367 if ( $tagStatus->isOK() ) {
368 $requestArray['wpChangeTags'] = implode( ',', $params['tags'] );
370 $this->dieStatus( $tagStatus );
374 // Pass through anything else we might have been given, to support extensions
375 // This is kind of a hack but it's the best we can do to make extensions work
376 $requestArray +
= $this->getRequest()->getValues();
378 global $wgTitle, $wgRequest;
380 $req = new DerivativeRequest( $this->getRequest(), $requestArray, true );
382 // Some functions depend on $wgTitle == $ep->mTitle
383 // TODO: Make them not or check if they still do
384 $wgTitle = $titleObj;
386 $articleContext = new RequestContext
;
387 $articleContext->setRequest( $req );
388 $articleContext->setWikiPage( $pageObj );
389 $articleContext->setUser( $this->getUser() );
391 /** @var $articleObject Article */
392 $articleObject = Article
::newFromWikiPage( $pageObj, $articleContext );
394 $ep = new EditPage( $articleObject );
396 $ep->setApiEditOverride( true );
397 $ep->setContextTitle( $titleObj );
398 $ep->importFormData( $req );
399 $content = $ep->textbox1
;
401 // The following is needed to give the hook the full content of the
402 // new revision rather than just the current section. (Bug 52077)
403 if ( !is_null( $params['section'] ) &&
404 $contentHandler->supportsSections() && $titleObj->exists()
406 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
407 // backwards compatibility with old forms/bots).
408 if ( $ep->sectiontitle
!== '' ) {
409 $sectionTitle = $ep->sectiontitle
;
411 $sectionTitle = $ep->summary
;
414 $contentObj = $contentHandler->unserializeContent( $content, $contentFormat );
416 $fullContentObj = $articleObject->replaceSectionContent(
421 if ( $fullContentObj ) {
422 $content = $fullContentObj->serialize( $contentFormat );
424 // This most likely means we have an edit conflict which means that the edit
425 // wont succeed anyway.
426 $this->dieUsageMsg( 'editconflict' );
431 // Handle APIEditBeforeSave parameters
433 if ( !Hooks
::run( 'APIEditBeforeSave', [ $ep, $content, &$r ] ) ) {
435 $r['result'] = 'Failure';
436 $apiResult->addValue( null, $this->getModuleName(), $r );
441 $this->dieUsageMsg( 'hookaborted' );
444 // Do the actual save
445 $oldRevId = $articleObject->getRevIdFetched();
447 // Fake $wgRequest for some hooks inside EditPage
448 // @todo FIXME: This interface SUCKS
449 $oldRequest = $wgRequest;
452 $status = $ep->attemptSave( $result );
453 $wgRequest = $oldRequest;
455 switch ( $status->value
) {
456 case EditPage
::AS_HOOK_ERROR
:
457 case EditPage
::AS_HOOK_ERROR_EXPECTED
:
458 if ( isset( $status->apiHookResult
) ) {
459 $r = $status->apiHookResult
;
460 $r['result'] = 'Failure';
461 $apiResult->addValue( null, $this->getModuleName(), $r );
464 $this->dieUsageMsg( 'hookaborted' );
467 case EditPage
::AS_PARSE_ERROR
:
468 $this->dieUsage( $status->getMessage(), 'parseerror' );
470 case EditPage
::AS_IMAGE_REDIRECT_ANON
:
471 $this->dieUsageMsg( 'noimageredirect-anon' );
473 case EditPage
::AS_IMAGE_REDIRECT_LOGGED
:
474 $this->dieUsageMsg( 'noimageredirect-logged' );
476 case EditPage
::AS_SPAM_ERROR
:
477 $this->dieUsageMsg( [ 'spamdetected', $result['spam'] ] );
479 case EditPage
::AS_BLOCKED_PAGE_FOR_USER
:
481 'You have been blocked from editing',
484 [ 'blockinfo' => ApiQueryUserInfo
::getBlockInfo( $user->getBlock() ) ]
487 case EditPage
::AS_MAX_ARTICLE_SIZE_EXCEEDED
:
488 case EditPage
::AS_CONTENT_TOO_BIG
:
489 $this->dieUsageMsg( [ 'contenttoobig', $this->getConfig()->get( 'MaxArticleSize' ) ] );
491 case EditPage
::AS_READ_ONLY_PAGE_ANON
:
492 $this->dieUsageMsg( 'noedit-anon' );
494 case EditPage
::AS_READ_ONLY_PAGE_LOGGED
:
495 $this->dieUsageMsg( 'noedit' );
497 case EditPage
::AS_READ_ONLY_PAGE
:
498 $this->dieReadOnly();
500 case EditPage
::AS_RATE_LIMITED
:
501 $this->dieUsageMsg( 'actionthrottledtext' );
503 case EditPage
::AS_ARTICLE_WAS_DELETED
:
504 $this->dieUsageMsg( 'wasdeleted' );
506 case EditPage
::AS_NO_CREATE_PERMISSION
:
507 $this->dieUsageMsg( 'nocreate-loggedin' );
509 case EditPage
::AS_NO_CHANGE_CONTENT_MODEL
:
510 $this->dieUsageMsg( 'cantchangecontentmodel' );
512 case EditPage
::AS_BLANK_ARTICLE
:
513 $this->dieUsageMsg( 'blankpage' );
515 case EditPage
::AS_CONFLICT_DETECTED
:
516 $this->dieUsageMsg( 'editconflict' );
518 case EditPage
::AS_TEXTBOX_EMPTY
:
519 $this->dieUsageMsg( 'emptynewsection' );
521 case EditPage
::AS_CHANGE_TAG_ERROR
:
522 $this->dieStatus( $status );
524 case EditPage
::AS_SUCCESS_NEW_ARTICLE
:
528 case EditPage
::AS_SUCCESS_UPDATE
:
529 $r['result'] = 'Success';
530 $r['pageid'] = intval( $titleObj->getArticleID() );
531 $r['title'] = $titleObj->getPrefixedText();
532 $r['contentmodel'] = $articleObject->getContentModel();
533 $newRevId = $articleObject->getLatest();
534 if ( $newRevId == $oldRevId ) {
535 $r['nochange'] = true;
537 $r['oldrevid'] = intval( $oldRevId );
538 $r['newrevid'] = intval( $newRevId );
539 $r['newtimestamp'] = wfTimestamp( TS_ISO_8601
,
540 $pageObj->getTimestamp() );
544 case EditPage
::AS_SUMMARY_NEEDED
:
545 // Shouldn't happen since we set wpIgnoreBlankSummary, but just in case
546 $this->dieUsageMsg( 'summaryrequired' );
548 case EditPage
::AS_END
:
550 // $status came from WikiPage::doEdit()
551 $errors = $status->getErrorsArray();
552 $this->dieUsageMsg( $errors[0] ); // TODO: Add new errors to message map
555 $apiResult->addValue( null, $this->getModuleName(), $r );
558 public function mustBePosted() {
562 public function isWriteMode() {
566 public function getAllowedParams() {
569 ApiBase
::PARAM_TYPE
=> 'string',
572 ApiBase
::PARAM_TYPE
=> 'integer',
576 ApiBase
::PARAM_TYPE
=> 'string',
579 ApiBase
::PARAM_TYPE
=> 'text',
583 ApiBase
::PARAM_TYPE
=> 'tags',
584 ApiBase
::PARAM_ISMULTI
=> true,
590 ApiBase
::PARAM_TYPE
=> 'timestamp',
592 'starttimestamp' => [
593 ApiBase
::PARAM_TYPE
=> 'timestamp',
596 'createonly' => false,
599 ApiBase
::PARAM_DFLT
=> false,
600 ApiBase
::PARAM_DEPRECATED
=> true,
603 ApiBase
::PARAM_DFLT
=> false,
604 ApiBase
::PARAM_DEPRECATED
=> true,
607 ApiBase
::PARAM_DFLT
=> 'preferences',
608 ApiBase
::PARAM_TYPE
=> [
617 ApiBase
::PARAM_TYPE
=> 'text',
620 ApiBase
::PARAM_TYPE
=> 'text',
623 ApiBase
::PARAM_TYPE
=> 'integer'
626 ApiBase
::PARAM_TYPE
=> 'integer'
629 ApiBase
::PARAM_TYPE
=> 'boolean',
630 ApiBase
::PARAM_DFLT
=> false,
633 ApiBase
::PARAM_TYPE
=> ContentHandler
::getAllContentFormats(),
636 ApiBase
::PARAM_TYPE
=> ContentHandler
::getContentModels(),
639 // Standard definition automatically inserted
640 ApiBase
::PARAM_HELP_MSG_APPEND
=> [ 'apihelp-edit-param-token' ],
645 public function needsToken() {
649 protected function getExamplesMessages() {
651 'action=edit&title=Test&summary=test%20summary&' .
652 'text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
653 => 'apihelp-edit-example-edit',
654 'action=edit&title=Test&summary=NOTOC&minor=&' .
655 'prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
656 => 'apihelp-edit-example-prepend',
657 'action=edit&title=Test&undo=13585&undoafter=13579&' .
658 'basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
659 => 'apihelp-edit-example-undo',
663 public function getHelpUrls() {
664 return 'https://www.mediawiki.org/wiki/API:Edit';