MediaWiki  master
ExtraParserTest.php
Go to the documentation of this file.
1 <?php
2 
4 
11 
13  protected $options;
15  protected $parser;
16 
17  protected function setUp() {
18  parent::setUp();
19 
20  $contLang = Language::factory( 'en' );
21  $this->setMwGlobals( [
22  'wgShowExceptionDetails' => true,
23  'wgCleanSignatures' => true,
24  ] );
25  $this->setUserLang( 'en' );
26  $this->setContentLang( $contLang );
27 
28  // FIXME: This test should pass without setting global content language
29  $this->options = ParserOptions::newFromUserAndLang( new User, $contLang );
30  $this->options->setTemplateCallback( [ __CLASS__, 'statelessFetchTemplate' ] );
31  $this->parser = new Parser;
32 
33  MediaWikiServices::getInstance()->resetServiceForTesting( 'MagicWordFactory' );
34  }
35 
41  $longLine = '1.' . str_repeat( '1234567890', 100000 ) . "\n";
42 
43  $title = Title::newFromText( 'Unit test' );
45  $this->assertEquals( "<p>$longLine</p>",
46  $this->parser->parse( $longLine, $title, $options )->getText( [ 'unwrap' => true ] ) );
47  }
48 
54  $text = "{{Special:ApiHelp/help}}";
55  $title = Title::newFromText( 'testSpecialPageTransclusionRestoresGlobalState' );
57 
58  RequestContext::getMain()->setTitle( $title );
59  RequestContext::getMain()->getWikiPage()->CustomTestProp = true;
60 
61  $parsed = $this->parser->parse( $text, $title, $options )->getText();
62  $this->assertContains( 'apihelp-header', $parsed );
63 
64  // Verify that this property wasn't wiped out by the parse
65  $this->assertTrue( RequestContext::getMain()->getWikiPage()->CustomTestProp );
66  }
67 
72  public function testParse() {
73  $title = Title::newFromText( __FUNCTION__ );
74  $parserOutput = $this->parser->parse( "Test\n{{Foo}}\n{{Bar}}", $title, $this->options );
75  $this->assertEquals(
76  "<p>Test\nContent of <i>Template:Foo</i>\nContent of <i>Template:Bar</i>\n</p>",
77  $parserOutput->getText( [ 'unwrap' => true ] )
78  );
79  }
80 
84  public function testPreSaveTransform() {
85  $title = Title::newFromText( __FUNCTION__ );
86  $outputText = $this->parser->preSaveTransform(
87  "Test\r\n{{subst:Foo}}\n{{Bar}}",
88  $title,
89  new User(),
90  $this->options
91  );
92 
93  $this->assertEquals( "Test\nContent of ''Template:Foo''\n{{Bar}}", $outputText );
94  }
95 
99  public function testPreprocess() {
100  $title = Title::newFromText( __FUNCTION__ );
101  $outputText = $this->parser->preprocess( "Test\n{{Foo}}\n{{Bar}}", $title, $this->options );
102 
103  $this->assertEquals(
104  "Test\nContent of ''Template:Foo''\nContent of ''Template:Bar''",
105  $outputText
106  );
107  }
108 
113  public function testCleanSig() {
114  $title = Title::newFromText( __FUNCTION__ );
115  $outputText = $this->parser->cleanSig( "{{Foo}} ~~~~" );
116 
117  $this->assertEquals( "{{SUBST:Foo}} ", $outputText );
118  }
119 
124  public function testCleanSigDisabled() {
125  $this->setMwGlobals( 'wgCleanSignatures', false );
126 
127  $title = Title::newFromText( __FUNCTION__ );
128  $outputText = $this->parser->cleanSig( "{{Foo}} ~~~~" );
129 
130  $this->assertEquals( "{{Foo}} ~~~~", $outputText );
131  }
132 
138  public function testCleanSigInSig( $in, $out ) {
139  $this->assertEquals( Parser::cleanSigInSig( $in ), $out );
140  }
141 
142  public static function provideStringsForCleanSigInSig() {
143  return [
144  [ "{{Foo}} ~~~~", "{{Foo}} " ],
145  [ "~~~", "" ],
146  [ "~~~~~", "" ],
147  ];
148  }
149 
153  public function testGetSection() {
154  $outputText2 = $this->parser->getSection(
155  "Section 0\n== Heading 1 ==\nSection 1\n=== Heading 2 ===\n"
156  . "Section 2\n== Heading 3 ==\nSection 3\n",
157  2
158  );
159  $outputText1 = $this->parser->getSection(
160  "Section 0\n== Heading 1 ==\nSection 1\n=== Heading 2 ===\n"
161  . "Section 2\n== Heading 3 ==\nSection 3\n",
162  1
163  );
164 
165  $this->assertEquals( "=== Heading 2 ===\nSection 2", $outputText2 );
166  $this->assertEquals( "== Heading 1 ==\nSection 1\n=== Heading 2 ===\nSection 2", $outputText1 );
167  }
168 
172  public function testReplaceSection() {
173  $outputText = $this->parser->replaceSection(
174  "Section 0\n== Heading 1 ==\nSection 1\n=== Heading 2 ===\n"
175  . "Section 2\n== Heading 3 ==\nSection 3\n",
176  1,
177  "New section 1"
178  );
179 
180  $this->assertEquals( "Section 0\nNew section 1\n\n== Heading 3 ==\nSection 3", $outputText );
181  }
182 
187  public function testGetPreloadText() {
188  $title = Title::newFromText( __FUNCTION__ );
189  $outputText = $this->parser->getPreloadText(
190  "{{Foo}}<noinclude> censored</noinclude> information <!-- is very secret -->",
191  $title,
192  $this->options
193  );
194 
195  $this->assertEquals( "{{Foo}} information <!-- is very secret -->", $outputText );
196  }
197 
204  static function statelessFetchTemplate( $title, $parser = false ) {
205  $text = "Content of ''" . $title->getFullText() . "''";
206  $deps = [];
207 
208  return [
209  'text' => $text,
210  'finalTitle' => $title,
211  'deps' => $deps ];
212  }
213 
217  public function testTrackingCategory() {
218  $title = Title::newFromText( __FUNCTION__ );
219  $catName = wfMessage( 'broken-file-category' )->inContentLanguage()->text();
220  $cat = Title::makeTitleSafe( NS_CATEGORY, $catName );
221  $expected = [ $cat->getDBkey() ];
222  $parserOutput = $this->parser->parse( "[[file:nonexistent]]", $title, $this->options );
223  $result = $parserOutput->getCategoryLinks();
224  $this->assertEquals( $expected, $result );
225  }
226 
230  public function testTrackingCategorySpecial() {
231  // Special pages shouldn't have tracking cats.
232  $title = SpecialPage::getTitleFor( 'Contributions' );
233  $parserOutput = $this->parser->parse( "[[file:nonexistent]]", $title, $this->options );
234  $result = $parserOutput->getCategoryLinks();
235  $this->assertEmpty( $result );
236  }
237 
242  public function testParseLinkParameter( $input, $expected, $expectedLinks, $desc ) {
243  $this->parser->startExternalParse( Title::newFromText( __FUNCTION__ ),
244  $this->options, Parser::OT_HTML );
245  $output = $this->parser->parseLinkParameter( $input );
246 
247  $this->assertEquals( $expected[0], $output[0], "$desc (type)" );
248 
249  if ( $expected[0] === 'link-title' ) {
250  $this->assertTrue( $expected[1]->equals( $output[1] ), "$desc (target)" );
251  } else {
252  $this->assertEquals( $expected[1], $output[1], "$desc (target)" );
253  }
254 
255  foreach ( $expectedLinks as $func => $expected ) {
256  $output = $this->parser->getOutput()->$func();
257  $this->assertEquals( $expected, $output, "$desc ($func)" );
258  }
259  }
260 
261  public static function provideParseLinkParameter() {
262  return [
263  [
264  '',
265  [ 'no-link', false ],
266  [],
267  'Return no link when requested',
268  ],
269  [
270  'https://example.com/',
271  [ 'link-url', 'https://example.com/' ],
272  [ 'getExternalLinks' => [ 'https://example.com/' => 1 ] ],
273  'External link',
274  ],
275  [
276  '//example.com/',
277  [ 'link-url', '//example.com/' ],
278  [ 'getExternalLinks' => [ '//example.com/' => 1 ] ],
279  'External link',
280  ],
281  [
282  'Test',
283  [ 'link-title', Title::newFromText( 'Test' ) ],
284  [ 'getLinks' => [ 0 => [ 'Test' => 0 ] ] ],
285  'Internal link',
286  ],
287  [
288  'mw:Test',
289  [ 'link-title', Title::newFromText( 'mw:Test' ) ],
290  [ 'getInterwikiLinks' => [ 'mw' => [ 'Test' => 1 ] ] ],
291  'Internal link (interwiki)',
292  ],
293  [
294  'https://',
295  [ null, false ],
296  [],
297  'Invalid link target',
298  ],
299  [
300  '<>',
301  [ null, false ],
302  [],
303  'Invalid link target',
304  ],
305  [
306  ' ',
307  [ null, false ],
308  [],
309  'Invalid link target',
310  ],
311  ];
312  }
313 }
testCleanSigDisabled()
cleanSig() should do nothing if disabled Parser::cleanSig
testParse()
Test the parser entry points Parser::parse.
if(is_array( $mode)) switch( $mode) $input
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:193
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
testPreprocess()
Parser::preprocess.
static newFromUserAndLang(User $user, Language $lang)
Get a ParserOptions object from a given user and language.
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 MediaWikiServices
Definition: injection.txt:23
testCleanSig()
cleanSig() makes all templates substs and removes tildes Parser::cleanSig
static cleanSigInSig( $text)
Strip 3, 4 or 5 tildes out of signatures.
Definition: Parser.php:4870
testParseLinkParameter( $input, $expected, $expectedLinks, $desc)
Parser::parseLinkParameter provideParseLinkParameter.
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2211
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=(\*-\*)") 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. '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 '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:1976
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:773
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 set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
static provideParseLinkParameter()
static statelessFetchTemplate( $title, $parser=false)
const NS_CATEGORY
Definition: Defines.php:74
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:83
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
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:620
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
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
testCleanSigInSig( $in, $out)
cleanSigInSig() just removes tildes provideStringsForCleanSigInSig Parser::cleanSigInSig ...
testTrackingCategorySpecial()
Parser::parse.
static newFromUser( $user)
Get a ParserOptions object from a given user.
testTrackingCategory()
Parser::parse.
testLongNumericLinesDontKillTheParser()
Parser-related tests that don&#39;t suit for parserTests.txt.
testSpecialPageTransclusionRestoresGlobalState()
Parser::braceSubstitution SpecialPageFactory::capturePath.
testReplaceSection()
Parser::replaceSection.
static provideStringsForCleanSigInSig()
testGetPreloadText()
Templates and comments are not affected, but noinclude/onlyinclude is.
ParserOptions $options
testGetSection()
Parser::getSection.
testPreSaveTransform()
Parser::preSaveTransform.
const OT_HTML
Definition: Parser.php:114
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:322