MediaWiki  master
eraseArchivedFile.php
Go to the documentation of this file.
1 <?php
26 
27 require_once __DIR__ . '/Maintenance.php';
28 
38  public function __construct() {
39  parent::__construct();
40  $this->addDescription( 'Erases traces of deleted files.' );
41  $this->addOption( 'delete', 'Perform the deletion' );
42  $this->addOption( 'filename', 'File name', false, true );
43  $this->addOption( 'filekey', 'File storage key (with extension) or "*"', true, true );
44  }
45 
46  public function execute() {
47  if ( !$this->hasOption( 'delete' ) ) {
48  $this->output( "Use --delete to actually confirm this script\n" );
49  }
50 
51  $filekey = $this->getOption( 'filekey' );
52  $filename = $this->getOption( 'filename' );
53 
54  if ( $filekey === '*' ) {
55  // all versions by name
56  if ( !strlen( $filename ) ) {
57  $this->fatalError( "Missing --filename parameter." );
58  }
59  $afile = false;
60  } else {
61  // specified version
62  $dbw = $this->getDB( DB_PRIMARY );
63  $queryBuilder = FileSelectQueryBuilder::newForArchivedFile( $dbw );
64  $queryBuilder->where( [ 'fa_storage_group' => 'deleted', 'fa_storage_key' => $filekey ] );
65  $row = $queryBuilder->caller( __METHOD__ )->fetchRow();
66 
67  if ( !$row ) {
68  $this->fatalError( "No deleted file exists with key '$filekey'." );
69  }
70  $filename = $row->fa_name;
71  $afile = ArchivedFile::newFromRow( $row );
72  }
73 
74  $file = $this->getServiceContainer()->getRepoGroup()->getLocalRepo()->newFile( $filename );
75  if ( $file->exists() ) {
76  $this->fatalError( "File '$filename' is still a public file, use the delete form.\n" );
77  }
78 
79  $this->output( "Purging all thumbnails for file '$filename'..." );
80  $file->purgeCache();
81  $this->output( "done.\n" );
82 
83  if ( $afile instanceof ArchivedFile ) {
84  $this->scrubVersion( $afile );
85  } else {
86  $this->output( "Finding deleted versions of file '$filename'...\n" );
87  $this->scrubAllVersions( $filename );
88  $this->output( "Done\n" );
89  }
90  }
91 
92  protected function scrubAllVersions( $name ) {
93  $dbw = $this->getDB( DB_PRIMARY );
94  $queryBuilder = FileSelectQueryBuilder::newForArchivedFile( $dbw );
95  $queryBuilder->where( [ 'fa_name' => $name, 'fa_storage_group' => 'deleted' ] );
96  $res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
97  foreach ( $res as $row ) {
98  $this->scrubVersion( ArchivedFile::newFromRow( $row ) );
99  }
100  }
101 
102  protected function scrubVersion( ArchivedFile $archivedFile ) {
103  $key = $archivedFile->getStorageKey();
104  $name = $archivedFile->getName();
105  $ts = $archivedFile->getTimestamp();
106  $repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo();
107  $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
108  if ( $this->hasOption( 'delete' ) ) {
109  $status = $repo->getBackend()->delete( [ 'src' => $path ] );
110  if ( $status->isOK() ) {
111  $this->output( "Deleted version '$key' ($ts) of file '$name'\n" );
112  } else {
113  $this->output( "Failed to delete version '$key' ($ts) of file '$name'\n" );
114  $this->output( print_r( Status::wrap( $status )->getErrorsArray(), true ) );
115  }
116  } else {
117  $this->output( "Would delete version '{$key}' ({$ts}) of file '$name'\n" );
118  }
119  }
120 }
121 
122 $maintClass = EraseArchivedFile::class;
123 require_once RUN_MAINTENANCE_IF_MAIN;
Deleted file in the 'filearchive' table.
getTimestamp()
Return upload timestamp.
static newFromRow( $row)
Loads a file object from the filearchive table.
getStorageKey()
Return the FileStore key (overriding base File class)
getName()
Return the file name.
Maintenance script to delete archived (non-current) files from storage.
scrubVersion(ArchivedFile $archivedFile)
execute()
Do the actual work.
__construct()
Default constructor.
Abstract maintenance class for quickly writing and churning out maintenance scripts with minimal effo...
Definition: Maintenance.php:66
getDB( $db, $groups=[], $dbDomain=false)
Returns a database to be used by current maintenance script.
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.
getOption( $name, $default=null)
Get an option, or return the default.
fatalError( $msg, $exitCode=1)
Output a message and terminate the current script.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:58
const DB_PRIMARY
Definition: defines.php:28
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42