MediaWiki  REL1_31
WikitextStructureTest.php
Go to the documentation of this file.
1 <?php
2 
7 
8  private function getMockTitle() {
9  return Title::newFromText( "TestTitle" );
10  }
11 
17  private function getParserOutput( $text ) {
18  $content = new WikitextContent( $text );
19  return $content->getParserOutput( $this->getMockTitle() );
20  }
21 
27  private function getStructure( $text ) {
28  return new WikiTextStructure( $this->getParserOutput( $text ) );
29  }
30 
31  public function testHeadings() {
32  $text = <<<END
33 Some text here
34 == Heading one ==
35 Some text
36 ==== heading two ====
37 More text
38 === Applicability of the strict mass-energy equivalence formula, ''E'' = ''mc''<sup>2</sup> ===
39 and more text
40 == Wikitext '''in''' [[Heading]] and also <b>html</b> ==
41 more text
42 ==== See also ====
43 * Also things to see!
44 END;
45  $struct = $this->getStructure( $text );
46  $headings = $struct->headings();
47  $this->assertCount( 4, $headings );
48  $this->assertContains( "Heading one", $headings );
49  $this->assertContains( "heading two", $headings );
50  $this->assertContains( "Applicability of the strict mass-energy equivalence formula, E = mc2",
51  $headings );
52  $this->assertContains( "Wikitext in Heading and also html", $headings );
53  }
54 
55  public function testDefaultSort() {
56  $text = <<<END
57 Louise Michel
58 == Heading one ==
59 Some text
60 ==== See also ====
61 * Also things to see!
62 {{DEFAULTSORT:Michel, Louise}}
63 END;
64  $struct = $this->getStructure( $text );
65  $this->assertEquals( "Michel, Louise", $struct->getDefaultSort() );
66  }
67 
68  public function testHeadingsFirst() {
69  $text = <<<END
70 == Heading one ==
71 Some text
72 ==== heading two ====
73 END;
74  $struct = $this->getStructure( $text );
75  $headings = $struct->headings();
76  $this->assertCount( 2, $headings );
77  $this->assertContains( "Heading one", $headings );
78  $this->assertContains( "heading two", $headings );
79  }
80 
81  public function testHeadingsNone() {
82  $text = "This text is completely devoid of headings.";
83  $struct = $this->getStructure( $text );
84  $headings = $struct->headings();
85  $this->assertArrayEquals( [], $headings );
86  }
87 
88  public function testTexts() {
89  $text = <<<END
90 Opening text is opening.
91 == Then comes header ==
92 Then we got more<br>text
93 === And more headers ===
94 {| class="wikitable"
95 |-
96 ! Header table
97 |-
98 | row in table
99 |-
100 | another row in table
101 |}
102 END;
103  $struct = $this->getStructure( $text );
104  $this->assertEquals( "Opening text is opening.", $struct->getOpeningText() );
105  $this->assertEquals( "Opening text is opening. Then we got more text",
106  $struct->getMainText() );
107  $this->assertEquals( [ "Header table row in table another row in table" ],
108  $struct->getAuxiliaryText() );
109  }
110 }
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
MediaWikiTestCase\assertArrayEquals
assertArrayEquals(array $expected, array $actual, $ordered=false, $named=false)
Assert that two arrays are equal.
Definition: MediaWikiTestCase.php:1771
WikitextStructureTest\testHeadingsNone
testHeadingsNone()
Definition: WikitextStructureTest.php:81
WikitextStructureTest\getParserOutput
getParserOutput( $text)
Get parser output for Wiki text.
Definition: WikitextStructureTest.php:17
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
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
WikitextStructureTest\getMockTitle
getMockTitle()
Definition: WikitextStructureTest.php:8
WikitextStructureTest\getStructure
getStructure( $text)
Get WikitextStructure for given text.
Definition: WikitextStructureTest.php:27
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
table
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global then executing the whole list after the page is displayed We don t do anything smart like collating updates to the same table or such because the list is almost always going to have just one item on if so it s not worth the trouble Since there is a job queue in the jobs table
Definition: deferred.txt:16
WikitextContent
Content object for wiki text pages.
Definition: WikitextContent.php:33
WikitextStructureTest\testDefaultSort
testDefaultSort()
Definition: WikitextStructureTest.php:55
WikitextStructureTest\testHeadingsFirst
testHeadingsFirst()
Definition: WikitextStructureTest.php:68
see
Some information about database access in MediaWiki By Tim January Database layout For information about the MediaWiki database such as a description of the tables and their please see
Definition: database.txt:18
MediaWikiLangTestCase
Base class that store and restore the Language objects.
Definition: MediaWikiLangTestCase.php:6
and
and(b) You must cause any modified files to carry prominent notices stating that You changed the files
WikitextStructureTest\testTexts
testTexts()
Definition: WikitextStructureTest.php:88
things
magicword txt Magic Words are some phrases used in the wikitext They are used for two things
Definition: magicword.txt:4
in
null for the wiki Added in
Definition: hooks.txt:1591
of
globals txt Globals are evil The original MediaWiki code relied on globals for processing context far too often MediaWiki development since then has been a story of slowly moving context out of global variables and into objects Storing processing context in object member variables allows those objects to be reused in a much more flexible way Consider the elegance of
database rows
Definition: globals.txt:10
WikiTextStructure
Class allowing to explore structure of parsed wikitext.
Definition: WikiTextStructure.php:8
WikitextStructureTest
WikiTextStructure.
Definition: WikitextStructureTest.php:6
headers
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 headers
Definition: design.txt:18
WikitextStructureTest\testHeadings
testHeadings()
Definition: WikitextStructureTest.php:31