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

ConvertUserOptions::execute() B
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ConvertUserOptions

Complexity

Conditions	4
Paths	4

Size

Total Lines	33
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	20
nc	4
nop	0
dl	0
loc	33
rs	8.5806
c	0
b	0
f	0

<?php

/**
 * Convert user options to the new `user_properties` 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 convert user options to the new `user_properties` table.
 *
 * @ingroup Maintenance
 */
class ConvertUserOptions extends Maintenance {

	private $mConversionCount = 0;

	public function __construct() {
		parent::__construct();
		$this->addDescription( 'Convert user options from old to new system' );
		$this->setBatchSize( 50 );
	}

	public function execute() {
		$this->output( "...batch conversion of user_options: " );
		$id = 0;
		$dbw = $this->getDB( DB_MASTER );

		if ( !$dbw->fieldExists( 'user', 'user_options', __METHOD__ ) ) {
			$this->output( "nothing to migrate. " );

			return;
		}
		while ( $id !== null ) {
			$res = $dbw->select( 'user',
				[ 'user_id', 'user_options' ],
				[
					'user_id > ' . $dbw->addQuotes( $id ),
					"user_options != " . $dbw->addQuotes( '' ),
				],
				__METHOD__,
				[
					'ORDER BY' => 'user_id',
					'LIMIT' => $this->mBatchSize,
				]
			);
			$id = $this->convertOptionBatch( $res, $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);
    }
}

			wfWaitForSlaves();


			if ( $id ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				$this->output( "--Converted to ID $id\n" );
			}
		}
		$this->output( "done. Converted " . $this->mConversionCount . " user records.\n" );
	}

	/**
	 * @param ResultWrapper $res
	 * @param Database $dbw
	 * @return null|int
	 */
	function convertOptionBatch( $res, $dbw ) {
		$id = null;
		foreach ( $res as $row ) {
			$this->mConversionCount++;
			$insertRows = [];
			foreach ( explode( "\n", $row->user_options ) as $s ) {
				$m = [];
				if ( !preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
					continue;
				}

				// MW < 1.16 would save even default values. Filter them out
				// here (as in User) to avoid adding many unnecessary rows.
				$defaultOption = User::getDefaultOption( $m[1] );
				if ( is_null( $defaultOption ) || $m[2] != $defaultOption ) {
					$insertRows[] = [
						'up_user' => $row->user_id,
						'up_property' => $m[1],
						'up_value' => $m[2],
					];
				}
			}

			if ( count( $insertRows ) ) {
				$dbw->insert( 'user_properties', $insertRows, __METHOD__, [ 'IGNORE' ] );
			}

			$dbw->update(
				'user',
				[ 'user_options' => '' ],
				[ 'user_id' => $row->user_id ],
				__METHOD__
			);
			$id = $row->user_id;
		}

		return $id;
	}
}

$maintClass = "ConvertUserOptions";
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 31 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			* Convert user options to the new `user_properties` 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 convert user options to the new `user_properties` table.
28			*
29			* @ingroup Maintenance
30			*/
31			class ConvertUserOptions extends Maintenance {
32
33			private $mConversionCount = 0;
34
35			public function __construct() {
36			parent::__construct();
37			$this->addDescription( 'Convert user options from old to new system' );
38			$this->setBatchSize( 50 );
39			}
40
41			public function execute() {
42			$this->output( "...batch conversion of user_options: " );
43			$id = 0;
44			$dbw = $this->getDB( DB_MASTER );
45
46			if ( !$dbw->fieldExists( 'user', 'user_options', __METHOD__ ) ) {
47			$this->output( "nothing to migrate. " );
48
49			return;
50			}
51			while ( $id !== null ) {
52			$res = $dbw->select( 'user',
53			[ 'user_id', 'user_options' ],
54			[
55			'user_id > ' . $dbw->addQuotes( $id ),
56			"user_options != " . $dbw->addQuotes( '' ),
57			],
58			__METHOD__,
59			[
60			'ORDER BY' => 'user_id',
61			'LIMIT' => $this->mBatchSize,
62			]
63			);
64			$id = $this->convertOptionBatch( $res, $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 `44` can be `null`; however, `ConvertUserOptions::convertOptionBatch()` 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...
65
66			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...
67
68			if ( $id ) {
			0 ignored issues – show Bug Best Practice introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report The expression `$id` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
69			$this->output( "--Converted to ID $id\n" );
70			}
71			}
72			$this->output( "done. Converted " . $this->mConversionCount . " user records.\n" );
73			}
74
75			/**
76			* @param ResultWrapper $res
77			* @param Database $dbw
78			* @return null\|int
79			*/
80			function convertOptionBatch( $res, $dbw ) {
81			$id = null;
82			foreach ( $res as $row ) {
83			$this->mConversionCount++;
84			$insertRows = [];
85			foreach ( explode( "\n", $row->user_options ) as $s ) {
86			$m = [];
87			if ( !preg_match( "/^(.[^=])=(.)$/", $s, $m ) ) {
88			continue;
89			}
90
91			// MW < 1.16 would save even default values. Filter them out
92			// here (as in User) to avoid adding many unnecessary rows.
93			$defaultOption = User::getDefaultOption( $m[1] );
94			if ( is_null( $defaultOption ) \|\| $m[2] != $defaultOption ) {
95			$insertRows[] = [
96			'up_user' => $row->user_id,
97			'up_property' => $m[1],
98			'up_value' => $m[2],
99			];
100			}
101			}
102
103			if ( count( $insertRows ) ) {
104			$dbw->insert( 'user_properties', $insertRows, __METHOD__, [ 'IGNORE' ] );
105			}
106
107			$dbw->update(
108			'user',
109			[ 'user_options' => '' ],
110			[ 'user_id' => $row->user_id ],
111			__METHOD__
112			);
113			$id = $row->user_id;
114			}
115
116			return $id;
117			}
118			}
119
120			$maintClass = "ConvertUserOptions";
121			require_once RUN_MAINTENANCE_IF_MAIN;
122

wikimedia / mediawiki

ConvertUserOptions::execute() B last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ConvertUserOptions::execute() B
last analyzed 2016-11-13 17:42 UTC