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' ],
64 'object factory spec' => [
65 [ 'class' => SpecialAllPages
::class ],
72 * @covers SpecialPageFactory::getPage
73 * @dataProvider specialPageProvider
75 public function testGetPage( $spec, $shouldReuseInstance ) {
76 $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => $spec ] );
78 $page = SpecialPageFactory
::getPage( 'testdummy' );
79 $this->assertInstanceOf( SpecialPage
::class, $page );
81 $page2 = SpecialPageFactory
::getPage( 'testdummy' );
82 $this->assertEquals( $shouldReuseInstance, $page2 === $page, "Should re-use instance:" );
86 * @covers SpecialPageFactory::getNames
88 public function testGetNames() {
89 $this->mergeMwGlobalArrayValue( 'wgSpecialPages', [ 'testdummy' => SpecialAllPages
::class ] );
91 $names = SpecialPageFactory
::getNames();
92 $this->assertInternalType( 'array', $names );
93 $this->assertContains( 'testdummy', $names );
97 * @covers SpecialPageFactory::resolveAlias
99 public function testResolveAlias() {
100 $this->setContentLang( 'de' );
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' );
113 $name = SpecialPageFactory
::getLocalNameFor( 'Specialpages', 'Foo' );
114 $this->assertEquals( 'Spezialseiten/Foo', $name );
118 * @covers SpecialPageFactory::getTitleForAlias
120 public function testGetTitleForAlias() {
121 $this->setContentLang( 'de' );
123 $title = SpecialPageFactory
::getTitleForAlias( 'Specialpages/Foo' );
124 $this->assertEquals( 'Spezialseiten/Foo', $title->getText() );
125 $this->assertEquals( NS_SPECIAL
, $title->getNamespace() );
129 * @dataProvider provideTestConflictResolution
131 public function testConflictResolution(
132 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
134 $lang = clone MediaWikiServices
::getInstance()->getContentLanguage();
135 $lang->mExtendedSpecialPageAliases
= $aliasesList;
136 $this->setMwGlobals( 'wgSpecialPages',
137 array_combine( array_keys( $aliasesList ), array_keys( $aliasesList ) )
139 $this->setContentLang( $lang );
141 // Catch the warnings we expect to be raised
143 $this->setMwGlobals( 'wgDevelopmentWarnings', true );
144 set_error_handler( function ( $errno, $errstr ) use ( &$warnings ) {
145 if ( preg_match( '/First alias \'[^\']*\' for .*/', $errstr ) ||
146 preg_match( '/Did not find a usable alias for special page .*/', $errstr )
148 $warnings[] = $errstr;
153 $reset = new ScopedCallback( 'restore_error_handler' );
155 list( $name, /*...*/ ) = SpecialPageFactory
::resolveAlias( $alias );
156 $this->assertEquals( $expectedName, $name, "$test: Alias to name" );
157 $result = SpecialPageFactory
::getLocalNameFor( $name );
158 $this->assertEquals( $expectedAlias, $result, "$test: Alias to name to alias" );
160 $gotWarnings = count( $warnings );
161 if ( $gotWarnings !== $expectWarnings ) {
162 $this->fail( "Expected $expectWarnings warning(s), but got $gotWarnings:\n" .
163 implode( "\n", $warnings )
169 * @dataProvider provideTestConflictResolution
171 public function testConflictResolutionReversed(
172 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
174 // Make sure order doesn't matter by reversing the list
175 $aliasesList = array_reverse( $aliasesList );
176 return $this->testConflictResolution(
177 $test, $aliasesList, $alias, $expectedName, $expectedAlias, $expectWarnings
181 public function provideTestConflictResolution() {
184 'Canonical name wins',
185 [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
193 'Doesn\'t redirect to a different special page\'s canonical name',
194 [ 'Foo' => [ 'Foo', 'Bar' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
202 'Canonical name wins even if not aliased',
203 [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
211 'Doesn\'t redirect to a different special page\'s canonical name even if not aliased',
212 [ 'Foo' => [ 'FooPage' ], 'Baz' => [ 'Foo', 'BazPage', 'Baz2' ] ],
220 'First local name beats non-first',
221 [ 'First' => [ 'Foo' ], 'NonFirst' => [ 'Bar', 'Foo' ] ],
229 'Doesn\'t redirect to a different special page\'s first alias',
232 'First' => [ 'Bar' ],
233 'Baz' => [ 'Foo', 'Bar', 'BazPage', 'Baz2' ]
242 'Doesn\'t redirect wrong even if all aliases conflict',
245 'First' => [ 'Bar' ],
246 'Baz' => [ 'Foo', 'Bar' ]
257 public function testGetAliasListRecursion() {
259 $this->mergeMwGlobalArrayValue( 'wgHooks', [
260 'SpecialPage_initList' => [
261 function () use ( &$called ) {
262 SpecialPageFactory
::getLocalNameFor( 'Specialpages' );
267 SpecialPageFactory
::getLocalNameFor( 'Specialpages' );
268 $this->assertTrue( $called, 'Recursive call succeeded' );
272 * @covers \MediaWiki\Special\SpecialPageFactory::getPage
274 public function testSpecialPageCreationThatRequiresService() {
277 $this->setMwGlobals( 'wgSpecialPages',
279 'factory' => function ( $spf ) use ( &$type ) {
280 $type = get_class( $spf );
282 return new class() extends SpecialPage
{
292 SpecialPageFactory
::getPage( 'TestPage' );
294 $this->assertEquals( \MediaWiki\Special\SpecialPageFactory
::class, $type );