Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 14
CRAP
0.00% covered (danger)
0.00%
0 / 138
ImageBuilder
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 14
756
0.00% covered (danger)
0.00%
0 / 135
 __construct
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 7
 execute
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 12
 getRepo
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 5
 build
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
 init
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 6
 progress
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 23
 buildTable
0.00% covered (danger)
0.00%
0 / 1
12
0.00% covered (danger)
0.00%
0 / 16
 buildImage
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
 imageCallback
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
 buildOldImage
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 3
 oldimageCallback
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 7
 crawlMissing
0.00% covered (danger)
0.00%
0 / 1
2
0.00% covered (danger)
0.00%
0 / 2
 checkMissingImage
0.00% covered (danger)
0.00%
0 / 1
6
0.00% covered (danger)
0.00%
0 / 9
 addMissingImage
0.00% covered (danger)
0.00%
0 / 1
42
0.00% covered (danger)
0.00%
0 / 36
<?php
/**
 * Update image metadata records.
 *
 * Usage: php rebuildImages.php [--missing] [--dry-run]
 * Options:
 *   --missing  Crawl the uploads dir for images without records, and
 *              add them only.
 *
 * Copyright © 2005 Brion Vibber <brion@pobox.com>
 * https://www.mediawiki.org/
 *
 * 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 Brion Vibber <brion at pobox.com>
 * @ingroup Maintenance
 */
require_once __DIR__ . '/Maintenance.php';
use MediaWiki\MediaWikiServices;
use Wikimedia\Rdbms\IMaintainableDatabase;
/**
 * Maintenance script to update image metadata records.
 *
 * @ingroup Maintenance
 */
class ImageBuilder extends Maintenance {
    /**
     * @var IMaintainableDatabase
     */
    protected $dbw;
    /** @var bool */
    private $dryrun;
    /** @var LocalRepo|null */
    private $repo;
    /** @var int */
    private $updated;
    /** @var int */
    private $processed;
    /** @var int */
    private $count;
    /** @var int */
    private $startTime;
    /** @var string */
    private $table;
    public function __construct() {
        parent::__construct();
        global $wgUpdateCompatibleMetadata;
        // make sure to update old, but compatible img_metadata fields.
        $wgUpdateCompatibleMetadata = true;
        $this->addDescription( 'Script to update image metadata records' );
        $this->addOption( 'missing', 'Check for files without associated database record' );
        $this->addOption( 'dry-run', 'Only report, don\'t update the database' );
    }
    public function execute() {
        $this->dbw = $this->getDB( DB_MASTER );
        $this->dryrun = $this->hasOption( 'dry-run' );
        if ( $this->dryrun ) {
            MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode()
                ->setReason( 'Dry run mode, image upgrades are suppressed' );
        }
        if ( $this->hasOption( 'missing' ) ) {
            $this->crawlMissing();
        } else {
            $this->build();
        }
    }
    /**
     * @return LocalRepo
     */
    private function getRepo() {
        if ( $this->repo === null ) {
            $this->repo = MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo();
        }
        return $this->repo;
    }
    private function build() {
        $this->buildImage();
        $this->buildOldImage();
    }
    /**
     * @param int $count
     * @param string $table
     */
    private function init( $count, $table ) {
        $this->processed = 0;
        $this->updated = 0;
        $this->count = $count;
        $this->startTime = microtime( true );
        $this->table = $table;
    }
    private function progress( $updated ) {
        $this->updated += $updated;
        $this->processed++;
        if ( $this->processed % 100 != 0 ) {
            return;
        }
        $portion = $this->processed / $this->count;
        $updateRate = $this->updated / $this->processed;
        $now = microtime( true );
        $delta = $now - $this->startTime;
        $estimatedTotalTime = $delta / $portion;
        $eta = $this->startTime + $estimatedTotalTime;
        $rate = $this->processed / $delta;
        $this->output( sprintf( "%s: %6.2f%% done on %s; ETA %s [%d/%d] %.2f/sec <%.2f%% updated>\n",
            wfTimestamp( TS_DB, intval( $now ) ),
            $portion * 100.0,
            $this->table,
            wfTimestamp( TS_DB, intval( $eta ) ),
            $this->processed,
            $this->count,
            $rate,
            $updateRate * 100.0 ) );
        flush();
    }
    private function buildTable( $table, $key, $queryInfo, $callback ) {
        $count = $this->dbw->selectField( $table, 'count(*)', '', __METHOD__ );
        $this->init( $count, $table );
        $this->output( "Processing $table...\n" );
        $result = $this->getDB( DB_REPLICA )->select(
            $queryInfo['tables'], $queryInfo['fields'], [], __METHOD__, [], $queryInfo['joins']
        );
        foreach ( $result as $row ) {
            $update = call_user_func( $callback, $row, null );
            if ( $update ) {
                $this->progress( 1 );
            } else {
                $this->progress( 0 );
            }
        }
        $this->output( "Finished $table... $this->updated of $this->processed rows updated\n" );
    }
    private function buildImage() {
        $callback = [ $this, 'imageCallback' ];
        $this->buildTable( 'image', 'img_name', LocalFile::getQueryInfo(), $callback );
    }
    private function imageCallback( $row, $copy ) {
        // Create a File object from the row
        // This will also upgrade it
        $file = $this->getRepo()->newFileFromRow( $row );
        return $file->getUpgraded();
    }
    private function buildOldImage() {
        $this->buildTable( 'oldimage', 'oi_archive_name', OldLocalFile::getQueryInfo(),
            [ $this, 'oldimageCallback' ] );
    }
    private function oldimageCallback( $row, $copy ) {
        // Create a File object from the row
        // This will also upgrade it
        if ( $row->oi_archive_name == '' ) {
            $this->output( "Empty oi_archive_name for oi_name={$row->oi_name}\n" );
            return false;
        }
        $file = $this->getRepo()->newFileFromRow( $row );
        return $file->getUpgraded();
    }
    private function crawlMissing() {
        $this->getRepo()->enumFiles( [ $this, 'checkMissingImage' ] );
    }
    private function checkMissingImage( $fullpath ) {
        $filename = wfBaseName( $fullpath );
        $row = $this->dbw->selectRow( 'image',
            [ 'img_name' ],
            [ 'img_name' => $filename ],
            __METHOD__ );
        if ( !$row ) {
            // file not registered
            $this->addMissingImage( $filename, $fullpath );
        }
    }
    private function addMissingImage( $filename, $fullpath ) {
        $timestamp = $this->dbw->timestamp( $this->getRepo()->getFileTimestamp( $fullpath ) );
        $services = MediaWikiServices::getInstance();
        $altname = $services->getContentLanguage()->checkTitleEncoding( $filename );
        if ( $altname != $filename ) {
            if ( $this->dryrun ) {
                $filename = $altname;
                $this->output( "Estimating transcoding... $altname\n" );
            } else {
                // @fixme create renameFile()
                // @phan-suppress-next-line PhanUndeclaredMethod See comment above...
                $filename = $this->renameFile( $filename );
            }
        }
        if ( $filename == '' ) {
            $this->output( "Empty filename for $fullpath\n" );
            return;
        }
        if ( !$this->dryrun ) {
            $file = $services->getRepoGroup()->getLocalRepo()->newFile( $filename );
            $pageText = SpecialUpload::getInitialPageText(
                '(recovered file, missing upload log entry)'
            );
            $user = User::newSystemUser( 'Maintenance script', [ 'steal' => true ] );
            $status = $file->recordUpload3(
                '',
                '(recovered file, missing upload log entry)',
                $pageText,
                $user,
                false,
                $timestamp
            );
            if ( !$status->isOK() ) {
                $this->output( "Error uploading file $fullpath\n" );
                return;
            }
        }
        $this->output( $fullpath . "\n" );
    }
}
$maintClass = ImageBuilder::class;
require_once RUN_MAINTENANCE_IF_MAIN;