Swap and for &&
[mediawiki.git] / includes / api / ApiEditPage.php
blobf2bb273eee22006d24e269226389cec809bfe374
1 <?php
2 /**
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
24 * @file
27 /**
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 * @ingroup API
34 class ApiEditPage extends ApiBase {
35 public function execute() {
36 $user = $this->getUser();
37 $params = $this->extractRequestParams();
39 if ( is_null( $params['text'] ) && is_null( $params['appendtext'] ) &&
40 is_null( $params['prependtext'] ) &&
41 $params['undo'] == 0
42 ) {
43 $this->dieUsageMsg( 'missingtext' );
46 $pageObj = $this->getTitleOrPageId( $params );
47 $titleObj = $pageObj->getTitle();
48 $apiResult = $this->getResult();
50 if ( $params['redirect'] ) {
51 if ( $params['prependtext'] === null && $params['appendtext'] === null && $params['section'] !== 'new' ) {
52 $this->dieUsage( 'You have attempted to edit using the "redirect"-following mode, which must be used in conjuction with section=new, prependtext, or appendtext.', 'redirect-appendonly' );
54 if ( $titleObj->isRedirect() ) {
55 $oldTitle = $titleObj;
57 $titles = Revision::newFromTitle( $oldTitle, false, Revision::READ_LATEST )
58 ->getContent( Revision::FOR_THIS_USER, $user )
59 ->getRedirectChain();
60 // array_shift( $titles );
62 $redirValues = array();
64 /** @var $newTitle Title */
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();
89 } else {
90 $contentHandler = ContentHandler::getForModelID( $params['contentmodel'] );
93 // @todo Ask handler whether direct editing is supported at all! make
94 // allowFlatEdit() method or some such
96 if ( !isset( $params['contentformat'] ) || $params['contentformat'] == '' ) {
97 $params['contentformat'] = $contentHandler->getDefaultFormat();
100 $contentFormat = $params['contentformat'];
102 if ( !$contentHandler->isSupportedFormat( $contentFormat ) ) {
103 $name = $titleObj->getPrefixedDBkey();
104 $model = $contentHandler->getModelID();
106 $this->dieUsage( "The requested format $contentFormat is not supported for content model " .
107 " $model used by $name", 'badformat' );
110 if ( $params['createonly'] && $titleObj->exists() ) {
111 $this->dieUsageMsg( 'createonly-exists' );
113 if ( $params['nocreate'] && !$titleObj->exists() ) {
114 $this->dieUsageMsg( 'nocreate-missing' );
117 // Now let's check whether we're even allowed to do this
118 $errors = $titleObj->getUserPermissionsErrors( 'edit', $user );
119 if ( !$titleObj->exists() ) {
120 $errors = array_merge( $errors, $titleObj->getUserPermissionsErrors( 'create', $user ) );
122 if ( count( $errors ) ) {
123 $this->dieUsageMsg( $errors[0] );
126 $toMD5 = $params['text'];
127 if ( !is_null( $params['appendtext'] ) || !is_null( $params['prependtext'] ) ) {
128 $content = $pageObj->getContent();
130 if ( !$content ) {
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 ) {
136 $text = '';
139 try {
140 $content = ContentHandler::makeContent( $text, $this->getTitle() );
141 } catch ( MWContentSerializationException $ex ) {
142 $this->dieUsage( $ex->getMessage(), 'parseerror' );
144 return;
146 } else {
147 # Otherwise, make a new empty content.
148 $content = $contentHandler->makeEmptyContent();
152 // @todo Add support for appending/prepending to the Content interface
154 if ( !( $content instanceof TextContent ) ) {
155 $mode = $contentHandler->getModelID();
156 $this->dieUsage( "Can't append to pages using content model $mode", 'appendnotsupported' );
159 if ( !is_null( $params['section'] ) ) {
160 if ( !$contentHandler->supportsSections() ) {
161 $modelName = $contentHandler->getModelID();
162 $this->dieUsage(
163 "Sections are not supported for this content model: $modelName.",
164 'sectionsnotsupported'
168 if ( $params['section'] == 'new' ) {
169 // DWIM if they're trying to prepend/append to a new section.
170 $content = null;
171 } else {
172 // Process the content for section edits
173 $section = $params['section'];
174 $content = $content->getSection( $section );
176 if ( !$content ) {
177 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
182 if ( !$content ) {
183 $text = '';
184 } else {
185 $text = $content->serialize( $contentFormat );
188 $params['text'] = $params['prependtext'] . $text . $params['appendtext'];
189 $toMD5 = $params['prependtext'] . $params['appendtext'];
192 if ( $params['undo'] > 0 ) {
193 if ( $params['undoafter'] > 0 ) {
194 if ( $params['undo'] < $params['undoafter'] ) {
195 list( $params['undo'], $params['undoafter'] ) =
196 array( $params['undoafter'], $params['undo'] );
198 $undoafterRev = Revision::newFromID( $params['undoafter'] );
200 $undoRev = Revision::newFromID( $params['undo'] );
201 if ( is_null( $undoRev ) || $undoRev->isDeleted( Revision::DELETED_TEXT ) ) {
202 $this->dieUsageMsg( array( 'nosuchrevid', $params['undo'] ) );
205 if ( $params['undoafter'] == 0 ) {
206 $undoafterRev = $undoRev->getPrevious();
208 if ( is_null( $undoafterRev ) || $undoafterRev->isDeleted( Revision::DELETED_TEXT ) ) {
209 $this->dieUsageMsg( array( 'nosuchrevid', $params['undoafter'] ) );
212 if ( $undoRev->getPage() != $pageObj->getID() ) {
213 $this->dieUsageMsg( array( 'revwrongpage', $undoRev->getID(),
214 $titleObj->getPrefixedText() ) );
216 if ( $undoafterRev->getPage() != $pageObj->getID() ) {
217 $this->dieUsageMsg( array( 'revwrongpage', $undoafterRev->getID(),
218 $titleObj->getPrefixedText() ) );
221 $newContent = $contentHandler->getUndoContent(
222 $pageObj->getRevision(),
223 $undoRev,
224 $undoafterRev
227 if ( !$newContent ) {
228 $this->dieUsageMsg( 'undo-failure' );
231 $params['text'] = $newContent->serialize( $params['contentformat'] );
233 // If no summary was given and we only undid one rev,
234 // use an autosummary
235 if ( is_null( $params['summary'] ) &&
236 $titleObj->getNextRevisionID( $undoafterRev->getID() ) == $params['undo']
238 $params['summary'] = wfMessage( 'undo-summary' )
239 ->params ( $params['undo'], $undoRev->getUserText() )->inContentLanguage()->text();
243 // See if the MD5 hash checks out
244 if ( !is_null( $params['md5'] ) && md5( $toMD5 ) !== $params['md5'] ) {
245 $this->dieUsageMsg( 'hashcheckfailed' );
248 // EditPage wants to parse its stuff from a WebRequest
249 // That interface kind of sucks, but it's workable
250 $requestArray = array(
251 'wpTextbox1' => $params['text'],
252 'format' => $contentFormat,
253 'model' => $contentHandler->getModelID(),
254 'wpEditToken' => $params['token'],
255 'wpIgnoreBlankSummary' => '',
256 'wpIgnoreBlankArticle' => true
259 if ( !is_null( $params['summary'] ) ) {
260 $requestArray['wpSummary'] = $params['summary'];
263 if ( !is_null( $params['sectiontitle'] ) ) {
264 $requestArray['wpSectionTitle'] = $params['sectiontitle'];
267 // TODO: Pass along information from 'undoafter' as well
268 if ( $params['undo'] > 0 ) {
269 $requestArray['wpUndidRevision'] = $params['undo'];
272 // Watch out for basetimestamp == ''
273 // wfTimestamp() treats it as NOW, almost certainly causing an edit conflict
274 if ( !is_null( $params['basetimestamp'] ) && $params['basetimestamp'] != '' ) {
275 $requestArray['wpEdittime'] = wfTimestamp( TS_MW, $params['basetimestamp'] );
276 } else {
277 $requestArray['wpEdittime'] = $pageObj->getTimestamp();
280 if ( !is_null( $params['starttimestamp'] ) && $params['starttimestamp'] != '' ) {
281 $requestArray['wpStarttime'] = wfTimestamp( TS_MW, $params['starttimestamp'] );
282 } else {
283 $requestArray['wpStarttime'] = wfTimestampNow(); // Fake wpStartime
286 if ( $params['minor'] || ( !$params['notminor'] && $user->getOption( 'minordefault' ) ) ) {
287 $requestArray['wpMinoredit'] = '';
290 if ( $params['recreate'] ) {
291 $requestArray['wpRecreate'] = '';
294 if ( !is_null( $params['section'] ) ) {
295 $section = $params['section'];
296 if ( !preg_match( '/^((T-)?\d+|new)$/', $section ) ) {
297 $this->dieUsage( "The section parameter must be a valid section id or 'new'", "invalidsection" );
299 $content = $pageObj->getContent();
300 if ( $section !== '0' && $section != 'new' && ( !$content || !$content->getSection( $section ) ) ) {
301 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
303 $requestArray['wpSection'] = $params['section'];
304 } else {
305 $requestArray['wpSection'] = '';
308 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
310 // Deprecated parameters
311 if ( $params['watch'] ) {
312 $this->logFeatureUsage( 'action=edit&watch' );
313 $watch = true;
314 } elseif ( $params['unwatch'] ) {
315 $this->logFeatureUsage( 'action=edit&unwatch' );
316 $watch = false;
319 if ( $watch ) {
320 $requestArray['wpWatchthis'] = '';
323 // Pass through anything else we might have been given, to support extensions
324 // This is kind of a hack but it's the best we can do to make extensions work
325 $requestArray += $this->getRequest()->getValues();
327 global $wgTitle, $wgRequest;
329 $req = new DerivativeRequest( $this->getRequest(), $requestArray, true );
331 // Some functions depend on $wgTitle == $ep->mTitle
332 // TODO: Make them not or check if they still do
333 $wgTitle = $titleObj;
335 $articleContext = new RequestContext;
336 $articleContext->setRequest( $req );
337 $articleContext->setWikiPage( $pageObj );
338 $articleContext->setUser( $this->getUser() );
340 /** @var $articleObject Article */
341 $articleObject = Article::newFromWikiPage( $pageObj, $articleContext );
343 $ep = new EditPage( $articleObject );
345 // allow editing of non-textual content.
346 $ep->allowNonTextContent = true;
348 $ep->setContextTitle( $titleObj );
349 $ep->importFormData( $req );
350 $content = $ep->textbox1;
352 // The following is needed to give the hook the full content of the
353 // new revision rather than just the current section. (Bug 52077)
354 if ( !is_null( $params['section'] ) &&
355 $contentHandler->supportsSections() && $titleObj->exists()
357 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
358 // backwards compatibility with old forms/bots).
359 if ( $ep->sectiontitle !== '' ) {
360 $sectionTitle = $ep->sectiontitle;
361 } else {
362 $sectionTitle = $ep->summary;
365 $contentObj = $contentHandler->unserializeContent( $content, $contentFormat );
367 $fullContentObj = $articleObject->replaceSectionContent(
368 $params['section'],
369 $contentObj,
370 $sectionTitle
372 if ( $fullContentObj ) {
373 $content = $fullContentObj->serialize( $contentFormat );
374 } else {
375 // This most likely means we have an edit conflict which means that the edit
376 // wont succeed anyway.
377 $this->dieUsageMsg( 'editconflict' );
381 // Run hooks
382 // Handle APIEditBeforeSave parameters
383 $r = array();
384 if ( !wfRunHooks( 'APIEditBeforeSave', array( $ep, $content, &$r ) ) ) {
385 if ( count( $r ) ) {
386 $r['result'] = 'Failure';
387 $apiResult->addValue( null, $this->getModuleName(), $r );
389 return;
392 $this->dieUsageMsg( 'hookaborted' );
395 // Do the actual save
396 $oldRevId = $articleObject->getRevIdFetched();
397 $result = null;
398 // Fake $wgRequest for some hooks inside EditPage
399 // @todo FIXME: This interface SUCKS
400 $oldRequest = $wgRequest;
401 $wgRequest = $req;
403 $status = $ep->internalAttemptSave( $result, $user->isAllowed( 'bot' ) && $params['bot'] );
404 $wgRequest = $oldRequest;
406 switch ( $status->value ) {
407 case EditPage::AS_HOOK_ERROR:
408 case EditPage::AS_HOOK_ERROR_EXPECTED:
409 $this->dieUsageMsg( 'hookaborted' );
411 case EditPage::AS_PARSE_ERROR:
412 $this->dieUsage( $status->getMessage(), 'parseerror' );
414 case EditPage::AS_IMAGE_REDIRECT_ANON:
415 $this->dieUsageMsg( 'noimageredirect-anon' );
417 case EditPage::AS_IMAGE_REDIRECT_LOGGED:
418 $this->dieUsageMsg( 'noimageredirect-logged' );
420 case EditPage::AS_SPAM_ERROR:
421 $this->dieUsageMsg( array( 'spamdetected', $result['spam'] ) );
423 case EditPage::AS_BLOCKED_PAGE_FOR_USER:
424 $this->dieUsageMsg( 'blockedtext' );
426 case EditPage::AS_MAX_ARTICLE_SIZE_EXCEEDED:
427 case EditPage::AS_CONTENT_TOO_BIG:
428 $this->dieUsageMsg( array( 'contenttoobig', $this->getConfig()->get( 'MaxArticleSize' ) ) );
430 case EditPage::AS_READ_ONLY_PAGE_ANON:
431 $this->dieUsageMsg( 'noedit-anon' );
433 case EditPage::AS_READ_ONLY_PAGE_LOGGED:
434 $this->dieUsageMsg( 'noedit' );
436 case EditPage::AS_READ_ONLY_PAGE:
437 $this->dieReadOnly();
439 case EditPage::AS_RATE_LIMITED:
440 $this->dieUsageMsg( 'actionthrottledtext' );
442 case EditPage::AS_ARTICLE_WAS_DELETED:
443 $this->dieUsageMsg( 'wasdeleted' );
445 case EditPage::AS_NO_CREATE_PERMISSION:
446 $this->dieUsageMsg( 'nocreate-loggedin' );
448 case EditPage::AS_BLANK_ARTICLE:
449 $this->dieUsageMsg( 'blankpage' );
451 case EditPage::AS_CONFLICT_DETECTED:
452 $this->dieUsageMsg( 'editconflict' );
454 // case EditPage::AS_SUMMARY_NEEDED: Can't happen since we set wpIgnoreBlankSummary
455 case EditPage::AS_TEXTBOX_EMPTY:
456 $this->dieUsageMsg( 'emptynewsection' );
458 case EditPage::AS_SUCCESS_NEW_ARTICLE:
459 $r['new'] = '';
460 // fall-through
462 case EditPage::AS_SUCCESS_UPDATE:
463 $r['result'] = 'Success';
464 $r['pageid'] = intval( $titleObj->getArticleID() );
465 $r['title'] = $titleObj->getPrefixedText();
466 $r['contentmodel'] = $titleObj->getContentModel();
467 $newRevId = $articleObject->getLatest();
468 if ( $newRevId == $oldRevId ) {
469 $r['nochange'] = '';
470 } else {
471 $r['oldrevid'] = intval( $oldRevId );
472 $r['newrevid'] = intval( $newRevId );
473 $r['newtimestamp'] = wfTimestamp( TS_ISO_8601,
474 $pageObj->getTimestamp() );
476 break;
478 case EditPage::AS_SUMMARY_NEEDED:
479 $this->dieUsageMsg( 'summaryrequired' );
481 case EditPage::AS_END:
482 default:
483 // $status came from WikiPage::doEdit()
484 $errors = $status->getErrorsArray();
485 $this->dieUsageMsg( $errors[0] ); // TODO: Add new errors to message map
486 break;
488 $apiResult->addValue( null, $this->getModuleName(), $r );
491 public function mustBePosted() {
492 return true;
495 public function isWriteMode() {
496 return true;
499 public function getAllowedParams() {
500 return array(
501 'title' => array(
502 ApiBase::PARAM_TYPE => 'string',
504 'pageid' => array(
505 ApiBase::PARAM_TYPE => 'integer',
507 'section' => null,
508 'sectiontitle' => array(
509 ApiBase::PARAM_TYPE => 'string',
511 'text' => null,
512 'summary' => null,
513 'minor' => false,
514 'notminor' => false,
515 'bot' => false,
516 'basetimestamp' => null,
517 'starttimestamp' => null,
518 'recreate' => false,
519 'createonly' => false,
520 'nocreate' => false,
521 'watch' => array(
522 ApiBase::PARAM_DFLT => false,
523 ApiBase::PARAM_DEPRECATED => true,
525 'unwatch' => array(
526 ApiBase::PARAM_DFLT => false,
527 ApiBase::PARAM_DEPRECATED => true,
529 'watchlist' => array(
530 ApiBase::PARAM_DFLT => 'preferences',
531 ApiBase::PARAM_TYPE => array(
532 'watch',
533 'unwatch',
534 'preferences',
535 'nochange'
538 'md5' => null,
539 'prependtext' => null,
540 'appendtext' => null,
541 'undo' => array(
542 ApiBase::PARAM_TYPE => 'integer'
544 'undoafter' => array(
545 ApiBase::PARAM_TYPE => 'integer'
547 'redirect' => array(
548 ApiBase::PARAM_TYPE => 'boolean',
549 ApiBase::PARAM_DFLT => false,
551 'contentformat' => array(
552 ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(),
554 'contentmodel' => array(
555 ApiBase::PARAM_TYPE => ContentHandler::getContentModels(),
557 'token' => array(
558 // Standard definition automatically inserted
559 ApiBase::PARAM_HELP_MSG_APPEND => array( 'apihelp-edit-param-token' ),
564 public function needsToken() {
565 return 'csrf';
568 public function getExamplesMessages() {
569 return array(
570 'action=edit&title=Test&summary=test%20summary&' .
571 'text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
572 => 'apihelp-edit-example-edit',
573 'action=edit&title=Test&summary=NOTOC&minor=&' .
574 'prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
575 => 'apihelp-edit-example-prepend',
576 'action=edit&title=Test&undo=13585&undoafter=13579&' .
577 'basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
578 => 'apihelp-edit-example-undo',
582 public function getHelpUrls() {
583 return 'https://www.mediawiki.org/wiki/API:Edit';