3926e85a3ab934c6c1bb605edd2347b202884dbc
4 * Tests for MediaWiki api.php?action=edit.
6 * @author Daniel Kinzler
12 class ApiEditPageTest
extends ApiTestCase
{
14 public function setUp() {
15 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
19 $wgExtraNamespaces[12312] = 'Dummy';
20 $wgExtraNamespaces[12313] = 'Dummy_talk';
22 $wgNamespaceContentModels[12312] = "testing";
23 $wgContentHandlers["testing"] = 'DummyContentHandlerForTesting';
25 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
26 $wgContLang->resetNamespaces(); # reset namespace cache
31 public function tearDown() {
32 global $wgExtraNamespaces, $wgNamespaceContentModels, $wgContentHandlers, $wgContLang;
34 unset( $wgExtraNamespaces[12312] );
35 unset( $wgExtraNamespaces[12313] );
37 unset( $wgNamespaceContentModels[12312] );
38 unset( $wgContentHandlers["testing"] );
40 MWNamespace
::getCanonicalNamespaces( true ); # reset namespace cache
41 $wgContLang->resetNamespaces(); # reset namespace cache
47 $name = 'Help:ApiEditPageTest_testEdit'; // assume Help namespace to default to wikitext
49 // -- test new page --------------------------------------------
50 $apiResult = $this->doApiRequestWithToken( array(
53 'text' => 'some text',
55 $apiResult = $apiResult[0];
57 // Validate API result data
58 $this->assertArrayHasKey( 'edit', $apiResult );
59 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
60 $this->assertEquals( 'Success', $apiResult['edit']['result'] );
62 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
63 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
65 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
67 // -- test existing page, no change ----------------------------
68 $data = $this->doApiRequestWithToken( array(
71 'text' => 'some text',
74 $this->assertEquals( 'Success', $data[0]['edit']['result'] );
76 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
77 $this->assertArrayHasKey( 'nochange', $data[0]['edit'] );
79 // -- test existing page, with change --------------------------
80 $data = $this->doApiRequestWithToken( array(
83 'text' => 'different text'
86 $this->assertEquals( 'Success', $data[0]['edit']['result'] );
88 $this->assertArrayNotHasKey( 'new', $data[0]['edit'] );
89 $this->assertArrayNotHasKey( 'nochange', $data[0]['edit'] );
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"
100 function testNonTextEdit() {
101 $name = 'Dummy:ApiEditPageTest_testNonTextEdit';
102 $data = serialize( 'some bla bla text' );
104 // -- test new page --------------------------------------------
105 $apiResult = $this->doApiRequestWithToken( array(
108 'text' => $data, ) );
109 $apiResult = $apiResult[0];
111 // Validate API result data
112 $this->assertArrayHasKey( 'edit', $apiResult );
113 $this->assertArrayHasKey( 'result', $apiResult['edit'] );
114 $this->assertEquals( 'Success', $apiResult['edit']['result'] );
116 $this->assertArrayHasKey( 'new', $apiResult['edit'] );
117 $this->assertArrayNotHasKey( 'nochange', $apiResult['edit'] );
119 $this->assertArrayHasKey( 'pageid', $apiResult['edit'] );
121 // validate resulting revision
122 $page = WikiPage
::factory( Title
::newFromText( $name ) );
123 $this->assertEquals( "testing", $page->getContentModel() );
124 $this->assertEquals( $data, $page->getContent()->serialize() );
127 public static function provideEditAppend() {
130 'foo', 'append', 'bar', "foobar"
133 'foo', 'prepend', 'bar', "barfoo"
135 array( #2: append to empty page
136 '', 'append', 'foo', "foo"
138 array( #3: prepend to empty page
139 '', 'prepend', 'foo', "foo"
141 array( #4: append to non-existing page
142 null, 'append', 'foo', "foo"
144 array( #5: prepend to non-existing page
145 null, 'prepend', 'foo', "foo"
151 * @dataProvider provideEditAppend
153 function testEditAppend( $text, $op, $append, $expected ) {
157 // assume NS_HELP defaults to wikitext
158 $name = "Help:ApiEditPageTest_testEditAppend_$count";
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(
167 'text' => '(dummy)', ) );
170 list( $re ) = $this->doApiRequestWithToken( array(
173 'text' => $text, ) );
175 $this->assertEquals( 'Success', $re['edit']['result'] ); // sanity
178 // -- try append/prepend --------------------------------------------
179 list( $re ) = $this->doApiRequestWithToken( array(
182 $op . 'text' => $append, ) );
184 $this->assertEquals( 'Success', $re['edit']['result'] );
186 // -- validate -----------------------------------------------------
187 $page = new WikiPage( Title
::newFromText( $name ) );
188 $content = $page->getContent();
189 $this->assertNotNull( $content, 'Page should have been created' );
191 $text = $content->getNativeData();
193 $this->assertEquals( $expected, $text );
197 * Test editing of sections
199 function testEditSection() {
200 $name = 'Help:ApiEditPageTest_testEditSection';
201 $page = WikiPage
::factory( Title
::newFromText( $name ) );
202 $text = "==section 1==\ncontent 1\n==section 2==\ncontent2";
203 // Preload the page with some text
204 $page->doEditContent( ContentHandler
::makeContent( $text, $page->getTitle() ), 'summary' );
206 list( $re ) = $this->doApiRequestWithToken( array(
210 'text' => "==section 1==\nnew content 1",
212 $this->assertEquals( 'Success', $re['edit']['result'] );
213 $newtext = WikiPage
::factory( Title
::newFromText( $name) )->getContent( Revision
::RAW
)->getNativeData();
214 $this->assertEquals( $newtext, "==section 1==\nnew content 1\n\n==section 2==\ncontent2" );
216 // Test that we raise a 'nosuchsection' error
218 $this->doApiRequestWithToken( array(
224 $this->fail( "Should have raised a UsageException" );
225 } catch ( UsageException
$e ) {
226 $this->assertEquals( $e->getCodeString(), 'nosuchsection' );
231 * Test action=edit§ion=new
232 * Run it twice so we test adding a new section on a
233 * page that doesn't exist (bug 52830) and one that
236 function testEditNewSection() {
237 $name = 'Help:ApiEditPageTest_testEditNewSection';
239 // Test on a page that does not already exist
240 $this->assertFalse( Title
::newFromText( $name )->exists() );
241 list( $re ) = $this->doApiRequestWithToken( array(
246 'summary' => 'header',
249 $this->assertEquals( 'Success', $re['edit']['result'] );
250 // Check the page text is correct
251 $text = WikiPage
::factory( Title
::newFromText( $name ) )->getContent( Revision
::RAW
)->getNativeData();
252 $this->assertEquals( $text, "== header ==\n\ntest" );
254 // Now on one that does
255 $this->assertTrue( Title
::newFromText( $name )->exists() );
256 list( $re2 ) = $this->doApiRequestWithToken( array(
261 'summary' => 'header',
264 $this->assertEquals( 'Success', $re2['edit']['result'] );
265 $text = WikiPage
::factory( Title
::newFromText( $name ) )->getContent( Revision
::RAW
)->getNativeData();
266 $this->assertEquals( $text, "== header ==\n\ntest\n\n== header ==\n\ntest" );
269 function testEditConflict() {
273 // assume NS_HELP defaults to wikitext
274 $name = "Help:ApiEditPageTest_testEditConflict_$count";
275 $title = Title
::newFromText( $name );
277 $page = WikiPage
::factory( $title );
280 $page->doEditContent( new WikitextContent( "Foo" ),
281 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
282 $this->forceRevisionDate( $page, '20120101000000' );
283 $baseTime = $page->getRevision()->getTimestamp();
286 $page->doEditContent( new WikitextContent( "Foo bar" ),
287 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
288 $this->forceRevisionDate( $page, '20120101020202' );
290 // try to save edit, expect conflict
292 $this->doApiRequestWithToken( array(
295 'text' => 'nix bar!',
296 'basetimestamp' => $baseTime,
297 ), null, self
::$users['sysop']->user
);
299 $this->fail( 'edit conflict expected' );
300 } catch ( UsageException
$ex ) {
301 $this->assertEquals( 'editconflict', $ex->getCodeString() );
305 function testEditConflict_redirect() {
309 // assume NS_HELP defaults to wikitext
310 $name = "Help:ApiEditPageTest_testEditConflict_redirect_$count";
311 $title = Title
::newFromText( $name );
312 $page = WikiPage
::factory( $title );
314 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_r$count";
315 $rtitle = Title
::newFromText( $rname );
316 $rpage = WikiPage
::factory( $rtitle );
318 // base edit for content
319 $page->doEditContent( new WikitextContent( "Foo" ),
320 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
321 $this->forceRevisionDate( $page, '20120101000000' );
322 $baseTime = $page->getRevision()->getTimestamp();
324 // base edit for redirect
325 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
326 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
327 $this->forceRevisionDate( $rpage, '20120101000000' );
329 // conflicting edit to redirect
330 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]\n\n[[Category:Test]]" ),
331 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
332 $this->forceRevisionDate( $rpage, '20120101020202' );
334 // try to save edit; should work, because we follow the redirect
335 list( $re, , ) = $this->doApiRequestWithToken( array(
338 'text' => 'nix bar!',
339 'basetimestamp' => $baseTime,
341 ), null, self
::$users['sysop']->user
);
343 $this->assertEquals( 'Success', $re['edit']['result'],
344 "no edit conflict expected when following redirect" );
346 // try again, without following the redirect. Should fail.
348 $this->doApiRequestWithToken( array(
351 'text' => 'nix bar!',
352 'basetimestamp' => $baseTime,
353 ), null, self
::$users['sysop']->user
);
355 $this->fail( 'edit conflict expected' );
356 } catch ( UsageException
$ex ) {
357 $this->assertEquals( 'editconflict', $ex->getCodeString() );
361 function testEditConflict_bug41990() {
366 * bug 41990: if the target page has a newer revision than the redirect, then editing the
367 * redirect while specifying 'redirect' and *not* specifying 'basetimestamp' erroneously
368 * caused an edit conflict to be detected.
371 // assume NS_HELP defaults to wikitext
372 $name = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_$count";
373 $title = Title
::newFromText( $name );
374 $page = WikiPage
::factory( $title );
376 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_r$count";
377 $rtitle = Title
::newFromText( $rname );
378 $rpage = WikiPage
::factory( $rtitle );
380 // base edit for content
381 $page->doEditContent( new WikitextContent( "Foo" ),
382 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
383 $this->forceRevisionDate( $page, '20120101000000' );
385 // base edit for redirect
386 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
387 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
388 $this->forceRevisionDate( $rpage, '20120101000000' );
389 $baseTime = $rpage->getRevision()->getTimestamp();
391 // new edit to content
392 $page->doEditContent( new WikitextContent( "Foo bar" ),
393 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
394 $this->forceRevisionDate( $rpage, '20120101020202' );
396 // try to save edit; should work, following the redirect.
397 list( $re, , ) = $this->doApiRequestWithToken( array(
400 'text' => 'nix bar!',
402 ), null, self
::$users['sysop']->user
);
404 $this->assertEquals( 'Success', $re['edit']['result'],
405 "no edit conflict expected here" );
408 protected function forceRevisionDate( WikiPage
$page, $timestamp ) {
409 $dbw = wfGetDB( DB_MASTER
);
411 $dbw->update( 'revision',
412 array( 'rev_timestamp' => $dbw->timestamp( $timestamp ) ),
413 array( 'rev_id' => $page->getLatest() ) );