TitleTest.php

Go to the documentation of this file.

<?php

class TitleTest extends MediaWikiTestCase {
        protected function setUp() {
                parent::setUp();

                $this->setMwGlobals( array(
                        'wgLanguageCode' => 'en',
                        'wgContLang' => Language::factory( 'en' ),
                        // User language
                        'wgLang' => Language::factory( 'en' ),
                        'wgAllowUserJs' => false,
                        'wgDefaultLanguageVariant' => false,
                ) );
        }

        function testLegalChars() {
                $titlechars = Title::legalChars();

                foreach ( range( 1, 255 ) as $num ) {
                        $chr = chr( $num );
                        if ( strpos( "#[]{}<>|", $chr ) !== false || preg_match( "/[\\x00-\\x1f\\x7f]/", $chr ) ) {
                                $this->assertFalse( (bool)preg_match( "/[$titlechars]/", $chr ), "chr($num) = $chr is not a valid titlechar" );
                        } else {
                                $this->assertTrue( (bool)preg_match( "/[$titlechars]/", $chr ), "chr($num) = $chr is a valid titlechar" );
                        }
                }
        }

        function testBug31100FixSpecialName( $text, $expectedParam ) {
                $title = Title::newFromText( $text );
                $fixed = $title->fixSpecialName();
                $stuff = explode( '/', $fixed->getDbKey(), 2 );
                if ( count( $stuff ) == 2 ) {
                        $par = $stuff[1];
                } else {
                        $par = null;
                }
                $this->assertEquals( $expectedParam, $par, "Bug 31100 regression check: Title->fixSpecialName() should preserve parameter" );
        }

        public static function provideBug31100() {
                return array(
                        array( 'Special:Version', null ),
                        array( 'Special:Version/', '' ),
                        array( 'Special:Version/param', 'param' ),
                );
        }

        function testIsValidMoveOperation( $source, $target, $expected ) {
                $title = Title::newFromText( $source );
                $nt = Title::newFromText( $target );
                $errors = $title->isValidMoveOperation( $nt, false );
                if ( $expected === true ) {
                        $this->assertTrue( $errors );
                } else {
                        $errors = $this->flattenErrorsArray( $errors );
                        foreach ( (array)$expected as $error ) {
                                $this->assertContains( $error, $errors );
                        }
                }
        }

        function dataTestIsValidMoveOperation() {
                return array(
                        array( 'Test', 'Test', 'selfmove' ),
                        array( 'File:Test.jpg', 'Page', 'imagenocrossnamespace' )
                );
        }

        function testWgWhitelistReadRegexp( $whitelistRegexp, $source, $action, $expected ) {
                // $wgWhitelistReadRegexp must be an array. Since the provided test cases
                // usually have only one regex, it is more concise to write the lonely regex
                // as a string. Thus we cast to an array() to honor $wgWhitelistReadRegexp
                // type requisite.
                if ( is_string( $whitelistRegexp ) ) {
                        $whitelistRegexp = array( $whitelistRegexp );
                }

                $title = Title::newFromDBkey( $source );

                global $wgGroupPermissions;
                $oldPermissions = $wgGroupPermissions;
                // Disallow all so we can ensure our regex works
                $wgGroupPermissions = array();
                $wgGroupPermissions['*']['read'] = false;

                global $wgWhitelistRead;
                $oldWhitelist = $wgWhitelistRead;
                // Undo any LocalSettings explicite whitelists so they won't cause a
                // failing test to succeed. Set it to some random non sense just
                // to make sure we properly test Title::checkReadPermissions()
                $wgWhitelistRead = array( 'some random non sense title' );

                global $wgWhitelistReadRegexp;
                $oldWhitelistRegexp = $wgWhitelistReadRegexp;
                $wgWhitelistReadRegexp = $whitelistRegexp;

                // Just use $wgUser which in test is a user object for '127.0.0.1'
                global $wgUser;
                // Invalidate user rights cache to take in account $wgGroupPermissions
                // change above.
                $wgUser->clearInstanceCache();
                $errors = $title->userCan( $action, $wgUser );

                // Restore globals
                $wgGroupPermissions = $oldPermissions;
                $wgWhitelistRead = $oldWhitelist;
                $wgWhitelistReadRegexp = $oldWhitelistRegexp;

                if ( is_bool( $expected ) ) {
                        # Forge the assertion message depending on the assertion expectation
                        $allowableness = $expected
                                ? " should be allowed"
                                : " should NOT be allowed";
                        $this->assertEquals( $expected, $errors, "User action '$action' on [[$source]] $allowableness." );
                } else {
                        $errors = $this->flattenErrorsArray( $errors );
                        foreach ( (array)$expected as $error ) {
                                $this->assertContains( $error, $errors );
                        }
                }
        }

        function dataWgWhitelistReadRegexp() {
                $ALLOWED = true;
                $DISALLOWED = false;

                return array(
                        // Everything, if this doesn't work, we're really in trouble
                        array( '/.*/', 'Main_Page', 'read', $ALLOWED ),
                        array( '/.*/', 'Main_Page', 'edit', $DISALLOWED ),

                        // We validate against the title name, not the db key
                        array( '/^Main_Page$/', 'Main_Page', 'read', $DISALLOWED ),
                        // Main page
                        array( '/^Main/', 'Main_Page', 'read', $ALLOWED ),
                        array( '/^Main.*/', 'Main_Page', 'read', $ALLOWED ),
                        // With spaces
                        array( '/Mic\sCheck/', 'Mic Check', 'read', $ALLOWED ),
                        // Unicode multibyte
                        // ...without unicode modifier
                        array( '/Unicode Test . Yes/', 'Unicode Test Ñ Yes', 'read', $DISALLOWED ),
                        // ...with unicode modifier
                        array( '/Unicode Test . Yes/u', 'Unicode Test Ñ Yes', 'read', $ALLOWED ),
                        // Case insensitive
                        array( '/MiC ChEcK/', 'mic check', 'read', $DISALLOWED ),
                        array( '/MiC ChEcK/i', 'mic check', 'read', $ALLOWED ),

                        // From DefaultSettings.php:
                        array( "@^UsEr.*@i", 'User is banned', 'read', $ALLOWED ),
                        array( "@^UsEr.*@i", 'User:John Doe', 'read', $ALLOWED ),

                        // With namespaces:
                        array( '/^Special:NewPages$/', 'Special:NewPages', 'read', $ALLOWED ),
                        array( null, 'Special:Newpages', 'read', $DISALLOWED ),

                );
        }

        function flattenErrorsArray( $errors ) {
                $result = array();
                foreach ( $errors as $error ) {
                        $result[] = $error[0];
                }
                return $result;
        }

        public static function provideTestIsValidMoveOperation() {
                return array(
                        array( 'Test', 'Test', 'selfmove' ),
                        array( 'File:Test.jpg', 'Page', 'imagenocrossnamespace' )
                );
        }

        function testGetpageviewlanguage( $expected, $titleText, $contLang, $lang, $variant, $msg = '' ) {
                global $wgLanguageCode, $wgContLang, $wgLang, $wgDefaultLanguageVariant, $wgAllowUserJs;

                // Setup environnement for this test
                $wgLanguageCode = $contLang;
                $wgContLang = Language::factory( $contLang );
                $wgLang = Language::factory( $lang );
                $wgDefaultLanguageVariant = $variant;
                $wgAllowUserJs = true;

                $title = Title::newFromText( $titleText );
                $this->assertInstanceOf( 'Title', $title,
                        "Test must be passed a valid title text, you gave '$titleText'"
                );
                $this->assertEquals( $expected,
                        $title->getPageViewLanguage()->getCode(),
                        $msg
                );
        }

        function provideCasesForGetpageviewlanguage() {
                # Format:
                # - expected
                # - Title name
                # - wgContLang (expected in most case)
                # - wgLang (on some specific pages)
                # - wgDefaultLanguageVariant
                # - Optional message
                return array(
                        array( 'fr', 'Help:I_need_somebody', 'fr', 'fr', false ),
                        array( 'es', 'Help:I_need_somebody', 'es', 'zh-tw', false ),
                        array( 'zh', 'Help:I_need_somebody', 'zh', 'zh-tw', false ),

                        array( 'es', 'Help:I_need_somebody', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'es', 'MediaWiki:About', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'es', 'MediaWiki:About/', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'de', 'MediaWiki:About/de', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'MediaWiki:Common.js', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'MediaWiki:Common.css', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'User:JohnDoe/Common.js', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'User:JohnDoe/Monobook.css', 'es', 'zh-tw', 'zh-cn' ),

                        array( 'zh-cn', 'Help:I_need_somebody', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'zh', 'MediaWiki:About', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'zh', 'MediaWiki:About/', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'de', 'MediaWiki:About/de', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'zh-cn', 'MediaWiki:About/zh-cn', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'zh-tw', 'MediaWiki:About/zh-tw', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'MediaWiki:Common.js', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'MediaWiki:Common.css', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'User:JohnDoe/Common.js', 'zh', 'zh-tw', 'zh-cn' ),
                        array( 'en', 'User:JohnDoe/Monobook.css', 'zh', 'zh-tw', 'zh-cn' ),

                        array( 'zh-tw', 'Special:NewPages', 'es', 'zh-tw', 'zh-cn' ),
                        array( 'zh-tw', 'Special:NewPages', 'zh', 'zh-tw', 'zh-cn' ),

                );
        }

        function testExtractingBaseTextFromTitle( $title, $expected, $msg = '' ) {
                $title = Title::newFromText( $title );
                $this->assertEquals( $expected,
                        $title->getBaseText(),
                        $msg
                );
        }

        function provideBaseTitleCases() {
                return array(
                        # Title, expected base, optional message
                        array( 'User:John_Doe/subOne/subTwo', 'John Doe/subOne' ),
                        array( 'User:Foo/Bar/Baz', 'Foo/Bar' ),
                );
        }

        function testExtractingRootTextFromTitle( $title, $expected, $msg = '' ) {
                $title = Title::newFromText( $title );
                $this->assertEquals( $expected,
                        $title->getRootText(),
                        $msg
                );
        }

        public static function provideRootTitleCases() {
                return array(
                        # Title, expected base, optional message
                        array( 'User:John_Doe/subOne/subTwo', 'John Doe' ),
                        array( 'User:Foo/Bar/Baz', 'Foo' ),
                );
        }

        function testExtractingSubpageTextFromTitle( $title, $expected, $msg = '' ) {
                $title = Title::newFromText( $title );
                $this->assertEquals( $expected,
                        $title->getSubpageText(),
                        $msg
                );
        }

        function provideSubpageTitleCases() {
                return array(
                        # Title, expected base, optional message
                        array( 'User:John_Doe/subOne/subTwo', 'subTwo' ),
                        array( 'User:John_Doe/subOne', 'subOne' ),
                );
        }
}