StoreFileOp.php

Go to the documentation of this file.

<?php
namespace Wikimedia\FileBackend\FileOps;
 
use StatusValue;
use Wikimedia\AtEase\AtEase;
 
class StoreFileOp extends FileOp {
    protected function allowedParams() {
        return [
            [ 'src', 'dst' ],
            [ 'overwrite', 'overwriteSame', 'headers' ],
            [ 'src', 'dst' ]
        ];
    }
 
    protected function doPrecheck(
        FileStatePredicates $opPredicates,
        FileStatePredicates $batchPredicates
    ) {
        $status = StatusValue::newGood();
 
        // Check if the source file exists in the file system
        if ( !is_file( $this->params['src'] ) ) {
            $status->fatal( 'backend-fail-notexists', $this->params['src'] );
 
            return $status;
        }
        // Check if the source file is too big
        $sourceSize = $this->getSourceSize();
        $maxFileSize = $this->backend->maxFileSizeInternal();
        if ( $sourceSize > $maxFileSize ) {
            $status->fatal( 'backend-fail-maxsize', $this->params['dst'], $maxFileSize );
 
            return $status;
        }
        // Check if an incompatible destination file exists
        $sourceSha1 = function () {
            static $sha1 = null;
            $sha1 ??= $this->getSourceSha1Base36();
            return $sha1;
        };
        $status->merge( $this->precheckDestExistence( $opPredicates, $sourceSize, $sourceSha1 ) );
        $this->params['dstExists'] = $this->destExists; // see FileBackendStore::setFileCache()
 
        // Update file existence predicates if the operation is expected to be allowed to run
        if ( $status->isOK() ) {
            $batchPredicates->assumeFileExists( $this->params['dst'], $sourceSize, $sourceSha1 );
        }
 
        return $status; // safe to call attempt()
    }
 
    protected function doAttempt() {
        if ( $this->overwriteSameCase ) {
            $status = StatusValue::newGood(); // nothing to do
        } else {
            // Store the file at the destination
            $status = $this->backend->storeInternal( $this->setFlags( $this->params ) );
        }
 
        return $status;
    }
 
    protected function getSourceSize(): int {
        AtEase::suppressWarnings();
        $size = filesize( $this->params['src'] );
        AtEase::restoreWarnings();
 
        return $size;
    }
 
    protected function getSourceSha1Base36(): string {
        AtEase::suppressWarnings();
        $hash = sha1_file( $this->params['src'] );
        AtEase::restoreWarnings();
        if ( $hash !== false ) {
            $hash = \Wikimedia\base_convert( $hash, 16, 36, 31 );
        }
 
        return $hash;
    }
 
    public function storagePathsChanged() {
        return [ $this->params['dst'] ];
    }
}
 
class_alias( StoreFileOp::class, 'StoreFileOp' );