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 $this->overrideMwServices();
37 $spf = MediaWikiServices
::getInstance()->getSpecialPageFactory();
40 $this->assertEquals( 1, $count );
43 public function newSpecialAllPages() {
44 return new SpecialAllPages();
47 public function specialPageProvider() {
48 $specialPageTestHelper = new SpecialPageTestHelper();
51 'class name' => [ 'SpecialAllPages', false ],
52 'closure' => [ function () {
53 return new SpecialAllPages();
55 'function' => [ [ $this, 'newSpecialAllPages' ], false ],
56 'callback string' => [ 'SpecialPageTestHelper::newSpecialAllPages', false ],
57 'callback with object' => [
58 [ $specialPageTestHelper, 'newSpecialAllPages' ],
62 [ 'SpecialPageTestHelper', 'newSpecialAllPages' ],
69 * @covers SpecialPageFactory::getPage
70 * @dataProvider specialPageProvider
72 public function testGetPage( $spec, $shouldReuseInstance ) {
73 $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => $spec ] );
74 $this->overrideMwServices();
76 $page = SpecialPageFactory
::getPage( 'testdummy' );
77 $this->assertInstanceOf( SpecialPage
::class, $page );
79 $page2 = SpecialPageFactory
::getPage( 'testdummy' );
80 $this->assertEquals( $shouldReuseInstance, $page2 === $page, "Should re-use instance:" );
84 * @covers SpecialPageFactory::getNames
86 public function testGetNames() {
87 $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => SpecialAllPages
::class ] );
88 $this->overrideMwServices();
90 $names = SpecialPageFactory
::getNames();
91 $this->assertInternalType( 'array', $names );
92 $this->assertContains( 'testdummy', $names );
96 * @covers SpecialPageFactory::resolveAlias
98 public function testResolveAlias() {
99 $this->setContentLang( 'de' );
100 $this->overrideMwServices();
102 list( $name, $param ) = SpecialPageFactory
::resolveAlias( 'Spezialseiten/Foo' );
103 $this->assertEquals( 'Specialpages', $name );
104 $this->assertEquals( 'Foo', $param );
108 * @covers SpecialPageFactory::getLocalNameFor
110 public function testGetLocalNameFor() {
111 $this->setContentLang( 'de' );
112 $this->overrideMwServices();
114 $name = SpecialPageFactory
::getLocalNameFor( 'Specialpages', 'Foo' );
115 $this->assertEquals( 'Spezialseiten/Foo', $name );
119 * @covers SpecialPageFactory::getTitleForAlias
121 public function testGetTitleForAlias() {
122 $this->setContentLang( 'de' );
123 $this->overrideMwServices();
125 $title = SpecialPageFactory
::getTitleForAlias( 'Specialpages/Foo' );
126 $this->assertEquals( 'Spezialseiten/Foo', $title->getText() );
127 $this->assertEquals( NS_SPECIAL
, $title->getNamespace() );
131 * @dataProvider provideTestConflictResolution
133 public function testConflictResolution(
134 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
136 $lang = clone MediaWikiServices
::getInstance()->getContentLanguage();
137 $lang->mExtendedSpecialPageAliases
= $aliasesList;
138 $this->setMwGlobals( 'wgSpecialPages',
139 array_combine( array_keys( $aliasesList ), array_keys( $aliasesList ) )
141 $this->overrideMwServices();
142 $this->setContentLang( $lang );
144 // Catch the warnings we expect to be raised
146 $this->setMwGlobals( 'wgDevelopmentWarnings', true );
147 set_error_handler( function ( $errno, $errstr ) use ( &$warnings ) {
148 if ( preg_match( '/First alias \'[^\']*\' for .*/', $errstr ) ||
149 preg_match( '/Did not find a usable alias for special page .*/', $errstr )
151 $warnings[] = $errstr;
156 $reset = new ScopedCallback( 'restore_error_handler' );
158 list( $name, /*...*/ ) = SpecialPageFactory
::resolveAlias( $alias );
159 $this->assertEquals( $expectedName, $name, "$test: Alias to name" );
160 $result = SpecialPageFactory
::getLocalNameFor( $name );
161 $this->assertEquals( $expectedAlias, $result, "$test: Alias to name to alias" );
163 $gotWarnings = count( $warnings );
164 if ( $gotWarnings !== $expectWarnings ) {
165 $this->fail( "Expected $expectWarnings warning(s), but got $gotWarnings:\n" .
166 implode( "\n", $warnings )
172 * @dataProvider provideTestConflictResolution
174 public function testConflictResolutionReversed(
175 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
177 // Make sure order doesn't matter by reversing the list
178 $aliasesList = array_reverse( $aliasesList );
179 return $this->testConflictResolution(
180 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
184 public function provideTestConflictResolution() {
187 'Canonical name wins',
188 [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
196 'Doesn\'t redirect to a different special page\'s canonical name',
197 [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
205 'Canonical name wins even if not aliased',
206 [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
214 'Doesn\'t redirect to a different special page\'s canonical name even if not aliased',
215 [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
223 'First local name beats non-first',
224 [ 'First' => [ 'Foo' ], 'NonFirst' => [ 'Bar', 'Foo' ] ],
232 'Doesn\'t redirect to a different special page\'s first alias',
235 'First' => [ 'Bar' ],
236 'Baz' => [ 'Foo', 'Bar', 'BazPage', 'Baz2' ]
245 'Doesn\'t redirect wrong even if all aliases conflict',
248 'First' => [ 'Bar' ],
249 'Baz' => [ 'Foo', 'Bar' ]
260 public function testGetAliasListRecursion() {
262 $this->mergeMwGlobalArrayValue( 'wgHooks', [
263 'SpecialPage_initList' => [
264 function () use ( &$called ) {
265 SpecialPageFactory
::getLocalNameFor( 'Specialpages' );
270 $this->overrideMwServices();
271 SpecialPageFactory
::getLocalNameFor( 'Specialpages' );
272 $this->assertTrue( $called, 'Recursive call succeeded' );