MediaWiki REL1_27
RevisionStorageTest.php
Go to the documentation of this file.
1<?php
2
17 private $the_page;
18
19 function __construct( $name = null, array $data = [], $dataName = '' ) {
20 parent::__construct( $name, $data, $dataName );
21
22 $this->tablesUsed = array_merge( $this->tablesUsed,
23 [ 'page',
24 'revision',
25 'text',
26
27 'recentchanges',
28 'logging',
29
30 'page_props',
31 'pagelinks',
32 'categorylinks',
33 'langlinks',
34 'externallinks',
35 'imagelinks',
36 'templatelinks',
37 'iwlinks' ] );
38 }
39
40 protected function setUp() {
42
43 parent::setUp();
44
45 $wgExtraNamespaces[12312] = 'Dummy';
46 $wgExtraNamespaces[12313] = 'Dummy_talk';
47
48 $wgNamespaceContentModels[12312] = 'DUMMY';
49 $wgContentHandlers['DUMMY'] = 'DummyContentHandlerForTesting';
50
51 MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
52 $wgContLang->resetNamespaces(); # reset namespace cache
53 if ( !$this->the_page ) {
54 $this->the_page = $this->createPage(
55 'RevisionStorageTest_the_page',
56 "just a dummy page",
58 );
59 }
60
61 $this->tablesUsed[] = 'archive';
62 }
63
64 protected function tearDown() {
66
67 parent::tearDown();
68
69 unset( $wgExtraNamespaces[12312] );
70 unset( $wgExtraNamespaces[12313] );
71
72 unset( $wgNamespaceContentModels[12312] );
73 unset( $wgContentHandlers['DUMMY'] );
74
75 MWNamespace::getCanonicalNamespaces( true ); # reset namespace cache
76 $wgContLang->resetNamespaces(); # reset namespace cache
77 }
78
79 protected function makeRevision( $props = null ) {
80 if ( $props === null ) {
81 $props = [];
82 }
83
84 if ( !isset( $props['content'] ) && !isset( $props['text'] ) ) {
85 $props['text'] = 'Lorem Ipsum';
86 }
87
88 if ( !isset( $props['comment'] ) ) {
89 $props['comment'] = 'just a test';
90 }
91
92 if ( !isset( $props['page'] ) ) {
93 $props['page'] = $this->the_page->getId();
94 }
95
96 $rev = new Revision( $props );
97
98 $dbw = wfGetDB( DB_MASTER );
99 $rev->insertOn( $dbw );
100
101 return $rev;
102 }
103
104 protected function createPage( $page, $text, $model = null ) {
105 if ( is_string( $page ) ) {
106 if ( !preg_match( '/:/', $page ) &&
107 ( $model === null || $model === CONTENT_MODEL_WIKITEXT )
108 ) {
109 $ns = $this->getDefaultWikitextNS();
111 }
112
114 }
115
116 if ( $page instanceof Title ) {
117 $page = new WikiPage( $page );
118 }
119
120 if ( $page->exists() ) {
121 $page->doDeleteArticle( "done" );
122 }
123
124 $content = ContentHandler::makeContent( $text, $page->getTitle(), $model );
125 $page->doEditContent( $content, "testing", EDIT_NEW );
126
127 return $page;
128 }
129
130 protected function assertRevEquals( Revision $orig, Revision $rev = null ) {
131 $this->assertNotNull( $rev, 'missing revision' );
132
133 $this->assertEquals( $orig->getId(), $rev->getId() );
134 $this->assertEquals( $orig->getPage(), $rev->getPage() );
135 $this->assertEquals( $orig->getTimestamp(), $rev->getTimestamp() );
136 $this->assertEquals( $orig->getUser(), $rev->getUser() );
137 $this->assertEquals( $orig->getContentModel(), $rev->getContentModel() );
138 $this->assertEquals( $orig->getContentFormat(), $rev->getContentFormat() );
139 $this->assertEquals( $orig->getSha1(), $rev->getSha1() );
140 }
141
145 public function testConstructFromRow() {
146 $orig = $this->makeRevision();
147
148 $dbr = wfGetDB( DB_SLAVE );
149 $res = $dbr->select( 'revision', '*', [ 'rev_id' => $orig->getId() ] );
150 $this->assertTrue( is_object( $res ), 'query failed' );
151
152 $row = $res->fetchObject();
153 $res->free();
154
155 $rev = new Revision( $row );
156
157 $this->assertRevEquals( $orig, $rev );
158 }
159
163 public function testNewFromRow() {
164 $orig = $this->makeRevision();
165
166 $dbr = wfGetDB( DB_SLAVE );
167 $res = $dbr->select( 'revision', '*', [ 'rev_id' => $orig->getId() ] );
168 $this->assertTrue( is_object( $res ), 'query failed' );
169
170 $row = $res->fetchObject();
171 $res->free();
172
173 $rev = Revision::newFromRow( $row );
174
175 $this->assertRevEquals( $orig, $rev );
176 }
177
181 public function testNewFromArchiveRow() {
182 $page = $this->createPage(
183 'RevisionStorageTest_testNewFromArchiveRow',
184 'Lorem Ipsum',
186 );
187 $orig = $page->getRevision();
188 $page->doDeleteArticle( 'test Revision::newFromArchiveRow' );
189
190 $dbr = wfGetDB( DB_SLAVE );
191 $res = $dbr->select( 'archive', '*', [ 'ar_rev_id' => $orig->getId() ] );
192 $this->assertTrue( is_object( $res ), 'query failed' );
193
194 $row = $res->fetchObject();
195 $res->free();
196
198
199 $this->assertRevEquals( $orig, $rev );
200 }
201
205 public function testNewFromId() {
206 $orig = $this->makeRevision();
207
208 $rev = Revision::newFromId( $orig->getId() );
209
210 $this->assertRevEquals( $orig, $rev );
211 }
212
216 public function testFetchRevision() {
217 $page = $this->createPage(
218 'RevisionStorageTest_testFetchRevision',
219 'one',
221 );
222
223 // Hidden process cache assertion below
224 $page->getRevision()->getId();
225
226 $page->doEditContent( new WikitextContent( 'two' ), 'second rev' );
227 $id = $page->getRevision()->getId();
228
229 $res = Revision::fetchRevision( $page->getTitle() );
230
231 # note: order is unspecified
232 $rows = [];
233 while ( ( $row = $res->fetchObject() ) ) {
234 $rows[$row->rev_id] = $row;
235 }
236
237 $this->assertEquals( 1, count( $rows ), 'expected exactly one revision' );
238 $this->assertArrayHasKey( $id, $rows, 'missing revision with id ' . $id );
239 }
240
244 public function testSelectFields() {
246
247 $fields = Revision::selectFields();
248
249 $this->assertTrue( in_array( 'rev_id', $fields ), 'missing rev_id in list of fields' );
250 $this->assertTrue( in_array( 'rev_page', $fields ), 'missing rev_page in list of fields' );
251 $this->assertTrue(
252 in_array( 'rev_timestamp', $fields ),
253 'missing rev_timestamp in list of fields'
254 );
255 $this->assertTrue( in_array( 'rev_user', $fields ), 'missing rev_user in list of fields' );
256
258 $this->assertTrue( in_array( 'rev_content_model', $fields ),
259 'missing rev_content_model in list of fields' );
260 $this->assertTrue( in_array( 'rev_content_format', $fields ),
261 'missing rev_content_format in list of fields' );
262 }
263 }
264
268 public function testGetPage() {
270
271 $orig = $this->makeRevision( [ 'page' => $page->getId() ] );
272 $rev = Revision::newFromId( $orig->getId() );
273
274 $this->assertEquals( $page->getId(), $rev->getPage() );
275 }
276
280 public function testGetText() {
281 $this->hideDeprecated( 'Revision::getText' );
282
283 $orig = $this->makeRevision( [ 'text' => 'hello hello.' ] );
284 $rev = Revision::newFromId( $orig->getId() );
285
286 $this->assertEquals( 'hello hello.', $rev->getText() );
287 }
288
292 public function testGetContent_failure() {
293 $rev = new Revision( [
294 'page' => $this->the_page->getId(),
295 'content_model' => $this->the_page->getContentModel(),
296 'text_id' => 123456789, // not in the test DB
297 ] );
298
299 $this->assertNull( $rev->getContent(),
300 "getContent() should return null if the revision's text blob could not be loaded." );
301
302 // NOTE: check this twice, once for lazy initialization, and once with the cached value.
303 $this->assertNull( $rev->getContent(),
304 "getContent() should return null if the revision's text blob could not be loaded." );
305 }
306
310 public function testGetContent() {
311 $orig = $this->makeRevision( [ 'text' => 'hello hello.' ] );
312 $rev = Revision::newFromId( $orig->getId() );
313
314 $this->assertEquals( 'hello hello.', $rev->getContent()->getNativeData() );
315 }
316
320 public function testGetContentModel() {
322
323 if ( !$wgContentHandlerUseDB ) {
324 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
325 }
326
327 $orig = $this->makeRevision( [ 'text' => 'hello hello.',
328 'content_model' => CONTENT_MODEL_JAVASCRIPT ] );
329 $rev = Revision::newFromId( $orig->getId() );
330
331 $this->assertEquals( CONTENT_MODEL_JAVASCRIPT, $rev->getContentModel() );
332 }
333
337 public function testGetContentFormat() {
339
340 if ( !$wgContentHandlerUseDB ) {
341 $this->markTestSkipped( '$wgContentHandlerUseDB is disabled' );
342 }
343
344 $orig = $this->makeRevision( [
345 'text' => 'hello hello.',
346 'content_model' => CONTENT_MODEL_JAVASCRIPT,
347 'content_format' => CONTENT_FORMAT_JAVASCRIPT
348 ] );
349 $rev = Revision::newFromId( $orig->getId() );
350
351 $this->assertEquals( CONTENT_FORMAT_JAVASCRIPT, $rev->getContentFormat() );
352 }
353
357 public function testIsCurrent() {
358 $page = $this->createPage(
359 'RevisionStorageTest_testIsCurrent',
360 'Lorem Ipsum',
362 );
363 $rev1 = $page->getRevision();
364
365 # @todo find out if this should be true
366 # $this->assertTrue( $rev1->isCurrent() );
367
368 $rev1x = Revision::newFromId( $rev1->getId() );
369 $this->assertTrue( $rev1x->isCurrent() );
370
371 $page->doEditContent(
373 'second rev'
374 );
375 $rev2 = $page->getRevision();
376
377 # @todo find out if this should be true
378 # $this->assertTrue( $rev2->isCurrent() );
379
380 $rev1x = Revision::newFromId( $rev1->getId() );
381 $this->assertFalse( $rev1x->isCurrent() );
382
383 $rev2x = Revision::newFromId( $rev2->getId() );
384 $this->assertTrue( $rev2x->isCurrent() );
385 }
386
390 public function testGetPrevious() {
391 $page = $this->createPage(
392 'RevisionStorageTest_testGetPrevious',
393 'Lorem Ipsum testGetPrevious',
395 );
396 $rev1 = $page->getRevision();
397
398 $this->assertNull( $rev1->getPrevious() );
399
400 $page->doEditContent(
402 'second rev testGetPrevious' );
403 $rev2 = $page->getRevision();
404
405 $this->assertNotNull( $rev2->getPrevious() );
406 $this->assertEquals( $rev1->getId(), $rev2->getPrevious()->getId() );
407 }
408
412 public function testGetNext() {
413 $page = $this->createPage(
414 'RevisionStorageTest_testGetNext',
415 'Lorem Ipsum testGetNext',
417 );
418 $rev1 = $page->getRevision();
419
420 $this->assertNull( $rev1->getNext() );
421
422 $page->doEditContent(
424 'second rev testGetNext'
425 );
426 $rev2 = $page->getRevision();
427
428 $this->assertNotNull( $rev1->getNext() );
429 $this->assertEquals( $rev2->getId(), $rev1->getNext()->getId() );
430 }
431
435 public function testNewNullRevision() {
436 $page = $this->createPage(
437 'RevisionStorageTest_testNewNullRevision',
438 'some testing text',
440 );
441 $orig = $page->getRevision();
442
443 $dbw = wfGetDB( DB_MASTER );
444 $rev = Revision::newNullRevision( $dbw, $page->getId(), 'a null revision', false );
445
446 $this->assertNotEquals( $orig->getId(), $rev->getId(),
447 'new null revision shold have a different id from the original revision' );
448 $this->assertEquals( $orig->getTextId(), $rev->getTextId(),
449 'new null revision shold have the same text id as the original revision' );
450 $this->assertEquals( 'some testing text', $rev->getContent()->getNativeData() );
451 }
452
453 public static function provideUserWasLastToEdit() {
454 return [
455 [ # 0
456 3, true, # actually the last edit
457 ],
458 [ # 1
459 2, true, # not the current edit, but still by this user
460 ],
461 [ # 2
462 1, false, # edit by another user
463 ],
464 [ # 3
465 0, false, # first edit, by this user, but another user edited in the mean time
466 ],
467 ];
468 }
469
473 public function testUserWasLastToEdit( $sinceIdx, $expectedLast ) {
474 $userA = User::newFromName( "RevisionStorageTest_userA" );
475 $userB = User::newFromName( "RevisionStorageTest_userB" );
476
477 if ( $userA->getId() === 0 ) {
478 $userA = User::createNew( $userA->getName() );
479 }
480
481 if ( $userB->getId() === 0 ) {
482 $userB = User::createNew( $userB->getName() );
483 }
484
485 $ns = $this->getDefaultWikitextNS();
486
487 $dbw = wfGetDB( DB_MASTER );
488 $revisions = [];
489
490 // create revisions -----------------------------
492 'RevisionStorageTest_testUserWasLastToEdit', $ns ) );
493 $page->insertOn( $dbw );
494
495 # zero
496 $revisions[0] = new Revision( [
497 'page' => $page->getId(),
498 // we need the title to determine the page's default content model
499 'title' => $page->getTitle(),
500 'timestamp' => '20120101000000',
501 'user' => $userA->getId(),
502 'text' => 'zero',
503 'content_model' => CONTENT_MODEL_WIKITEXT,
504 'summary' => 'edit zero'
505 ] );
506 $revisions[0]->insertOn( $dbw );
507
508 # one
509 $revisions[1] = new Revision( [
510 'page' => $page->getId(),
511 // still need the title, because $page->getId() is 0 (there's no entry in the page table)
512 'title' => $page->getTitle(),
513 'timestamp' => '20120101000100',
514 'user' => $userA->getId(),
515 'text' => 'one',
516 'content_model' => CONTENT_MODEL_WIKITEXT,
517 'summary' => 'edit one'
518 ] );
519 $revisions[1]->insertOn( $dbw );
520
521 # two
522 $revisions[2] = new Revision( [
523 'page' => $page->getId(),
524 'title' => $page->getTitle(),
525 'timestamp' => '20120101000200',
526 'user' => $userB->getId(),
527 'text' => 'two',
528 'content_model' => CONTENT_MODEL_WIKITEXT,
529 'summary' => 'edit two'
530 ] );
531 $revisions[2]->insertOn( $dbw );
532
533 # three
534 $revisions[3] = new Revision( [
535 'page' => $page->getId(),
536 'title' => $page->getTitle(),
537 'timestamp' => '20120101000300',
538 'user' => $userA->getId(),
539 'text' => 'three',
540 'content_model' => CONTENT_MODEL_WIKITEXT,
541 'summary' => 'edit three'
542 ] );
543 $revisions[3]->insertOn( $dbw );
544
545 # four
546 $revisions[4] = new Revision( [
547 'page' => $page->getId(),
548 'title' => $page->getTitle(),
549 'timestamp' => '20120101000200',
550 'user' => $userA->getId(),
551 'text' => 'zero',
552 'content_model' => CONTENT_MODEL_WIKITEXT,
553 'summary' => 'edit four'
554 ] );
555 $revisions[4]->insertOn( $dbw );
556
557 // test it ---------------------------------
558 $since = $revisions[$sinceIdx]->getTimestamp();
559
560 $wasLast = Revision::userWasLastToEdit( $dbw, $page->getId(), $userA->getId(), $since );
561
562 $this->assertEquals( $expectedLast, $wasLast );
563 }
564}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for and distribution as defined by Sections through of this document Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License Legal Entity shall mean the union of the acting entity and all other entities that control are controlled by or are under common control with that entity For the purposes of this definition control direct or to cause the direction or management of such whether by contract or including but not limited to software source documentation and configuration files Object form shall mean any form resulting from mechanical transformation or translation of a Source including but not limited to compiled object generated and conversions to other media types Work shall mean the work of whether in Source or Object made available under the as indicated by a copyright notice that is included in or attached to the whether in Source or Object that is based or other modifications as a an original work of authorship For the purposes of this Derivative Works shall not include works that remain separable or merely the Work and Derivative Works thereof Contribution shall mean any work of including the original version of the Work and any modifications or additions to that Work or Derivative Works that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner For the purposes of this submitted means any form of or written communication sent to the Licensor or its including but not limited to communication on electronic mailing source code control and issue tracking systems that are managed by
$wgExtraNamespaces
Additional namespaces.
$wgNamespaceContentModels
Associative array mapping namespace IDs to the name of the content model pages in that namespace shou...
$wgContentHandlerUseDB
Set to false to disable use of the database fields introduced by the ContentHandler facility.
$wgContentHandlers
Plugins for page content model handling.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
if($IP===false)
Definition WebStart.php:59
static makeContent( $text, Title $title=null, $modelId=null, $format=null)
Convenience function for creating a Content object from a given textual representation.
static getCanonicalName( $index)
Returns the canonical (English) name for a given index.
static getCanonicalNamespaces( $rebuild=false)
Returns array of all defined namespaces with their canonical (English) names.
getDefaultWikitextNS()
Returns the ID of a namespace that defaults to Wikitext.
hideDeprecated( $function)
Don't throw a warning if $function is deprecated and called later.
Test class for Revision storage.
testGetPage()
Revision::getPage.
testGetText()
Revision::getText.
assertRevEquals(Revision $orig, Revision $rev=null)
testGetPrevious()
Revision::getPrevious.
testGetContent()
Revision::getContent.
testSelectFields()
Revision::selectFields.
testConstructFromRow()
Revision::__construct.
testIsCurrent()
Revision::isCurrent.
testNewFromId()
Revision::newFromId.
testFetchRevision()
Revision::fetchRevision.
testUserWasLastToEdit( $sinceIdx, $expectedLast)
provideUserWasLastToEdit
testGetContentFormat()
Revision::getContentFormat.
__construct( $name=null, array $data=[], $dataName='')
testGetContentModel()
Revision::getContentModel.
testNewFromRow()
Revision::newFromRow.
testGetContent_failure()
Revision::getContent.
testNewFromArchiveRow()
Revision::newFromArchiveRow.
createPage( $page, $text, $model=null)
testNewNullRevision()
Revision::newNullRevision.
testGetNext()
Revision::getNext.
getId()
Get revision ID.
Definition Revision.php:716
getContentFormat()
Returns the content format for this revision.
static selectFields()
Return the list of revision fields that should be selected to create a new revision.
Definition Revision.php:429
getPage()
Get the page ID.
Definition Revision.php:812
static newFromRow( $row)
Definition Revision.php:219
static newNullRevision( $dbw, $pageId, $summary, $minor, $user=null)
Create a new null-revision for insertion into a page's history.
getContentModel()
Returns the content model for this revision.
getUser( $audience=self::FOR_PUBLIC, User $user=null)
Fetch revision's user id if it's available to the specified audience.
Definition Revision.php:829
static newFromArchiveRow( $row, $overrides=[])
Make a fake revision object from an archive table row.
Definition Revision.php:172
getSha1()
Returns the base36 sha1 of the text in this revision, or null if unknown.
Definition Revision.php:762
static userWasLastToEdit( $db, $pageId, $userId, $since)
Check if no edits were made by other users since the time a user started editing the page.
static fetchRevision( $title)
Return a wrapper for a series of database rows to fetch all of a given page's revisions in turn.
Definition Revision.php:363
static newFromId( $id, $flags=0)
Load a page revision from a given revision ID number.
Definition Revision.php:99
Represents a title within MediaWiki.
Definition Title.php:34
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition Title.php:277
Class representing a MediaWiki article and history.
Definition WikiPage.php:29
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:99
Content object for wiki text pages.
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of edited
$res
Definition database.txt:21
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a function
Definition design.txt:94
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
const CONTENT_FORMAT_JAVASCRIPT
Definition Defines.php:295
const DB_MASTER
Definition Defines.php:48
const CONTENT_MODEL_WIKITEXT
Definition Defines.php:278
const CONTENT_MODEL_JAVASCRIPT
Definition Defines.php:279
const EDIT_NEW
Definition Defines.php:180
const DB_SLAVE
Definition Defines.php:47
the array() calling protocol came about after MediaWiki 1.4rc1.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
Definition hooks.txt:2379
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition hooks.txt:1040
null for the local wiki Added in
Definition hooks.txt:1421
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:314
presenting them properly to the user as errors is done by the caller return true use this to change the list i e etc $rev
Definition hooks.txt:1597
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
you have access to all of the normal MediaWiki so you can get a DB use the cache
#define the
table suitable for use with IDatabase::select()