summaryrefslogtreecommitdiff
path: root/www/wiki/includes/libs/filebackend/fileop/MoveFileOp.php
diff options
context:
space:
mode:
Diffstat (limited to 'www/wiki/includes/libs/filebackend/fileop/MoveFileOp.php')
-rw-r--r--www/wiki/includes/libs/filebackend/fileop/MoveFileOp.php106
1 files changed, 106 insertions, 0 deletions
diff --git a/www/wiki/includes/libs/filebackend/fileop/MoveFileOp.php b/www/wiki/includes/libs/filebackend/fileop/MoveFileOp.php
new file mode 100644
index 00000000..55dca516
--- /dev/null
+++ b/www/wiki/includes/libs/filebackend/fileop/MoveFileOp.php
@@ -0,0 +1,106 @@
+<?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
+ */
+
+/**
+ * Move a file from one storage path to another in the backend.
+ * Parameters for this operation are outlined in FileBackend::doOperations().
+ */
+class MoveFileOp 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-move', $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['src']] = false;
+ $predicates['sha1'][$this->params['src']] = false;
+ $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 ) {
+ if ( $this->params['src'] === $this->params['dst'] ) {
+ // Do nothing to the destination (which is also the source)
+ $status = StatusValue::newGood();
+ } else {
+ // Just delete the source as the destination file needs no changes
+ $status = $this->backend->deleteInternal( $this->setFlags(
+ [ 'src' => $this->params['src'] ]
+ ) );
+ }
+ } 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 {
+ // Move the file to the destination
+ $status = $this->backend->moveInternal( $this->setFlags( $this->params ) );
+ }
+
+ return $status;
+ }
+
+ public function storagePathsRead() {
+ return [ $this->params['src'] ];
+ }
+
+ public function storagePathsChanged() {
+ return [ $this->params['src'], $this->params['dst'] ];
+ }
+}