summaryrefslogtreecommitdiff
path: root/maintenance/dumpUploads.php
blob: 50d03ae1882141fc85ecc11fdcb4333e4bb0e6c0 (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
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
<?php

require_once 'commandLine.inc';

class UploadDumper {
	function __construct( $args ) {
		global $IP, $wgUseSharedUploads;
		$this->mAction = 'fetchLocal';
		$this->mBasePath = $IP;
		$this->mShared = false;
		$this->mSharedSupplement = false;
		
		if( isset( $args['help'] ) ) {
			$this->mAction = 'help';
		}
		
		if( isset( $args['base'] ) ) {
			$this->mBasePath = $args['base'];
		}
		
		if( isset( $args['local'] ) ) {
			$this->mAction = 'fetchLocal';
		}
		
		if( isset( $args['used'] ) ) {
			$this->mAction = 'fetchUsed';
		}
		
		if( isset( $args['shared'] ) ) {
			if( isset( $args['used'] ) ) {
				// Include shared-repo files in the used check
				$this->mShared = true;
			} else {
				// Grab all local *plus* used shared
				$this->mSharedSupplement = true;
			}
		}
	}
	
	function run() {
		$this->{$this->mAction}( $this->mShared );
		if( $this->mSharedSupplement ) {
			$this->fetchUsed( true );
		}
	}
	
	function help() {
		echo <<<END
Generates list of uploaded files which can be fed to tar or similar.
By default, outputs relative paths against the parent directory of
\$wgUploadDirectory.

Usage:
php dumpUploads.php [options] > list-o-files.txt

Options:
--base=<path>  Set base relative path instead of wiki include root

--local        List all local files, used or not. No shared files included.
--used         Skip local images that are not used
--shared       Include images used from shared repository

END;
	}
	
	/**
	 * Fetch a list of all or used images from a particular image source.
	 * @param string $table
	 * @param string $directory Base directory where files are located
	 * @param bool $shared true to pass shared-dir settings to hash func
	 */
	function fetchUsed( $shared ) {
		$dbr = wfGetDB( DB_SLAVE );
		$image = $dbr->tableName( 'image' );
		$imagelinks = $dbr->tableName( 'imagelinks' );
		
		$sql = "SELECT DISTINCT il_to, img_name
			FROM $imagelinks
			LEFT OUTER JOIN $image
			ON il_to=img_name";
		$result = $dbr->query( $sql );
		
		foreach( $result as $row ) {
			$this->outputItem( $row->il_to, $shared );
		}
		$dbr->freeResult( $result );
	}
	
	function fetchLocal( $shared ) {
		$dbr = wfGetDB( DB_SLAVE );
		$result = $dbr->select( 'image',
			array( 'img_name' ),
			'',
			__METHOD__ );
		
		foreach( $result as $row ) {
			$this->outputItem( $row->img_name, $shared );
		}
		$dbr->freeResult( $result );
	}
	
	function outputItem( $name, $shared ) {
		$file = wfFindFile( $name );
		if( $file && $this->filterItem( $file, $shared ) ) {
			$filename = $file->getFullPath();
			$rel = wfRelativePath( $filename, $this->mBasePath );
			echo "$rel\n";
		} else {
			wfDebug( __METHOD__ . ": base file? $name\n" );
		}
	}
	
	function filterItem( $file, $shared ) {
		return $shared || $file->isLocal();
	}
}

$dumper = new UploadDumper( $options );
$dumper->run();