summaryrefslogtreecommitdiff
path: root/maintenance/cleanupUploadStash.php
blob: 5f57ffdffbca08235dd58fc0920db3897801ac7f (plain)
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
<?php
/**
 * Remove old or broken uploads from temporary uploaded file storage,
 * clean up associated database records
 *
 * Copyright © 2011, Wikimedia Foundation
 *
 * 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
 * @author Ian Baker <ibaker@wikimedia.org>
 * @ingroup Maintenance
 */

require_once( dirname( __FILE__ ) . '/Maintenance.php' );

class UploadStashCleanup extends Maintenance {

	public function __construct() {
		parent::__construct();
		$this->mDescription = "Clean up abandoned files in temporary uploaded file stash";
	}

	public function execute() {
		$repo = RepoGroup::singleton()->getLocalRepo();

		$dbr = $repo->getSlaveDb();

		// how far back should this look for files to delete?
		global $wgUploadStashMaxAge;

		$this->output( "Getting list of files to clean up...\n" );
		$res = $dbr->select(
			'uploadstash',
			'us_key',
			'us_timestamp < ' . $dbr->addQuotes( $dbr->timestamp( time() - $wgUploadStashMaxAge ) ),
			__METHOD__
		);

		if( !is_object( $res ) || $res->numRows() == 0 ) {
			$this->output( "No files to cleanup!\n" );
			// nothing to do.
			return;
		}

		// finish the read before starting writes.
		$keys = array();
		foreach( $res as $row ) {
			array_push( $keys, $row->us_key );
		}

		$this->output( 'Removing ' . count($keys) . " file(s)...\n" );
		// this could be done some other, more direct/efficient way, but using
		// UploadStash's own methods means it's less likely to fall accidentally
		// out-of-date someday
		$stash = new UploadStash( $repo );

		foreach( $keys as $key ) {
			try {
				$stash->getFile( $key, true );
				$stash->removeFileNoAuth( $key );
			} catch ( UploadStashBadPathException $ex ) {
				$this->output( "Failed removing stashed upload with key: $key\n"  );
			}
		}
  	}
}

$maintClass = "UploadStashCleanup";
require_once( RUN_MAINTENANCE_IF_MAIN );