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

PopulateLogUsertext::__construct() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: PopulateLogUsertext

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0

<?php

/**
 * Makes the required database updates for Special:ProtectedPages
 * to show all protected pages, even ones before the page restrictions
 * schema change. All remaining page_restriction column values are moved
 * to the new 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 that makes the required database updates for
 * Special:ProtectedPages to show all protected pages.
 *
 * @ingroup Maintenance
 */
class PopulateLogUsertext extends LoggedUpdateMaintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Populates the log_user_text field' );
		$this->setBatchSize( 100 );
	}

	protected function getUpdateKey() {
		return 'populate log_usertext';
	}

	protected function updateSkippedMessage() {
		return 'log_user_text column of logging table already populated.';
	}

	protected function doDBUpdates() {
		$db = $this->getDB( DB_MASTER );
		$start = $db->selectField( 'logging', 'MIN(log_id)', false, __METHOD__ );
		if ( !$start ) {
			$this->output( "Nothing to do.\n" );

			return true;
		}
		$end = $db->selectField( 'logging', 'MAX(log_id)', false, __METHOD__ );

		# Do remaining chunk
		$end += $this->mBatchSize - 1;
		$blockStart = $start;
		$blockEnd = $start + $this->mBatchSize - 1;
		while ( $blockEnd <= $end ) {
			$this->output( "...doing log_id from $blockStart to $blockEnd\n" );
			$cond = "log_id BETWEEN $blockStart AND $blockEnd AND log_user = user_id";
			$res = $db->select( [ 'logging', 'user' ],
				[ 'log_id', 'user_name' ], $cond, __METHOD__ );

			$this->beginTransaction( $db, __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 ) {
				$db->update( 'logging', [ 'log_user_text' => $row->user_name ],
					[ 'log_id' => $row->log_id ], __METHOD__ );
			}
			$this->commitTransaction( $db, __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);
    }
}
			$blockStart += $this->mBatchSize;
			$blockEnd += $this->mBatchSize;
			wfWaitForSlaves();

		}
		$this->output( "Done populating log_user_text field.\n" );

		return true;
	}
}

$maintClass = "PopulateLogUsertext";
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			* Makes the required database updates for Special:ProtectedPages
4			* to show all protected pages, even ones before the page restrictions
5			* schema change. All remaining page_restriction column values are moved
6			* to the new table.
7			*
8			* This program is free software; you can redistribute it and/or modify
9			* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation; either version 2 of the License, or
11			* (at your option) any later version.
12			*
13			* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17			*
18			* You should have received a copy of the GNU General Public License along
19			* with this program; if not, write to the Free Software Foundation, Inc.,
20			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21			* http://www.gnu.org/copyleft/gpl.html
22			*
23			* @file
24			* @ingroup Maintenance
25			*/
26
27			require_once __DIR__ . '/Maintenance.php';
28
29			/**
30			* Maintenance script that makes the required database updates for
31			* Special:ProtectedPages to show all protected pages.
32			*
33			* @ingroup Maintenance
34			*/
35			class PopulateLogUsertext extends LoggedUpdateMaintenance {
36			public function __construct() {
37			parent::__construct();
38			$this->addDescription( 'Populates the log_user_text field' );
39			$this->setBatchSize( 100 );
40			}
41
42			protected function getUpdateKey() {
43			return 'populate log_usertext';
44			}
45
46			protected function updateSkippedMessage() {
47			return 'log_user_text column of logging table already populated.';
48			}
49
50			protected function doDBUpdates() {
51			$db = $this->getDB( DB_MASTER );
52			$start = $db->selectField( 'logging', 'MIN(log_id)', false, __METHOD__ );
53			if ( !$start ) {
54			$this->output( "Nothing to do.\n" );
55
56			return true;
57			}
58			$end = $db->selectField( 'logging', 'MAX(log_id)', false, __METHOD__ );
59
60			# Do remaining chunk
61			$end += $this->mBatchSize - 1;
62			$blockStart = $start;
63			$blockEnd = $start + $this->mBatchSize - 1;
64			while ( $blockEnd <= $end ) {
65			$this->output( "...doing log_id from $blockStart to $blockEnd\n" );
66			$cond = "log_id BETWEEN $blockStart AND $blockEnd AND log_user = user_id";
67			$res = $db->select( [ 'logging', 'user' ],
68			[ 'log_id', 'user_name' ], $cond, __METHOD__ );
69
70			$this->beginTransaction( $db, __METHOD__ );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$db` defined by `$this->getDB(DB_MASTER)` on line `51` 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...
71			foreach ( $res as $row ) {
72			$db->update( 'logging', [ 'log_user_text' => $row->user_name ],
73			[ 'log_id' => $row->log_id ], __METHOD__ );
74			}
75			$this->commitTransaction( $db, __METHOD__ );
			0 ignored issues – show Bug introduced 2016-09-24 18:22 UTC by Report Bug Copy Issue Report It seems like `$db` defined by `$this->getDB(DB_MASTER)` on line `51` 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...
76			$blockStart += $this->mBatchSize;
77			$blockEnd += $this->mBatchSize;
78			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...
79			}
80			$this->output( "Done populating log_user_text field.\n" );
81
82			return true;
83			}
84			}
85
86			$maintClass = "PopulateLogUsertext";
87			require_once RUN_MAINTENANCE_IF_MAIN;
88

wikimedia / mediawiki

PopulateLogUsertext::__construct() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

PopulateLogUsertext::__construct() A
last analyzed 2016-11-13 17:42 UTC