MediaWiki  1.30.0
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->error( "Invalid username", true );
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->error( "Unable to read file, exiting", true );
81  }
82 
83  $dbw = $this->getDB( DB_MASTER );
84 
85  # Handle each entry
86  // @codingStandardsIgnoreStart Ignore Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
87  for ( $linenum = 1; !feof( $file ); $linenum++ ) {
88  // @codingStandardsIgnoreEnd
89  $line = trim( fgets( $file ) );
90  if ( $line == '' ) {
91  continue;
92  }
94  if ( is_null( $title ) ) {
95  $this->output( "Invalid title '$line' on line $linenum\n" );
96  continue;
97  }
98  if ( !$title->exists() ) {
99  $this->output( "Skipping nonexistent page '$line'\n" );
100  continue;
101  }
102 
103  $this->output( $title->getPrefixedText() );
104  if ( $title->getNamespace() == NS_FILE ) {
105  $img = wfFindFile( $title, [ 'ignoreRedirect' => true ] );
106  if ( $img && $img->isLocal() && !$img->delete( $reason ) ) {
107  $this->output( " FAILED to delete associated file... " );
108  }
109  }
110  $page = WikiPage::factory( $title );
111  $error = '';
112  $success = $page->doDeleteArticle( $reason, false, 0, true, $error, $user );
113  if ( $success ) {
114  $this->output( " Deleted!\n" );
115  } else {
116  $this->output( " FAILED to delete article\n" );
117  }
118 
119  if ( $interval ) {
120  sleep( $interval );
121  }
122  wfWaitForSlaves();
123  }
124  }
125 }
126 
127 $maintClass = "DeleteBatch";
128 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:244
$wgUser
$wgUser
Definition: Setup.php:809
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:268
Maintenance\getStdin
getStdin( $len=null)
Return input from stdin.
Definition: Maintenance.php:346
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:287
NS_FILE
const NS_FILE
Definition: Defines.php:71
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:550
Maintenance\hasArg
hasArg( $argId=0)
Does a given argument exist?
Definition: Maintenance.php:296
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:44
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:3010
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:35
User\newSystemUser
static newSystemUser( $name, $options=[])
Static factory method for creation of a "system" user from username.
Definition: User.php:678
DeleteBatch\__construct
__construct()
Default constructor.
Definition: deleteBatch.php:40
DeleteBatch
Maintenance script to delete a batch of pages.
Definition: deleteBatch.php:38
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:932
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:121
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:215
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
DB_MASTER
const DB_MASTER
Definition: defines.php:26
$line
$line
Definition: cdb.php:58
$maintClass
$maintClass
Definition: deleteBatch.php:127
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2897
Maintenance\getOption
getOption( $name, $default=null)
Get an option, or return the default.
Definition: Maintenance.php:250
Maintenance\addArg
addArg( $arg, $description, $required=true)
Add some args that are needed.
Definition: Maintenance.php:267
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1251
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:392
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:373
Maintenance\getArg
getArg( $argId=0, $default=null)
Get an argument.
Definition: Maintenance.php:306
$username
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:781