97 lines
3.3 KiB
PHP
97 lines
3.3 KiB
PHP
<?php
|
|
/**
|
|
* Helper class for representing operations with transaction support.
|
|
*
|
|
* 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
|
|
* @author Aaron Schulz
|
|
*/
|
|
|
|
/**
|
|
* Copy a file from one storage path to another in the backend.
|
|
* Parameters for this operation are outlined in FileBackend::doOperations().
|
|
*/
|
|
class CopyFileOp extends FileOp {
|
|
protected function allowedParams() {
|
|
return [
|
|
[ 'src', 'dst' ],
|
|
[ 'overwrite', 'overwriteSame', 'ignoreMissingSource', 'headers' ],
|
|
[ 'src', 'dst' ]
|
|
];
|
|
}
|
|
|
|
protected function doPrecheck( array &$predicates ) {
|
|
$status = StatusValue::newGood();
|
|
// Check if the source file exists
|
|
if ( !$this->fileExists( $this->params['src'], $predicates ) ) {
|
|
if ( $this->getParam( 'ignoreMissingSource' ) ) {
|
|
$this->doOperation = false; // no-op
|
|
// Update file existence predicates (cache 404s)
|
|
$predicates['exists'][$this->params['src']] = false;
|
|
$predicates['sha1'][$this->params['src']] = false;
|
|
|
|
return $status; // nothing to do
|
|
} else {
|
|
$status->fatal( 'backend-fail-notexists', $this->params['src'] );
|
|
|
|
return $status;
|
|
}
|
|
// Check if a file can be placed/changed at the destination
|
|
} elseif ( !$this->backend->isPathUsableInternal( $this->params['dst'] ) ) {
|
|
$status->fatal( 'backend-fail-usable', $this->params['dst'] );
|
|
$status->fatal( 'backend-fail-copy', $this->params['src'], $this->params['dst'] );
|
|
|
|
return $status;
|
|
}
|
|
// Check if destination file exists
|
|
$status->merge( $this->precheckDestExistence( $predicates ) );
|
|
$this->params['dstExists'] = $this->destExists; // see FileBackendStore::setFileCache()
|
|
if ( $status->isOK() ) {
|
|
// Update file existence predicates
|
|
$predicates['exists'][$this->params['dst']] = true;
|
|
$predicates['sha1'][$this->params['dst']] = $this->sourceSha1;
|
|
}
|
|
|
|
return $status; // safe to call attempt()
|
|
}
|
|
|
|
protected function doAttempt() {
|
|
if ( $this->overwriteSameCase ) {
|
|
$status = StatusValue::newGood(); // nothing to do
|
|
} elseif ( $this->params['src'] === $this->params['dst'] ) {
|
|
// Just update the destination file headers
|
|
$headers = $this->getParam( 'headers' ) ?: [];
|
|
$status = $this->backend->describeInternal( $this->setFlags( [
|
|
'src' => $this->params['dst'], 'headers' => $headers
|
|
] ) );
|
|
} else {
|
|
// Copy the file to the destination
|
|
$status = $this->backend->copyInternal( $this->setFlags( $this->params ) );
|
|
}
|
|
|
|
return $status;
|
|
}
|
|
|
|
public function storagePathsRead() {
|
|
return [ $this->params['src'] ];
|
|
}
|
|
|
|
public function storagePathsChanged() {
|
|
return [ $this->params['dst'] ];
|
|
}
|
|
}
|