3 * Fills the rev_sha1 and ar_sha1 columns of revision
4 * and archive tables for revisions created before MW 1.19.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup Maintenance
25 require_once __DIR__
. '/Maintenance.php';
28 * Maintenance script that fills the rev_sha1 and ar_sha1 columns of revision
29 * and archive tables for revisions created before MW 1.19.
31 * @ingroup Maintenance
33 class PopulateRevisionSha1
extends LoggedUpdateMaintenance
{
34 public function __construct() {
35 parent
::__construct();
36 $this->mDescription
= "Populates the rev_sha1 and ar_sha1 fields";
37 $this->setBatchSize( 200 );
40 protected function getUpdateKey() {
41 return 'populate rev_sha1';
44 protected function doDBUpdates() {
45 $db = $this->getDB( DB_MASTER
);
47 if ( !$db->tableExists( 'revision' ) ) {
48 $this->error( "revision table does not exist", true );
49 } elseif ( !$db->tableExists( 'archive' ) ) {
50 $this->error( "archive table does not exist", true );
51 } elseif ( !$db->fieldExists( 'revision', 'rev_sha1', __METHOD__
) ) {
52 $this->output( "rev_sha1 column does not exist\n\n", true );
56 $this->output( "Populating rev_sha1 column\n" );
57 $rc = $this->doSha1Updates( 'revision', 'rev_id', 'rev' );
59 $this->output( "Populating ar_sha1 column\n" );
60 $ac = $this->doSha1Updates( 'archive', 'ar_rev_id', 'ar' );
61 $this->output( "Populating ar_sha1 column legacy rows\n" );
62 $ac +
= $this->doSha1LegacyUpdates();
64 $this->output( "rev_sha1 and ar_sha1 population complete "
65 . "[$rc revision rows, $ac archive rows].\n" );
70 * @param string $table
71 * @param string $idCol
72 * @param string $prefix
73 * @return int Rows changed
75 protected function doSha1Updates( $table, $idCol, $prefix ) {
76 $db = $this->getDB( DB_MASTER
);
77 $start = $db->selectField( $table, "MIN($idCol)", false, __METHOD__
);
78 $end = $db->selectField( $table, "MAX($idCol)", false, __METHOD__
);
79 if ( !$start ||
!$end ) {
80 $this->output( "...$table table seems to be empty.\n" );
86 $end +
= $this->mBatchSize
- 1;
88 $blockEnd = $start +
$this->mBatchSize
- 1;
89 while ( $blockEnd <= $end ) {
90 $this->output( "...doing $idCol from $blockStart to $blockEnd\n" );
91 $cond = "$idCol BETWEEN $blockStart AND $blockEnd
92 AND $idCol IS NOT NULL AND {$prefix}_sha1 = ''";
93 $res = $db->select( $table, '*', $cond, __METHOD__
);
95 $db->begin( __METHOD__
);
96 foreach ( $res as $row ) {
97 if ( $this->upgradeRow( $row, $table, $idCol, $prefix ) ) {
101 $db->commit( __METHOD__
);
103 $blockStart +
= $this->mBatchSize
;
104 $blockEnd +
= $this->mBatchSize
;
113 protected function doSha1LegacyUpdates() {
115 $db = $this->getDB( DB_MASTER
);
116 $res = $db->select( 'archive', '*',
117 array( 'ar_rev_id IS NULL', 'ar_sha1' => '' ), __METHOD__
);
120 $db->begin( __METHOD__
);
121 foreach ( $res as $row ) {
122 if ( $this->upgradeLegacyArchiveRow( $row ) ) {
125 if ( ++
$updateSize >= 100 ) {
127 $db->commit( __METHOD__
);
128 $this->output( "Commited row with ar_timestamp={$row->ar_timestamp}\n" );
130 $db->begin( __METHOD__
);
133 $db->commit( __METHOD__
);
138 * @param stdClass $row
139 * @param string $table
140 * @param string $idCol
141 * @param string $prefix
144 protected function upgradeRow( $row, $table, $idCol, $prefix ) {
145 $db = $this->getDB( DB_MASTER
);
147 $rev = ( $table === 'archive' )
148 ? Revision
::newFromArchiveRow( $row )
149 : new Revision( $row );
150 $text = $rev->getSerializedData();
151 } catch ( MWException
$e ) {
152 $this->output( "Data of revision with {$idCol}={$row->$idCol} unavailable!\n" );
153 return false; // bug 22624?
155 if ( !is_string( $text ) ) {
156 # This should not happen, but sometimes does (bug 20757)
157 $this->output( "Data of revision with {$idCol}={$row->$idCol} unavailable!\n" );
161 array( "{$prefix}_sha1" => Revision
::base36Sha1( $text ) ),
162 array( $idCol => $row->$idCol ),
170 * @param stdClass $row
173 protected function upgradeLegacyArchiveRow( $row ) {
174 $db = $this->getDB( DB_MASTER
);
176 $rev = Revision
::newFromArchiveRow( $row );
177 } catch ( MWException
$e ) {
178 $this->output( "Text of revision with timestamp {$row->ar_timestamp} unavailable!\n" );
179 return false; // bug 22624?
181 $text = $rev->getSerializedData();
182 if ( !is_string( $text ) ) {
183 # This should not happen, but sometimes does (bug 20757)
184 $this->output( "Data of revision with timestamp {$row->ar_timestamp} unavailable!\n" );
187 # Archive table as no PK, but (NS,title,time) should be near unique.
188 # Any duplicates on those should also have duplicated text anyway.
189 $db->update( 'archive',
190 array( 'ar_sha1' => Revision
::base36Sha1( $text ) ),
192 'ar_namespace' => $row->ar_namespace
,
193 'ar_title' => $row->ar_title
,
194 'ar_timestamp' => $row->ar_timestamp
,
195 'ar_len' => $row->ar_len
// extra sanity
204 $maintClass = "PopulateRevisionSha1";
205 require_once RUN_MAINTENANCE_IF_MAIN
;