OldLocalFile.php

Go to the documentation of this file.

<?php
use MediaWiki\FileRepo\File\FileSelectQueryBuilder;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Permissions\Authority;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use MediaWiki\User\UserIdentity;
use Wikimedia\Rdbms\IDBAccessObject;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
class OldLocalFile extends LocalFile {
    protected $requestedTime;
 
    protected $archive_name;
 
    public const CACHE_VERSION = 1;
 
    public static function newFromTitle( $title, $repo, $time = null ) {
        # The null default value is only here to avoid an E_STRICT
        if ( $time === null ) {
            throw new InvalidArgumentException( __METHOD__ . ' got null for $time parameter' );
        }
 
        return new static( $title, $repo, $time, null );
    }
 
    public static function newFromArchiveName( $title, $repo, $archiveName ) {
        return new static( $title, $repo, null, $archiveName );
    }
 
    public static function newFromRow( $row, $repo ) {
        $title = Title::makeTitle( NS_FILE, $row->oi_name );
        $file = new static( $title, $repo, null, $row->oi_archive_name );
        $file->loadFromRow( $row, 'oi_' );
 
        return $file;
    }
 
    public static function newFromKey( $sha1, $repo, $timestamp = false ) {
        $dbr = $repo->getReplicaDB();
        $queryBuilder = FileSelectQueryBuilder::newForOldFile( $dbr );
 
        $queryBuilder->where( [ 'oi_sha1' => $sha1 ] );
        if ( $timestamp ) {
            $queryBuilder->andWhere( [ 'oi_timestamp' => $dbr->timestamp( $timestamp ) ] );
        }
 
        $row = $queryBuilder->caller( __METHOD__ )->fetchRow();
        if ( $row ) {
            return static::newFromRow( $row, $repo );
        } else {
            return false;
        }
    }
 
    public static function getQueryInfo( array $options = [] ) {
        $dbr = MediaWikiServices::getInstance()->getConnectionProvider()->getReplicaDatabase();
        $queryInfo = FileSelectQueryBuilder::newForOldFile( $dbr, $options )->getQueryInfo();
        return [
            'tables' => $queryInfo['tables'],
            'fields' => $queryInfo['fields'],
            'joins' => $queryInfo['join_conds'],
        ];
    }
 
    public function __construct( $title, $repo, $time, $archiveName ) {
        parent::__construct( $title, $repo );
        $this->requestedTime = $time;
        $this->archive_name = $archiveName;
        if ( $time === null && $archiveName === null ) {
            throw new LogicException( __METHOD__ . ': must specify at least one of $time or $archiveName' );
        }
    }
 
    public function loadFromRow( $row, $prefix = 'img_' ) {
        $this->archive_name = $row->{"{$prefix}archive_name"};
        $this->deleted = $row->{"{$prefix}deleted"};
        $row = clone $row;
        unset( $row->{"{$prefix}archive_name"} );
        unset( $row->{"{$prefix}deleted"} );
        parent::loadFromRow( $row, $prefix );
    }
 
    protected function getCacheKey() {
        return false;
    }
 
    public function getArchiveName() {
        if ( $this->archive_name === null ) {
            $this->load();
        }
 
        return $this->archive_name;
    }
 
    public function isOld() {
        return true;
    }
 
    public function isVisible() {
        return $this->exists() && !$this->isDeleted( File::DELETED_FILE );
    }
 
    protected function loadFromDB( $flags = 0 ) {
        $this->dataLoaded = true;
 
        $dbr = ( $flags & IDBAccessObject::READ_LATEST )
            ? $this->repo->getPrimaryDB()
            : $this->repo->getReplicaDB();
        $queryBuilder = $this->buildQueryBuilderForLoad( $dbr, [] );
        $row = $queryBuilder->caller( __METHOD__ )->fetchRow();
        if ( $row ) {
            $this->loadFromRow( $row, 'oi_' );
        } else {
            $this->fileExists = false;
        }
    }
 
    protected function loadExtraFromDB() {
        $this->extraDataLoaded = true;
        $dbr = $this->repo->getReplicaDB();
        $queryBuilder = $this->buildQueryBuilderForLoad( $dbr );
 
        // In theory the file could have just been renamed/deleted...oh well
        $row = $queryBuilder->caller( __METHOD__ )->fetchRow();
 
        if ( !$row ) { // fallback to primary DB
            $dbr = $this->repo->getPrimaryDB();
            $queryBuilder = $this->buildQueryBuilderForLoad( $dbr );
            $row = $queryBuilder->caller( __METHOD__ )->fetchRow();
        }
 
        if ( $row ) {
            foreach ( $this->unprefixRow( $row, 'oi_' ) as $name => $value ) {
                $this->$name = $value;
            }
        } else {
            throw new RuntimeException( "Could not find data for image '{$this->archive_name}'." );
        }
    }
 
    private function buildQueryBuilderForLoad( IReadableDatabase $dbr, $options = [ 'omit-nonlazy' ] ) {
        $queryBuilder = FileSelectQueryBuilder::newForOldFile( $dbr, $options );
        $queryBuilder->where( [ 'oi_name' => $this->getName() ] )
            ->orderBy( 'oi_timestamp', SelectQueryBuilder::SORT_DESC );
        if ( $this->requestedTime === null ) {
            $queryBuilder->andWhere( [ 'oi_archive_name' => $this->archive_name ] );
        } else {
            $queryBuilder->andWhere( [ 'oi_timestamp' => $dbr->timestamp( $this->requestedTime ) ] );
        }
        return $queryBuilder;
    }
 
    protected function getCacheFields( $prefix = 'img_' ) {
        $fields = parent::getCacheFields( $prefix );
        $fields[] = $prefix . 'archive_name';
        $fields[] = $prefix . 'deleted';
 
        return $fields;
    }
 
    public function getRel() {
        return $this->getArchiveRel( $this->getArchiveName() );
    }
 
    public function getUrlRel() {
        return $this->getArchiveRel( rawurlencode( $this->getArchiveName() ) );
    }
 
    public function upgradeRow() {
        $this->loadFromFile();
 
        # Don't destroy file info of missing files
        if ( !$this->fileExists ) {
            wfDebug( __METHOD__ . ": file does not exist, aborting" );
 
            return;
        }
 
        $dbw = $this->repo->getPrimaryDB();
        [ $major, $minor ] = self::splitMime( $this->mime );
        $metadata = $this->getMetadataForDb( $dbw );
 
        wfDebug( __METHOD__ . ': upgrading ' . $this->archive_name . " to the current schema" );
        $dbw->newUpdateQueryBuilder()
            ->update( 'oldimage' )
            ->set( [
                'oi_size' => $this->size,
                'oi_width' => $this->width,
                'oi_height' => $this->height,
                'oi_bits' => $this->bits,
                'oi_media_type' => $this->media_type,
                'oi_major_mime' => $major,
                'oi_minor_mime' => $minor,
                'oi_metadata' => $metadata,
                'oi_sha1' => $this->sha1,
            ] )
            ->where( [
                'oi_name' => $this->getName(),
                'oi_archive_name' => $this->archive_name,
            ] )
            ->caller( __METHOD__ )->execute();
 
        $migrationStage = MediaWikiServices::getInstance()->getMainConfig()->get(
            MainConfigNames::FileSchemaMigrationStage
        );
        if ( $migrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
            $dbw->newUpdateQueryBuilder()
                ->update( 'filerevision' )
                ->set( [
                    'fr_size' => $this->size,
                    'fr_width' => $this->width,
                    'fr_height' => $this->height,
                    'fr_bits' => $this->bits,
                    'fr_metadata' => $metadata,
                    'fr_sha1' => $this->sha1,
                ] )
                ->where( [
                    'fr_file' => $this->acquireFileIdFromName(),
                    'fr_archive_name' => $this->archive_name,
                ] )
                ->caller( __METHOD__ )->execute();
        }
    }
 
    protected function reserializeMetadata() {
        // TODO: implement this and make it possible to hit it from refreshImageMetadata.php
        // It can be hit from action=purge but that's not very useful if the
        // goal is to reserialize the whole oldimage table.
    }
 
    public function isDeleted( $field ) {
        $this->load();
 
        return ( $this->deleted & $field ) == $field;
    }
 
    public function getVisibility() {
        $this->load();
 
        return (int)$this->deleted;
    }
 
    public function userCan( $field, Authority $performer ) {
        $this->load();
 
        return RevisionRecord::userCanBitfield(
            $this->deleted,
            $field,
            $performer
        );
    }
 
    public function uploadOld( $srcPath, $timestamp, $comment, UserIdentity $user ) {
        $archiveName = $this->getArchiveName();
        $dstRel = $this->getArchiveRel( $archiveName );
        $status = $this->publishTo( $srcPath, $dstRel );
 
        if ( $status->isGood() &&
            !$this->recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user )
        ) {
            $status->fatal( 'filenotfound', $srcPath );
        }
 
        return $status;
    }
 
    protected function recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) {
        $dbw = $this->repo->getPrimaryDB();
 
        $services = MediaWikiServices::getInstance();
        $mwProps = new MWFileProps( $services->getMimeAnalyzer() );
        $props = $mwProps->getPropsFromPath( $srcPath, true );
        if ( !$props['fileExists'] ) {
            return false;
        }
        $this->setProps( $props );
 
        $dbw->startAtomic( __METHOD__ );
 
        $commentFields = $services->getCommentStore()
            ->insert( $dbw, 'oi_description', $comment );
        $actorId = $services->getActorNormalization()
            ->acquireActorId( $user, $dbw );
        $dbw->newInsertQueryBuilder()
            ->insertInto( 'oldimage' )
            ->row( [
                'oi_name' => $this->getName(),
                'oi_archive_name' => $archiveName,
                'oi_size' => $props['size'],
                'oi_width' => intval( $props['width'] ),
                'oi_height' => intval( $props['height'] ),
                'oi_bits' => $props['bits'],
                'oi_actor' => $actorId,
                'oi_timestamp' => $dbw->timestamp( $timestamp ),
                'oi_metadata' => $this->getMetadataForDb( $dbw ),
                'oi_media_type' => $props['media_type'],
                'oi_major_mime' => $props['major_mime'],
                'oi_minor_mime' => $props['minor_mime'],
                'oi_sha1' => $props['sha1'],
            ] + $commentFields )
            ->caller( __METHOD__ )->execute();
 
        $migrationStage = MediaWikiServices::getInstance()->getMainConfig()->get(
            MainConfigNames::FileSchemaMigrationStage
        );
        if ( $migrationStage & SCHEMA_COMPAT_WRITE_NEW ) {
            $commentFields = $services->getCommentStore()
                ->insert( $dbw, 'fr_description', $comment );
            $dbw->newInsertQueryBuilder()
                ->insertInto( 'filerevision' )
                ->ignore()
                ->row( [
                        'fr_file' => $this->acquireFileIdFromName(),
                        'fr_size' => $this->size,
                        'fr_width' => intval( $this->width ),
                        'fr_height' => intval( $this->height ),
                        'fr_bits' => $this->bits,
                        'fr_actor' => $actorId,
                        'fr_deleted' => 0,
                        'fr_timestamp' => $dbw->timestamp( $timestamp ),
                        'fr_metadata' => $this->getMetadataForDb( $dbw ),
                        'fr_sha1' => $this->sha1
                    ] + $commentFields )
                ->caller( __METHOD__ )->execute();
        }
 
        $dbw->endAtomic( __METHOD__ );
 
        return true;
    }
 
    public function exists() {
        $archiveName = $this->getArchiveName();
        if ( $archiveName === '' || !is_string( $archiveName ) ) {
            return false;
        }
        return parent::exists();
    }
}