maintenance: Make use of BatchRowIterator::setCaller
[mediawiki.git] / maintenance / deleteBatch.php
blobbb3addbd7e2ab021423122a6a88f53484848ad4a
1 <?php
2 /**
3 * Deletes a batch of pages.
4 * Usage: php deleteBatch.php [-u <user>] [-r <reason>] [-i <interval>] [listfile]
5 * where
6 * [listfile] is a file where each line contains the title of a page to be
7 * deleted, standard input is used if listfile is not given.
8 * <user> is the username
9 * <reason> is the delete reason
10 * <interval> is the number of seconds to sleep for after each delete
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 * http://www.gnu.org/copyleft/gpl.html
27 * @file
28 * @ingroup Maintenance
31 use MediaWiki\MediaWikiServices;
33 require_once __DIR__ . '/Maintenance.php';
35 /**
36 * Maintenance script to delete a batch of pages.
38 * @ingroup Maintenance
40 class DeleteBatch extends Maintenance {
42 public function __construct() {
43 parent::__construct();
44 $this->addDescription( 'Deletes a batch of pages' );
45 $this->addOption( 'u', "User to perform deletion", false, true );
46 $this->addOption( 'r', "Reason to delete page", false, true );
47 $this->addOption( 'i', "Interval to sleep between deletions" );
48 $this->addArg( 'listfile', 'File with titles to delete, separated by newlines. ' .
49 'If not given, stdin will be used.', false );
52 public function execute() {
53 global $wgUser;
55 # Change to current working directory
56 $oldCwd = getcwd();
57 chdir( $oldCwd );
59 # Options processing
60 $username = $this->getOption( 'u', false );
61 $reason = $this->getOption( 'r', '' );
62 $interval = $this->getOption( 'i', 0 );
64 if ( $username === false ) {
65 $user = User::newSystemUser( 'Delete page script', [ 'steal' => true ] );
66 } else {
67 $user = User::newFromName( $username );
69 if ( !$user ) {
70 $this->fatalError( "Invalid username" );
72 $wgUser = $user;
74 if ( $this->hasArg( 0 ) ) {
75 $file = fopen( $this->getArg( 0 ), 'r' );
76 } else {
77 $file = $this->getStdin();
80 # Setup
81 if ( !$file ) {
82 $this->fatalError( "Unable to read file, exiting" );
85 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
87 # Handle each entry
88 for ( $linenum = 1; !feof( $file ); $linenum++ ) {
89 $line = trim( fgets( $file ) );
90 if ( $line == '' ) {
91 continue;
93 $title = Title::newFromText( $line );
94 if ( $title === null ) {
95 $this->output( "Invalid title '$line' on line $linenum\n" );
96 continue;
98 if ( !$title->exists() ) {
99 $this->output( "Skipping nonexistent page '$line'\n" );
100 continue;
103 $this->output( $title->getPrefixedText() );
104 if ( $title->getNamespace() === NS_FILE ) {
105 $img = MediaWikiServices::getInstance()->getRepoGroup()->findFile(
106 $title, [ 'ignoreRedirect' => true ]
108 if ( $img && $img->isLocal() && !$img->deleteFile( $reason, $user ) ) {
109 $this->output( " FAILED to delete associated file... " );
112 $page = WikiPage::factory( $title );
113 $error = '';
114 $status = $page->doDeleteArticleReal(
115 $reason,
116 $user,
117 false,
118 null,
119 $error,
120 null,
122 'delete',
123 true
125 if ( $status->isOK() ) {
126 $this->output( " Deleted!\n" );
127 } else {
128 $this->output( " FAILED to delete article\n" );
131 if ( $interval ) {
132 sleep( $interval );
134 $lbFactory->waitForReplication();
139 $maintClass = DeleteBatch::class;
140 require_once RUN_MAINTENANCE_IF_MAIN;