3 use MediaWiki\MediaWikiServices
;
4 use Wikimedia\ScopedCallback
;
7 * Factory for handling the special page list and generating SpecialPage objects.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
24 * @covers \MediaWiki\Special\SpecialPageFactory
27 class SpecialPageFactoryTest
extends MediaWikiTestCase
{
28 public function testHookNotCalledTwice() {
30 $this->mergeMwGlobalArrayValue( 'wgHooks', [
31 'SpecialPage_initList' => [
32 function () use ( &$count ) {
36 $spf = MediaWikiServices
::getInstance()->getSpecialPageFactory();
39 $this->assertEquals( 1, $count );
42 public function newSpecialAllPages() {
43 return new SpecialAllPages();
46 public function specialPageProvider() {
47 $specialPageTestHelper = new SpecialPageTestHelper();
50 'class name' => [ 'SpecialAllPages', false ],
51 'closure' => [ function () {
52 return new SpecialAllPages();
54 'function' => [ [ $this, 'newSpecialAllPages' ], false ],
55 'callback string' => [ 'SpecialPageTestHelper::newSpecialAllPages', false ],
56 'callback with object' => [
57 [ $specialPageTestHelper, 'newSpecialAllPages' ],
61 [ 'SpecialPageTestHelper', 'newSpecialAllPages' ],
68 * @covers SpecialPageFactory::getPage
69 * @dataProvider specialPageProvider
71 public function testGetPage( $spec, $shouldReuseInstance ) {
72 $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => $spec ] );
74 $page = SpecialPageFactory
::getPage( 'testdummy' );
75 $this->assertInstanceOf( SpecialPage
::class, $page );
77 $page2 = SpecialPageFactory
::getPage( 'testdummy' );
78 $this->assertEquals( $shouldReuseInstance, $page2 === $page, "Should re-use instance:" );
82 * @covers SpecialPageFactory::getNames
84 public function testGetNames() {
85 $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => SpecialAllPages
::class ] );
87 $names = SpecialPageFactory
::getNames();
88 $this->assertInternalType( 'array', $names );
89 $this->assertContains( 'testdummy', $names );
93 * @covers SpecialPageFactory::resolveAlias
95 public function testResolveAlias() {
96 $this->setContentLang( 'de' );
98 list( $name, $param ) = SpecialPageFactory
::resolveAlias( 'Spezialseiten/Foo' );
99 $this->assertEquals( 'Specialpages', $name );
100 $this->assertEquals( 'Foo', $param );
104 * @covers SpecialPageFactory::getLocalNameFor
106 public function testGetLocalNameFor() {
107 $this->setContentLang( 'de' );
109 $name = SpecialPageFactory
::getLocalNameFor( 'Specialpages', 'Foo' );
110 $this->assertEquals( 'Spezialseiten/Foo', $name );
114 * @covers SpecialPageFactory::getTitleForAlias
116 public function testGetTitleForAlias() {
117 $this->setContentLang( 'de' );
119 $title = SpecialPageFactory
::getTitleForAlias( 'Specialpages/Foo' );
120 $this->assertEquals( 'Spezialseiten/Foo', $title->getText() );
121 $this->assertEquals( NS_SPECIAL
, $title->getNamespace() );
125 * @dataProvider provideTestConflictResolution
127 public function testConflictResolution(
128 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
130 $lang = clone MediaWikiServices
::getInstance()->getContentLanguage();
131 $lang->mExtendedSpecialPageAliases
= $aliasesList;
132 $this->setMwGlobals( 'wgSpecialPages',
133 array_combine( array_keys( $aliasesList ), array_keys( $aliasesList ) )
135 $this->setContentLang( $lang );
137 // Catch the warnings we expect to be raised
139 $this->setMwGlobals( 'wgDevelopmentWarnings', true );
140 set_error_handler( function ( $errno, $errstr ) use ( &$warnings ) {
141 if ( preg_match( '/First alias \'[^\']*\' for .*/', $errstr ) ||
142 preg_match( '/Did not find a usable alias for special page .*/', $errstr )
144 $warnings[] = $errstr;
149 $reset = new ScopedCallback( 'restore_error_handler' );
151 list( $name, /*...*/ ) = SpecialPageFactory
::resolveAlias( $alias );
152 $this->assertEquals( $expectedName, $name, "$test: Alias to name" );
153 $result = SpecialPageFactory
::getLocalNameFor( $name );
154 $this->assertEquals( $expectedAlias, $result, "$test: Alias to name to alias" );
156 $gotWarnings = count( $warnings );
157 if ( $gotWarnings !== $expectWarnings ) {
158 $this->fail( "Expected $expectWarnings warning(s), but got $gotWarnings:\n" .
159 implode( "\n", $warnings )
165 * @dataProvider provideTestConflictResolution
167 public function testConflictResolutionReversed(
168 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
170 // Make sure order doesn't matter by reversing the list
171 $aliasesList = array_reverse( $aliasesList );
172 return $this->testConflictResolution(
173 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
177 public function provideTestConflictResolution() {
180 'Canonical name wins',
181 [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
189 'Doesn\'t redirect to a different special page\'s canonical name',
190 [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
198 'Canonical name wins even if not aliased',
199 [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
207 'Doesn\'t redirect to a different special page\'s canonical name even if not aliased',
208 [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
216 'First local name beats non-first',
217 [ 'First' => [ 'Foo' ], 'NonFirst' => [ 'Bar', 'Foo' ] ],
225 'Doesn\'t redirect to a different special page\'s first alias',
228 'First' => [ 'Bar' ],
229 'Baz' => [ 'Foo', 'Bar', 'BazPage', 'Baz2' ]
238 'Doesn\'t redirect wrong even if all aliases conflict',
241 'First' => [ 'Bar' ],
242 'Baz' => [ 'Foo', 'Bar' ]
253 public function testGetAliasListRecursion() {
255 $this->mergeMwGlobalArrayValue( 'wgHooks', [
256 'SpecialPage_initList' => [
257 function () use ( &$called ) {
258 SpecialPageFactory
::getLocalNameFor( 'Specialpages' );
263 SpecialPageFactory
::getLocalNameFor( 'Specialpages' );
264 $this->assertTrue( $called, 'Recursive call succeeded' );