MediaWiki  REL1_31
deleteBatch.php
Go to the documentation of this file.
1 <?php
31 require_once __DIR__ . '/Maintenance.php';
32 
38 class DeleteBatch extends Maintenance {
39 
40  public function __construct() {
41  parent::__construct();
42  $this->addDescription( 'Deletes a batch of pages' );
43  $this->addOption( 'u', "User to perform deletion", false, true );
44  $this->addOption( 'r', "Reason to delete page", false, true );
45  $this->addOption( 'i', "Interval to sleep between deletions" );
46  $this->addArg( 'listfile', 'File with titles to delete, separated by newlines. ' .
47  'If not given, stdin will be used.', false );
48  }
49 
50  public function execute() {
52 
53  # Change to current working directory
54  $oldCwd = getcwd();
55  chdir( $oldCwd );
56 
57  # Options processing
58  $username = $this->getOption( 'u', false );
59  $reason = $this->getOption( 'r', '' );
60  $interval = $this->getOption( 'i', 0 );
61 
62  if ( $username === false ) {
63  $user = User::newSystemUser( 'Delete page script', [ 'steal' => true ] );
64  } else {
66  }
67  if ( !$user ) {
68  $this->fatalError( "Invalid username" );
69  }
70  $wgUser = $user;
71 
72  if ( $this->hasArg() ) {
73  $file = fopen( $this->getArg(), 'r' );
74  } else {
75  $file = $this->getStdin();
76  }
77 
78  # Setup
79  if ( !$file ) {
80  $this->fatalError( "Unable to read file, exiting" );
81  }
82 
83  $dbw = $this->getDB( DB_MASTER );
84 
85  # Handle each entry
86  // phpcs:ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall
87  for ( $linenum = 1; !feof( $file ); $linenum++ ) {
88  $line = trim( fgets( $file ) );
89  if ( $line == '' ) {
90  continue;
91  }
93  if ( is_null( $title ) ) {
94  $this->output( "Invalid title '$line' on line $linenum\n" );
95  continue;
96  }
97  if ( !$title->exists() ) {
98  $this->output( "Skipping nonexistent page '$line'\n" );
99  continue;
100  }
101 
102  $this->output( $title->getPrefixedText() );
103  if ( $title->getNamespace() == NS_FILE ) {
104  $img = wfFindFile( $title, [ 'ignoreRedirect' => true ] );
105  if ( $img && $img->isLocal() && !$img->delete( $reason ) ) {
106  $this->output( " FAILED to delete associated file... " );
107  }
108  }
109  $page = WikiPage::factory( $title );
110  $error = '';
111  $success = $page->doDeleteArticle( $reason, false, 0, true, $error, $user );
112  if ( $success ) {
113  $this->output( " Deleted!\n" );
114  } else {
115  $this->output( " FAILED to delete article\n" );
116  }
117 
118  if ( $interval ) {
119  sleep( $interval );
120  }
121  wfWaitForSlaves();
122  }
123  }
124 }
125 
127 require_once RUN_MAINTENANCE_IF_MAIN;
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
$wgUser
$wgUser
Definition: Setup.php:902
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:273
Maintenance\getStdin
getStdin( $len=null)
Return input from stdin.
Definition: Maintenance.php:361
Maintenance\fatalError
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Definition: Maintenance.php:439
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
NS_FILE
const NS_FILE
Definition: Defines.php:80
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
User\newFromName
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:591
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition: Maintenance.php:300
DeleteBatch\execute
execute()
Do the actual work.
Definition: deleteBatch.php:50
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
$success
$success
Definition: NoLocalSettings.php:42
wfWaitForSlaves
wfWaitForSlaves( $ifWritesSince=null, $wiki=false, $cluster=false, $timeout=null)
Waits for the replica DBs to catch up to the master position.
Definition: GlobalFunctions.php:2966
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
User\newSystemUser
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:791
DeleteBatch\__construct
__construct()
Default constructor.
Definition: deleteBatch.php:40
DeleteBatch
Maintenance script to delete a batch of pages.
Definition: deleteBatch.php:38
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
DB_MASTER
const DB_MASTER
Definition: defines.php:26
$line
$line
Definition: cdb.php:59
$maintClass
$maintClass
Definition: deleteBatch.php:126
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2853
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:254
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:271
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:310