CleanupEmptyCategories - Code Metrics - Inspection of "Daily Inspection: Merge "Use current content model..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (5998bb)

unknown

created 2016-07-23 17:18 UTC

CleanupEmptyCategories A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	170
Duplicated Lines	42.94 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	73
loc	170
rs	10
c	1
b	0
f	0
wmc	20
lcom	1
cbo	3

3 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	39	39	1
A	getUpdateKey()	0	3	1
D	doDBUpdates()	34	123	18

How to fix Duplicated Code

<?php

/**
 * Clean up empty categories in the category table.
 *
 * 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';

/**
 * Maintenance script to clean up empty categories in the category table.
 *
 * @ingroup Maintenance
 * @since 1.28
 */
class CleanupEmptyCategories extends LoggedUpdateMaintenance {

	public function __construct() {
		parent::__construct();
		$this->addDescription(
			<<<TEXT
This script will clean up the category table by removing entries for empty
categories without a description page and adding entries for empty categories
with a description page. It will print out progress indicators every batch. The
script is perfectly safe to run on large, live wikis, and running it multiple
times is harmless. You may want to use the throttling options if it's causing
too much load; they will not affect correctness.

If the script is stopped and later resumed, you can use the --mode and --begin
options with the last printed progress indicator to pick up where you left off.

When the script has finished, it will make a note of this in the database, and
will not run again without the --force option.
TEXT
		);

		$this->addOption(
			'mode',
			'"add" empty categories with description pages, "remove" empty categories '
			. 'without description pages, or "both"',
			false,
			true
		);
		$this->addOption(
			'begin',
			'Only do categories whose names are alphabetically after the provided name',
			false,
			true
		);
		$this->addOption(
			'throttle',
			'Wait this many milliseconds after each batch. Default: 0',
			false,
			true
		);
	}

	protected function getUpdateKey() {
		return 'cleanup empty categories';
	}

	protected function doDBUpdates() {
		$mode = $this->getOption( 'mode', 'both' );
		$begin = $this->getOption( 'begin', '' );
		$throttle = $this->getOption( 'throttle', 0 );

		if ( !in_array( $mode, [ 'add', 'remove', 'both' ] ) ) {
			$this->output( "--mode must be 'add', 'remove', or 'both'.\n" );
			return false;
		}

		$dbw = $this->getDB( DB_MASTER );

		$throttle = intval( $throttle );

		if ( $mode === 'add' || $mode === 'both' ) {
			if ( $begin !== '' ) {
				$where = [ 'page_title > ' . $dbw->addQuotes( $begin ) ];
			} else {
				$where = [];
			}

			$this->output( "Adding empty categories with description pages...\n" );
			while ( true ) {
				# Find which category to update
				$rows = $dbw->select(
					[ 'page', 'category' ],
					'page_title',
					array_merge( $where, [
						'page_namespace' => NS_CATEGORY,
						'cat_title' => null,
					] ),
					__METHOD__,
					[
						'ORDER BY' => 'page_title',
						'LIMIT' => $this->mBatchSize,
					],
					[
						'category' => [ 'LEFT JOIN', 'page_title = cat_title' ],
					]
				);
				if ( !$rows || $rows->numRows() <= 0 ) {
					# Done, hopefully.
					break;
				}

				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) { /** ... */ }
					$name = $row->page_title;
					$where = [ 'page_title > ' . $dbw->addQuotes( $name ) ];

					# Use the row to update the category count
					$cat = Category::newFromName( $name );
					if ( !is_object( $cat ) ) {
						$this->output( "The category named $name is not valid?!\n" );
					} else {
						$cat->refreshCounts();
					}
				}
				$this->output( "--mode=$mode --begin=$name\n" );
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

				wfWaitForSlaves();

				usleep( $throttle * 1000 );
			}

			$begin = '';
		}

		if ( $mode === 'remove' || $mode === 'both' ) {
			if ( $begin !== '' ) {
				$where = [ 'cat_title > ' . $dbw->addQuotes( $begin ) ];
			} else {
				$where = [];
			}
			$i = 0;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

			$this->output( "Removing empty categories without description pages...\n" );
			while ( true ) {
				# Find which category to update
				$rows = $dbw->select(
					[ 'category', 'page' ],
					'cat_title',
					array_merge( $where, [
						'page_title' => null,
						'cat_pages' => 0,
					] ),
					__METHOD__,
					[
						'ORDER BY' => 'cat_title',
						'LIMIT' => $this->mBatchSize,
					],
					[
						'page' => [ 'LEFT JOIN', [
							'page_namespace' => NS_CATEGORY, 'page_title = cat_title'
						] ],
					]
				);
				if ( !$rows || $rows->numRows() <= 0 ) {
					# Done, hopefully.
					break;
				}
				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) { /** ... */ }
					$name = $row->cat_title;
					$where = [ 'cat_title > ' . $dbw->addQuotes( $name ) ];

					# Use the row to update the category count
					$cat = Category::newFromName( $name );
					if ( !is_object( $cat ) ) {
						$this->output( "The category named $name is not valid?!\n" );
					} else {
						$cat->refreshCounts();
					}
				}

				$this->output( "--mode=remove --begin=$name\n" );

				wfWaitForSlaves();

				usleep( $throttle * 1000 );
			}
		}

		$this->output( "Category cleanup complete.\n" );

		return true;
	}
}

$maintClass = 'CleanupEmptyCategories';
require_once RUN_MAINTENANCE_IF_MAIN;


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-07-20 17:43 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 32 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		* Clean up empty categories in the category table.
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		* Maintenance script to clean up empty categories in the category table.
28		*
29		* @ingroup Maintenance
30		* @since 1.28
31		*/
32		class CleanupEmptyCategories extends LoggedUpdateMaintenance {
33
34	View Code Duplication	public function __construct() {
35		parent::__construct();
36		$this->addDescription(
37		<<<TEXT
38		This script will clean up the category table by removing entries for empty
39		categories without a description page and adding entries for empty categories
40		with a description page. It will print out progress indicators every batch. The
41		script is perfectly safe to run on large, live wikis, and running it multiple
42		times is harmless. You may want to use the throttling options if it's causing
43		too much load; they will not affect correctness.
44
45		If the script is stopped and later resumed, you can use the --mode and --begin
46		options with the last printed progress indicator to pick up where you left off.
47
48		When the script has finished, it will make a note of this in the database, and
49		will not run again without the --force option.
50		TEXT
51		);
52
53		$this->addOption(
54		'mode',
55		'"add" empty categories with description pages, "remove" empty categories '
56		. 'without description pages, or "both"',
57		false,
58		true
59		);
60		$this->addOption(
61		'begin',
62		'Only do categories whose names are alphabetically after the provided name',
63		false,
64		true
65		);
66		$this->addOption(
67		'throttle',
68		'Wait this many milliseconds after each batch. Default: 0',
69		false,
70		true
71		);
72		}
73
74		protected function getUpdateKey() {
75		return 'cleanup empty categories';
76		}
77
78		protected function doDBUpdates() {
79		$mode = $this->getOption( 'mode', 'both' );
80		$begin = $this->getOption( 'begin', '' );
81		$throttle = $this->getOption( 'throttle', 0 );
82
83		if ( !in_array( $mode, [ 'add', 'remove', 'both' ] ) ) {
84		$this->output( "--mode must be 'add', 'remove', or 'both'.\n" );
85		return false;
86		}
87
88		$dbw = $this->getDB( DB_MASTER );
89
90		$throttle = intval( $throttle );
91
92		if ( $mode === 'add' \|\| $mode === 'both' ) {
93	View Code Duplication	if ( $begin !== '' ) {
94		$where = [ 'page_title > ' . $dbw->addQuotes( $begin ) ];
95		} else {
96		$where = [];
97		}
98
99		$this->output( "Adding empty categories with description pages...\n" );
100		while ( true ) {
101		# Find which category to update
102		$rows = $dbw->select(
103		[ 'page', 'category' ],
104		'page_title',
105		array_merge( $where, [
106		'page_namespace' => NS_CATEGORY,
107		'cat_title' => null,
108		] ),
109		__METHOD__,
110		[
111		'ORDER BY' => 'page_title',
112		'LIMIT' => $this->mBatchSize,
113		],
114		[
115		'category' => [ 'LEFT JOIN', 'page_title = cat_title' ],
116		]
117		);
118		if ( !$rows \|\| $rows->numRows() <= 0 ) {
119		# Done, hopefully.
120		break;
121		}
122
123	View Code Duplication	foreach ( $rows as $row ) {
		0 ignored issues – show Bug introduced 2016-07-20 17:43 UTC by Report Bug Copy Issue Report The expression `$rows` of type `object<ResultWrapper>\|boolean` 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...
124		$name = $row->page_title;
125		$where = [ 'page_title > ' . $dbw->addQuotes( $name ) ];
126
127		# Use the row to update the category count
128		$cat = Category::newFromName( $name );
129		if ( !is_object( $cat ) ) {
130		$this->output( "The category named $name is not valid?!\n" );
131		} else {
132		$cat->refreshCounts();
133		}
134		}
135		$this->output( "--mode=$mode --begin=$name\n" );
		0 ignored issues – show Bug introduced 2016-07-20 17:43 UTC by Report Bug Copy Issue Report The variable `$name` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
136
137		wfWaitForSlaves();
		0 ignored issues – show Deprecated Code introduced 2016-07-20 17:43 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...
138		usleep( $throttle * 1000 );
139		}
140
141		$begin = '';
142		}
143
144		if ( $mode === 'remove' \|\| $mode === 'both' ) {
145	View Code Duplication	if ( $begin !== '' ) {
146		$where = [ 'cat_title > ' . $dbw->addQuotes( $begin ) ];
147		} else {
148		$where = [];
149		}
150		$i = 0;
		0 ignored issues – show Unused Code introduced 2016-07-20 17:43 UTC by Report Bug Copy Issue Report `$i` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
151
152		$this->output( "Removing empty categories without description pages...\n" );
153		while ( true ) {
154		# Find which category to update
155		$rows = $dbw->select(
156		[ 'category', 'page' ],
157		'cat_title',
158		array_merge( $where, [
159		'page_title' => null,
160		'cat_pages' => 0,
161		] ),
162		__METHOD__,
163		[
164		'ORDER BY' => 'cat_title',
165		'LIMIT' => $this->mBatchSize,
166		],
167		[
168		'page' => [ 'LEFT JOIN', [
169		'page_namespace' => NS_CATEGORY, 'page_title = cat_title'
170		] ],
171		]
172		);
173		if ( !$rows \|\| $rows->numRows() <= 0 ) {
174		# Done, hopefully.
175		break;
176		}
177	View Code Duplication	foreach ( $rows as $row ) {
		0 ignored issues – show Bug introduced 2016-07-20 17:43 UTC by Report Bug Copy Issue Report The expression `$rows` of type `object<ResultWrapper>\|boolean` 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...
178		$name = $row->cat_title;
179		$where = [ 'cat_title > ' . $dbw->addQuotes( $name ) ];
180
181		# Use the row to update the category count
182		$cat = Category::newFromName( $name );
183		if ( !is_object( $cat ) ) {
184		$this->output( "The category named $name is not valid?!\n" );
185		} else {
186		$cat->refreshCounts();
187		}
188		}
189
190		$this->output( "--mode=remove --begin=$name\n" );
191
192		wfWaitForSlaves();
		0 ignored issues – show Deprecated Code introduced 2016-07-20 17:43 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...
193		usleep( $throttle * 1000 );
194		}
195		}
196
197		$this->output( "Category cleanup complete.\n" );
198
199		return true;
200		}
201		}
202
203		$maintClass = 'CleanupEmptyCategories';
204		require_once RUN_MAINTENANCE_IF_MAIN;
205

wikimedia / mediawiki

Branch — master (5998bb)

CleanupEmptyCategories A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like