e7393b3cc7
Why: * Maintenance scripts in core have bolierplate code that is added before and after the class to allow directly running the maintenance script. * Running the maintenance script directly has been deprecated since 1.40, so this boilerplate code is only to support a now deprecated method of running maintenance scripts. * This code cannot also be marked as covered, due to PHPUnit not recognising code coverage for files. * Therefore, it is best to ignore this boilerplate code in code coverage reports as it cannot be marked as covered and also is for deprecated code. What: * Wrap the boilerplate code (requiring Maintenance.php and then later defining the maintenance script class and running if the maintenance script was called directly) with @codeCoverageIgnore comments. * Some files use a different boilerplate code, however, these should also be marked as ignored for coverage for the same reason that coverage is not properly reported for files. Bug: T371167 Change-Id: I32f5c6362dfb354149a48ce9c28da9a7fc494f7c
126 lines
4.2 KiB
PHP
126 lines
4.2 KiB
PHP
<?php
|
|
/**
|
|
* Delete archived (non-current) files from storage
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
* @ingroup Maintenance
|
|
*/
|
|
|
|
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
|
|
|
|
// @codeCoverageIgnoreStart
|
|
require_once __DIR__ . '/Maintenance.php';
|
|
// @codeCoverageIgnoreEnd
|
|
|
|
/**
|
|
* Maintenance script to delete archived (non-current) files from storage.
|
|
*
|
|
* @todo Maybe add some simple logging
|
|
*
|
|
* @ingroup Maintenance
|
|
* @since 1.22
|
|
*/
|
|
class EraseArchivedFile extends Maintenance {
|
|
public function __construct() {
|
|
parent::__construct();
|
|
$this->addDescription( 'Erases traces of deleted files.' );
|
|
$this->addOption( 'delete', 'Perform the deletion' );
|
|
$this->addOption( 'filename', 'File name', false, true );
|
|
$this->addOption( 'filekey', 'File storage key (with extension) or "*"', true, true );
|
|
}
|
|
|
|
public function execute() {
|
|
if ( !$this->hasOption( 'delete' ) ) {
|
|
$this->output( "Use --delete to actually confirm this script\n" );
|
|
}
|
|
|
|
$filekey = $this->getOption( 'filekey' );
|
|
$filename = $this->getOption( 'filename' );
|
|
|
|
if ( $filekey === '*' ) {
|
|
// all versions by name
|
|
if ( !strlen( $filename ) ) {
|
|
$this->fatalError( "Missing --filename parameter." );
|
|
}
|
|
$afile = false;
|
|
} else {
|
|
// specified version
|
|
$dbw = $this->getPrimaryDB();
|
|
$queryBuilder = FileSelectQueryBuilder::newForArchivedFile( $dbw );
|
|
$queryBuilder->where( [ 'fa_storage_group' => 'deleted', 'fa_storage_key' => $filekey ] );
|
|
$row = $queryBuilder->caller( __METHOD__ )->fetchRow();
|
|
|
|
if ( !$row ) {
|
|
$this->fatalError( "No deleted file exists with key '$filekey'." );
|
|
}
|
|
$filename = $row->fa_name;
|
|
$afile = ArchivedFile::newFromRow( $row );
|
|
}
|
|
|
|
$file = $this->getServiceContainer()->getRepoGroup()->getLocalRepo()->newFile( $filename );
|
|
if ( $file->exists() ) {
|
|
$this->fatalError( "File '$filename' is still a public file, use the delete form.\n" );
|
|
}
|
|
|
|
$this->output( "Purging all thumbnails for file '$filename'..." );
|
|
$file->purgeCache();
|
|
$this->output( "done.\n" );
|
|
|
|
if ( $afile instanceof ArchivedFile ) {
|
|
$this->scrubVersion( $afile );
|
|
} else {
|
|
$this->output( "Finding deleted versions of file '$filename'...\n" );
|
|
$this->scrubAllVersions( $filename );
|
|
$this->output( "Done\n" );
|
|
}
|
|
}
|
|
|
|
protected function scrubAllVersions( $name ) {
|
|
$dbw = $this->getPrimaryDB();
|
|
$queryBuilder = FileSelectQueryBuilder::newForArchivedFile( $dbw );
|
|
$queryBuilder->where( [ 'fa_name' => $name, 'fa_storage_group' => 'deleted' ] );
|
|
$res = $queryBuilder->caller( __METHOD__ )->fetchResultSet();
|
|
foreach ( $res as $row ) {
|
|
$this->scrubVersion( ArchivedFile::newFromRow( $row ) );
|
|
}
|
|
}
|
|
|
|
protected function scrubVersion( ArchivedFile $archivedFile ) {
|
|
$key = $archivedFile->getStorageKey();
|
|
$name = $archivedFile->getName();
|
|
$ts = $archivedFile->getTimestamp();
|
|
$repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo();
|
|
$path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
|
|
if ( $this->hasOption( 'delete' ) ) {
|
|
$status = $repo->getBackend()->delete( [ 'src' => $path ] );
|
|
if ( $status->isOK() ) {
|
|
$this->output( "Deleted version '$key' ($ts) of file '$name'\n" );
|
|
} else {
|
|
$this->output( "Failed to delete version '$key' ($ts) of file '$name'\n" );
|
|
$this->error( $status );
|
|
}
|
|
} else {
|
|
$this->output( "Would delete version '{$key}' ({$ts}) of file '$name'\n" );
|
|
}
|
|
}
|
|
}
|
|
|
|
// @codeCoverageIgnoreStart
|
|
$maintClass = EraseArchivedFile::class;
|
|
require_once RUN_MAINTENANCE_IF_MAIN;
|
|
// @codeCoverageIgnoreEnd
|