MediaWiki  master
RevisionStoreRecordTest.php
Go to the documentation of this file.
1 <?php
2 
4 
15 use Title;
16 
22 
24 
30  protected function newRevision( array $rowOverrides = [] ) {
31  $title = Title::newFromText( 'Dummy' );
32  $title->resetArticleID( 17 );
33 
34  $user = new UserIdentityValue( 11, 'Tester', 0 );
35  $comment = CommentStoreComment::newUnsavedComment( 'Hello World' );
36 
37  $main = SlotRecord::newUnsaved( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
38  $aux = SlotRecord::newUnsaved( 'aux', new TextContent( 'Frumious Bandersnatch' ) );
39  $slots = new RevisionSlots( [ $main, $aux ] );
40 
41  $row = [
42  'rev_id' => '7',
43  'rev_page' => strval( $title->getArticleID() ),
44  'rev_timestamp' => '20200101000000',
45  'rev_deleted' => 0,
46  'rev_minor_edit' => 0,
47  'rev_parent_id' => '5',
48  'rev_len' => $slots->computeSize(),
49  'rev_sha1' => $slots->computeSha1(),
50  'page_latest' => '18',
51  ];
52 
53  $row = array_merge( $row, $rowOverrides );
54 
55  return new RevisionStoreRecord( $title, $user, $comment, (object)$row, $slots );
56  }
57 
58  public function provideConstructor() {
59  $title = Title::newFromText( 'Dummy' );
60  $title->resetArticleID( 17 );
61 
62  $user = new UserIdentityValue( 11, 'Tester', 0 );
63  $comment = CommentStoreComment::newUnsavedComment( 'Hello World' );
64 
65  $main = SlotRecord::newUnsaved( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
66  $aux = SlotRecord::newUnsaved( 'aux', new TextContent( 'Frumious Bandersnatch' ) );
67  $slots = new RevisionSlots( [ $main, $aux ] );
68 
69  $protoRow = [
70  'rev_id' => '7',
71  'rev_page' => strval( $title->getArticleID() ),
72  'rev_timestamp' => '20200101000000',
73  'rev_deleted' => 0,
74  'rev_minor_edit' => 0,
75  'rev_parent_id' => '5',
76  'rev_len' => $slots->computeSize(),
77  'rev_sha1' => $slots->computeSha1(),
78  'page_latest' => '18',
79  ];
80 
81  $row = $protoRow;
82  yield 'all info' => [
83  $title,
84  $user,
85  $comment,
86  (object)$row,
87  $slots,
88  'acmewiki'
89  ];
90 
91  $row = $protoRow;
92  $row['rev_minor_edit'] = '1';
93  $row['rev_deleted'] = strval( RevisionRecord::DELETED_USER );
94 
95  yield 'minor deleted' => [
96  $title,
97  $user,
98  $comment,
99  (object)$row,
100  $slots
101  ];
102 
103  $row = $protoRow;
104  $row['page_latest'] = $row['rev_id'];
105 
106  yield 'latest' => [
107  $title,
108  $user,
109  $comment,
110  (object)$row,
111  $slots
112  ];
113 
114  $row = $protoRow;
115  unset( $row['rev_parent'] );
116 
117  yield 'no parent' => [
118  $title,
119  $user,
120  $comment,
121  (object)$row,
122  $slots
123  ];
124 
125  $row = $protoRow;
126  $row['rev_len'] = null;
127  $row['rev_sha1'] = '';
128 
129  yield 'rev_len is null, rev_sha1 is ""' => [
130  $title,
131  $user,
132  $comment,
133  (object)$row,
134  $slots
135  ];
136 
137  $row = $protoRow;
138  yield 'no length, no hash' => [
139  Title::newFromText( 'DummyDoesNotExist' ),
140  $user,
141  $comment,
142  (object)$row,
143  $slots
144  ];
145  }
146 
157  public function testConstructorAndGetters(
158  Title $title,
160  CommentStoreComment $comment,
161  $row,
162  RevisionSlots $slots,
163  $wikiId = false
164  ) {
165  $rec = new RevisionStoreRecord( $title, $user, $comment, $row, $slots, $wikiId );
166 
167  $this->assertSame( $title, $rec->getPageAsLinkTarget(), 'getPageAsLinkTarget' );
168  $this->assertSame( $user, $rec->getUser( RevisionRecord::RAW ), 'getUser' );
169  $this->assertSame( $comment, $rec->getComment(), 'getComment' );
170 
171  $this->assertSame( $slots, $rec->getSlots(), 'getSlots' );
172  $this->assertSame( $slots->getSlotRoles(), $rec->getSlotRoles(), 'getSlotRoles' );
173  $this->assertSame( $slots->getSlots(), $rec->getSlots()->getSlots(), 'getSlots' );
174  $this->assertSame( $wikiId, $rec->getWikiId(), 'getWikiId' );
175 
176  $this->assertSame( (int)$row->rev_id, $rec->getId(), 'getId' );
177  $this->assertSame( (int)$row->rev_page, $rec->getPageId(), 'getId' );
178  $this->assertSame( $row->rev_timestamp, $rec->getTimestamp(), 'getTimestamp' );
179  $this->assertSame( (int)$row->rev_deleted, $rec->getVisibility(), 'getVisibility' );
180  $this->assertSame( (bool)$row->rev_minor_edit, $rec->isMinor(), 'getIsMinor' );
181 
182  if ( isset( $row->rev_parent_id ) ) {
183  $this->assertSame( (int)$row->rev_parent_id, $rec->getParentId(), 'getParentId' );
184  } else {
185  $this->assertSame( 0, $rec->getParentId(), 'getParentId' );
186  }
187 
188  if ( isset( $row->rev_len ) ) {
189  $this->assertSame( (int)$row->rev_len, $rec->getSize(), 'getSize' );
190  } else {
191  $this->assertSame( $slots->computeSize(), $rec->getSize(), 'getSize' );
192  }
193 
194  if ( !empty( $row->rev_sha1 ) ) {
195  $this->assertSame( $row->rev_sha1, $rec->getSha1(), 'getSha1' );
196  } else {
197  $this->assertSame( $slots->computeSha1(), $rec->getSha1(), 'getSha1' );
198  }
199 
200  if ( isset( $row->page_latest ) ) {
201  $this->assertSame(
202  (int)$row->rev_id === (int)$row->page_latest,
203  $rec->isCurrent(),
204  'isCurrent'
205  );
206  } else {
207  $this->assertSame(
208  false,
209  $rec->isCurrent(),
210  'isCurrent'
211  );
212  }
213  }
214 
215  public function provideConstructorFailure() {
216  $title = Title::newFromText( 'Dummy' );
217  $title->resetArticleID( 17 );
218 
219  $user = new UserIdentityValue( 11, 'Tester', 0 );
220 
221  $comment = CommentStoreComment::newUnsavedComment( 'Hello World' );
222 
223  $main = SlotRecord::newUnsaved( SlotRecord::MAIN, new TextContent( 'Lorem Ipsum' ) );
224  $aux = SlotRecord::newUnsaved( 'aux', new TextContent( 'Frumious Bandersnatch' ) );
225  $slots = new RevisionSlots( [ $main, $aux ] );
226 
227  $protoRow = [
228  'rev_id' => '7',
229  'rev_page' => strval( $title->getArticleID() ),
230  'rev_timestamp' => '20200101000000',
231  'rev_deleted' => 0,
232  'rev_minor_edit' => 0,
233  'rev_parent_id' => '5',
234  'rev_len' => $slots->computeSize(),
235  'rev_sha1' => $slots->computeSha1(),
236  'page_latest' => '18',
237  ];
238 
239  yield 'not a row' => [
240  $title,
241  $user,
242  $comment,
243  'not a row',
244  $slots,
245  'acmewiki'
246  ];
247 
248  $row = $protoRow;
249  $row['rev_timestamp'] = 'kittens';
250 
251  yield 'bad timestamp' => [
252  $title,
253  $user,
254  $comment,
255  (object)$row,
256  $slots
257  ];
258 
259  $row = $protoRow;
260  $row['rev_page'] = 99;
261 
262  yield 'page ID mismatch' => [
263  $title,
264  $user,
265  $comment,
266  (object)$row,
267  $slots
268  ];
269 
270  $row = $protoRow;
271 
272  yield 'bad wiki' => [
273  $title,
274  $user,
275  $comment,
276  (object)$row,
277  $slots,
278  12345
279  ];
280  }
281 
292  public function testConstructorFailure(
293  Title $title,
295  CommentStoreComment $comment,
296  $row,
297  RevisionSlots $slots,
298  $wikiId = false
299  ) {
300  $this->setExpectedException( InvalidArgumentException::class );
301  new RevisionStoreRecord( $title, $user, $comment, $row, $slots, $wikiId );
302  }
303 
304  public function provideIsCurrent() {
305  yield [
306  [
307  'rev_id' => 11,
308  'page_latest' => 11,
309  ],
310  true,
311  ];
312  yield [
313  [
314  'rev_id' => 11,
315  'page_latest' => 10,
316  ],
317  false,
318  ];
319  }
320 
324  public function testIsCurrent( $row, $current ) {
325  $rev = $this->newRevision( $row );
326 
327  $this->assertSame( $current, $rev->isCurrent(), 'isCurrent()' );
328  }
329 
330  public function provideGetSlot_audience_latest() {
332  }
333 
337  public function testGetSlot_audience_latest( $visibility, $groups, $userCan, $publicCan ) {
338  $this->forceStandardPermissions();
339 
340  $user = $this->getTestUser( $groups )->getUser();
341  $rev = $this->newRevision(
342  [
343  'rev_deleted' => $visibility,
344  'rev_id' => 11,
345  'page_latest' => 11, // revision is current
346  ]
347  );
348 
349  // NOTE: slot meta-data is never suppressed, just the content is!
350  $this->assertNotNull( $rev->getSlot( SlotRecord::MAIN, RevisionRecord::RAW ), 'raw can' );
351  $this->assertNotNull( $rev->getSlot( SlotRecord::MAIN, RevisionRecord::FOR_PUBLIC ),
352  'public can' );
353 
354  $this->assertNotNull(
356  'user can'
357  );
358 
359  $rev->getSlot( SlotRecord::MAIN, RevisionRecord::RAW )->getContent();
360  // NOTE: the content of the current revision is never suppressed!
361  // Check that getContent() doesn't throw SuppressedDataException
362  $rev->getSlot( SlotRecord::MAIN, RevisionRecord::FOR_PUBLIC )->getContent();
363  $rev->getSlot( SlotRecord::MAIN, RevisionRecord::FOR_THIS_USER, $user )->getContent();
364  }
365 
366 }
A RevisionRecord representing an existing revision persisted in the revision table.
\MediaWiki\Revision\RevisionStoreRecord \MediaWiki\Revision\RevisionRecord
computeSha1()
Computes the combined hash of the revisions&#39;s slots.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getSlotRoles()
Returns the slot names (roles) of all slots present in this revision.
globals will be eliminated from MediaWiki replaced by an application object which would be passed to constructors Whether that would be an convenient solution remains to be but certainly PHP makes such object oriented programming models easier than they were in previous versions For the time being MediaWiki programmers will have to work in an environment with some global context At the time of globals were initialised on startup by MediaWiki of these were configuration which are documented in DefaultSettings php There is no comprehensive documentation for the remaining however some of the most important ones are listed below They are typically initialised either in index php or in Setup php $wgTitle Title object created from the request URL $wgOut OutputPage object for HTTP response $wgUser User object for the user associated with the current request $wgLang Language object selected by user preferences $wgContLang Language object associated with the wiki being viewed $wgParser Parser object Parser extensions register their hooks here $wgRequest WebRequest object
Definition: globals.txt:25
static newUnsavedComment( $comment, array $data=null)
Create a new, unsaved CommentStoreComment.
testConstructorFailure(Title $title, UserIdentity $user, CommentStoreComment $comment, $row, RevisionSlots $slots, $wikiId=false)
provideConstructorFailure
Interface for objects representing user identity.
testGetSlot_audience_latest( $visibility, $groups, $userCan, $publicCan)
provideGetSlot_audience_latest
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
Value object representing a user&#39;s identity.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
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:1747
testConstructorAndGetters(Title $title, UserIdentity $user, CommentStoreComment $comment, $row, RevisionSlots $slots, $wikiId=false)
provideConstructor
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:35
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:52
getSlots()
Returns an associative array that maps role names to SlotRecords.
trait RevisionRecordTests
\MediaWiki\Revision\RevisionRecord
static newUnsaved( $role, Content $content)
Constructs a new Slot from a Content object for a new revision.
Definition: SlotRecord.php:129
Value object representing the set of slots belonging to a revision.
computeSize()
Computes the total nominal size of the revision&#39;s slots, in bogo-bytes.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1454
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:320