1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<?php
/**
* Scan the logging table and purge affected files within a timeframe.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup Maintenance
*/
require_once __DIR__ . '/Maintenance.php';
/**
* Maintenance script that scans the deletion log and purges affected files
* within a timeframe.
*
* @ingroup Maintenance
*/
class PurgeChangedFiles extends Maintenance {
/**
* Mapping from type option to log type and actions.
* @var array
*/
private static $typeMappings = array(
'created' => array(
'upload' => array( 'upload' ),
'import' => array( 'upload', 'interwiki' ),
),
'deleted' => array(
'delete' => array( 'delete', 'revision' ),
'suppress' => array( 'delete', 'revision' ),
),
'modified' => array(
'upload' => array( 'overwrite', 'revert' ),
'move' => array( 'move', 'move_redir' ),
),
);
/**
* @var string
*/
private $startTimestamp;
/**
* @var string
*/
private $endTimestamp;
public function __construct() {
parent::__construct();
$this->mDescription = "Scan the logging table and purge files and thumbnails.";
$this->addOption( 'starttime', 'Starting timestamp', true, true );
$this->addOption( 'endtime', 'Ending timestamp', true, true );
$this->addOption( 'type', 'Comma-separated list of types of changes to send purges for (' .
implode( ',', array_keys( self::$typeMappings ) ) . ',all)', false, true );
$this->addOption( 'htcp-dest', 'HTCP announcement destination (IP:port)', false, true );
$this->addOption( 'dry-run', 'Do not send purge requests' );
$this->addOption( 'sleep-per-batch', 'Milliseconds to sleep between batches', false, true );
$this->addOption( 'verbose', 'Show more output', false, false, 'v' );
$this->setBatchSize( 100 );
}
public function execute() {
global $wgHTCPRouting;
if ( $this->hasOption( 'htcp-dest' ) ) {
$parts = explode( ':', $this->getOption( 'htcp-dest' ) );
if ( count( $parts ) < 2 ) {
// Add default htcp port
$parts[] = '4827';
}
// Route all HTCP messages to provided host:port
$wgHTCPRouting = array(
'' => array( 'host' => $parts[0], 'port' => $parts[1] ),
);
$this->verbose( "HTCP broadcasts to {$parts[0]}:{$parts[1]}\n" );
}
// Find out which actions we should be concerned with
$typeOpt = $this->getOption( 'type', 'all' );
$validTypes = array_keys( self::$typeMappings );
if ( $typeOpt === 'all' ) {
// Convert 'all' to all registered types
$typeOpt = implode( ',', $validTypes );
}
$typeList = explode( ',', $typeOpt );
foreach ( $typeList as $type ) {
if ( !in_array( $type, $validTypes ) ) {
$this->error( "\nERROR: Unknown type: {$type}\n" );
$this->maybeHelp( true );
}
}
// Validate the timestamps
$dbr = $this->getDB( DB_SLAVE );
$this->startTimestamp = $dbr->timestamp( $this->getOption( 'starttime' ) );
$this->endTimestamp = $dbr->timestamp( $this->getOption( 'endtime' ) );
if ( $this->startTimestamp > $this->endTimestamp ) {
$this->error( "\nERROR: starttime after endtime\n" );
$this->maybeHelp( true );
}
// Turn on verbose when dry-run is enabled
if ( $this->hasOption( 'dry-run' ) ) {
$this->mOptions['verbose'] = 1;
}
$this->verbose( 'Purging files that were: ' . implode( ', ', $typeList ) . "\n" );
foreach ( $typeList as $type ) {
$this->verbose( "Checking for {$type} files...\n" );
$this->purgeFromLogType( $type );
if ( !$this->hasOption( 'dry-run' ) ) {
$this->verbose( "...{$type} files purged.\n\n" );
}
}
}
/**
* Purge cache and thumbnails for changes of the given type.
*
* @param string $type Type of change to find
*/
protected function purgeFromLogType( $type ) {
$repo = RepoGroup::singleton()->getLocalRepo();
$dbr = $this->getDB( DB_SLAVE );
foreach ( self::$typeMappings[$type] as $logType => $logActions ) {
$this->verbose( "Scanning for {$logType}/" . implode( ',', $logActions ) . "\n" );
$res = $dbr->select(
'logging',
array( 'log_title', 'log_timestamp', 'log_params' ),
array(
'log_namespace' => NS_FILE,
'log_type' => $logType,
'log_action' => $logActions,
'log_timestamp >= ' . $dbr->addQuotes( $this->startTimestamp ),
'log_timestamp <= ' . $dbr->addQuotes( $this->endTimestamp ),
),
__METHOD__
);
$bSize = 0;
foreach ( $res as $row ) {
$file = $repo->newFile( Title::makeTitle( NS_FILE, $row->log_title ) );
if ( $this->hasOption( 'dry-run' ) ) {
$this->verbose( "{$type}[{$row->log_timestamp}]: {$row->log_title}\n" );
continue;
}
// Purge current version and any versions in oldimage table
$file->purgeCache();
$file->purgeHistory();
if ( $logType === 'delete' ) {
// If there is an orphaned storage file... delete it
if ( !$file->exists() && $repo->fileExists( $file->getPath() ) ) {
$dpath = $this->getDeletedPath( $repo, $file );
if ( $repo->fileExists( $dpath ) ) {
// Sanity check to avoid data loss
$repo->getBackend()->delete( array( 'src' => $file->getPath() ) );
$this->verbose( "Deleted orphan file: {$file->getPath()}.\n" );
} else {
$this->error( "File was not deleted: {$file->getPath()}.\n" );
}
}
// Purge items from fileachive table (rows are likely here)
$this->purgeFromArchiveTable( $repo, $file );
} elseif ( $logType === 'move' ) {
// Purge the target file as well
$params = unserialize( $row->log_params );
if ( isset( $params['4::target'] ) ) {
$target = $params['4::target'];
$targetFile = $repo->newFile( Title::makeTitle( NS_FILE, $target ) );
$targetFile->purgeCache();
$targetFile->purgeHistory();
$this->verbose( "Purged file {$target}; move target @{$row->log_timestamp}.\n" );
}
}
$this->verbose( "Purged file {$row->log_title}; {$type} @{$row->log_timestamp}.\n" );
if ( $this->hasOption( 'sleep-per-batch' ) && ++$bSize > $this->mBatchSize ) {
$bSize = 0;
// sleep-per-batch is milliseconds, usleep wants micro seconds.
usleep( 1000 * (int)$this->getOption( 'sleep-per-batch' ) );
}
}
}
}
protected function purgeFromArchiveTable( LocalRepo $repo, LocalFile $file ) {
$dbr = $repo->getSlaveDB();
$res = $dbr->select(
'filearchive',
array( 'fa_archive_name' ),
array( 'fa_name' => $file->getName() ),
__METHOD__
);
foreach ( $res as $row ) {
if ( $row->fa_archive_name === null ) {
// Was not an old version (current version names checked already)
continue;
}
$ofile = $repo->newFromArchiveName( $file->getTitle(), $row->fa_archive_name );
// If there is an orphaned storage file still there...delete it
if ( !$file->exists() && $repo->fileExists( $ofile->getPath() ) ) {
$dpath = $this->getDeletedPath( $repo, $ofile );
if ( $repo->fileExists( $dpath ) ) {
// Sanity check to avoid data loss
$repo->getBackend()->delete( array( 'src' => $ofile->getPath() ) );
$this->output( "Deleted orphan file: {$ofile->getPath()}.\n" );
} else {
$this->error( "File was not deleted: {$ofile->getPath()}.\n" );
}
}
$file->purgeOldThumbnails( $row->fa_archive_name );
}
}
protected function getDeletedPath( LocalRepo $repo, LocalFile $file ) {
$hash = $repo->getFileSha1( $file->getPath() );
$key = "{$hash}.{$file->getExtension()}";
return $repo->getDeletedHashPath( $key ) . $key;
}
/**
* Send an output message iff the 'verbose' option has been provided.
*
* @param string $msg Message to output
*/
protected function verbose( $msg ) {
if ( $this->hasOption( 'verbose' ) ) {
$this->output( $msg );
}
}
}
$maintClass = "PurgeChangedFiles";
require_once RUN_MAINTENANCE_IF_MAIN;
|
