MediaWiki  master
removeInvalidEmails.php
Go to the documentation of this file.
1 <?php
2 
3 require_once __DIR__ . '/Maintenance.php';
4 
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 
25  public function execute() {
26  $this->commit = $this->hasOption( 'commit' );
27  $dbr = $this->getDB( DB_REPLICA );
28  $dbw = $this->getDB( DB_MASTER );
29  $lastId = 0;
30  do {
31  $rows = $dbr->select(
32  'user',
33  [ 'user_id', 'user_email' ],
34  [
35  'user_id > ' . $dbr->addQuotes( $lastId ),
36  'user_email != ""',
37  'user_email_authenticated IS NULL'
38  ],
39  __METHOD__,
40  [ 'LIMIT' => $this->getBatchSize() ]
41  );
42  $count = $rows->numRows();
43  $badIds = [];
44  foreach ( $rows as $row ) {
45  if ( !Sanitizer::validateEmail( trim( $row->user_email ) ) ) {
46  $this->output( "Found bad email: {$row->user_email} for user #{$row->user_id}\n" );
47  $badIds[] = $row->user_id;
48  }
49  if ( $row->user_id > $lastId ) {
50  $lastId = $row->user_id;
51  }
52  }
53 
54  if ( $badIds ) {
55  $badCount = count( $badIds );
56  if ( $this->commit ) {
57  $this->output( "Removing $badCount emails from the database.\n" );
58  $dbw->update(
59  'user',
60  [ 'user_email' => '' ],
61  [ 'user_id' => $badIds ],
62  __METHOD__
63  );
64  foreach ( $badIds as $badId ) {
65  User::newFromId( $badId )->invalidateCache();
66  }
68  } else {
69  $this->output( "Would have removed $badCount emails from the database.\n" );
70 
71  }
72  }
73  } while ( $count !== 0 );
74  $this->output( "Done.\n" );
75  }
76 }
77 
78 $maintClass = RemoveInvalidEmails::class;
79 require_once RUN_MAINTENANCE_IF_MAIN;
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:39
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:86
setBatchSize( $s=0)
Set the batch size.
hasOption( $name)
Checks to see if a particular option exists.
const DB_MASTER
Definition: defines.php:26
static validateEmail( $addr)
Does a string look like an e-mail address?
Definition: Sanitizer.php:2165
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
output( $out, $channel=null)
Throw some output to the user.
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:560
getBatchSize()
Returns batch size.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
const DB_REPLICA
Definition: defines.php:25
A script to remove emails that are invalid from the user_email column of the user table...
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.