MediaWiki  master
SideBarTest.php
Go to the documentation of this file.
1 <?php
2 
7 
12  private $skin;
14  private $messages;
15 
17  private function initMessagesHref() {
18  # List of default messages for the sidebar. The sidebar doesn't care at
19  # all whether they are full URLs, interwiki links or local titles.
20  $URL_messages = [
21  'mainpage',
22  'portal-url',
23  'currentevents-url',
24  'recentchanges-url',
25  'randompage-url',
26  'helppage',
27  ];
28 
29  # We're assuming that isValidURI works as advertised: it's also
30  # tested separately, in tests/phpunit/includes/HttpTest.php.
31  foreach ( $URL_messages as $m ) {
32  $titleName = MessageCache::singleton()->get( $m );
33  if ( Http::isValidURI( $titleName ) ) {
34  $this->messages[$m]['href'] = $titleName;
35  } else {
36  $title = Title::newFromText( $titleName );
37  $this->messages[$m]['href'] = $title->getLocalURL();
38  }
39  }
40  }
41 
42  protected function setUp() {
43  parent::setUp();
44  $this->initMessagesHref();
45  $this->skin = new SkinTemplate();
46  $this->skin->getContext()->setLanguage( Language::factory( 'en' ) );
47  }
48 
56  private function assertSideBar( $expected, $text, $message = '' ) {
57  $bar = [];
58  $this->skin->addToSidebarPlain( $bar, $text );
59  $this->assertEquals( $expected, $bar, $message );
60  }
61 
65  public function testSidebarWithOnlyTwoTitles() {
66  $this->assertSideBar(
67  [
68  'Title1' => [],
69  'Title2' => [],
70  ],
71  '* Title1
72 * Title2
73 '
74  );
75  }
76 
80  public function testExpandMessages() {
81  $this->assertSideBar(
82  [ 'Title' => [
83  [
84  'text' => 'Help',
85  'href' => $this->messages['helppage']['href'],
86  'id' => 'n-help',
87  'active' => null
88  ]
89  ] ],
90  '* Title
91 ** helppage|help
92 '
93  );
94  }
95 
100  $this->setMwGlobals( [
101  'wgNoFollowLinks' => true,
102  'wgNoFollowDomainExceptions' => [],
103  'wgNoFollowNsExceptions' => [],
104  ] );
105  $this->assertSideBar(
106  [ 'Title' => [
107  # ** http://www.mediawiki.org/| Home
108  [
109  'text' => 'Home',
110  'href' => 'http://www.mediawiki.org/',
111  'id' => 'n-Home',
112  'active' => null,
113  'rel' => 'nofollow',
114  ],
115  # ** http://valid.no.desc.org/
116  # ... skipped since it is missing a pipe with a description
117  ] ],
118  '* Title
119 ** http://www.mediawiki.org/| Home
120 ** http://valid.no.desc.org/
121 '
122  );
123  }
124 
130  public function testTrickyPipe() {
131  $this->assertSideBar(
132  [ 'Title' => [
133  # The first 2 are skipped
134  # Doesn't really test the url properly
135  # because it will vary with $wgArticlePath et al.
136  # ** Baz|Fred
137  [
138  'text' => 'Fred',
139  'href' => Title::newFromText( 'Baz' )->getLocalURL(),
140  'id' => 'n-Fred',
141  'active' => null,
142  ],
143  [
144  'text' => 'title-to-display',
145  'href' => Title::newFromText( 'page-to-go-to' )->getLocalURL(),
146  'id' => 'n-title-to-display',
147  'active' => null,
148  ],
149  ] ],
150  '* Title
151 ** {{PAGENAME|Foo}}
152 ** Bar
153 ** Baz|Fred
154 ** {{PLURAL:1|page-to-go-to{{int:pipe-separator/en}}title-to-display|branch not taken}}
155 '
156  );
157  }
158 
159  #### Attributes for external links ##########################
160  private function getAttribs() {
161  # Sidebar text we will use everytime
162  $text = '* Title
163 ** http://www.mediawiki.org/| Home';
164 
165  $bar = [];
166  $this->skin->addToSidebarPlain( $bar, $text );
167 
168  return $bar['Title'][0];
169  }
170 
175  $this->setMwGlobals( [
176  'wgNoFollowLinks' => true,
177  'wgNoFollowDomainExceptions' => [],
178  'wgNoFollowNsExceptions' => [],
179  'wgExternalLinkTarget' => false,
180  ] );
181  $attribs = $this->getAttribs();
182 
183  $this->assertArrayHasKey( 'rel', $attribs );
184  $this->assertEquals( 'nofollow', $attribs['rel'] );
185 
186  $this->assertArrayNotHasKey( 'target', $attribs );
187  }
188 
192  public function testRespectWgnofollowlinks() {
193  $this->setMwGlobals( 'wgNoFollowLinks', false );
194 
195  $attribs = $this->getAttribs();
196  $this->assertArrayNotHasKey( 'rel', $attribs,
197  'External URL in sidebar do not have rel=nofollow when $wgNoFollowLinks = false'
198  );
199  }
200 
205  public function testRespectExternallinktarget( $externalLinkTarget ) {
206  $this->setMwGlobals( 'wgExternalLinkTarget', $externalLinkTarget );
207 
208  $attribs = $this->getAttribs();
209  $this->assertArrayHasKey( 'target', $attribs );
210  $this->assertEquals( $attribs['target'], $externalLinkTarget );
211  }
212 
213  public static function dataRespectExternallinktarget() {
214  return [
215  [ '_blank' ],
216  [ '_self' ],
217  ];
218  }
219 }
testSidebarWithOnlyTwoTitles()
SkinTemplate::addToSidebarPlain
Definition: SideBarTest.php:65
testTrickyPipe()
T35321 - Make sure there's a | after transforming.
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
SkinTemplate $skin
A skin template, reinitialized before each test.
Definition: SideBarTest.php:12
static newFromText($text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:265
testTestAttributesAssertionHelper()
Simple test to verify our helper assertAttribs() is functional.
title
$messages
Local cache for sidebar messages.
Definition: SideBarTest.php:14
Apache License January http
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
passed in as a query string parameter to the various URLs constructed here(i.e.$prevlink) $ldel you ll need to handle error messages
Definition: hooks.txt:1260
Base class for template-based skins.
getContext()
Get the base IContextSource object.
Base class that store and restore the Language objects.
shown</td >< td > a href
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1957
while(($__line=Maintenance::readconsole())!==false) print n
Definition: eval.php:64
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:935
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:12
addToSidebarPlain(&$bar, $text)
Add content from plain text.
Definition: Skin.php:1283
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:9
testExpandMessages()
SkinTemplate::addToSidebarPlain
Definition: SideBarTest.php:80
Further assume MyExt::onFoo needs service Bar
Definition: injection.txt:214
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
assertSideBar($expected, $text, $message= '')
Internal helper to test the sidebar.
Definition: SideBarTest.php:56
testRespectWgnofollowlinks()
Test $wgNoFollowLinks in sidebar.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed or on behalf the Licensor for the purpose of discussing and improving the but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work Grant of Copyright License Subject to the terms and conditions of this each Contributor hereby grants to You a non no royalty irrevocable copyright license to prepare Derivative Works publicly display
static dataRespectExternallinktarget()
=Architecture==Two class hierarchies are used to provide the functionality associated with the different content models:*Content interface(and AbstractContent base class) define functionality that acts on the concrete content of a page, and *ContentHandler base class provides functionality specific to a content model, but not acting on concrete content.The most important function of ContentHandler is to act as a factory for the appropriate implementation of Content.These Content objects are to be used by MediaWiki everywhere, instead of passing page content around as text.All manipulation and analysis of page content must be done via the appropriate methods of the Content object.For each content model, a subclass of ContentHandler has to be registered with $wgContentHandlers.The ContentHandler object for a given content model can be obtained using ContentHandler::getForModelID($id).Also Title, WikiPage and Revision now have getContentHandler() methods for convenience.ContentHandler objects are singletons that provide functionality specific to the content type, but not directly acting on the content of some page.ContentHandler::makeEmptyContent() and ContentHandler::unserializeContent() can be used to create a Content object of the appropriate type.However, it is recommended to instead use WikiPage::getContent() resp.Revision::getContent() to get a page's content as a Content object.These two methods should be the ONLY way in which page content is accessed.Another important function of ContentHandler objects is to define custom action handlers for a content model, see ContentHandler::getActionOverrides().This is similar to what WikiPage::getActionOverrides() was already doing.==Serialization==With the ContentHandler facility, page content no longer has to be text based.Objects implementing the Content interface are used to represent and handle the content internally.For storage and data exchange, each content model supports at least one serialization format via ContentHandler::serializeContent($content).The list of supported formats for a given content model can be accessed using ContentHandler::getSupportedFormats().Content serialization formats are identified using MIME type like strings.The following formats are built in:*text/x-wiki-wikitext *text/javascript-for js pages *text/css-for css pages *text/plain-for future use, e.g.with plain text messages.*text/html-for future use, e.g.with plain html messages.*application/vnd.php.serialized-for future use with the api and for extensions *application/json-for future use with the api, and for use by extensions *application/xml-for future use with the api, and for use by extensions In PHP, use the corresponding CONTENT_FORMAT_XXX constant.Note that when using the API to access page content, especially action=edit, action=parse and action=query &prop=revisions, the model and format of the content should always be handled explicitly.Without that information, interpretation of the provided content is not reliable.The same applies to XML dumps generated via maintenance/dumpBackup.php or Special:Export.Also note that the API will provide encapsulated, serialized content-so if the API was called with format=json, and contentformat is also json(or rather, application/json), the page content is represented as a string containing an escaped json structure.Extensions that use JSON to serialize some types of page content may provide specialized API modules that allow access to that content in a more natural form.==Compatibility==The ContentHandler facility is introduced in a way that should allow all existing code to keep functioning at least for pages that contain wikitext or other text based content.However, a number of functions and hooks have been deprecated in favor of new versions that are aware of the page's content model, and will now generate warnings when used.Most importantly, the following functions have been deprecated:*Revisions::getText() is deprecated in favor Revisions::getContent()*WikiPage::getText() is deprecated in favor WikiPage::getContent() Also, the old Article::getContent()(which returns text) is superceded by Article::getContentObject().However, both methods should be avoided since they do not provide clean access to the page's actual content.For instance, they may return a system message for non-existing pages.Use WikiPage::getContent() instead.Code that relies on a textual representation of the page content should eventually be rewritten.However, ContentHandler::getContentText() provides a stop-gap that can be used to get text for a page.Its behavior is controlled by $wgContentHandlerTextFallback it
initMessagesHref()
Build $this->messages array.
Definition: SideBarTest.php:17
static factory($code)
Get a cached or new language object for a given language code.
Definition: Language.php:183
setMwGlobals($pairs, $value=null)
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be skipped
Definition: hooks.txt:1050
testExternalUrlsRequireADescription()
SkinTemplate::addToSidebarPlain
Definition: SideBarTest.php:99
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached my talk page
Definition: hooks.txt:2537
static isValidURI($uri)
Checks that the given URI is a valid one.
Definition: Http.php:146
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 skin(according to that user's preference)
static singleton()
Get the signleton instance of this class.
testRespectExternallinktarget($externalLinkTarget)
Test $wgExternaLinkTarget in sidebar dataRespectExternallinktarget.