MediaWiki  REL1_31
deleteArchivedFiles.php
Go to the documentation of this file.
1 <?php
26 require_once __DIR__ . '/Maintenance.php';
27 
34  public function __construct() {
35  parent::__construct();
36  $this->addDescription( 'Deletes all archived images.' );
37  $this->addOption( 'delete', 'Perform the deletion' );
38  $this->addOption( 'force', 'Force deletion of rows from filearchive' );
39  }
40 
41  public function execute() {
42  if ( !$this->hasOption( 'delete' ) ) {
43  $this->output( "Use --delete to actually confirm this script\n" );
44  return;
45  }
46 
47  # Data should come off the master, wrapped in a transaction
48  $dbw = $this->getDB( DB_MASTER );
49  $this->beginTransaction( $dbw, __METHOD__ );
50  $repo = RepoGroup::singleton()->getLocalRepo();
51 
52  # Get "active" revisions from the filearchive table
53  $this->output( "Searching for and deleting archived files...\n" );
54  $res = $dbw->select(
55  'filearchive',
56  [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ],
57  '',
58  __METHOD__
59  );
60 
61  $count = 0;
62  foreach ( $res as $row ) {
63  $key = $row->fa_storage_key;
64  if ( !strlen( $key ) ) {
65  $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" );
66  continue;
67  }
68 
70  $file = $repo->newFile( $row->fa_name );
71  try {
72  $file->lock();
73  } catch ( LocalFileLockError $e ) {
74  $this->error( "Could not acquire lock on '{$row->fa_name}', skipping\n" );
75  continue;
76  }
77 
78  $group = $row->fa_storage_group;
79  $id = $row->fa_id;
80  $path = $repo->getZonePath( 'deleted' ) .
81  '/' . $repo->getDeletedHashPath( $key ) . $key;
82  if ( isset( $row->fa_sha1 ) ) {
83  $sha1 = $row->fa_sha1;
84  } else {
85  // old row, populate from key
86  $sha1 = LocalRepo::getHashFromKey( $key );
87  }
88 
89  // Check if the file is used anywhere...
90  $inuse = $dbw->selectField(
91  'oldimage',
92  '1',
93  [
94  'oi_sha1' => $sha1,
95  $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE
96  ],
97  __METHOD__,
98  [ 'FOR UPDATE' ]
99  );
100 
101  $needForce = true;
102  if ( !$repo->fileExists( $path ) ) {
103  $this->output( "Notice - file '$key' not found in group '$group'\n" );
104  } elseif ( $inuse ) {
105  $this->output( "Notice - file '$key' is still in use\n" );
106  } elseif ( !$repo->quickPurge( $path ) ) {
107  $this->output( "Unable to remove file $path, skipping\n" );
108  $file->unlock();
109  continue; // don't delete even with --force
110  } else {
111  $needForce = false;
112  }
113 
114  if ( $needForce ) {
115  if ( $this->hasOption( 'force' ) ) {
116  $this->output( "Got --force, deleting DB entry\n" );
117  } else {
118  $file->unlock();
119  continue;
120  }
121  }
122 
123  $count++;
124  $dbw->delete( 'filearchive', [ 'fa_id' => $id ], __METHOD__ );
125  $file->unlock();
126  }
127 
128  $this->commitTransaction( $dbw, __METHOD__ );
129  $this->output( "Done! [$count file(s)]\n" );
130  }
131 }
132 
134 require_once RUN_MAINTENANCE_IF_MAIN;
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:291
DeleteArchivedFiles\execute
execute()
Do the actual work.
Definition: deleteArchivedFiles.php:41
RUN_MAINTENANCE_IF_MAIN
require_once RUN_MAINTENANCE_IF_MAIN
Definition: maintenance.txt:50
DeleteArchivedFiles
Maintenance script to delete archived (non-current) files from the database.
Definition: deleteArchivedFiles.php:33
$res
$res
Definition: database.txt:21
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: maintenance.txt:39
DeleteArchivedFiles\__construct
__construct()
Default constructor.
Definition: deleteArchivedFiles.php:34
LocalRepo\getHashFromKey
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:181
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
Maintenance\beginTransaction
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
Definition: Maintenance.php:1336
$maintClass
$maintClass
Definition: deleteArchivedFiles.php:133
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:219
DB_MASTER
const DB_MASTER
Definition: defines.php:29
LocalFileLockError
Definition: LocalFile.php:3493
Maintenance\commitTransaction
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
Definition: Maintenance.php:1351
$path
$path
Definition: NoLocalSettings.php:25
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
Maintenance\getDB
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1309
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:416
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:388
File\DELETED_FILE
const DELETED_FILE
Definition: File.php:53
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\hasOption
hasOption( $name)
Checks to see if a particular param exists.
Definition: Maintenance.php:240
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171