PopulateContentModel - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

PopulateContentModel A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	175
Duplicated Lines	4 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
dl	7
loc	175
rs	9.8
c	0
b	0
f	0
wmc	31
lcom	1
cbo	4

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	7	7	1
B	execute()	0	20	7
A	updatePageRows()	0	12	1
B	populatePage()	0	31	6
A	updateRevisionOrArchiveRows()	0	17	2
D	populateRevisionOrArchive()	0	81	14

How to fix Duplicated Code

<?php

/**
 * Populate the page_content_model and {rev,ar}_content_{model,format} fields.
 *
 * 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
 */

require_once __DIR__ . '/Maintenance.php';

/**
 * Usage:
 *  populateContentModel.php --ns=1 --table=page
 */
class PopulateContentModel extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Populate the various content_* fields' );
		$this->addOption( 'ns', 'Namespace to run in, or "all" for all namespaces', true, true );
		$this->addOption( 'table', 'Table to run in', true, true );
		$this->setBatchSize( 100 );
	}

	public function execute() {
		$dbw = $this->getDB( DB_MASTER );
		$ns = $this->getOption( 'ns' );
		if ( !ctype_digit( $ns ) && $ns !== 'all' ) {
			$this->error( 'Invalid namespace', 1 );
		}
		$ns = $ns === 'all' ? 'all' : (int)$ns;
		$table = $this->getOption( 'table' );
		switch ( $table ) {
			case 'revision':
			case 'archive':
				$this->populateRevisionOrArchive( $dbw, $table, $ns );
/** @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);
    }
}
				break;
			case 'page':
				$this->populatePage( $dbw, $ns );
/** @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);
    }
}
				break;
			default:
				$this->error( "Invalid table name: $table", 1 );
		}
	}

	private function updatePageRows( Database $dbw, $pageIds, $model ) {
		$count = count( $pageIds );
		$this->output( "Setting $count rows to $model..." );
		$dbw->update(
			'page',
			[ 'page_content_model' => $model ],
			[ 'page_id' => $pageIds ],
			__METHOD__
		);
		wfWaitForSlaves();

		$this->output( "done.\n" );
	}

	protected function populatePage( Database $dbw, $ns ) {
		$toSave = [];
		$lastId = 0;
		$nsCondition = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
		do {
			$rows = $dbw->select(
				'page',
				[ 'page_namespace', 'page_title', 'page_id' ],
				[
					'page_content_model' => null,
					'page_id > ' . $dbw->addQuotes( $lastId ),
				] + $nsCondition,
				__METHOD__,
				[ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => 'page_id ASC' ]
			);
			$this->output( "Fetched {$rows->numRows()} rows.\n" );
			foreach ( $rows as $row ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
				$title = Title::newFromRow( $row );
				$model = ContentHandler::getDefaultModelFor( $title );
				$toSave[$model][] = $row->page_id;
				if ( count( $toSave[$model] ) >= $this->mBatchSize ) {
					$this->updatePageRows( $dbw, $toSave[$model], $model );
					unset( $toSave[$model] );
				}
				$lastId = $row->page_id;
			}
		} while ( $rows->numRows() >= $this->mBatchSize );
		foreach ( $toSave as $model => $pages ) {
			$this->updatePageRows( $dbw, $pages, $model );
		}
	}

	private function updateRevisionOrArchiveRows( Database $dbw, $ids, $model, $table ) {
		$prefix = $table === 'archive' ? 'ar' : 'rev';
		$model_column = "{$prefix}_content_model";
		$format_column = "{$prefix}_content_format";
		$key = "{$prefix}_id";

		$count = count( $ids );
		$format = ContentHandler::getForModelID( $model )->getDefaultFormat();
		$this->output( "Setting $count rows to $model / $format..." );
		$dbw->update(
			$table,
			[ $model_column => $model, $format_column => $format ],
			[ $key => $ids ],
			__METHOD__
		);
		$this->output( "done.\n" );
	}

	protected function populateRevisionOrArchive( Database $dbw, $table, $ns ) {
		$prefix = $table === 'archive' ? 'ar' : 'rev';
		$model_column = "{$prefix}_content_model";
		$format_column = "{$prefix}_content_format";
		$key = "{$prefix}_id";
		if ( $table === 'archive' ) {
			$selectTables = 'archive';
			$fields = [ 'ar_namespace', 'ar_title' ];
			$join_conds = [];
			$where = $ns === 'all' ? [] : [ 'ar_namespace' => $ns ];
		} else { // revision
			$selectTables = [ 'revision', 'page' ];
			$fields = [ 'page_title', 'page_namespace' ];
			$join_conds = [ 'page' => [ 'INNER JOIN', 'rev_page=page_id' ] ];
			$where = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
		}

		$toSave = [];
		$lastId = 0;
		do {
			$rows = $dbw->select(
				$selectTables,
				array_merge( $fields, [ $model_column, $format_column, $key ] ),
				// @todo support populating format if model is already set
				[
					$model_column => null,
					"$key > " . $dbw->addQuotes( $lastId ),
				] + $where,
				__METHOD__,
				[ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => "$key ASC" ],
				$join_conds
			);
			$this->output( "Fetched {$rows->numRows()} rows.\n" );
			foreach ( $rows as $row ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
				if ( $table === 'archive' ) {
					$title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
				} else {
					$title = Title::newFromRow( $row );
				}
				$lastId = $row->{$key};
				try {
					$handler = ContentHandler::getForTitle( $title );
				} catch ( MWException $e ) {
					$this->error( "Invalid content model for $title" );
					continue;
				}
				$defaultModel = $handler->getModelID();
				$defaultFormat = $handler->getDefaultFormat();
				$dbModel = $row->{$model_column};
				$dbFormat = $row->{$format_column};
				$id = $row->{$key};
				if ( $dbModel === null && $dbFormat === null ) {
					// Set the defaults
					$toSave[$defaultModel][] = $row->{$key};
				} else { // $dbModel === null, $dbFormat set.
					if ( $dbFormat === $defaultFormat ) {
						$toSave[$defaultModel][] = $row->{$key};
					} else { // non-default format, just update now
						$this->output( "Updating model to match format for $table $id of $title... " );
						$dbw->update(
							$table,
							[ $model_column => $defaultModel ],
							[ $key => $id ],
							__METHOD__
						);
						wfWaitForSlaves();

						$this->output( "done.\n" );
						continue;
					}
				}

				if ( count( $toSave[$defaultModel] ) >= $this->mBatchSize ) {
					$this->updateRevisionOrArchiveRows( $dbw, $toSave[$defaultModel], $defaultModel, $table );
					unset( $toSave[$defaultModel] );
				}
			}
		} while ( $rows->numRows() >= $this->mBatchSize );
		foreach ( $toSave as $model => $ids ) {
			$this->updateRevisionOrArchiveRows( $dbw, $ids, $model, $table );
		}
	}
}

$maintClass = 'PopulateContentModel';
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 30 and the first side effect is on line 24. 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		* Populate the page_content_model and {rev,ar}_content_{model,format} fields.
4		*
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.
9		*
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.
14		*
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
19		*
20		* @file
21		* @ingroup Maintenance
22		*/
23
24		require_once __DIR__ . '/Maintenance.php';
25
26		/**
27		* Usage:
28		* populateContentModel.php --ns=1 --table=page
29		*/
30		class PopulateContentModel extends Maintenance {
31	View Code Duplication	public function __construct() {
32		parent::__construct();
33		$this->addDescription( 'Populate the various content_* fields' );
34		$this->addOption( 'ns', 'Namespace to run in, or "all" for all namespaces', true, true );
35		$this->addOption( 'table', 'Table to run in', true, true );
36		$this->setBatchSize( 100 );
37		}
38
39		public function execute() {
40		$dbw = $this->getDB( DB_MASTER );
41		$ns = $this->getOption( 'ns' );
42		if ( !ctype_digit( $ns ) && $ns !== 'all' ) {
43		$this->error( 'Invalid namespace', 1 );
44		}
45		$ns = $ns === 'all' ? 'all' : (int)$ns;
46		$table = $this->getOption( 'table' );
47		switch ( $table ) {
48		case 'revision':
49		case 'archive':
50		$this->populateRevisionOrArchive( $dbw, $table, $ns );
		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 `40` can be `null`; however, `PopulateContentModel::populateRevisionOrArchive()` 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...
51		break;
52		case 'page':
53		$this->populatePage( $dbw, $ns );
		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 `40` can be `null`; however, `PopulateContentModel::populatePage()` 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...
54		break;
55		default:
56		$this->error( "Invalid table name: $table", 1 );
57		}
58		}
59
60		private function updatePageRows( Database $dbw, $pageIds, $model ) {
61		$count = count( $pageIds );
62		$this->output( "Setting $count rows to $model..." );
63		$dbw->update(
64		'page',
65		[ 'page_content_model' => $model ],
66		[ 'page_id' => $pageIds ],
67		__METHOD__
68		);
69		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...
70		$this->output( "done.\n" );
71		}
72
73		protected function populatePage( Database $dbw, $ns ) {
74		$toSave = [];
75		$lastId = 0;
76		$nsCondition = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
77		do {
78		$rows = $dbw->select(
79		'page',
80		[ 'page_namespace', 'page_title', 'page_id' ],
81		[
82		'page_content_model' => null,
83		'page_id > ' . $dbw->addQuotes( $lastId ),
84		] + $nsCondition,
85		__METHOD__,
86		[ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => 'page_id ASC' ]
87		);
88		$this->output( "Fetched {$rows->numRows()} rows.\n" );
89		foreach ( $rows as $row ) {
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$rows` of type `boolean\|object<ResultWrapper>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
90		$title = Title::newFromRow( $row );
91		$model = ContentHandler::getDefaultModelFor( $title );
92		$toSave[$model][] = $row->page_id;
93		if ( count( $toSave[$model] ) >= $this->mBatchSize ) {
94		$this->updatePageRows( $dbw, $toSave[$model], $model );
95		unset( $toSave[$model] );
96		}
97		$lastId = $row->page_id;
98		}
99		} while ( $rows->numRows() >= $this->mBatchSize );
100		foreach ( $toSave as $model => $pages ) {
101		$this->updatePageRows( $dbw, $pages, $model );
102		}
103		}
104
105		private function updateRevisionOrArchiveRows( Database $dbw, $ids, $model, $table ) {
106		$prefix = $table === 'archive' ? 'ar' : 'rev';
107		$model_column = "{$prefix}_content_model";
108		$format_column = "{$prefix}_content_format";
109		$key = "{$prefix}_id";
110
111		$count = count( $ids );
112		$format = ContentHandler::getForModelID( $model )->getDefaultFormat();
113		$this->output( "Setting $count rows to $model / $format..." );
114		$dbw->update(
115		$table,
116		[ $model_column => $model, $format_column => $format ],
117		[ $key => $ids ],
118		__METHOD__
119		);
120		$this->output( "done.\n" );
121		}
122
123		protected function populateRevisionOrArchive( Database $dbw, $table, $ns ) {
124		$prefix = $table === 'archive' ? 'ar' : 'rev';
125		$model_column = "{$prefix}_content_model";
126		$format_column = "{$prefix}_content_format";
127		$key = "{$prefix}_id";
128		if ( $table === 'archive' ) {
129		$selectTables = 'archive';
130		$fields = [ 'ar_namespace', 'ar_title' ];
131		$join_conds = [];
132		$where = $ns === 'all' ? [] : [ 'ar_namespace' => $ns ];
133		} else { // revision
134		$selectTables = [ 'revision', 'page' ];
135		$fields = [ 'page_title', 'page_namespace' ];
136		$join_conds = [ 'page' => [ 'INNER JOIN', 'rev_page=page_id' ] ];
137		$where = $ns === 'all' ? [] : [ 'page_namespace' => $ns ];
138		}
139
140		$toSave = [];
141		$lastId = 0;
142		do {
143		$rows = $dbw->select(
144		$selectTables,
145		array_merge( $fields, [ $model_column, $format_column, $key ] ),
146		// @todo support populating format if model is already set
147		[
148		$model_column => null,
149		"$key > " . $dbw->addQuotes( $lastId ),
150		] + $where,
151		__METHOD__,
152		[ 'LIMIT' => $this->mBatchSize, 'ORDER BY' => "$key ASC" ],
153		$join_conds
154		);
155		$this->output( "Fetched {$rows->numRows()} rows.\n" );
156		foreach ( $rows as $row ) {
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$rows` of type `boolean\|object<ResultWrapper>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
157		if ( $table === 'archive' ) {
158		$title = Title::makeTitle( $row->ar_namespace, $row->ar_title );
159		} else {
160		$title = Title::newFromRow( $row );
161		}
162		$lastId = $row->{$key};
163		try {
164		$handler = ContentHandler::getForTitle( $title );
165		} catch ( MWException $e ) {
166		$this->error( "Invalid content model for $title" );
167		continue;
168		}
169		$defaultModel = $handler->getModelID();
170		$defaultFormat = $handler->getDefaultFormat();
171		$dbModel = $row->{$model_column};
172		$dbFormat = $row->{$format_column};
173		$id = $row->{$key};
174		if ( $dbModel === null && $dbFormat === null ) {
175		// Set the defaults
176		$toSave[$defaultModel][] = $row->{$key};
177		} else { // $dbModel === null, $dbFormat set.
178		if ( $dbFormat === $defaultFormat ) {
179		$toSave[$defaultModel][] = $row->{$key};
180		} else { // non-default format, just update now
181		$this->output( "Updating model to match format for $table $id of $title... " );
182		$dbw->update(
183		$table,
184		[ $model_column => $defaultModel ],
185		[ $key => $id ],
186		__METHOD__
187		);
188		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...
189		$this->output( "done.\n" );
190		continue;
191		}
192		}
193
194		if ( count( $toSave[$defaultModel] ) >= $this->mBatchSize ) {
195		$this->updateRevisionOrArchiveRows( $dbw, $toSave[$defaultModel], $defaultModel, $table );
196		unset( $toSave[$defaultModel] );
197		}
198		}
199		} while ( $rows->numRows() >= $this->mBatchSize );
200		foreach ( $toSave as $model => $ids ) {
201		$this->updateRevisionOrArchiveRows( $dbw, $ids, $model, $table );
202		}
203		}
204		}
205
206		$maintClass = 'PopulateContentModel';
207		require_once RUN_MAINTENANCE_IF_MAIN;
208

wikimedia / mediawiki

PopulateContentModel A last analyzed 2016-11-13 17:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

PopulateContentModel A
last analyzed 2016-11-13 17:42 UTC