RemoveInvalidEmails::execute()   C
last analyzed

Complexity

Conditions 8
Paths 15

Size

Total Lines 51
Code Lines 38

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 8
eloc 38
nc 15
nop 0
dl 0
loc 51
rs 6.5978
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
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 15 and the first side effect is on line 3.

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
require_once __DIR__ . '/Maintenance.php';
4
5
/**
6
 * A script to remove emails that are invalid from
7
 * the user_email column of the user table. Emails
8
 * are validated before users can add them, but
9
 * this was not always the case so older users may
10
 * have invalid ones.
11
 *
12
 * By default it does a dry-run, pass --commit
13
 * to actually update the database.
14
 */
15
class RemoveInvalidEmails extends Maintenance {
16
17
	private $commit = false;
18
19
	public function __construct() {
20
		parent::__construct();
21
		$this->addOption( 'commit', 'Whether to actually update the database', false, false );
22
		$this->setBatchSize( 500 );
23
	}
24
	public function execute() {
25
		$this->commit = $this->hasOption( 'commit' );
26
		$dbr = $this->getDB( DB_REPLICA );
27
		$dbw = $this->getDB( DB_MASTER );
28
		$lastId = 0;
29
		do {
30
			$rows = $dbr->select(
31
				'user',
32
				[ 'user_id', 'user_email' ],
33
				[
34
					'user_id > ' . $dbr->addQuotes( $lastId ),
35
					'user_email != ""',
36
					'user_email_authenticated IS NULL'
37
				],
38
				__METHOD__,
39
				[ 'LIMIT' => $this->mBatchSize ]
40
			);
41
			$count = $rows->numRows();
42
			$badIds = [];
43
			foreach ( $rows as $row ) {
44
				if ( !Sanitizer::validateEmail( trim( $row->user_email ) ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Sanitizer::validateEmail(trim($row->user_email)) of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
45
					$this->output( "Found bad email: {$row->user_email} for user #{$row->user_id}\n" );
46
					$badIds[] = $row->user_id;
47
				}
48
				if ( $row->user_id > $lastId ) {
49
					$lastId = $row->user_id;
50
				}
51
			}
52
53
			if ( $badIds ) {
54
				$badCount = count( $badIds );
55
				if ( $this->commit ) {
56
					$this->output( "Removing $badCount emails from the database.\n" );
57
					$dbw->update(
58
						'user',
59
						[ 'user_email' => '' ],
60
						[ 'user_id' => $badIds ],
61
						__METHOD__
62
					);
63
					foreach ( $badIds as $badId ) {
64
						User::newFromId( $badId )->invalidateCache();
65
					}
66
					wfWaitForSlaves();
0 ignored issues
show
Deprecated Code introduced by
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
				} else {
68
					$this->output( "Would have removed $badCount emails from the database.\n" );
69
70
				}
71
			}
72
		} while ( $count !== 0 );
73
		$this->output( "Done.\n" );
74
	}
75
}
76
77
$maintClass = 'RemoveInvalidEmails';
78
require_once RUN_MAINTENANCE_IF_MAIN;
79