RCCacheEntryFactoryTest.php

Go to the documentation of this file.

<?php

class RCCacheEntryFactoryTest extends MediaWikiLangTestCase {
    protected function setUp() {
        parent::setUp();

        $this->setMwGlobals( array(
            'wgArticlePath' => '/wiki/$1'
        ) );
    }

    public function testNewFromRecentChange( $expected, $context, $messages,
        $recentChange, $watched
    ) {
        $cacheEntryFactory = new RCCacheEntryFactory( $context, $messages );
        $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, $watched );

        $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );

        $this->assertEquals( $watched, $cacheEntry->watched, 'watched' );
        $this->assertEquals( $expected['timestamp'], $cacheEntry->timestamp, 'timestamp' );
        $this->assertEquals(
            $expected['numberofWatchingusers'], $cacheEntry->numberofWatchingusers,
            'watching users'
        );
        $this->assertEquals( $expected['unpatrolled'], $cacheEntry->unpatrolled, 'unpatrolled' );

        $this->assertUserLinks( 'Mary', $cacheEntry );
        $this->assertTitleLink( 'Xyz', $cacheEntry );

        $this->assertQueryLink( 'cur', $expected['cur'], $cacheEntry->curlink, 'cur link' );
        $this->assertQueryLink( 'prev', $expected['diff'], $cacheEntry->lastlink, 'prev link' );
        $this->assertQueryLink( 'diff', $expected['diff'], $cacheEntry->difflink, 'diff link' );
    }

    public function editChangeProvider() {
        return array(
            array(
                array(
                    'title' => 'Xyz',
                    'user' => 'Mary',
                    'diff' => array( 'curid' => 5, 'diff' => 191, 'oldid' => 190 ),
                    'cur' => array( 'curid' => 5, 'diff' => 0, 'oldid' => 191 ),
                    'timestamp' => '21:21',
                    'numberofWatchingusers' => 0,
                    'unpatrolled' => false
                ),
                $this->getContext(),
                $this->getMessages(),
                $this->makeEditRecentChange(
                    'Xyz',
                    $this->getTestUser(),
                    5, // curid
                    191, // thisid
                    190, // lastid
                    '20131103212153',
                    0, // counter
                    0 // number of watching users
                ),
                false,
                'edit'
            )
        );
    }

    private function makeEditRecentChange( $title, $user, $curid, $thisid, $lastid,
        $timestamp, $counter, $watchingUsers
    ) {

        $attribs = array_merge(
            $this->getDefaultAttributes( $title, $timestamp ),
            array(
                'rc_user' => $user->getId(),
                'rc_user_text' => $user->getName(),
                'rc_this_oldid' => $thisid,
                'rc_last_oldid' => $lastid,
                'rc_cur_id' => $curid
            )
        );

        return $this->makeRecentChange( $attribs, $counter, $watchingUsers );
    }

    public function testNewForDeleteChange( $expected, $context, $messages, $recentChange, $watched ) {
        $cacheEntryFactory = new RCCacheEntryFactory( $context, $messages );
        $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, $watched );

        $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );

        $this->assertEquals( $watched, $cacheEntry->watched, 'watched' );
        $this->assertEquals( $expected['timestamp'], $cacheEntry->timestamp, 'timestamp' );
        $this->assertEquals(
            $expected['numberofWatchingusers'],
            $cacheEntry->numberofWatchingusers, 'watching users'
        );
        $this->assertEquals( $expected['unpatrolled'], $cacheEntry->unpatrolled, 'unpatrolled' );

        $this->assertDeleteLogLink( $cacheEntry );
        $this->assertUserLinks( 'Mary', $cacheEntry );

        $this->assertEquals( 'cur', $cacheEntry->curlink, 'cur link for delete log or rev' );
        $this->assertEquals( 'diff', $cacheEntry->difflink, 'diff link for delete log or rev' );
        $this->assertEquals( 'prev', $cacheEntry->lastlink, 'pref link for delete log or rev' );
    }

    public function deleteChangeProvider() {
        return array(
            array(
                array(
                    'title' => 'Abc',
                    'user' => 'Mary',
                    'timestamp' => '21:21',
                    'numberofWatchingusers' => 0,
                    'unpatrolled' => false
                ),
                $this->getContext(),
                $this->getMessages(),
                $this->makeLogRecentChange(
                    'Abc',
                    $this->getTestUser(),
                    '20131103212153',
                    0, // counter
                    0 // number of watching users
                ),
                false,
                'delete'
            )
        );
    }

    private function makeLogRecentChange( $title, $user, $timestamp, $counter, $watchingUsers ) {
        $attribs = array_merge(
            $this->getDefaultAttributes( $title, $timestamp ),
            array(
                'rc_cur_id' => 0,
                'rc_user' => $user->getId(),
                'rc_user_text' => $user->getName(),
                'rc_this_oldid' => 0,
                'rc_last_oldid' => 0,
                'rc_old_len' => null,
                'rc_new_len' => null,
                'rc_type' => 3,
                'rc_logid' => 25,
                'rc_log_type' => 'delete',
                'rc_log_action' => 'delete'
            )
        );

        return $this->makeRecentChange( $attribs, $counter, $watchingUsers );
    }

    public function testNewForRevUserDeleteChange( $expected, $context, $messages,
        $recentChange, $watched
    ) {
        $cacheEntryFactory = new RCCacheEntryFactory( $context, $messages );
        $cacheEntry = $cacheEntryFactory->newFromRecentChange( $recentChange, $watched );

        $this->assertInstanceOf( 'RCCacheEntry', $cacheEntry );

        $this->assertEquals( $watched, $cacheEntry->watched, 'watched' );
        $this->assertEquals( $expected['timestamp'], $cacheEntry->timestamp, 'timestamp' );
        $this->assertEquals(
            $expected['numberofWatchingusers'],
            $cacheEntry->numberofWatchingusers, 'watching users'
        );
        $this->assertEquals( $expected['unpatrolled'], $cacheEntry->unpatrolled, 'unpatrolled' );

        $this->assertRevDel( $cacheEntry );
        $this->assertTitleLink( 'Zzz', $cacheEntry );

        $this->assertEquals( 'cur', $cacheEntry->curlink, 'cur link for delete log or rev' );
        $this->assertEquals( 'diff', $cacheEntry->difflink, 'diff link for delete log or rev' );
        $this->assertEquals( 'prev', $cacheEntry->lastlink, 'pref link for delete log or rev' );
    }

    public function revUserDeleteProvider() {
        return array(
            array(
                array(
                    'title' => 'Zzz',
                    'user' => 'Mary',
                    'diff' => '',
                    'cur' => '',
                    'timestamp' => '21:21',
                    'numberofWatchingusers' => 0,
                    'unpatrolled' => false
                ),
                $this->getContext(),
                $this->getMessages(),
                $this->makeDeletedEditRecentChange(
                    'Zzz',
                    $this->getTestUser(),
                    '20131103212153',
                    191, // thisid
                    190, // lastid
                    '20131103212153',
                    0, // counter
                    0 // number of watching users
                ),
                false,
                'deletedrevuser'
            )
        );
    }

    private function makeDeletedEditRecentChange( $title, $user, $timestamp, $curid, $thisid,
        $lastid, $counter, $watchingUsers
    ) {
        $attribs = array_merge(
            $this->getDefaultAttributes( $title, $timestamp ),
            array(
                'rc_user' => $user->getId(),
                'rc_user_text' => $user->getName(),
                'rc_deleted' => 5,
                'rc_cur_id' => $curid,
                'rc_this_oldid' => $thisid,
                'rc_last_oldid' => $lastid
            )
        );

        return $this->makeRecentChange( $attribs, $counter, $watchingUsers );
    }

    private function assertUserLinks( $user, $cacheEntry ) {
        $this->assertTag(
            array(
                'tag' => 'a',
                'attributes' => array(
                    'class' => 'new mw-userlink'
                ),
                'content' => $user
            ),
            $cacheEntry->userlink,
            'verify user link'
        );

        $this->assertTag(
            array(
                'tag' => 'span',
                'attributes' => array(
                    'class' => 'mw-usertoollinks'
                ),
                'child' => array(
                    'tag' => 'a',
                    'content' => 'Talk',
                )
            ),
            $cacheEntry->usertalklink,
            'verify user talk link'
        );

        $this->assertTag(
            array(
                'tag' => 'span',
                'attributes' => array(
                    'class' => 'mw-usertoollinks'
                ),
                'child' => array(
                    'tag' => 'a',
                    'content' => 'contribs',
                )
            ),
            $cacheEntry->usertalklink,
            'verify user tool links'
        );
    }

    private function assertDeleteLogLink( $cacheEntry ) {
        $this->assertTag(
            array(
                'tag' => 'a',
                'attributes' => array(
                    'href' => '/wiki/Special:Log/delete',
                    'title' => 'Special:Log/delete'
                ),
                'content' => 'Deletion log'
            ),
            $cacheEntry->link,
            'verify deletion log link'
        );
    }

    private function assertRevDel( $cacheEntry ) {
        $this->assertTag(
            array(
                'tag' => 'span',
                'attributes' => array(
                    'class' => 'history-deleted'
                ),
                'content' => '(username removed)'
            ),
            $cacheEntry->userlink,
            'verify user link for change with deleted revision and user'
        );
    }

    private function assertTitleLink( $title, $cacheEntry ) {
        $this->assertTag(
            array(
                'tag' => 'a',
                'attributes' => array(
                    'href' => '/wiki/' . $title,
                    'title' => $title
                ),
                'content' => $title
            ),
            $cacheEntry->link,
            'verify title link'
        );
    }

    private function assertQueryLink( $content, $params, $link ) {
        $this->assertTag(
            array(
                'tag' => 'a',
                'content' => $content
            ),
            $link,
            'assert query link element'
        );

        foreach ( $params as $key => $value ) {
            $this->assertRegExp( '/' . $key . '=' . $value . '/', $link, "verify $key link params" );
        }
    }

    private function makeRecentChange( $attribs, $counter, $watchingUsers ) {
        $change = new RecentChange();
        $change->setAttribs( $attribs );
        $change->counter = $counter;
        $change->numberofWatchingusers = $watchingUsers;

        return $change;
    }

    private function getDefaultAttributes( $title, $timestamp ) {
        return array(
            'rc_id' => 545,
            'rc_user' => 0,
            'rc_user_text' => '127.0.0.1',
            'rc_ip' => '127.0.0.1',
            'rc_title' => $title,
            'rc_namespace' => 0,
            'rc_timestamp' => $timestamp,
            'rc_cur_time' => $timestamp,
            'rc_old_len' => 212,
            'rc_new_len' => 188,
            'rc_comment' => '',
            'rc_minor' => 0,
            'rc_bot' => 0,
            'rc_type' => 0,
            'rc_patrolled' => 1,
            'rc_deleted' => 0,
            'rc_logid' => 0,
            'rc_log_type' => null,
            'rc_log_action' => '',
            'rc_params' => '',
            'rc_source' => 'mw.edit'
        );
    }

    private function getTestUser() {
        $user = User::newFromName( 'Mary' );

        if ( !$user->getId() ) {
            $user->addToDatabase();
        }

        return $user;
    }

    private function getMessages() {
        return array(
            'cur' => 'cur',
            'diff' => 'diff',
            'hist' => 'hist',
            'enhancedrc-history' => 'history',
            'last' => 'prev',
            'blocklink' => 'block',
            'history' => 'Page history',
            'semicolon-separator' => '; ',
            'pipe-separator' => ' | '
        );
    }

    private function getContext() {
        $title = Title::newFromText( 'RecentChanges', NS_SPECIAL );

        $context = new RequestContext();
        $context->setTitle( $title );
        $context->setLanguage( Language::factory( 'en' ) );

        $user = $this->getTestUser();
        $context->setUser( $user );

        return $context;
    }
}