wiki.techinc.nl/maintenance/CheckSignatures.php
Dreamy Jazz e7393b3cc7 Exclude boilerplate maintenance code from code coverage reports
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
2024-08-27 13:22:29 +01:00

84 lines
2.8 KiB
PHP

<?php
/**
* 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
*/
/**
* Maintenance script to list users with invalid signatures.
*
* @ingroup Maintenance
*/
class CheckSignatures extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'List users with invalid signatures' );
$this->setBatchSize( 1000 );
}
public function execute() {
$dbr = $this->getReplicaDB();
$userFactory = $this->getServiceContainer()->getUserIdentityLookup();
$userOptions = $this->getServiceContainer()->getUserOptionsLookup();
$signatureValidatorFactory = $this->getServiceContainer()->getSignatureValidatorFactory();
$contentLanguage = $this->getServiceContainer()->getContentLanguage();
$count = 0;
$maxUserId = 0;
do {
// List users who may have a signature that needs validation
$res = $dbr->newSelectQueryBuilder()
->from( 'user_properties' )
->select( 'up_user' )
->where( [ 'up_property' => 'fancysig' ] )
->andWhere( $dbr->expr( 'up_user', '>', $maxUserId ) )
->orderBy( [ 'up_property', 'up_user' ] )
->limit( $this->getBatchSize() )
->caller( __METHOD__ )
->fetchResultSet();
foreach ( $res as $row ) {
// Double-check effective preferences and check validation
$user = $userFactory->getUserIdentityByUserId( $row->up_user );
if ( !$user ) {
continue;
}
$signature = $userOptions->getOption( $user, 'nickname' );
$useFancySig = $userOptions->getBoolOption( $user, 'fancysig' );
if ( $useFancySig && $signature !== '' ) {
$parserOpts = new ParserOptions( $user, $contentLanguage );
$validator = $signatureValidatorFactory->newSignatureValidator( $user, null, $parserOpts );
$signatureErrors = $validator->validateSignature( $signature );
if ( $signatureErrors ) {
$count++;
$this->output( $user->getName() . "\n" );
}
}
$maxUserId = $row->up_user;
}
} while ( $res->numRows() );
$this->output( "-- $count invalid signatures --\n" );
}
}
// @codeCoverageIgnoreStart
$maintClass = CheckSignatures::class;
// @codeCoverageIgnoreEnd