MediaWiki  REL1_31
EditPageTest.php
Go to the documentation of this file.
1 <?php
2 
13 
14  protected function setUp() {
16 
17  parent::setUp();
18 
19  $this->setMwGlobals( [
20  'wgExtraNamespaces' => $wgExtraNamespaces,
21  'wgNamespaceContentModels' => $wgNamespaceContentModels,
22  'wgContentHandlers' => $wgContentHandlers,
23  'wgContLang' => $wgContLang,
24  ] );
25 
26  $wgExtraNamespaces[12312] = 'Dummy';
27  $wgExtraNamespaces[12313] = 'Dummy_talk';
28 
29  $wgNamespaceContentModels[12312] = "testing";
30  $wgContentHandlers["testing"] = 'DummyContentHandlerForTesting';
31 
33  $wgContLang->resetNamespaces(); # reset namespace cache
34  }
35 
36  protected function tearDown() {
38 
40  $wgContLang->resetNamespaces(); # reset namespace cache
41  parent::tearDown();
42  }
43 
48  public function testExtractSectionTitle( $section, $title ) {
50  $this->assertEquals( $title, $extracted );
51  }
52 
53  public static function provideExtractSectionTitle() {
54  return [
55  [
56  "== Test ==\n\nJust a test section.",
57  "Test"
58  ],
59  [
60  "An initial section, no header.",
61  false
62  ],
63  [
64  "An initial section with a fake heder (T34617)\n\n== Test == ??\nwtf",
65  false
66  ],
67  [
68  "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
69  "Section"
70  ],
71  [
72  "== Section== \t\r\n followed by whitespace (T37051)",
73  'Section',
74  ],
75  ];
76  }
77 
78  protected function forceRevisionDate( WikiPage $page, $timestamp ) {
79  $dbw = wfGetDB( DB_MASTER );
80 
81  $dbw->update( 'revision',
82  [ 'rev_timestamp' => $dbw->timestamp( $timestamp ) ],
83  [ 'rev_id' => $page->getLatest() ] );
84 
85  $page->clear();
86  }
87 
96  protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
97  $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
98  }
99 
125  protected function assertEdit( $title, $baseText, $user = null, array $edit,
126  $expectedCode = null, $expectedText = null, $message = null
127  ) {
128  if ( is_string( $title ) ) {
129  $ns = $this->getDefaultWikitextNS();
130  $title = Title::newFromText( $title, $ns );
131  }
132  $this->assertNotNull( $title );
133 
134  if ( is_string( $user ) ) {
136 
137  if ( $user->getId() === 0 ) {
138  $user->addToDatabase();
139  }
140  }
141 
142  $page = WikiPage::factory( $title );
143 
144  if ( $baseText !== null ) {
145  $content = ContentHandler::makeContent( $baseText, $title );
146  $page->doEditContent( $content, "base text for test" );
147  $this->forceRevisionDate( $page, '20120101000000' );
148 
149  // sanity check
150  $page->clear();
151  $currentText = ContentHandler::getContentText( $page->getContent() );
152 
153  # EditPage rtrim() the user input, so we alter our expected text
154  # to reflect that.
155  $this->assertEditedTextEquals( $baseText, $currentText );
156  }
157 
158  if ( $user == null ) {
159  $user = $GLOBALS['wgUser'];
160  } else {
161  $this->setMwGlobals( 'wgUser', $user );
162  }
163 
164  if ( !isset( $edit['wpEditToken'] ) ) {
165  $edit['wpEditToken'] = $user->getEditToken();
166  }
167 
168  if ( !isset( $edit['wpEdittime'] ) ) {
169  $edit['wpEdittime'] = $page->exists() ? $page->getTimestamp() : '';
170  }
171 
172  if ( !isset( $edit['wpStarttime'] ) ) {
173  $edit['wpStarttime'] = wfTimestampNow();
174  }
175 
176  if ( !isset( $edit['wpUnicodeCheck'] ) ) {
177  $edit['wpUnicodeCheck'] = EditPage::UNICODE_CHECK;
178  }
179 
180  $req = new FauxRequest( $edit, true ); // session ??
181 
182  $article = new Article( $title );
183  $article->getContext()->setTitle( $title );
184  $ep = new EditPage( $article );
185  $ep->setContextTitle( $title );
186  $ep->importFormData( $req );
187 
188  $bot = isset( $edit['bot'] ) ? (bool)$edit['bot'] : false;
189 
190  // this is where the edit happens!
191  // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
192  // and throws exceptions like PermissionsError
193  $status = $ep->internalAttemptSave( $result, $bot );
194 
195  if ( $expectedCode !== null ) {
196  // check edit code
197  $this->assertEquals( $expectedCode, $status->value,
198  "Expected result code mismatch. $message" );
199  }
200 
201  $page = WikiPage::factory( $title );
202 
203  if ( $expectedText !== null ) {
204  // check resulting page text
205  $content = $page->getContent();
206  $text = ContentHandler::getContentText( $content );
207 
208  # EditPage rtrim() the user input, so we alter our expected text
209  # to reflect that.
210  $this->assertEditedTextEquals( $expectedText, $text,
211  "Expected article text mismatch. $message" );
212  }
213 
214  return $page;
215  }
216 
217  public static function provideCreatePages() {
218  return [
219  [ 'expected article being created',
220  'EditPageTest_testCreatePage',
221  null,
222  'Hello World!',
224  'Hello World!'
225  ],
226  [ 'expected article not being created if empty',
227  'EditPageTest_testCreatePage',
228  null,
229  '',
231  null
232  ],
233  [ 'expected MediaWiki: page being created',
234  'MediaWiki:January',
235  'UTSysop',
236  'Not January',
238  'Not January'
239  ],
240  [ 'expected not-registered MediaWiki: page not being created if empty',
241  'MediaWiki:EditPageTest_testCreatePage',
242  'UTSysop',
243  '',
245  null
246  ],
247  [ 'expected registered MediaWiki: page being created even if empty',
248  'MediaWiki:January',
249  'UTSysop',
250  '',
252  ''
253  ],
254  [ 'expected registered MediaWiki: page whose default content is empty'
255  . ' not being created if empty',
256  'MediaWiki:Ipb-default-expiry',
257  'UTSysop',
258  '',
260  ''
261  ],
262  [ 'expected MediaWiki: page not being created if text equals default message',
263  'MediaWiki:January',
264  'UTSysop',
265  'January',
267  null
268  ],
269  [ 'expected empty article being created',
270  'EditPageTest_testCreatePage',
271  null,
272  '',
274  '',
275  true
276  ],
277  ];
278  }
279 
284  public function testCreatePage(
285  $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
286  ) {
287  $checkId = null;
288 
289  $this->setMwGlobals( 'wgHooks', [
290  'PageContentInsertComplete' => [ function (
291  WikiPage &$page, User &$user, Content $content,
292  $summary, $minor, $u1, $u2, &$flags, Revision $revision
293  ) {
294  // types/refs checked
295  } ],
296  'PageContentSaveComplete' => [ function (
297  WikiPage &$page, User &$user, Content $content,
298  $summary, $minor, $u1, $u2, &$flags, Revision $revision,
299  Status &$status, $baseRevId
300  ) use ( &$checkId ) {
301  $checkId = $status->value['revision']->getId();
302  // types/refs checked
303  } ],
304  ] );
305 
306  $edit = [ 'wpTextbox1' => $editText ];
307  if ( $ignoreBlank ) {
308  $edit['wpIgnoreBlankArticle'] = 1;
309  }
310 
311  $page = $this->assertEdit( $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
312 
313  if ( $expectedCode != EditPage::AS_BLANK_ARTICLE ) {
314  $latest = $page->getLatest();
315  $page->doDeleteArticleReal( $pageTitle );
316 
317  $this->assertGreaterThan( 0, $latest, "Page revision ID updated in object" );
318  $this->assertEquals( $latest, $checkId, "Revision in Status for hook" );
319  }
320  }
321 
326  public function testCreatePageTrx(
327  $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
328  ) {
329  $checkIds = [];
330  $this->setMwGlobals( 'wgHooks', [
331  'PageContentInsertComplete' => [ function (
332  WikiPage &$page, User &$user, Content $content,
333  $summary, $minor, $u1, $u2, &$flags, Revision $revision
334  ) {
335  // types/refs checked
336  } ],
337  'PageContentSaveComplete' => [ function (
338  WikiPage &$page, User &$user, Content $content,
339  $summary, $minor, $u1, $u2, &$flags, Revision $revision,
340  Status &$status, $baseRevId
341  ) use ( &$checkIds ) {
342  $checkIds[] = $status->value['revision']->getId();
343  // types/refs checked
344  } ],
345  ] );
346 
347  wfGetDB( DB_MASTER )->begin( __METHOD__ );
348 
349  $edit = [ 'wpTextbox1' => $editText ];
350  if ( $ignoreBlank ) {
351  $edit['wpIgnoreBlankArticle'] = 1;
352  }
353 
354  $page = $this->assertEdit(
355  $pageTitle, null, $user, $edit, $expectedCode, $expectedText, $desc );
356 
357  $pageTitle2 = (string)$pageTitle . '/x';
358  $page2 = $this->assertEdit(
359  $pageTitle2, null, $user, $edit, $expectedCode, $expectedText, $desc );
360 
361  wfGetDB( DB_MASTER )->commit( __METHOD__ );
362 
363  $this->assertEquals( 0, DeferredUpdates::pendingUpdatesCount(), 'No deferred updates' );
364 
365  if ( $expectedCode != EditPage::AS_BLANK_ARTICLE ) {
366  $latest = $page->getLatest();
367  $page->doDeleteArticleReal( $pageTitle );
368 
369  $this->assertGreaterThan( 0, $latest, "Page #1 revision ID updated in object" );
370  $this->assertEquals( $latest, $checkIds[0], "Revision #1 in Status for hook" );
371 
372  $latest2 = $page2->getLatest();
373  $page2->doDeleteArticleReal( $pageTitle2 );
374 
375  $this->assertGreaterThan( 0, $latest2, "Page #2 revision ID updated in object" );
376  $this->assertEquals( $latest2, $checkIds[1], "Revision #2 in Status for hook" );
377  }
378  }
379 
380  public function testUpdatePage() {
381  $checkIds = [];
382 
383  $this->setMwGlobals( 'wgHooks', [
384  'PageContentInsertComplete' => [ function (
385  WikiPage &$page, User &$user, Content $content,
386  $summary, $minor, $u1, $u2, &$flags, Revision $revision
387  ) {
388  // types/refs checked
389  } ],
390  'PageContentSaveComplete' => [ function (
391  WikiPage &$page, User &$user, Content $content,
392  $summary, $minor, $u1, $u2, &$flags, Revision $revision,
393  Status &$status, $baseRevId
394  ) use ( &$checkIds ) {
395  $checkIds[] = $status->value['revision']->getId();
396  // types/refs checked
397  } ],
398  ] );
399 
400  $text = "one";
401  $edit = [
402  'wpTextbox1' => $text,
403  'wpSummary' => 'first update',
404  ];
405 
406  $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
408  "expected successfull update with given text" );
409  $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
410 
411  $this->forceRevisionDate( $page, '20120101000000' );
412 
413  $text = "two";
414  $edit = [
415  'wpTextbox1' => $text,
416  'wpSummary' => 'second update',
417  ];
418 
419  $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
421  "expected successfull update with given text" );
422  $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
423  $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
424  }
425 
426  public function testUpdatePageTrx() {
427  $text = "one";
428  $edit = [
429  'wpTextbox1' => $text,
430  'wpSummary' => 'first update',
431  ];
432 
433  $page = $this->assertEdit( 'EditPageTest_testTrxUpdatePage', "zero", null, $edit,
435  "expected successfull update with given text" );
436 
437  $this->forceRevisionDate( $page, '20120101000000' );
438 
439  $checkIds = [];
440  $this->setMwGlobals( 'wgHooks', [
441  'PageContentSaveComplete' => [ function (
442  WikiPage &$page, User &$user, Content $content,
443  $summary, $minor, $u1, $u2, &$flags, Revision $revision,
444  Status &$status, $baseRevId
445  ) use ( &$checkIds ) {
446  $checkIds[] = $status->value['revision']->getId();
447  // types/refs checked
448  } ],
449  ] );
450 
451  wfGetDB( DB_MASTER )->begin( __METHOD__ );
452 
453  $text = "two";
454  $edit = [
455  'wpTextbox1' => $text,
456  'wpSummary' => 'second update',
457  ];
458 
459  $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
461  "expected successfull update with given text" );
462 
463  $text = "three";
464  $edit = [
465  'wpTextbox1' => $text,
466  'wpSummary' => 'third update',
467  ];
468 
469  $this->assertEdit( 'EditPageTest_testTrxUpdatePage', null, null, $edit,
471  "expected successfull update with given text" );
472 
473  wfGetDB( DB_MASTER )->commit( __METHOD__ );
474 
475  $this->assertGreaterThan( 0, $checkIds[0], "First event rev ID set" );
476  $this->assertGreaterThan( 0, $checkIds[1], "Second edit hook rev ID set" );
477  $this->assertGreaterThan( $checkIds[0], $checkIds[1], "Second event rev ID is higher" );
478  }
479 
480  public static function provideSectionEdit() {
481  $text = 'Intro
482 
483 == one ==
484 first section.
485 
486 == two ==
487 second section.
488 ';
489 
490  $sectionOne = '== one ==
491 hello
492 ';
493 
494  $newSection = '== new section ==
495 
496 hello
497 ';
498 
499  $textWithNewSectionOne = preg_replace(
500  '/== one ==.*== two ==/ms',
501  "$sectionOne\n== two ==", $text
502  );
503 
504  $textWithNewSectionAdded = "$text\n$newSection";
505 
506  return [
507  [ # 0
508  $text,
509  '',
510  'hello',
511  'replace all',
512  'hello'
513  ],
514 
515  [ # 1
516  $text,
517  '1',
518  $sectionOne,
519  'replace first section',
520  $textWithNewSectionOne,
521  ],
522 
523  [ # 2
524  $text,
525  'new',
526  'hello',
527  'new section',
528  $textWithNewSectionAdded,
529  ],
530  ];
531  }
532 
537  public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
538  $edit = [
539  'wpTextbox1' => $text,
540  'wpSummary' => $summary,
541  'wpSection' => $section,
542  ];
543 
544  $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
545  EditPage::AS_SUCCESS_UPDATE, $expected,
546  "expected successfull update of section" );
547  }
548 
549  public static function provideAutoMerge() {
550  $tests = [];
551 
552  $tests[] = [ # 0: plain conflict
553  "Elmo", # base edit user
554  "one\n\ntwo\n\nthree\n",
555  [ # adam's edit
556  'wpStarttime' => 1,
557  'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
558  ],
559  [ # berta's edit
560  'wpStarttime' => 2,
561  'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
562  ],
564  "ONE\n\ntwo\n\nthree\n", # expected text
565  'expected edit conflict', # message
566  ];
567 
568  $tests[] = [ # 1: successful merge
569  "Elmo", # base edit user
570  "one\n\ntwo\n\nthree\n",
571  [ # adam's edit
572  'wpStarttime' => 1,
573  'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
574  ],
575  [ # berta's edit
576  'wpStarttime' => 2,
577  'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
578  ],
580  "ONE\n\ntwo\n\nTHREE\n", # expected text
581  'expected automatic merge', # message
582  ];
583 
584  $text = "Intro\n\n";
585  $text .= "== first section ==\n\n";
586  $text .= "one\n\ntwo\n\nthree\n\n";
587  $text .= "== second section ==\n\n";
588  $text .= "four\n\nfive\n\nsix\n\n";
589 
590  // extract the first section.
591  $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );
592 
593  // generate expected text after merge
594  $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );
595 
596  $tests[] = [ # 2: merge in section
597  "Elmo", # base edit user
598  $text,
599  [ # adam's edit
600  'wpStarttime' => 1,
601  'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
602  'wpSection' => '1'
603  ],
604  [ # berta's edit
605  'wpStarttime' => 2,
606  'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
607  'wpSection' => '1'
608  ],
610  $expected, # expected text
611  'expected automatic section merge', # message
612  ];
613 
614  // see whether it makes a difference who did the base edit
615  $testsWithAdam = array_map( function ( $test ) {
616  $test[0] = 'Adam'; // change base edit user
617  return $test;
618  }, $tests );
619 
620  $testsWithBerta = array_map( function ( $test ) {
621  $test[0] = 'Berta'; // change base edit user
622  return $test;
623  }, $tests );
624 
625  return array_merge( $tests, $testsWithAdam, $testsWithBerta );
626  }
627 
632  public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
633  $expectedCode, $expectedText, $message = null
634  ) {
635  $this->markTestSkippedIfNoDiff3();
636 
637  // create page
638  $ns = $this->getDefaultWikitextNS();
639  $title = Title::newFromText( 'EditPageTest_testAutoMerge', $ns );
640  $page = WikiPage::factory( $title );
641 
642  if ( $page->exists() ) {
643  $page->doDeleteArticle( "clean slate for testing" );
644  }
645 
646  $baseEdit = [
647  'wpTextbox1' => $text,
648  ];
649 
650  $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
651  $baseUser, $baseEdit, null, null, __METHOD__ );
652 
653  $this->forceRevisionDate( $page, '20120101000000' );
654 
655  $edittime = $page->getTimestamp();
656 
657  // start timestamps for conflict detection
658  if ( !isset( $adamsEdit['wpStarttime'] ) ) {
659  $adamsEdit['wpStarttime'] = 1;
660  }
661 
662  if ( !isset( $bertasEdit['wpStarttime'] ) ) {
663  $bertasEdit['wpStarttime'] = 2;
664  }
665 
667  $adamsTime = wfTimestamp(
668  TS_MW,
669  (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$adamsEdit['wpStarttime']
670  );
671  $bertasTime = wfTimestamp(
672  TS_MW,
673  (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$bertasEdit['wpStarttime']
674  );
675 
676  $adamsEdit['wpStarttime'] = $adamsTime;
677  $bertasEdit['wpStarttime'] = $bertasTime;
678 
679  $adamsEdit['wpSummary'] = 'Adam\'s edit';
680  $bertasEdit['wpSummary'] = 'Bertas\'s edit';
681 
682  $adamsEdit['wpEdittime'] = $edittime;
683  $bertasEdit['wpEdittime'] = $edittime;
684 
685  // first edit
686  $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
687  EditPage::AS_SUCCESS_UPDATE, null, "expected successfull update" );
688 
689  // second edit
690  $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
691  $expectedCode, $expectedText, $message );
692  }
693 
698  $title = Title::newFromText( 'Dummy:NonTextPageForEditPage' );
699  $page = WikiPage::factory( $title );
700 
701  $article = new Article( $title );
702  $article->getContext()->setTitle( $title );
703  $ep = new EditPage( $article );
704  $ep->setContextTitle( $title );
705 
706  $user = $GLOBALS['wgUser'];
707 
708  $edit = [
709  'wpTextbox1' => serialize( 'non-text content' ),
710  'wpEditToken' => $user->getEditToken(),
711  'wpEdittime' => '',
712  'wpStarttime' => wfTimestampNow(),
713  'wpUnicodeCheck' => EditPage::UNICODE_CHECK,
714  ];
715 
716  $req = new FauxRequest( $edit, true );
717  $ep->importFormData( $req );
718 
719  $this->setExpectedException(
721  'This content model is not supported: testing'
722  );
723 
724  $ep->internalAttemptSave( $result, false );
725  }
726 
727 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
EditPageTest\testCreatePageTrx
testCreatePageTrx( $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank=false)
provideCreatePages EditPage
Definition: EditPageTest.php:326
code
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of or an object and a method hook function The function part of a third party developers and administrators to define code that will be run at certain points in the mainline code
Definition: hooks.txt:28
FauxRequest
WebRequest clone which takes values from a provided array.
Definition: FauxRequest.php:33
$wgNamespaceContentModels
$wgNamespaceContentModels
Associative array mapping namespace IDs to the name of the content model pages in that namespace shou...
Definition: DefaultSettings.php:8554
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
EditPage\AS_BLANK_ARTICLE
const AS_BLANK_ARTICLE
Status: user tried to create a blank page and wpIgnoreBlankArticle == false.
Definition: EditPage.php:115
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
plain
either a plain
Definition: hooks.txt:2056
EditPageTest\provideAutoMerge
static provideAutoMerge()
Definition: EditPageTest.php:549
EditPageTest\testExtractSectionTitle
testExtractSectionTitle( $section, $title)
provideExtractSectionTitle EditPage::extractSectionTitle
Definition: EditPageTest.php:48
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
string
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:181
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1980
WikiPage
Class representing a MediaWiki article and history.
Definition: WikiPage.php:37
EditPageTest\provideExtractSectionTitle
static provideExtractSectionTitle()
Definition: EditPageTest.php:53
serialize
serialize()
Definition: ApiMessage.php:184
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
message
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a message
Definition: hooks.txt:2163
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
$base
$base
Definition: generateLocalAutoload.php:11
cache
you have access to all of the normal MediaWiki so you can get a DB use the cache
Definition: maintenance.txt:55
true
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 true
Definition: hooks.txt:2006
php
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:37
WikiPage\doDeleteArticleReal
doDeleteArticleReal( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $deleter=null, $tags=[], $logsubtype='delete')
Back-end article deletion Deletes the article with database consistency, writes logs,...
Definition: WikiPage.php:2786
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
EditPageTest\testCreatePage
testCreatePage( $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank=false)
provideCreatePages EditPage
Definition: EditPageTest.php:284
Revision
Definition: Revision.php:41
MWNamespace\clearCaches
static clearCaches()
Clear internal caches.
Definition: MWNamespace.php:76
EditPage\AS_SUCCESS_NEW_ARTICLE
const AS_SUCCESS_NEW_ARTICLE
Status: Article successfully created.
Definition: EditPage.php:58
EditPage\UNICODE_CHECK
const UNICODE_CHECK
Used for Unicode support checks.
Definition: EditPage.php:48
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
$starttime
$starttime
Definition: api.php:40
user
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
Definition: distributors.txt:25
$wgContentHandlers
$wgContentHandlers
Plugins for page content model handling.
Definition: DefaultSettings.php:1010
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
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:678
EditPageTest\provideSectionEdit
static provideSectionEdit()
Definition: EditPageTest.php:480
EditPageTest\assertEdit
assertEdit( $title, $baseText, $user=null, array $edit, $expectedCode=null, $expectedText=null, $message=null)
Performs an edit and checks the result.
Definition: EditPageTest.php:125
EditPageTest\forceRevisionDate
forceRevisionDate(WikiPage $page, $timestamp)
Definition: EditPageTest.php:78
EditPageTest\testCheckDirectEditingDisallowed_forNonTextContent
testCheckDirectEditingDisallowed_forNonTextContent()
@depends testAutoMerge
Definition: EditPageTest.php:697
function
when a variable name is used in a function
Definition: design.txt:93
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
MediaWikiTestCase\getDefaultWikitextNS
getDefaultWikitextNS()
Returns the ID of a namespace that defaults to Wikitext.
Definition: MediaWikiTestCase.php:1912
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
wfTimestampNow
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
Definition: GlobalFunctions.php:2009
WikiPage\getLatest
getLatest()
Get the page_latest field.
Definition: WikiPage.php:624
DB_MASTER
const DB_MASTER
Definition: defines.php:26
merge
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to merge
Definition: LICENSE.txt:11
ContentHandler\makeContent
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
Definition: ContentHandler.php:129
EditPageTest\tearDown
tearDown()
Definition: EditPageTest.php:36
MediaWikiTestCase\markTestSkippedIfNoDiff3
markTestSkippedIfNoDiff3()
Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped,...
Definition: MediaWikiTestCase.php:1967
EditPageTest\testUpdatePageTrx
testUpdatePageTrx()
Definition: EditPageTest.php:426
EditPage\AS_SUCCESS_UPDATE
const AS_SUCCESS_UPDATE
Status: Article successfully updated.
Definition: EditPage.php:53
EditPageTest\testAutoMerge
testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit, $expectedCode, $expectedText, $message=null)
provideAutoMerge EditPage
Definition: EditPageTest.php:632
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
$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. '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:1255
EditPage\extractSectionTitle
static extractSectionTitle( $text)
Extract the section title from current section text, if any.
Definition: EditPage.php:2969
EditPage
The edit page/HTML interface (split from Article) The actual database and text munging is still in Ar...
Definition: EditPage.php:44
Content
Base interface for content objects.
Definition: Content.php:34
$req
this hook is for auditing only $req
Definition: hooks.txt:990
EditPageTest\provideCreatePages
static provideCreatePages()
Definition: EditPageTest.php:217
DeferredUpdates\pendingUpdatesCount
static pendingUpdatesCount()
Definition: DeferredUpdates.php:330
ContentHandler\getContentText
static getContentText(Content $content=null)
Convenience function for getting flat text from a Content object.
Definition: ContentHandler.php:79
EditPageTest
Editing.
Definition: EditPageTest.php:12
$section
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template $section
Definition: hooks.txt:3022
EditPageTest\testUpdatePage
testUpdatePage()
Definition: EditPageTest.php:380
EditPage\AS_CONFLICT_DETECTED
const AS_CONFLICT_DETECTED
Status: (non-resolvable) edit conflict.
Definition: EditPage.php:120
in
null for the wiki Added in
Definition: hooks.txt:1591
class
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:56
Article
Class for viewing MediaWiki article and history.
Definition: Article.php:35
EditPageTest\assertEditedTextEquals
assertEditedTextEquals( $expected, $actual, $msg='')
User input text is passed to rtrim() by edit page.
Definition: EditPageTest.php:96
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$wgExtraNamespaces
$wgExtraNamespaces
Additional namespaces.
Definition: DefaultSettings.php:3888
$article
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function array $article
Definition: hooks.txt:77
EditPageTest\setUp
setUp()
Definition: EditPageTest.php:14
$GLOBALS
$GLOBALS['IP']
Definition: ComposerHookHandler.php:6
WikiPage\clear
clear()
Clear the object.
Definition: WikiPage.php:244
EditPageTest\testSectionEdit
testSectionEdit( $base, $section, $text, $summary, $expected)
provideSectionEdit EditPage
Definition: EditPageTest.php:537
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57