refreshImageMetadata.php

Go to the documentation of this file.

<?php
// @codeCoverageIgnoreStart
require_once __DIR__ . '/Maintenance.php';
// @codeCoverageIgnoreEnd
 
use MediaWiki\FileRepo\File\File;
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
use MediaWiki\FileRepo\LocalRepo;
use MediaWiki\Maintenance\Maintenance;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IMaintainableDatabase;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\LikeValue;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
class RefreshImageMetadata extends Maintenance {
 
    protected $dbw;
 
    public function __construct() {
        parent::__construct();
 
        $this->addDescription( 'Script to update image metadata records' );
        $this->setBatchSize( 200 );
 
        $this->addOption(
            'force',
            'Reload metadata from file even if the metadata looks ok',
            false,
            false,
            'f'
        );
        $this->addOption(
            'broken-only',
            'Only fix really broken records, leave old but still compatible records alone.'
        );
        $this->addOption(
            'convert-to-json',
            'Fix records with an out of date serialization format.'
        );
        $this->addOption(
            'split',
            'Enable splitting out large metadata items to the text table. Implies --convert-to-json.'
        );
        $this->addOption(
            'verbose',
            'Output extra information about each upgraded/non-upgraded file.',
            false,
            false,
            'v'
        );
        $this->addOption( 'start', 'Name of file to start with', false, true );
        $this->addOption( 'end', 'Name of file to end with', false, true );
 
        $this->addOption(
            'mediatype',
            'Only refresh files with this media type, e.g. BITMAP, UNKNOWN etc.',
            false,
            true
        );
        $this->addOption(
            'mime',
            "Only refresh files with this MIME type. Can accept wild-card 'image/*'. "
                . "Potentially inefficient unless 'mediatype' is also specified",
            false,
            true
        );
        $this->addOption(
            'metadata-contains',
            '(Inefficient!) Only refresh files where the img_metadata field '
                . 'contains this string. Can be used if its known a specific '
                . 'property was being extracted incorrectly.',
            false,
            true
        );
        $this->addOption(
            'sleep',
            'Time to sleep between each batch (in seconds). Default: 0',
            false,
            true
        );
        $this->addOption( 'oldimage', 'Run and refresh on oldimage table.' );
    }
 
    public function execute() {
        $force = $this->hasOption( 'force' );
        $brokenOnly = $this->hasOption( 'broken-only' );
        $verbose = $this->hasOption( 'verbose' );
        $start = $this->getOption( 'start', false );
        $split = $this->hasOption( 'split' );
        $sleep = (int)$this->getOption( 'sleep', 0 );
        $reserialize = $this->hasOption( 'convert-to-json' );
        $oldimage = $this->hasOption( 'oldimage' );
 
        $dbw = $this->getPrimaryDB();
        if ( $oldimage ) {
            $fieldPrefix = 'oi_';
            $queryBuilderTemplate  = FileSelectQueryBuilder::newForOldFile( $dbw );
        } else {
            $fieldPrefix = 'img_';
            $queryBuilderTemplate  = FileSelectQueryBuilder::newForFile( $dbw );
        }
 
        $upgraded = 0;
        $leftAlone = 0;
        $batchSize = intval( $this->getBatchSize() );
        if ( $batchSize <= 0 ) {
            $this->fatalError( "Batch size is too low...", 12 );
        }
        $repo = $this->newLocalRepo( $force, $brokenOnly, $reserialize, $split );
        $this->setConditions( $dbw, $queryBuilderTemplate, $fieldPrefix );
        $queryBuilderTemplate
            ->orderBy( $fieldPrefix . 'name', SelectQueryBuilder::SORT_ASC )
            ->limit( $batchSize );
 
        $batchCondition = [];
        // For the WHERE img_name > 'foo' condition that comes after doing a batch
        if ( $start !== false ) {
            $batchCondition[] = $dbw->expr( $fieldPrefix . 'name', '>=', $start );
        }
        do {
            $queryBuilder = clone $queryBuilderTemplate;
            $res = $queryBuilder->andWhere( $batchCondition )
                ->caller( __METHOD__ )->fetchResultSet();
            $nameField = $fieldPrefix . 'name';
            if ( $res->numRows() > 0 ) {
                $row1 = $res->current();
                $this->output( "Processing next {$res->numRows()} row(s) starting with {$row1->$nameField}.\n" );
                $res->rewind();
            }
 
            foreach ( $res as $row ) {
                try {
                    // LocalFile will upgrade immediately here if obsolete
                    $file = $repo->newFileFromRow( $row );
                    $file->maybeUpgradeRow();
                    if ( $file->getUpgraded() ) {
                        // File was upgraded.
                        $upgraded++;
                        $this->output( "Refreshed File:{$row->$nameField}.\n" );
                    } else {
                        $leftAlone++;
                        if ( $force ) {
                            $file->upgradeRow();
                            if ( $verbose ) {
                                $this->output( "Forcibly refreshed File:{$row->$nameField}.\n" );
                            }
                        } else {
                            if ( $verbose ) {
                                $this->output( "Skipping File:{$row->$nameField}.\n" );
                            }
                        }
                    }
                } catch ( Exception $e ) {
                    $this->output( "{$row->$nameField} failed. {$e->getMessage()}\n" );
                }
            }
            if ( $res->numRows() > 0 ) {
                // @phan-suppress-next-line PhanPossiblyUndeclaredVariable rows contains at least one item
                $batchCondition = [ $dbw->expr( $fieldPrefix . 'name', '>', $row->$nameField ) ];
            }
            $this->waitForReplication();
            if ( $sleep ) {
                sleep( $sleep );
            }
        } while ( $res->numRows() === $batchSize );
 
        $total = $upgraded + $leftAlone;
        if ( $force ) {
            $this->output( "\nFinished refreshing file metadata for $total files. "
                . "$upgraded needed to be refreshed, $leftAlone did not need to "
                . "be but were refreshed anyways.\n" );
        } else {
            $this->output( "\nFinished refreshing file metadata for $total files. "
                . "$upgraded were refreshed, $leftAlone were already up to date.\n" );
        }
    }
 
    private function setConditions( IReadableDatabase $dbw, SelectQueryBuilder $queryBuilder, $fieldPrefix ) {
        $end = $this->getOption( 'end', false );
        $mime = $this->getOption( 'mime', false );
        $mediatype = $this->getOption( 'mediatype', false );
        $like = $this->getOption( 'metadata-contains', false );
 
        if ( $end !== false ) {
            $queryBuilder->andWhere( $dbw->expr( $fieldPrefix . 'name', '<=', $end ) );
        }
        if ( $mime !== false ) {
            [ $major, $minor ] = File::splitMime( $mime );
            $queryBuilder->andWhere( [ $fieldPrefix . 'major_mime' => $major ] );
            if ( $minor !== '*' ) {
                $queryBuilder->andWhere( [ $fieldPrefix . 'minor_mime' => $minor ] );
            }
        }
        if ( $mediatype !== false ) {
            $queryBuilder->andWhere( [ $fieldPrefix . 'media_type' => $mediatype ] );
        }
        if ( $like ) {
            $queryBuilder->andWhere(
                $dbw->expr( $fieldPrefix . 'metadata', IExpression::LIKE,
                    new LikeValue( $dbw->anyString(), $like, $dbw->anyString() ) )
            );
        }
    }
 
    private function newLocalRepo( $force, $brokenOnly, $reserialize, $split ): LocalRepo {
        if ( $brokenOnly && $force ) {
            $this->fatalError( 'Cannot use --broken-only and --force together. ', 2 );
        }
        $reserialize = $reserialize || $split;
        if ( $brokenOnly && $reserialize ) {
            $this->fatalError( 'Cannot use --broken-only with --convert-to-json or --split. ',
                2 );
        }
 
        $overrides = [
            'updateCompatibleMetadata' => !$brokenOnly,
        ];
        if ( $reserialize ) {
            $overrides['reserializeMetadata'] = true;
            $overrides['useJsonMetadata'] = true;
        }
        if ( $split ) {
            $overrides['useSplitMetadata'] = true;
        }
 
        return $this->getServiceContainer()->getRepoGroup()
            ->newCustomLocalRepo( $overrides );
    }
}
 
// @codeCoverageIgnoreStart
$maintClass = RefreshImageMetadata::class;
require_once RUN_MAINTENANCE_IF_MAIN;
// @codeCoverageIgnoreEnd