1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @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 {
protected function allowedParams() {
return [
[ 'content', 'dst' ],
[ 'overwrite', 'overwriteSame', 'headers' ],
[ 'dst' ]
];
}
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()
}
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() {
return strlen( $this->params['content'] );
}
protected function getSourceSha1Base36() {
return \Wikimedia\base_convert( sha1( $this->params['content'] ), 16, 36, 31 );
}
public function storagePathsChanged() {
return [ $this->params['dst'] ];
}
}
/** @deprecated class alias since 1.43 */
class_alias( CreateFileOp::class, 'CreateFileOp' );
|
