5 * @group GlobalFunctions
7 class GlobalTest
extends MediaWikiTestCase
{
8 protected function setUp() {
11 $readOnlyFile = $this->getNewTempFile();
12 unlink( $readOnlyFile );
14 $this->setMwGlobals( [
15 'wgReadOnlyFile' => $readOnlyFile,
21 'file://', # Non-default
27 * @dataProvider provideForWfArrayDiff2
28 * @covers ::wfArrayDiff2
30 public function testWfArrayDiff2( $a, $b, $expected ) {
32 wfArrayDiff2( $a, $b ), $expected
36 // @todo Provide more tests
37 public static function provideForWfArrayDiff2() {
46 [ [ 'a' ], [ 'a', 'b', 'c' ] ],
47 [ [ 'a' ], [ 'a', 'b' ] ],
48 [ 1 => [ 'a', 'b', 'c' ] ],
54 * Test cases for random functions could hypothetically fail,
55 * even though they shouldn't.
61 public function testRandom() {
63 wfRandom() == wfRandom()
68 * @covers ::wfRandomString
70 public function testRandomString() {
72 wfRandomString() == wfRandomString()
75 strlen( wfRandomString( 10 ) ), 10
78 preg_match( '/^[0-9a-f]+$/i', wfRandomString() ) === 1
83 * @covers ::wfUrlencode
85 public function testUrlencode() {
87 "%E7%89%B9%E5%88%A5:Contributions/Foobar",
88 wfUrlencode( "\xE7\x89\xB9\xE5\x88\xA5:Contributions/Foobar" ) );
92 * @covers ::wfExpandIRI
94 public function testExpandIRI() {
96 "https://te.wikibooks.org/wiki/ఉబుంటు_వాడుకరి_మార్గదర్శని",
97 wfExpandIRI( "https://te.wikibooks.org/wiki/"
98 . "%E0%B0%89%E0%B0%AC%E0%B1%81%E0%B0%82%E0%B0%9F%E0%B1%81_"
99 . "%E0%B0%B5%E0%B0%BE%E0%B0%A1%E0%B1%81%E0%B0%95%E0%B0%B0%E0%B0%BF_"
100 . "%E0%B0%AE%E0%B0%BE%E0%B0%B0%E0%B1%8D%E0%B0%97%E0%B0%A6%E0%B0%B0"
101 . "%E0%B1%8D%E0%B0%B6%E0%B0%A8%E0%B0%BF" ) );
105 * Intended to cover the relevant bits of ServiceWiring.php, as well as GlobalFunctions.php
106 * @covers ::wfReadOnly
108 public function testReadOnlyEmpty() {
112 MediaWiki\MediaWikiServices
::getInstance()->getReadOnlyMode()->clearCache();
113 $this->assertFalse( wfReadOnly() );
114 $this->assertFalse( wfReadOnly() );
118 * Intended to cover the relevant bits of ServiceWiring.php, as well as GlobalFunctions.php
119 * @covers ::wfReadOnly
121 public function testReadOnlySet() {
122 global $wgReadOnly, $wgReadOnlyFile;
124 $readOnlyMode = MediaWiki\MediaWikiServices
::getInstance()->getReadOnlyMode();
125 $readOnlyMode->clearCache();
127 $f = fopen( $wgReadOnlyFile, "wt" );
128 fwrite( $f, 'Message' );
130 $wgReadOnly = null; # Check on $wgReadOnlyFile
132 $this->assertTrue( wfReadOnly() );
133 $this->assertTrue( wfReadOnly() ); # Check cached
135 unlink( $wgReadOnlyFile );
136 $readOnlyMode->clearCache();
137 $this->assertFalse( wfReadOnly() );
138 $this->assertFalse( wfReadOnly() );
142 * This behaviour could probably be deprecated. Several extensions rely on it as of 1.29.
143 * @covers ::wfReadOnlyReason
145 public function testReadOnlyGlobalChange() {
146 $this->assertFalse( wfReadOnlyReason() );
147 $this->setMwGlobals( [
148 'wgReadOnly' => 'reason'
150 $this->assertSame( 'reason', wfReadOnlyReason() );
153 public static function provideArrayToCGI() {
156 [ [ 'foo' => 'bar' ], 'foo=bar' ], // string test
157 [ [ 'foo' => '' ], 'foo=' ], // empty string test
158 [ [ 'foo' => 1 ], 'foo=1' ], // number test
159 [ [ 'foo' => true ], 'foo=1' ], // true test
160 [ [ 'foo' => false ], '' ], // false test
161 [ [ 'foo' => null ], '' ], // null test
162 [ [ 'foo' => 'A&B=5+6@!"\'' ], 'foo=A%26B%3D5%2B6%40%21%22%27' ], // urlencoding test
164 [ 'foo' => 'bar', 'baz' => 'is', 'asdf' => 'qwerty' ],
165 'foo=bar&baz=is&asdf=qwerty'
166 ], // multi-item test
167 [ [ 'foo' => [ 'bar' => 'baz' ] ], 'foo%5Bbar%5D=baz' ],
169 [ 'foo' => [ 'bar' => 'baz', 'qwerty' => 'asdf' ] ],
170 'foo%5Bbar%5D=baz&foo%5Bqwerty%5D=asdf'
172 [ [ 'foo' => [ 'bar', 'baz' ] ], 'foo%5B0%5D=bar&foo%5B1%5D=baz' ],
174 [ 'foo' => [ 'bar' => [ 'bar' => 'baz' ] ] ],
175 'foo%5Bbar%5D%5Bbar%5D=baz'
181 * @dataProvider provideArrayToCGI
182 * @covers ::wfArrayToCgi
184 public function testArrayToCGI( $array, $result ) {
185 $this->assertEquals( $result, wfArrayToCgi( $array ) );
189 * @covers ::wfArrayToCgi
191 public function testArrayToCGI2() {
196 [ 'foo' => 'bar', 'baz' => 'overridden value' ] ) );
199 public static function provideCgiToArray() {
202 [ 'foo=bar', [ 'foo' => 'bar' ] ], // string
203 [ 'foo=', [ 'foo' => '' ] ], // empty string
204 [ 'foo', [ 'foo' => '' ] ], // missing =
205 [ 'foo=bar&qwerty=asdf', [ 'foo' => 'bar', 'qwerty' => 'asdf' ] ], // multiple value
206 [ 'foo=A%26B%3D5%2B6%40%21%22%27', [ 'foo' => 'A&B=5+6@!"\'' ] ], // urldecoding test
207 [ 'foo%5Bbar%5D=baz', [ 'foo' => [ 'bar' => 'baz' ] ] ],
209 'foo%5Bbar%5D=baz&foo%5Bqwerty%5D=asdf',
210 [ 'foo' => [ 'bar' => 'baz', 'qwerty' => 'asdf' ] ]
212 [ 'foo%5B0%5D=bar&foo%5B1%5D=baz', [ 'foo' => [ 0 => 'bar', 1 => 'baz' ] ] ],
214 'foo%5Bbar%5D%5Bbar%5D=baz',
215 [ 'foo' => [ 'bar' => [ 'bar' => 'baz' ] ] ]
221 * @dataProvider provideCgiToArray
222 * @covers ::wfCgiToArray
224 public function testCgiToArray( $cgi, $result ) {
225 $this->assertEquals( $result, wfCgiToArray( $cgi ) );
228 public static function provideCgiRoundTrip() {
233 [ 'foo=bar&baz=biz' ],
234 [ 'foo=A%26B%3D5%2B6%40%21%22%27' ],
235 [ 'foo%5Bbar%5D=baz' ],
236 [ 'foo%5B0%5D=bar&foo%5B1%5D=baz' ],
237 [ 'foo%5Bbar%5D%5Bbar%5D=baz' ],
242 * @dataProvider provideCgiRoundTrip
243 * @covers ::wfArrayToCgi
245 public function testCgiRoundTrip( $cgi ) {
246 $this->assertEquals( $cgi, wfArrayToCgi( wfCgiToArray( $cgi ) ) );
250 * @covers ::mimeTypeMatch
252 public function testMimeTypeMatch() {
255 mimeTypeMatch( 'text/html',
256 [ 'application/xhtml+xml' => 1.0,
258 'text/plain' => 0.3 ] ) );
261 mimeTypeMatch( 'text/html',
263 'text/*' => 0.5 ] ) );
266 mimeTypeMatch( 'text/html',
267 [ '*/*' => 1.0 ] ) );
269 mimeTypeMatch( 'text/html',
270 [ 'image/png' => 1.0,
271 'image/svg+xml' => 0.5 ] ) );
275 * @covers ::wfNegotiateType
277 public function testNegotiateType() {
281 [ 'application/xhtml+xml' => 1.0,
285 [ 'text/html' => 1.0 ] ) );
287 'application/xhtml+xml',
289 [ 'application/xhtml+xml' => 1.0,
293 [ 'application/xhtml+xml' => 1.0,
294 'text/html' => 0.5 ] ) );
298 [ 'text/html' => 1.0,
301 'application/xhtml+xml' => 0.2 ],
302 [ 'application/xhtml+xml' => 1.0,
303 'text/html' => 0.5 ] ) );
310 [ 'application/xhtml+xml' => 1.0,
311 'text/html' => 0.5 ] ) );
315 [ 'application/xhtml+xml' => 1.0 ] ) );
320 * @covers ::wfDebugMem
322 public function testDebugFunctionTest() {
323 $debugLogFile = $this->getNewTempFile();
325 $this->setMwGlobals( [
326 'wgDebugLogFile' => $debugLogFile,
327 # @todo FIXME: $wgDebugTimestamps should be tested
328 'wgDebugTimestamps' => false
331 wfDebug( "This is a normal string" );
332 $this->assertEquals( "This is a normal string\n", file_get_contents( $debugLogFile ) );
333 unlink( $debugLogFile );
335 wfDebug( "This is nöt an ASCII string" );
336 $this->assertEquals( "This is nöt an ASCII string\n", file_get_contents( $debugLogFile ) );
337 unlink( $debugLogFile );
339 wfDebug( "\00305This has böth UTF and control chars\003" );
341 " 05This has böth UTF and control chars \n",
342 file_get_contents( $debugLogFile )
344 unlink( $debugLogFile );
347 $this->assertGreaterThan(
349 preg_replace( '/\D/', '', file_get_contents( $debugLogFile ) )
351 unlink( $debugLogFile );
354 $this->assertGreaterThan(
356 preg_replace( '/\D/', '', file_get_contents( $debugLogFile ) )
358 unlink( $debugLogFile );
362 * @covers ::wfClientAcceptsGzip
364 public function testClientAcceptsGzipTest() {
369 'compress, gzip' => true,
370 'gzip;q=1.0' => true,
373 'gzip;q=abcde' => true, // is this REALLY valid?
374 'gzip;q=12345678.9' => true,
378 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
379 $old_server_setting = $_SERVER['HTTP_ACCEPT_ENCODING'];
382 foreach ( $settings as $encoding => $expect ) {
383 $_SERVER['HTTP_ACCEPT_ENCODING'] = $encoding;
385 $this->assertEquals( $expect, wfClientAcceptsGzip( true ),
386 "'$encoding' => " . wfBoolToStr( $expect ) );
389 if ( isset( $old_server_setting ) ) {
390 $_SERVER['HTTP_ACCEPT_ENCODING'] = $old_server_setting;
395 * @covers ::wfPercent
397 public function testWfPercentTest() {
399 [ 6 / 7, '0.86%', 2, false ],
401 [ 22 / 7, '3.14286%', 5 ],
404 [ 10 / 3, '0%', -1 ],
405 [ 3 / 4 / 5, '0.1%', 1 ],
406 [ 6 / 7 * 8, '6.8571428571%', 10 ],
409 foreach ( $pcts as $pct ) {
410 if ( !isset( $pct[2] ) ) {
413 if ( !isset( $pct[3] ) ) {
417 $this->assertEquals( wfPercent( $pct[0], $pct[2], $pct[3] ), $pct[1], $pct[1] );
422 * test @see wfShorthandToInteger()
423 * @dataProvider provideShorthand
424 * @covers ::wfShorthandToInteger
426 public function testWfShorthandToInteger( $shorthand, $expected ) {
427 $this->assertEquals( $expected,
428 wfShorthandToInteger( $shorthand )
432 public static function provideShorthand() {
433 // Syntax: [ shorthand, expected integer ]
440 # Failures returns 0 :(
444 # Int, strings with spaces
453 [ '1m', 1024 * 1024 ],
454 [ '1M', 1024 * 1024 ],
455 [ '1g', 1024 * 1024 * 1024 ],
456 [ '1G', 1024 * 1024 * 1024 ],
479 public function testMerge_worksWithLessParameters() {
480 $this->markTestSkippedIfNoDiff3();
483 $successfulMerge = wfMerge( "old1\n\nold2", "old1\n\nnew2", "new1\n\nold2", $mergedText );
486 $conflictingMerge = wfMerge( 'old', 'old and mine', 'old and yours', $mergedText );
488 $this->assertEquals( true, $successfulMerge );
489 $this->assertEquals( false, $conflictingMerge );
493 * @param string $old Text as it was in the database
494 * @param string $mine Text submitted while user was editing
495 * @param string $yours Text submitted by the user
496 * @param bool $expectedMergeResult Whether the merge should be a success
497 * @param string $expectedText Text after merge has been completed
498 * @param string $expectedMergeAttemptResult Diff3 output if conflicts occur
500 * @dataProvider provideMerge()
504 public function testMerge( $old, $mine, $yours, $expectedMergeResult, $expectedText,
505 $expectedMergeAttemptResult ) {
506 $this->markTestSkippedIfNoDiff3();
509 $attemptMergeResult = null;
510 $isMerged = wfMerge( $old, $mine, $yours, $mergedText, $mergeAttemptResult );
512 $msg = 'Merge should be a ';
513 $msg .= $expectedMergeResult ?
'success' : 'failure';
514 $this->assertEquals( $expectedMergeResult, $isMerged, $msg );
515 $this->assertEquals( $expectedMergeAttemptResult, $mergeAttemptResult );
518 // Verify the merged text
519 $this->assertEquals( $expectedText, $mergedText,
520 'is merged text as expected?' );
524 public static function provideMerge() {
525 $EXPECT_MERGE_SUCCESS = true;
526 $EXPECT_MERGE_FAILURE = false;
532 "one one one\n" . // trimmed
537 "one one one ONE ONE\n" .
539 "two two two\n", // with tailing whitespace
544 "two two TWO TWO", // trimmed
547 $EXPECT_MERGE_SUCCESS,
550 "one one one ONE ONE\n" .
552 "two two TWO TWO\n", // note: will always end in a newline
554 // mergeAttemptResult:
558 // #1: conflict, fail
561 "one one one", // trimmed
564 "one one one ONE ONE\n" .
567 "\n", // with tailing whitespace
572 "two two", // trimmed
574 $EXPECT_MERGE_FAILURE,
579 // mergeAttemptResult:
590 * @dataProvider provideMakeUrlIndexes()
591 * @covers ::wfMakeUrlIndexes
593 public function testMakeUrlIndexes( $url, $expected ) {
594 $index = wfMakeUrlIndexes( $url );
595 $this->assertEquals( $expected, $index, "wfMakeUrlIndexes(\"$url\")" );
598 public static function provideMakeUrlIndexes() {
600 // Testcase for T30627
602 'https://example.org/test.cgi?id=12345',
603 [ 'https://org.example./test.cgi?id=12345' ]
606 // mailtos are handled special
607 // is this really right though? that final . probably belongs earlier?
608 'mailto:wiki@wikimedia.org',
609 [ 'mailto:org.wikimedia@wiki.' ]
612 // file URL cases per T30627...
614 // three slashes: local filesystem path Unix-style
615 'file:///whatever/you/like.txt',
616 [ 'file://./whatever/you/like.txt' ]
619 // three slashes: local filesystem path Windows-style
620 'file:///c:/whatever/you/like.txt',
621 [ 'file://./c:/whatever/you/like.txt' ]
624 // two slashes: UNC filesystem path Windows-style
625 'file://intranet/whatever/you/like.txt',
626 [ 'file://intranet./whatever/you/like.txt' ]
628 // Multiple-slash cases that can sorta work on Mozilla
629 // if you hack it just right are kinda pathological,
630 // and unreliable cross-platform or on IE which means they're
631 // unlikely to appear on intranets.
632 // Those will survive the algorithm but with results that
633 // are less consistent.
635 // protocol-relative URL cases per T31854...
637 '//example.org/test.cgi?id=12345',
639 'http://org.example./test.cgi?id=12345',
640 'https://org.example./test.cgi?id=12345'
647 * @dataProvider provideWfMatchesDomainList
648 * @covers ::wfMatchesDomainList
650 public function testWfMatchesDomainList( $url, $domains, $expected, $description ) {
651 $actual = wfMatchesDomainList( $url, $domains );
652 $this->assertEquals( $expected, $actual, $description );
655 public static function provideWfMatchesDomainList() {
657 $protocols = [ 'HTTP' => 'http:', 'HTTPS' => 'https:', 'protocol-relative' => '' ];
658 foreach ( $protocols as $pDesc => $p ) {
659 $a = array_merge( $a, [
661 "$p//www.example.com",
664 "No matches for empty domains array, $pDesc URL"
667 "$p//www.example.com",
668 [ 'www.example.com' ],
670 "Exact match in domains array, $pDesc URL"
673 "$p//www.example.com",
676 "Match without subdomain in domains array, $pDesc URL"
679 "$p//www.example2.com",
680 [ 'www.example.com', 'www.example2.com', 'www.example3.com' ],
682 "Exact match with other domains in array, $pDesc URL"
685 "$p//www.example2.com",
686 [ 'example.com', 'example2.com', 'example3,com' ],
688 "Match without subdomain with other domains in array, $pDesc URL"
691 "$p//www.example4.com",
692 [ 'example.com', 'example2.com', 'example3,com' ],
694 "Domain not in array, $pDesc URL"
697 "$p//nds-nl.wikipedia.org",
698 [ 'nl.wikipedia.org' ],
700 "Non-matching substring of domain, $pDesc URL"
709 * @covers ::wfMkdirParents
711 public function testWfMkdirParents() {
712 // Should not return true if file exists instead of directory
713 $fname = $this->getNewTempFile();
714 MediaWiki\
suppressWarnings();
715 $ok = wfMkdirParents( $fname );
716 MediaWiki\restoreWarnings
();
717 $this->assertFalse( $ok );
721 * @dataProvider provideWfShellWikiCmdList
722 * @covers ::wfShellWikiCmd
724 public function testWfShellWikiCmd( $script, $parameters, $options,
725 $expected, $description
727 if ( wfIsWindows() ) {
728 // Approximation that's good enough for our purposes just now
729 $expected = str_replace( "'", '"', $expected );
731 $actual = wfShellWikiCmd( $script, $parameters, $options );
732 $this->assertEquals( $expected, $actual, $description );
735 public function wfWikiID() {
736 $this->setMwGlobals( [
737 'wgDBname' => 'example',
745 $this->setMwGlobals( [
746 'wgDBname' => 'example',
747 'wgDBprefix' => 'mw_',
755 public function testWfMemcKey() {
756 $cache = ObjectCache
::getLocalClusterInstance();
758 $cache->makeKey( 'foo', 123, 'bar' ),
759 wfMemcKey( 'foo', 123, 'bar' )
763 public function testWfForeignMemcKey() {
764 $cache = ObjectCache
::getLocalClusterInstance();
765 $keyspace = $this->readAttribute( $cache, 'keyspace' );
767 wfForeignMemcKey( $keyspace, '', 'foo', 'bar' ),
768 $cache->makeKey( 'foo', 'bar' )
772 public function testWfGlobalCacheKey() {
773 $cache = ObjectCache
::getLocalClusterInstance();
775 $cache->makeGlobalKey( 'foo', 123, 'bar' ),
776 wfGlobalCacheKey( 'foo', 123, 'bar' )
780 public static function provideWfShellWikiCmdList() {
784 [ 'eval.php', [ '--help', '--test' ], [],
785 "'$wgPhpCli' 'eval.php' '--help' '--test'",
786 "Called eval.php --help --test" ],
787 [ 'eval.php', [ '--help', '--test space' ], [ 'php' => 'php5' ],
788 "'php5' 'eval.php' '--help' '--test space'",
789 "Called eval.php --help --test with php option" ],
790 [ 'eval.php', [ '--help', '--test', 'X' ], [ 'wrapper' => 'MWScript.php' ],
791 "'$wgPhpCli' 'MWScript.php' 'eval.php' '--help' '--test' 'X'",
792 "Called eval.php --help --test with wrapper option" ],
795 [ '--help', '--test', 'y' ],
796 [ 'php' => 'php5', 'wrapper' => 'MWScript.php' ],
797 "'php5' 'MWScript.php' 'eval.php' '--help' '--test' 'y'",
798 "Called eval.php --help --test with wrapper and php option"
802 /* @todo many more! */