eraseArchivedFile.php

Go to the documentation of this file.

<?php
use MediaWiki\FileRepo\File\ArchivedFile;
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
use MediaWiki\Maintenance\Maintenance;
 
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
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 ( $filename === null || $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( string $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