UpdateCollation::execute() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

UpdateCollation::execute() F
last analyzed 2016-11-13 17:42 UTC

↳ Parent: UpdateCollation

Complexity

Conditions	24
Paths	> 20000

Size

Total Lines	171
Code Lines	114

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	24
eloc	114
nc	84112
nop	0
dl	0
loc	171
rs	2
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

/**
 * Find all rows in the categorylinks table whose collation is out-of-date
 * (cl_collation != $wgCategoryCollation) and repopulate cl_sortkey
 * using the page title and cl_sortkey_prefix.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Maintenance
 * @author Aryeh Gregor (Simetrical)
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Maintenance script that will find all rows in the categorylinks table
 * whose collation is out-of-date.
 *
 * @ingroup Maintenance
 */
class UpdateCollation extends Maintenance {
	const BATCH_SIZE = 100; // Number of rows to process in one batch
	const SYNC_INTERVAL = 5; // Wait for replica DBs after this many batches

	public $sizeHistogram = [];

	public function __construct() {
		parent::__construct();

		global $wgCategoryCollation;
		$this->addDescription( <<<TEXT
This script will find all rows in the categorylinks table whose collation is
out-of-date (cl_collation != '$wgCategoryCollation') and repopulate cl_sortkey
using the page title and cl_sortkey_prefix.  If all collations are
up-to-date, it will do nothing.
TEXT
		);

		$this->addOption( 'force', 'Run on all rows, even if the collation is ' .
			'supposed to be up-to-date.', false, false, 'f' );
		$this->addOption( 'previous-collation', 'Set the previous value of ' .
			'$wgCategoryCollation here to speed up this script, especially if your ' .
			'categorylinks table is large. This will only update rows with that ' .
			'collation, though, so it may miss out-of-date rows with a different, ' .
			'even older collation.', false, true );
		$this->addOption( 'target-collation', 'Set this to the new collation type to ' .
			'use instead of $wgCategoryCollation. Usually you should not use this, ' .
			'you should just update $wgCategoryCollation in LocalSettings.php.',
			false, true );
		$this->addOption( 'dry-run', 'Don\'t actually change the collations, just ' .
			'compile statistics.' );
		$this->addOption( 'verbose-stats', 'Show more statistics.' );
	}

	public function execute() {
		global $wgCategoryCollation;

		$dbw = $this->getDB( DB_MASTER );
		$dbr = $this->getDB( DB_REPLICA );
		$force = $this->getOption( 'force' );
		$dryRun = $this->getOption( 'dry-run' );
		$verboseStats = $this->getOption( 'verbose-stats' );
		if ( $this->hasOption( 'target-collation' ) ) {
			$collationName = $this->getOption( 'target-collation' );
			$collation = Collation::factory( $collationName );
		} else {
			$collationName = $wgCategoryCollation;
			$collation = Collation::singleton();
		}

		// Collation sanity check: in some cases the constructor will work,
		// but this will raise an exception, breaking all category pages
		$collation->getFirstLetter( 'MediaWiki' );

		// Locally at least, (my local is a rather old version of mysql)
		// mysql seems to filesort if there is both an equality
		// (but not for an inequality) condition on cl_collation in the
		// WHERE and it is also the first item in the ORDER BY.
		if ( $this->hasOption( 'previous-collation' ) ) {
			$orderBy = 'cl_to, cl_type, cl_from';
		} else {
			$orderBy = 'cl_collation, cl_to, cl_type, cl_from';
		}
		$options = [
			'LIMIT' => self::BATCH_SIZE,
			'ORDER BY' => $orderBy,
			'STRAIGHT_JOIN' // per T58041
		];

		if ( $force ) {
			$collationConds = [];
		} else {
			if ( $this->hasOption( 'previous-collation' ) ) {
				$collationConds['cl_collation'] = $this->getOption( 'previous-collation' );
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
			} else {
				$collationConds = [ 0 =>
					'cl_collation != ' . $dbw->addQuotes( $collationName )
				];
			}

			$count = $dbr->estimateRowCount(
				'categorylinks',
				'*',
				$collationConds,
				__METHOD__
			);
			// Improve estimate if feasible
			if ( $count < 1000000 ) {
				$count = $dbr->selectField(
					'categorylinks',
					'COUNT(*)',
					$collationConds,
					__METHOD__
				);
			}
			if ( $count == 0 ) {
				$this->output( "Collations up-to-date.\n" );

				return;
			}
			if ( $dryRun ) {
				$this->output( "$count rows would be updated.\n" );
			} else {
				$this->output( "Fixing collation for $count rows.\n" );
			}
			wfWaitForSlaves();

		}
		$count = 0;
		$batchCount = 0;
		$batchConds = [];
		do {
			$this->output( "Selecting next " . self::BATCH_SIZE . " rows..." );

			// cl_type must be selected as a number for proper paging because
			// enums suck.
			if ( $dbw->getType() === 'mysql' ) {
				$clType = 'cl_type+0 AS "cl_type_numeric"';
			} else {
				$clType = 'cl_type';
			}
			$res = $dbw->select(
				[ 'categorylinks', 'page' ],
				[ 'cl_from', 'cl_to', 'cl_sortkey_prefix', 'cl_collation',
					'cl_sortkey', $clType,
					'page_namespace', 'page_title'
				],
				array_merge( $collationConds, $batchConds, [ 'cl_from = page_id' ] ),
				__METHOD__,
				$options
			);
			$this->output( " processing..." );

			if ( !$dryRun ) {
				$this->beginTransaction( $dbw, __METHOD__ );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			}
			foreach ( $res as $row ) {
				$title = Title::newFromRow( $row );
				if ( !$row->cl_collation ) {
					# This is an old-style row, so the sortkey needs to be
					# converted.
					if ( $row->cl_sortkey == $title->getText()
						|| $row->cl_sortkey == $title->getPrefixedText()
					) {
						$prefix = '';
					} else {
						# Custom sortkey, use it as a prefix
						$prefix = $row->cl_sortkey;
					}
				} else {
					$prefix = $row->cl_sortkey_prefix;
				}
				# cl_type will be wrong for lots of pages if cl_collation is 0,
				# so let's update it while we're here.
				if ( $title->getNamespace() == NS_CATEGORY ) {
					$type = 'subcat';
				} elseif ( $title->getNamespace() == NS_FILE ) {
					$type = 'file';
				} else {
					$type = 'page';
				}
				$newSortKey = $collation->getSortKey(
					$title->getCategorySortkey( $prefix ) );
				if ( $verboseStats ) {
					$this->updateSortKeySizeHistogram( $newSortKey );
				}

				if ( !$dryRun ) {
					$dbw->update(
						'categorylinks',
						[
							'cl_sortkey' => $newSortKey,
							'cl_sortkey_prefix' => $prefix,
							'cl_collation' => $collationName,
							'cl_type' => $type,
							'cl_timestamp = cl_timestamp',
						],
						[ 'cl_from' => $row->cl_from, 'cl_to' => $row->cl_to ],
						__METHOD__
					);
				}
				if ( $row ) {
					$batchConds = [ $this->getBatchCondition( $row, $dbw ) ];
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
				}
			}
			if ( !$dryRun ) {
				$this->commitTransaction( $dbw, __METHOD__ );
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			}

			$count += $res->numRows();
			$this->output( "$count done.\n" );

			if ( !$dryRun && ++$batchCount % self::SYNC_INTERVAL == 0 ) {
				$this->output( "Waiting for replica DBs ... " );
				wfWaitForSlaves();

				$this->output( "done\n" );
			}
		} while ( $res->numRows() == self::BATCH_SIZE );

		$this->output( "$count rows processed\n" );

		if ( $verboseStats ) {
			$this->output( "\n" );
			$this->showSortKeySizeHistogram();
		}
	}

	/**
	 * Return an SQL expression selecting rows which sort above the given row,
	 * assuming an ordering of cl_collation, cl_to, cl_type, cl_from
	 * @param stdClass $row
	 * @param Database $dbw
	 * @return string
	 */
	function getBatchCondition( $row, $dbw ) {
		if ( $this->hasOption( 'previous-collation' ) ) {
			$fields = [ 'cl_to', 'cl_type', 'cl_from' ];
		} else {
			$fields = [ 'cl_collation', 'cl_to', 'cl_type', 'cl_from' ];
		}
		$first = true;
		$cond = false;
		$prefix = false;
		foreach ( $fields as $field ) {
			if ( $dbw->getType() === 'mysql' && $field === 'cl_type' ) {
				// Range conditions with enums are weird in mysql
				// This must be a numeric literal, or it won't work.
				$encValue = intval( $row->cl_type_numeric );
			} else {
				$encValue = $dbw->addQuotes( $row->$field );
			}
			$inequality = "$field > $encValue";
			$equality = "$field = $encValue";
			if ( $first ) {
				$cond = $inequality;
				$prefix = $equality;
				$first = false;
			} else {
				$cond .= " OR ($prefix AND $inequality)";
				$prefix .= " AND $equality";
			}
		}

		return $cond;
	}

	function updateSortKeySizeHistogram( $key ) {
		$length = strlen( $key );
		if ( !isset( $this->sizeHistogram[$length] ) ) {
			$this->sizeHistogram[$length] = 0;
		}
		$this->sizeHistogram[$length]++;
	}

	function showSortKeySizeHistogram() {
		$maxLength = max( array_keys( $this->sizeHistogram ) );
		if ( $maxLength == 0 ) {
			return;
		}
		$numBins = 20;
		$coarseHistogram = array_fill( 0, $numBins, 0 );
		$coarseBoundaries = [];
		$boundary = 0;
		for ( $i = 0; $i < $numBins - 1; $i++ ) {
			$boundary += $maxLength / $numBins;
			$coarseBoundaries[$i] = round( $boundary );
		}
		$coarseBoundaries[$numBins - 1] = $maxLength + 1;
		$raw = '';
		for ( $i = 0; $i <= $maxLength; $i++ ) {
			if ( $raw !== '' ) {
				$raw .= ', ';
			}
			if ( !isset( $this->sizeHistogram[$i] ) ) {
				$val = 0;
			} else {
				$val = $this->sizeHistogram[$i];
			}
			for ( $coarseIndex = 0; $coarseIndex < $numBins - 1; $coarseIndex++ ) {
				if ( $coarseBoundaries[$coarseIndex] > $i ) {
					$coarseHistogram[$coarseIndex] += $val;
					break;
				}
			}
			if ( $coarseIndex == $numBins - 1 ) {
				$coarseHistogram[$coarseIndex] += $val;
			}
			$raw .= $val;
		}

		$this->output( "Sort key size histogram\nRaw data: $raw\n\n" );

		$maxBinVal = max( $coarseHistogram );
		$scale = 60 / $maxBinVal;
		$prevBoundary = 0;
		for ( $coarseIndex = 0; $coarseIndex < $numBins; $coarseIndex++ ) {
			if ( !isset( $coarseHistogram[$coarseIndex] ) ) {
				$val = 0;
			} else {
				$val = $coarseHistogram[$coarseIndex];
			}
			$boundary = $coarseBoundaries[$coarseIndex];
			$this->output( sprintf( "%-10s %-10d |%s\n",
				$prevBoundary . '-' . ( $boundary - 1 ) . ': ',
				$val,
				str_repeat( '*', $scale * $val ) ) );
			$prevBoundary = $boundary;
		}
	}
}

$maintClass = "UpdateCollation";
require_once RUN_MAINTENANCE_IF_MAIN;


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 35 and the first side effect is on line 27. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
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.
6			*
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.
11			*
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.
16			*
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
21			*
22			* @file
23			* @ingroup Maintenance
24			* @author Aryeh Gregor (Simetrical)
25			*/
26
27			require_once __DIR__ . '/Maintenance.php';
28
29			/**
30			* Maintenance script that will find all rows in the categorylinks table
31			* whose collation is out-of-date.
32			*
33			* @ingroup Maintenance
34			*/
35			class UpdateCollation extends Maintenance {
36			const BATCH_SIZE = 100; // Number of rows to process in one batch
37			const SYNC_INTERVAL = 5; // Wait for replica DBs after this many batches
38
39			public $sizeHistogram = [];
40
41			public function __construct() {
42			parent::__construct();
43
44			global $wgCategoryCollation;
45			$this->addDescription( <<<TEXT
46			This script will find all rows in the categorylinks table whose collation is
47			out-of-date (cl_collation != '$wgCategoryCollation') and repopulate cl_sortkey
48			using the page title and cl_sortkey_prefix. If all collations are
49			up-to-date, it will do nothing.
50			TEXT
51			);
52
53			$this->addOption( 'force', 'Run on all rows, even if the collation is ' .
54			'supposed to be up-to-date.', false, false, 'f' );
55			$this->addOption( 'previous-collation', 'Set the previous value of ' .
56			'$wgCategoryCollation here to speed up this script, especially if your ' .
57			'categorylinks table is large. This will only update rows with that ' .
58			'collation, though, so it may miss out-of-date rows with a different, ' .
59			'even older collation.', false, true );
60			$this->addOption( 'target-collation', 'Set this to the new collation type to ' .
61			'use instead of $wgCategoryCollation. Usually you should not use this, ' .
62			'you should just update $wgCategoryCollation in LocalSettings.php.',
63			false, true );
64			$this->addOption( 'dry-run', 'Don\'t actually change the collations, just ' .
65			'compile statistics.' );
66			$this->addOption( 'verbose-stats', 'Show more statistics.' );
67			}
68
69			public function execute() {
70			global $wgCategoryCollation;
71
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 );
80			} else {
81			$collationName = $wgCategoryCollation;
82			$collation = Collation::singleton();
83			}
84
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' );
88
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';
95			} else {
96			$orderBy = 'cl_collation, cl_to, cl_type, cl_from';
97			}
98			$options = [
99			'LIMIT' => self::BATCH_SIZE,
100			'ORDER BY' => $orderBy,
101			'STRAIGHT_JOIN' // per T58041
102			];
103
104			if ( $force ) {
105			$collationConds = [];
106			} else {
107			if ( $this->hasOption( 'previous-collation' ) ) {
108			$collationConds['cl_collation'] = $this->getOption( 'previous-collation' );
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `$collationConds` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$collationConds = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
109			} else {
110			$collationConds = [ 0 =>
111			'cl_collation != ' . $dbw->addQuotes( $collationName )
112			];
113			}
114
115			$count = $dbr->estimateRowCount(
116			'categorylinks',
117			'*',
118			$collationConds,
119			__METHOD__
120			);
121			// Improve estimate if feasible
122			if ( $count < 1000000 ) {
123			$count = $dbr->selectField(
124			'categorylinks',
125			'COUNT(*)',
126			$collationConds,
127			__METHOD__
128			);
129			}
130			if ( $count == 0 ) {
131			$this->output( "Collations up-to-date.\n" );
132
133			return;
134			}
135			if ( $dryRun ) {
136			$this->output( "$count rows would be updated.\n" );
137			} else {
138			$this->output( "Fixing collation for $count rows.\n" );
139			}
140			wfWaitForSlaves();
			0 ignored issues – show Deprecated Code introduced 2016-01-25 18:14 UTC by Report Bug Copy Issue Report The function `wfWaitForSlaves()` has been deprecated with message: since 1.27 Use LBFactory::waitForReplication This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
141			}
142			$count = 0;
143			$batchCount = 0;
144			$batchConds = [];
145			do {
146			$this->output( "Selecting next " . self::BATCH_SIZE . " rows..." );
147
148			// cl_type must be selected as a number for proper paging because
149			// enums suck.
150			if ( $dbw->getType() === 'mysql' ) {
151			$clType = 'cl_type+0 AS "cl_type_numeric"';
152			} else {
153			$clType = 'cl_type';
154			}
155			$res = $dbw->select(
156			[ 'categorylinks', 'page' ],
157			[ 'cl_from', 'cl_to', 'cl_sortkey_prefix', 'cl_collation',
158			'cl_sortkey', $clType,
159			'page_namespace', 'page_title'
160			],
161			array_merge( $collationConds, $batchConds, [ 'cl_from = page_id' ] ),
162			__METHOD__,
163			$options
164			);
165			$this->output( " processing..." );
166
167			if ( !$dryRun ) {
168			$this->beginTransaction( $dbw, __METHOD__ );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `72` can be `null`; however, `Maintenance::beginTransaction()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
169			}
170			foreach ( $res as $row ) {
171			$title = Title::newFromRow( $row );
172			if ( !$row->cl_collation ) {
173			# This is an old-style row, so the sortkey needs to be
174			# converted.
175			if ( $row->cl_sortkey == $title->getText()
176			\|\| $row->cl_sortkey == $title->getPrefixedText()
177			) {
178			$prefix = '';
179			} else {
180			# Custom sortkey, use it as a prefix
181			$prefix = $row->cl_sortkey;
182			}
183			} else {
184			$prefix = $row->cl_sortkey_prefix;
185			}
186			# cl_type will be wrong for lots of pages if cl_collation is 0,
187			# so let's update it while we're here.
188			if ( $title->getNamespace() == NS_CATEGORY ) {
189			$type = 'subcat';
190			} elseif ( $title->getNamespace() == NS_FILE ) {
191			$type = 'file';
192			} else {
193			$type = 'page';
194			}
195			$newSortKey = $collation->getSortKey(
196			$title->getCategorySortkey( $prefix ) );
197			if ( $verboseStats ) {
198			$this->updateSortKeySizeHistogram( $newSortKey );
199			}
200
201			if ( !$dryRun ) {
202			$dbw->update(
203			'categorylinks',
204			[
205			'cl_sortkey' => $newSortKey,
206			'cl_sortkey_prefix' => $prefix,
207			'cl_collation' => $collationName,
208			'cl_type' => $type,
209			'cl_timestamp = cl_timestamp',
210			],
211			[ 'cl_from' => $row->cl_from, 'cl_to' => $row->cl_to ],
212			__METHOD__
213			);
214			}
215			if ( $row ) {
216			$batchConds = [ $this->getBatchCondition( $row, $dbw ) ];
			0 ignored issues – show Bug introduced 2016-09-29 17:29 UTC by Report Bug Copy Issue Report It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `72` can be `null`; however, `UpdateCollation::getBatchCondition()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
217			}
218			}
219			if ( !$dryRun ) {
220			$this->commitTransaction( $dbw, __METHOD__ );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$dbw` defined by `$this->getDB(DB_MASTER)` on line `72` can be `null`; however, `Maintenance::commitTransaction()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
221			}
222
223			$count += $res->numRows();
224			$this->output( "$count done.\n" );
225
226			if ( !$dryRun && ++$batchCount % self::SYNC_INTERVAL == 0 ) {
227			$this->output( "Waiting for replica DBs ... " );
228			wfWaitForSlaves();
			0 ignored issues – show Deprecated Code introduced 2016-05-11 17:53 UTC by Report Bug Copy Issue Report The function `wfWaitForSlaves()` has been deprecated with message: since 1.27 Use LBFactory::waitForReplication This function has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead. Loading history...
229			$this->output( "done\n" );
230			}
231			} while ( $res->numRows() == self::BATCH_SIZE );
232
233			$this->output( "$count rows processed\n" );
234
235			if ( $verboseStats ) {
236			$this->output( "\n" );
237			$this->showSortKeySizeHistogram();
238			}
239			}
240
241			/**
242			* Return an SQL expression selecting rows which sort above the given row,
243			* assuming an ordering of cl_collation, cl_to, cl_type, cl_from
244			* @param stdClass $row
245			* @param Database $dbw
246			* @return string
247			*/
248			function getBatchCondition( $row, $dbw ) {
249			if ( $this->hasOption( 'previous-collation' ) ) {
250			$fields = [ 'cl_to', 'cl_type', 'cl_from' ];
251			} else {
252			$fields = [ 'cl_collation', 'cl_to', 'cl_type', 'cl_from' ];
253			}
254			$first = true;
255			$cond = false;
256			$prefix = false;
257			foreach ( $fields as $field ) {
258			if ( $dbw->getType() === 'mysql' && $field === 'cl_type' ) {
259			// Range conditions with enums are weird in mysql
260			// This must be a numeric literal, or it won't work.
261			$encValue = intval( $row->cl_type_numeric );
262			} else {
263			$encValue = $dbw->addQuotes( $row->$field );
264			}
265			$inequality = "$field > $encValue";
266			$equality = "$field = $encValue";
267			if ( $first ) {
268			$cond = $inequality;
269			$prefix = $equality;
270			$first = false;
271			} else {
272			$cond .= " OR ($prefix AND $inequality)";
273			$prefix .= " AND $equality";
274			}
275			}
276
277			return $cond;
278			}
279
280			function updateSortKeySizeHistogram( $key ) {
281			$length = strlen( $key );
282			if ( !isset( $this->sizeHistogram[$length] ) ) {
283			$this->sizeHistogram[$length] = 0;
284			}
285			$this->sizeHistogram[$length]++;
286			}
287
288			function showSortKeySizeHistogram() {
289			$maxLength = max( array_keys( $this->sizeHistogram ) );
290			if ( $maxLength == 0 ) {
291			return;
292			}
293			$numBins = 20;
294			$coarseHistogram = array_fill( 0, $numBins, 0 );
295			$coarseBoundaries = [];
296			$boundary = 0;
297			for ( $i = 0; $i < $numBins - 1; $i++ ) {
298			$boundary += $maxLength / $numBins;
299			$coarseBoundaries[$i] = round( $boundary );
300			}
301			$coarseBoundaries[$numBins - 1] = $maxLength + 1;
302			$raw = '';
303			for ( $i = 0; $i <= $maxLength; $i++ ) {
304			if ( $raw !== '' ) {
305			$raw .= ', ';
306			}
307			if ( !isset( $this->sizeHistogram[$i] ) ) {
308			$val = 0;
309			} else {
310			$val = $this->sizeHistogram[$i];
311			}
312			for ( $coarseIndex = 0; $coarseIndex < $numBins - 1; $coarseIndex++ ) {
313			if ( $coarseBoundaries[$coarseIndex] > $i ) {
314			$coarseHistogram[$coarseIndex] += $val;
315			break;
316			}
317			}
318			if ( $coarseIndex == $numBins - 1 ) {
319			$coarseHistogram[$coarseIndex] += $val;
320			}
321			$raw .= $val;
322			}
323
324			$this->output( "Sort key size histogram\nRaw data: $raw\n\n" );
325
326			$maxBinVal = max( $coarseHistogram );
327			$scale = 60 / $maxBinVal;
328			$prevBoundary = 0;
329			for ( $coarseIndex = 0; $coarseIndex < $numBins; $coarseIndex++ ) {
330			if ( !isset( $coarseHistogram[$coarseIndex] ) ) {
331			$val = 0;
332			} else {
333			$val = $coarseHistogram[$coarseIndex];
334			}
335			$boundary = $coarseBoundaries[$coarseIndex];
336			$this->output( sprintf( "%-10s %-10d \|%s\n",
337			$prevBoundary . '-' . ( $boundary - 1 ) . ': ',
338			$val,
339			str_repeat( '', $scale $val ) ) );
340			$prevBoundary = $boundary;
341			}
342			}
343			}
344
345			$maintClass = "UpdateCollation";
346			require_once RUN_MAINTENANCE_IF_MAIN;
347

wikimedia / mediawiki

UpdateCollation::execute() F last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

UpdateCollation::execute() F
last analyzed 2016-11-13 17:42 UTC