maintenance/deleteArchivedFiles.php

   1 <?php
   2 /**
   3  * Delete archived (non-current) files from the database
   4  *
   5  * Based on deleteOldRevisions.php by Rob Church.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  * @ingroup Maintenance
  24  */
  25
  26 use MediaWiki\MediaWikiServices;
  27
  28 require_once __DIR__ . '/Maintenance.php';
  29
  30 /**
  31  * Maintenance script to delete archived (non-current) files from the database.
  32  *
  33  * @ingroup Maintenance
  34  */
  35 class DeleteArchivedFiles extends Maintenance {
  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->getDB( DB_MASTER );
  51                 $this->beginTransaction( $dbw, __METHOD__ );
  52                 $repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
  53
  54                 # Get "active" revisions from the filearchive table
  55                 $this->output( "Searching for and deleting archived files...\n" );
  56                 $res = $dbw->select(
  57                         'filearchive',
  58                         [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ],
  59                         '',
  60                         __METHOD__
  61                 );
  62
  63                 $count = 0;
  64                 foreach ( $res as $row ) {
  65                         $key = $row->fa_storage_key;
  66                         if ( !strlen( $key ) ) {
  67                                 $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" );
  68                                 continue;
  69                         }
  70
  71                         $file = $repo->newFile( $row->fa_name );
  72                         try {
  73                                 $file->lock();
  74                         } catch ( LocalFileLockError $e ) {
  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 = $dbw->selectField(
  92                                 'oldimage',
  93                                 '1',
  94                                 [
  95                                         'oi_sha1' => $sha1,
  96                                         $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE
  97                                 ],
  98                                 __METHOD__,
  99                                 [ 'FOR UPDATE' ]
 100                         );
 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->unlock();
 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->unlock();
 122                                         continue;
 123                                 }
 124                         }
 125
 126                         $count++;
 127                         $dbw->delete( 'filearchive', [ 'fa_id' => $id ], __METHOD__ );
 128                         $file->unlock();
 129                 }
 130
 131                 $this->commitTransaction( $dbw, __METHOD__ );
 132                 $this->output( "Done! [$count file(s)]\n" );
 133         }
 134 }
 135
 136 $maintClass = DeleteArchivedFiles::class;
 137 require_once RUN_MAINTENANCE_IF_MAIN;