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 require_once __DIR__ . '/Maintenance.php';
  27
  28 /**
  29  * Maintenance script to delete archived (non-current) files from the database.
  30  *
  31  * @ingroup Maintenance
  32  */
  33 class DeleteArchivedFiles extends Maintenance {
  34         public function __construct() {
  35                 parent::__construct();
  36                 $this->addDescription( 'Deletes all archived images.' );
  37                 $this->addOption( 'delete', 'Perform the deletion' );
  38                 $this->addOption( 'force', 'Force deletion of rows from filearchive' );
  39         }
  40
  41         public function execute() {
  42                 if ( !$this->hasOption( 'delete' ) ) {
  43                         $this->output( "Use --delete to actually confirm this script\n" );
  44                         return;
  45                 }
  46
  47                 # Data should come off the master, wrapped in a transaction
  48                 $dbw = $this->getDB( DB_MASTER );
  49                 $this->beginTransaction( $dbw, __METHOD__ );
  50                 $repo = RepoGroup::singleton()->getLocalRepo();
  51
  52                 # Get "active" revisions from the filearchive table
  53                 $this->output( "Searching for and deleting archived files...\n" );
  54                 $res = $dbw->select(
  55                         'filearchive',
  56                         [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ],
  57                         '',
  58                         __METHOD__
  59                 );
  60
  61                 $count = 0;
  62                 foreach ( $res as $row ) {
  63                         $key = $row->fa_storage_key;
  64                         if ( !strlen( $key ) ) {
  65                                 $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" );
  66                                 continue;
  67                         }
  68
  69                         $file = $repo->newFile( $row->fa_name );
  70                         try {
  71                                 $file->lock();
  72                         } catch ( LocalFileLockError $e ) {
  73                                 $this->error( "Could not acquire lock on '{$row->fa_name}', skipping\n" );
  74                                 continue;
  75                         }
  76
  77                         $group = $row->fa_storage_group;
  78                         $id = $row->fa_id;
  79                         $path = $repo->getZonePath( 'deleted' ) .
  80                                 '/' . $repo->getDeletedHashPath( $key ) . $key;
  81                         if ( isset( $row->fa_sha1 ) ) {
  82                                 $sha1 = $row->fa_sha1;
  83                         } else {
  84                                 // old row, populate from key
  85                                 $sha1 = LocalRepo::getHashFromKey( $key );
  86                         }
  87
  88                         // Check if the file is used anywhere...
  89                         $inuse = $dbw->selectField(
  90                                 'oldimage',
  91                                 '1',
  92                                 [
  93                                         'oi_sha1' => $sha1,
  94                                         $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE
  95                                 ],
  96                                 __METHOD__,
  97                                 [ 'FOR UPDATE' ]
  98                         );
  99
 100                         $needForce = true;
 101                         if ( !$repo->fileExists( $path ) ) {
 102                                 $this->output( "Notice - file '$key' not found in group '$group'\n" );
 103                         } elseif ( $inuse ) {
 104                                 $this->output( "Notice - file '$key' is still in use\n" );
 105                         } elseif ( !$repo->quickPurge( $path ) ) {
 106                                 $this->output( "Unable to remove file $path, skipping\n" );
 107                                 $file->unlock();
 108                                 continue; // don't delete even with --force
 109                         } else {
 110                                 $needForce = false;
 111                         }
 112
 113                         if ( $needForce ) {
 114                                 if ( $this->hasOption( 'force' ) ) {
 115                                         $this->output( "Got --force, deleting DB entry\n" );
 116                                 } else {
 117                                         $file->unlock();
 118                                         continue;
 119                                 }
 120                         }
 121
 122                         $count++;
 123                         $dbw->delete( 'filearchive', [ 'fa_id' => $id ], __METHOD__ );
 124                         $file->unlock();
 125                 }
 126
 127                 $this->commitTransaction( $dbw, __METHOD__ );
 128                 $this->output( "Done! [$count file(s)]\n" );
 129         }
 130 }
 131
 132 $maintClass = DeleteArchivedFiles::class;
 133 require_once RUN_MAINTENANCE_IF_MAIN;