Merge "Pass context to FormatMetadata class on ImagePage"
[lhc/web/wiklou.git] / includes / api / ApiEditPage.php
1 <?php
2 /**
3 *
4 *
5 * Created on August 16, 2007
6 *
7 * Copyright © 2007 Iker Labarga "<Firstname><Lastname>@gmail.com"
8 *
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.
13 *
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.
18 *
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
23 *
24 * @file
25 */
26
27 /**
28 * A module that allows for editing and creating pages.
29 *
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
33 */
34 class ApiEditPage extends ApiBase {
35 public function execute() {
36 $user = $this->getUser();
37 $params = $this->extractRequestParams();
38
39 if ( is_null( $params['text'] ) && is_null( $params['appendtext'] ) &&
40 is_null( $params['prependtext'] ) &&
41 $params['undo'] == 0
42 ) {
43 $this->dieUsageMsg( 'missingtext' );
44 }
45
46 $pageObj = $this->getTitleOrPageId( $params );
47 $titleObj = $pageObj->getTitle();
48 $apiResult = $this->getResult();
49
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' );
53 }
54 if ( $titleObj->isRedirect() ) {
55 $oldTitle = $titleObj;
56
57 $titles = Revision::newFromTitle( $oldTitle, false, Revision::READ_LATEST )
58 ->getContent( Revision::FOR_THIS_USER, $user )
59 ->getRedirectChain();
60 // array_shift( $titles );
61
62 $redirValues = array();
63
64 /** @var $newTitle Title */
65 foreach ( $titles as $id => $newTitle ) {
66
67 if ( !isset( $titles[$id - 1] ) ) {
68 $titles[$id - 1] = $oldTitle;
69 }
70
71 $redirValues[] = array(
72 'from' => $titles[$id - 1]->getPrefixedText(),
73 'to' => $newTitle->getPrefixedText()
74 );
75
76 $titleObj = $newTitle;
77 }
78
79 $apiResult->setIndexedTagName( $redirValues, 'r' );
80 $apiResult->addValue( null, 'redirects', $redirValues );
81
82 // Since the page changed, update $pageObj
83 $pageObj = WikiPage::factory( $titleObj );
84 }
85 }
86
87 if ( !isset( $params['contentmodel'] ) || $params['contentmodel'] == '' ) {
88 $contentHandler = $pageObj->getContentHandler();
89 } else {
90 $contentHandler = ContentHandler::getForModelID( $params['contentmodel'] );
91 }
92
93 // @todo Ask handler whether direct editing is supported at all! make
94 // allowFlatEdit() method or some such
95
96 if ( !isset( $params['contentformat'] ) || $params['contentformat'] == '' ) {
97 $params['contentformat'] = $contentHandler->getDefaultFormat();
98 }
99
100 $contentFormat = $params['contentformat'];
101
102 if ( !$contentHandler->isSupportedFormat( $contentFormat ) ) {
103 $name = $titleObj->getPrefixedDBkey();
104 $model = $contentHandler->getModelID();
105
106 $this->dieUsage( "The requested format $contentFormat is not supported for content model " .
107 " $model used by $name", 'badformat' );
108 }
109
110 if ( $params['createonly'] && $titleObj->exists() ) {
111 $this->dieUsageMsg( 'createonly-exists' );
112 }
113 if ( $params['nocreate'] && !$titleObj->exists() ) {
114 $this->dieUsageMsg( 'nocreate-missing' );
115 }
116
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 ) );
121 }
122 if ( count( $errors ) ) {
123 $this->dieUsageMsg( $errors[0] );
124 }
125
126 $toMD5 = $params['text'];
127 if ( !is_null( $params['appendtext'] ) || !is_null( $params['prependtext'] ) ) {
128 $content = $pageObj->getContent();
129
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 = '';
137 }
138
139 try {
140 $content = ContentHandler::makeContent( $text, $this->getTitle() );
141 } catch ( MWContentSerializationException $ex ) {
142 $this->dieUsage( $ex->getMessage(), 'parseerror' );
143
144 return;
145 }
146 } else {
147 # Otherwise, make a new empty content.
148 $content = $contentHandler->makeEmptyContent();
149 }
150 }
151
152 // @todo Add support for appending/prepending to the Content interface
153
154 if ( !( $content instanceof TextContent ) ) {
155 $mode = $contentHandler->getModelID();
156 $this->dieUsage( "Can't append to pages using content model $mode", 'appendnotsupported' );
157 }
158
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'
165 );
166 }
167
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 );
175
176 if ( !$content ) {
177 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
178 }
179 }
180 }
181
182 if ( !$content ) {
183 $text = '';
184 } else {
185 $text = $content->serialize( $contentFormat );
186 }
187
188 $params['text'] = $params['prependtext'] . $text . $params['appendtext'];
189 $toMD5 = $params['prependtext'] . $params['appendtext'];
190 }
191
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'] );
197 }
198 $undoafterRev = Revision::newFromId( $params['undoafter'] );
199 }
200 $undoRev = Revision::newFromId( $params['undo'] );
201 if ( is_null( $undoRev ) || $undoRev->isDeleted( Revision::DELETED_TEXT ) ) {
202 $this->dieUsageMsg( array( 'nosuchrevid', $params['undo'] ) );
203 }
204
205 if ( $params['undoafter'] == 0 ) {
206 $undoafterRev = $undoRev->getPrevious();
207 }
208 if ( is_null( $undoafterRev ) || $undoafterRev->isDeleted( Revision::DELETED_TEXT ) ) {
209 $this->dieUsageMsg( array( 'nosuchrevid', $params['undoafter'] ) );
210 }
211
212 if ( $undoRev->getPage() != $pageObj->getID() ) {
213 $this->dieUsageMsg( array( 'revwrongpage', $undoRev->getID(),
214 $titleObj->getPrefixedText() ) );
215 }
216 if ( $undoafterRev->getPage() != $pageObj->getID() ) {
217 $this->dieUsageMsg( array( 'revwrongpage', $undoafterRev->getID(),
218 $titleObj->getPrefixedText() ) );
219 }
220
221 $newContent = $contentHandler->getUndoContent(
222 $pageObj->getRevision(),
223 $undoRev,
224 $undoafterRev
225 );
226
227 if ( !$newContent ) {
228 $this->dieUsageMsg( 'undo-failure' );
229 }
230
231 $params['text'] = $newContent->serialize( $params['contentformat'] );
232
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']
237 ) {
238 $params['summary'] = wfMessage( 'undo-summary' )
239 ->params ( $params['undo'], $undoRev->getUserText() )->inContentLanguage()->text();
240 }
241 }
242
243 // See if the MD5 hash checks out
244 if ( !is_null( $params['md5'] ) && md5( $toMD5 ) !== $params['md5'] ) {
245 $this->dieUsageMsg( 'hashcheckfailed' );
246 }
247
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' => true,
256 'wpIgnoreBlankArticle' => true,
257 'wpIgnoreSelfRedirect' => true,
258 'bot' => $params['bot'],
259 );
260
261 if ( !is_null( $params['summary'] ) ) {
262 $requestArray['wpSummary'] = $params['summary'];
263 }
264
265 if ( !is_null( $params['sectiontitle'] ) ) {
266 $requestArray['wpSectionTitle'] = $params['sectiontitle'];
267 }
268
269 // TODO: Pass along information from 'undoafter' as well
270 if ( $params['undo'] > 0 ) {
271 $requestArray['wpUndidRevision'] = $params['undo'];
272 }
273
274 // Watch out for basetimestamp == ''
275 // wfTimestamp() treats it as NOW, almost certainly causing an edit conflict
276 if ( !is_null( $params['basetimestamp'] ) && $params['basetimestamp'] != '' ) {
277 $requestArray['wpEdittime'] = wfTimestamp( TS_MW, $params['basetimestamp'] );
278 } else {
279 $requestArray['wpEdittime'] = $pageObj->getTimestamp();
280 }
281
282 if ( !is_null( $params['starttimestamp'] ) && $params['starttimestamp'] != '' ) {
283 $requestArray['wpStarttime'] = wfTimestamp( TS_MW, $params['starttimestamp'] );
284 } else {
285 $requestArray['wpStarttime'] = wfTimestampNow(); // Fake wpStartime
286 }
287
288 if ( $params['minor'] || ( !$params['notminor'] && $user->getOption( 'minordefault' ) ) ) {
289 $requestArray['wpMinoredit'] = '';
290 }
291
292 if ( $params['recreate'] ) {
293 $requestArray['wpRecreate'] = '';
294 }
295
296 if ( !is_null( $params['section'] ) ) {
297 $section = $params['section'];
298 if ( !preg_match( '/^((T-)?\d+|new)$/', $section ) ) {
299 $this->dieUsage( "The section parameter must be a valid section id or 'new'", "invalidsection" );
300 }
301 $content = $pageObj->getContent();
302 if ( $section !== '0' && $section != 'new' && ( !$content || !$content->getSection( $section ) ) ) {
303 $this->dieUsage( "There is no section {$section}.", 'nosuchsection' );
304 }
305 $requestArray['wpSection'] = $params['section'];
306 } else {
307 $requestArray['wpSection'] = '';
308 }
309
310 $watch = $this->getWatchlistValue( $params['watchlist'], $titleObj );
311
312 // Deprecated parameters
313 if ( $params['watch'] ) {
314 $this->logFeatureUsage( 'action=edit&watch' );
315 $watch = true;
316 } elseif ( $params['unwatch'] ) {
317 $this->logFeatureUsage( 'action=edit&unwatch' );
318 $watch = false;
319 }
320
321 if ( $watch ) {
322 $requestArray['wpWatchthis'] = '';
323 }
324
325 // Pass through anything else we might have been given, to support extensions
326 // This is kind of a hack but it's the best we can do to make extensions work
327 $requestArray += $this->getRequest()->getValues();
328
329 global $wgTitle, $wgRequest;
330
331 $req = new DerivativeRequest( $this->getRequest(), $requestArray, true );
332
333 // Some functions depend on $wgTitle == $ep->mTitle
334 // TODO: Make them not or check if they still do
335 $wgTitle = $titleObj;
336
337 $articleContext = new RequestContext;
338 $articleContext->setRequest( $req );
339 $articleContext->setWikiPage( $pageObj );
340 $articleContext->setUser( $this->getUser() );
341
342 /** @var $articleObject Article */
343 $articleObject = Article::newFromWikiPage( $pageObj, $articleContext );
344
345 $ep = new EditPage( $articleObject );
346
347 // allow editing of non-textual content.
348 $ep->allowNonTextContent = true;
349
350 $ep->setContextTitle( $titleObj );
351 $ep->importFormData( $req );
352 $content = $ep->textbox1;
353
354 // The following is needed to give the hook the full content of the
355 // new revision rather than just the current section. (Bug 52077)
356 if ( !is_null( $params['section'] ) &&
357 $contentHandler->supportsSections() && $titleObj->exists()
358 ) {
359 // If sectiontitle is set, use it, otherwise use the summary as the section title (for
360 // backwards compatibility with old forms/bots).
361 if ( $ep->sectiontitle !== '' ) {
362 $sectionTitle = $ep->sectiontitle;
363 } else {
364 $sectionTitle = $ep->summary;
365 }
366
367 $contentObj = $contentHandler->unserializeContent( $content, $contentFormat );
368
369 $fullContentObj = $articleObject->replaceSectionContent(
370 $params['section'],
371 $contentObj,
372 $sectionTitle
373 );
374 if ( $fullContentObj ) {
375 $content = $fullContentObj->serialize( $contentFormat );
376 } else {
377 // This most likely means we have an edit conflict which means that the edit
378 // wont succeed anyway.
379 $this->dieUsageMsg( 'editconflict' );
380 }
381 }
382
383 // Run hooks
384 // Handle APIEditBeforeSave parameters
385 $r = array();
386 if ( !Hooks::run( 'APIEditBeforeSave', array( $ep, $content, &$r ) ) ) {
387 if ( count( $r ) ) {
388 $r['result'] = 'Failure';
389 $apiResult->addValue( null, $this->getModuleName(), $r );
390
391 return;
392 }
393
394 $this->dieUsageMsg( 'hookaborted' );
395 }
396
397 // Do the actual save
398 $oldRevId = $articleObject->getRevIdFetched();
399 $result = null;
400 // Fake $wgRequest for some hooks inside EditPage
401 // @todo FIXME: This interface SUCKS
402 $oldRequest = $wgRequest;
403 $wgRequest = $req;
404
405 $status = $ep->attemptSave( $result );
406 $wgRequest = $oldRequest;
407
408 switch ( $status->value ) {
409 case EditPage::AS_HOOK_ERROR:
410 case EditPage::AS_HOOK_ERROR_EXPECTED:
411 if ( isset( $status->apiHookResult ) ) {
412 $r = $status->apiHookResult;
413 $r['result'] = 'Failure';
414 $apiResult->addValue( null, $this->getModuleName(), $r );
415 return;
416 } else {
417 $this->dieUsageMsg( 'hookaborted' );
418 }
419
420 case EditPage::AS_PARSE_ERROR:
421 $this->dieUsage( $status->getMessage(), 'parseerror' );
422
423 case EditPage::AS_IMAGE_REDIRECT_ANON:
424 $this->dieUsageMsg( 'noimageredirect-anon' );
425
426 case EditPage::AS_IMAGE_REDIRECT_LOGGED:
427 $this->dieUsageMsg( 'noimageredirect-logged' );
428
429 case EditPage::AS_SPAM_ERROR:
430 $this->dieUsageMsg( array( 'spamdetected', $result['spam'] ) );
431
432 case EditPage::AS_BLOCKED_PAGE_FOR_USER:
433 $this->dieUsageMsg( 'blockedtext' );
434
435 case EditPage::AS_MAX_ARTICLE_SIZE_EXCEEDED:
436 case EditPage::AS_CONTENT_TOO_BIG:
437 $this->dieUsageMsg( array( 'contenttoobig', $this->getConfig()->get( 'MaxArticleSize' ) ) );
438
439 case EditPage::AS_READ_ONLY_PAGE_ANON:
440 $this->dieUsageMsg( 'noedit-anon' );
441
442 case EditPage::AS_READ_ONLY_PAGE_LOGGED:
443 $this->dieUsageMsg( 'noedit' );
444
445 case EditPage::AS_READ_ONLY_PAGE:
446 $this->dieReadOnly();
447
448 case EditPage::AS_RATE_LIMITED:
449 $this->dieUsageMsg( 'actionthrottledtext' );
450
451 case EditPage::AS_ARTICLE_WAS_DELETED:
452 $this->dieUsageMsg( 'wasdeleted' );
453
454 case EditPage::AS_NO_CREATE_PERMISSION:
455 $this->dieUsageMsg( 'nocreate-loggedin' );
456
457 case EditPage::AS_NO_CHANGE_CONTENT_MODEL:
458 $this->dieUsageMsg( 'cantchangecontentmodel' );
459
460 case EditPage::AS_BLANK_ARTICLE:
461 $this->dieUsageMsg( 'blankpage' );
462
463 case EditPage::AS_CONFLICT_DETECTED:
464 $this->dieUsageMsg( 'editconflict' );
465
466 case EditPage::AS_TEXTBOX_EMPTY:
467 $this->dieUsageMsg( 'emptynewsection' );
468
469 case EditPage::AS_SUCCESS_NEW_ARTICLE:
470 $r['new'] = '';
471 // fall-through
472
473 case EditPage::AS_SUCCESS_UPDATE:
474 $r['result'] = 'Success';
475 $r['pageid'] = intval( $titleObj->getArticleID() );
476 $r['title'] = $titleObj->getPrefixedText();
477 $r['contentmodel'] = $titleObj->getContentModel();
478 $newRevId = $articleObject->getLatest();
479 if ( $newRevId == $oldRevId ) {
480 $r['nochange'] = '';
481 } else {
482 $r['oldrevid'] = intval( $oldRevId );
483 $r['newrevid'] = intval( $newRevId );
484 $r['newtimestamp'] = wfTimestamp( TS_ISO_8601,
485 $pageObj->getTimestamp() );
486 }
487 break;
488
489 case EditPage::AS_SUMMARY_NEEDED:
490 // Shouldn't happen since we set wpIgnoreBlankSummary, but just in case
491 $this->dieUsageMsg( 'summaryrequired' );
492
493 case EditPage::AS_END:
494 default:
495 // $status came from WikiPage::doEdit()
496 $errors = $status->getErrorsArray();
497 $this->dieUsageMsg( $errors[0] ); // TODO: Add new errors to message map
498 break;
499 }
500 $apiResult->addValue( null, $this->getModuleName(), $r );
501 }
502
503 public function mustBePosted() {
504 return true;
505 }
506
507 public function isWriteMode() {
508 return true;
509 }
510
511 public function getAllowedParams() {
512 return array(
513 'title' => array(
514 ApiBase::PARAM_TYPE => 'string',
515 ),
516 'pageid' => array(
517 ApiBase::PARAM_TYPE => 'integer',
518 ),
519 'section' => null,
520 'sectiontitle' => array(
521 ApiBase::PARAM_TYPE => 'string',
522 ),
523 'text' => null,
524 'summary' => null,
525 'minor' => false,
526 'notminor' => false,
527 'bot' => false,
528 'basetimestamp' => null,
529 'starttimestamp' => null,
530 'recreate' => false,
531 'createonly' => false,
532 'nocreate' => false,
533 'watch' => array(
534 ApiBase::PARAM_DFLT => false,
535 ApiBase::PARAM_DEPRECATED => true,
536 ),
537 'unwatch' => array(
538 ApiBase::PARAM_DFLT => false,
539 ApiBase::PARAM_DEPRECATED => true,
540 ),
541 'watchlist' => array(
542 ApiBase::PARAM_DFLT => 'preferences',
543 ApiBase::PARAM_TYPE => array(
544 'watch',
545 'unwatch',
546 'preferences',
547 'nochange'
548 ),
549 ),
550 'md5' => null,
551 'prependtext' => null,
552 'appendtext' => null,
553 'undo' => array(
554 ApiBase::PARAM_TYPE => 'integer'
555 ),
556 'undoafter' => array(
557 ApiBase::PARAM_TYPE => 'integer'
558 ),
559 'redirect' => array(
560 ApiBase::PARAM_TYPE => 'boolean',
561 ApiBase::PARAM_DFLT => false,
562 ),
563 'contentformat' => array(
564 ApiBase::PARAM_TYPE => ContentHandler::getAllContentFormats(),
565 ),
566 'contentmodel' => array(
567 ApiBase::PARAM_TYPE => ContentHandler::getContentModels(),
568 ),
569 'token' => array(
570 // Standard definition automatically inserted
571 ApiBase::PARAM_HELP_MSG_APPEND => array( 'apihelp-edit-param-token' ),
572 ),
573 );
574 }
575
576 public function needsToken() {
577 return 'csrf';
578 }
579
580 protected function getExamplesMessages() {
581 return array(
582 'action=edit&title=Test&summary=test%20summary&' .
583 'text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
584 => 'apihelp-edit-example-edit',
585 'action=edit&title=Test&summary=NOTOC&minor=&' .
586 'prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
587 => 'apihelp-edit-example-prepend',
588 'action=edit&title=Test&undo=13585&undoafter=13579&' .
589 'basetimestamp=2007-08-24T12:34:54Z&token=123ABC'
590 => 'apihelp-edit-example-undo',
591 );
592 }
593
594 public function getHelpUrls() {
595 return 'https://www.mediawiki.org/wiki/API:Edit';
596 }
597 }