Fix typo in tests/phpunit/includes/Revision/MainSlotRoleHandlerTest.php
[lhc/web/wiklou.git] / tests / phpunit / includes / EditPageTest.php
1 <?php
2
3 use MediaWiki\MediaWikiServices;
4
5 /**
6 * @group Editing
7 *
8 * @group Database
9 * ^--- tell jenkins this test needs the database
10 *
11 * @group medium
12 * ^--- tell phpunit that these test cases may take longer than 2 seconds.
13 */
14 class EditPageTest extends MediaWikiLangTestCase {
15
16 protected function setUp() {
17 parent::setUp();
18
19 $contLang = MediaWikiServices::getInstance()->getContentLanguage();
20 $this->setContentLang( $contLang );
21
22 $this->setMwGlobals( [
23 'wgExtraNamespaces' => [
24 12312 => 'Dummy',
25 12313 => 'Dummy_talk',
26 ],
27 'wgNamespaceContentModels' => [ 12312 => 'testing' ],
28 ] );
29 $this->mergeMwGlobalArrayValue(
30 'wgContentHandlers',
31 [ 'testing' => 'DummyContentHandlerForTesting' ]
32 );
33 }
34
35 /**
36 * @dataProvider provideExtractSectionTitle
37 * @covers EditPage::extractSectionTitle
38 */
39 public function testExtractSectionTitle( $section, $title ) {
40 $extracted = EditPage::extractSectionTitle( $section );
41 $this->assertEquals( $title, $extracted );
42 }
43
44 public static function provideExtractSectionTitle() {
45 return [
46 [
47 "== Test ==\n\nJust a test section.",
48 "Test"
49 ],
50 [
51 "An initial section, no header.",
52 false
53 ],
54 [
55 "An initial section with a fake heder (T34617)\n\n== Test == ??\nwtf",
56 false
57 ],
58 [
59 "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
60 "Section"
61 ],
62 [
63 "== Section== \t\r\n followed by whitespace (T37051)",
64 'Section',
65 ],
66 ];
67 }
68
69 protected function forceRevisionDate( WikiPage $page, $timestamp ) {
70 $dbw = wfGetDB( DB_MASTER );
71
72 $dbw->update( 'revision',
73 [ 'rev_timestamp' => $dbw->timestamp( $timestamp ) ],
74 [ 'rev_id' => $page->getLatest() ] );
75
76 $page->clear();
77 }
78
79 /**
80 * User input text is passed to rtrim() by edit page. This is a simple
81 * wrapper around assertEquals() which calls rrtrim() to normalize the
82 * expected and actual texts.
83 * @param string $expected
84 * @param string $actual
85 * @param string $msg
86 */
87 protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
88 $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
89 }
90
91 /**
92 * Performs an edit and checks the result.
93 *
94 * @param string|Title $title The title of the page to edit
95 * @param string|null $baseText Some text to create the page with before attempting the edit.
96 * @param User|string|null $user The user to perform the edit as.
97 * @param array $edit An array of request parameters used to define the edit to perform.
98 * Some well known fields are:
99 * * wpTextbox1: the text to submit
100 * * wpSummary: the edit summary
101 * * wpEditToken: the edit token (will be inserted if not provided)
102 * * wpEdittime: timestamp of the edit's base revision (will be inserted
103 * if not provided)
104 * * wpStarttime: timestamp when the edit started (will be inserted if not provided)
105 * * wpSectionTitle: the section to edit
106 * * wpMinorEdit: mark as minor edit
107 * * wpWatchthis: whether to watch the page
108 * @param int|null $expectedCode The expected result code (EditPage::AS_XXX constants).
109 * Set to null to skip the check.
110 * @param string|null $expectedText The text expected to be on the page after the edit.
111 * Set to null to skip the check.
112 * @param string|null $message An optional message to show along with any error message.
113 *
114 * @return WikiPage The page that was just edited, useful for getting the edit's rev_id, etc.
115 */
116 protected function assertEdit( $title, $baseText, $user = null, array $edit,
117 $expectedCode = null, $expectedText = null, $message = null
118 ) {
119 if ( is_string( $title ) ) {
120 $ns = $this->getDefaultWikitextNS();
121 $title = Title::newFromText( $title, $ns );
122 }
123 $this->assertNotNull( $title );
124
125 if ( is_string( $user ) ) {
126 $user = User::newFromName( $user );
127
128 if ( $user->getId() === 0 ) {
129 $user->addToDatabase();
130 }
131 }
132
133 $page = WikiPage::factory( $title );
134
135 if ( $baseText !== null ) {
136 $content = ContentHandler::makeContent( $baseText, $title );
137 $page->doEditContent( $content, "base text for test" );
138 $this->forceRevisionDate( $page, '20120101000000' );
139
140 // sanity check
141 $page->clear();
142 $currentText = ContentHandler::getContentText( $page->getContent() );
143
144 # EditPage rtrim() the user input, so we alter our expected text
145 # to reflect that.
146 $this->assertEditedTextEquals( $baseText, $currentText );
147 }
148
149 if ( $user == null ) {
150 $user = $GLOBALS['wgUser'];
151 } else {
152 $this->setMwGlobals( 'wgUser', $user );
153 }
154
155 if ( !isset( $edit['wpEditToken'] ) ) {
156 $edit['wpEditToken'] = $user->getEditToken();
157 }
158
159 if ( !isset( $edit['wpEdittime'] ) ) {
160 $edit['wpEdittime'] = $page->exists() ? $page->getTimestamp() : '';
161 }
162
163 if ( !isset( $edit['wpStarttime'] ) ) {
164 $edit['wpStarttime'] = wfTimestampNow();
165 }
166
167 if ( !isset( $edit['wpUnicodeCheck'] ) ) {
168 $edit['wpUnicodeCheck'] = EditPage::UNICODE_CHECK;
169 }
170
171 $req = new FauxRequest( $edit, true ); // session ??
172
173 $article = new Article( $title );
174 $article->getContext()->setTitle( $title );
175 $ep = new EditPage( $article );
176 $ep->setContextTitle( $title );
177 $ep->importFormData( $req );
178
179 $bot = isset( $edit['bot'] ) ? (bool)$edit['bot'] : false;
180
181 // this is where the edit happens!
182 // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
183 // and throws exceptions like PermissionsError
184 $status = $ep->internalAttemptSave( $result, $bot );
185
186 if ( $expectedCode !== null ) {
187 // check edit code
188 $this->assertEquals( $expectedCode, $status->value,
189 "Expected result code mismatch. $message" );
190 }
191
192 $page = WikiPage::factory( $title );
193
194 if ( $expectedText !== null ) {
195 // check resulting page text
196 $content = $page->getContent();
197 $text = ContentHandler::getContentText( $content );
198
199 # EditPage rtrim() the user input, so we alter our expected text
200 # to reflect that.
201 $this->assertEditedTextEquals( $expectedText, $text,
202 "Expected article text mismatch. $message" );
203 }
204
205 return $page;
206 }
207
208 public static function provideCreatePages() {
209 return [
210 [ 'expected article being created',
211 'EditPageTest_testCreatePage',
212 null,
213 'Hello World!',
214 EditPage::AS_SUCCESS_NEW_ARTICLE,
215 'Hello World!'
216 ],
217 [ 'expected article not being created if empty',
218 'EditPageTest_testCreatePage',
219 null,
220 '',
221 EditPage::AS_BLANK_ARTICLE,
222 null
223 ],
224 [ 'expected MediaWiki: page being created',
225 'MediaWiki:January',
226 'UTSysop',
227 'Not January',
228 EditPage::AS_SUCCESS_NEW_ARTICLE,
229 'Not January'
230 ],
231 [ 'expected not-registered MediaWiki: page not being created if empty',
232 'MediaWiki:EditPageTest_testCreatePage',
233 'UTSysop',
234 '',
235 EditPage::AS_BLANK_ARTICLE,
236 null
237 ],
238 [ 'expected registered MediaWiki: page being created even if empty',
239 'MediaWiki:January',
240 'UTSysop',
241 '',
242 EditPage::AS_SUCCESS_NEW_ARTICLE,
243 ''
244 ],
245 [ 'expected registered MediaWiki: page whose default content is empty'
246 . ' not being created if empty',
247 'MediaWiki:Ipb-default-expiry',
248 'UTSysop',
249 '',
250 EditPage::AS_BLANK_ARTICLE,
251 ''
252 ],
253 [ 'expected MediaWiki: page not being created if text equals default message',
254 'MediaWiki:January',
255 'UTSysop',
256 'January',
257 EditPage::AS_BLANK_ARTICLE,
258 null
259 ],
260 [ 'expected empty article being created',
261 'EditPageTest_testCreatePage',
262 null,
263 '',
264 EditPage::AS_SUCCESS_NEW_ARTICLE,
265 '',
266 true
267 ],
268 ];
269 }
270
271 /**
272 * @dataProvider provideCreatePages
273 * @covers EditPage
274 */
275 public function testCreatePage(
276 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
277 ) {
278 $checkId = null;
279
280 $this->setMwGlobals( 'wgHooks', [
281 'PageContentInsertComplete' => [ function (
282 WikiPage &$page, User &$user, Content $content,
283 $summary, $minor, $u1, $u2, &$flags, Revision $revision
284 ) {
285 // types/refs checked
286 } ],
287 'PageContentSaveComplete' => [ function (
288 WikiPage &$page, User &$user, Content $content,
289 $summary, $minor, $u1, $u2, &$flags, Revision $revision,
290 Status &$status, $baseRevId
291 ) use ( &$checkId ) {
292 $checkId = $status->value['revision']->getId();
293 // types/refs checked
294 } ],
295 ] );
296
297 $edit = [ 'wpTextbox1' => $editText ];
298 if ( $ignoreBlank ) {
299 $edit['wpIgnoreBlankArticle'] = 1;
300 }
301
302 $page = $this->assertEdit( $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
303
304 if ( $expectedCode != EditPage::AS_BLANK_ARTICLE ) {
305 $latest = $page->getLatest();
306 $page->doDeleteArticleReal( $pageTitle );
307
308 $this->assertGreaterThan( 0, $latest, "Page revision ID updated in object" );
309 $this->assertEquals( $latest, $checkId, "Revision in Status for hook" );
310 }
311 }
312
313 /**
314 * @dataProvider provideCreatePages
315 * @covers EditPage
316 */
317 public function testCreatePageTrx(
318 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
319 ) {
320 $checkIds = [];
321 $this->setMwGlobals( 'wgHooks', [
322 'PageContentInsertComplete' => [ function (
323 WikiPage &$page, User &$user, Content $content,
324 $summary, $minor, $u1, $u2, &$flags, Revision $revision
325 ) {
326 // types/refs checked
327 } ],
328 'PageContentSaveComplete' => [ function (
329 WikiPage &$page, User &$user, Content $content,
330 $summary, $minor, $u1, $u2, &$flags, Revision $revision,
331 Status &$status, $baseRevId
332 ) use ( &$checkIds ) {
333 $checkIds[] = $status->value['revision']->getId();
334 // types/refs checked
335 } ],
336 ] );
337
338 wfGetDB( DB_MASTER )->begin( __METHOD__ );
339
340 $edit = [ 'wpTextbox1' => $editText ];
341 if ( $ignoreBlank ) {
342 $edit['wpIgnoreBlankArticle'] = 1;
343 }
344
345 $page = $this->assertEdit(
346 $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
347
348 $pageTitle2 = (string)$pageTitle . '/x';
349 $page2 = $this->assertEdit(
350 $pageTitle2, null, $user, $edit, $expectedCode, $expectedText, $desc );
351
352 wfGetDB( DB_MASTER )->commit( __METHOD__ );
353
354 $this->assertEquals( 0, DeferredUpdates::pendingUpdatesCount(), 'No deferred updates' );
355
356 if ( $expectedCode != EditPage::AS_BLANK_ARTICLE ) {
357 $latest = $page->getLatest();
358 $page->doDeleteArticleReal( $pageTitle );
359
360 $this->assertGreaterThan( 0, $latest, "Page #1 revision ID updated in object" );
361 $this->assertEquals( $latest, $checkIds[0], "Revision #1 in Status for hook" );
362
363 $latest2 = $page2->getLatest();
364 $page2->doDeleteArticleReal( $pageTitle2 );
365
366 $this->assertGreaterThan( 0, $latest2, "Page #2 revision ID updated in object" );
367 $this->assertEquals( $latest2, $checkIds[1], "Revision #2 in Status for hook" );
368 }
369 }
370
371 public function testUpdatePage() {
372 $checkIds = [];
373
374 $this->setMwGlobals( 'wgHooks', [
375 'PageContentInsertComplete' => [ function (
376 WikiPage &$page, User &$user, Content $content,
377 $summary, $minor, $u1, $u2, &$flags, Revision $revision
378 ) {
379 // types/refs checked
380 } ],
381 'PageContentSaveComplete' => [ function (
382 WikiPage &$page, User &$user, Content $content,
383 $summary, $minor, $u1, $u2, &$flags, Revision $revision,
384 Status &$status, $baseRevId
385 ) use ( &$checkIds ) {
386 $checkIds[] = $status->value['revision']->getId();
387 // types/refs checked
388 } ],
389 ] );
390
391 $text = "one";
392 $edit = [
393 'wpTextbox1' => $text,
394 'wpSummary' => 'first update',
395 ];
396
397 $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
398 EditPage::AS_SUCCESS_UPDATE, $text,
399 "expected successful update with given text" );
400 $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
401
402 $this->forceRevisionDate( $page, '20120101000000' );
403
404 $text = "two";
405 $edit = [
406 'wpTextbox1' => $text,
407 'wpSummary' => 'second update',
408 ];
409
410 $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
411 EditPage::AS_SUCCESS_UPDATE, $text,
412 "expected successful update with given text" );
413 $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
414 $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
415 }
416
417 public function testUpdatePageTrx() {
418 $text = "one";
419 $edit = [
420 'wpTextbox1' => $text,
421 'wpSummary' => 'first update',
422 ];
423
424 $page = $this->assertEdit( 'EditPageTest_testTrxUpdatePage', "zero", null, $edit,
425 EditPage::AS_SUCCESS_UPDATE, $text,
426 "expected successful update with given text" );
427
428 $this->forceRevisionDate( $page, '20120101000000' );
429
430 $checkIds = [];
431 $this->setMwGlobals( 'wgHooks', [
432 'PageContentSaveComplete' => [ function (
433 WikiPage &$page, User &$user, Content $content,
434 $summary, $minor, $u1, $u2, &$flags, Revision $revision,
435 Status &$status, $baseRevId
436 ) use ( &$checkIds ) {
437 $checkIds[] = $status->value['revision']->getId();
438 // types/refs checked
439 } ],
440 ] );
441
442 wfGetDB( DB_MASTER )->begin( __METHOD__ );
443
444 $text = "two";
445 $edit = [
446 'wpTextbox1' => $text,
447 'wpSummary' => 'second update',
448 ];
449
450 $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
451 EditPage::AS_SUCCESS_UPDATE, $text,
452 "expected successful update with given text" );
453
454 $text = "three";
455 $edit = [
456 'wpTextbox1' => $text,
457 'wpSummary' => 'third update',
458 ];
459
460 $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
461 EditPage::AS_SUCCESS_UPDATE, $text,
462 "expected successful update with given text" );
463
464 wfGetDB( DB_MASTER )->commit( __METHOD__ );
465
466 $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
467 $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
468 $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
469 }
470
471 public static function provideSectionEdit() {
472 $text = 'Intro
473
474 == one ==
475 first section.
476
477 == two ==
478 second section.
479 ';
480
481 $sectionOne = '== one ==
482 hello
483 ';
484
485 $newSection = '== new section ==
486
487 hello
488 ';
489
490 $textWithNewSectionOne = preg_replace(
491 '/== one ==.*== two ==/ms',
492 "$sectionOne\n== two ==", $text
493 );
494
495 $textWithNewSectionAdded = "$text\n$newSection";
496
497 return [
498 [ # 0
499 $text,
500 '',
501 'hello',
502 'replace all',
503 'hello'
504 ],
505
506 [ # 1
507 $text,
508 '1',
509 $sectionOne,
510 'replace first section',
511 $textWithNewSectionOne,
512 ],
513
514 [ # 2
515 $text,
516 'new',
517 'hello',
518 'new section',
519 $textWithNewSectionAdded,
520 ],
521 ];
522 }
523
524 /**
525 * @dataProvider provideSectionEdit
526 * @covers EditPage
527 */
528 public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
529 $edit = [
530 'wpTextbox1' => $text,
531 'wpSummary' => $summary,
532 'wpSection' => $section,
533 ];
534
535 $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
536 EditPage::AS_SUCCESS_UPDATE, $expected,
537 "expected successful update of section" );
538 }
539
540 public static function provideAutoMerge() {
541 $tests = [];
542
543 $tests[] = [ # 0: plain conflict
544 "Elmo", # base edit user
545 "one\n\ntwo\n\nthree\n",
546 [ # adam's edit
547 'wpStarttime' => 1,
548 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
549 ],
550 [ # berta's edit
551 'wpStarttime' => 2,
552 'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
553 ],
554 EditPage::AS_CONFLICT_DETECTED, # expected code
555 "ONE\n\ntwo\n\nthree\n", # expected text
556 'expected edit conflict', # message
557 ];
558
559 $tests[] = [ # 1: successful merge
560 "Elmo", # base edit user
561 "one\n\ntwo\n\nthree\n",
562 [ # adam's edit
563 'wpStarttime' => 1,
564 'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
565 ],
566 [ # berta's edit
567 'wpStarttime' => 2,
568 'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
569 ],
570 EditPage::AS_SUCCESS_UPDATE, # expected code
571 "ONE\n\ntwo\n\nTHREE\n", # expected text
572 'expected automatic merge', # message
573 ];
574
575 $text = "Intro\n\n";
576 $text .= "== first section ==\n\n";
577 $text .= "one\n\ntwo\n\nthree\n\n";
578 $text .= "== second section ==\n\n";
579 $text .= "four\n\nfive\n\nsix\n\n";
580
581 // extract the first section.
582 $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );
583
584 // generate expected text after merge
585 $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );
586
587 $tests[] = [ # 2: merge in section
588 "Elmo", # base edit user
589 $text,
590 [ # adam's edit
591 'wpStarttime' => 1,
592 'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
593 'wpSection' => '1'
594 ],
595 [ # berta's edit
596 'wpStarttime' => 2,
597 'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
598 'wpSection' => '1'
599 ],
600 EditPage::AS_SUCCESS_UPDATE, # expected code
601 $expected, # expected text
602 'expected automatic section merge', # message
603 ];
604
605 // see whether it makes a difference who did the base edit
606 $testsWithAdam = array_map( function ( $test ) {
607 $test[0] = 'Adam'; // change base edit user
608 return $test;
609 }, $tests );
610
611 $testsWithBerta = array_map( function ( $test ) {
612 $test[0] = 'Berta'; // change base edit user
613 return $test;
614 }, $tests );
615
616 return array_merge( $tests, $testsWithAdam, $testsWithBerta );
617 }
618
619 /**
620 * @dataProvider provideAutoMerge
621 * @covers EditPage
622 */
623 public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
624 $expectedCode, $expectedText, $message = null
625 ) {
626 $this->markTestSkippedIfNoDiff3();
627
628 // create page
629 $ns = $this->getDefaultWikitextNS();
630 $title = Title::newFromText( 'EditPageTest_testAutoMerge', $ns );
631 $page = WikiPage::factory( $title );
632
633 if ( $page->exists() ) {
634 $page->doDeleteArticle( "clean slate for testing" );
635 }
636
637 $baseEdit = [
638 'wpTextbox1' => $text,
639 ];
640
641 $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
642 $baseUser, $baseEdit, null, null, __METHOD__ );
643
644 $this->forceRevisionDate( $page, '20120101000000' );
645
646 $edittime = $page->getTimestamp();
647
648 // start timestamps for conflict detection
649 if ( !isset( $adamsEdit['wpStarttime'] ) ) {
650 $adamsEdit['wpStarttime'] = 1;
651 }
652
653 if ( !isset( $bertasEdit['wpStarttime'] ) ) {
654 $bertasEdit['wpStarttime'] = 2;
655 }
656
657 $starttime = wfTimestampNow();
658 $adamsTime = wfTimestamp(
659 TS_MW,
660 (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$adamsEdit['wpStarttime']
661 );
662 $bertasTime = wfTimestamp(
663 TS_MW,
664 (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$bertasEdit['wpStarttime']
665 );
666
667 $adamsEdit['wpStarttime'] = $adamsTime;
668 $bertasEdit['wpStarttime'] = $bertasTime;
669
670 $adamsEdit['wpSummary'] = 'Adam\'s edit';
671 $bertasEdit['wpSummary'] = 'Bertas\'s edit';
672
673 $adamsEdit['wpEdittime'] = $edittime;
674 $bertasEdit['wpEdittime'] = $edittime;
675
676 // first edit
677 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
678 EditPage::AS_SUCCESS_UPDATE, null, "expected successful update" );
679
680 // second edit
681 $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
682 $expectedCode, $expectedText, $message );
683 }
684
685 /**
686 * @depends testAutoMerge
687 */
688 public function testCheckDirectEditingDisallowed_forNonTextContent() {
689 $title = Title::newFromText( 'Dummy:NonTextPageForEditPage' );
690 $page = WikiPage::factory( $title );
691
692 $article = new Article( $title );
693 $article->getContext()->setTitle( $title );
694 $ep = new EditPage( $article );
695 $ep->setContextTitle( $title );
696
697 $user = $GLOBALS['wgUser'];
698
699 $edit = [
700 'wpTextbox1' => serialize( 'non-text content' ),
701 'wpEditToken' => $user->getEditToken(),
702 'wpEdittime' => '',
703 'wpStarttime' => wfTimestampNow(),
704 'wpUnicodeCheck' => EditPage::UNICODE_CHECK,
705 ];
706
707 $req = new FauxRequest( $edit, true );
708 $ep->importFormData( $req );
709
710 $this->setExpectedException(
711 MWException::class,
712 'This content model is not supported: testing'
713 );
714
715 $ep->internalAttemptSave( $result, false );
716 }
717
718 }