e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
74 lines
2.3 KiB
PHP
74 lines
2.3 KiB
PHP
<?php
|
|
/**
|
|
* Check that database usernames are actually valid.
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Maintenance script to check that database usernames are actually valid.
|
|
*
|
|
* An existing usernames can become invalid if UserNameUtils::isValid()
|
|
* is altered or if we change the $wgMaxNameChars
|
|
*
|
|
* @ingroup Maintenance
|
|
*/
|
|
class CheckUsernames extends Maintenance {
|
|
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Verify that database usernames are actually valid' );
|
|
$this->setBatchSize( 1000 );
|
|
}
|
|
|
|
public function execute() {
|
|
$dbr = $this->getReplicaDB();
|
|
$userNameUtils = $this->getServiceContainer()->getUserNameUtils();
|
|
|
|
$maxUserId = 0;
|
|
do {
|
|
$res = $dbr->newSelectQueryBuilder()
|
|
->select( [ 'user_id', 'user_name' ] )
|
|
->from( 'user' )
|
|
->where( $dbr->expr( 'user_id', '>', $maxUserId ) )
|
|
->orderBy( 'user_id' )
|
|
->limit( $this->getBatchSize() )
|
|
->caller( __METHOD__ )
|
|
->fetchResultSet();
|
|
|
|
foreach ( $res as $row ) {
|
|
if ( !$userNameUtils->isValid( $row->user_name ) ) {
|
|
$this->output( sprintf( "Found: %6d: '%s'\n", $row->user_id, $row->user_name ) );
|
|
wfDebugLog( 'checkUsernames', $row->user_name );
|
|
}
|
|
}
|
|
// @phan-suppress-next-line PhanPossiblyUndeclaredVariable $res has at at least one item
|
|
$maxUserId = $row->user_id;
|
|
} while ( $res->numRows() );
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = CheckUsernames::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|