MediaWiki master
deleteArchivedFiles.php
Go to the documentation of this file.
1<?php
27
28// @codeCoverageIgnoreStart
29require_once __DIR__ . '/Maintenance.php';
30// @codeCoverageIgnoreEnd
31
38 public function __construct() {
39 parent::__construct();
40 $this->addDescription( 'Deletes all archived images.' );
41 $this->addOption( 'delete', 'Perform the deletion' );
42 $this->addOption( 'force', 'Force deletion of rows from filearchive' );
43 }
44
45 public function execute() {
46 if ( !$this->hasOption( 'delete' ) ) {
47 $this->output( "Use --delete to actually confirm this script\n" );
48 return;
49 }
50
51 # Data should come off the master, wrapped in a transaction
52 $dbw = $this->getPrimaryDB();
53 $this->beginTransaction( $dbw, __METHOD__ );
54 $repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo();
55
56 # Get "active" revisions from the filearchive table
57 $this->output( "Searching for and deleting archived files...\n" );
58 $res = $dbw->newSelectQueryBuilder()
59 ->select( [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ] )
60 ->from( 'filearchive' )
61 ->caller( __METHOD__ )
62 ->fetchResultSet();
63
64 $count = 0;
65 foreach ( $res as $row ) {
66 $key = $row->fa_storage_key;
67 if ( $key === '' ) {
68 $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" );
69 continue;
70 }
71
72 $file = $repo->newFile( $row->fa_name );
73 $status = $file->acquireFileLock( 10 );
74 if ( !$status->isOK() ) {
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 = (bool)$dbw->newSelectQueryBuilder()
92 ->select( '1' )
93 ->from( 'oldimage' )
94 ->where( [
95 'oi_sha1' => $sha1,
96 $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE
97 ] )
98 ->caller( __METHOD__ )
99 ->forUpdate()
100 ->fetchField();
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->releaseFileLock();
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->releaseFileLock();
122 continue;
123 }
124 }
125
126 $count++;
127 $dbw->newDeleteQueryBuilder()
128 ->deleteFrom( 'filearchive' )
129 ->where( [ 'fa_id' => $id ] )
130 ->caller( __METHOD__ )->execute();
131 $file->releaseFileLock();
132 }
133
134 $this->commitTransaction( $dbw, __METHOD__ );
135 $this->output( "Done! [$count file(s)]\n" );
136 }
137}
138
139// @codeCoverageIgnoreStart
140$maintClass = DeleteArchivedFiles::class;
141require_once RUN_MAINTENANCE_IF_MAIN;
142// @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...
output( $out, $channel=null)
Throw some output to the user.
commitTransaction(IDatabase $dbw, $fname)
Commit the transaction on a DB handle and wait for replica DB servers to catch up.
addOption( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
Add a parameter to the script.
hasOption( $name)
Checks to see if a particular option was set.
beginTransaction(IDatabase $dbw, $fname)
Begin a transaction on a DB handle.
error( $err, $die=0)
Throw an error to the user.
getServiceContainer()
Returns the main service container.
addDescription( $text)
Set the description text.