MediaWiki  REL1_31
WikitextContentTest.php
Go to the documentation of this file.
1 <?php
2 
10  public static $sections = "Intro
11 
12 == stuff ==
13 hello world
14 
15 == test ==
16 just a test
17 
18 == foo ==
19 more stuff
20 ";
21 
22  public function newContent( $text ) {
23  return new WikitextContent( $text );
24  }
25 
26  public static function dataGetParserOutput() {
27  return [
28  [
29  "WikitextContentTest_testGetParserOutput",
31  "hello ''world''\n",
32  "<div class=\"mw-parser-output\"><p>hello <i>world</i>\n</p>\n\n\n</div>"
33  ],
34  // TODO: more...?
35  ];
36  }
37 
38  public static function dataGetSecondaryDataUpdates() {
39  return [
40  [ "WikitextContentTest_testGetSecondaryDataUpdates_1",
41  CONTENT_MODEL_WIKITEXT, "hello ''world''\n",
42  [
44  'mRecursive' => true,
45  'mLinks' => []
46  ]
47  ]
48  ],
49  [ "WikitextContentTest_testGetSecondaryDataUpdates_2",
50  CONTENT_MODEL_WIKITEXT, "hello [[world test 21344]]\n",
51  [
53  'mRecursive' => true,
54  'mLinks' => [
55  [ 'World_test_21344' => 0 ]
56  ]
57  ]
58  ]
59  ],
60  // TODO: more...?
61  ];
62  }
63 
69  public function testGetSecondaryDataUpdates( $title, $model, $text, $expectedStuff ) {
70  $ns = $this->getDefaultWikitextNS();
72 
73  $content = ContentHandler::makeContent( $text, $title, $model );
74 
75  $page = WikiPage::factory( $title );
76  $page->doEditContent( $content, '' );
77 
78  $updates = $content->getSecondaryDataUpdates( $title );
79 
80  // make updates accessible by class name
81  foreach ( $updates as $update ) {
82  $class = get_class( $update );
83  $updates[$class] = $update;
84  }
85 
86  foreach ( $expectedStuff as $class => $fieldValues ) {
87  $this->assertArrayHasKey( $class, $updates, "missing an update of type $class" );
88 
89  $update = $updates[$class];
90 
91  foreach ( $fieldValues as $field => $value ) {
92  $v = $update->$field; # if the field doesn't exist, just crash and burn
93  $this->assertEquals(
94  $value,
95  $v,
96  "unexpected value for field $field in instance of $class"
97  );
98  }
99  }
100 
101  $page->doDeleteArticle( '' );
102  }
103 
104  public static function dataGetSection() {
105  return [
106  [ self::$sections,
107  "0",
108  "Intro"
109  ],
110  [ self::$sections,
111  "2",
112  "== test ==
113 just a test"
114  ],
115  [ self::$sections,
116  "8",
117  false
118  ],
119  ];
120  }
121 
126  public function testGetSection( $text, $sectionId, $expectedText ) {
127  $content = $this->newContent( $text );
128 
129  $sectionContent = $content->getSection( $sectionId );
130  if ( is_object( $sectionContent ) ) {
131  $sectionText = $sectionContent->getNativeData();
132  } else {
133  $sectionText = $sectionContent;
134  }
135 
136  $this->assertEquals( $expectedText, $sectionText );
137  }
138 
139  public static function dataReplaceSection() {
140  return [
141  [ self::$sections,
142  "0",
143  "No more",
144  null,
145  trim( preg_replace( '/^Intro/sm', 'No more', self::$sections ) )
146  ],
147  [ self::$sections,
148  "",
149  "No more",
150  null,
151  "No more"
152  ],
153  [ self::$sections,
154  "2",
155  "== TEST ==\nmore fun",
156  null,
157  trim( preg_replace(
158  '/^== test ==.*== foo ==/sm', "== TEST ==\nmore fun\n\n== foo ==",
159  self::$sections
160  ) )
161  ],
162  [ self::$sections,
163  "8",
164  "No more",
165  null,
166  self::$sections
167  ],
168  [ self::$sections,
169  "new",
170  "No more",
171  "New",
172  trim( self::$sections ) . "\n\n\n== New ==\n\nNo more"
173  ],
174  ];
175  }
176 
181  public function testReplaceSection( $text, $section, $with, $sectionTitle, $expected ) {
182  $content = $this->newContent( $text );
183  $c = $content->replaceSection( $section, $this->newContent( $with ), $sectionTitle );
184 
185  $this->assertEquals( $expected, is_null( $c ) ? null : $c->getNativeData() );
186  }
187 
191  public function testAddSectionHeader() {
192  $content = $this->newContent( 'hello world' );
193  $content = $content->addSectionHeader( 'test' );
194 
195  $this->assertEquals( "== test ==\n\nhello world", $content->getNativeData() );
196  }
197 
198  public static function dataPreSaveTransform() {
199  return [
200  [ 'hello this is ~~~',
201  "hello this is [[Special:Contributions/127.0.0.1|127.0.0.1]]",
202  ],
203  [ 'hello \'\'this\'\' is <nowiki>~~~</nowiki>',
204  'hello \'\'this\'\' is <nowiki>~~~</nowiki>',
205  ],
206  [ // rtrim
207  " Foo \n ",
208  " Foo",
209  ],
210  ];
211  }
212 
213  public static function dataPreloadTransform() {
214  return [
215  [
216  'hello this is ~~~',
217  "hello this is ~~~",
218  ],
219  [
220  'hello \'\'this\'\' is <noinclude>foo</noinclude><includeonly>bar</includeonly>',
221  'hello \'\'this\'\' is bar',
222  ],
223  ];
224  }
225 
226  public static function dataGetRedirectTarget() {
227  return [
228  [ '#REDIRECT [[Test]]',
229  'Test',
230  ],
231  [ '#REDIRECT Test',
232  null,
233  ],
234  [ '* #REDIRECT [[Test]]',
235  null,
236  ],
237  ];
238  }
239 
240  public static function dataGetTextForSummary() {
241  return [
242  [ "hello\nworld.",
243  16,
244  'hello world.',
245  ],
246  [ 'hello world.',
247  8,
248  'hello...',
249  ],
250  [ '[[hello world]].',
251  8,
252  'hel...',
253  ],
254  ];
255  }
256 
257  public static function dataIsCountable() {
258  return [
259  [ '',
260  null,
261  'any',
262  true
263  ],
264  [ 'Foo',
265  null,
266  'any',
267  true
268  ],
269  [ 'Foo',
270  null,
271  'link',
272  false
273  ],
274  [ 'Foo [[bar]]',
275  null,
276  'link',
277  true
278  ],
279  [ 'Foo',
280  true,
281  'link',
282  true
283  ],
284  [ 'Foo [[bar]]',
285  false,
286  'link',
287  false
288  ],
289  [ '#REDIRECT [[bar]]',
290  true,
291  'any',
292  false
293  ],
294  [ '#REDIRECT [[bar]]',
295  true,
296  'link',
297  false
298  ],
299  ];
300  }
301 
305  public function testMatchMagicWord() {
306  $mw = MagicWord::get( "staticredirect" );
307 
308  $content = $this->newContent( "#REDIRECT [[FOO]]\n__STATICREDIRECT__" );
309  $this->assertTrue( $content->matchMagicWord( $mw ), "should have matched magic word" );
310 
311  $content = $this->newContent( "#REDIRECT [[FOO]]" );
312  $this->assertFalse(
313  $content->matchMagicWord( $mw ),
314  "should not have matched magic word"
315  );
316  }
317 
321  public function testUpdateRedirect() {
322  $target = Title::newFromText( "testUpdateRedirect_target" );
323 
324  // test with non-redirect page
325  $content = $this->newContent( "hello world." );
326  $newContent = $content->updateRedirect( $target );
327 
328  $this->assertTrue( $content->equals( $newContent ), "content should be unchanged" );
329 
330  // test with actual redirect
331  $content = $this->newContent( "#REDIRECT [[Someplace]]" );
332  $newContent = $content->updateRedirect( $target );
333 
334  $this->assertFalse( $content->equals( $newContent ), "content should have changed" );
335  $this->assertTrue( $newContent->isRedirect(), "new content should be a redirect" );
336 
337  $this->assertEquals(
338  $target->getFullText(),
339  $newContent->getRedirectTarget()->getFullText()
340  );
341  }
342 
346  public function testGetModel() {
347  $content = $this->newContent( "hello world." );
348 
349  $this->assertEquals( CONTENT_MODEL_WIKITEXT, $content->getModel() );
350  }
351 
355  public function testGetContentHandler() {
356  $content = $this->newContent( "hello world." );
357 
358  $this->assertEquals( CONTENT_MODEL_WIKITEXT, $content->getContentHandler()->getModelID() );
359  }
360 
361  public function testRedirectParserOption() {
362  $title = Title::newFromText( 'testRedirectParserOption' );
363 
364  // Set up hook and its reporting variables
365  $wikitext = null;
366  $redirectTarget = null;
367  $this->mergeMwGlobalArrayValue( 'wgHooks', [
368  'InternalParseBeforeLinks' => [
369  function ( &$parser, &$text, &$stripState ) use ( &$wikitext, &$redirectTarget ) {
370  $wikitext = $text;
371  $redirectTarget = $parser->getOptions()->getRedirectTarget();
372  }
373  ]
374  ] );
375 
376  // Test with non-redirect page
377  $wikitext = false;
378  $redirectTarget = false;
379  $content = $this->newContent( 'hello world.' );
380  $options = $content->getContentHandler()->makeParserOptions( 'canonical' );
381  $options->setRedirectTarget( $title );
382  $content->getParserOutput( $title, null, $options );
383  $this->assertEquals( 'hello world.', $wikitext,
384  'Wikitext passed to hook was not as expected'
385  );
386  $this->assertEquals( null, $redirectTarget, 'Redirect seen in hook was not null' );
387  $this->assertEquals( $title, $options->getRedirectTarget(),
388  'ParserOptions\' redirectTarget was changed'
389  );
390 
391  // Test with a redirect page
392  $wikitext = false;
393  $redirectTarget = false;
394  $content = $this->newContent(
395  "#REDIRECT [[TestRedirectParserOption/redir]]\nhello redirect."
396  );
397  $options = $content->getContentHandler()->makeParserOptions( 'canonical' );
398  $content->getParserOutput( $title, null, $options );
399  $this->assertEquals(
400  'hello redirect.',
401  $wikitext,
402  'Wikitext passed to hook was not as expected'
403  );
404  $this->assertNotEquals(
405  null,
406  $redirectTarget,
407  'Redirect seen in hook was null' );
408  $this->assertEquals(
409  'TestRedirectParserOption/redir',
410  $redirectTarget->getFullText(),
411  'Redirect seen in hook was not the expected title'
412  );
413  $this->assertEquals(
414  null,
415  $options->getRedirectTarget(),
416  'ParserOptions\' redirectTarget was changed'
417  );
418  }
419 
420  public static function dataEquals() {
421  return [
422  [ new WikitextContent( "hallo" ), null, false ],
423  [ new WikitextContent( "hallo" ), new WikitextContent( "hallo" ), true ],
424  [ new WikitextContent( "hallo" ), new JavaScriptContent( "hallo" ), false ],
425  [ new WikitextContent( "hallo" ), new TextContent( "hallo" ), false ],
426  [ new WikitextContent( "hallo" ), new WikitextContent( "HALLO" ), false ],
427  ];
428  }
429 
430  public static function dataGetDeletionUpdates() {
431  return [
432  [ "WikitextContentTest_testGetSecondaryDataUpdates_1",
433  CONTENT_MODEL_WIKITEXT, "hello ''world''\n",
435  ],
436  [ "WikitextContentTest_testGetSecondaryDataUpdates_2",
437  CONTENT_MODEL_WIKITEXT, "hello [[world test 21344]]\n",
439  ],
440  // @todo more...?
441  ];
442  }
443 }
WikitextContentTest\testGetSecondaryDataUpdates
testGetSecondaryDataUpdates( $title, $model, $text, $expectedStuff)
dataGetSecondaryDataUpdates Database WikitextContent::getSecondaryDataUpdates
Definition: WikitextContentTest.php:69
ParserOptions
Set options of the Parser.
Definition: ParserOptions.php:40
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
is
We use the convention $dbr for read and $dbw for write to help you keep track of whether the database object is a the world will explode Or to be a subsequent write query which succeeded on the master may fail when replicated to the slave due to a unique key collision Replication on the slave will stop and it may take hours to repair the database and get it back online Setting read_only in my cnf on the slave will avoid this but given the dire we prefer to have as many checks as possible We provide a but the wrapper functions like please read the documentation for except in special pages derived from QueryPage It s a common pitfall for new developers to submit code containing SQL queries which examine huge numbers of rows Remember that COUNT * is(N), counting rows in atable is like counting beans in a bucket.------------------------------------------------------------------------ Replication------------------------------------------------------------------------The largest installation of MediaWiki, Wikimedia, uses a large set ofslave MySQL servers replicating writes made to a master MySQL server. Itis important to understand the issues associated with this setup if youwant to write code destined for Wikipedia.It 's often the case that the best algorithm to use for a given taskdepends on whether or not replication is in use. Due to our unabashedWikipedia-centrism, we often just use the replication-friendly version, but if you like, you can use wfGetLB() ->getServerCount() > 1 tocheck to see if replication is in use.===Lag===Lag primarily occurs when large write queries are sent to the master.Writes on the master are executed in parallel, but they are executed inserial when they are replicated to the slaves. The master writes thequery to the binlog when the transaction is committed. The slaves pollthe binlog and start executing the query as soon as it appears. They canservice reads while they are performing a write query, but will not readanything more from the binlog and thus will perform no more writes. Thismeans that if the write query runs for a long time, the slaves will lagbehind the master for the time it takes for the write query to complete.Lag can be exacerbated by high read load. MediaWiki 's load balancer willstop sending reads to a slave when it is lagged by more than 30 seconds.If the load ratios are set incorrectly, or if there is too much loadgenerally, this may lead to a slave permanently hovering around 30seconds lag.If all slaves are lagged by more than 30 seconds, MediaWiki will stopwriting to the database. All edits and other write operations will berefused, with an error returned to the user. This gives the slaves achance to catch up. Before we had this mechanism, the slaves wouldregularly lag by several minutes, making review of recent editsdifficult.In addition to this, MediaWiki attempts to ensure that the user seesevents occurring on the wiki in chronological order. A few seconds of lagcan be tolerated, as long as the user sees a consistent picture fromsubsequent requests. This is done by saving the master binlog positionin the session, and then at the start of each request, waiting for theslave to catch up to that position before doing any reads from it. Ifthis wait times out, reads are allowed anyway, but the request isconsidered to be in "lagged slave mode". Lagged slave mode can bechecked by calling wfGetLB() ->getLaggedSlaveMode(). The onlypractical consequence at present is a warning displayed in the pagefooter.===Lag avoidance===To avoid excessive lag, queries which write large numbers of rows shouldbe split up, generally to write one row at a time. Multi-row INSERT ...SELECT queries are the worst offenders should be avoided altogether.Instead do the select first and then the insert.===Working with lag===Despite our best efforts, it 's not practical to guarantee a low-lagenvironment. Lag will usually be less than one second, but mayoccasionally be up to 30 seconds. For scalability, it 's very importantto keep load on the master low, so simply sending all your queries tothe master is not the answer. So when you have a genuine need forup-to-date data, the following approach is advised:1) Do a quick query to the master for a sequence number or timestamp 2) Run the full query on the slave and check if it matches the data you gotfrom the master 3) If it doesn 't, run the full query on the masterTo avoid swamping the master every time the slaves lag, use of thisapproach should be kept to a minimum. In most cases you should just readfrom the slave and let the user deal with the delay.------------------------------------------------------------------------ Lock contention------------------------------------------------------------------------Due to the high write rate on Wikipedia(and some other wikis), MediaWiki developers need to be very careful to structure their writesto avoid long-lasting locks. By default, MediaWiki opens a transactionat the first query, and commits it before the output is sent. Locks willbe held from the time when the query is done until the commit. So youcan reduce lock time by doing as much processing as possible before youdo your write queries.Often this approach is not good enough, and it becomes necessary toenclose small groups of queries in their own transaction. Use thefollowing syntax:$dbw=wfGetDB(DB_MASTER
WikitextContentTest\dataGetSecondaryDataUpdates
static dataGetSecondaryDataUpdates()
Definition: WikitextContentTest.php:38
TextContentTest
ContentHandler Database ^— needed, because we do need the database to test link updates.
Definition: TextContentTest.php:8
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:245
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
WikitextContentTest\newContent
newContent( $text)
Definition: WikitextContentTest.php:22
WikitextContentTest\$sections
static $sections
Definition: WikitextContentTest.php:10
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
$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
WikitextContent
Content object for wiki text pages.
Definition: WikitextContent.php:33
WikitextContentTest\dataEquals
static dataEquals()
Definition: WikitextContentTest.php:420
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
JavaScriptContent
Content for JavaScript pages.
Definition: JavaScriptContent.php:33
$options
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 & $options
Definition: hooks.txt:2001
hook
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 hook
Definition: hooks.txt:23
$value
$value
Definition: styleTest.css.php:45
WikitextContentTest\testRedirectParserOption
testRedirectParserOption()
Definition: WikitextContentTest.php:361
WikitextContentTest\dataGetDeletionUpdates
static dataGetDeletionUpdates()
Definition: WikitextContentTest.php:430
TextContent
Content object implementation for representing flat text.
Definition: TextContent.php:35
WikitextContentTest\dataGetParserOutput
static dataGetParserOutput()
Definition: WikitextContentTest.php:26
link
usually copyright or history_copyright This message must be in HTML not wikitext if the section is included from a template to be included in the link
Definition: hooks.txt:3023
as
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 as
Definition: distributors.txt:22
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
seen
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be seen
Definition: globals.txt:31
WikitextContentTest
ContentHandler.
Definition: WikitextContentTest.php:9
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187