dumpUploads.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
require_once __DIR__ . '/Maintenance.php';
 
class DumpUploads extends Maintenance {
    private $mBasePath;
 
    public function __construct() {
        parent::__construct();
        $this->addDescription( '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' );
    }
 
    public function execute() {
        global $IP;
        $this->mBasePath = $this->getOption( 'base', $IP );
        $shared = false;
        $sharedSupplement = false;
 
        if ( $this->hasOption( 'shared' ) ) {
            if ( $this->hasOption( 'used' ) ) {
                // Include shared-repo files in the used check
                $shared = true;
            } else {
                // Grab all local *plus* used shared
                $sharedSupplement = true;
            }
        }
 
        if ( $this->hasOption( 'local' ) ) {
            $this->fetchLocal( $shared );
        } elseif ( $this->hasOption( 'used' ) ) {
            $this->fetchUsed( $shared );
        } else {
            $this->fetchLocal( $shared );
        }
 
        if ( $sharedSupplement ) {
            $this->fetchUsed( true );
        }
    }
 
    private function fetchUsed( $shared ) {
        $dbr = $this->getDB( DB_REPLICA );
 
        $result = $dbr->newSelectQueryBuilder()
            ->select( [ 'il_to', 'img_name' ] )
            ->distinct()
            ->from( 'imagelinks' )
            ->leftJoin( 'image', null, 'il_to=img_name' )
            ->caller( __METHOD__ )
            ->fetchResultSet();
 
        foreach ( $result as $row ) {
            $this->outputItem( $row->il_to, $shared );
        }
    }
 
    private function fetchLocal( $shared ) {
        $dbr = $this->getDB( DB_REPLICA );
        $result = $dbr->newSelectQueryBuilder()
            ->select( 'img_name' )
            ->from( 'image' )
            ->caller( __METHOD__ )
            ->fetchResultSet();
 
        foreach ( $result as $row ) {
            $this->outputItem( $row->img_name, $shared );
        }
    }
 
    private function outputItem( $name, $shared ) {
        $file = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $name );
        if ( $file && $this->filterItem( $file, $shared ) ) {
            $filename = $file->getLocalRefPath();
            $rel = wfRelativePath( $filename, $this->mBasePath );
            $this->output( "$rel\n" );
        } else {
            wfDebug( __METHOD__ . ": base file? $name" );
        }
    }
 
    private function filterItem( $file, $shared ) {
        return $shared || $file->isLocal();
    }
}
 
$maintClass = DumpUploads::class;
require_once RUN_MAINTENANCE_IF_MAIN;