Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00% covered (success)
100.00%
20 / 20
100.00% covered (success)
100.00%
2 / 2
CRAP
100.00% covered (success)
100.00%
1 / 1
CheckUsernames
100.00% covered (success)
100.00%
20 / 20
100.00% covered (success)
100.00%
2 / 2
4
100.00% covered (success)
100.00%
1 / 1
 __construct
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 execute
100.00% covered (success)
100.00%
17 / 17
100.00% covered (success)
100.00%
1 / 1
3
1<?php
2/**
3 * Check that database usernames are actually valid.
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
24use MediaWiki\Maintenance\Maintenance;
25
26// @codeCoverageIgnoreStart
27require_once __DIR__ . '/Maintenance.php';
28// @codeCoverageIgnoreEnd
29
30/**
31 * Maintenance script to check that database usernames are actually valid.
32 *
33 * An existing usernames can become invalid if UserNameUtils::isValid()
34 * is altered or if we change the $wgMaxNameChars
35 *
36 * @ingroup Maintenance
37 */
38class CheckUsernames extends Maintenance {
39
40    public function __construct() {
41        parent::__construct();
42        $this->addDescription( 'Verify that database usernames are actually valid' );
43        $this->setBatchSize( 1000 );
44    }
45
46    public function execute() {
47        $dbr = $this->getReplicaDB();
48        $userNameUtils = $this->getServiceContainer()->getUserNameUtils();
49
50        $maxUserId = 0;
51        do {
52            $res = $dbr->newSelectQueryBuilder()
53                ->select( [ 'user_id', 'user_name' ] )
54                ->from( 'user' )
55                ->where( $dbr->expr( 'user_id', '>', $maxUserId ) )
56                ->orderBy( 'user_id' )
57                ->limit( $this->getBatchSize() )
58                ->caller( __METHOD__ )
59                ->fetchResultSet();
60
61            foreach ( $res as $row ) {
62                if ( !$userNameUtils->isValid( $row->user_name ) ) {
63                    $this->output( sprintf( "Found: %6d: '%s'\n", $row->user_id, $row->user_name ) );
64                    wfDebugLog( 'checkUsernames', $row->user_name );
65                }
66            }
67            // @phan-suppress-next-line PhanPossiblyUndeclaredVariable $res has at at least one item
68            $maxUserId = $row->user_id;
69        } while ( $res->numRows() );
70    }
71}
72
73// @codeCoverageIgnoreStart
74$maintClass = CheckUsernames::class;
75require_once RUN_MAINTENANCE_IF_MAIN;
76// @codeCoverageIgnoreEnd