OldLocalFile.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;

class OldLocalFile extends LocalFile {
    protected $requestedTime;

    protected $archive_name;

    const CACHE_VERSION = 1;
    const MAX_CACHE_ROWS = 20;

    static function newFromTitle( $title, $repo, $time = null ) {
        # The null default value is only here to avoid an E_STRICT
        if ( $time === null ) {
            throw new MWException( __METHOD__ . ' got null for $time parameter' );
        }

        return new self( $title, $repo, $time, null );
    }

    static function newFromArchiveName( $title, $repo, $archiveName ) {
        return new self( $title, $repo, null, $archiveName );
    }

    static function newFromRow( $row, $repo ) {
        $title = Title::makeTitle( NS_FILE, $row->oi_name );
        $file = new self( $title, $repo, null, $row->oi_archive_name );
        $file->loadFromRow( $row, 'oi_' );

        return $file;
    }

    static function newFromKey( $sha1, $repo, $timestamp = false ) {
        $dbr = $repo->getReplicaDB();

        $conds = [ 'oi_sha1' => $sha1 ];
        if ( $timestamp ) {
            $conds['oi_timestamp'] = $dbr->timestamp( $timestamp );
        }

        $fileQuery = self::getQueryInfo();
        $row = $dbr->selectRow(
            $fileQuery['tables'], $fileQuery['fields'], $conds, __METHOD__, [], $fileQuery['joins']
        );
        if ( $row ) {
            return self::newFromRow( $row, $repo );
        } else {
            return false;
        }
    }

    static function selectFields() {
        global $wgActorTableSchemaMigrationStage;

        wfDeprecated( __METHOD__, '1.31' );
        if ( $wgActorTableSchemaMigrationStage & SCHEMA_COMPAT_READ_NEW ) {
            // If code is using this instead of self::getQueryInfo(), there's a
            // decent chance it's going to try to directly access
            // $row->oi_user or $row->oi_user_text and we can't give it
            // useful values here once those aren't being used anymore.
            throw new BadMethodCallException(
                'Cannot use ' . __METHOD__
                    . ' when $wgActorTableSchemaMigrationStage has SCHEMA_COMPAT_READ_NEW'
            );
        }

        return [
            'oi_name',
            'oi_archive_name',
            'oi_size',
            'oi_width',
            'oi_height',
            'oi_metadata',
            'oi_bits',
            'oi_media_type',
            'oi_major_mime',
            'oi_minor_mime',
            'oi_user',
            'oi_user_text',
            'oi_actor' => 'NULL',
            'oi_timestamp',
            'oi_deleted',
            'oi_sha1',
        ] + MediaWikiServices::getInstance()->getCommentStore()->getFields( 'oi_description' );
    }

    public static function getQueryInfo( array $options = [] ) {
        $commentQuery = MediaWikiServices::getInstance()->getCommentStore()->getJoin( 'oi_description' );
        $actorQuery = ActorMigration::newMigration()->getJoin( 'oi_user' );
        $ret = [
            'tables' => [ 'oldimage' ] + $commentQuery['tables'] + $actorQuery['tables'],
            'fields' => [
                'oi_name',
                'oi_archive_name',
                'oi_size',
                'oi_width',
                'oi_height',
                'oi_bits',
                'oi_media_type',
                'oi_major_mime',
                'oi_minor_mime',
                'oi_timestamp',
                'oi_deleted',
                'oi_sha1',
            ] + $commentQuery['fields'] + $actorQuery['fields'],
            'joins' => $commentQuery['joins'] + $actorQuery['joins'],
        ];

        if ( in_array( 'omit-nonlazy', $options, true ) ) {
            // Internal use only for getting only the lazy fields
            $ret['fields'] = [];
        }
        if ( !in_array( 'omit-lazy', $options, true ) ) {
            // Note: Keep this in sync with self::getLazyCacheFields()
            $ret['fields'][] = 'oi_metadata';
        }

        return $ret;
    }

    function __construct( $title, $repo, $time, $archiveName ) {
        parent::__construct( $title, $repo );
        $this->requestedTime = $time;
        $this->archive_name = $archiveName;
        if ( is_null( $time ) && is_null( $archiveName ) ) {
            throw new MWException( __METHOD__ . ': must specify at least one of $time or $archiveName' );
        }
    }

    function getCacheKey() {
        return false;
    }

    function getArchiveName() {
        if ( !isset( $this->archive_name ) ) {
            $this->load();
        }

        return $this->archive_name;
    }

    function isOld() {
        return true;
    }

    function isVisible() {
        return $this->exists() && !$this->isDeleted( File::DELETED_FILE );
    }

    function loadFromDB( $flags = 0 ) {
        $this->dataLoaded = true;

        $dbr = ( $flags & self::READ_LATEST )
            ? $this->repo->getMasterDB()
            : $this->repo->getReplicaDB();

        $conds = [ 'oi_name' => $this->getName() ];
        if ( is_null( $this->requestedTime ) ) {
            $conds['oi_archive_name'] = $this->archive_name;
        } else {
            $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime );
        }
        $fileQuery = static::getQueryInfo();
        $row = $dbr->selectRow(
            $fileQuery['tables'],
            $fileQuery['fields'],
            $conds,
            __METHOD__,
            [ 'ORDER BY' => 'oi_timestamp DESC' ],
            $fileQuery['joins']
        );
        if ( $row ) {
            $this->loadFromRow( $row, 'oi_' );
        } else {
            $this->fileExists = false;
        }
    }

    protected function loadExtraFromDB() {
        $this->extraDataLoaded = true;
        $dbr = $this->repo->getReplicaDB();
        $conds = [ 'oi_name' => $this->getName() ];
        if ( is_null( $this->requestedTime ) ) {
            $conds['oi_archive_name'] = $this->archive_name;
        } else {
            $conds['oi_timestamp'] = $dbr->timestamp( $this->requestedTime );
        }
        $fileQuery = static::getQueryInfo( [ 'omit-nonlazy' ] );
        // In theory the file could have just been renamed/deleted...oh well
        $row = $dbr->selectRow(
            $fileQuery['tables'],
            $fileQuery['fields'],
            $conds,
            __METHOD__,
            [ 'ORDER BY' => 'oi_timestamp DESC' ],
            $fileQuery['joins']
        );

        if ( !$row ) { // fallback to master
            $dbr = $this->repo->getMasterDB();
            $row = $dbr->selectRow(
                $fileQuery['tables'],
                $fileQuery['fields'],
                $conds,
                __METHOD__,
                [ 'ORDER BY' => 'oi_timestamp DESC' ],
                $fileQuery['joins']
            );
        }

        if ( $row ) {
            foreach ( $this->unprefixRow( $row, 'oi_' ) as $name => $value ) {
                $this->$name = $value;
            }
        } else {
            throw new MWException( "Could not find data for image '{$this->archive_name}'." );
        }
    }

    protected function getCacheFields( $prefix = 'img_' ) {
        $fields = parent::getCacheFields( $prefix );
        $fields[] = $prefix . 'archive_name';
        $fields[] = $prefix . 'deleted';

        return $fields;
    }

    function getRel() {
        return $this->getArchiveRel( $this->getArchiveName() );
    }

    function getUrlRel() {
        return $this->getArchiveRel( rawurlencode( $this->getArchiveName() ) );
    }

    function upgradeRow() {
        $this->loadFromFile();

        # Don't destroy file info of missing files
        if ( !$this->fileExists ) {
            wfDebug( __METHOD__ . ": file does not exist, aborting\n" );

            return;
        }

        $dbw = $this->repo->getMasterDB();
        list( $major, $minor ) = self::splitMime( $this->mime );

        wfDebug( __METHOD__ . ': upgrading ' . $this->archive_name . " to the current schema\n" );
        $dbw->update( 'oldimage',
            [
                'oi_size' => $this->size, // sanity
                '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' => $this->metadata,
                'oi_sha1' => $this->sha1,
            ], [
                'oi_name' => $this->getName(),
                'oi_archive_name' => $this->archive_name ],
            __METHOD__
        );
    }

    function isDeleted( $field ) {
        $this->load();

        return ( $this->deleted & $field ) == $field;
    }

    function getVisibility() {
        $this->load();

        return (int)$this->deleted;
    }

    function userCan( $field, User $user = null ) {
        $this->load();

        return Revision::userCanBitfield( $this->deleted, $field, $user );
    }

    public function uploadOld( $srcPath, $timestamp, $comment, $user ) {
        $this->lock();

        $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 );
        }

        $this->unlock();

        return $status;
    }

    protected function recordOldUpload( $srcPath, $archiveName, $timestamp, $comment, $user ) {
        $dbw = $this->repo->getMasterDB();

        $dstPath = $this->repo->getZonePath( 'public' ) . '/' . $this->getRel();
        $props = $this->repo->getFileProps( $dstPath );
        if ( !$props['fileExists'] ) {
            return false;
        }

        $commentFields = MediaWikiServices::getInstance()->getCommentStore()
            ->insert( $dbw, 'oi_description', $comment );
        $actorFields = ActorMigration::newMigration()->getInsertValues( $dbw, 'oi_user', $user );
        $dbw->insert( 'oldimage',
            [
                '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_timestamp' => $dbw->timestamp( $timestamp ),
                'oi_metadata' => $props['metadata'],
                'oi_media_type' => $props['media_type'],
                'oi_major_mime' => $props['major_mime'],
                'oi_minor_mime' => $props['minor_mime'],
                'oi_sha1' => $props['sha1'],
            ] + $commentFields + $actorFields, __METHOD__
        );

        return true;
    }

    public function exists() {
        $archiveName = $this->getArchiveName();
        if ( $archiveName === '' || !is_string( $archiveName ) ) {
            return false;
        }
        return parent::exists();
    }
}