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 action=edit§ion=new
198 * Run it twice so we test adding a new section on a
199 * page that doesn't exist (bug 52830) and one that
202 function testEditNewSection() {
203 $name = 'Help:ApiEditPageTest_testEditNewSection';
205 // Test on a page that does not already exist
206 $this->assertFalse( Title
::newFromText( $name )->exists() );
207 list( $re ) = $this->doApiRequestWithToken( array(
212 'summary' => 'header',
215 $this->assertEquals( 'Success', $re['edit']['result'] );
216 // Check the page text is correct
217 $text = WikiPage
::factory( Title
::newFromText( $name ) )->getContent( Revision
::RAW
)->getNativeData();
218 $this->assertEquals( $text, "== header ==\n\ntest" );
220 // Now on one that does
221 $this->assertTrue( Title
::newFromText( $name )->exists() );
222 list( $re2 ) = $this->doApiRequestWithToken( array(
227 'summary' => 'header',
230 $this->assertEquals( 'Success', $re2['edit']['result'] );
231 $text = WikiPage
::factory( Title
::newFromText( $name ) )->getContent( Revision
::RAW
)->getNativeData();
232 $this->assertEquals( $text, "== header ==\n\ntest\n\n== header ==\n\ntest" );
235 function testEditConflict() {
239 // assume NS_HELP defaults to wikitext
240 $name = "Help:ApiEditPageTest_testEditConflict_$count";
241 $title = Title
::newFromText( $name );
243 $page = WikiPage
::factory( $title );
246 $page->doEditContent( new WikitextContent( "Foo" ),
247 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
248 $this->forceRevisionDate( $page, '20120101000000' );
249 $baseTime = $page->getRevision()->getTimestamp();
252 $page->doEditContent( new WikitextContent( "Foo bar" ),
253 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
254 $this->forceRevisionDate( $page, '20120101020202' );
256 // try to save edit, expect conflict
258 $this->doApiRequestWithToken( array(
261 'text' => 'nix bar!',
262 'basetimestamp' => $baseTime,
263 ), null, self
::$users['sysop']->user
);
265 $this->fail( 'edit conflict expected' );
266 } catch ( UsageException
$ex ) {
267 $this->assertEquals( 'editconflict', $ex->getCodeString() );
271 function testEditConflict_redirect() {
275 // assume NS_HELP defaults to wikitext
276 $name = "Help:ApiEditPageTest_testEditConflict_redirect_$count";
277 $title = Title
::newFromText( $name );
278 $page = WikiPage
::factory( $title );
280 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_r$count";
281 $rtitle = Title
::newFromText( $rname );
282 $rpage = WikiPage
::factory( $rtitle );
284 // base edit for content
285 $page->doEditContent( new WikitextContent( "Foo" ),
286 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
287 $this->forceRevisionDate( $page, '20120101000000' );
288 $baseTime = $page->getRevision()->getTimestamp();
290 // base edit for redirect
291 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
292 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
293 $this->forceRevisionDate( $rpage, '20120101000000' );
295 // conflicting edit to redirect
296 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]\n\n[[Category:Test]]" ),
297 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
298 $this->forceRevisionDate( $rpage, '20120101020202' );
300 // try to save edit; should work, because we follow the redirect
301 list( $re, , ) = $this->doApiRequestWithToken( array(
304 'text' => 'nix bar!',
305 'basetimestamp' => $baseTime,
307 ), null, self
::$users['sysop']->user
);
309 $this->assertEquals( 'Success', $re['edit']['result'],
310 "no edit conflict expected when following redirect" );
312 // try again, without following the redirect. Should fail.
314 $this->doApiRequestWithToken( array(
317 'text' => 'nix bar!',
318 'basetimestamp' => $baseTime,
319 ), null, self
::$users['sysop']->user
);
321 $this->fail( 'edit conflict expected' );
322 } catch ( UsageException
$ex ) {
323 $this->assertEquals( 'editconflict', $ex->getCodeString() );
327 function testEditConflict_bug41990() {
332 * bug 41990: if the target page has a newer revision than the redirect, then editing the
333 * redirect while specifying 'redirect' and *not* specifying 'basetimestamp' erronously
334 * caused an edit conflict to be detected.
337 // assume NS_HELP defaults to wikitext
338 $name = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_$count";
339 $title = Title
::newFromText( $name );
340 $page = WikiPage
::factory( $title );
342 $rname = "Help:ApiEditPageTest_testEditConflict_redirect_bug41990_r$count";
343 $rtitle = Title
::newFromText( $rname );
344 $rpage = WikiPage
::factory( $rtitle );
346 // base edit for content
347 $page->doEditContent( new WikitextContent( "Foo" ),
348 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
349 $this->forceRevisionDate( $page, '20120101000000' );
351 // base edit for redirect
352 $rpage->doEditContent( new WikitextContent( "#REDIRECT [[$name]]" ),
353 "testing 1", EDIT_NEW
, false, self
::$users['sysop']->user
);
354 $this->forceRevisionDate( $rpage, '20120101000000' );
355 $baseTime = $rpage->getRevision()->getTimestamp();
357 // new edit to content
358 $page->doEditContent( new WikitextContent( "Foo bar" ),
359 "testing 2", EDIT_UPDATE
, $page->getLatest(), self
::$users['uploader']->user
);
360 $this->forceRevisionDate( $rpage, '20120101020202' );
362 // try to save edit; should work, following the redirect.
363 list( $re, , ) = $this->doApiRequestWithToken( array(
366 'text' => 'nix bar!',
368 ), null, self
::$users['sysop']->user
);
370 $this->assertEquals( 'Success', $re['edit']['result'],
371 "no edit conflict expected here" );
374 protected function forceRevisionDate( WikiPage
$page, $timestamp ) {
375 $dbw = wfGetDB( DB_MASTER
);
377 $dbw->update( 'revision',
378 array( 'rev_timestamp' => $dbw->timestamp( $timestamp ) ),
379 array( 'rev_id' => $page->getLatest() ) );