1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
|
<?php
/**
* @todo document
* @file
*/
/**
* @todo document
*/
class Revision {
const DELETED_TEXT = 1;
const DELETED_COMMENT = 2;
const DELETED_USER = 4;
const DELETED_RESTRICTED = 8;
// Audience options for Revision::getText()
const FOR_PUBLIC = 1;
const FOR_THIS_USER = 2;
const RAW = 3;
/**
* Load a page revision from a given revision ID number.
* Returns null if no such revision can be found.
*
* @param int $id
* @access public
* @static
*/
public static function newFromId( $id ) {
return Revision::newFromConds(
array( 'page_id=rev_page',
'rev_id' => intval( $id ) ) );
}
/**
* Load either the current, or a specified, revision
* that's attached to a given title. If not attached
* to that title, will return null.
*
* @param Title $title
* @param int $id
* @return Revision
*/
public static function newFromTitle( $title, $id = 0 ) {
$conds = array(
'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDBkey()
);
if ( $id ) {
// Use the specified ID
$conds['rev_id'] = $id;
} elseif ( wfGetLB()->getServerCount() > 1 ) {
// Get the latest revision ID from the master
$dbw = wfGetDB( DB_MASTER );
$latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__ );
if ( $latest === false ) {
// Page does not exist
return null;
}
$conds['rev_id'] = $latest;
} else {
// Use a join to get the latest revision
$conds[] = 'rev_id=page_latest';
}
$conds[] = 'page_id=rev_page';
return Revision::newFromConds( $conds );
}
/**
* Load a page revision from a given revision ID number.
* Returns null if no such revision can be found.
*
* @param Database $db
* @param int $id
* @access public
* @static
*/
public static function loadFromId( $db, $id ) {
return Revision::loadFromConds( $db,
array( 'page_id=rev_page',
'rev_id' => intval( $id ) ) );
}
/**
* Load either the current, or a specified, revision
* that's attached to a given page. If not attached
* to that page, will return null.
*
* @param Database $db
* @param int $pageid
* @param int $id
* @return Revision
* @access public
* @static
*/
public static function loadFromPageId( $db, $pageid, $id = 0 ) {
$conds=array('page_id=rev_page','rev_page'=>intval( $pageid ), 'page_id'=>intval( $pageid ));
if( $id ) {
$conds['rev_id']=intval($id);
} else {
$conds[]='rev_id=page_latest';
}
return Revision::loadFromConds( $db, $conds );
}
/**
* Load either the current, or a specified, revision
* that's attached to a given page. If not attached
* to that page, will return null.
*
* @param Database $db
* @param Title $title
* @param int $id
* @return Revision
* @access public
* @static
*/
public static function loadFromTitle( $db, $title, $id = 0 ) {
if( $id ) {
$matchId = intval( $id );
} else {
$matchId = 'page_latest';
}
return Revision::loadFromConds(
$db,
array( "rev_id=$matchId",
'page_id=rev_page',
'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDBkey() ) );
}
/**
* Load the revision for the given title with the given timestamp.
* WARNING: Timestamps may in some circumstances not be unique,
* so this isn't the best key to use.
*
* @param Database $db
* @param Title $title
* @param string $timestamp
* @return Revision
* @access public
* @static
*/
public static function loadFromTimestamp( $db, $title, $timestamp ) {
return Revision::loadFromConds(
$db,
array( 'rev_timestamp' => $db->timestamp( $timestamp ),
'page_id=rev_page',
'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDBkey() ) );
}
/**
* Given a set of conditions, fetch a revision.
*
* @param array $conditions
* @return Revision
* @access private
* @static
*/
private static function newFromConds( $conditions ) {
$db = wfGetDB( DB_SLAVE );
$row = Revision::loadFromConds( $db, $conditions );
if( is_null( $row ) && wfGetLB()->getServerCount() > 1 ) {
$dbw = wfGetDB( DB_MASTER );
$row = Revision::loadFromConds( $dbw, $conditions );
}
return $row;
}
/**
* Given a set of conditions, fetch a revision from
* the given database connection.
*
* @param Database $db
* @param array $conditions
* @return Revision
* @access private
* @static
*/
private static function loadFromConds( $db, $conditions ) {
$res = Revision::fetchFromConds( $db, $conditions );
if( $res ) {
$row = $res->fetchObject();
$res->free();
if( $row ) {
$ret = new Revision( $row );
return $ret;
}
}
$ret = null;
return $ret;
}
/**
* Return a wrapper for a series of database rows to
* fetch all of a given page's revisions in turn.
* Each row can be fed to the constructor to get objects.
*
* @param Title $title
* @return ResultWrapper
* @access public
* @static
*/
public static function fetchAllRevisions( $title ) {
return Revision::fetchFromConds(
wfGetDB( DB_SLAVE ),
array( 'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDBkey(),
'page_id=rev_page' ) );
}
/**
* Return a wrapper for a series of database rows to
* fetch all of a given page's revisions in turn.
* Each row can be fed to the constructor to get objects.
*
* @param Title $title
* @return ResultWrapper
* @access public
* @static
*/
public static function fetchRevision( $title ) {
return Revision::fetchFromConds(
wfGetDB( DB_SLAVE ),
array( 'rev_id=page_latest',
'page_namespace' => $title->getNamespace(),
'page_title' => $title->getDBkey(),
'page_id=rev_page' ) );
}
/**
* Given a set of conditions, return a ResultWrapper
* which will return matching database rows with the
* fields necessary to build Revision objects.
*
* @param Database $db
* @param array $conditions
* @return ResultWrapper
* @access private
* @static
*/
private static function fetchFromConds( $db, $conditions ) {
$fields = self::selectFields();
$fields[] = 'page_namespace';
$fields[] = 'page_title';
$fields[] = 'page_latest';
$res = $db->select(
array( 'page', 'revision' ),
$fields,
$conditions,
__METHOD__,
array( 'LIMIT' => 1 ) );
$ret = $db->resultObject( $res );
return $ret;
}
/**
* Return the list of revision fields that should be selected to create
* a new revision.
*/
static function selectFields() {
return array(
'rev_id',
'rev_page',
'rev_text_id',
'rev_timestamp',
'rev_comment',
'rev_user_text,'.
'rev_user',
'rev_minor_edit',
'rev_deleted',
'rev_len',
'rev_parent_id'
);
}
/**
* Return the list of text fields that should be selected to read the
* revision text
*/
static function selectTextFields() {
return array(
'old_text',
'old_flags'
);
}
/**
* Return the list of page fields that should be selected from page table
*/
static function selectPageFields() {
return array(
'page_namespace',
'page_title',
'page_latest'
);
}
/**
* @param object $row
* @access private
*/
function Revision( $row ) {
if( is_object( $row ) ) {
$this->mId = intval( $row->rev_id );
$this->mPage = intval( $row->rev_page );
$this->mTextId = intval( $row->rev_text_id );
$this->mComment = $row->rev_comment;
$this->mUserText = $row->rev_user_text;
$this->mUser = intval( $row->rev_user );
$this->mMinorEdit = intval( $row->rev_minor_edit );
$this->mTimestamp = $row->rev_timestamp;
$this->mDeleted = intval( $row->rev_deleted );
if( !isset( $row->rev_parent_id ) )
$this->mParentId = is_null($row->rev_parent_id) ? null : 0;
else
$this->mParentId = intval( $row->rev_parent_id );
if( !isset( $row->rev_len ) || is_null( $row->rev_len ) )
$this->mSize = null;
else
$this->mSize = intval( $row->rev_len );
if( isset( $row->page_latest ) ) {
$this->mCurrent = ( $row->rev_id == $row->page_latest );
$this->mTitle = Title::makeTitle( $row->page_namespace, $row->page_title );
$this->mTitle->resetArticleID( $this->mPage );
} else {
$this->mCurrent = false;
$this->mTitle = null;
}
// Lazy extraction...
$this->mText = null;
if( isset( $row->old_text ) ) {
$this->mTextRow = $row;
} else {
// 'text' table row entry will be lazy-loaded
$this->mTextRow = null;
}
} elseif( is_array( $row ) ) {
// Build a new revision to be saved...
global $wgUser;
$this->mId = isset( $row['id'] ) ? intval( $row['id'] ) : null;
$this->mPage = isset( $row['page'] ) ? intval( $row['page'] ) : null;
$this->mTextId = isset( $row['text_id'] ) ? intval( $row['text_id'] ) : null;
$this->mUserText = isset( $row['user_text'] ) ? strval( $row['user_text'] ) : $wgUser->getName();
$this->mUser = isset( $row['user'] ) ? intval( $row['user'] ) : $wgUser->getId();
$this->mMinorEdit = isset( $row['minor_edit'] ) ? intval( $row['minor_edit'] ) : 0;
$this->mTimestamp = isset( $row['timestamp'] ) ? strval( $row['timestamp'] ) : wfTimestamp( TS_MW );
$this->mDeleted = isset( $row['deleted'] ) ? intval( $row['deleted'] ) : 0;
$this->mSize = isset( $row['len'] ) ? intval( $row['len'] ) : null;
$this->mParentId = isset( $row['parent_id'] ) ? intval( $row['parent_id'] ) : null;
// Enforce spacing trimming on supplied text
$this->mComment = isset( $row['comment'] ) ? trim( strval( $row['comment'] ) ) : null;
$this->mText = isset( $row['text'] ) ? rtrim( strval( $row['text'] ) ) : null;
$this->mTextRow = null;
$this->mTitle = null; # Load on demand if needed
$this->mCurrent = false;
# If we still have no len_size, see it we have the text to figure it out
if ( !$this->mSize )
$this->mSize = is_null($this->mText) ? null : strlen($this->mText);
} else {
throw new MWException( 'Revision constructor passed invalid row format.' );
}
$this->mUnpatrolled = NULL;
}
/**#@+
* @access public
*/
/**
* Get revision ID
* @return int
*/
public function getId() {
return $this->mId;
}
/**
* Get text row ID
* @return int
*/
public function getTextId() {
return $this->mTextId;
}
/**
* Get parent revision ID (the original previous page revision)
* @return int
*/
public function getParentId() {
return $this->mParentId;
}
/**
* Returns the length of the text in this revision, or null if unknown.
* @return int
*/
public function getSize() {
return $this->mSize;
}
/**
* Returns the title of the page associated with this entry.
* @return Title
*/
public function getTitle() {
if( isset( $this->mTitle ) ) {
return $this->mTitle;
}
$dbr = wfGetDB( DB_SLAVE );
$row = $dbr->selectRow(
array( 'page', 'revision' ),
array( 'page_namespace', 'page_title' ),
array( 'page_id=rev_page',
'rev_id' => $this->mId ),
'Revision::getTitle' );
if( $row ) {
$this->mTitle = Title::makeTitle( $row->page_namespace,
$row->page_title );
}
return $this->mTitle;
}
/**
* Set the title of the revision
* @param Title $title
*/
public function setTitle( $title ) {
$this->mTitle = $title;
}
/**
* Get the page ID
* @return int
*/
public function getPage() {
return $this->mPage;
}
/**
* Fetch revision's user id if it's available to the specified audience.
* If the specified audience does not have access to it, zero will be
* returned.
*
* @param integer $audience One of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the ID regardless of permissions
*
*
* @return int
*/
public function getUser( $audience = self::FOR_PUBLIC ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_USER ) ) {
return 0;
} elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER ) ) {
return 0;
} else {
return $this->mUser;
}
}
/**
* Fetch revision's user id without regard for the current user's permissions
* @return string
*/
public function getRawUser() {
return $this->mUser;
}
/**
* Fetch revision's username if it's available to the specified audience.
* If the specified audience does not have access to the username, an
* empty string will be returned.
*
* @param integer $audience One of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
*
* @return string
*/
public function getUserText( $audience = self::FOR_PUBLIC ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_USER ) ) {
return "";
} elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_USER ) ) {
return "";
} else {
return $this->mUserText;
}
}
/**
* Fetch revision's username without regard for view restrictions
* @return string
*/
public function getRawUserText() {
return $this->mUserText;
}
/**
* Fetch revision comment if it's available to the specified audience.
* If the specified audience does not have access to the comment, an
* empty string will be returned.
*
* @param integer $audience One of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
*
* @return string
*/
function getComment( $audience = self::FOR_PUBLIC ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_COMMENT ) ) {
return "";
} elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_COMMENT ) ) {
return "";
} else {
return $this->mComment;
}
}
/**
* Fetch revision comment without regard for the current user's permissions
* @return string
*/
public function getRawComment() {
return $this->mComment;
}
/**
* @return bool
*/
public function isMinor() {
return (bool)$this->mMinorEdit;
}
/**
* @return int rcid of the unpatrolled row, zero if there isn't one
*/
public function isUnpatrolled() {
if( $this->mUnpatrolled !== NULL ) {
return $this->mUnpatrolled;
}
$dbr = wfGetDB( DB_SLAVE );
$this->mUnpatrolled = $dbr->selectField( 'recentchanges',
'rc_id',
array( // Add redundant user,timestamp condition so we can use the existing index
'rc_user_text' => $this->getRawUserText(),
'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
'rc_this_oldid' => $this->getId(),
'rc_patrolled' => 0
),
__METHOD__
);
return (int)$this->mUnpatrolled;
}
/**
* int $field one of DELETED_* bitfield constants
* @return bool
*/
public function isDeleted( $field ) {
return ($this->mDeleted & $field) == $field;
}
/**
* Get the deletion bitfield of the revision
*/
public function getVisibility() {
return (int)$this->mDeleted;
}
/**
* Fetch revision text if it's available to the specified audience.
* If the specified audience does not have the ability to view this
* revision, an empty string will be returned.
*
* @param integer $audience One of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
*
*
* @return string
*/
public function getText( $audience = self::FOR_PUBLIC ) {
if( $audience == self::FOR_PUBLIC && $this->isDeleted( self::DELETED_TEXT ) ) {
return "";
} elseif( $audience == self::FOR_THIS_USER && !$this->userCan( self::DELETED_TEXT ) ) {
return "";
} else {
return $this->getRawText();
}
}
/**
* Alias for getText(Revision::FOR_THIS_USER)
*/
public function revText() {
return $this->getText( self::FOR_THIS_USER );
}
/**
* Fetch revision text without regard for view restrictions
* @return string
*/
public function getRawText() {
if( is_null( $this->mText ) ) {
// Revision text is immutable. Load on demand:
$this->mText = $this->loadText();
}
return $this->mText;
}
/**
* @return string
*/
public function getTimestamp() {
return wfTimestamp(TS_MW, $this->mTimestamp);
}
/**
* @return bool
*/
public function isCurrent() {
return $this->mCurrent;
}
/**
* Get previous revision for this title
* @return Revision
*/
public function getPrevious() {
if( $this->getTitle() ) {
$prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
if( $prev ) {
return Revision::newFromTitle( $this->getTitle(), $prev );
}
}
return null;
}
/**
* @return Revision
*/
public function getNext() {
if( $this->getTitle() ) {
$next = $this->getTitle()->getNextRevisionID( $this->getId() );
if ( $next ) {
return Revision::newFromTitle( $this->getTitle(), $next );
}
}
return null;
}
/**
* Get previous revision Id for this page_id
* This is used to populate rev_parent_id on save
* @param Database $db
* @return int
*/
private function getPreviousRevisionId( $db ) {
if( is_null($this->mPage) ) {
return 0;
}
# Use page_latest if ID is not given
if( !$this->mId ) {
$prevId = $db->selectField( 'page', 'page_latest',
array( 'page_id' => $this->mPage ),
__METHOD__ );
} else {
$prevId = $db->selectField( 'revision', 'rev_id',
array( 'rev_page' => $this->mPage, 'rev_id < ' . $this->mId ),
__METHOD__,
array( 'ORDER BY' => 'rev_id DESC' ) );
}
return intval($prevId);
}
/**
* Get revision text associated with an old or archive row
* $row is usually an object from wfFetchRow(), both the flags and the text
* field must be included
*
* @param object $row The text data
* @param string $prefix table prefix (default 'old_')
* @return string $text|false the text requested
*/
public static function getRevisionText( $row, $prefix = 'old_' ) {
wfProfileIn( __METHOD__ );
# Get data
$textField = $prefix . 'text';
$flagsField = $prefix . 'flags';
if( isset( $row->$flagsField ) ) {
$flags = explode( ',', $row->$flagsField );
} else {
$flags = array();
}
if( isset( $row->$textField ) ) {
$text = $row->$textField;
} else {
wfProfileOut( __METHOD__ );
return false;
}
# Use external methods for external objects, text in table is URL-only then
if ( in_array( 'external', $flags ) ) {
$url=$text;
@list(/* $proto */,$path)=explode('://',$url,2);
if ($path=="") {
wfProfileOut( __METHOD__ );
return false;
}
$text=ExternalStore::fetchFromURL($url);
}
// If the text was fetched without an error, convert it
if ( $text !== false ) {
if( in_array( 'gzip', $flags ) ) {
# Deal with optional compression of archived pages.
# This can be done periodically via maintenance/compressOld.php, and
# as pages are saved if $wgCompressRevisions is set.
$text = gzinflate( $text );
}
if( in_array( 'object', $flags ) ) {
# Generic compressed storage
$obj = unserialize( $text );
if ( !is_object( $obj ) ) {
// Invalid object
wfProfileOut( __METHOD__ );
return false;
}
$text = $obj->getText();
}
global $wgLegacyEncoding;
if( $wgLegacyEncoding && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) ) {
# Old revisions kept around in a legacy encoding?
# Upconvert on demand.
# ("utf8" checked for compatibility with some broken
# conversion scripts 2008-12-30)
global $wgInputEncoding, $wgContLang;
$text = $wgContLang->iconv( $wgLegacyEncoding, $wgInputEncoding, $text );
}
}
wfProfileOut( __METHOD__ );
return $text;
}
/**
* If $wgCompressRevisions is enabled, we will compress data.
* The input string is modified in place.
* Return value is the flags field: contains 'gzip' if the
* data is compressed, and 'utf-8' if we're saving in UTF-8
* mode.
*
* @param mixed $text reference to a text
* @return string
*/
public static function compressRevisionText( &$text ) {
global $wgCompressRevisions;
$flags = array();
# Revisions not marked this way will be converted
# on load if $wgLegacyCharset is set in the future.
$flags[] = 'utf-8';
if( $wgCompressRevisions ) {
if( function_exists( 'gzdeflate' ) ) {
$text = gzdeflate( $text );
$flags[] = 'gzip';
} else {
wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
}
}
return implode( ',', $flags );
}
/**
* Insert a new revision into the database, returning the new revision ID
* number on success and dies horribly on failure.
*
* @param Database $dbw
* @return int
*/
public function insertOn( $dbw ) {
global $wgDefaultExternalStore;
wfProfileIn( __METHOD__ );
$data = $this->mText;
$flags = Revision::compressRevisionText( $data );
# Write to external storage if required
if( $wgDefaultExternalStore ) {
// Store and get the URL
$data = ExternalStore::insertToDefault( $data );
if( !$data ) {
throw new MWException( "Unable to store text to external storage" );
}
if( $flags ) {
$flags .= ',';
}
$flags .= 'external';
}
# Record the text (or external storage URL) to the text table
if( !isset( $this->mTextId ) ) {
$old_id = $dbw->nextSequenceValue( 'text_old_id_val' );
$dbw->insert( 'text',
array(
'old_id' => $old_id,
'old_text' => $data,
'old_flags' => $flags,
), __METHOD__
);
$this->mTextId = $dbw->insertId();
}
# Record the edit in revisions
$rev_id = isset( $this->mId )
? $this->mId
: $dbw->nextSequenceValue( 'rev_rev_id_val' );
$dbw->insert( 'revision',
array(
'rev_id' => $rev_id,
'rev_page' => $this->mPage,
'rev_text_id' => $this->mTextId,
'rev_comment' => $this->mComment,
'rev_minor_edit' => $this->mMinorEdit ? 1 : 0,
'rev_user' => $this->mUser,
'rev_user_text' => $this->mUserText,
'rev_timestamp' => $dbw->timestamp( $this->mTimestamp ),
'rev_deleted' => $this->mDeleted,
'rev_len' => $this->mSize,
'rev_parent_id' => is_null($this->mParentId) ?
$this->getPreviousRevisionId( $dbw ) : $this->mParentId
), __METHOD__
);
$this->mId = !is_null($rev_id) ? $rev_id : $dbw->insertId();
wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
wfProfileOut( __METHOD__ );
return $this->mId;
}
/**
* Lazy-load the revision's text.
* Currently hardcoded to the 'text' table storage engine.
*
* @return string
*/
private function loadText() {
wfProfileIn( __METHOD__ );
// Caching may be beneficial for massive use of external storage
global $wgRevisionCacheExpiry, $wgMemc;
$key = wfMemcKey( 'revisiontext', 'textid', $this->getTextId() );
if( $wgRevisionCacheExpiry ) {
$text = $wgMemc->get( $key );
if( is_string( $text ) ) {
wfProfileOut( __METHOD__ );
return $text;
}
}
// If we kept data for lazy extraction, use it now...
if ( isset( $this->mTextRow ) ) {
$row = $this->mTextRow;
$this->mTextRow = null;
} else {
$row = null;
}
if( !$row ) {
// Text data is immutable; check slaves first.
$dbr = wfGetDB( DB_SLAVE );
$row = $dbr->selectRow( 'text',
array( 'old_text', 'old_flags' ),
array( 'old_id' => $this->getTextId() ),
__METHOD__ );
}
if( !$row && wfGetLB()->getServerCount() > 1 ) {
// Possible slave lag!
$dbw = wfGetDB( DB_MASTER );
$row = $dbw->selectRow( 'text',
array( 'old_text', 'old_flags' ),
array( 'old_id' => $this->getTextId() ),
__METHOD__ );
}
$text = self::getRevisionText( $row );
# No negative caching -- negative hits on text rows may be due to corrupted slave servers
if( $wgRevisionCacheExpiry && $text !== false ) {
$wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
}
wfProfileOut( __METHOD__ );
return $text;
}
/**
* Create a new null-revision for insertion into a page's
* history. This will not re-save the text, but simply refer
* to the text from the previous version.
*
* Such revisions can for instance identify page rename
* operations and other such meta-modifications.
*
* @param Database $dbw
* @param int $pageId ID number of the page to read from
* @param string $summary
* @param bool $minor
* @return Revision
*/
public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
wfProfileIn( __METHOD__ );
$current = $dbw->selectRow(
array( 'page', 'revision' ),
array( 'page_latest', 'rev_text_id', 'rev_len' ),
array(
'page_id' => $pageId,
'page_latest=rev_id',
),
__METHOD__ );
if( $current ) {
$revision = new Revision( array(
'page' => $pageId,
'comment' => $summary,
'minor_edit' => $minor,
'text_id' => $current->rev_text_id,
'parent_id' => $current->page_latest,
'len' => $current->rev_len
) );
} else {
$revision = null;
}
wfProfileOut( __METHOD__ );
return $revision;
}
/**
* Determine if the current user is allowed to view a particular
* field of this revision, if it's marked as deleted.
* @param int $field one of self::DELETED_TEXT,
* self::DELETED_COMMENT,
* self::DELETED_USER
* @return bool
*/
public function userCan( $field ) {
if( ( $this->mDeleted & $field ) == $field ) {
global $wgUser;
$permission = ( $this->mDeleted & self::DELETED_RESTRICTED ) == self::DELETED_RESTRICTED
? 'suppressrevision'
: 'deleterevision';
wfDebug( "Checking for $permission due to $field match on $this->mDeleted\n" );
return $wgUser->isAllowed( $permission );
} else {
return true;
}
}
/**
* Get rev_timestamp from rev_id, without loading the rest of the row
* @param Title $title
* @param integer $id
*/
static function getTimestampFromId( $title, $id ) {
$dbr = wfGetDB( DB_SLAVE );
// Casting fix for DB2
if ($id == '') {
$id = 0;
}
$conds = array( 'rev_id' => $id );
$conds['rev_page'] = $title->getArticleId();
$timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__ );
if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
# Not in slave, try master
$dbw = wfGetDB( DB_MASTER );
$timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__ );
}
return wfTimestamp( TS_MW, $timestamp );
}
/**
* Get count of revisions per page...not very efficient
* @param Database $db
* @param int $id, page id
*/
static function countByPageId( $db, $id ) {
$row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
array( 'rev_page' => $id ), __METHOD__ );
if( $row ) {
return $row->revCount;
}
return 0;
}
/**
* Get count of revisions per page...not very efficient
* @param Database $db
* @param Title $title
*/
static function countByTitle( $db, $title ) {
$id = $title->getArticleId();
if( $id ) {
return Revision::countByPageId( $db, $id );
}
return 0;
}
}
/**
* Aliases for backwards compatibility with 1.6
*/
define( 'MW_REV_DELETED_TEXT', Revision::DELETED_TEXT );
define( 'MW_REV_DELETED_COMMENT', Revision::DELETED_COMMENT );
define( 'MW_REV_DELETED_USER', Revision::DELETED_USER );
define( 'MW_REV_DELETED_RESTRICTED', Revision::DELETED_RESTRICTED );
|