LinksUpdateTest.php

Go to the documentation of this file.

<?php

class LinksUpdateTest extends MediaWikiLangTestCase {
    protected static $testingPageId;

    function __construct( $name = null, array $data = [], $dataName = '' ) {
        parent::__construct( $name, $data, $dataName );

        $this->tablesUsed = array_merge( $this->tablesUsed,
            [
                'interwiki',
                'page_props',
                'pagelinks',
                'categorylinks',
                'langlinks',
                'externallinks',
                'imagelinks',
                'templatelinks',
                'iwlinks',
                'recentchanges',
            ]
        );
    }

    protected function setUp() {
        parent::setUp();
        $dbw = wfGetDB( DB_MASTER );
        $dbw->replace(
            'interwiki',
            [ 'iw_prefix' ],
            [
                'iw_prefix' => 'linksupdatetest',
                'iw_url' => 'http://testing.com/wiki/$1',
                'iw_api' => 'http://testing.com/w/api.php',
                'iw_local' => 0,
                'iw_trans' => 0,
                'iw_wikiid' => 'linksupdatetest',
            ]
        );
        $this->setMwGlobals( 'wgRCWatchCategoryMembership', true );
    }

    public function addDBDataOnce() {
        $res = $this->insertPage( 'Testing' );
        self::$testingPageId = $res['id'];
        $this->insertPage( 'Some_other_page' );
        $this->insertPage( 'Template:TestingTemplate' );
    }

    protected function makeTitleAndParserOutput( $name, $id ) {
        $t = Title::newFromText( $name );
        $t->mArticleID = $id; # XXX: this is fugly

        $po = new ParserOutput();
        $po->setTitleText( $t->getPrefixedText() );

        return [ $t, $po ];
    }

    public function testUpdate_pagelinks() {
        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $po->addLink( Title::newFromText( "Foo" ) );
        $po->addLink( Title::newFromText( "Special:Foo" ) ); // special namespace should be ignored
        $po->addLink( Title::newFromText( "linksupdatetest:Foo" ) ); // interwiki link should be ignored
        $po->addLink( Title::newFromText( "#Foo" ) ); // hash link should be ignored

        $update = $this->assertLinksUpdate(
            $t,
            $po,
            'pagelinks',
            'pl_namespace,
            pl_title',
            'pl_from = ' . self::$testingPageId,
            [ [ NS_MAIN, 'Foo' ] ]
        );
        $this->assertArrayEquals( [
            Title::makeTitle( NS_MAIN, 'Foo' ),  // newFromText doesn't yield the same internal state....
        ], $update->getAddedLinks() );

        $po = new ParserOutput();
        $po->setTitleText( $t->getPrefixedText() );

        $po->addLink( Title::newFromText( "Bar" ) );
        $po->addLink( Title::newFromText( "Talk:Bar" ) );

        $update = $this->assertLinksUpdate(
            $t,
            $po,
            'pagelinks',
            'pl_namespace,
            pl_title',
            'pl_from = ' . self::$testingPageId,
            [
                [ NS_MAIN, 'Bar' ],
                [ NS_TALK, 'Bar' ],
            ]
        );
        $this->assertArrayEquals( [
            Title::makeTitle( NS_MAIN, 'Bar' ),
            Title::makeTitle( NS_TALK, 'Bar' ),
        ], $update->getAddedLinks() );
        $this->assertArrayEquals( [
            Title::makeTitle( NS_MAIN, 'Foo' ),
        ], $update->getRemovedLinks() );
    }

    public function testUpdate_externallinks() {
        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $po->addExternalLink( "http://testing.com/wiki/Foo" );

        $this->assertLinksUpdate(
            $t,
            $po,
            'externallinks',
            'el_to, el_index',
            'el_from = ' . self::$testingPageId,
            [
                [ 'http://testing.com/wiki/Foo', 'http://com.testing./wiki/Foo' ],
            ]
        );
    }

    public function testUpdate_categorylinks() {
        $this->setMwGlobals( 'wgCategoryCollation', 'uppercase' );

        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $po->addCategory( "Foo", "FOO" );

        $this->assertLinksUpdate(
            $t,
            $po,
            'categorylinks',
            'cl_to, cl_sortkey',
            'cl_from = ' . self::$testingPageId,
            [ [ 'Foo', "FOO\nTESTING" ] ]
        );
    }

    public function testOnAddingAndRemovingCategory_recentChangesRowIsAdded() {
        $this->setMwGlobals( 'wgCategoryCollation', 'uppercase' );

        $title = Title::newFromText( 'Testing' );
        $wikiPage = new WikiPage( $title );
        $wikiPage->doEditContent( new WikitextContent( '[[Category:Foo]]' ), 'added category' );
        $this->runAllRelatedJobs();

        $this->assertRecentChangeByCategorization(
            $title,
            $wikiPage->getParserOutput( new ParserOptions() ),
            Title::newFromText( 'Category:Foo' ),
            [ [ 'Foo', '[[:Testing]] added to category' ] ]
        );

        $wikiPage->doEditContent( new WikitextContent( '[[Category:Bar]]' ), 'replaced category' );
        $this->runAllRelatedJobs();

        $this->assertRecentChangeByCategorization(
            $title,
            $wikiPage->getParserOutput( new ParserOptions() ),
            Title::newFromText( 'Category:Foo' ),
            [
                [ 'Foo', '[[:Testing]] added to category' ],
                [ 'Foo', '[[:Testing]] removed from category' ],
            ]
        );

        $this->assertRecentChangeByCategorization(
            $title,
            $wikiPage->getParserOutput( new ParserOptions() ),
            Title::newFromText( 'Category:Bar' ),
            [
                [ 'Bar', '[[:Testing]] added to category' ],
            ]
        );
    }

    public function testOnAddingAndRemovingCategoryToTemplates_embeddingPagesAreIgnored() {
        $this->setMwGlobals( 'wgCategoryCollation', 'uppercase' );

        $templateTitle = Title::newFromText( 'Template:TestingTemplate' );
        $templatePage = new WikiPage( $templateTitle );

        $wikiPage = new WikiPage( Title::newFromText( 'Testing' ) );
        $wikiPage->doEditContent( new WikitextContent( '{{TestingTemplate}}' ), 'added template' );
        $this->runAllRelatedJobs();

        $otherWikiPage = new WikiPage( Title::newFromText( 'Some_other_page' ) );
        $otherWikiPage->doEditContent( new WikitextContent( '{{TestingTemplate}}' ), 'added template' );
        $this->runAllRelatedJobs();

        $this->assertRecentChangeByCategorization(
            $templateTitle,
            $templatePage->getParserOutput( new ParserOptions() ),
            Title::newFromText( 'Baz' ),
            []
        );

        $templatePage->doEditContent( new WikitextContent( '[[Category:Baz]]' ), 'added category' );
        $this->runAllRelatedJobs();

        $this->assertRecentChangeByCategorization(
            $templateTitle,
            $templatePage->getParserOutput( new ParserOptions() ),
            Title::newFromText( 'Baz' ),
            [ [
                'Baz',
                '[[:Template:TestingTemplate]] added to category, ' .
                '[[Special:WhatLinksHere/Template:TestingTemplate|this page is included within other pages]]'
            ] ]
        );
    }

    public function testUpdate_iwlinks() {
        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $target = Title::makeTitleSafe( NS_MAIN, "Foo", '', 'linksupdatetest' );
        $po->addInterwikiLink( $target );

        $this->assertLinksUpdate(
            $t,
            $po,
            'iwlinks',
            'iwl_prefix, iwl_title',
            'iwl_from = ' . self::$testingPageId,
            [ [ 'linksupdatetest', 'Foo' ] ]
        );
    }

    public function testUpdate_templatelinks() {
        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $po->addTemplate( Title::newFromText( "Template:Foo" ), 23, 42 );

        $this->assertLinksUpdate(
            $t,
            $po,
            'templatelinks',
            'tl_namespace,
            tl_title',
            'tl_from = ' . self::$testingPageId,
            [ [ NS_TEMPLATE, 'Foo' ] ]
        );
    }

    public function testUpdate_imagelinks() {
        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $po->addImage( "Foo.png" );

        $this->assertLinksUpdate(
            $t,
            $po,
            'imagelinks',
            'il_to',
            'il_from = ' . self::$testingPageId,
            [ [ 'Foo.png' ] ]
        );
    }

    public function testUpdate_langlinks() {
        $this->setMwGlobals( [
            'wgCapitalLinks' => true,
        ] );

        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $po->addLanguageLink( Title::newFromText( "en:Foo" )->getFullText() );

        $this->assertLinksUpdate(
            $t,
            $po,
            'langlinks',
            'll_lang, ll_title',
            'll_from = ' . self::$testingPageId,
            [ [ 'En', 'Foo' ] ]
        );
    }

    public function testUpdate_page_props() {
        global $wgPagePropsHaveSortkey;

        list( $t, $po ) = $this->makeTitleAndParserOutput( "Testing", self::$testingPageId );

        $fields = [ 'pp_propname', 'pp_value' ];
        $expected = [];

        $po->setProperty( "bool", true );
        $expected[] = [ "bool", true ];

        $po->setProperty( "float", 4.0 + 1.0 / 4.0 );
        $expected[] = [ "float", 4.0 + 1.0 / 4.0 ];

        $po->setProperty( "int", -7 );
        $expected[] = [ "int", -7 ];

        $po->setProperty( "string", "33 bar" );
        $expected[] = [ "string", "33 bar" ];

        // compute expected sortkey values
        if ( $wgPagePropsHaveSortkey ) {
            $fields[] = 'pp_sortkey';

            foreach ( $expected as &$row ) {
                $value = $row[1];

                if ( is_int( $value ) || is_float( $value ) || is_bool( $value ) ) {
                    $row[] = floatval( $value );
                } else {
                    $row[] = null;
                }
            }
        }

        $this->assertLinksUpdate(
            $t, $po, 'page_props', $fields, 'pp_page = ' . self::$testingPageId, $expected );
    }

    public function testUpdate_page_props_without_sortkey() {
        $this->setMwGlobals( 'wgPagePropsHaveSortkey', false );

        $this->testUpdate_page_props();
    }

    // @todo test recursive, too!

    protected function assertLinksUpdate( Title $title, ParserOutput $parserOutput,
        $table, $fields, $condition, array $expectedRows
    ) {
        $update = new LinksUpdate( $title, $parserOutput );

        // NOTE: make sure LinksUpdate does not generate warnings when called inside a transaction.
        $update->beginTransaction();
        $update->doUpdate();
        $update->commitTransaction();

        $this->assertSelect( $table, $fields, $condition, $expectedRows );
        return $update;
    }

    protected function assertRecentChangeByCategorization(
        Title $pageTitle, ParserOutput $parserOutput, Title $categoryTitle, $expectedRows
    ) {
        $this->assertSelect(
            'recentchanges',
            'rc_title, rc_comment',
            [
                'rc_type' => RC_CATEGORIZE,
                'rc_namespace' => NS_CATEGORY,
                'rc_title' => $categoryTitle->getDBkey()
            ],
            $expectedRows
        );
    }

    private function runAllRelatedJobs() {
        $queueGroup = JobQueueGroup::singleton();
        while ( $job = $queueGroup->pop( 'refreshLinksPrioritized' ) ) {
            $job->run();
            $queueGroup->ack( $job );
        }
        while ( $job = $queueGroup->pop( 'categoryMembershipChange' ) ) {
            $job->run();
            $queueGroup->ack( $job );
        }
    }
}