Page MenuHomeWickedGov Phorge
Files F4097514

CreateFileOp.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

CreateFileOp.php
View Options

<?php
/**
* @license GPL-2.0-or-later
* @file
* @ingroup FileBackend
*/
namespace Wikimedia\FileBackend\FileOps;
use StatusValue;
/**
* Create a file in the backend with the given content.
* Parameters for this operation are outlined in FileBackend::doOperations().
*/
class CreateFileOp extends FileOp {
/** @inheritDoc */
protected function allowedParams() {
return [
[ 'content', 'dst' ],
[ 'overwrite', 'overwriteSame', 'headers' ],
[ 'dst' ]
];
}
/** @inheritDoc */
protected function doPrecheck(
FileStatePredicates $opPredicates,
FileStatePredicates $batchPredicates
) {
$status = StatusValue::newGood();
// Check if the source data 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 = $this->getSourceSha1Base36();
$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()
}
/** @inheritDoc */
protected function doAttempt() {
if ( $this->overwriteSameCase ) {
$status = StatusValue::newGood(); // nothing to do
} else {
// Create the file at the destination
$status = $this->backend->createInternal( $this->setFlags( $this->params ) );
}
return $status;
}
protected function getSourceSize(): int {
return strlen( $this->params['content'] );
}
protected function getSourceSha1Base36(): string {
return \Wikimedia\base_convert( sha1( $this->params['content'] ), 16, 36, 31 );
}
/** @inheritDoc */
public function storagePathsChanged() {
return [ $this->params['dst'] ];
}
}
/** @deprecated class alias since 1.43 */
class_alias( CreateFileOp::class, 'CreateFileOp' );

File Metadata

Mime Type
text/x-php
Expires
Tue, Aug 18, 14:55 (3 w, 6 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
66/d7/975262d6941c5c4ad7f68463ad44
Default Alt Text
CreateFileOp.php (2 KB)

Event Timeline