SideBarTest.php

Go to the documentation of this file.

<?php

class SideBarTest extends MediaWikiLangTestCase {

    private $skin;
    private $messages;

    private function initMessagesHref() {
        # List of default messages for the sidebar. The sidebar doesn't care at
        # all whether they are full URLs, interwiki links or local titles.
        $URL_messages = array(
            'mainpage',
            'portal-url',
            'currentevents-url',
            'recentchanges-url',
            'randompage-url',
            'helppage',
        );

        # We're assuming that isValidURI works as advertised: it's also
        # tested separately, in tests/phpunit/includes/HttpTest.php.
        foreach ( $URL_messages as $m ) {
            $titleName = MessageCache::singleton()->get( $m );
            if ( Http::isValidURI( $titleName ) ) {
                $this->messages[$m]['href'] = $titleName;
            } else {
                $title = Title::newFromText( $titleName );
                $this->messages[$m]['href'] = $title->getLocalURL();
            }
        }
    }

    protected function setUp() {
        parent::setUp();
        $this->initMessagesHref();
        $this->skin = new SkinTemplate();
        $this->skin->getContext()->setLanguage( Language::factory( 'en' ) );
    }

    private function assertSideBar( $expected, $text, $message = '' ) {
        $bar = array();
        $this->skin->addToSidebarPlain( $bar, $text );
        $this->assertEquals( $expected, $bar, $message );
    }

    public function testSidebarWithOnlyTwoTitles() {
        $this->assertSideBar(
            array(
                'Title1' => array(),
                'Title2' => array(),
            ),
            '* Title1
* Title2
'
        );
    }

    public function testExpandMessages() {
        $this->assertSidebar(
            array( 'Title' => array(
                array(
                    'text' => 'Help',
                    'href' => $this->messages['helppage']['href'],
                    'id' => 'n-help',
                    'active' => null
                )
            ) ),
            '* Title
** helppage|help
'
        );
    }

    public function testExternalUrlsRequireADescription() {
        $this->setMwGlobals( array(
            'wgNoFollowLinks' => true,
            'wgNoFollowDomainExceptions' => array(),
            'wgNoFollowNsExceptions' => array(),
        ) );
        $this->assertSidebar(
            array( 'Title' => array(
                # ** http://www.mediawiki.org/| Home
                array(
                    'text' => 'Home',
                    'href' => 'http://www.mediawiki.org/',
                    'id' => 'n-Home',
                    'active' => null,
                    'rel' => 'nofollow',
                ),
                # ** http://valid.no.desc.org/
                # ... skipped since it is missing a pipe with a description
            ) ),
            '* Title
** http://www.mediawiki.org/| Home
** http://valid.no.desc.org/
'
        );
    }

    public function testTrickyPipe() {
        $this->assertSidebar(
            array( 'Title' => array(
                # The first 2 are skipped
                # Doesn't really test the url properly
                # because it will vary with $wgArticlePath et al.
                # ** Baz|Fred
                array(
                    'text' => 'Fred',
                    'href' => Title::newFromText( 'Baz' )->getLocalURL(),
                    'id' => 'n-Fred',
                    'active' => null,
                ),
                array(
                    'text' => 'title-to-display',
                    'href' => Title::newFromText( 'page-to-go-to' )->getLocalURL(),
                    'id' => 'n-title-to-display',
                    'active' => null,
                ),
            ) ),
            '* Title
** {{PAGENAME|Foo}}
** Bar
** Baz|Fred
** {{PLURAL:1|page-to-go-to{{int:pipe-separator/en}}title-to-display|branch not taken}}
'
        );
    }

    #### Attributes for external links ##########################
    private function getAttribs() {
        # Sidebar text we will use everytime
        $text = '* Title
** http://www.mediawiki.org/| Home';

        $bar = array();
        $this->skin->addToSideBarPlain( $bar, $text );

        return $bar['Title'][0];
    }

    public function testTestAttributesAssertionHelper() {
        $this->setMwGlobals( array(
            'wgNoFollowLinks' => true,
            'wgNoFollowDomainExceptions' => array(),
            'wgNoFollowNsExceptions' => array(),
            'wgExternalLinkTarget' => false,
        ) );
        $attribs = $this->getAttribs();

        $this->assertArrayHasKey( 'rel', $attribs );
        $this->assertEquals( 'nofollow', $attribs['rel'] );

        $this->assertArrayNotHasKey( 'target', $attribs );
    }

    public function testRespectWgnofollowlinks() {
        $this->setMwGlobals( 'wgNoFollowLinks', false );

        $attribs = $this->getAttribs();
        $this->assertArrayNotHasKey( 'rel', $attribs,
            'External URL in sidebar do not have rel=nofollow when $wgNoFollowLinks = false'
        );
    }

    public function testRespectExternallinktarget( $externalLinkTarget ) {
        $this->setMwGlobals( 'wgExternalLinkTarget', $externalLinkTarget );

        $attribs = $this->getAttribs();
        $this->assertArrayHasKey( 'target', $attribs );
        $this->assertEquals( $attribs['target'], $externalLinkTarget );
    }

    public static function dataRespectExternallinktarget() {
        return array(
            array( '_blank' ),
            array( '_self' ),
        );
    }
}