MediaWiki REL1_32
EditPageTest.php
Go to the documentation of this file.
1<?php
2
4
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 ] );
30 'wgContentHandlers',
31 [ 'testing' => 'DummyContentHandlerForTesting' ]
32 );
33 }
34
39 public function testExtractSectionTitle( $section, $title ) {
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
87 protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
88 $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
89 }
90
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 ) ) {
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!',
215 'Hello World!'
216 ],
217 [ 'expected article not being created if empty',
218 'EditPageTest_testCreatePage',
219 null,
220 '',
222 null
223 ],
224 [ 'expected MediaWiki: page being created',
225 'MediaWiki:January',
226 'UTSysop',
227 'Not January',
229 'Not January'
230 ],
231 [ 'expected not-registered MediaWiki: page not being created if empty',
232 'MediaWiki:EditPageTest_testCreatePage',
233 'UTSysop',
234 '',
236 null
237 ],
238 [ 'expected registered MediaWiki: page being created even if empty',
239 'MediaWiki:January',
240 'UTSysop',
241 '',
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 '',
251 ''
252 ],
253 [ 'expected MediaWiki: page not being created if text equals default message',
254 'MediaWiki:January',
255 'UTSysop',
256 'January',
258 null
259 ],
260 [ 'expected empty article being created',
261 'EditPageTest_testCreatePage',
262 null,
263 '',
265 '',
266 true
267 ],
268 ];
269 }
270
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 (
283 $summary, $minor, $u1, $u2, &$flags, Revision $revision
284 ) {
285 // types/refs checked
286 } ],
287 'PageContentSaveComplete' => [ function (
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
317 public function testCreatePageTrx(
318 $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank = false
319 ) {
320 $checkIds = [];
321 $this->setMwGlobals( 'wgHooks', [
322 'PageContentInsertComplete' => [ function (
324 $summary, $minor, $u1, $u2, &$flags, Revision $revision
325 ) {
326 // types/refs checked
327 } ],
328 'PageContentSaveComplete' => [ function (
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 (
377 $summary, $minor, $u1, $u2, &$flags, Revision $revision
378 ) {
379 // types/refs checked
380 } ],
381 'PageContentSaveComplete' => [ function (
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,
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,
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,
426 "expected successful update with given text" );
427
428 $this->forceRevisionDate( $page, '20120101000000' );
429
430 $checkIds = [];
431 $this->setMwGlobals( 'wgHooks', [
432 'PageContentSaveComplete' => [ function (
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,
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,
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 ==
475first section.
476
477== two ==
478second section.
479';
480
481 $sectionOne = '== one ==
482hello
483';
484
485 $newSection = '== new section ==
486
487hello
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
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,
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 ],
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 ],
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 ],
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
623 public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
624 $expectedCode, $expectedText, $message = null
625 ) {
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
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
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}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
serialize()
$GLOBALS['IP']
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$starttime
Definition api.php:37
Class for viewing MediaWiki article and history.
Definition Article.php:38
getContext()
Get the base IContextSource object.
testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit, $expectedCode, $expectedText, $message=null)
provideAutoMerge EditPage
assertEdit( $title, $baseText, $user=null, array $edit, $expectedCode=null, $expectedText=null, $message=null)
Performs an edit and checks the result.
testCreatePage( $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank=false)
provideCreatePages EditPage
forceRevisionDate(WikiPage $page, $timestamp)
assertEditedTextEquals( $expected, $actual, $msg='')
User input text is passed to rtrim() by edit page.
testCheckDirectEditingDisallowed_forNonTextContent()
@depends testAutoMerge
static provideCreatePages()
static provideSectionEdit()
static provideAutoMerge()
testSectionEdit( $base, $section, $text, $summary, $expected)
provideSectionEdit EditPage
testCreatePageTrx( $desc, $pageTitle, $user, $editText, $expectedCode, $expectedText, $ignoreBlank=false)
provideCreatePages EditPage
testExtractSectionTitle( $section, $title)
provideExtractSectionTitle EditPage::extractSectionTitle
static provideExtractSectionTitle()
The edit page/HTML interface (split from Article) The actual database and text munging is still in Ar...
Definition EditPage.php:44
const AS_CONFLICT_DETECTED
Status: (non-resolvable) edit conflict.
Definition EditPage.php:120
const AS_BLANK_ARTICLE
Status: user tried to create a blank page and wpIgnoreBlankArticle == false.
Definition EditPage.php:115
static extractSectionTitle( $text)
Extract the section title from current section text, if any.
const AS_SUCCESS_UPDATE
Status: Article successfully updated.
Definition EditPage.php:53
const AS_SUCCESS_NEW_ARTICLE
Status: Article successfully created.
Definition EditPage.php:58
const UNICODE_CHECK
Used for Unicode support checks.
Definition EditPage.php:48
WebRequest clone which takes values from a provided array.
Base class that store and restore the Language objects.
getDefaultWikitextNS()
Returns the ID of a namespace that defaults to Wikitext.
mergeMwGlobalArrayValue( $name, $values)
Merges the given values into a MW global array variable.
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
markTestSkippedIfNoDiff3()
Check, if $wgDiff3 is set and ready to merge Will mark the calling test as skipped,...
MediaWikiServices is the service locator for the application scope of MediaWiki.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:47
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition User.php:592
Class representing a MediaWiki article and history.
Definition WikiPage.php:44
getLatest()
Get the page_latest field.
Definition WikiPage.php:692
doDeleteArticleReal( $reason, $suppress=false, $u1=null, $u2=null, &$error='', User $deleter=null, $tags=[], $logsubtype='delete', $immediate=false)
Back-end article deletion Deletes the article with database consistency, writes logs,...
clear()
Clear the object.
Definition WikiPage.php:284
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.
this hook is for auditing only $req
Definition hooks.txt:1018
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 since 1.16! 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 since 1.28! 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:2042
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
either a plain
Definition hooks.txt:2105
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:1305
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:994
null for the local wiki Added in
Definition hooks.txt:1627
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:2055
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 local administrators to define code that will be run at certain points in the mainline code
Definition hooks.txt:28
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 use $formDescriptor instead 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:2213
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used the name of the old file & $article
Definition hooks.txt:1619
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:3107
processing should stop and the error should be shown to the user * false
Definition hooks.txt:187
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 local account $user
Definition hooks.txt:247
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
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
Base interface for content objects.
Definition Content.php:34
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
$content
const DB_MASTER
Definition defines.php:26