3 * Representation of a page version.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
30 protected $mOrigUserText;
32 protected $mMinorEdit;
33 protected $mTimestamp;
44 const DELETED_TEXT
= 1;
45 const DELETED_COMMENT
= 2;
46 const DELETED_USER
= 4;
47 const DELETED_RESTRICTED
= 8;
49 const SUPPRESSED_USER
= 12;
50 // Audience options for Revision::getText()
52 const FOR_THIS_USER
= 2;
56 * Load a page revision from a given revision ID number.
57 * Returns null if no such revision can be found.
60 * @return Revision or null
62 public static function newFromId( $id ) {
63 return Revision
::newFromConds( array( 'rev_id' => intval( $id ) ) );
67 * Load either the current, or a specified, revision
68 * that's attached to a given title. If not attached
69 * to that title, will return null.
72 * @param $id Integer (optional)
73 * @return Revision or null
75 public static function newFromTitle( $title, $id = 0 ) {
77 'page_namespace' => $title->getNamespace(),
78 'page_title' => $title->getDBkey()
81 // Use the specified ID
82 $conds['rev_id'] = $id;
83 } elseif ( wfGetLB()->getServerCount() > 1 ) {
84 // Get the latest revision ID from the master
85 $dbw = wfGetDB( DB_MASTER
);
86 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
87 if ( $latest === false ) {
88 return null; // page does not exist
90 $conds['rev_id'] = $latest;
92 // Use a join to get the latest revision
93 $conds[] = 'rev_id=page_latest';
95 return Revision
::newFromConds( $conds );
99 * Load either the current, or a specified, revision
100 * that's attached to a given page ID.
101 * Returns null if no such revision can be found.
103 * @param $revId Integer
104 * @param $pageId Integer (optional)
105 * @return Revision or null
107 public static function newFromPageId( $pageId, $revId = 0 ) {
108 $conds = array( 'page_id' => $pageId );
110 $conds['rev_id'] = $revId;
111 } elseif ( wfGetLB()->getServerCount() > 1 ) {
112 // Get the latest revision ID from the master
113 $dbw = wfGetDB( DB_MASTER
);
114 $latest = $dbw->selectField( 'page', 'page_latest', $conds, __METHOD__
);
115 if ( $latest === false ) {
116 return null; // page does not exist
118 $conds['rev_id'] = $latest;
120 $conds[] = 'rev_id = page_latest';
122 return Revision
::newFromConds( $conds );
126 * Make a fake revision object from an archive table row. This is queried
127 * for permissions or even inserted (as in Special:Undelete)
128 * @todo FIXME: Should be a subclass for RevisionDelete. [TS]
131 * @param $overrides array
135 public static function newFromArchiveRow( $row, $overrides = array() ) {
136 $attribs = $overrides +
array(
137 'page' => isset( $row->ar_page_id
) ?
$row->ar_page_id
: null,
138 'id' => isset( $row->ar_rev_id
) ?
$row->ar_rev_id
: null,
139 'comment' => $row->ar_comment
,
140 'user' => $row->ar_user
,
141 'user_text' => $row->ar_user_text
,
142 'timestamp' => $row->ar_timestamp
,
143 'minor_edit' => $row->ar_minor_edit
,
144 'text_id' => isset( $row->ar_text_id
) ?
$row->ar_text_id
: null,
145 'deleted' => $row->ar_deleted
,
146 'len' => $row->ar_len
,
147 'sha1' => isset( $row->ar_sha1
) ?
$row->ar_sha1
: null,
149 if ( isset( $row->ar_text
) && !$row->ar_text_id
) {
150 // Pre-1.5 ar_text row
151 $attribs['text'] = self
::getRevisionText( $row, 'ar_' );
152 if ( $attribs['text'] === false ) {
153 throw new MWException( 'Unable to load text from archive row (possibly bug 22624)' );
156 return new self( $attribs );
165 public static function newFromRow( $row ) {
166 return new self( $row );
170 * Load a page revision from a given revision ID number.
171 * Returns null if no such revision can be found.
173 * @param $db DatabaseBase
175 * @return Revision or null
177 public static function loadFromId( $db, $id ) {
178 return Revision
::loadFromConds( $db, array( 'rev_id' => intval( $id ) ) );
182 * Load either the current, or a specified, revision
183 * that's attached to a given page. If not attached
184 * to that page, will return null.
186 * @param $db DatabaseBase
187 * @param $pageid Integer
189 * @return Revision or null
191 public static function loadFromPageId( $db, $pageid, $id = 0 ) {
192 $conds = array( 'rev_page' => intval( $pageid ), 'page_id' => intval( $pageid ) );
194 $conds['rev_id'] = intval( $id );
196 $conds[] = 'rev_id=page_latest';
198 return Revision
::loadFromConds( $db, $conds );
202 * Load either the current, or a specified, revision
203 * that's attached to a given page. If not attached
204 * to that page, will return null.
206 * @param $db DatabaseBase
207 * @param $title Title
209 * @return Revision or null
211 public static function loadFromTitle( $db, $title, $id = 0 ) {
213 $matchId = intval( $id );
215 $matchId = 'page_latest';
217 return Revision
::loadFromConds( $db,
218 array( "rev_id=$matchId",
219 'page_namespace' => $title->getNamespace(),
220 'page_title' => $title->getDBkey() )
225 * Load the revision for the given title with the given timestamp.
226 * WARNING: Timestamps may in some circumstances not be unique,
227 * so this isn't the best key to use.
229 * @param $db DatabaseBase
230 * @param $title Title
231 * @param $timestamp String
232 * @return Revision or null
234 public static function loadFromTimestamp( $db, $title, $timestamp ) {
235 return Revision
::loadFromConds( $db,
236 array( 'rev_timestamp' => $db->timestamp( $timestamp ),
237 'page_namespace' => $title->getNamespace(),
238 'page_title' => $title->getDBkey() )
243 * Given a set of conditions, fetch a revision.
245 * @param $conditions Array
246 * @return Revision or null
248 public static function newFromConds( $conditions ) {
249 $db = wfGetDB( DB_SLAVE
);
250 $rev = Revision
::loadFromConds( $db, $conditions );
251 if( is_null( $rev ) && wfGetLB()->getServerCount() > 1 ) {
252 $dbw = wfGetDB( DB_MASTER
);
253 $rev = Revision
::loadFromConds( $dbw, $conditions );
259 * Given a set of conditions, fetch a revision from
260 * the given database connection.
262 * @param $db DatabaseBase
263 * @param $conditions Array
264 * @return Revision or null
266 private static function loadFromConds( $db, $conditions ) {
267 $res = Revision
::fetchFromConds( $db, $conditions );
269 $row = $res->fetchObject();
271 $ret = new Revision( $row );
280 * Return a wrapper for a series of database rows to
281 * fetch all of a given page's revisions in turn.
282 * Each row can be fed to the constructor to get objects.
284 * @param $title Title
285 * @return ResultWrapper
287 public static function fetchRevision( $title ) {
288 return Revision
::fetchFromConds(
290 array( 'rev_id=page_latest',
291 'page_namespace' => $title->getNamespace(),
292 'page_title' => $title->getDBkey() )
297 * Given a set of conditions, return a ResultWrapper
298 * which will return matching database rows with the
299 * fields necessary to build Revision objects.
301 * @param $db DatabaseBase
302 * @param $conditions Array
303 * @return ResultWrapper
305 private static function fetchFromConds( $db, $conditions ) {
306 $fields = array_merge(
307 self
::selectFields(),
308 self
::selectPageFields(),
309 self
::selectUserFields()
312 array( 'revision', 'page', 'user' ),
316 array( 'LIMIT' => 1 ),
317 array( 'page' => self
::pageJoinCond(), 'user' => self
::userJoinCond() )
322 * Return the value of a select() JOIN conds array for the user table.
323 * This will get user table rows for logged-in users.
327 public static function userJoinCond() {
328 return array( 'LEFT JOIN', array( 'rev_user != 0', 'user_id = rev_user' ) );
332 * Return the value of a select() page conds array for the paeg table.
333 * This will assure that the revision(s) are not orphaned from live pages.
337 public static function pageJoinCond() {
338 return array( 'INNER JOIN', array( 'page_id = rev_page' ) );
342 * Return the list of revision fields that should be selected to create
346 public static function selectFields() {
364 * Return the list of text fields that should be selected to read the
368 public static function selectTextFields() {
376 * Return the list of page fields that should be selected from page table
379 public static function selectPageFields() {
391 * Return the list of user fields that should be selected from user table
394 public static function selectUserFields() {
395 return array( 'user_name' );
399 * Do a batched query to get the parent revision lengths
400 * @param $db DatabaseBase
401 * @param $revIds Array
404 public static function getParentLengths( $db, array $revIds ) {
407 return $revLens; // empty
409 wfProfileIn( __METHOD__
);
410 $res = $db->select( 'revision',
411 array( 'rev_id', 'rev_len' ),
412 array( 'rev_id' => $revIds ),
414 foreach ( $res as $row ) {
415 $revLens[$row->rev_id
] = $row->rev_len
;
417 wfProfileOut( __METHOD__
);
424 * @param $row Mixed: either a database row or an array
427 function __construct( $row ) {
428 if( is_object( $row ) ) {
429 $this->mId
= intval( $row->rev_id
);
430 $this->mPage
= intval( $row->rev_page
);
431 $this->mTextId
= intval( $row->rev_text_id
);
432 $this->mComment
= $row->rev_comment
;
433 $this->mUser
= intval( $row->rev_user
);
434 $this->mMinorEdit
= intval( $row->rev_minor_edit
);
435 $this->mTimestamp
= $row->rev_timestamp
;
436 $this->mDeleted
= intval( $row->rev_deleted
);
438 if( !isset( $row->rev_parent_id
) ) {
439 $this->mParentId
= is_null( $row->rev_parent_id
) ?
null : 0;
441 $this->mParentId
= intval( $row->rev_parent_id
);
444 if( !isset( $row->rev_len
) ||
is_null( $row->rev_len
) ) {
447 $this->mSize
= intval( $row->rev_len
);
450 if ( !isset( $row->rev_sha1
) ) {
453 $this->mSha1
= $row->rev_sha1
;
456 if( isset( $row->page_latest
) ) {
457 $this->mCurrent
= ( $row->rev_id
== $row->page_latest
);
458 $this->mTitle
= Title
::newFromRow( $row );
460 $this->mCurrent
= false;
461 $this->mTitle
= null;
464 // Lazy extraction...
466 if( isset( $row->old_text
) ) {
467 $this->mTextRow
= $row;
469 // 'text' table row entry will be lazy-loaded
470 $this->mTextRow
= null;
473 // Use user_name for users and rev_user_text for IPs...
474 $this->mUserText
= null; // lazy load if left null
475 if ( $this->mUser
== 0 ) {
476 $this->mUserText
= $row->rev_user_text
; // IP user
477 } elseif ( isset( $row->user_name
) ) {
478 $this->mUserText
= $row->user_name
; // logged-in user
480 $this->mOrigUserText
= $row->rev_user_text
;
481 } elseif( is_array( $row ) ) {
482 // Build a new revision to be saved...
483 global $wgUser; // ugh
485 $this->mId
= isset( $row['id'] ) ?
intval( $row['id'] ) : null;
486 $this->mPage
= isset( $row['page'] ) ?
intval( $row['page'] ) : null;
487 $this->mTextId
= isset( $row['text_id'] ) ?
intval( $row['text_id'] ) : null;
488 $this->mUserText
= isset( $row['user_text'] ) ?
strval( $row['user_text'] ) : $wgUser->getName();
489 $this->mUser
= isset( $row['user'] ) ?
intval( $row['user'] ) : $wgUser->getId();
490 $this->mMinorEdit
= isset( $row['minor_edit'] ) ?
intval( $row['minor_edit'] ) : 0;
491 $this->mTimestamp
= isset( $row['timestamp'] ) ?
strval( $row['timestamp'] ) : wfTimestampNow();
492 $this->mDeleted
= isset( $row['deleted'] ) ?
intval( $row['deleted'] ) : 0;
493 $this->mSize
= isset( $row['len'] ) ?
intval( $row['len'] ) : null;
494 $this->mParentId
= isset( $row['parent_id'] ) ?
intval( $row['parent_id'] ) : null;
495 $this->mSha1
= isset( $row['sha1'] ) ?
strval( $row['sha1'] ) : null;
497 // Enforce spacing trimming on supplied text
498 $this->mComment
= isset( $row['comment'] ) ?
trim( strval( $row['comment'] ) ) : null;
499 $this->mText
= isset( $row['text'] ) ?
rtrim( strval( $row['text'] ) ) : null;
500 $this->mTextRow
= null;
502 $this->mTitle
= null; # Load on demand if needed
503 $this->mCurrent
= false;
504 # If we still have no length, see it we have the text to figure it out
505 if ( !$this->mSize
) {
506 $this->mSize
= is_null( $this->mText
) ?
null : strlen( $this->mText
);
509 if ( $this->mSha1
=== null ) {
510 $this->mSha1
= is_null( $this->mText
) ?
null : self
::base36Sha1( $this->mText
);
513 throw new MWException( 'Revision constructor passed invalid row format.' );
515 $this->mUnpatrolled
= null;
521 * @return Integer|null
523 public function getId() {
528 * Set the revision ID
533 public function setId( $id ) {
540 * @return Integer|null
542 public function getTextId() {
543 return $this->mTextId
;
547 * Get parent revision ID (the original previous page revision)
549 * @return Integer|null
551 public function getParentId() {
552 return $this->mParentId
;
556 * Returns the length of the text in this revision, or null if unknown.
558 * @return Integer|null
560 public function getSize() {
565 * Returns the base36 sha1 of the text in this revision, or null if unknown.
567 * @return String|null
569 public function getSha1() {
574 * Returns the title of the page associated with this entry or null.
576 * Will do a query, when title is not set and id is given.
580 public function getTitle() {
581 if( isset( $this->mTitle
) ) {
582 return $this->mTitle
;
584 if( !is_null( $this->mId
) ) { //rev_id is defined as NOT NULL
585 $dbr = wfGetDB( DB_SLAVE
);
586 $row = $dbr->selectRow(
587 array( 'page', 'revision' ),
588 self
::selectPageFields(),
589 array( 'page_id=rev_page',
590 'rev_id' => $this->mId
),
593 $this->mTitle
= Title
::newFromRow( $row );
596 return $this->mTitle
;
600 * Set the title of the revision
602 * @param $title Title
604 public function setTitle( $title ) {
605 $this->mTitle
= $title;
611 * @return Integer|null
613 public function getPage() {
618 * Fetch revision's user id if it's available to the specified audience.
619 * If the specified audience does not have access to it, zero will be
622 * @param $audience Integer: one of:
623 * Revision::FOR_PUBLIC to be displayed to all users
624 * Revision::FOR_THIS_USER to be displayed to the given user
625 * Revision::RAW get the ID regardless of permissions
626 * @param $user User object to check for, only if FOR_THIS_USER is passed
627 * to the $audience parameter
630 public function getUser( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
631 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
633 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
641 * Fetch revision's user id without regard for the current user's permissions
645 public function getRawUser() {
650 * Fetch revision's username if it's available to the specified audience.
651 * If the specified audience does not have access to the username, an
652 * empty string will be returned.
654 * @param $audience Integer: one of:
655 * Revision::FOR_PUBLIC to be displayed to all users
656 * Revision::FOR_THIS_USER to be displayed to the given user
657 * Revision::RAW get the text regardless of permissions
658 * @param $user User object to check for, only if FOR_THIS_USER is passed
659 * to the $audience parameter
662 public function getUserText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
663 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_USER
) ) {
665 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_USER
, $user ) ) {
668 return $this->getRawUserText();
673 * Fetch revision's username without regard for view restrictions
677 public function getRawUserText() {
678 if ( $this->mUserText
=== null ) {
679 $this->mUserText
= User
::whoIs( $this->mUser
); // load on demand
680 if ( $this->mUserText
=== false ) {
681 # This shouldn't happen, but it can if the wiki was recovered
682 # via importing revs and there is no user table entry yet.
683 $this->mUserText
= $this->mOrigUserText
;
686 return $this->mUserText
;
690 * Fetch revision comment if it's available to the specified audience.
691 * If the specified audience does not have access to the comment, an
692 * empty string will be returned.
694 * @param $audience Integer: one of:
695 * Revision::FOR_PUBLIC to be displayed to all users
696 * Revision::FOR_THIS_USER to be displayed to the given user
697 * Revision::RAW get the text regardless of permissions
698 * @param $user User object to check for, only if FOR_THIS_USER is passed
699 * to the $audience parameter
702 function getComment( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
703 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
705 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_COMMENT
, $user ) ) {
708 return $this->mComment
;
713 * Fetch revision comment without regard for the current user's permissions
717 public function getRawComment() {
718 return $this->mComment
;
724 public function isMinor() {
725 return (bool)$this->mMinorEdit
;
729 * @return Integer rcid of the unpatrolled row, zero if there isn't one
731 public function isUnpatrolled() {
732 if( $this->mUnpatrolled
!== null ) {
733 return $this->mUnpatrolled
;
735 $dbr = wfGetDB( DB_SLAVE
);
736 $this->mUnpatrolled
= $dbr->selectField( 'recentchanges',
738 array( // Add redundant user,timestamp condition so we can use the existing index
739 'rc_user_text' => $this->getRawUserText(),
740 'rc_timestamp' => $dbr->timestamp( $this->getTimestamp() ),
741 'rc_this_oldid' => $this->getId(),
746 return (int)$this->mUnpatrolled
;
750 * @param $field int one of DELETED_* bitfield constants
754 public function isDeleted( $field ) {
755 return ( $this->mDeleted
& $field ) == $field;
759 * Get the deletion bitfield of the revision
763 public function getVisibility() {
764 return (int)$this->mDeleted
;
768 * Fetch revision text if it's available to the specified audience.
769 * If the specified audience does not have the ability to view this
770 * revision, an empty string will be returned.
772 * @param $audience Integer: one of:
773 * Revision::FOR_PUBLIC to be displayed to all users
774 * Revision::FOR_THIS_USER to be displayed to the given user
775 * Revision::RAW get the text regardless of permissions
776 * @param $user User object to check for, only if FOR_THIS_USER is passed
777 * to the $audience parameter
780 public function getText( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
781 if( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_TEXT
) ) {
783 } elseif( $audience == self
::FOR_THIS_USER
&& !$this->userCan( self
::DELETED_TEXT
, $user ) ) {
786 return $this->getRawText();
791 * Alias for getText(Revision::FOR_THIS_USER)
793 * @deprecated since 1.17
796 public function revText() {
797 wfDeprecated( __METHOD__
, '1.17' );
798 return $this->getText( self
::FOR_THIS_USER
);
802 * Fetch revision text without regard for view restrictions
806 public function getRawText() {
807 if( is_null( $this->mText
) ) {
808 // Revision text is immutable. Load on demand:
809 $this->mText
= $this->loadText();
817 public function getTimestamp() {
818 return wfTimestamp( TS_MW
, $this->mTimestamp
);
824 public function isCurrent() {
825 return $this->mCurrent
;
829 * Get previous revision for this title
831 * @return Revision or null
833 public function getPrevious() {
834 if( $this->getTitle() ) {
835 $prev = $this->getTitle()->getPreviousRevisionID( $this->getId() );
837 return Revision
::newFromTitle( $this->getTitle(), $prev );
844 * Get next revision for this title
846 * @return Revision or null
848 public function getNext() {
849 if( $this->getTitle() ) {
850 $next = $this->getTitle()->getNextRevisionID( $this->getId() );
852 return Revision
::newFromTitle( $this->getTitle(), $next );
859 * Get previous revision Id for this page_id
860 * This is used to populate rev_parent_id on save
862 * @param $db DatabaseBase
865 private function getPreviousRevisionId( $db ) {
866 if( is_null( $this->mPage
) ) {
869 # Use page_latest if ID is not given
871 $prevId = $db->selectField( 'page', 'page_latest',
872 array( 'page_id' => $this->mPage
),
875 $prevId = $db->selectField( 'revision', 'rev_id',
876 array( 'rev_page' => $this->mPage
, 'rev_id < ' . $this->mId
),
878 array( 'ORDER BY' => 'rev_id DESC' ) );
880 return intval( $prevId );
884 * Get revision text associated with an old or archive row
885 * $row is usually an object from wfFetchRow(), both the flags and the text
886 * field must be included
888 * @param $row Object: the text data
889 * @param $prefix String: table prefix (default 'old_')
890 * @return String: text the text requested or false on failure
892 public static function getRevisionText( $row, $prefix = 'old_' ) {
893 wfProfileIn( __METHOD__
);
896 $textField = $prefix . 'text';
897 $flagsField = $prefix . 'flags';
899 if( isset( $row->$flagsField ) ) {
900 $flags = explode( ',', $row->$flagsField );
905 if( isset( $row->$textField ) ) {
906 $text = $row->$textField;
908 wfProfileOut( __METHOD__
);
912 # Use external methods for external objects, text in table is URL-only then
913 if ( in_array( 'external', $flags ) ) {
915 $parts = explode( '://', $url, 2 );
916 if( count( $parts ) == 1 ||
$parts[1] == '' ) {
917 wfProfileOut( __METHOD__
);
920 $text = ExternalStore
::fetchFromURL( $url );
923 // If the text was fetched without an error, convert it
924 if ( $text !== false ) {
925 if( in_array( 'gzip', $flags ) ) {
926 # Deal with optional compression of archived pages.
927 # This can be done periodically via maintenance/compressOld.php, and
928 # as pages are saved if $wgCompressRevisions is set.
929 $text = gzinflate( $text );
932 if( in_array( 'object', $flags ) ) {
933 # Generic compressed storage
934 $obj = unserialize( $text );
935 if ( !is_object( $obj ) ) {
937 wfProfileOut( __METHOD__
);
940 $text = $obj->getText();
943 global $wgLegacyEncoding;
944 if( $text !== false && $wgLegacyEncoding
945 && !in_array( 'utf-8', $flags ) && !in_array( 'utf8', $flags ) )
947 # Old revisions kept around in a legacy encoding?
948 # Upconvert on demand.
949 # ("utf8" checked for compatibility with some broken
950 # conversion scripts 2008-12-30)
952 $text = $wgContLang->iconv( $wgLegacyEncoding, 'UTF-8', $text );
955 wfProfileOut( __METHOD__
);
960 * If $wgCompressRevisions is enabled, we will compress data.
961 * The input string is modified in place.
962 * Return value is the flags field: contains 'gzip' if the
963 * data is compressed, and 'utf-8' if we're saving in UTF-8
966 * @param $text Mixed: reference to a text
969 public static function compressRevisionText( &$text ) {
970 global $wgCompressRevisions;
973 # Revisions not marked this way will be converted
974 # on load if $wgLegacyCharset is set in the future.
977 if( $wgCompressRevisions ) {
978 if( function_exists( 'gzdeflate' ) ) {
979 $text = gzdeflate( $text );
982 wfDebug( "Revision::compressRevisionText() -- no zlib support, not compressing\n" );
985 return implode( ',', $flags );
989 * Insert a new revision into the database, returning the new revision ID
990 * number on success and dies horribly on failure.
992 * @param $dbw DatabaseBase: (master connection)
995 public function insertOn( $dbw ) {
996 global $wgDefaultExternalStore;
998 wfProfileIn( __METHOD__
);
1000 $data = $this->mText
;
1001 $flags = Revision
::compressRevisionText( $data );
1003 # Write to external storage if required
1004 if( $wgDefaultExternalStore ) {
1005 // Store and get the URL
1006 $data = ExternalStore
::insertToDefault( $data );
1008 throw new MWException( "Unable to store text to external storage" );
1013 $flags .= 'external';
1016 # Record the text (or external storage URL) to the text table
1017 if( !isset( $this->mTextId
) ) {
1018 $old_id = $dbw->nextSequenceValue( 'text_old_id_seq' );
1019 $dbw->insert( 'text',
1021 'old_id' => $old_id,
1022 'old_text' => $data,
1023 'old_flags' => $flags,
1026 $this->mTextId
= $dbw->insertId();
1029 if ( $this->mComment
=== null ) $this->mComment
= "";
1031 # Record the edit in revisions
1032 $rev_id = isset( $this->mId
)
1034 : $dbw->nextSequenceValue( 'revision_rev_id_seq' );
1035 $dbw->insert( 'revision',
1037 'rev_id' => $rev_id,
1038 'rev_page' => $this->mPage
,
1039 'rev_text_id' => $this->mTextId
,
1040 'rev_comment' => $this->mComment
,
1041 'rev_minor_edit' => $this->mMinorEdit ?
1 : 0,
1042 'rev_user' => $this->mUser
,
1043 'rev_user_text' => $this->mUserText
,
1044 'rev_timestamp' => $dbw->timestamp( $this->mTimestamp
),
1045 'rev_deleted' => $this->mDeleted
,
1046 'rev_len' => $this->mSize
,
1047 'rev_parent_id' => is_null( $this->mParentId
)
1048 ?
$this->getPreviousRevisionId( $dbw )
1050 'rev_sha1' => is_null( $this->mSha1
)
1051 ? Revision
::base36Sha1( $this->mText
)
1056 $this->mId
= !is_null( $rev_id ) ?
$rev_id : $dbw->insertId();
1058 wfRunHooks( 'RevisionInsertComplete', array( &$this, $data, $flags ) );
1060 wfProfileOut( __METHOD__
);
1065 * Get the base 36 SHA-1 value for a string of text
1066 * @param $text String
1069 public static function base36Sha1( $text ) {
1070 return wfBaseConvert( sha1( $text ), 16, 36, 31 );
1074 * Lazy-load the revision's text.
1075 * Currently hardcoded to the 'text' table storage engine.
1079 protected function loadText() {
1080 wfProfileIn( __METHOD__
);
1082 // Caching may be beneficial for massive use of external storage
1083 global $wgRevisionCacheExpiry, $wgMemc;
1084 $textId = $this->getTextId();
1085 $key = wfMemcKey( 'revisiontext', 'textid', $textId );
1086 if( $wgRevisionCacheExpiry ) {
1087 $text = $wgMemc->get( $key );
1088 if( is_string( $text ) ) {
1089 wfDebug( __METHOD__
. ": got id $textId from cache\n" );
1090 wfProfileOut( __METHOD__
);
1095 // If we kept data for lazy extraction, use it now...
1096 if ( isset( $this->mTextRow
) ) {
1097 $row = $this->mTextRow
;
1098 $this->mTextRow
= null;
1104 // Text data is immutable; check slaves first.
1105 $dbr = wfGetDB( DB_SLAVE
);
1106 $row = $dbr->selectRow( 'text',
1107 array( 'old_text', 'old_flags' ),
1108 array( 'old_id' => $this->getTextId() ),
1112 if( !$row && wfGetLB()->getServerCount() > 1 ) {
1113 // Possible slave lag!
1114 $dbw = wfGetDB( DB_MASTER
);
1115 $row = $dbw->selectRow( 'text',
1116 array( 'old_text', 'old_flags' ),
1117 array( 'old_id' => $this->getTextId() ),
1121 $text = self
::getRevisionText( $row );
1123 # No negative caching -- negative hits on text rows may be due to corrupted slave servers
1124 if( $wgRevisionCacheExpiry && $text !== false ) {
1125 $wgMemc->set( $key, $text, $wgRevisionCacheExpiry );
1128 wfProfileOut( __METHOD__
);
1134 * Create a new null-revision for insertion into a page's
1135 * history. This will not re-save the text, but simply refer
1136 * to the text from the previous version.
1138 * Such revisions can for instance identify page rename
1139 * operations and other such meta-modifications.
1141 * @param $dbw DatabaseBase
1142 * @param $pageId Integer: ID number of the page to read from
1143 * @param $summary String: revision's summary
1144 * @param $minor Boolean: whether the revision should be considered as minor
1145 * @return Revision|null on error
1147 public static function newNullRevision( $dbw, $pageId, $summary, $minor ) {
1148 wfProfileIn( __METHOD__
);
1150 $current = $dbw->selectRow(
1151 array( 'page', 'revision' ),
1152 array( 'page_latest', 'page_namespace', 'page_title',
1153 'rev_text_id', 'rev_len', 'rev_sha1' ),
1155 'page_id' => $pageId,
1156 'page_latest=rev_id',
1161 $revision = new Revision( array(
1163 'comment' => $summary,
1164 'minor_edit' => $minor,
1165 'text_id' => $current->rev_text_id
,
1166 'parent_id' => $current->page_latest
,
1167 'len' => $current->rev_len
,
1168 'sha1' => $current->rev_sha1
1170 $revision->setTitle( Title
::makeTitle( $current->page_namespace
, $current->page_title
) );
1175 wfProfileOut( __METHOD__
);
1180 * Determine if the current user is allowed to view a particular
1181 * field of this revision, if it's marked as deleted.
1183 * @param $field Integer:one of self::DELETED_TEXT,
1184 * self::DELETED_COMMENT,
1185 * self::DELETED_USER
1186 * @param $user User object to check, or null to use $wgUser
1189 public function userCan( $field, User
$user = null ) {
1190 return self
::userCanBitfield( $this->mDeleted
, $field, $user );
1194 * Determine if the current user is allowed to view a particular
1195 * field of this revision, if it's marked as deleted. This is used
1196 * by various classes to avoid duplication.
1198 * @param $bitfield Integer: current field
1199 * @param $field Integer: one of self::DELETED_TEXT = File::DELETED_FILE,
1200 * self::DELETED_COMMENT = File::DELETED_COMMENT,
1201 * self::DELETED_USER = File::DELETED_USER
1202 * @param $user User object to check, or null to use $wgUser
1205 public static function userCanBitfield( $bitfield, $field, User
$user = null ) {
1206 if( $bitfield & $field ) { // aspect is deleted
1207 if ( $bitfield & self
::DELETED_RESTRICTED
) {
1208 $permission = 'suppressrevision';
1209 } elseif ( $field & self
::DELETED_TEXT
) {
1210 $permission = 'deletedtext';
1212 $permission = 'deletedhistory';
1214 wfDebug( "Checking for $permission due to $field match on $bitfield\n" );
1215 if ( $user === null ) {
1219 return $user->isAllowed( $permission );
1226 * Get rev_timestamp from rev_id, without loading the rest of the row
1228 * @param $title Title
1229 * @param $id Integer
1232 static function getTimestampFromId( $title, $id ) {
1233 $dbr = wfGetDB( DB_SLAVE
);
1234 // Casting fix for DB2
1238 $conds = array( 'rev_id' => $id );
1239 $conds['rev_page'] = $title->getArticleID();
1240 $timestamp = $dbr->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1241 if ( $timestamp === false && wfGetLB()->getServerCount() > 1 ) {
1242 # Not in slave, try master
1243 $dbw = wfGetDB( DB_MASTER
);
1244 $timestamp = $dbw->selectField( 'revision', 'rev_timestamp', $conds, __METHOD__
);
1246 return wfTimestamp( TS_MW
, $timestamp );
1250 * Get count of revisions per page...not very efficient
1252 * @param $db DatabaseBase
1253 * @param $id Integer: page id
1256 static function countByPageId( $db, $id ) {
1257 $row = $db->selectRow( 'revision', 'COUNT(*) AS revCount',
1258 array( 'rev_page' => $id ), __METHOD__
);
1260 return $row->revCount
;
1266 * Get count of revisions per page...not very efficient
1268 * @param $db DatabaseBase
1269 * @param $title Title
1272 static function countByTitle( $db, $title ) {
1273 $id = $title->getArticleID();
1275 return Revision
::countByPageId( $db, $id );