wiki.techinc.nl/maintenance/deleteUserEmail.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

68 lines
2.1 KiB
PHP

<?php
/**
* Deletes a given user's associated email address
* Usage: php deleteUserEmail.php <user>
* where <user> can be either the username or user ID
*
* 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
* @author Samuel Guebo <sguebo@wikimedia.org>
* @see https://phabricator.wikimedia.org/T290099
* @ingroup Maintenance
*/
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
/**
*
* @since 1.38
* @author Samuel Guebo
*/
class DeleteUserEmail extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( "Delete a user's email" );
$this->addArg( 'user', 'Username or user ID, if starts with #', true );
}
public function execute() {
$userFactory = $this->getServiceContainer()->getUserFactory();
$userName = $this->getArg( 0 );
if ( preg_match( '/^#\d+$/', $userName ) ) {
$user = $userFactory->newFromId( (int)substr( $userName, 1 ) );
} else {
$user = $userFactory->newFromName( $userName );
}
// Checking whether User object is valid and has an actual id
if ( !$user || !$user->isRegistered() || !$user->loadFromId() ) {
$this->fatalError( "Error: user '$userName' could not be loaded" );
}
// Blank the email address
$user->invalidateEmail();
$user->saveSettings();
$this->output( "Done!\n" );
}
}
// @codeCoverageIgnoreStart
$maintClass = DeleteUserEmail::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd