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

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

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	73
rs	10
c	0
b	0
f	0
wmc	7
lcom	1
cbo	2

4 Methods

Rating	Name	Size	Complexity
A	__construct()	6	1
B	doDBUpdates()	41	4
A	getUpdateKey()	3	1
A	buildUpdateCondition()	18	1

<?php

/**
 * Upgrade script to populate the rc_source field
 *
 * 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 populate the rc_source field.
 *
 * @ingroup Maintenance
 * @since 1.22
 */
class PopulateRecentChangesSource extends LoggedUpdateMaintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription(
			'Populates rc_source field of the recentchanges table with the data in rc_type.' );
		$this->setBatchSize( 100 );
	}

	protected function doDBUpdates() {
		$dbw = $this->getDB( DB_MASTER );
		if ( !$dbw->fieldExists( 'recentchanges', 'rc_source' ) ) {
			$this->error( 'rc_source field in recentchanges table does not exist.' );
		}

		$start = $dbw->selectField( 'recentchanges', 'MIN(rc_id)', false, __METHOD__ );
		if ( !$start ) {
			$this->output( "Nothing to do.\n" );

			return true;
		}
		$end = $dbw->selectField( 'recentchanges', 'MAX(rc_id)', false, __METHOD__ );
		$end += $this->mBatchSize - 1;
		$blockStart = $start;
		$blockEnd = $start + $this->mBatchSize - 1;

		$updatedValues = $this->buildUpdateCondition( $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);
    }
}

		while ( $blockEnd <= $end ) {
			$cond = "rc_id BETWEEN $blockStart AND $blockEnd";
$myVar = 'Value';
$higher = false;

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

			$dbw->update(
				'recentchanges',
				[ $updatedValues ],
				[
					"rc_source = ''",
					"rc_id BETWEEN $blockStart AND $blockEnd"
				],
				__METHOD__
			);

			$this->output( "." );
			wfWaitForSlaves();


			$blockStart += $this->mBatchSize;
			$blockEnd += $this->mBatchSize;
		}

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

	protected function getUpdateKey() {
		return __CLASS__;
	}

	protected function buildUpdateCondition( Database $dbw ) {
		$rcNew = $dbw->addQuotes( RC_NEW );
		$rcSrcNew = $dbw->addQuotes( RecentChange::SRC_NEW );
		$rcEdit = $dbw->addQuotes( RC_EDIT );
		$rcSrcEdit = $dbw->addQuotes( RecentChange::SRC_EDIT );
		$rcLog = $dbw->addQuotes( RC_LOG );
		$rcSrcLog = $dbw->addQuotes( RecentChange::SRC_LOG );
		$rcExternal = $dbw->addQuotes( RC_EXTERNAL );
		$rcSrcExternal = $dbw->addQuotes( RecentChange::SRC_EXTERNAL );

		return "rc_source = CASE
					WHEN rc_type = $rcNew THEN $rcSrcNew
					WHEN rc_type = $rcEdit THEN $rcSrcEdit
					WHEN rc_type = $rcLog THEN $rcSrcLog
					WHEN rc_type = $rcExternal THEN $rcSrcExternal
					ELSE ''
				END";
	}
}

$maintClass = "PopulateRecentChangesSource";
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 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			* Upgrade script to populate the rc_source field
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 populate the rc_source field.
28			*
29			* @ingroup Maintenance
30			* @since 1.22
31			*/
32			class PopulateRecentChangesSource extends LoggedUpdateMaintenance {
33			public function __construct() {
34			parent::__construct();
35			$this->addDescription(
36			'Populates rc_source field of the recentchanges table with the data in rc_type.' );
37			$this->setBatchSize( 100 );
38			}
39
40			protected function doDBUpdates() {
41			$dbw = $this->getDB( DB_MASTER );
42			if ( !$dbw->fieldExists( 'recentchanges', 'rc_source' ) ) {
43			$this->error( 'rc_source field in recentchanges table does not exist.' );
44			}
45
46			$start = $dbw->selectField( 'recentchanges', 'MIN(rc_id)', false, __METHOD__ );
47			if ( !$start ) {
48			$this->output( "Nothing to do.\n" );
49
50			return true;
51			}
52			$end = $dbw->selectField( 'recentchanges', 'MAX(rc_id)', false, __METHOD__ );
53			$end += $this->mBatchSize - 1;
54			$blockStart = $start;
55			$blockEnd = $start + $this->mBatchSize - 1;
56
57			$updatedValues = $this->buildUpdateCondition( $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 `41` can be `null`; however, `PopulateRecentChangesSou...:buildUpdateCondition()` 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...
58
59			while ( $blockEnd <= $end ) {
60			$cond = "rc_id BETWEEN $blockStart AND $blockEnd";
			0 ignored issues – show Unused Code introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `$cond` 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...
61
62			$dbw->update(
63			'recentchanges',
64			[ $updatedValues ],
65			[
66			"rc_source = ''",
67			"rc_id BETWEEN $blockStart AND $blockEnd"
68			],
69			__METHOD__
70			);
71
72			$this->output( "." );
73			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...
74
75			$blockStart += $this->mBatchSize;
76			$blockEnd += $this->mBatchSize;
77			}
78
79			$this->output( "\nDone.\n" );
80			}
81
82			protected function getUpdateKey() {
83			return __CLASS__;
84			}
85
86			protected function buildUpdateCondition( Database $dbw ) {
87			$rcNew = $dbw->addQuotes( RC_NEW );
88			$rcSrcNew = $dbw->addQuotes( RecentChange::SRC_NEW );
89			$rcEdit = $dbw->addQuotes( RC_EDIT );
90			$rcSrcEdit = $dbw->addQuotes( RecentChange::SRC_EDIT );
91			$rcLog = $dbw->addQuotes( RC_LOG );
92			$rcSrcLog = $dbw->addQuotes( RecentChange::SRC_LOG );
93			$rcExternal = $dbw->addQuotes( RC_EXTERNAL );
94			$rcSrcExternal = $dbw->addQuotes( RecentChange::SRC_EXTERNAL );
95
96			return "rc_source = CASE
97			WHEN rc_type = $rcNew THEN $rcSrcNew
98			WHEN rc_type = $rcEdit THEN $rcSrcEdit
99			WHEN rc_type = $rcLog THEN $rcSrcLog
100			WHEN rc_type = $rcExternal THEN $rcSrcExternal
101			ELSE ''
102			END";
103			}
104			}
105
106			$maintClass = "PopulateRecentChangesSource";
107			require_once RUN_MAINTENANCE_IF_MAIN;
108

wikimedia / mediawiki

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

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like

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