MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
2 use Wikimedia\ScopedCallback;
27  protected function tearDown() {
28  parent::tearDown();
31  }
33  public function testResetList() {
35  $this->assertContains( 'Specialpages', SpecialPageFactory::getNames() );
36  }
38  public function testHookNotCalledTwice() {
39  $count = 0;
40  $this->mergeMwGlobalArrayValue( 'wgHooks', [
41  'SpecialPage_initList' => [
42  function () use ( &$count ) {
43  $count++;
44  }
45  ] ] );
49  $this->assertEquals( 1, $count );
50  }
52  public function newSpecialAllPages() {
53  return new SpecialAllPages();
54  }
56  public function specialPageProvider() {
57  $specialPageTestHelper = new SpecialPageTestHelper();
59  return [
60  'class name' => [ 'SpecialAllPages', false ],
61  'closure' => [ function () {
62  return new SpecialAllPages();
63  }, false ],
64  'function' => [ [ $this, 'newSpecialAllPages' ], false ],
65  'callback string' => [ 'SpecialPageTestHelper::newSpecialAllPages', false ],
66  'callback with object' => [
67  [ $specialPageTestHelper, 'newSpecialAllPages' ],
68  false
69  ],
70  'callback array' => [
71  [ 'SpecialPageTestHelper', 'newSpecialAllPages' ],
72  false
73  ]
74  ];
75  }
81  public function testGetPage( $spec, $shouldReuseInstance ) {
82  $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => $spec ] );
85  $page = SpecialPageFactory::getPage( 'testdummy' );
86  $this->assertInstanceOf( SpecialPage::class, $page );
88  $page2 = SpecialPageFactory::getPage( 'testdummy' );
89  $this->assertEquals( $shouldReuseInstance, $page2 === $page, "Should re-use instance:" );
90  }
95  public function testGetNames() {
96  $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => SpecialAllPages::class ] );
100  $this->assertInternalType( 'array', $names );
101  $this->assertContains( 'testdummy', $names );
102  }
107  public function testResolveAlias() {
108  $this->setMwGlobals( 'wgContLang', Language::factory( 'de' ) );
111  list( $name, $param ) = SpecialPageFactory::resolveAlias( 'Spezialseiten/Foo' );
112  $this->assertEquals( 'Specialpages', $name );
113  $this->assertEquals( 'Foo', $param );
114  }
119  public function testGetLocalNameFor() {
120  $this->setMwGlobals( 'wgContLang', Language::factory( 'de' ) );
123  $name = SpecialPageFactory::getLocalNameFor( 'Specialpages', 'Foo' );
124  $this->assertEquals( 'Spezialseiten/Foo', $name );
125  }
130  public function testGetTitleForAlias() {
131  $this->setMwGlobals( 'wgContLang', Language::factory( 'de' ) );
134  $title = SpecialPageFactory::getTitleForAlias( 'Specialpages/Foo' );
135  $this->assertEquals( 'Spezialseiten/Foo', $title->getText() );
136  $this->assertEquals( NS_SPECIAL, $title->getNamespace() );
137  }
142  public function testConflictResolution(
143  $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
144  ) {
146  $lang = clone $wgContLang;
147  $lang->mExtendedSpecialPageAliases = $aliasesList;
148  $this->setMwGlobals( 'wgContLang', $lang );
149  $this->setMwGlobals( 'wgSpecialPages',
150  array_combine( array_keys( $aliasesList ), array_keys( $aliasesList ) )
151  );
154  // Catch the warnings we expect to be raised
155  $warnings = [];
156  $this->setMwGlobals( 'wgDevelopmentWarnings', true );
157  set_error_handler( function ( $errno, $errstr ) use ( &$warnings ) {
158  if ( preg_match( '/First alias \'[^\']*\' for .*/', $errstr ) ||
159  preg_match( '/Did not find a usable alias for special page .*/', $errstr )
160  ) {
161  $warnings[] = $errstr;
162  return true;
163  }
164  return false;
165  } );
166  $reset = new ScopedCallback( 'restore_error_handler' );
168  list( $name, /*...*/ ) = SpecialPageFactory::resolveAlias( $alias );
169  $this->assertEquals( $expectedName, $name, "$test: Alias to name" );
171  $this->assertEquals( $expectedAlias, $result, "$test: Alias to name to alias" );
173  $gotWarnings = count( $warnings );
174  if ( $gotWarnings !== $expectWarnings ) {
175  $this->fail( "Expected $expectWarnings warning(s), but got $gotWarnings:\n" .
176  implode( "\n", $warnings )
177  );
178  }
179  }
185  $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
186  ) {
187  // Make sure order doesn't matter by reversing the list
188  $aliasesList = array_reverse( $aliasesList );
189  return $this->testConflictResolution(
190  $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
191  );
192  }
194  public function provideTestConflictResolution() {
195  return [
196  [
197  'Canonical name wins',
198  [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
199  'Foo',
200  'Foo',
201  'Foo',
202  1,
203  ],
205  [
206  'Doesn\'t redirect to a different special page\'s canonical name',
207  [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
208  'Baz',
209  'Baz',
210  'BazPage',
211  1,
212  ],
214  [
215  'Canonical name wins even if not aliased',
216  [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
217  'Foo',
218  'Foo',
219  'FooPage',
220  1,
221  ],
223  [
224  'Doesn\'t redirect to a different special page\'s canonical name even if not aliased',
225  [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
226  'Baz',
227  'Baz',
228  'BazPage',
229  1,
230  ],
232  [
233  'First local name beats non-first',
234  [ 'First' => [ 'Foo' ], 'NonFirst' => [ 'Bar', 'Foo' ] ],
235  'Foo',
236  'First',
237  'Foo',
238  0,
239  ],
241  [
242  'Doesn\'t redirect to a different special page\'s first alias',
243  [
244  'Foo' => [ 'Foo' ],
245  'First' => [ 'Bar' ],
246  'Baz' => [ 'Foo', 'Bar', 'BazPage', 'Baz2' ]
247  ],
248  'Baz',
249  'Baz',
250  'BazPage',
251  1,
252  ],
254  [
255  'Doesn\'t redirect wrong even if all aliases conflict',
256  [
257  'Foo' => [ 'Foo' ],
258  'First' => [ 'Bar' ],
259  'Baz' => [ 'Foo', 'Bar' ]
260  ],
261  'Baz',
262  'Baz',
263  'Baz',
264  2,
265  ],
267  ];
268  }
270  public function testGetAliasListRecursion() {
271  $called = false;
272  $this->mergeMwGlobalArrayValue( 'wgHooks', [
273  'SpecialPage_initList' => [
274  function () use ( &$called ) {
275  SpecialPageFactory::getLocalNameFor( 'Specialpages' );
276  $called = true;
277  }
278  ],
279  ] );
281  SpecialPageFactory::getLocalNameFor( 'Specialpages' );
282  $this->assertTrue( $called, 'Recursive call succeeded' );
283  }
285 }
Definition: SpecialPageFactoryTest.php:107
Definition: SpecialPageFactoryTest.php:194
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
mergeMwGlobalArrayValue( $name, $values)
Merges the given values into a MW global array variable.
Definition: MediaWikiTestCase.php:813
if(!isset( $args[0])) $lang
Definition: testCompression.php:33
Definition: SpecialPageFactoryTest.php:130
testConflictResolutionReversed( $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings)
Definition: SpecialPageFactoryTest.php:184
Definition: SpecialPageFactoryTest.php:95
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! 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! 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:1993
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
Definition: SpecialPageFactoryTest.php:38
testConflictResolution( $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings)
Definition: SpecialPageFactoryTest.php:142
$called tracks whether the setUp and tearDown method has been called.
Definition: MediaWikiTestCase.php:43
This program is free software; you can redistribute it and/or modify it under the terms of the GNU Ge...
Definition: SpecialPageTestHelper.php:18
Definition: Defines.php:63
Definition: SpecialPageFactoryTest.php:119
setMwGlobals( $pairs, $value=null)
Sets a global, maintaining a stashed version of the previous global to be restored in tearDown.
Definition: MediaWikiTestCase.php:678
Definition: MediaWikiTestCase.php:17
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
Definition: SpecialPageFactoryTest.php:52
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
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 list
Definition: deferred.txt:11
Factory for handling the special page list and generating SpecialPage objects.
Definition: SpecialPageFactoryTest.php:25
testGetPage( $spec, $shouldReuseInstance)
SpecialPageFactory::getPage specialPageProvider.
Definition: SpecialPageFactoryTest.php:81
Definition: SpecialPageFactoryTest.php:56
static resolveAlias( $alias)
Given a special page name with a possible subpage, return an array where the first element is the spe...
Definition: SpecialPageFactory.php:328
static getTitleForAlias( $alias)
Get a title for a given alias.
Definition: SpecialPageFactory.php:701
static getLocalNameFor( $name, $subpage=false)
Get the local name for a specified canonical name.
Definition: SpecialPageFactory.php:647
Definition: SpecialPageFactoryTest.php:33
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Implements Special:Allpages.
Definition: SpecialAllPages.php:30
static resetList()
Reset the internal list of special pages.
Definition: SpecialPageFactory.php:200
static getNames()
Returns a list of canonical special page names.
Definition: SpecialPageFactory.php:211
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:183
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
static getPage( $name)
Find the object with a given name and return it (or NULL)
Definition: SpecialPageFactory.php:369
Definition: SpecialPageFactoryTest.php:27
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
Definition: SpecialPageFactoryTest.php:270
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 and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57