MediaWiki  master
PageUpdaterTest.php
Go to the documentation of this file.
1 <?php
2 
4 
15 use Title;
16 use User;
18 
24 
25  private function getDummyTitle( $method ) {
26  return Title::newFromText( $method, $this->getDefaultWikitextNS() );
27  }
28 
34  private function getRecentChangeFor( $revId ) {
36  $row = $this->db->selectRow(
37  $qi['tables'],
38  $qi['fields'],
39  [ 'rc_this_oldid' => $revId ],
40  __METHOD__,
41  [],
42  $qi['joins']
43  );
44 
45  return $row ? RecentChange::newFromRow( $row ) : null;
46  }
47 
48  // TODO: test setAjaxEditStash();
49 
54  public function testCreatePage() {
55  $user = $this->getTestUser()->getUser();
56 
57  $title = $this->getDummyTitle( __METHOD__ );
58  $page = WikiPage::factory( $title );
59  $updater = $page->newPageUpdater( $user );
60 
61  $oldStats = $this->db->selectRow( 'site_stats', '*', '1=1' );
62 
63  $this->assertFalse( $updater->wasCommitted(), 'wasCommitted' );
64  $this->assertFalse( $updater->getOriginalRevisionId(), 'getOriginalRevisionId' );
65  $this->assertSame( 0, $updater->getUndidRevisionId(), 'getUndidRevisionId' );
66 
67  $updater->addTag( 'foo' );
68  $updater->addTags( [ 'bar', 'qux' ] );
69 
70  $tags = $updater->getExplicitTags();
71  sort( $tags );
72  $this->assertSame( [ 'bar', 'foo', 'qux' ], $tags, 'getExplicitTags' );
73 
74  // TODO: MCR: test additional slots
75  $content = new TextContent( 'Lorem Ipsum' );
76  $updater->setContent( SlotRecord::MAIN, $content );
77 
78  $parent = $updater->grabParentRevision();
79 
80  $this->assertNull( $parent, 'getParentRevision' );
81  $this->assertFalse( $updater->wasCommitted(), 'wasCommitted' );
82 
83  // TODO: test that hasEditConflict() grabs the parent revision
84  $this->assertFalse( $updater->hasEditConflict( 0 ), 'hasEditConflict' );
85  $this->assertTrue( $updater->hasEditConflict( 1 ), 'hasEditConflict' );
86 
87  // TODO: test failure with EDIT_UPDATE
88  // TODO: test EDIT_MINOR, EDIT_BOT, etc
89  $summary = CommentStoreComment::newUnsavedComment( 'Just a test' );
90  $rev = $updater->saveRevision( $summary );
91 
92  $this->assertNotNull( $rev );
93  $this->assertSame( 0, $rev->getParentId() );
94  $this->assertSame( $summary->text, $rev->getComment( RevisionRecord::RAW )->text );
95  $this->assertSame( $user->getName(), $rev->getUser( RevisionRecord::RAW )->getName() );
96 
97  $this->assertTrue( $updater->wasCommitted(), 'wasCommitted()' );
98  $this->assertTrue( $updater->wasSuccessful(), 'wasSuccessful()' );
99  $this->assertTrue( $updater->getStatus()->isOK(), 'getStatus()->isOK()' );
100  $this->assertTrue( $updater->isNew(), 'isNew()' );
101  $this->assertFalse( $updater->isUnchanged(), 'isUnchanged()' );
102  $this->assertNotNull( $updater->getNewRevision(), 'getNewRevision()' );
103  $this->assertInstanceOf( Revision::class, $updater->getStatus()->value['revision'] );
104 
105  $rev = $updater->getNewRevision();
106  $revContent = $rev->getContent( SlotRecord::MAIN );
107  $this->assertSame( 'Lorem Ipsum', $revContent->serialize(), 'revision content' );
108 
109  // were the WikiPage and Title objects updated?
110  $this->assertTrue( $page->exists(), 'WikiPage::exists()' );
111  $this->assertTrue( $title->exists(), 'Title::exists()' );
112  $this->assertSame( $rev->getId(), $page->getLatest(), 'WikiPage::getRevision()' );
113  $this->assertNotNull( $page->getRevision(), 'WikiPage::getRevision()' );
114 
115  // re-load
116  $page2 = WikiPage::factory( $title );
117  $this->assertTrue( $page2->exists(), 'WikiPage::exists()' );
118  $this->assertSame( $rev->getId(), $page2->getLatest(), 'WikiPage::getRevision()' );
119  $this->assertNotNull( $page2->getRevision(), 'WikiPage::getRevision()' );
120 
121  // Check RC entry
122  $rc = $this->getRecentChangeFor( $rev->getId() );
123  $this->assertNotNull( $rc, 'RecentChange' );
124 
125  // check site stats - this asserts that derived data updates where run.
126  $stats = $this->db->selectRow( 'site_stats', '*', '1=1' );
127  $this->assertSame( $oldStats->ss_total_pages + 1, (int)$stats->ss_total_pages );
128  $this->assertSame( $oldStats->ss_total_edits + 1, (int)$stats->ss_total_edits );
129 
130  // re-edit with same content - should be a "null-edit"
131  $updater = $page->newPageUpdater( $user );
132  $updater->setContent( SlotRecord::MAIN, $content );
133 
134  $summary = CommentStoreComment::newUnsavedComment( 'to to re-edit' );
135  $rev = $updater->saveRevision( $summary );
136  $status = $updater->getStatus();
137 
138  $this->assertNull( $rev, 'getNewRevision()' );
139  $this->assertNull( $updater->getNewRevision(), 'getNewRevision()' );
140  $this->assertTrue( $updater->isUnchanged(), 'isUnchanged' );
141  $this->assertTrue( $updater->wasSuccessful(), 'wasSuccessful()' );
142  $this->assertTrue( $status->isOK(), 'getStatus()->isOK()' );
143  $this->assertTrue( $status->hasMessage( 'edit-no-change' ), 'edit-no-change' );
144  }
145 
150  public function testUpdatePage() {
151  $user = $this->getTestUser()->getUser();
152 
153  $title = $this->getDummyTitle( __METHOD__ );
154  $this->insertPage( $title );
155 
156  $page = WikiPage::factory( $title );
157  $parentId = $page->getLatest();
158 
159  $updater = $page->newPageUpdater( $user );
160 
161  $oldStats = $this->db->selectRow( 'site_stats', '*', '1=1' );
162 
163  $updater->setOriginalRevisionId( 7 );
164  $this->assertSame( 7, $updater->getOriginalRevisionId(), 'getOriginalRevisionId' );
165 
166  $this->assertFalse( $updater->hasEditConflict( $parentId ), 'hasEditConflict' );
167  $this->assertTrue( $updater->hasEditConflict( $parentId - 1 ), 'hasEditConflict' );
168  $this->assertTrue( $updater->hasEditConflict( 0 ), 'hasEditConflict' );
169 
170  // TODO: MCR: test additional slots
171  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
172 
173  // TODO: test all flags for saveRevision()!
174  $summary = CommentStoreComment::newUnsavedComment( 'Just a test' );
175  $rev = $updater->saveRevision( $summary );
176 
177  $this->assertNotNull( $rev );
178  $this->assertSame( $parentId, $rev->getParentId() );
179  $this->assertSame( $summary->text, $rev->getComment( RevisionRecord::RAW )->text );
180  $this->assertSame( $user->getName(), $rev->getUser( RevisionRecord::RAW )->getName() );
181 
182  $this->assertTrue( $updater->wasCommitted(), 'wasCommitted()' );
183  $this->assertTrue( $updater->wasSuccessful(), 'wasSuccessful()' );
184  $this->assertTrue( $updater->getStatus()->isOK(), 'getStatus()->isOK()' );
185  $this->assertFalse( $updater->isNew(), 'isNew()' );
186  $this->assertNotNull( $updater->getNewRevision(), 'getNewRevision()' );
187  $this->assertInstanceOf( Revision::class, $updater->getStatus()->value['revision'] );
188  $this->assertFalse( $updater->isUnchanged(), 'isUnchanged()' );
189 
190  // TODO: Test null revision (with different user): new revision!
191 
192  $rev = $updater->getNewRevision();
193  $revContent = $rev->getContent( SlotRecord::MAIN );
194  $this->assertSame( 'Lorem Ipsum', $revContent->serialize(), 'revision content' );
195 
196  // were the WikiPage and Title objects updated?
197  $this->assertTrue( $page->exists(), 'WikiPage::exists()' );
198  $this->assertTrue( $title->exists(), 'Title::exists()' );
199  $this->assertSame( $rev->getId(), $page->getLatest(), 'WikiPage::getRevision()' );
200  $this->assertNotNull( $page->getRevision(), 'WikiPage::getRevision()' );
201 
202  // re-load
203  $page2 = WikiPage::factory( $title );
204  $this->assertTrue( $page2->exists(), 'WikiPage::exists()' );
205  $this->assertSame( $rev->getId(), $page2->getLatest(), 'WikiPage::getRevision()' );
206  $this->assertNotNull( $page2->getRevision(), 'WikiPage::getRevision()' );
207 
208  // Check RC entry
209  $rc = $this->getRecentChangeFor( $rev->getId() );
210  $this->assertNotNull( $rc, 'RecentChange' );
211 
212  // re-edit
213  $updater = $page->newPageUpdater( $user );
214  $updater->setContent( SlotRecord::MAIN, new TextContent( 'dolor sit amet' ) );
215 
216  $summary = CommentStoreComment::newUnsavedComment( 're-edit' );
217  $updater->saveRevision( $summary );
218  $this->assertTrue( $updater->wasSuccessful(), 'wasSuccessful()' );
219  $this->assertTrue( $updater->getStatus()->isOK(), 'getStatus()->isOK()' );
220 
221  // check site stats - this asserts that derived data updates where run.
222  $stats = $this->db->selectRow( 'site_stats', '*', '1=1' );
223  $this->assertNotNull( $stats, 'site_stats' );
224  $this->assertSame( $oldStats->ss_total_pages + 0, (int)$stats->ss_total_pages );
225  $this->assertSame( $oldStats->ss_total_edits + 2, (int)$stats->ss_total_edits );
226  }
227 
237  private function createRevision( WikiPage $page, $summary, $content = null ) {
238  $user = $this->getTestUser()->getUser();
239  $comment = CommentStoreComment::newUnsavedComment( $summary );
240 
241  if ( !$content instanceof Content ) {
242  $content = new TextContent( $content ?? $summary );
243  }
244 
245  $updater = $page->newPageUpdater( $user );
246  $updater->setContent( SlotRecord::MAIN, $content );
247  $rev = $updater->saveRevision( $comment );
248  return $rev;
249  }
250 
255  public function testCompareAndSwapFailure() {
256  $user = $this->getTestUser()->getUser();
257 
258  $title = $this->getDummyTitle( __METHOD__ );
259 
260  // start editing non-existing page
261  $page = WikiPage::factory( $title );
262  $updater = $page->newPageUpdater( $user );
263  $updater->grabParentRevision();
264 
265  // create page concurrently
266  $concurrentPage = WikiPage::factory( $title );
267  $this->createRevision( $concurrentPage, __METHOD__ . '-one' );
268 
269  // try creating the page - should trigger CAS failure.
270  $summary = CommentStoreComment::newUnsavedComment( 'create?!' );
271  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem ipsum' ) );
272  $updater->saveRevision( $summary );
273  $status = $updater->getStatus();
274 
275  $this->assertFalse( $updater->wasSuccessful(), 'wasSuccessful()' );
276  $this->assertNull( $updater->getNewRevision(), 'getNewRevision()' );
277  $this->assertFalse( $status->isOK(), 'getStatus()->isOK()' );
278  $this->assertTrue( $status->hasMessage( 'edit-already-exists' ), 'edit-conflict' );
279 
280  // start editing existing page
281  $page = WikiPage::factory( $title );
282  $updater = $page->newPageUpdater( $user );
283  $updater->grabParentRevision();
284 
285  // update page concurrently
286  $concurrentPage = WikiPage::factory( $title );
287  $this->createRevision( $concurrentPage, __METHOD__ . '-two' );
288 
289  // try creating the page - should trigger CAS failure.
290  $summary = CommentStoreComment::newUnsavedComment( 'edit?!' );
291  $updater->setContent( SlotRecord::MAIN, new TextContent( 'dolor sit amet' ) );
292  $updater->saveRevision( $summary );
293  $status = $updater->getStatus();
294 
295  $this->assertFalse( $updater->wasSuccessful(), 'wasSuccessful()' );
296  $this->assertNull( $updater->getNewRevision(), 'getNewRevision()' );
297  $this->assertFalse( $status->isOK(), 'getStatus()->isOK()' );
298  $this->assertTrue( $status->hasMessage( 'edit-conflict' ), 'edit-conflict' );
299  }
300 
304  public function testFailureOnEditFlags() {
305  $user = $this->getTestUser()->getUser();
306 
307  $title = $this->getDummyTitle( __METHOD__ );
308 
309  // start editing non-existing page
310  $page = WikiPage::factory( $title );
311  $updater = $page->newPageUpdater( $user );
312 
313  // update with EDIT_UPDATE flag should fail
314  $summary = CommentStoreComment::newUnsavedComment( 'udpate?!' );
315  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem ipsum' ) );
316  $updater->saveRevision( $summary, EDIT_UPDATE );
317  $status = $updater->getStatus();
318 
319  $this->assertFalse( $updater->wasSuccessful(), 'wasSuccessful()' );
320  $this->assertNull( $updater->getNewRevision(), 'getNewRevision()' );
321  $this->assertFalse( $status->isOK(), 'getStatus()->isOK()' );
322  $this->assertTrue( $status->hasMessage( 'edit-gone-missing' ), 'edit-gone-missing' );
323 
324  // create the page
325  $this->createRevision( $page, __METHOD__ );
326 
327  // update with EDIT_NEW flag should fail
328  $summary = CommentStoreComment::newUnsavedComment( 'create?!' );
329  $updater = $page->newPageUpdater( $user );
330  $updater->setContent( SlotRecord::MAIN, new TextContent( 'dolor sit amet' ) );
331  $updater->saveRevision( $summary, EDIT_NEW );
332  $status = $updater->getStatus();
333 
334  $this->assertFalse( $updater->wasSuccessful(), 'wasSuccessful()' );
335  $this->assertNull( $updater->getNewRevision(), 'getNewRevision()' );
336  $this->assertFalse( $status->isOK(), 'getStatus()->isOK()' );
337  $this->assertTrue( $status->hasMessage( 'edit-already-exists' ), 'edit-already-exists' );
338  }
339 
340  public function provideSetRcPatrolStatus( $patrolled ) {
343  }
344 
349  public function testSetRcPatrolStatus( $patrolled ) {
350  $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
351 
352  $user = $this->getTestUser()->getUser();
353 
354  $title = $this->getDummyTitle( __METHOD__ );
355 
356  $page = WikiPage::factory( $title );
357  $updater = $page->newPageUpdater( $user );
358 
359  $summary = CommentStoreComment::newUnsavedComment( 'Lorem ipsum ' . $patrolled );
360  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem ipsum ' . $patrolled ) );
361  $updater->setRcPatrolStatus( $patrolled );
362  $rev = $updater->saveRevision( $summary );
363 
364  $rc = $revisionStore->getRecentChange( $rev );
365  $this->assertEquals( $patrolled, $rc->getAttribute( 'rc_patrolled' ) );
366  }
367 
372  public function testInheritSlot() {
373  $user = $this->getTestUser()->getUser();
374  $title = $this->getDummyTitle( __METHOD__ );
375  $page = WikiPage::factory( $title );
376 
377  $updater = $page->newPageUpdater( $user );
378  $summary = CommentStoreComment::newUnsavedComment( 'one' );
379  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem ipsum' ) );
380  $rev1 = $updater->saveRevision( $summary, EDIT_NEW );
381 
382  $updater = $page->newPageUpdater( $user );
383  $summary = CommentStoreComment::newUnsavedComment( 'two' );
384  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Foo Bar' ) );
385  $rev2 = $updater->saveRevision( $summary, EDIT_UPDATE );
386 
387  $updater = $page->newPageUpdater( $user );
388  $summary = CommentStoreComment::newUnsavedComment( 'three' );
389  $updater->inheritSlot( $rev1->getSlot( SlotRecord::MAIN ) );
390  $rev3 = $updater->saveRevision( $summary, EDIT_UPDATE );
391 
392  $this->assertNotSame( $rev1->getId(), $rev3->getId() );
393  $this->assertNotSame( $rev2->getId(), $rev3->getId() );
394 
395  $main1 = $rev1->getSlot( SlotRecord::MAIN );
396  $main3 = $rev3->getSlot( SlotRecord::MAIN );
397 
398  $this->assertNotSame( $main1->getRevision(), $main3->getRevision() );
399  $this->assertSame( $main1->getAddress(), $main3->getAddress() );
400  $this->assertTrue( $main1->getContent()->equals( $main3->getContent() ) );
401  }
402 
403  // TODO: MCR: test adding multiple slots, inheriting parent slots, and removing slots.
404 
406  $this->setContentLang( 'qqx' );
407  $user = $this->getTestUser()->getUser();
408 
409  $title = $this->getDummyTitle( __METHOD__ );
410  $page = WikiPage::factory( $title );
411 
412  $updater = $page->newPageUpdater( $user );
413  $updater->setUseAutomaticEditSummaries( true );
414  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
415 
416  // empty comment triggers auto-summary
418  $updater->saveRevision( $summary, EDIT_AUTOSUMMARY );
419 
420  $rev = $updater->getNewRevision();
421  $comment = $rev->getComment( RevisionRecord::RAW );
422  $this->assertSame( '(autosumm-new: Lorem Ipsum)', $comment->text, 'comment text' );
423 
424  // check that this also works when blanking the page
425  $updater = $page->newPageUpdater( $user );
426  $updater->setUseAutomaticEditSummaries( true );
427  $updater->setContent( SlotRecord::MAIN, new TextContent( '' ) );
428 
430  $updater->saveRevision( $summary, EDIT_AUTOSUMMARY );
431 
432  $rev = $updater->getNewRevision();
433  $comment = $rev->getComment( RevisionRecord::RAW );
434  $this->assertSame( '(autosumm-blank)', $comment->text, 'comment text' );
435 
436  // check that we can also disable edit-summaries
437  $title2 = $this->getDummyTitle( __METHOD__ . '/2' );
438  $page2 = WikiPage::factory( $title2 );
439 
440  $updater = $page2->newPageUpdater( $user );
441  $updater->setUseAutomaticEditSummaries( false );
442  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
443 
445  $updater->saveRevision( $summary, EDIT_AUTOSUMMARY );
446 
447  $rev = $updater->getNewRevision();
448  $comment = $rev->getComment( RevisionRecord::RAW );
449  $this->assertSame( '', $comment->text, 'comment text should still be lank' );
450 
451  // check that we don't do auto.summaries without the EDIT_AUTOSUMMARY flag
452  $updater = $page2->newPageUpdater( $user );
453  $updater->setUseAutomaticEditSummaries( true );
454  $updater->setContent( SlotRecord::MAIN, new TextContent( '' ) );
455 
457  $updater->saveRevision( $summary, 0 );
458 
459  $rev = $updater->getNewRevision();
460  $comment = $rev->getComment( RevisionRecord::RAW );
461  $this->assertSame( '', $comment->text, 'comment text' );
462  }
463 
464  public function provideSetUsePageCreationLog() {
465  yield [ true, [ [ 'create', 'create' ] ] ];
466  yield [ false, [] ];
467  }
468 
473  public function testSetUsePageCreationLog( $use, $expected ) {
474  $user = $this->getTestUser()->getUser();
475  $title = $this->getDummyTitle( __METHOD__ . ( $use ? '_logged' : '_unlogged' ) );
476  $page = WikiPage::factory( $title );
477 
478  $updater = $page->newPageUpdater( $user );
479  $updater->setUsePageCreationLog( $use );
480  $summary = CommentStoreComment::newUnsavedComment( 'cmt' );
481  $updater->setContent( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
482  $updater->saveRevision( $summary, EDIT_NEW );
483 
484  $rev = $updater->getNewRevision();
485  $this->assertSelect(
486  'logging',
487  [ 'log_type', 'log_action' ],
488  [ 'log_page' => $rev->getPageId() ],
489  $expected
490  );
491  }
492 
493  public function provideMagicWords() {
494  yield 'PAGEID' => [
495  'Test {{PAGEID}} Test',
496  function ( RevisionRecord $rev ) {
497  return $rev->getPageId();
498  }
499  ];
500 
501  yield 'REVISIONID' => [
502  'Test {{REVISIONID}} Test',
503  function ( RevisionRecord $rev ) {
504  return $rev->getId();
505  }
506  ];
507 
508  yield 'REVISIONUSER' => [
509  'Test {{REVISIONUSER}} Test',
510  function ( RevisionRecord $rev ) {
511  return $rev->getUser()->getName();
512  }
513  ];
514 
515  yield 'REVISIONTIMESTAMP' => [
516  'Test {{REVISIONTIMESTAMP}} Test',
517  function ( RevisionRecord $rev ) {
518  return $rev->getTimestamp();
519  }
520  ];
521 
522  yield 'subst:REVISIONUSER' => [
523  'Test {{subst:REVISIONUSER}} Test',
524  function ( RevisionRecord $rev ) {
525  return $rev->getUser()->getName();
526  },
527  'subst'
528  ];
529 
530  yield 'subst:PAGENAME' => [
531  'Test {{subst:PAGENAME}} Test',
532  function ( RevisionRecord $rev ) {
533  return 'PageUpdaterTest::testMagicWords';
534  },
535  'subst'
536  ];
537  }
538 
549  public function testMagicWords( $wikitext, $callback, $subst = false ) {
550  $user = User::newFromName( 'A user for ' . __METHOD__ );
551  $user->addToDatabase();
552 
553  $title = $this->getDummyTitle( __METHOD__ . '-' . $this->getName() );
554  $this->insertPage( $title );
555 
556  $page = WikiPage::factory( $title );
557  $updater = $page->newPageUpdater( $user );
558 
559  $updater->setContent( SlotRecord::MAIN, new \WikitextContent( $wikitext ) );
560 
561  $summary = CommentStoreComment::newUnsavedComment( 'Just a test' );
562  $rev = $updater->saveRevision( $summary, EDIT_UPDATE );
563 
564  if ( !$rev ) {
565  $this->fail( $updater->getStatus()->getWikiText() );
566  }
567 
568  $expected = strval( $callback( $rev ) );
569 
570  $output = $page->getParserOutput( ParserOptions::newCanonical( 'canonical' ) );
571  $html = $output->getText();
572  $text = $rev->getContent( SlotRecord::MAIN )->serialize();
573 
574  if ( $subst ) {
575  $this->assertContains( $expected, $text, 'In Wikitext' );
576  }
577 
578  $this->assertContains( $expected, $html, 'In HTML' );
579  }
580 
581 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:127
testFailureOnEditFlags()
\MediaWiki\Storage\PageUpdater::saveRevision()
\MediaWiki\Storage\PageUpdater Database
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1997
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
testSetRcPatrolStatus( $patrolled)
provideSetRcPatrolStatus \MediaWiki\Storage\PageUpdater::setRcPatrolStatus()
static array static newFromRow( $row)
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:1277
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
const EDIT_UPDATE
Definition: Defines.php:153
static getInstance()
Returns the global default instance of the top level service locator.
static newUnsavedComment( $comment, array $data=null)
Create a new, unsaved CommentStoreComment.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2222
testMagicWords( $wikitext, $callback, $subst=false)
\MediaWiki\Storage\PageUpdater::saveRevision()
static newCanonical( $context=null, $userLang=null)
Creates a "canonical" ParserOptions object.
testSetUsePageCreationLog( $use, $expected)
provideSetUsePageCreationLog
testUpdatePage()
\MediaWiki\Storage\PageUpdater::saveRevision() \WikiPage::newPageUpdater()
getDefaultWikitextNS()
Returns the ID of a namespace that defaults to Wikitext.
newPageUpdater(User $user, RevisionSlotsUpdate $forUpdate=null)
Returns a PageUpdater for creating new revisions on this page (or creating the page).
Definition: WikiPage.php:1764
testCreatePage()
\MediaWiki\Storage\PageUpdater::saveRevision() \WikiPage::newPageUpdater()
insertPage( $pageName, $text='Sample page for unit test.', $namespace=null, User $user=null)
Insert a new page.
testCompareAndSwapFailure()
\MediaWiki\Storage\PageUpdater::grabParentRevision() \MediaWiki\Storage\PageUpdater::saveRevision() ...
const EDIT_AUTOSUMMARY
Definition: Defines.php:158
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:936
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition: hooks.txt:1781
assertSelect( $table, $fields, $condition, array $expectedRows, array $options=[], array $join_conds=[])
Asserts that the given database query yields the rows given by $expectedRows.
const PRC_UNPATROLLED
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
testInheritSlot()
\MediaWiki\Storage\PageUpdater::inheritSlot() \MediaWiki\Storage\PageUpdater::setContent() ...
$parent
Definition: pageupdater.txt:71
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
const EDIT_NEW
Definition: Defines.php:152
$page->newPageUpdater($user) $updater
Definition: pageupdater.txt:63
static getQueryInfo()
Return the tables, fields, and join conditions to be selected to create a new recentchanges object...
Page revision base class.
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:592
const PRC_AUTOPATROLLED
$content
Definition: pageupdater.txt:72
createRevision(WikiPage $page, $summary, $content=null)
Creates a revision in the database.
static getTestUser( $groups=[])
Convenience method for getting an immutable test user.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:280