MediaWiki  master
deleteArchivedFiles.php
Go to the documentation of this file.
1 <?php
27 
28 require_once __DIR__ . '/Maintenance.php';
29 
36  public function __construct() {
37  parent::__construct();
38  $this->addDescription( 'Deletes all archived images.' );
39  $this->addOption( 'delete', 'Perform the deletion' );
40  $this->addOption( 'force', 'Force deletion of rows from filearchive' );
41  }
42 
43  public function execute() {
44  if ( !$this->hasOption( 'delete' ) ) {
45  $this->output( "Use --delete to actually confirm this script\n" );
46  return;
47  }
48 
49  # Data should come off the master, wrapped in a transaction
50  $dbw = $this->getDB( DB_MASTER );
51  $this->beginTransaction( $dbw, __METHOD__ );
52  $repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
53 
54  # Get "active" revisions from the filearchive table
55  $this->output( "Searching for and deleting archived files...\n" );
56  $res = $dbw->select(
57  'filearchive',
58  [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ],
59  '',
60  __METHOD__
61  );
62 
63  $count = 0;
64  foreach ( $res as $row ) {
65  $key = $row->fa_storage_key;
66  if ( !strlen( $key ) ) {
67  $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" );
68  continue;
69  }
70 
71  $file = $repo->newFile( $row->fa_name );
72  try {
73  $file->lock();
74  } catch ( LocalFileLockError $e ) {
75  $this->error( "Could not acquire lock on '{$row->fa_name}', skipping\n" );
76  continue;
77  }
78 
79  $group = $row->fa_storage_group;
80  $id = $row->fa_id;
81  $path = $repo->getZonePath( 'deleted' ) .
82  '/' . $repo->getDeletedHashPath( $key ) . $key;
83  if ( isset( $row->fa_sha1 ) ) {
84  $sha1 = $row->fa_sha1;
85  } else {
86  // old row, populate from key
87  $sha1 = LocalRepo::getHashFromKey( $key );
88  }
89 
90  // Check if the file is used anywhere...
91  $inuse = $dbw->selectField(
92  'oldimage',
93  '1',
94  [
95  'oi_sha1' => $sha1,
96  $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE
97  ],
98  __METHOD__,
99  [ 'FOR UPDATE' ]
100  );
101 
102  $needForce = true;
103  if ( !$repo->fileExists( $path ) ) {
104  $this->output( "Notice - file '$key' not found in group '$group'\n" );
105  } elseif ( $inuse ) {
106  $this->output( "Notice - file '$key' is still in use\n" );
107  } elseif ( !$repo->quickPurge( $path ) ) {
108  $this->output( "Unable to remove file $path, skipping\n" );
109  $file->unlock();
110 
111  // don't delete even with --force
112  continue;
113  } else {
114  $needForce = false;
115  }
116 
117  if ( $needForce ) {
118  if ( $this->hasOption( 'force' ) ) {
119  $this->output( "Got --force, deleting DB entry\n" );
120  } else {
121  $file->unlock();
122  continue;
123  }
124  }
125 
126  $count++;
127  $dbw->delete( 'filearchive', [ 'fa_id' => $id ], __METHOD__ );
128  $file->unlock();
129  }
130 
131  $this->commitTransaction( $dbw, __METHOD__ );
132  $this->output( "Done! [$count file(s)]\n" );
133  }
134 }
135 
136 $maintClass = DeleteArchivedFiles::class;
137 require_once RUN_MAINTENANCE_IF_MAIN;
RUN_MAINTENANCE_IF_MAIN
const RUN_MAINTENANCE_IF_MAIN
Definition: Maintenance.php:38
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:152
Maintenance\addDescription
addDescription( $text)
Set the description text.
Definition: Maintenance.php:323
DeleteArchivedFiles\execute
execute()
Do the actual work.
Definition: deleteArchivedFiles.php:43
$file
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42
DeleteArchivedFiles
Maintenance script to delete archived (non-current) files from the database.
Definition: deleteArchivedFiles.php:35
Maintenance
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:53
DeleteArchivedFiles\__construct
__construct()
Default constructor.
Definition: deleteArchivedFiles.php:36
$res
$res
Definition: testCompression.php:57
LocalRepo\getHashFromKey
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
Definition: LocalRepo.php:183
Maintenance\beginTransaction
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
Definition: Maintenance.php:1380
$maintClass
$maintClass
Definition: deleteArchivedFiles.php:136
Maintenance\addOption
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
Definition: Maintenance.php:241
DB_MASTER
const DB_MASTER
Definition: defines.php:26
LocalFileLockError
Definition: LocalFileLockError.php:24
Maintenance\commitTransaction
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
Definition: Maintenance.php:1395
Maintenance\getDB
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
Definition: Maintenance.php:1350
$path
$path
Definition: NoLocalSettings.php:25
Maintenance\error
error( $err, $die=0)
Throw an error to the user.
Definition: Maintenance.php:457
Maintenance\output
output( $out, $channel=null)
Throw some output to the user.
Definition: Maintenance.php:429
File\DELETED_FILE
const DELETED_FILE
Definition: File.php:66
Maintenance\hasOption
hasOption( $name)
Checks to see if a particular option exists.
Definition: Maintenance.php:262