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