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

120 lines
3.9 KiB
PHP

<?php
/**
* Deletes all pages in the MediaWiki namespace which were last edited by
* "MediaWiki default".
*
* 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
use MediaWiki\StubObject\StubGlobalUser;
use MediaWiki\Title\Title;
use MediaWiki\User\ActorMigration;
use MediaWiki\User\User;
/**
* Maintenance script that deletes all pages in the MediaWiki namespace
* which were last edited by "MediaWiki default".
*
* @ingroup Maintenance
*/
class DeleteDefaultMessages extends Maintenance {
public function __construct() {
parent::__construct();
$this->addDescription( 'Deletes all pages in the MediaWiki namespace' .
' which were last edited by "MediaWiki default"' );
$this->addOption( 'dry-run', 'Perform a dry run, delete nothing' );
}
public function execute() {
$services = $this->getServiceContainer();
$this->output( "Checking existence of old default messages..." );
$dbr = $this->getReplicaDB();
$userFactory = $services->getUserFactory();
$actorQuery = ActorMigration::newMigration()
->getWhere( $dbr, 'rev_user', $userFactory->newFromName( 'MediaWiki default' ) );
$res = $dbr->newSelectQueryBuilder()
->select( [ 'page_namespace', 'page_title' ] )
->from( 'page' )
->join( 'revision', null, 'page_latest=rev_id' )
->tables( $actorQuery['tables'] )
->where( [
'page_namespace' => NS_MEDIAWIKI,
$actorQuery['conds'],
] )
->joinConds( $actorQuery['joins'] )
->caller( __METHOD__ )
->fetchResultSet();
if ( $res->numRows() == 0 ) {
// No more messages left
$this->output( "done.\n" );
return;
}
$dryrun = $this->hasOption( 'dry-run' );
if ( $dryrun ) {
foreach ( $res as $row ) {
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
$this->output( "\n* [[$title]]" );
}
$this->output( "\n\nRun again without --dry-run to delete these pages.\n" );
return;
}
// Deletions will be made by $user temporarily added to the bot group
// in order to hide it in RecentChanges.
$user = User::newSystemUser( 'MediaWiki default', [ 'steal' => true ] );
if ( !$user ) {
$this->fatalError( "Invalid username" );
}
$userGroupManager = $services->getUserGroupManager();
$userGroupManager->addUserToGroup( $user, 'bot' );
StubGlobalUser::setUser( $user );
// Handle deletion
$this->output( "\n...deleting old default messages (this may take a long time!)...", 'msg' );
$dbw = $this->getPrimaryDB();
$wikiPageFactory = $services->getWikiPageFactory();
$delPageFactory = $services->getDeletePageFactory();
foreach ( $res as $row ) {
$this->waitForReplication();
$dbw->ping();
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
$page = $wikiPageFactory->newFromTitle( $title );
// FIXME: Deletion failures should be reported, not silently ignored.
$delPageFactory->newDeletePage( $page, $user )->deleteUnsafe( 'No longer required' );
}
$this->output( "done!\n", 'msg' );
}
}
// @codeCoverageIgnoreStart
$maintClass = DeleteDefaultMessages::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd