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', 'fa_name' ], |
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
|
|
|
/** @var LocalFile $file */ |
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
|
|
|
continue; // don't delete even with --force |
111
|
|
|
} else { |
112
|
|
|
$needForce = false; |
113
|
|
|
} |
114
|
|
|
|
115
|
|
|
if ( $needForce ) { |
116
|
|
|
if ( $this->hasOption( 'force' ) ) { |
117
|
|
|
$this->output( "Got --force, deleting DB entry\n" ); |
118
|
|
|
} else { |
119
|
|
|
$file->unlock(); |
120
|
|
|
continue; |
121
|
|
|
} |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
$count++; |
125
|
|
|
$dbw->delete( 'filearchive', [ 'fa_id' => $id ], __METHOD__ ); |
126
|
|
|
$file->unlock(); |
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
$this->commitTransaction( $dbw, __METHOD__ ); |
|
|
|
|
130
|
|
|
$this->output( "Done! [$count file(s)]\n" ); |
131
|
|
|
} |
132
|
|
|
} |
133
|
|
|
|
134
|
|
|
$maintClass = "DeleteArchivedFiles"; |
135
|
|
|
require_once RUN_MAINTENANCE_IF_MAIN; |
136
|
|
|
|
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.