MediaWiki master
deleteArchivedFiles.php
Go to the documentation of this file.
1<?php
26// @codeCoverageIgnoreStart
27require_once __DIR__ . '/Maintenance.php';
28// @codeCoverageIgnoreEnd
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->getPrimaryDB();
51 $this->beginTransaction( $dbw, __METHOD__ );
52 $repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo();
53
54 # Get "active" revisions from the filearchive table
55 $this->output( "Searching for and deleting archived files...\n" );
56 $res = $dbw->newSelectQueryBuilder()
57 ->select( [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ] )
58 ->from( 'filearchive' )
59 ->caller( __METHOD__ )
60 ->fetchResultSet();
61
62 $count = 0;
63 foreach ( $res as $row ) {
64 $key = $row->fa_storage_key;
65 if ( !strlen( $key ) ) {
66 $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" );
67 continue;
68 }
69
70 $file = $repo->newFile( $row->fa_name );
71 $status = $file->acquireFileLock( 10 );
72 if ( !$status->isOK() ) {
73 $this->error( "Could not acquire lock on '{$row->fa_name}', skipping\n" );
74 continue;
75 }
76
77 $group = $row->fa_storage_group;
78 $id = $row->fa_id;
79 $path = $repo->getZonePath( 'deleted' ) .
80 '/' . $repo->getDeletedHashPath( $key ) . $key;
81 if ( isset( $row->fa_sha1 ) ) {
82 $sha1 = $row->fa_sha1;
83 } else {
84 // old row, populate from key
85 $sha1 = LocalRepo::getHashFromKey( $key );
86 }
87
88 // Check if the file is used anywhere...
89 $inuse = (bool)$dbw->newSelectQueryBuilder()
90 ->select( '1' )
91 ->from( 'oldimage' )
92 ->where( [
93 'oi_sha1' => $sha1,
94 $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE
95 ] )
96 ->caller( __METHOD__ )
97 ->forUpdate()
98 ->fetchField();
99
100 $needForce = true;
101 if ( !$repo->fileExists( $path ) ) {
102 $this->output( "Notice - file '$key' not found in group '$group'\n" );
103 } elseif ( $inuse ) {
104 $this->output( "Notice - file '$key' is still in use\n" );
105 } elseif ( !$repo->quickPurge( $path ) ) {
106 $this->output( "Unable to remove file $path, skipping\n" );
107 $file->releaseFileLock();
108
109 // don't delete even with --force
110 continue;
111 } else {
112 $needForce = false;
113 }
114
115 if ( $needForce ) {
116 if ( $this->hasOption( 'force' ) ) {
117 $this->output( "Got --force, deleting DB entry\n" );
118 } else {
119 $file->releaseFileLock();
120 continue;
121 }
122 }
123
124 $count++;
125 $dbw->newDeleteQueryBuilder()
126 ->deleteFrom( 'filearchive' )
127 ->where( [ 'fa_id' => $id ] )
128 ->caller( __METHOD__ )->execute();
129 $file->releaseFileLock();
130 }
131
132 $this->commitTransaction( $dbw, __METHOD__ );
133 $this->output( "Done! [$count file(s)]\n" );
134 }
135}
136
137// @codeCoverageIgnoreStart
138$maintClass = DeleteArchivedFiles::class;
139require_once RUN_MAINTENANCE_IF_MAIN;
140// @codeCoverageIgnoreEnd
Maintenance script to delete archived (non-current) files from the database.
__construct()
Default constructor.
execute()
Do the actual work.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
error( $err, $die=0)
Throw an error to the user.
beginTransaction(IDatabase $dbw, $fname)
Begin a transaction on a DB.
commitTransaction(IDatabase $dbw, $fname)
Commit the transaction on a DB handle and wait for replica DBs to catch up.
output( $out, $channel=null)
Throw some output to the user.
hasOption( $name)
Checks to see if a particular option was set.
getServiceContainer()
Returns the main service container.
addDescription( $text)
Set the description text.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.