tests/phpunit/includes/api/ApiEditPageTest.php

   1 <?php
   2
   3 /**
   4  * Tests for MediaWiki api.php?action=edit.
   5  *
   6  * @author Daniel Kinzler
   7  *
   8  * @group API
   9  * @group Database
  10  * @group medium
  11  */
  12 class ApiEditPageTest extends ApiTestCase {
  13
  14         public function setUp() {
  15                 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
  16
  17                 parent::setUp();
  18
  19                 $wgExtraNamespaces[12312] = 'Dummy';
  20                 $wgExtraNamespaces[12313] = 'Dummy_talk';
  21
  22                 $wgNamespaceContentModels[12312] = "testing";
  23                 $wgContentHandlers["testing"] = 'DummyContentHandlerForTesting';
  24
  25                 MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
  26                 $wgContLang->resetNamespaces(); # reset namespace cache
  27
  28                 $this->doLogin();
  29         }
  30
  31         public function tearDown() {
  32                 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
  33
  34                 unset( $wgExtraNamespaces[12312] );
  35                 unset( $wgExtraNamespaces[12313] );
  36
  37                 unset( $wgNamespaceContentModels[12312] );
  38                 unset( $wgContentHandlers["testing"] );
  39
  40                 MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
  41                 $wgContLang->resetNamespaces(); # reset namespace cache
  42
  43                 parent::tearDown();
  44         }
  45
  46         function testEdit() {
  47                 $name = 'Help:ApiEditPageTest_testEdit'; // assume Help namespace to default to wikitext
  48
  49                 // -- test new page --------------------------------------------
  50                 $apiResult = $this->doApiRequestWithToken( array(
  51                         'action' => 'edit',
  52                         'title' => $name,
  53                         'text' => 'some text',
  54                 ) );
  55                 $apiResult = $apiResult[0];
  56
  57                 // Validate API result data
  58                 $this->assertArrayHasKey( 'edit', $apiResult );
  59                 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
  60                 $this->assertEquals( 'Success', $apiResult['edit']['result'] );
  61
  62                 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
  63                 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
  64
  65                 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
  66
  67                 // -- test existing page, no change ----------------------------
  68                 $data = $this->doApiRequestWithToken( array(
  69                         'action' => 'edit',
  70                         'title' => $name,
  71                         'text' => 'some text',
  72                 ) );
  73
  74                 $this->assertEquals( 'Success', $data[0]['edit']['result'] );
  75
  76                 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
  77                 $this->assertArrayHasKey( 'nochange', $data[0]['edit'] );
  78
  79                 // -- test existing page, with change --------------------------
  80                 $data = $this->doApiRequestWithToken( array(
  81                         'action' => 'edit',
  82                         'title' => $name,
  83                         'text' => 'different text'
  84                 ) );
  85
  86                 $this->assertEquals( 'Success', $data[0]['edit']['result'] );
  87
  88                 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
  89                 $this->assertArrayNotHasKey( 'nochange', $data[0]['edit'] );
  90
  91                 $this->assertArrayHasKey( 'oldrevid', $data[0]['edit'] );
  92                 $this->assertArrayHasKey( 'newrevid', $data[0]['edit'] );
  93                 $this->assertNotEquals(
  94                         $data[0]['edit']['newrevid'],
  95                         $data[0]['edit']['oldrevid'],
  96                         "revision id should change after edit"
  97                 );
  98         }
  99
 100         function testNonTextEdit() {
 101                 $name = 'Dummy:ApiEditPageTest_testNonTextEdit';
 102                 $data = serialize( 'some bla bla text' );
 103
 104                 // -- test new page --------------------------------------------
 105                 $apiResult = $this->doApiRequestWithToken( array(
 106                         'action' => 'edit',
 107                         'title' => $name,
 108                         'text' => $data, ) );
 109                 $apiResult = $apiResult[0];
 110
 111                 // Validate API result data
 112                 $this->assertArrayHasKey( 'edit', $apiResult );
 113                 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
 114                 $this->assertEquals( 'Success', $apiResult['edit']['result'] );
 115
 116                 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
 117                 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
 118
 119                 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
 120
 121                 // validate resulting revision
 122                 $page = WikiPage::factory( Title::newFromText( $name ) );
 123                 $this->assertEquals( "testing", $page->getContentModel() );
 124                 $this->assertEquals( $data, $page->getContent()->serialize() );
 125         }
 126
 127         public static function provideEditAppend() {
 128                 return array(
 129                         array( #0: append
 130                                 'foo', 'append', 'bar', "foobar"
 131                         ),
 132                         array( #1: prepend
 133                                 'foo', 'prepend', 'bar', "barfoo"
 134                         ),
 135                         array( #2: append to empty page
 136                                 '', 'append', 'foo', "foo"
 137                         ),
 138                         array( #3: prepend to empty page
 139                                 '', 'prepend', 'foo', "foo"
 140                         ),
 141                         array( #4: append to non-existing page
 142                                 null, 'append', 'foo', "foo"
 143                         ),
 144                         array( #5: prepend to non-existing page
 145                                 null, 'prepend', 'foo', "foo"
 146                         ),
 147                 );
 148         }
 149
 150         /**
 151          * @dataProvider provideEditAppend
 152          */
 153         function testEditAppend( $text, $op, $append, $expected ) {
 154                 static $count = 0;
 155                 $count++;
 156
 157                 // assume NS_HELP defaults to wikitext
 158                 $name = "Help:ApiEditPageTest_testEditAppend_$count";
 159
 160                 // -- create page (or not) -----------------------------------------
 161                 if ( $text !== null ) {
 162                         if ( $text === '' ) {
 163                                 // can't create an empty page, so create it with some content
 164                                 $this->doApiRequestWithToken( array(
 165                                         'action' => 'edit',
 166                                         'title' => $name,
 167                                         'text' => '(dummy)', ) );
 168                         }
 169
 170                         list( $re ) = $this->doApiRequestWithToken( array(
 171                                 'action' => 'edit',
 172                                 'title' => $name,
 173                                 'text' => $text, ) );
 174
 175                         $this->assertEquals( 'Success', $re['edit']['result'] ); // sanity
 176                 }
 177
 178                 // -- try append/prepend --------------------------------------------
 179                 list( $re ) = $this->doApiRequestWithToken( array(
 180                         'action' => 'edit',
 181                         'title' => $name,
 182                         $op . 'text' => $append, ) );
 183
 184                 $this->assertEquals( 'Success', $re['edit']['result'] );
 185
 186                 // -- validate -----------------------------------------------------
 187                 $page = new WikiPage( Title::newFromText( $name ) );
 188                 $content = $page->getContent();
 189                 $this->assertNotNull( $content, 'Page should have been created' );
 190
 191                 $text = $content->getNativeData();
 192
 193                 $this->assertEquals( $expected, $text );
 194         }
 195
 196         function testEditSection() {
 197                 $this->markTestIncomplete( "not yet implemented" );
 198         }
 199
 200         function testUndo() {
 201                 $this->markTestIncomplete( "not yet implemented" );
 202         }
 203
 204         function testEditConflict() {
 205                 static $count = 0;
 206                 $count++;
 207
 208                 // assume NS_HELP defaults to wikitext
 209                 $name = "Help:ApiEditPageTest_testEditConflict_$count";
 210                 $title = Title::newFromText( $name );
 211
 212                 $page = WikiPage::factory( $title );
 213
 214                 // base edit
 215                 $page->doEditContent( new WikitextContent( "Foo" ),
 216                         "testing 1", EDIT_NEW, false, self::$users['sysop']->user );
 217                 $this->forceRevisionDate( $page, '20120101000000' );
 218                 $baseTime = $page->getRevision()->getTimestamp();
 219
 220                 // conflicting edit
 221                 $page->doEditContent( new WikitextContent( "Foo bar" ),
 222                         "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->user );
 223                 $this->forceRevisionDate( $page, '20120101020202' );
 224
 225                 // try to save edit, expect conflict
 226                 try {
 227                         $this->doApiRequestWithToken( array(
 228                                 'action' => 'edit',
 229                                 'title' => $name,
 230                                 'text' => 'nix bar!',
 231                                 'basetimestamp' => $baseTime,
 232                         ), null, self::$users['sysop']->user );
 233
 234                         $this->fail( 'edit conflict expected' );
 235                 } catch ( UsageException $ex ) {
 236                         $this->assertEquals( 'editconflict', $ex->getCodeString() );
 237                 }
 238         }
 239
 240         function testEditConflict_redirect() {
 241                 static $count = 0;
 242                 $count++;
 243
 244                 // assume NS_HELP defaults to wikitext
 245                 $name = "Help:ApiEditPageTest_testEditConflict_redirect_$count";
 246                 $title = Title::newFromText( $name );
 247                 $page = WikiPage::factory( $title );
 248
 249                 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_r$count";
 250                 $rtitle = Title::newFromText( $rname );
 251                 $rpage = WikiPage::factory( $rtitle );
 252
 253                 // base edit for content
 254                 $page->doEditContent( new WikitextContent( "Foo" ),
 255                         "testing 1", EDIT_NEW, false, self::$users['sysop']->user );
 256                 $this->forceRevisionDate( $page, '20120101000000' );
 257                 $baseTime = $page->getRevision()->getTimestamp();
 258
 259                 // base edit for redirect
 260                 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
 261                         "testing 1", EDIT_NEW, false, self::$users['sysop']->user );
 262                 $this->forceRevisionDate( $rpage, '20120101000000' );
 263
 264                 // conflicting edit to redirect
 265                 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]\n\n[[Category:Test]]" ),
 266                         "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->user );
 267                 $this->forceRevisionDate( $rpage, '20120101020202' );
 268
 269                 // try to save edit; should work, because we follow the redirect
 270                 list( $re, , ) = $this->doApiRequestWithToken( array(
 271                         'action' => 'edit',
 272                         'title' => $rname,
 273                         'text' => 'nix bar!',
 274                         'basetimestamp' => $baseTime,
 275                         'redirect' => true,
 276                 ), null, self::$users['sysop']->user );
 277
 278                 $this->assertEquals( 'Success', $re['edit']['result'],
 279                         "no edit conflict expected when following redirect" );
 280
 281                 // try again, without following the redirect. Should fail.
 282                 try {
 283                         $this->doApiRequestWithToken( array(
 284                                 'action' => 'edit',
 285                                 'title' => $rname,
 286                                 'text' => 'nix bar!',
 287                                 'basetimestamp' => $baseTime,
 288                         ), null, self::$users['sysop']->user );
 289
 290                         $this->fail( 'edit conflict expected' );
 291                 } catch ( UsageException $ex ) {
 292                         $this->assertEquals( 'editconflict', $ex->getCodeString() );
 293                 }
 294         }
 295
 296         function testEditConflict_bug41990() {
 297                 static $count = 0;
 298                 $count++;
 299
 300                 /*
 301                 * bug 41990: if the target page has a newer revision than the redirect, then editing the
 302                 * redirect while specifying 'redirect' and *not* specifying 'basetimestamp' erronously
 303                 * caused an edit conflict to be detected.
 304                 */
 305
 306                 // assume NS_HELP defaults to wikitext
 307                 $name = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_$count";
 308                 $title = Title::newFromText( $name );
 309                 $page = WikiPage::factory( $title );
 310
 311                 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_r$count";
 312                 $rtitle = Title::newFromText( $rname );
 313                 $rpage = WikiPage::factory( $rtitle );
 314
 315                 // base edit for content
 316                 $page->doEditContent( new WikitextContent( "Foo" ),
 317                         "testing 1", EDIT_NEW, false, self::$users['sysop']->user );
 318                 $this->forceRevisionDate( $page, '20120101000000' );
 319
 320                 // base edit for redirect
 321                 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
 322                         "testing 1", EDIT_NEW, false, self::$users['sysop']->user );
 323                 $this->forceRevisionDate( $rpage, '20120101000000' );
 324                 $baseTime = $rpage->getRevision()->getTimestamp();
 325
 326                 // new edit to content
 327                 $page->doEditContent( new WikitextContent( "Foo bar" ),
 328                         "testing 2", EDIT_UPDATE, $page->getLatest(), self::$users['uploader']->user );
 329                 $this->forceRevisionDate( $rpage, '20120101020202' );
 330
 331                 // try to save edit; should work, following the redirect.
 332                 list( $re, , ) = $this->doApiRequestWithToken( array(
 333                         'action' => 'edit',
 334                         'title' => $rname,
 335                         'text' => 'nix bar!',
 336                         'redirect' => true,
 337                 ), null, self::$users['sysop']->user );
 338
 339                 $this->assertEquals( 'Success', $re['edit']['result'],
 340                         "no edit conflict expected here" );
 341         }
 342
 343         protected function forceRevisionDate( WikiPage $page, $timestamp ) {
 344                 $dbw = wfGetDB( DB_MASTER );
 345
 346                 $dbw->update( 'revision',
 347                         array( 'rev_timestamp' => $dbw->timestamp( $timestamp ) ),
 348                         array( 'rev_id' => $page->getLatest() ) );
 349
 350                 $page->clear();
 351         }
 352 }