<?php
+/**
+ * Dump a the list of files uploaded, for feeding to tar or similar
+ *
+ * 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
+ *
+ * @ingroup Maintenance
+ */
-require_once 'commandLine.inc';
+require_once( dirname( __FILE__ ) . '/Maintenance.php' );
-class UploadDumper {
-
- function __construct( $args ) {
- global $IP, $wgUseSharedUploads;
- $this->mAction = 'fetchUsed';
- $this->mBasePath = $IP;
- $this->mShared = $wgUseSharedUploads;
-
- if( isset( $args['help'] ) ) {
- $this->mAction = 'help';
- }
-
- if( isset( $args['base'] ) ) {
- $this->mBasePath = $args['base'];
- }
+class UploadDumper extends Maintenance {
+ public function __construct() {
+ parent::__construct();
+ $this->mDescription = "Generates list of uploaded files which can be fed to tar or similar.
+By default, outputs relative paths against the parent directory of \$wgUploadDirectory.";
+ $this->addOption( 'base', 'Set base relative path instead of wiki include root', false, true );
+ $this->addOption( 'local', 'List all local files, used or not. No shared files included' );
+ $this->addOption( 'used', 'Skip local images that are not used' );
+ $this->addOption( 'shared', 'Include images used from shared repository' );
}
-
- function run() {
- $this->{$this->mAction}();
- }
-
- 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
+ public function execute() {
+ global $IP;
+ $this->mAction = 'fetchLocal';
+ $this->mBasePath = $this->getOption( 'base', $IP );
+ $this->mShared = false;
+ $this->mSharedSupplement = false;
-FIXME: other options not implemented yet ;)
+ if ( $this->hasOption( 'local' ) ) {
+ $this->mAction = 'fetchLocal';
+ }
---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
+ if ( $this->hasOption( 'used' ) ) {
+ $this->mAction = 'fetchUsed';
+ }
-END;
+ if ( $this->hasOption( 'shared' ) ) {
+ if ( $this->hasOption( 'used' ) ) {
+ // Include shared-repo files in the used check
+ $this->mShared = true;
+ } else {
+ // Grab all local *plus* used shared
+ $this->mSharedSupplement = true;
+ }
+ }
+ $this-> { $this->mAction } ( $this->mShared );
+ if ( $this->mSharedSupplement ) {
+ $this->fetchUsed( true );
+ }
}
-
+
/**
- * 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
+ * Fetch a list of used images from a particular image source.
+ *
+ * @param $shared Boolean: true to pass shared-dir settings to hash func
*/
- function fetchUsed() {
+ 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 );
-
- while( $row = $dbr->fetchObject( $result ) ) {
- if( is_null( $row->img_name ) ) {
- if( $this->mShared ) {
- $this->outputShared( $row->il_to );
- }
- } else {
- $this->outputLocal( $row->il_to );
- }
+
+ foreach ( $result as $row ) {
+ $this->outputItem( $row->il_to, $shared );
}
- $dbr->freeResult( $result );
- }
-
- function outputLocal( $name ) {
- global $wgUploadDirectory;
- return $this->outputItem( $name, $wgUploadDirectory, false );
- }
-
- function outputShared( $name ) {
- global $wgSharedUploadDirectory;
- return $this->outputItem( $name, $wgSharedUploadDirectory, true );
- }
-
- function outputItem( $name, $directory, $shared ) {
- $filename = $directory .
- wfGetHashPath( $name, $shared ) .
- $name;
- $rel = $this->relativePath( $filename, $this->mBasePath );
- echo "$rel\n";
}
/**
- * Return a relative path to $path from the base directory $base
- * For instance relativePath( '/foo/bar/baz', '/foo' ) should return
- * 'bar/baz'.
+ * Fetch a list of all images from a particular image source.
+ *
+ * @param $shared Boolean: true to pass shared-dir settings to hash func
*/
- function relativePath( $path, $base) {
- $path = explode( DIRECTORY_SEPARATOR, $path );
- $base = explode( DIRECTORY_SEPARATOR, $base );
- while( count( $base ) && $path[0] == $base[0] ) {
- array_shift( $path );
- array_shift( $base );
+ 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 );
}
- foreach( $base as $prefix ) {
- array_unshift( $path, '..' );
+ }
+
+ function outputItem( $name, $shared ) {
+ $file = wfFindFile( $name );
+ if ( $file && $this->filterItem( $file, $shared ) ) {
+ $filename = $file->getPath();
+ $rel = wfRelativePath( $filename, $this->mBasePath );
+ $this->output( "$rel\n" );
+ } else {
+ wfDebug( __METHOD__ . ": base file? $name\n" );
}
- return implode( DIRECTORY_SEPARATOR, $path );
}
-}
-$dumper = new UploadDumper( $options );
-$dumper->run();
+ function filterItem( $file, $shared ) {
+ return $shared || $file->isLocal();
+ }
+}
-?>
\ No newline at end of file
+$maintClass = "UploadDumper";
+require_once( RUN_MAINTENANCE_IF_MAIN );