MediaWiki REL1_30
deleteArchivedFiles.php
Go to the documentation of this file.
1<?php
26require_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
133$maintClass = "DeleteArchivedFiles";
134require_once RUN_MAINTENANCE_IF_MAIN;
Maintenance script to delete archived (non-current) files from the database.
__construct()
Default constructor.
execute()
Do the actual work.
const DELETED_FILE
Definition File.php:53
static getHashFromKey( $key)
Gets the SHA1 hash from a storage key.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
beginTransaction(IDatabase $dbw, $fname)
Begin a transcation on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transcation on a DB handle and wait for replica DBs to catch up.
getDB( $db, $groups=[], $wiki=false)
Returns a database to be used by current maintenance script.
hasOption( $name)
Checks to see if a particular param exists.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
$res
Definition database.txt:21
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults error
Definition hooks.txt:2581
returning false will NOT prevent logging $e
Definition hooks.txt:2146
require_once RUN_MAINTENANCE_IF_MAIN
const DB_MASTER
Definition defines.php:26