Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
0.00% |
0 / 67 |
|
0.00% |
0 / 2 |
CRAP | |
0.00% |
0 / 1 |
| DeleteArchivedFiles | |
0.00% |
0 / 67 |
|
0.00% |
0 / 2 |
156 | |
0.00% |
0 / 1 |
| __construct | |
0.00% |
0 / 4 |
|
0.00% |
0 / 1 |
2 | |||
| execute | |
0.00% |
0 / 63 |
|
0.00% |
0 / 1 |
132 | |||
| 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\Maintenance\Maintenance; |
| 27 | |
| 28 | // @codeCoverageIgnoreStart |
| 29 | require_once __DIR__ . '/Maintenance.php'; |
| 30 | // @codeCoverageIgnoreEnd |
| 31 | |
| 32 | /** |
| 33 | * Maintenance script to delete archived (non-current) files from the database. |
| 34 | * |
| 35 | * @ingroup Maintenance |
| 36 | */ |
| 37 | class DeleteArchivedFiles extends Maintenance { |
| 38 | public function __construct() { |
| 39 | parent::__construct(); |
| 40 | $this->addDescription( 'Deletes all archived images.' ); |
| 41 | $this->addOption( 'delete', 'Perform the deletion' ); |
| 42 | $this->addOption( 'force', 'Force deletion of rows from filearchive' ); |
| 43 | } |
| 44 | |
| 45 | public function execute() { |
| 46 | if ( !$this->hasOption( 'delete' ) ) { |
| 47 | $this->output( "Use --delete to actually confirm this script\n" ); |
| 48 | return; |
| 49 | } |
| 50 | |
| 51 | # Data should come off the master, wrapped in a transaction |
| 52 | $dbw = $this->getPrimaryDB(); |
| 53 | $this->beginTransaction( $dbw, __METHOD__ ); |
| 54 | $repo = $this->getServiceContainer()->getRepoGroup()->getLocalRepo(); |
| 55 | |
| 56 | # Get "active" revisions from the filearchive table |
| 57 | $this->output( "Searching for and deleting archived files...\n" ); |
| 58 | $res = $dbw->newSelectQueryBuilder() |
| 59 | ->select( [ 'fa_id', 'fa_storage_group', 'fa_storage_key', 'fa_sha1', 'fa_name' ] ) |
| 60 | ->from( 'filearchive' ) |
| 61 | ->caller( __METHOD__ ) |
| 62 | ->fetchResultSet(); |
| 63 | |
| 64 | $count = 0; |
| 65 | foreach ( $res as $row ) { |
| 66 | $key = $row->fa_storage_key; |
| 67 | if ( !strlen( $key ) ) { |
| 68 | $this->output( "Entry with ID {$row->fa_id} has empty key, skipping\n" ); |
| 69 | continue; |
| 70 | } |
| 71 | |
| 72 | $file = $repo->newFile( $row->fa_name ); |
| 73 | $status = $file->acquireFileLock( 10 ); |
| 74 | if ( !$status->isOK() ) { |
| 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 = (bool)$dbw->newSelectQueryBuilder() |
| 92 | ->select( '1' ) |
| 93 | ->from( 'oldimage' ) |
| 94 | ->where( [ |
| 95 | 'oi_sha1' => $sha1, |
| 96 | $dbw->bitAnd( 'oi_deleted', File::DELETED_FILE ) => File::DELETED_FILE |
| 97 | ] ) |
| 98 | ->caller( __METHOD__ ) |
| 99 | ->forUpdate() |
| 100 | ->fetchField(); |
| 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->releaseFileLock(); |
| 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->releaseFileLock(); |
| 122 | continue; |
| 123 | } |
| 124 | } |
| 125 | |
| 126 | $count++; |
| 127 | $dbw->newDeleteQueryBuilder() |
| 128 | ->deleteFrom( 'filearchive' ) |
| 129 | ->where( [ 'fa_id' => $id ] ) |
| 130 | ->caller( __METHOD__ )->execute(); |
| 131 | $file->releaseFileLock(); |
| 132 | } |
| 133 | |
| 134 | $this->commitTransaction( $dbw, __METHOD__ ); |
| 135 | $this->output( "Done! [$count file(s)]\n" ); |
| 136 | } |
| 137 | } |
| 138 | |
| 139 | // @codeCoverageIgnoreStart |
| 140 | $maintClass = DeleteArchivedFiles::class; |
| 141 | require_once RUN_MAINTENANCE_IF_MAIN; |
| 142 | // @codeCoverageIgnoreEnd |