EditPageTest.php

Go to the documentation of this file.

<?php

class EditPageTest extends MediaWikiLangTestCase {

    public function testExtractSectionTitle( $section, $title ) {
        $extracted = EditPage::extractSectionTitle( $section );
        $this->assertEquals( $title, $extracted );
    }

    public static function provideExtractSectionTitle() {
        return array(
            array(
                "== Test ==\n\nJust a test section.",
                "Test"
            ),
            array(
                "An initial section, no header.",
                false
            ),
            array(
                "An initial section with a fake heder (bug 32617)\n\n== Test == ??\nwtf",
                false
            ),
            array(
                "== Section ==\nfollowed by a fake == Non-section == ??\nnoooo",
                "Section"
            ),
            array(
                "== Section== \t\r\n followed by whitespace (bug 35051)",
                'Section',
            ),
        );
    }

    protected function forceRevisionDate( WikiPage $page, $timestamp ) {
        $dbw = wfGetDB( DB_MASTER );

        $dbw->update( 'revision',
            array( 'rev_timestamp' => $dbw->timestamp( $timestamp ) ),
            array( 'rev_id' => $page->getLatest() ) );

        $page->clear();
    }

    protected function assertEditedTextEquals( $expected, $actual, $msg = '' ) {
        return $this->assertEquals( rtrim( $expected ), rtrim( $actual ), $msg );
    }

    protected function assertEdit( $title, $baseText, $user = null, array $edit,
        $expectedCode = EditPage::AS_OK, $expectedText = null, $message = null
    ) {
        if ( is_string( $title ) ) {
            $ns = $this->getDefaultWikitextNS();
            $title = Title::newFromText( $title, $ns );
        }

        if ( is_string( $user ) ) {
            $user = User::newFromName( $user );

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

        $page = WikiPage::factory( $title );

        if ( $baseText !== null ) {
            $content = ContentHandler::makeContent( $baseText, $title );
            $page->doEditContent( $content, "base text for test" );
            $this->forceRevisionDate( $page, '20120101000000' );

            //sanity check
            $page->clear();
            $currentText = ContentHandler::getContentText( $page->getContent() );

            # EditPage rtrim() the user input, so we alter our expected text
            # to reflect that.
            $this->assertEditedTextEquals( $baseText, $currentText );
        }

        if ( $user == null ) {
            $user = $GLOBALS['wgUser'];
        } else {
            $this->setMwGlobals( 'wgUser', $user );
        }

        if ( !isset( $edit['wpEditToken'] ) ) {
            $edit['wpEditToken'] = $user->getEditToken();
        }

        if ( !isset( $edit['wpEdittime'] ) ) {
            $edit['wpEdittime'] = $page->exists() ? $page->getTimestamp() : '';
        }

        if ( !isset( $edit['wpStarttime'] ) ) {
            $edit['wpStarttime'] = wfTimestampNow();
        }

        $req = new FauxRequest( $edit, true ); // session ??

        $ep = new EditPage( new Article( $title ) );
        $ep->setContextTitle( $title );
        $ep->importFormData( $req );

        $bot = isset( $edit['bot'] ) ? (bool)$edit['bot'] : false;

        // this is where the edit happens!
        // Note: don't want to use EditPage::AttemptSave, because it messes with $wgOut
        // and throws exceptions like PermissionsError
        $status = $ep->internalAttemptSave( $result, $bot );

        if ( $expectedCode !== null ) {
            // check edit code
            $this->assertEquals( $expectedCode, $status->value,
                "Expected result code mismatch. $message" );
        }

        $page = WikiPage::factory( $title );

        if ( $expectedText !== null ) {
            // check resulting page text
            $content = $page->getContent();
            $text = ContentHandler::getContentText( $content );

            # EditPage rtrim() the user input, so we alter our expected text
            # to reflect that.
            $this->assertEditedTextEquals( $expectedText, $text,
                "Expected article text mismatch. $message" );
        }

        return $page;
    }

    public function testCreatePage() {
        $this->assertEdit(
            'EditPageTest_testCreatePage',
            null,
            null,
            array(
                'wpTextbox1' => "Hello World!",
            ),
            EditPage::AS_SUCCESS_NEW_ARTICLE,
            "Hello World!",
            "expected article being created"
        )->doDeleteArticleReal( 'EditPageTest_testCreatePage' );

        $this->assertEdit(
            'EditPageTest_testCreatePage',
            null,
            null,
            array(
                'wpTextbox1' => "",
            ),
            EditPage::AS_BLANK_ARTICLE,
            null,
            "expected article not being created if empty"
        );

        $this->assertEdit(
            'MediaWiki:January',
            null,
            'UTSysop',
            array(
                'wpTextbox1' => "Not January",
            ),
            EditPage::AS_SUCCESS_NEW_ARTICLE,
            "Not January",
            "expected MediaWiki: page being created"
        )->doDeleteArticleReal( 'EditPageTest_testCreatePage' );

        $this->assertEdit(
            'MediaWiki:EditPageTest_testCreatePage',
            null,
            'UTSysop',
            array(
                'wpTextbox1' => "",
            ),
            EditPage::AS_BLANK_ARTICLE,
            null,
            "expected not-registered MediaWiki: page not being created if empty"
        );

        $this->assertEdit(
            'MediaWiki:January',
            null,
            'UTSysop',
            array(
                'wpTextbox1' => "",
            ),
            EditPage::AS_SUCCESS_NEW_ARTICLE,
            "",
            "expected registered MediaWiki: page being created even if empty"
        )->doDeleteArticleReal( 'EditPageTest_testCreatePage' );

        $this->assertEdit(
            'MediaWiki:Ipb-default-expiry',
            null,
            'UTSysop',
            array(
                'wpTextbox1' => "",
            ),
            EditPage::AS_BLANK_ARTICLE,
            "",
            "expected registered MediaWiki: page whose default content is empty not being created if empty"
        );

        $this->assertEdit(
            'MediaWiki:January',
            null,
            'UTSysop',
            array(
                'wpTextbox1' => "January",
            ),
            EditPage::AS_BLANK_ARTICLE,
            null,
            "expected MediaWiki: page not being created if text equals default message"
        );
    }

    public function testUpdatePage() {
        $text = "one";
        $edit = array(
            'wpTextbox1' => $text,
            'wpSummary' => 'first update',
        );

        $page = $this->assertEdit( 'EditPageTest_testUpdatePage', "zero", null, $edit,
            EditPage::AS_SUCCESS_UPDATE, $text,
            "expected successfull update with given text" );

        $this->forceRevisionDate( $page, '20120101000000' );

        $text = "two";
        $edit = array(
            'wpTextbox1' => $text,
            'wpSummary' => 'second update',
        );

        $this->assertEdit( 'EditPageTest_testUpdatePage', null, null, $edit,
            EditPage::AS_SUCCESS_UPDATE, $text,
            "expected successfull update with given text" );
    }

    public static function provideSectionEdit() {
        $text = 'Intro

== one ==
first section.

== two ==
second section.
';

        $sectionOne = '== one ==
hello
';

        $newSection = '== new section ==

hello
';

        $textWithNewSectionOne = preg_replace(
            '/== one ==.*== two ==/ms',
            "$sectionOne\n== two ==", $text
        );

        $textWithNewSectionAdded = "$text\n$newSection";

        return array(
            array( #0
                $text,
                '',
                'hello',
                'replace all',
                'hello'
            ),

            array( #1
                $text,
                '1',
                $sectionOne,
                'replace first section',
                $textWithNewSectionOne,
            ),

            array( #2
                $text,
                'new',
                'hello',
                'new section',
                $textWithNewSectionAdded,
            ),
        );
    }

    public function testSectionEdit( $base, $section, $text, $summary, $expected ) {
        $edit = array(
            'wpTextbox1' => $text,
            'wpSummary' => $summary,
            'wpSection' => $section,
        );

        $this->assertEdit( 'EditPageTest_testSectionEdit', $base, null, $edit,
            EditPage::AS_SUCCESS_UPDATE, $expected,
            "expected successfull update of section" );
    }

    public static function provideAutoMerge() {
        $tests = array();

        $tests[] = array( #0: plain conflict
            "Elmo", # base edit user
            "one\n\ntwo\n\nthree\n",
            array( #adam's edit
                'wpStarttime' => 1,
                'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
            ),
            array( #berta's edit
                'wpStarttime' => 2,
                'wpTextbox1' => "(one)\n\ntwo\n\nthree\n",
            ),
            EditPage::AS_CONFLICT_DETECTED, # expected code
            "ONE\n\ntwo\n\nthree\n", # expected text
            'expected edit conflict', # message
        );

        $tests[] = array( #1: successful merge
            "Elmo", # base edit user
            "one\n\ntwo\n\nthree\n",
            array( #adam's edit
                'wpStarttime' => 1,
                'wpTextbox1' => "ONE\n\ntwo\n\nthree\n",
            ),
            array( #berta's edit
                'wpStarttime' => 2,
                'wpTextbox1' => "one\n\ntwo\n\nTHREE\n",
            ),
            EditPage::AS_SUCCESS_UPDATE, # expected code
            "ONE\n\ntwo\n\nTHREE\n", # expected text
            'expected automatic merge', # message
        );

        $text = "Intro\n\n";
        $text .= "== first section ==\n\n";
        $text .= "one\n\ntwo\n\nthree\n\n";
        $text .= "== second section ==\n\n";
        $text .= "four\n\nfive\n\nsix\n\n";

        // extract the first section.
        $section = preg_replace( '/.*(== first section ==.*)== second section ==.*/sm', '$1', $text );

        // generate expected text after merge
        $expected = str_replace( 'one', 'ONE', str_replace( 'three', 'THREE', $text ) );

        $tests[] = array( #2: merge in section
            "Elmo", # base edit user
            $text,
            array( #adam's edit
                'wpStarttime' => 1,
                'wpTextbox1' => str_replace( 'one', 'ONE', $section ),
                'wpSection' => '1'
            ),
            array( #berta's edit
                'wpStarttime' => 2,
                'wpTextbox1' => str_replace( 'three', 'THREE', $section ),
                'wpSection' => '1'
            ),
            EditPage::AS_SUCCESS_UPDATE, # expected code
            $expected, # expected text
            'expected automatic section merge', # message
        );

        // see whether it makes a difference who did the base edit
        $testsWithAdam = array_map( function ( $test ) {
            $test[0] = 'Adam'; // change base edit user
            return $test;
        }, $tests );

        $testsWithBerta = array_map( function ( $test ) {
            $test[0] = 'Berta'; // change base edit user
            return $test;
        }, $tests );

        return array_merge( $tests, $testsWithAdam, $testsWithBerta );
    }

    public function testAutoMerge( $baseUser, $text, $adamsEdit, $bertasEdit,
        $expectedCode, $expectedText, $message = null
    ) {
        $this->checkHasDiff3();

        //create page
        $ns = $this->getDefaultWikitextNS();
        $title = Title::newFromText( 'EditPageTest_testAutoMerge', $ns );
        $page = WikiPage::factory( $title );

        if ( $page->exists() ) {
            $page->doDeleteArticle( "clean slate for testing" );
        }

        $baseEdit = array(
            'wpTextbox1' => $text,
        );

        $page = $this->assertEdit( 'EditPageTest_testAutoMerge', null,
            $baseUser, $baseEdit, null, null, __METHOD__ );

        $this->forceRevisionDate( $page, '20120101000000' );

        $edittime = $page->getTimestamp();

        // start timestamps for conflict detection
        if ( !isset( $adamsEdit['wpStarttime'] ) ) {
            $adamsEdit['wpStarttime'] = 1;
        }

        if ( !isset( $bertasEdit['wpStarttime'] ) ) {
            $bertasEdit['wpStarttime'] = 2;
        }

        $starttime = wfTimestampNow();
        $adamsTime = wfTimestamp( TS_MW, (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$adamsEdit['wpStarttime'] );
        $bertasTime = wfTimestamp( TS_MW, (int)wfTimestamp( TS_UNIX, $starttime ) + (int)$bertasEdit['wpStarttime'] );

        $adamsEdit['wpStarttime'] = $adamsTime;
        $bertasEdit['wpStarttime'] = $bertasTime;

        $adamsEdit['wpSummary'] = 'Adam\'s edit';
        $bertasEdit['wpSummary'] = 'Bertas\'s edit';

        $adamsEdit['wpEdittime'] = $edittime;
        $bertasEdit['wpEdittime'] = $edittime;

        // first edit
        $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Adam', $adamsEdit,
            EditPage::AS_SUCCESS_UPDATE, null, "expected successfull update" );

        // second edit
        $this->assertEdit( 'EditPageTest_testAutoMerge', null, 'Berta', $bertasEdit,
            $expectedCode, $expectedText, $message );
    }
}