3 * Find all rows in the categorylinks table whose collation is out-of-date
4 * (cl_collation != $wgCategoryCollation) and repopulate cl_sortkey
5 * using the page title and cl_sortkey_prefix.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
23 * @ingroup Maintenance
24 * @author Aryeh Gregor (Simetrical)
27 require_once __DIR__
. '/Maintenance.php';
29 use MediaWiki\MediaWikiServices
;
30 use Wikimedia\Rdbms\IDatabase
;
33 * Maintenance script that will find all rows in the categorylinks table
34 * whose collation is out-of-date.
36 * @ingroup Maintenance
38 class UpdateCollation
extends Maintenance
{
39 const BATCH_SIZE
= 100; // Number of rows to process in one batch
40 const SYNC_INTERVAL
= 5; // Wait for replica DBs after this many batches
42 public $sizeHistogram = [];
44 public function __construct() {
45 parent
::__construct();
47 $this->addDescription( <<<TEXT
48 This script will find all rows in the categorylinks table whose collation is
49 out-of-date (cl_collation is not the same as \$wgCategoryCollation) and
50 repopulate cl_sortkey using the page title and cl_sortkey_prefix. If all
51 collations are up-to-date, it will do nothing.
55 $this->addOption( 'force', 'Run on all rows, even if the collation is ' .
56 'supposed to be up-to-date.', false, false, 'f' );
57 $this->addOption( 'previous-collation', 'Set the previous value of ' .
58 '$wgCategoryCollation here to speed up this script, especially if your ' .
59 'categorylinks table is large. This will only update rows with that ' .
60 'collation, though, so it may miss out-of-date rows with a different, ' .
61 'even older collation.', false, true );
62 $this->addOption( 'target-collation', 'Set this to the new collation type to ' .
63 'use instead of $wgCategoryCollation. Usually you should not use this, ' .
64 'you should just update $wgCategoryCollation in LocalSettings.php.',
66 $this->addOption( 'dry-run', 'Don\'t actually change the collations, just ' .
67 'compile statistics.' );
68 $this->addOption( 'verbose-stats', 'Show more statistics.' );
71 public function execute() {
72 $dbw = $this->getDB( DB_MASTER
);
73 $dbr = $this->getDB( DB_REPLICA
);
74 $force = $this->getOption( 'force' );
75 $dryRun = $this->getOption( 'dry-run' );
76 $verboseStats = $this->getOption( 'verbose-stats' );
77 if ( $this->hasOption( 'target-collation' ) ) {
78 $collationName = $this->getOption( 'target-collation' );
79 $collation = Collation
::factory( $collationName );
81 $collationName = $this->getConfig()->get( 'CategoryCollation' );
82 $collation = Collation
::singleton();
85 // Collation sanity check: in some cases the constructor will work,
86 // but this will raise an exception, breaking all category pages
87 $collation->getFirstLetter( 'MediaWiki' );
89 // Locally at least, (my local is a rather old version of mysql)
90 // mysql seems to filesort if there is both an equality
91 // (but not for an inequality) condition on cl_collation in the
92 // WHERE and it is also the first item in the ORDER BY.
93 if ( $this->hasOption( 'previous-collation' ) ) {
94 $orderBy = 'cl_to, cl_type, cl_from';
96 $orderBy = 'cl_collation, cl_to, cl_type, cl_from';
99 'LIMIT' => self
::BATCH_SIZE
,
100 'ORDER BY' => $orderBy,
101 'STRAIGHT_JOIN' // per T58041
104 $collationConds = [];
106 if ( $this->hasOption( 'previous-collation' ) ) {
107 $collationConds['cl_collation'] = $this->getOption( 'previous-collation' );
109 $collationConds = [ 0 =>
110 'cl_collation != ' . $dbw->addQuotes( $collationName )
114 $count = $dbr->estimateRowCount(
120 // Improve estimate if feasible
121 if ( $count < 1000000 ) {
122 $count = $dbr->selectField(
130 $this->output( "Collations up-to-date.\n" );
135 $this->output( "$count rows would be updated.\n" );
137 $this->output( "Fixing collation for $count rows.\n" );
144 $this->output( "Selecting next " . self
::BATCH_SIZE
. " rows..." );
146 // cl_type must be selected as a number for proper paging because
148 if ( $dbw->getType() === 'mysql' ) {
149 $clType = 'cl_type+0 AS "cl_type_numeric"';
154 [ 'categorylinks', 'page' ],
155 [ 'cl_from', 'cl_to', 'cl_sortkey_prefix', 'cl_collation',
156 'cl_sortkey', $clType,
157 'page_namespace', 'page_title'
159 array_merge( $collationConds, $batchConds, [ 'cl_from = page_id' ] ),
163 $this->output( " processing..." );
166 $this->beginTransaction( $dbw, __METHOD__
);
168 foreach ( $res as $row ) {
169 $title = Title
::newFromRow( $row );
170 if ( !$row->cl_collation
) {
171 # This is an old-style row, so the sortkey needs to be
173 if ( $row->cl_sortkey
== $title->getText()
174 ||
$row->cl_sortkey
== $title->getPrefixedText()
178 # Custom sortkey, use it as a prefix
179 $prefix = $row->cl_sortkey
;
182 $prefix = $row->cl_sortkey_prefix
;
184 # cl_type will be wrong for lots of pages if cl_collation is 0,
185 # so let's update it while we're here.
186 $type = MediaWikiServices
::getInstance()->getNamespaceInfo()->
187 getCategoryLinkType( $title->getNamespace() );
188 $newSortKey = $collation->getSortKey(
189 $title->getCategorySortkey( $prefix ) );
190 if ( $verboseStats ) {
191 $this->updateSortKeySizeHistogram( $newSortKey );
195 // Add 1 to the count if the sortkey was changed. (Note that this doesn't count changes in
196 // other fields, if any, those usually only happen when upgrading old MediaWikis.)
197 $count +
= ( $row->cl_sortkey
!== $newSortKey );
202 'cl_sortkey' => $newSortKey,
203 'cl_sortkey_prefix' => $prefix,
204 'cl_collation' => $collationName,
206 'cl_timestamp = cl_timestamp',
208 [ 'cl_from' => $row->cl_from
, 'cl_to' => $row->cl_to
],
214 $batchConds = [ $this->getBatchCondition( $row, $dbw ) ];
218 $this->commitTransaction( $dbw, __METHOD__
);
222 $this->output( "$count rows would be updated so far.\n" );
224 $this->output( "$count done.\n" );
226 } while ( $res->numRows() == self
::BATCH_SIZE
);
229 $this->output( "$count rows processed\n" );
232 if ( $verboseStats ) {
233 $this->output( "\n" );
234 $this->showSortKeySizeHistogram();
239 * Return an SQL expression selecting rows which sort above the given row,
240 * assuming an ordering of cl_collation, cl_to, cl_type, cl_from
241 * @param stdClass $row
242 * @param IDatabase $dbw
245 function getBatchCondition( $row, $dbw ) {
246 if ( $this->hasOption( 'previous-collation' ) ) {
247 $fields = [ 'cl_to', 'cl_type', 'cl_from' ];
249 $fields = [ 'cl_collation', 'cl_to', 'cl_type', 'cl_from' ];
254 foreach ( $fields as $field ) {
255 if ( $dbw->getType() === 'mysql' && $field === 'cl_type' ) {
256 // Range conditions with enums are weird in mysql
257 // This must be a numeric literal, or it won't work.
258 $encValue = intval( $row->cl_type_numeric
);
260 $encValue = $dbw->addQuotes( $row->$field );
262 $inequality = "$field > $encValue";
263 $equality = "$field = $encValue";
269 $cond .= " OR ($prefix AND $inequality)";
270 $prefix .= " AND $equality";
277 function updateSortKeySizeHistogram( $key ) {
278 $length = strlen( $key );
279 if ( !isset( $this->sizeHistogram
[$length] ) ) {
280 $this->sizeHistogram
[$length] = 0;
282 $this->sizeHistogram
[$length]++
;
285 function showSortKeySizeHistogram() {
286 $maxLength = max( array_keys( $this->sizeHistogram
) );
287 if ( $maxLength == 0 ) {
291 $coarseHistogram = array_fill( 0, $numBins, 0 );
292 $coarseBoundaries = [];
294 for ( $i = 0; $i < $numBins - 1; $i++
) {
295 $boundary +
= $maxLength / $numBins;
296 $coarseBoundaries[$i] = round( $boundary );
298 $coarseBoundaries[$numBins - 1] = $maxLength +
1;
300 for ( $i = 0; $i <= $maxLength; $i++
) {
304 $val = $this->sizeHistogram
[$i] ??
0;
305 for ( $coarseIndex = 0; $coarseIndex < $numBins - 1; $coarseIndex++
) {
306 if ( $coarseBoundaries[$coarseIndex] > $i ) {
307 $coarseHistogram[$coarseIndex] +
= $val;
311 if ( $coarseIndex == $numBins - 1 ) {
312 $coarseHistogram[$coarseIndex] +
= $val;
317 $this->output( "Sort key size histogram\nRaw data: $raw\n\n" );
319 $maxBinVal = max( $coarseHistogram );
320 $scale = 60 / $maxBinVal;
322 for ( $coarseIndex = 0; $coarseIndex < $numBins; $coarseIndex++
) {
323 $val = $coarseHistogram[$coarseIndex] ??
0;
324 $boundary = $coarseBoundaries[$coarseIndex];
325 $this->output( sprintf( "%-10s %-10d |%s\n",
326 $prevBoundary . '-' . ( $boundary - 1 ) . ': ',
328 str_repeat( '*', $scale * $val ) ) );
329 $prevBoundary = $boundary;
334 $maintClass = UpdateCollation
::class;
335 require_once RUN_MAINTENANCE_IF_MAIN
;