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';
27 use MediaWiki\MediaWikiServices
;
30 * Maintenance script that fills the rev_sha1 and ar_sha1 columns of revision
31 * and archive tables for revisions created before MW 1.19.
33 * @ingroup Maintenance
35 class PopulateRevisionSha1
extends LoggedUpdateMaintenance
{
36 public function __construct() {
37 parent
::__construct();
38 $this->addDescription( 'Populates the rev_sha1 and ar_sha1 fields' );
39 $this->setBatchSize( 200 );
42 protected function getUpdateKey() {
43 return 'populate rev_sha1';
46 protected function doDBUpdates() {
47 $db = $this->getDB( DB_MASTER
);
49 if ( !$db->tableExists( 'revision', __METHOD__
) ) {
50 $this->fatalError( "revision table does not exist" );
51 } elseif ( !$db->tableExists( 'archive', __METHOD__
) ) {
52 $this->fatalError( "archive table does not exist" );
53 } elseif ( !$db->fieldExists( 'revision', 'rev_sha1', __METHOD__
) ) {
54 $this->output( "rev_sha1 column does not exist\n\n", true );
58 $revStore = MediaWikiServices
::getInstance()->getRevisionStore();
60 $this->output( "Populating rev_sha1 column\n" );
61 $rc = $this->doSha1Updates( $revStore, 'revision', 'rev_id',
62 $revStore->getQueryInfo(), 'rev'
65 $this->output( "Populating ar_sha1 column\n" );
66 $ac = $this->doSha1Updates( $revStore, 'archive', 'ar_rev_id',
67 $revStore->getArchiveQueryInfo(), 'ar'
69 $this->output( "Populating ar_sha1 column legacy rows\n" );
70 $ac +
= $this->doSha1LegacyUpdates( $revStore );
72 $this->output( "rev_sha1 and ar_sha1 population complete "
73 . "[$rc revision rows, $ac archive rows].\n" );
79 * @param MediaWiki\Revision\RevisionStore $revStore
80 * @param string $table
81 * @param string $idCol
82 * @param array $queryInfo
83 * @param string $prefix
84 * @return int Rows changed
86 protected function doSha1Updates( $revStore, $table, $idCol, $queryInfo, $prefix ) {
87 $db = $this->getDB( DB_MASTER
);
88 $batchSize = $this->getBatchSize();
89 $start = $db->selectField( $table, "MIN($idCol)", '', __METHOD__
);
90 $end = $db->selectField( $table, "MAX($idCol)", '', __METHOD__
);
91 if ( !$start ||
!$end ) {
92 $this->output( "...$table table seems to be empty.\n" );
99 $end +
= $batchSize - 1;
100 $blockStart = $start;
101 $blockEnd = $start +
$batchSize - 1;
102 while ( $blockEnd <= $end ) {
103 $this->output( "...doing $idCol from $blockStart to $blockEnd\n" );
105 $cond = "$idCol BETWEEN " . (int)$blockStart . " AND " . (int)$blockEnd .
106 " AND $idCol IS NOT NULL AND {$prefix}_sha1 = ''";
108 $queryInfo['tables'], $queryInfo['fields'], $cond, __METHOD__
, [], $queryInfo['joins']
111 $this->beginTransaction( $db, __METHOD__
);
112 foreach ( $res as $row ) {
113 if ( $this->upgradeRow( $revStore, $row, $table, $idCol, $prefix ) ) {
117 $this->commitTransaction( $db, __METHOD__
);
119 $blockStart +
= $batchSize;
120 $blockEnd +
= $batchSize;
127 * @param MediaWiki\Revision\RevisionStore $revStore
130 protected function doSha1LegacyUpdates( $revStore ) {
132 $db = $this->getDB( DB_MASTER
);
133 $arQuery = $revStore->getArchiveQueryInfo();
134 $res = $db->select( $arQuery['tables'], $arQuery['fields'],
135 [ 'ar_rev_id IS NULL', 'ar_sha1' => '' ], __METHOD__
, [], $arQuery['joins'] );
138 $this->beginTransaction( $db, __METHOD__
);
139 foreach ( $res as $row ) {
140 if ( $this->upgradeLegacyArchiveRow( $revStore, $row ) ) {
143 if ( ++
$updateSize >= 100 ) {
145 $this->commitTransaction( $db, __METHOD__
);
146 $this->output( "Commited row with ar_timestamp={$row->ar_timestamp}\n" );
147 $this->beginTransaction( $db, __METHOD__
);
150 $this->commitTransaction( $db, __METHOD__
);
156 * @param MediaWiki\Revision\RevisionStore $revStore
157 * @param stdClass $row
158 * @param string $table
159 * @param string $idCol
160 * @param string $prefix
163 protected function upgradeRow( $revStore, $row, $table, $idCol, $prefix ) {
164 $db = $this->getDB( DB_MASTER
);
166 // Create a revision and use it to get the sha1 from the content table, if possible.
168 $rev = ( $table === 'archive' )
169 ?
$revStore->newRevisionFromArchiveRow( $row )
170 : $revStore->newRevisionFromRow( $row );
171 $sha1 = $rev->getSha1();
172 } catch ( Exception
$e ) {
173 $this->output( "Data of revision with {$idCol}={$row->$idCol} unavailable!\n" );
174 return false; // T24624? T22757?
178 [ "{$prefix}_sha1" => $sha1 ],
179 [ $idCol => $row->$idCol ],
187 * @param MediaWiki\Revision\RevisionStore $revStore
188 * @param stdClass $row
191 protected function upgradeLegacyArchiveRow( $revStore, $row ) {
192 $db = $this->getDB( DB_MASTER
);
194 // Create a revision and use it to get the sha1 from the content table, if possible.
196 $rev = $revStore->newRevisionFromArchiveRow( $row );
197 $sha1 = $rev->getSha1();
198 } catch ( Exception
$e ) {
199 $this->output( "Text of revision with timestamp {$row->ar_timestamp} unavailable!\n" );
200 return false; // T24624? T22757?
203 # Archive table has no PK, but (NS,title,time) should be near unique.
204 # Any duplicates on those should also have duplicated text anyway.
205 $db->update( 'archive',
206 [ 'ar_sha1' => $sha1 ],
208 'ar_namespace' => $row->ar_namespace
,
209 'ar_title' => $row->ar_title
,
210 'ar_timestamp' => $row->ar_timestamp
,
211 'ar_len' => $row->ar_len
// extra sanity
220 $maintClass = PopulateRevisionSha1
::class;
221 require_once RUN_MAINTENANCE_IF_MAIN
;