ArticleViewTest.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\MutableRevisionRecord;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use PHPUnit\Framework\MockObject\MockObject;
 
class ArticleViewTest extends MediaWikiTestCase {
 
    protected function setUp() {
        parent::setUp();
 
        $this->setUserLang( 'qqx' );
    }
 
    private function getHtml( OutputPage $output ) {
        return preg_replace( '/<!--.*?-->/s', '', $output->getHTML() );
    }
 
    private function getPage( $title, array $revisionContents = [], array &$revisions = [] ) {
        if ( is_string( $title ) ) {
            $title = Title::makeTitle( $this->getDefaultWikitextNS(), $title );
        }
 
        $page = WikiPage::factory( $title );
 
        $user = $this->getTestUser()->getUser();
 
        foreach ( $revisionContents as $key => $cont ) {
            if ( is_string( $cont ) ) {
                $cont = new WikitextContent( $cont );
            }
 
            $u = $page->newPageUpdater( $user );
            $u->setContent( SlotRecord::MAIN, $cont );
            $rev = $u->saveRevision( CommentStoreComment::newUnsavedComment( 'Rev ' . $key ) );
 
            $revisions[ $key ] = $rev;
        }
 
        return $page;
    }
 
    public function testGetOldId() {
        $revisions = [];
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ], $revisions );
 
        $idA = $revisions[1]->getId();
        $idB = $revisions[2]->getId();
 
        // oldid in constructor
        $article = new Article( $page->getTitle(), $idA );
        $this->assertSame( $idA, $article->getOldID() );
        $article->getRevisionFetched();
        $this->assertSame( $idA, $article->getRevIdFetched() );
 
        // oldid 0 in constructor
        $article = new Article( $page->getTitle(), 0 );
        $this->assertSame( 0, $article->getOldID() );
        $article->getRevisionFetched();
        $this->assertSame( $idB, $article->getRevIdFetched() );
 
        // oldid in request
        $article = new Article( $page->getTitle() );
        $context = new RequestContext();
        $context->setRequest( new FauxRequest( [ 'oldid' => $idA ] ) );
        $article->setContext( $context );
        $this->assertSame( $idA, $article->getOldID() );
        $article->getRevisionFetched();
        $this->assertSame( $idA, $article->getRevIdFetched() );
 
        // no oldid
        $article = new Article( $page->getTitle() );
        $context = new RequestContext();
        $context->setRequest( new FauxRequest( [] ) );
        $article->setContext( $context );
        $this->assertSame( 0, $article->getOldID() );
        $article->getRevisionFetched();
        $this->assertSame( $idB, $article->getRevIdFetched() );
    }
 
    public function testView() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ] );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'Test B', $this->getHtml( $output ) );
        $this->assertNotContains( 'id="mw-revision-info"', $this->getHtml( $output ) );
        $this->assertNotContains( 'id="mw-revision-nav"', $this->getHtml( $output ) );
    }
 
    public function testViewCached() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ] );
 
        $po = new ParserOutput( 'Cached Text' );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
 
        $cache = MediaWikiServices::getInstance()->getParserCache();
        $cache->save( $po, $page, $article->getParserOptions() );
 
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'Cached Text', $this->getHtml( $output ) );
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertNotContains( 'Test B', $this->getHtml( $output ) );
    }
 
    public function testViewRedirect() {
        $target = Title::makeTitle( $this->getDefaultWikitextNS(), 'Test_Target' );
        $redirectText = '#REDIRECT [[' . $target->getPrefixedText() . ']]';
 
        $page = $this->getPage( __METHOD__, [ $redirectText ] );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $this->assertNotNull(
            $article->getRedirectTarget()->getPrefixedDBkey()
        );
        $this->assertSame(
            $target->getPrefixedDBkey(),
            $article->getRedirectTarget()->getPrefixedDBkey()
        );
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'class="redirectText"', $this->getHtml( $output ) );
        $this->assertContains(
            '>' . htmlspecialchars( $target->getPrefixedText() ) . '<',
            $this->getHtml( $output )
        );
    }
 
    public function testViewNonText() {
        $dummy = $this->getPage( __METHOD__, [ 'Dummy' ] );
        $dummyRev = $dummy->getRevision()->getRevisionRecord();
        $title = $dummy->getTitle();
 
        $mockHandler = $this->getMockBuilder( ContentHandler::class )
            ->setMethods(
                [
                    'isParserCacheSupported',
                    'serializeContent',
                    'unserializeContent',
                    'makeEmptyContent',
                ]
            )
            ->setConstructorArgs( [ 'NotText', [ 'application/frobnitz' ] ] )
            ->getMock();
 
        $mockHandler->method( 'isParserCacheSupported' )
            ->willReturn( false );
 
        $this->setTemporaryHook(
            'ContentHandlerForModelID',
            function ( $id, &$handler ) use ( $mockHandler ) {
                $handler = $mockHandler;
            }
        );
 
        $content = $this->getMock( Content::class );
        $content->method( 'getParserOutput' )
            ->willReturn( new ParserOutput( 'Structured Output' ) );
        $content->method( 'getModel' )
            ->willReturn( 'NotText' );
        $content->method( 'getNativeData' )
            ->willReturn( [ (object)[ 'x' => 'stuff' ] ] );
        $content->method( 'copy' )
            ->willReturn( $content );
 
        $rev = new MutableRevisionRecord( $title );
        $rev->setId( $dummyRev->getId() );
        $rev->setPageId( $title->getArticleID() );
        $rev->setUser( $dummyRev->getUser() );
        $rev->setComment( $dummyRev->getComment() );
        $rev->setTimestamp( $dummyRev->getTimestamp() );
 
        $rev->setContent( SlotRecord::MAIN, $content );
 
        $rev = new Revision( $rev );
 
        $page = $this->getMockBuilder( WikiPage::class )
            ->setMethods( [ 'getRevision', 'getLatest' ] )
            ->setConstructorArgs( [ $title ] )
            ->getMock();
 
        $page->method( 'getRevision' )
            ->willReturn( $rev );
        $page->method( 'getLatest' )
            ->willReturn( $rev->getId() );
 
        $article = Article::newFromWikiPage( $page, RequestContext::getMain() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'Structured Output', $this->getHtml( $output ) );
        $this->assertNotContains( 'Dummy', $this->getHtml( $output ) );
    }
 
    public function testViewOfOldRevision() {
        $revisions = [];
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ], $revisions );
        $idA = $revisions[1]->getId();
 
        $article = new Article( $page->getTitle(), $idA );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'Test A', $this->getHtml( $output ) );
        $this->assertContains( 'id="mw-revision-info"', $output->getSubtitle() );
        $this->assertContains( 'id="mw-revision-nav"', $output->getSubtitle() );
 
        $this->assertNotContains( 'id="revision-info-current"', $output->getSubtitle() );
        $this->assertNotContains( 'Test B', $this->getHtml( $output ) );
    }
 
    public function testViewOfCurrentRevision() {
        $revisions = [];
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ], $revisions );
        $idB = $revisions[2]->getId();
 
        $article = new Article( $page->getTitle(), $idB );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'Test B', $this->getHtml( $output ) );
        $this->assertContains( 'id="mw-revision-info-current"', $output->getSubtitle() );
        $this->assertContains( 'id="mw-revision-nav"', $output->getSubtitle() );
    }
 
    public function testViewOfMissingRevision() {
        $revisions = [];
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A' ], $revisions );
        $badId = $revisions[1]->getId() + 100;
 
        $article = new Article( $page->getTitle(), $badId );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'missing-revision: ' . $badId, $this->getHtml( $output ) );
 
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
    }
 
    public function testViewOfDeletedRevision() {
        $revisions = [];
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ], $revisions );
        $idA = $revisions[1]->getId();
 
        $revDelList = new RevDelRevisionList(
            RequestContext::getMain(), $page->getTitle(), [ $idA ]
        );
        $revDelList->setVisibility( [
            'value' => [ RevisionRecord::DELETED_TEXT => 1 ],
            'comment' => "Testing",
        ] );
 
        $article = new Article( $page->getTitle(), $idA );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( '(rev-deleted-text-permission)', $this->getHtml( $output ) );
 
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertNotContains( 'Test B', $this->getHtml( $output ) );
    }
 
    public function testUnhiddenViewOfDeletedRevision() {
        $revisions = [];
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ], $revisions );
        $idA = $revisions[1]->getId();
 
        $revDelList = new RevDelRevisionList(
            RequestContext::getMain(), $page->getTitle(), [ $idA ]
        );
        $revDelList->setVisibility( [
            'value' => [ RevisionRecord::DELETED_TEXT => 1 ],
            'comment' => "Testing",
        ] );
 
        $article = new Article( $page->getTitle(), $idA );
        $context = new DerivativeContext( $article->getContext() );
        $article->setContext( $context );
        $context->getOutput()->setTitle( $page->getTitle() );
        $context->getRequest()->setVal( 'unhide', 1 );
        $context->setUser( $this->getTestUser( [ 'sysop' ] )->getUser() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( '(rev-deleted-text-view)', $this->getHtml( $output ) );
 
        $this->assertContains( 'Test A', $this->getHtml( $output ) );
        $this->assertNotContains( 'Test B', $this->getHtml( $output ) );
    }
 
    public function testViewMissingPage() {
        $page = $this->getPage( __METHOD__ );
 
        $article = new Article( $page->getTitle() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( '(noarticletextanon)', $this->getHtml( $output ) );
    }
 
    public function testViewDeletedPage() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A', 2 => 'Test B' ] );
        $page->doDeleteArticle( 'Test' );
 
        $article = new Article( $page->getTitle() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( 'moveddeleted', $this->getHtml( $output ) );
        $this->assertContains( 'logentry-delete-delete', $this->getHtml( $output ) );
        $this->assertContains( '(noarticletextanon)', $this->getHtml( $output ) );
 
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertNotContains( 'Test B', $this->getHtml( $output ) );
    }
 
    public function testViewMessagePage() {
        $title = Title::makeTitle( NS_MEDIAWIKI, 'Mainpage' );
        $page = $this->getPage( $title );
 
        $article = new Article( $page->getTitle() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains(
            wfMessage( 'mainpage' )->inContentLanguage()->parse(),
            $this->getHtml( $output )
        );
        $this->assertNotContains( '(noarticletextanon)', $this->getHtml( $output ) );
    }
 
    public function testViewMissingUserPage() {
        $user = $this->getTestUser()->getUser();
        $user->addToDatabase();
 
        $title = Title::makeTitle( NS_USER, $user->getName() );
 
        $page = $this->getPage( $title );
 
        $article = new Article( $page->getTitle() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( '(noarticletextanon)', $this->getHtml( $output ) );
        $this->assertNotContains( '(userpage-userdoesnotexist-view)', $this->getHtml( $output ) );
    }
 
    public function testViewUserPageOfNonexistingUser() {
        $user = User::newFromName( 'Testing ' . __METHOD__ );
 
        $title = Title::makeTitle( NS_USER, $user->getName() );
 
        $page = $this->getPage( $title );
 
        $article = new Article( $page->getTitle() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( '(noarticletextanon)', $this->getHtml( $output ) );
        $this->assertContains( '(userpage-userdoesnotexist-view:', $this->getHtml( $output ) );
    }
 
    public function testArticleViewHeaderHook() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A' ] );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
 
        $this->setTemporaryHook(
            'ArticleViewHeader',
            function ( Article $articlePage, &$outputDone, &$useParserCache ) use ( $article ) {
                $this->assertSame( $article, $articlePage, '$articlePage' );
 
                $outputDone = new ParserOutput( 'Hook Text' );
                $outputDone->setTitleText( 'Hook Title' );
 
                $articlePage->getContext()->getOutput()->addParserOutput( $outputDone );
            }
        );
 
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertContains( 'Hook Text', $this->getHtml( $output ) );
        $this->assertSame( 'Hook Title', $output->getPageTitle() );
    }
 
    public function testArticleContentViewCustomHook() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A' ] );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
 
        // use ArticleViewHeader hook to bypass the parser cache
        $this->setTemporaryHook(
            'ArticleViewHeader',
            function ( Article $articlePage, &$outputDone, &$useParserCache ) use ( $article ) {
                $useParserCache = false;
            }
        );
 
        $this->setTemporaryHook(
            'ArticleContentViewCustom',
            function ( Content $content, Title $title, OutputPage $output ) use ( $page ) {
                $this->assertSame( $page->getTitle(), $title, '$title' );
                $this->assertSame( 'Test A', $content->getNativeData(), '$content' );
 
                $output->addHTML( 'Hook Text' );
                return false;
            }
        );
 
        $this->hideDeprecated(
            'ArticleContentViewCustom hook (used in hook-ArticleContentViewCustom-closure)'
        );
 
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertContains( 'Hook Text', $this->getHtml( $output ) );
    }
 
    public function testArticleRevisionViewCustomHook() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A' ] );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
 
        // use ArticleViewHeader hook to bypass the parser cache
        $this->setTemporaryHook(
            'ArticleViewHeader',
            function ( Article $articlePage, &$outputDone, &$useParserCache ) use ( $article ) {
                $useParserCache = false;
            }
        );
 
        $this->setTemporaryHook(
            'ArticleRevisionViewCustom',
            function ( RevisionRecord $rev, Title $title, $oldid, OutputPage $output ) use ( $page ) {
                $content = $rev->getContent( SlotRecord::MAIN );
 
                $this->assertSame( $page->getTitle(), $title, '$title' );
                $this->assertSame( 'Test A', $content->getNativeData(), '$content' );
 
                $output->addHTML( 'Hook Text' );
                return false;
            }
        );
 
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertContains( 'Hook Text', $this->getHtml( $output ) );
    }
 
    public function testArticleAfterFetchContentObjectHook() {
        $page = $this->getPage( __METHOD__, [ 1 => 'Test A' ] );
 
        $article = new Article( $page->getTitle(), 0 );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
 
        // use ArticleViewHeader hook to bypass the parser cache
        $this->setTemporaryHook(
            'ArticleViewHeader',
            function ( Article $articlePage, &$outputDone, &$useParserCache ) use ( $article ) {
                $useParserCache = false;
            }
        );
 
        $this->setTemporaryHook(
            'ArticleAfterFetchContentObject',
            function ( Article &$articlePage, Content &$content ) use ( $page, $article ) {
                $this->assertSame( $article, $articlePage, '$articlePage' );
                $this->assertSame( 'Test A', $content->getNativeData(), '$content' );
 
                $content = new WikitextContent( 'Hook Text' );
            }
        );
 
        $this->hideDeprecated(
            'ArticleAfterFetchContentObject hook'
            . ' (used in hook-ArticleAfterFetchContentObject-closure)'
        );
 
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertNotContains( 'Test A', $this->getHtml( $output ) );
        $this->assertContains( 'Hook Text', $this->getHtml( $output ) );
    }
 
    public function testShowMissingArticleHook() {
        $page = $this->getPage( __METHOD__ );
 
        $article = new Article( $page->getTitle() );
        $article->getContext()->getOutput()->setTitle( $page->getTitle() );
 
        $this->setTemporaryHook(
            'ShowMissingArticle',
            function ( Article $articlePage ) use ( $article ) {
                $this->assertSame( $article, $articlePage, '$articlePage' );
 
                $articlePage->getContext()->getOutput()->addHTML( 'Hook Text' );
            }
        );
 
        $article->view();
 
        $output = $article->getContext()->getOutput();
        $this->assertContains( '(noarticletextanon)', $this->getHtml( $output ) );
        $this->assertContains( 'Hook Text', $this->getHtml( $output ) );
    }
 
}