MediaWiki REL1_32
ApiEditPageTest.php
Go to the documentation of this file.
1<?php
2
14class ApiEditPageTest extends ApiTestCase {
15
16 protected function setUp() {
17 parent::setUp();
18
19 $this->setMwGlobals( [
20 'wgExtraNamespaces' => [
21 12312 => 'Dummy',
22 12313 => 'Dummy_talk',
23 12314 => 'DummyNonText',
24 12315 => 'DummyNonText_talk',
25 ],
26 'wgNamespaceContentModels' => [
27 12312 => 'testing',
28 12314 => 'testing-nontext',
29 ],
30 ] );
31 $this->mergeMwGlobalArrayValue( 'wgContentHandlers', [
32 'testing' => 'DummyContentHandlerForTesting',
33 'testing-nontext' => 'DummyNonTextContentHandler',
34 'testing-serialize-error' => 'DummySerializeErrorContentHandler',
35 ] );
36 $this->tablesUsed = array_merge(
37 $this->tablesUsed,
38 [ 'change_tag', 'change_tag_def', 'logging' ]
39 );
40 }
41
42 public function testEdit() {
43 $name = 'Help:ApiEditPageTest_testEdit'; // assume Help namespace to default to wikitext
44
45 // -- test new page --------------------------------------------
46 $apiResult = $this->doApiRequestWithToken( [
47 'action' => 'edit',
48 'title' => $name,
49 'text' => 'some text',
50 ] );
51 $apiResult = $apiResult[0];
52
53 // Validate API result data
54 $this->assertArrayHasKey( 'edit', $apiResult );
55 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
56 $this->assertSame( 'Success', $apiResult['edit']['result'] );
57
58 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
59 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
60
61 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
62
63 // -- test existing page, no change ----------------------------
64 $data = $this->doApiRequestWithToken( [
65 'action' => 'edit',
66 'title' => $name,
67 'text' => 'some text',
68 ] );
69
70 $this->assertSame( 'Success', $data[0]['edit']['result'] );
71
72 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
73 $this->assertArrayHasKey( 'nochange', $data[0]['edit'] );
74
75 // -- test existing page, with change --------------------------
76 $data = $this->doApiRequestWithToken( [
77 'action' => 'edit',
78 'title' => $name,
79 'text' => 'different text'
80 ] );
81
82 $this->assertSame( 'Success', $data[0]['edit']['result'] );
83
84 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
85 $this->assertArrayNotHasKey( 'nochange', $data[0]['edit'] );
86
87 $this->assertArrayHasKey( 'oldrevid', $data[0]['edit'] );
88 $this->assertArrayHasKey( 'newrevid', $data[0]['edit'] );
89 $this->assertNotEquals(
90 $data[0]['edit']['newrevid'],
91 $data[0]['edit']['oldrevid'],
92 "revision id should change after edit"
93 );
94 }
95
99 public static function provideEditAppend() {
100 return [
101 [ # 0: append
102 'foo', 'append', 'bar', "foobar"
103 ],
104 [ # 1: prepend
105 'foo', 'prepend', 'bar', "barfoo"
106 ],
107 [ # 2: append to empty page
108 '', 'append', 'foo', "foo"
109 ],
110 [ # 3: prepend to empty page
111 '', 'prepend', 'foo', "foo"
112 ],
113 [ # 4: append to non-existing page
114 null, 'append', 'foo', "foo"
115 ],
116 [ # 5: prepend to non-existing page
117 null, 'prepend', 'foo', "foo"
118 ],
119 ];
120 }
121
125 public function testEditAppend( $text, $op, $append, $expected ) {
126 static $count = 0;
127 $count++;
128
129 // assume NS_HELP defaults to wikitext
130 $name = "Help:ApiEditPageTest_testEditAppend_$count";
131
132 // -- create page (or not) -----------------------------------------
133 if ( $text !== null ) {
134 list( $re ) = $this->doApiRequestWithToken( [
135 'action' => 'edit',
136 'title' => $name,
137 'text' => $text, ] );
138
139 $this->assertSame( 'Success', $re['edit']['result'] ); // sanity
140 }
141
142 // -- try append/prepend --------------------------------------------
143 list( $re ) = $this->doApiRequestWithToken( [
144 'action' => 'edit',
145 'title' => $name,
146 $op . 'text' => $append, ] );
147
148 $this->assertSame( 'Success', $re['edit']['result'] );
149
150 // -- validate -----------------------------------------------------
151 $page = new WikiPage( Title::newFromText( $name ) );
152 $content = $page->getContent();
153 $this->assertNotNull( $content, 'Page should have been created' );
154
155 $text = $content->getNativeData();
156
157 $this->assertSame( $expected, $text );
158 }
159
163 public function testEditSection() {
164 $name = 'Help:ApiEditPageTest_testEditSection';
165 $page = WikiPage::factory( Title::newFromText( $name ) );
166 $text = "==section 1==\ncontent 1\n==section 2==\ncontent2";
167 // Preload the page with some text
168 $page->doEditContent( ContentHandler::makeContent( $text, $page->getTitle() ), 'summary' );
169
170 list( $re ) = $this->doApiRequestWithToken( [
171 'action' => 'edit',
172 'title' => $name,
173 'section' => '1',
174 'text' => "==section 1==\nnew content 1",
175 ] );
176 $this->assertSame( 'Success', $re['edit']['result'] );
177 $newtext = WikiPage::factory( Title::newFromText( $name ) )
178 ->getContent( Revision::RAW )
179 ->getNativeData();
180 $this->assertSame( "==section 1==\nnew content 1\n\n==section 2==\ncontent2", $newtext );
181
182 // Test that we raise a 'nosuchsection' error
183 try {
184 $this->doApiRequestWithToken( [
185 'action' => 'edit',
186 'title' => $name,
187 'section' => '9999',
188 'text' => 'text',
189 ] );
190 $this->fail( "Should have raised an ApiUsageException" );
191 } catch ( ApiUsageException $e ) {
192 $this->assertTrue( self::apiExceptionHasCode( $e, 'nosuchsection' ) );
193 }
194 }
195
202 public function testEditNewSection() {
203 $name = 'Help:ApiEditPageTest_testEditNewSection';
204
205 // Test on a page that does not already exist
206 $this->assertFalse( Title::newFromText( $name )->exists() );
207 list( $re ) = $this->doApiRequestWithToken( [
208 'action' => 'edit',
209 'title' => $name,
210 'section' => 'new',
211 'text' => 'test',
212 'summary' => 'header',
213 ] );
214
215 $this->assertSame( 'Success', $re['edit']['result'] );
216 // Check the page text is correct
217 $text = WikiPage::factory( Title::newFromText( $name ) )
218 ->getContent( Revision::RAW )
219 ->getNativeData();
220 $this->assertSame( "== header ==\n\ntest", $text );
221
222 // Now on one that does
223 $this->assertTrue( Title::newFromText( $name )->exists() );
224 list( $re2 ) = $this->doApiRequestWithToken( [
225 'action' => 'edit',
226 'title' => $name,
227 'section' => 'new',
228 'text' => 'test',
229 'summary' => 'header',
230 ] );
231
232 $this->assertSame( 'Success', $re2['edit']['result'] );
233 $text = WikiPage::factory( Title::newFromText( $name ) )
234 ->getContent( Revision::RAW )
235 ->getNativeData();
236 $this->assertSame( "== header ==\n\ntest\n\n== header ==\n\ntest", $text );
237 }
238
242 public function testEdit_redirect() {
243 static $count = 0;
244 $count++;
245
246 // assume NS_HELP defaults to wikitext
247 $name = "Help:ApiEditPageTest_testEdit_redirect_$count";
248 $title = Title::newFromText( $name );
249 $page = WikiPage::factory( $title );
250
251 $rname = "Help:ApiEditPageTest_testEdit_redirect_r$count";
252 $rtitle = Title::newFromText( $rname );
253 $rpage = WikiPage::factory( $rtitle );
254
255 // base edit for content
256 $page->doEditContent( new WikitextContent( "Foo" ),
257 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
258 $this->forceRevisionDate( $page, '20120101000000' );
259 $baseTime = $page->getRevision()->getTimestamp();
260
261 // base edit for redirect
262 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
263 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
264 $this->forceRevisionDate( $rpage, '20120101000000' );
265
266 // conflicting edit to redirect
267 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]\n\n[[Category:Test]]" ),
268 "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->getUser() );
269 $this->forceRevisionDate( $rpage, '20120101020202' );
270
271 // try to save edit, following the redirect
272 list( $re, , ) = $this->doApiRequestWithToken( [
273 'action' => 'edit',
274 'title' => $rname,
275 'text' => 'nix bar!',
276 'basetimestamp' => $baseTime,
277 'section' => 'new',
278 'redirect' => true,
279 ] );
280
281 $this->assertSame( 'Success', $re['edit']['result'],
282 "no problems expected when following redirect" );
283 }
284
288 public function testEdit_redirectText() {
289 static $count = 0;
290 $count++;
291
292 // assume NS_HELP defaults to wikitext
293 $name = "Help:ApiEditPageTest_testEdit_redirectText_$count";
294 $title = Title::newFromText( $name );
295 $page = WikiPage::factory( $title );
296
297 $rname = "Help:ApiEditPageTest_testEdit_redirectText_r$count";
298 $rtitle = Title::newFromText( $rname );
299 $rpage = WikiPage::factory( $rtitle );
300
301 // base edit for content
302 $page->doEditContent( new WikitextContent( "Foo" ),
303 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
304 $this->forceRevisionDate( $page, '20120101000000' );
305 $baseTime = $page->getRevision()->getTimestamp();
306
307 // base edit for redirect
308 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
309 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
310 $this->forceRevisionDate( $rpage, '20120101000000' );
311
312 // conflicting edit to redirect
313 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]\n\n[[Category:Test]]" ),
314 "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->getUser() );
315 $this->forceRevisionDate( $rpage, '20120101020202' );
316
317 // try to save edit, following the redirect but without creating a section
318 try {
319 $this->doApiRequestWithToken( [
320 'action' => 'edit',
321 'title' => $rname,
322 'text' => 'nix bar!',
323 'basetimestamp' => $baseTime,
324 'redirect' => true,
325 ] );
326
327 $this->fail( 'redirect-appendonly error expected' );
328 } catch ( ApiUsageException $ex ) {
329 $this->assertTrue( self::apiExceptionHasCode( $ex, 'redirect-appendonly' ) );
330 }
331 }
332
333 public function testEditConflict() {
334 static $count = 0;
335 $count++;
336
337 // assume NS_HELP defaults to wikitext
338 $name = "Help:ApiEditPageTest_testEditConflict_$count";
339 $title = Title::newFromText( $name );
340
341 $page = WikiPage::factory( $title );
342
343 // base edit
344 $page->doEditContent( new WikitextContent( "Foo" ),
345 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
346 $this->forceRevisionDate( $page, '20120101000000' );
347 $baseTime = $page->getRevision()->getTimestamp();
348
349 // conflicting edit
350 $page->doEditContent( new WikitextContent( "Foo bar" ),
351 "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->getUser() );
352 $this->forceRevisionDate( $page, '20120101020202' );
353
354 // try to save edit, expect conflict
355 try {
356 $this->doApiRequestWithToken( [
357 'action' => 'edit',
358 'title' => $name,
359 'text' => 'nix bar!',
360 'basetimestamp' => $baseTime,
361 ] );
362
363 $this->fail( 'edit conflict expected' );
364 } catch ( ApiUsageException $ex ) {
365 $this->assertTrue( self::apiExceptionHasCode( $ex, 'editconflict' ) );
366 }
367 }
368
372 public function testEditConflict_newSection() {
373 static $count = 0;
374 $count++;
375
376 // assume NS_HELP defaults to wikitext
377 $name = "Help:ApiEditPageTest_testEditConflict_newSection_$count";
378 $title = Title::newFromText( $name );
379
380 $page = WikiPage::factory( $title );
381
382 // base edit
383 $page->doEditContent( new WikitextContent( "Foo" ),
384 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
385 $this->forceRevisionDate( $page, '20120101000000' );
386 $baseTime = $page->getRevision()->getTimestamp();
387
388 // conflicting edit
389 $page->doEditContent( new WikitextContent( "Foo bar" ),
390 "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->getUser() );
391 $this->forceRevisionDate( $page, '20120101020202' );
392
393 // try to save edit, expect no conflict
394 list( $re, , ) = $this->doApiRequestWithToken( [
395 'action' => 'edit',
396 'title' => $name,
397 'text' => 'nix bar!',
398 'basetimestamp' => $baseTime,
399 'section' => 'new',
400 ] );
401
402 $this->assertSame( 'Success', $re['edit']['result'],
403 "no edit conflict expected here" );
404 }
405
406 public function testEditConflict_T43990() {
407 static $count = 0;
408 $count++;
409
410 /*
411 * T43990: if the target page has a newer revision than the redirect, then editing the
412 * redirect while specifying 'redirect' and *not* specifying 'basetimestamp' erroneously
413 * caused an edit conflict to be detected.
414 */
415
416 // assume NS_HELP defaults to wikitext
417 $name = "Help:ApiEditPageTest_testEditConflict_redirect_T43990_$count";
418 $title = Title::newFromText( $name );
419 $page = WikiPage::factory( $title );
420
421 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_T43990_r$count";
422 $rtitle = Title::newFromText( $rname );
423 $rpage = WikiPage::factory( $rtitle );
424
425 // base edit for content
426 $page->doEditContent( new WikitextContent( "Foo" ),
427 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
428 $this->forceRevisionDate( $page, '20120101000000' );
429
430 // base edit for redirect
431 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
432 "testing 1", EDIT_NEW, false, self::$users['sysop']->getUser() );
433 $this->forceRevisionDate( $rpage, '20120101000000' );
434
435 // new edit to content
436 $page->doEditContent( new WikitextContent( "Foo bar" ),
437 "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->getUser() );
438 $this->forceRevisionDate( $rpage, '20120101020202' );
439
440 // try to save edit; should work, following the redirect.
441 list( $re, , ) = $this->doApiRequestWithToken( [
442 'action' => 'edit',
443 'title' => $rname,
444 'text' => 'nix bar!',
445 'section' => 'new',
446 'redirect' => true,
447 ] );
448
449 $this->assertSame( 'Success', $re['edit']['result'],
450 "no edit conflict expected here" );
451 }
452
457 protected function forceRevisionDate( WikiPage $page, $timestamp ) {
458 $dbw = wfGetDB( DB_MASTER );
459
460 $dbw->update( 'revision',
461 [ 'rev_timestamp' => $dbw->timestamp( $timestamp ) ],
462 [ 'rev_id' => $page->getLatest() ] );
463
464 $page->clear();
465 }
466
467 public function testCheckDirectApiEditingDisallowed_forNonTextContent() {
468 $this->setExpectedException(
469 ApiUsageException::class,
470 'Direct editing via API is not supported for content model ' .
471 'testing used by Dummy:ApiEditPageTest_nonTextPageEdit'
472 );
473
474 $this->doApiRequestWithToken( [
475 'action' => 'edit',
476 'title' => 'Dummy:ApiEditPageTest_nonTextPageEdit',
477 'text' => '{"animals":["kittens!"]}'
478 ] );
479 }
480
481 public function testSupportsDirectApiEditing_withContentHandlerOverride() {
482 $name = 'DummyNonText:ApiEditPageTest_testNonTextEdit';
483 $data = serialize( 'some bla bla text' );
484
485 $result = $this->doApiRequestWithToken( [
486 'action' => 'edit',
487 'title' => $name,
488 'text' => $data,
489 ] );
490
491 $apiResult = $result[0];
492
493 // Validate API result data
494 $this->assertArrayHasKey( 'edit', $apiResult );
495 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
496 $this->assertSame( 'Success', $apiResult['edit']['result'] );
497
498 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
499 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
500
501 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
502
503 // validate resulting revision
504 $page = WikiPage::factory( Title::newFromText( $name ) );
505 $this->assertSame( "testing-nontext", $page->getContentModel() );
506 $this->assertSame( $data, $page->getContent()->serialize() );
507 }
508
514 public function testUndoAfterContentModelChange() {
515 $name = 'Help:' . __FUNCTION__;
516 $uploader = self::$users['uploader']->getUser();
517 $sysop = self::$users['sysop']->getUser();
518
519 $apiResult = $this->doApiRequestWithToken( [
520 'action' => 'edit',
521 'title' => $name,
522 'text' => 'some text',
523 ], null, $sysop )[0];
524
525 // Check success
526 $this->assertArrayHasKey( 'edit', $apiResult );
527 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
528 $this->assertSame( 'Success', $apiResult['edit']['result'] );
529 $this->assertArrayHasKey( 'contentmodel', $apiResult['edit'] );
530 // Content model is wikitext
531 $this->assertSame( 'wikitext', $apiResult['edit']['contentmodel'] );
532
533 // Convert the page to JSON
534 $apiResult = $this->doApiRequestWithToken( [
535 'action' => 'edit',
536 'title' => $name,
537 'text' => '{}',
538 'contentmodel' => 'json',
539 ], null, $uploader )[0];
540
541 // Check success
542 $this->assertArrayHasKey( 'edit', $apiResult );
543 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
544 $this->assertSame( 'Success', $apiResult['edit']['result'] );
545 $this->assertArrayHasKey( 'contentmodel', $apiResult['edit'] );
546 $this->assertSame( 'json', $apiResult['edit']['contentmodel'] );
547
548 $apiResult = $this->doApiRequestWithToken( [
549 'action' => 'edit',
550 'title' => $name,
551 'undo' => $apiResult['edit']['newrevid']
552 ], null, $sysop )[0];
553
554 // Check success
555 $this->assertArrayHasKey( 'edit', $apiResult );
556 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
557 $this->assertSame( 'Success', $apiResult['edit']['result'] );
558 $this->assertArrayHasKey( 'contentmodel', $apiResult['edit'] );
559 // Check that the contentmodel is back to wikitext now.
560 $this->assertSame( 'wikitext', $apiResult['edit']['contentmodel'] );
561 }
562
563 // The tests below are mostly not commented because they do exactly what
564 // you'd expect from the name.
565
566 public function testCorrectContentFormat() {
567 $name = 'Help:' . ucfirst( __FUNCTION__ );
568
569 $this->doApiRequestWithToken( [
570 'action' => 'edit',
571 'title' => $name,
572 'text' => 'some text',
573 'contentmodel' => 'wikitext',
574 'contentformat' => 'text/x-wiki',
575 ] );
576
577 $this->assertTrue( Title::newFromText( $name )->exists() );
578 }
579
580 public function testUnsupportedContentFormat() {
581 $name = 'Help:' . ucfirst( __FUNCTION__ );
582
583 $this->setExpectedException( ApiUsageException::class,
584 'Unrecognized value for parameter "contentformat": nonexistent format.' );
585
586 try {
587 $this->doApiRequestWithToken( [
588 'action' => 'edit',
589 'title' => $name,
590 'text' => 'some text',
591 'contentformat' => 'nonexistent format',
592 ] );
593 } finally {
594 $this->assertFalse( Title::newFromText( $name )->exists() );
595 }
596 }
597
598 public function testMismatchedContentFormat() {
599 $name = 'Help:' . ucfirst( __FUNCTION__ );
600
601 $this->setExpectedException( ApiUsageException::class,
602 'The requested format text/plain is not supported for content ' .
603 "model wikitext used by $name." );
604
605 try {
606 $this->doApiRequestWithToken( [
607 'action' => 'edit',
608 'title' => $name,
609 'text' => 'some text',
610 'contentmodel' => 'wikitext',
611 'contentformat' => 'text/plain',
612 ] );
613 } finally {
614 $this->assertFalse( Title::newFromText( $name )->exists() );
615 }
616 }
617
618 public function testUndoToInvalidRev() {
619 $name = 'Help:' . ucfirst( __FUNCTION__ );
620
621 $revId = $this->editPage( $name, 'Some text' )->value['revision']
622 ->getId();
623 $revId++;
624
625 $this->setExpectedException( ApiUsageException::class,
626 "There is no revision with ID $revId." );
627
628 $this->doApiRequestWithToken( [
629 'action' => 'edit',
630 'title' => $name,
631 'undo' => $revId,
632 ] );
633 }
634
640 public function testUndoAfterToInvalidRev() {
641 // We can't just pick a large number for undoafter (as in
642 // testUndoToInvalidRev above), because then MediaWiki will helpfully
643 // assume we switched around undo and undoafter and we'll test the code
644 // path for undo being invalid, not undoafter. So instead we delete
645 // the revision from the database. In real life this case could come
646 // up if a revision number was skipped, e.g., if two transactions try
647 // to insert new revision rows at once and the first one to succeed
648 // gets rolled back.
649 $name = 'Help:' . ucfirst( __FUNCTION__ );
650 $titleObj = Title::newFromText( $name );
651
652 $revId1 = $this->editPage( $name, '1' )->value['revision']->getId();
653 $revId2 = $this->editPage( $name, '2' )->value['revision']->getId();
654 $revId3 = $this->editPage( $name, '3' )->value['revision']->getId();
655
656 // Make the middle revision disappear
657 $dbw = wfGetDB( DB_MASTER );
658 $dbw->delete( 'revision', [ 'rev_id' => $revId2 ], __METHOD__ );
659 $dbw->update( 'revision', [ 'rev_parent_id' => $revId1 ],
660 [ 'rev_id' => $revId3 ], __METHOD__ );
661
662 $this->setExpectedException( ApiUsageException::class,
663 "There is no revision with ID $revId2." );
664
665 $this->doApiRequestWithToken( [
666 'action' => 'edit',
667 'title' => $name,
668 'undo' => $revId3,
669 'undoafter' => $revId2,
670 ] );
671 }
672
677 public function testUndoAfterToHiddenRev() {
678 $name = 'Help:' . ucfirst( __FUNCTION__ );
679 $titleObj = Title::newFromText( $name );
680
681 $this->editPage( $name, '0' );
682
683 $revId1 = $this->editPage( $name, '1' )->value['revision']->getId();
684
685 $revId2 = $this->editPage( $name, '2' )->value['revision']->getId();
686
687 // Hide the middle revision
688 $list = RevisionDeleter::createList( 'revision',
689 RequestContext::getMain(), $titleObj, [ $revId1 ] );
690 $list->setVisibility( [
691 'value' => [ Revision::DELETED_TEXT => 1 ],
692 'comment' => 'Bye-bye',
693 ] );
694
695 $this->setExpectedException( ApiUsageException::class,
696 "There is no revision with ID $revId1." );
697
698 $this->doApiRequestWithToken( [
699 'action' => 'edit',
700 'title' => $name,
701 'undo' => $revId2,
702 'undoafter' => $revId1,
703 ] );
704 }
705
710 public function testUndoWithSwappedRevisions() {
711 $name = 'Help:' . ucfirst( __FUNCTION__ );
712 $titleObj = Title::newFromText( $name );
713
714 $this->editPage( $name, '0' );
715
716 $revId2 = $this->editPage( $name, '2' )->value['revision']->getId();
717
718 $revId1 = $this->editPage( $name, '1' )->value['revision']->getId();
719
720 // Now monkey with the timestamp
721 $dbw = wfGetDB( DB_MASTER );
722 $dbw->update(
723 'revision',
724 [ 'rev_timestamp' => $dbw->timestamp( time() - 86400 ) ],
725 [ 'rev_id' => $revId1 ],
726 __METHOD__
727 );
728
729 $this->doApiRequestWithToken( [
730 'action' => 'edit',
731 'title' => $name,
732 'undo' => $revId2,
733 'undoafter' => $revId1,
734 ] );
735
736 $text = ( new WikiPage( $titleObj ) )->getContent()->getNativeData();
737
738 // This is wrong! It should be 1. But let's test for our incorrect
739 // behavior for now, so if someone fixes it they'll fix the test as
740 // well to expect 1. If we disabled the test, it might stay disabled
741 // even once the bug is fixed, which would be a shame.
742 $this->assertSame( '2', $text );
743 }
744
745 public function testUndoWithConflicts() {
746 $name = 'Help:' . ucfirst( __FUNCTION__ );
747
748 $this->setExpectedException( ApiUsageException::class,
749 'The edit could not be undone due to conflicting intermediate edits.' );
750
751 $this->editPage( $name, '1' );
752
753 $revId = $this->editPage( $name, '2' )->value['revision']->getId();
754
755 $this->editPage( $name, '3' );
756
757 $this->doApiRequestWithToken( [
758 'action' => 'edit',
759 'title' => $name,
760 'undo' => $revId,
761 ] );
762
763 $text = ( new WikiPage( Title::newFromText( $name ) ) )->getContent()
764 ->getNativeData();
765 $this->assertSame( '3', $text );
766 }
767
772 public function testReversedUndoAfter() {
773 $name = 'Help:' . ucfirst( __FUNCTION__ );
774
775 $this->editPage( $name, '0' );
776 $revId1 = $this->editPage( $name, '1' )->value['revision']->getId();
777 $revId2 = $this->editPage( $name, '2' )->value['revision']->getId();
778
779 $this->doApiRequestWithToken( [
780 'action' => 'edit',
781 'title' => $name,
782 'undo' => $revId1,
783 'undoafter' => $revId2,
784 ] );
785
786 $text = ( new WikiPage( Title::newFromText( $name ) ) )->getContent()
787 ->getNativeData();
788 $this->assertSame( '1', $text );
789 }
790
791 public function testUndoToRevFromDifferentPage() {
792 $name = 'Help:' . ucfirst( __FUNCTION__ );
793
794 $this->editPage( "$name-1", 'Some text' );
795 $revId = $this->editPage( "$name-1", 'Some more text' )
796 ->value['revision']->getId();
797
798 $this->editPage( "$name-2", 'Some text' );
799
800 $this->setExpectedException( ApiUsageException::class,
801 "r$revId is not a revision of $name-2." );
802
803 $this->doApiRequestWithToken( [
804 'action' => 'edit',
805 'title' => "$name-2",
806 'undo' => $revId,
807 ] );
808 }
809
810 public function testUndoAfterToRevFromDifferentPage() {
811 $name = 'Help:' . ucfirst( __FUNCTION__ );
812
813 $revId1 = $this->editPage( "$name-1", 'Some text' )
814 ->value['revision']->getId();
815
816 $revId2 = $this->editPage( "$name-2", 'Some text' )
817 ->value['revision']->getId();
818
819 $this->setExpectedException( ApiUsageException::class,
820 "r$revId1 is not a revision of $name-2." );
821
822 $this->doApiRequestWithToken( [
823 'action' => 'edit',
824 'title' => "$name-2",
825 'undo' => $revId2,
826 'undoafter' => $revId1,
827 ] );
828 }
829
830 public function testMd5Text() {
831 $name = 'Help:' . ucfirst( __FUNCTION__ );
832
833 $this->assertFalse( Title::newFromText( $name )->exists() );
834
835 $this->doApiRequestWithToken( [
836 'action' => 'edit',
837 'title' => $name,
838 'text' => 'Some text',
839 'md5' => md5( 'Some text' ),
840 ] );
841
842 $this->assertTrue( Title::newFromText( $name )->exists() );
843 }
844
845 public function testMd5PrependText() {
846 $name = 'Help:' . ucfirst( __FUNCTION__ );
847
848 $this->editPage( $name, 'Some text' );
849
850 $this->doApiRequestWithToken( [
851 'action' => 'edit',
852 'title' => $name,
853 'prependtext' => 'Alert: ',
854 'md5' => md5( 'Alert: ' ),
855 ] );
856
857 $text = ( new WikiPage( Title::newFromText( $name ) ) )
858 ->getContent()->getNativeData();
859 $this->assertSame( 'Alert: Some text', $text );
860 }
861
862 public function testMd5AppendText() {
863 $name = 'Help:' . ucfirst( __FUNCTION__ );
864
865 $this->editPage( $name, 'Some text' );
866
867 $this->doApiRequestWithToken( [
868 'action' => 'edit',
869 'title' => $name,
870 'appendtext' => ' is nice',
871 'md5' => md5( ' is nice' ),
872 ] );
873
874 $text = ( new WikiPage( Title::newFromText( $name ) ) )
875 ->getContent()->getNativeData();
876 $this->assertSame( 'Some text is nice', $text );
877 }
878
879 public function testMd5PrependAndAppendText() {
880 $name = 'Help:' . ucfirst( __FUNCTION__ );
881
882 $this->editPage( $name, 'Some text' );
883
884 $this->doApiRequestWithToken( [
885 'action' => 'edit',
886 'title' => $name,
887 'prependtext' => 'Alert: ',
888 'appendtext' => ' is nice',
889 'md5' => md5( 'Alert: is nice' ),
890 ] );
891
892 $text = ( new WikiPage( Title::newFromText( $name ) ) )
893 ->getContent()->getNativeData();
894 $this->assertSame( 'Alert: Some text is nice', $text );
895 }
896
897 public function testIncorrectMd5Text() {
898 $name = 'Help:' . ucfirst( __FUNCTION__ );
899
900 $this->setExpectedException( ApiUsageException::class,
901 'The supplied MD5 hash was incorrect.' );
902
903 $this->doApiRequestWithToken( [
904 'action' => 'edit',
905 'title' => $name,
906 'text' => 'Some text',
907 'md5' => md5( '' ),
908 ] );
909 }
910
911 public function testIncorrectMd5PrependText() {
912 $name = 'Help:' . ucfirst( __FUNCTION__ );
913
914 $this->setExpectedException( ApiUsageException::class,
915 'The supplied MD5 hash was incorrect.' );
916
917 $this->doApiRequestWithToken( [
918 'action' => 'edit',
919 'title' => $name,
920 'prependtext' => 'Some ',
921 'appendtext' => 'text',
922 'md5' => md5( 'Some ' ),
923 ] );
924 }
925
926 public function testIncorrectMd5AppendText() {
927 $name = 'Help:' . ucfirst( __FUNCTION__ );
928
929 $this->setExpectedException( ApiUsageException::class,
930 'The supplied MD5 hash was incorrect.' );
931
932 $this->doApiRequestWithToken( [
933 'action' => 'edit',
934 'title' => $name,
935 'prependtext' => 'Some ',
936 'appendtext' => 'text',
937 'md5' => md5( 'text' ),
938 ] );
939 }
940
941 public function testCreateOnly() {
942 $name = 'Help:' . ucfirst( __FUNCTION__ );
943
944 $this->setExpectedException( ApiUsageException::class,
945 'The article you tried to create has been created already.' );
946
947 $this->editPage( $name, 'Some text' );
948 $this->assertTrue( Title::newFromText( $name )->exists() );
949
950 try {
951 $this->doApiRequestWithToken( [
952 'action' => 'edit',
953 'title' => $name,
954 'text' => 'Some more text',
955 'createonly' => '',
956 ] );
957 } finally {
958 // Validate that content was not changed
959 $text = ( new WikiPage( Title::newFromText( $name ) ) )
960 ->getContent()->getNativeData();
961
962 $this->assertSame( 'Some text', $text );
963 }
964 }
965
966 public function testNoCreate() {
967 $name = 'Help:' . ucfirst( __FUNCTION__ );
968
969 $this->setExpectedException( ApiUsageException::class,
970 "The page you specified doesn't exist." );
971
972 $this->assertFalse( Title::newFromText( $name )->exists() );
973
974 try {
975 $this->doApiRequestWithToken( [
976 'action' => 'edit',
977 'title' => $name,
978 'text' => 'Some text',
979 'nocreate' => '',
980 ] );
981 } finally {
982 $this->assertFalse( Title::newFromText( $name )->exists() );
983 }
984 }
985
991 public function testAppendWithNonTextContentHandler() {
992 $name = 'MediaWiki:' . ucfirst( __FUNCTION__ );
993
994 $this->setExpectedException( ApiUsageException::class,
995 "Can't append to pages using content model testing-nontext." );
996
997 $this->setTemporaryHook( 'ContentHandlerDefaultModelFor',
998 function ( Title $title, &$model ) use ( $name ) {
999 if ( $title->getPrefixedText() === $name ) {
1000 $model = 'testing-nontext';
1001 }
1002 return true;
1003 }
1004 );
1005
1006 $this->doApiRequestWithToken( [
1007 'action' => 'edit',
1008 'title' => $name,
1009 'appendtext' => 'Some text',
1010 ] );
1011 }
1012
1013 public function testAppendInMediaWikiNamespace() {
1014 $name = 'MediaWiki:' . ucfirst( __FUNCTION__ );
1015
1016 $this->assertFalse( Title::newFromText( $name )->exists() );
1017
1018 $this->doApiRequestWithToken( [
1019 'action' => 'edit',
1020 'title' => $name,
1021 'appendtext' => 'Some text',
1022 ] );
1023
1024 $this->assertTrue( Title::newFromText( $name )->exists() );
1025 }
1026
1027 public function testAppendInMediaWikiNamespaceWithSerializationError() {
1028 $name = 'MediaWiki:' . ucfirst( __FUNCTION__ );
1029
1030 $this->setExpectedException( ApiUsageException::class,
1031 'Content serialization failed: Could not unserialize content' );
1032
1033 $this->setTemporaryHook( 'ContentHandlerDefaultModelFor',
1034 function ( Title $title, &$model ) use ( $name ) {
1035 if ( $title->getPrefixedText() === $name ) {
1036 $model = 'testing-serialize-error';
1037 }
1038 return true;
1039 }
1040 );
1041
1042 $this->doApiRequestWithToken( [
1043 'action' => 'edit',
1044 'title' => $name,
1045 'appendtext' => 'Some text',
1046 ] );
1047 }
1048
1049 public function testAppendNewSection() {
1050 $name = 'Help:' . ucfirst( __FUNCTION__ );
1051
1052 $this->editPage( $name, 'Initial content' );
1053
1054 $this->doApiRequestWithToken( [
1055 'action' => 'edit',
1056 'title' => $name,
1057 'appendtext' => '== New section ==',
1058 'section' => 'new',
1059 ] );
1060
1061 $text = ( new WikiPage( Title::newFromText( $name ) ) )
1062 ->getContent()->getNativeData();
1063
1064 $this->assertSame( "Initial content\n\n== New section ==", $text );
1065 }
1066
1067 public function testAppendNewSectionWithInvalidContentModel() {
1068 $name = 'Help:' . ucfirst( __FUNCTION__ );
1069
1070 $this->setExpectedException( ApiUsageException::class,
1071 'Sections are not supported for content model text.' );
1072
1073 $this->editPage( $name, 'Initial content' );
1074
1075 $this->doApiRequestWithToken( [
1076 'action' => 'edit',
1077 'title' => $name,
1078 'appendtext' => '== New section ==',
1079 'section' => 'new',
1080 'contentmodel' => 'text',
1081 ] );
1082 }
1083
1084 public function testAppendNewSectionWithTitle() {
1085 $name = 'Help:' . ucfirst( __FUNCTION__ );
1086
1087 $this->editPage( $name, 'Initial content' );
1088
1089 $this->doApiRequestWithToken( [
1090 'action' => 'edit',
1091 'title' => $name,
1092 'sectiontitle' => 'My section',
1093 'appendtext' => 'More content',
1094 'section' => 'new',
1095 ] );
1096
1097 $page = new WikiPage( Title::newFromText( $name ) );
1098
1099 $this->assertSame( "Initial content\n\n== My section ==\n\nMore content",
1100 $page->getContent()->getNativeData() );
1101 $this->assertSame( '/* My section */ new section',
1102 $page->getRevision()->getComment() );
1103 }
1104
1105 public function testAppendNewSectionWithSummary() {
1106 $name = 'Help:' . ucfirst( __FUNCTION__ );
1107
1108 $this->editPage( $name, 'Initial content' );
1109
1110 $this->doApiRequestWithToken( [
1111 'action' => 'edit',
1112 'title' => $name,
1113 'appendtext' => 'More content',
1114 'section' => 'new',
1115 'summary' => 'Add new section',
1116 ] );
1117
1118 $page = new WikiPage( Title::newFromText( $name ) );
1119
1120 $this->assertSame( "Initial content\n\n== Add new section ==\n\nMore content",
1121 $page->getContent()->getNativeData() );
1122 // EditPage actually assumes the summary is the section name here
1123 $this->assertSame( '/* Add new section */ new section',
1124 $page->getRevision()->getComment() );
1125 }
1126
1127 public function testAppendNewSectionWithTitleAndSummary() {
1128 $name = 'Help:' . ucfirst( __FUNCTION__ );
1129
1130 $this->editPage( $name, 'Initial content' );
1131
1132 $this->doApiRequestWithToken( [
1133 'action' => 'edit',
1134 'title' => $name,
1135 'sectiontitle' => 'My section',
1136 'appendtext' => 'More content',
1137 'section' => 'new',
1138 'summary' => 'Add new section',
1139 ] );
1140
1141 $page = new WikiPage( Title::newFromText( $name ) );
1142
1143 $this->assertSame( "Initial content\n\n== My section ==\n\nMore content",
1144 $page->getContent()->getNativeData() );
1145 $this->assertSame( 'Add new section',
1146 $page->getRevision()->getComment() );
1147 }
1148
1149 public function testAppendToSection() {
1150 $name = 'Help:' . ucfirst( __FUNCTION__ );
1151
1152 $this->editPage( $name, "== Section 1 ==\n\nContent\n\n" .
1153 "== Section 2 ==\n\nFascinating!" );
1154
1155 $this->doApiRequestWithToken( [
1156 'action' => 'edit',
1157 'title' => $name,
1158 'appendtext' => ' and more content',
1159 'section' => '1',
1160 ] );
1161
1162 $text = ( new WikiPage( Title::newFromText( $name ) ) )
1163 ->getContent()->getNativeData();
1164
1165 $this->assertSame( "== Section 1 ==\n\nContent and more content\n\n" .
1166 "== Section 2 ==\n\nFascinating!", $text );
1167 }
1168
1169 public function testAppendToFirstSection() {
1170 $name = 'Help:' . ucfirst( __FUNCTION__ );
1171
1172 $this->editPage( $name, "Content\n\n== Section 1 ==\n\nFascinating!" );
1173
1174 $this->doApiRequestWithToken( [
1175 'action' => 'edit',
1176 'title' => $name,
1177 'appendtext' => ' and more content',
1178 'section' => '0',
1179 ] );
1180
1181 $text = ( new WikiPage( Title::newFromText( $name ) ) )
1182 ->getContent()->getNativeData();
1183
1184 $this->assertSame( "Content and more content\n\n== Section 1 ==\n\n" .
1185 "Fascinating!", $text );
1186 }
1187
1188 public function testAppendToNonexistentSection() {
1189 $name = 'Help:' . ucfirst( __FUNCTION__ );
1190
1191 $this->setExpectedException( ApiUsageException::class, 'There is no section 1.' );
1192
1193 $this->editPage( $name, 'Content' );
1194
1195 try {
1196 $this->doApiRequestWithToken( [
1197 'action' => 'edit',
1198 'title' => $name,
1199 'appendtext' => ' and more content',
1200 'section' => '1',
1201 ] );
1202 } finally {
1203 $text = ( new WikiPage( Title::newFromText( $name ) ) )
1204 ->getContent()->getNativeData();
1205
1206 $this->assertSame( 'Content', $text );
1207 }
1208 }
1209
1210 public function testEditMalformedSection() {
1211 $name = 'Help:' . ucfirst( __FUNCTION__ );
1212
1213 $this->setExpectedException( ApiUsageException::class,
1214 'The "section" parameter must be a valid section ID or "new".' );
1215 $this->editPage( $name, 'Content' );
1216
1217 try {
1218 $this->doApiRequestWithToken( [
1219 'action' => 'edit',
1220 'title' => $name,
1221 'text' => 'Different content',
1222 'section' => 'It is unlikely that this is valid',
1223 ] );
1224 } finally {
1225 $text = ( new WikiPage( Title::newFromText( $name ) ) )
1226 ->getContent()->getNativeData();
1227
1228 $this->assertSame( 'Content', $text );
1229 }
1230 }
1231
1232 public function testEditWithStartTimestamp() {
1233 $name = 'Help:' . ucfirst( __FUNCTION__ );
1234 $this->setExpectedException( ApiUsageException::class,
1235 'The page has been deleted since you fetched its timestamp.' );
1236
1237 $startTime = MWTimestamp::convert( TS_MW, time() - 1 );
1238
1239 $this->editPage( $name, 'Some text' );
1240
1241 $pageObj = new WikiPage( Title::newFromText( $name ) );
1242 $pageObj->doDeleteArticle( 'Bye-bye' );
1243
1244 $this->assertFalse( $pageObj->exists() );
1245
1246 try {
1247 $this->doApiRequestWithToken( [
1248 'action' => 'edit',
1249 'title' => $name,
1250 'text' => 'Different text',
1251 'starttimestamp' => $startTime,
1252 ] );
1253 } finally {
1254 $this->assertFalse( $pageObj->exists() );
1255 }
1256 }
1257
1258 public function testEditMinor() {
1259 $name = 'Help:' . ucfirst( __FUNCTION__ );
1260
1261 $this->editPage( $name, 'Some text' );
1262
1263 $this->doApiRequestWithToken( [
1264 'action' => 'edit',
1265 'title' => $name,
1266 'text' => 'Different text',
1267 'minor' => '',
1268 ] );
1269
1270 $revisionStore = \MediaWiki\MediaWikiServices::getInstance()->getRevisionStore();
1271 $revision = $revisionStore->getRevisionByTitle( Title::newFromText( $name ) );
1272 $this->assertTrue( $revision->isMinor() );
1273 }
1274
1275 public function testEditRecreate() {
1276 $name = 'Help:' . ucfirst( __FUNCTION__ );
1277
1278 $startTime = MWTimestamp::convert( TS_MW, time() - 1 );
1279
1280 $this->editPage( $name, 'Some text' );
1281
1282 $pageObj = new WikiPage( Title::newFromText( $name ) );
1283 $pageObj->doDeleteArticle( 'Bye-bye' );
1284
1285 $this->assertFalse( $pageObj->exists() );
1286
1287 $this->doApiRequestWithToken( [
1288 'action' => 'edit',
1289 'title' => $name,
1290 'text' => 'Different text',
1291 'starttimestamp' => $startTime,
1292 'recreate' => '',
1293 ] );
1294
1295 $this->assertTrue( Title::newFromText( $name )->exists() );
1296 }
1297
1298 public function testEditWatch() {
1299 $name = 'Help:' . ucfirst( __FUNCTION__ );
1300 $user = self::$users['sysop']->getUser();
1301
1302 $this->doApiRequestWithToken( [
1303 'action' => 'edit',
1304 'title' => $name,
1305 'text' => 'Some text',
1306 'watch' => '',
1307 ] );
1308
1309 $this->assertTrue( Title::newFromText( $name )->exists() );
1310 $this->assertTrue( $user->isWatched( Title::newFromText( $name ) ) );
1311 }
1312
1313 public function testEditUnwatch() {
1314 $name = 'Help:' . ucfirst( __FUNCTION__ );
1315 $user = self::$users['sysop']->getUser();
1316 $titleObj = Title::newFromText( $name );
1317
1318 $user->addWatch( $titleObj );
1319
1320 $this->assertFalse( $titleObj->exists() );
1321 $this->assertTrue( $user->isWatched( $titleObj ) );
1322
1323 $this->doApiRequestWithToken( [
1324 'action' => 'edit',
1325 'title' => $name,
1326 'text' => 'Some text',
1327 'unwatch' => '',
1328 ] );
1329
1330 $this->assertTrue( $titleObj->exists() );
1331 $this->assertFalse( $user->isWatched( $titleObj ) );
1332 }
1333
1334 public function testEditWithTag() {
1335 $this->setMwGlobals( 'wgChangeTagsSchemaMigrationStage', MIGRATION_WRITE_BOTH );
1336 $name = 'Help:' . ucfirst( __FUNCTION__ );
1337
1338 ChangeTags::defineTag( 'custom tag' );
1339
1340 $revId = $this->doApiRequestWithToken( [
1341 'action' => 'edit',
1342 'title' => $name,
1343 'text' => 'Some text',
1344 'tags' => 'custom tag',
1345 ] )[0]['edit']['newrevid'];
1346
1347 $dbw = wfGetDB( DB_MASTER );
1348 $this->assertSame( 'custom tag', $dbw->selectField(
1349 'change_tag', 'ct_tag', [ 'ct_rev_id' => $revId ], __METHOD__ ) );
1350 }
1351
1352 public function testEditWithTagNewBackend() {
1353 $this->setMwGlobals( 'wgChangeTagsSchemaMigrationStage', MIGRATION_NEW );
1354 $name = 'Help:' . ucfirst( __FUNCTION__ );
1355
1356 ChangeTags::defineTag( 'custom tag' );
1357
1358 $revId = $this->doApiRequestWithToken( [
1359 'action' => 'edit',
1360 'title' => $name,
1361 'text' => 'Some text',
1362 'tags' => 'custom tag',
1363 ] )[0]['edit']['newrevid'];
1364
1365 $dbw = wfGetDB( DB_MASTER );
1366 $this->assertSame( 'custom tag', $dbw->selectField(
1367 [ 'change_tag', 'change_tag_def' ],
1368 'ctd_name',
1369 [ 'ct_rev_id' => $revId ],
1370 __METHOD__,
1371 [ 'change_tag_def' => [ 'INNER JOIN', 'ctd_id = ct_tag_id' ] ]
1372 )
1373 );
1374 }
1375
1376 public function testEditWithoutTagPermission() {
1377 $name = 'Help:' . ucfirst( __FUNCTION__ );
1378
1379 $this->setExpectedException( ApiUsageException::class,
1380 'You do not have permission to apply change tags along with your changes.' );
1381
1382 $this->assertFalse( Title::newFromText( $name )->exists() );
1383
1384 ChangeTags::defineTag( 'custom tag' );
1385 $this->setMwGlobals( 'wgRevokePermissions',
1386 [ 'user' => [ 'applychangetags' => true ] ] );
1387 try {
1388 $this->doApiRequestWithToken( [
1389 'action' => 'edit',
1390 'title' => $name,
1391 'text' => 'Some text',
1392 'tags' => 'custom tag',
1393 ] );
1394 } finally {
1395 $this->assertFalse( Title::newFromText( $name )->exists() );
1396 }
1397 }
1398
1399 public function testEditAbortedByHook() {
1400 $name = 'Help:' . ucfirst( __FUNCTION__ );
1401
1402 $this->setExpectedException( ApiUsageException::class,
1403 'The modification you tried to make was aborted by an extension.' );
1404
1405 $this->hideDeprecated( 'APIEditBeforeSave hook (used in ' .
1406 'hook-APIEditBeforeSave-closure)' );
1407
1408 $this->setTemporaryHook( 'APIEditBeforeSave',
1409 function () {
1410 return false;
1411 }
1412 );
1413
1414 try {
1415 $this->doApiRequestWithToken( [
1416 'action' => 'edit',
1417 'title' => $name,
1418 'text' => 'Some text',
1419 ] );
1420 } finally {
1421 $this->assertFalse( Title::newFromText( $name )->exists() );
1422 }
1423 }
1424
1425 public function testEditAbortedByHookWithCustomOutput() {
1426 $name = 'Help:' . ucfirst( __FUNCTION__ );
1427
1428 $this->hideDeprecated( 'APIEditBeforeSave hook (used in ' .
1429 'hook-APIEditBeforeSave-closure)' );
1430
1431 $this->setTemporaryHook( 'APIEditBeforeSave',
1432 function ( $unused1, $unused2, &$r ) {
1433 $r['msg'] = 'Some message';
1434 return false;
1435 } );
1436
1437 $result = $this->doApiRequestWithToken( [
1438 'action' => 'edit',
1439 'title' => $name,
1440 'text' => 'Some text',
1441 ] );
1442 Wikimedia\restoreWarnings();
1443
1444 $this->assertSame( [ 'msg' => 'Some message', 'result' => 'Failure' ],
1445 $result[0]['edit'] );
1446
1447 $this->assertFalse( Title::newFromText( $name )->exists() );
1448 }
1449
1450 public function testEditAbortedByEditPageHookWithResult() {
1451 $name = 'Help:' . ucfirst( __FUNCTION__ );
1452
1453 $this->setTemporaryHook( 'EditFilterMergedContent',
1454 function ( $unused1, $unused2, Status $status ) {
1455 $status->apiHookResult = [ 'msg' => 'A message for you!' ];
1456 return false;
1457 } );
1458
1459 $res = $this->doApiRequestWithToken( [
1460 'action' => 'edit',
1461 'title' => $name,
1462 'text' => 'Some text',
1463 ] );
1464
1465 $this->assertFalse( Title::newFromText( $name )->exists() );
1466 $this->assertSame( [ 'edit' => [ 'msg' => 'A message for you!',
1467 'result' => 'Failure' ] ], $res[0] );
1468 }
1469
1470 public function testEditAbortedByEditPageHookWithNoResult() {
1471 $name = 'Help:' . ucfirst( __FUNCTION__ );
1472
1473 $this->setExpectedException( ApiUsageException::class,
1474 'The modification you tried to make was aborted by an extension.' );
1475
1476 $this->setTemporaryHook( 'EditFilterMergedContent',
1477 function () {
1478 return false;
1479 }
1480 );
1481
1482 try {
1483 $this->doApiRequestWithToken( [
1484 'action' => 'edit',
1485 'title' => $name,
1486 'text' => 'Some text',
1487 ] );
1488 } finally {
1489 $this->assertFalse( Title::newFromText( $name )->exists() );
1490 }
1491 }
1492
1493 public function testEditWhileBlocked() {
1494 $name = 'Help:' . ucfirst( __FUNCTION__ );
1495
1496 $this->setExpectedException( ApiUsageException::class,
1497 'You have been blocked from editing.' );
1498
1499 $block = new Block( [
1500 'address' => self::$users['sysop']->getUser()->getName(),
1501 'by' => self::$users['sysop']->getUser()->getId(),
1502 'reason' => 'Capriciousness',
1503 'timestamp' => '19370101000000',
1504 'expiry' => 'infinity',
1505 ] );
1506 $block->insert();
1507
1508 try {
1509 $this->doApiRequestWithToken( [
1510 'action' => 'edit',
1511 'title' => $name,
1512 'text' => 'Some text',
1513 ] );
1514 } finally {
1515 $block->delete();
1516 self::$users['sysop']->getUser()->clearInstanceCache();
1517 }
1518 }
1519
1520 public function testEditWhileReadOnly() {
1521 $name = 'Help:' . ucfirst( __FUNCTION__ );
1522
1523 $this->setExpectedException( ApiUsageException::class,
1524 'The wiki is currently in read-only mode.' );
1525
1526 $svc = \MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode();
1527 $svc->setReason( "Read-only for testing" );
1528
1529 try {
1530 $this->doApiRequestWithToken( [
1531 'action' => 'edit',
1532 'title' => $name,
1533 'text' => 'Some text',
1534 ] );
1535 } finally {
1536 $svc->setReason( false );
1537 }
1538 }
1539
1540 public function testCreateImageRedirectAnon() {
1541 $name = 'File:' . ucfirst( __FUNCTION__ );
1542
1543 $this->setExpectedException( ApiUsageException::class,
1544 "Anonymous users can't create image redirects." );
1545
1546 $this->doApiRequestWithToken( [
1547 'action' => 'edit',
1548 'title' => $name,
1549 'text' => '#REDIRECT [[File:Other file.png]]',
1550 ], null, new User() );
1551 }
1552
1553 public function testCreateImageRedirectLoggedIn() {
1554 $name = 'File:' . ucfirst( __FUNCTION__ );
1555
1556 $this->setExpectedException( ApiUsageException::class,
1557 "You don't have permission to create image redirects." );
1558
1559 $this->setMwGlobals( 'wgRevokePermissions',
1560 [ 'user' => [ 'upload' => true ] ] );
1561
1562 $this->doApiRequestWithToken( [
1563 'action' => 'edit',
1564 'title' => $name,
1565 'text' => '#REDIRECT [[File:Other file.png]]',
1566 ] );
1567 }
1568
1569 public function testTooBigEdit() {
1570 $name = 'Help:' . ucfirst( __FUNCTION__ );
1571
1572 $this->setExpectedException( ApiUsageException::class,
1573 'The content you supplied exceeds the article size limit of 1 kilobyte.' );
1574
1575 $this->setMwGlobals( 'wgMaxArticleSize', 1 );
1576
1577 $text = str_repeat( '!', 1025 );
1578
1579 $this->doApiRequestWithToken( [
1580 'action' => 'edit',
1581 'title' => $name,
1582 'text' => $text,
1583 ] );
1584 }
1585
1586 public function testProhibitedAnonymousEdit() {
1587 $name = 'Help:' . ucfirst( __FUNCTION__ );
1588
1589 $this->setExpectedException( ApiUsageException::class,
1590 'The action you have requested is limited to users in the group: ' );
1591
1592 $this->setMwGlobals( 'wgRevokePermissions', [ '*' => [ 'edit' => true ] ] );
1593
1594 $this->doApiRequestWithToken( [
1595 'action' => 'edit',
1596 'title' => $name,
1597 'text' => 'Some text',
1598 ], null, new User() );
1599 }
1600
1601 public function testProhibitedChangeContentModel() {
1602 $name = 'Help:' . ucfirst( __FUNCTION__ );
1603
1604 $this->setExpectedException( ApiUsageException::class,
1605 "You don't have permission to change the content model of a page." );
1606
1607 $this->setMwGlobals( 'wgRevokePermissions',
1608 [ 'user' => [ 'editcontentmodel' => true ] ] );
1609
1610 $this->doApiRequestWithToken( [
1611 'action' => 'edit',
1612 'title' => $name,
1613 'text' => 'Some text',
1614 'contentmodel' => 'json',
1615 ] );
1616 }
1617}
serialize
serialize()
Definition ApiMessageTrait.php:131
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition GlobalFunctions.php:2705
ApiEditPageTest
Tests for MediaWiki api.php?action=edit.
Definition ApiEditPageTest.php:14
ApiEditPageTest\testEditSection
testEditSection()
Test editing of sections.
Definition ApiEditPageTest.php:163
ApiEditPageTest\testAppendNewSectionWithInvalidContentModel
testAppendNewSectionWithInvalidContentModel()
Definition ApiEditPageTest.php:1067
ApiEditPageTest\testAppendInMediaWikiNamespaceWithSerializationError
testAppendInMediaWikiNamespaceWithSerializationError()
Definition ApiEditPageTest.php:1027
ApiEditPageTest\testEditAbortedByEditPageHookWithNoResult
testEditAbortedByEditPageHookWithNoResult()
Definition ApiEditPageTest.php:1470
ApiEditPageTest\testUndoAfterContentModelChange
testUndoAfterContentModelChange()
This test verifies that after changing the content model of a page, undoing that edit via the API wil...
Definition ApiEditPageTest.php:514
ApiEditPageTest\testCheckDirectApiEditingDisallowed_forNonTextContent
testCheckDirectApiEditingDisallowed_forNonTextContent()
Definition ApiEditPageTest.php:467
ApiEditPageTest\testEdit_redirectText
testEdit_redirectText()
Ensure we cannot edit through a redirect, if attempting to overwrite content.
Definition ApiEditPageTest.php:288
ApiEditPageTest\testEditNewSection
testEditNewSection()
Test action=edit&section=new Run it twice so we test adding a new section on a page that doesn't exis...
Definition ApiEditPageTest.php:202
ApiEditPageTest\testAppendWithNonTextContentHandler
testAppendWithNonTextContentHandler()
Appending/prepending is currently only supported for TextContent.
Definition ApiEditPageTest.php:991
ApiEditPageTest\testUndoWithSwappedRevisions
testUndoWithSwappedRevisions()
Test undo when a revision with a higher id has an earlier timestamp.
Definition ApiEditPageTest.php:710
ApiEditPageTest\testEditConflict_newSection
testEditConflict_newSection()
Ensure that editing using section=new will prevent simple conflicts.
Definition ApiEditPageTest.php:372
ApiEditPageTest\testReversedUndoAfter
testReversedUndoAfter()
undoafter is supposed to be less than undo.
Definition ApiEditPageTest.php:772
ApiEditPageTest\testEdit_redirect
testEdit_redirect()
Ensure we can edit through a redirect, if adding a section.
Definition ApiEditPageTest.php:242
ApiEditPageTest\testEditAppend
testEditAppend( $text, $op, $append, $expected)
provideEditAppend
Definition ApiEditPageTest.php:125
ApiEditPageTest\testUndoAfterToHiddenRev
testUndoAfterToHiddenRev()
Tests what happens if the undo parameter is a valid revision, but undoafter is hidden (rev_deleted).
Definition ApiEditPageTest.php:677
ApiEditPageTest\testSupportsDirectApiEditing_withContentHandlerOverride
testSupportsDirectApiEditing_withContentHandlerOverride()
Definition ApiEditPageTest.php:481
ApiEditPageTest\forceRevisionDate
forceRevisionDate(WikiPage $page, $timestamp)
Definition ApiEditPageTest.php:457
ApiEditPageTest\testUndoAfterToInvalidRev
testUndoAfterToInvalidRev()
Tests what happens if the undo parameter is a valid revision, but the undoafter parameter doesn't ref...
Definition ApiEditPageTest.php:640
ApiEditPageTest\provideEditAppend
static provideEditAppend()
Definition ApiEditPageTest.php:99
ApiTestCase\doApiRequestWithToken
doApiRequestWithToken(array $params, array $session=null, User $user=null, $tokenType='auto')
Convenience function to access the token parameter of doApiRequest() more succinctly.
Definition ApiTestCase.php:133
ApiUsageException
Exception used to abort API execution with an error.
Definition ApiUsageException.php:28
MediaWikiTestCase\editPage
editPage( $pageName, $text, $summary='', $defaultNs=NS_MAIN)
Edits or creates a page/revision.
Definition MediaWikiTestCase.php:2333
MediaWikiTestCase\mergeMwGlobalArrayValue
mergeMwGlobalArrayValue( $name, $values)
Merges the given values into a MW global array variable.
Definition MediaWikiTestCase.php:901
MediaWikiTestCase\setMwGlobals
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition MediaWikiTestCase.php:706
MediaWikiTestCase\hideDeprecated
hideDeprecated( $function)
Don't throw a warning if $function is deprecated and called later.
Definition MediaWikiTestCase.php:1940
MediaWikiTestCase\setTemporaryHook
setTemporaryHook( $hookName, $handler)
Create a temporary hook handler which will be reset by tearDown.
Definition MediaWikiTestCase.php:2291
RevisionDeleter\createList
static createList( $typeName, IContextSource $context, Title $title, array $ids)
Instantiate the appropriate list class for a given list of IDs.
Definition RevisionDeleter.php:83
Revision\DELETED_TEXT
const DELETED_TEXT
Definition Revision.php:47
Revision\RAW
const RAW
Definition Revision.php:57
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
Title
Represents a title within MediaWiki.
Definition Title.php:39
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
WikiPage
Class representing a MediaWiki article and history.
Definition WikiPage.php:44
WikitextContent
Content object for wiki text pages.
Definition WikitextContent.php:35
$res
$res
Definition database.txt:21
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1071
$e
returning false will NOT prevent logging $e
Definition hooks.txt:2226
EDIT_UPDATE
const EDIT_UPDATE
Definition Defines.php:153
MIGRATION_NEW
const MIGRATION_NEW
Definition Defines.php:318
MIGRATION_WRITE_BOTH
const MIGRATION_WRITE_BOTH
Definition Defines.php:316
EDIT_NEW
const EDIT_NEW
Definition Defines.php:152
$content
$content
Definition pageupdater.txt:72
DB_MASTER
const DB_MASTER
Definition defines.php:26