DescribeFileOp.php

Go to the documentation of this file.

<?php
namespace Wikimedia\FileBackend\FileOps;
 
use StatusValue;
use Wikimedia\FileBackend\FileBackend;
 
class DescribeFileOp extends FileOp {
    protected function allowedParams() {
        return [ [ 'src' ], [ 'headers' ], [ 'src' ] ];
    }
 
    protected function doPrecheck(
        FileStatePredicates $opPredicates,
        FileStatePredicates $batchPredicates
    ) {
        $status = StatusValue::newGood();
 
        if ( !$this->backend->isPathUsableInternal( $this->params['src'] ) ) {
            $status->fatal( 'backend-fail-usable', $this->params['src'] );
 
            return $status;
        }
 
        // Check source file existence
        $srcExists = $this->resolveFileExistence( $this->params['src'], $opPredicates );
        if ( $srcExists === false ) {
            $status->fatal( 'backend-fail-notexists', $this->params['src'] );
 
            return $status;
        } elseif ( $srcExists === FileBackend::EXISTENCE_ERROR ) {
            $status->fatal( 'backend-fail-stat', $this->params['src'] );
 
            return $status;
        }
 
        // Update file existence predicates since the operation is expected to be allowed to run
        $srcSize = function () use ( $opPredicates ) {
            static $size = null;
            $size ??= $this->resolveFileSize( $this->params['src'], $opPredicates );
            return $size;
        };
        $srcSha1 = function () use ( $opPredicates ) {
            static $sha1 = null;
            $sha1 ??= $this->resolveFileSha1Base36( $this->params['src'], $opPredicates );
            return $sha1;
        };
        $batchPredicates->assumeFileExists( $this->params['src'], $srcSize, $srcSha1 );
 
        return $status; // safe to call attempt()
    }
 
    protected function doAttempt() {
        // Update the source file's metadata
        return $this->backend->describeInternal( $this->setFlags( $this->params ) );
    }
 
    public function storagePathsChanged() {
        return [ $this->params['src'] ];
    }
}
 
class_alias( DescribeFileOp::class, 'DescribeFileOp' );