diff options
Diffstat (limited to 'www/wiki/includes/libs/filebackend/fileop/DescribeFileOp.php')
-rw-r--r-- | www/wiki/includes/libs/filebackend/fileop/DescribeFileOp.php | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/www/wiki/includes/libs/filebackend/fileop/DescribeFileOp.php b/www/wiki/includes/libs/filebackend/fileop/DescribeFileOp.php new file mode 100644 index 00000000..0d1e5532 --- /dev/null +++ b/www/wiki/includes/libs/filebackend/fileop/DescribeFileOp.php @@ -0,0 +1,64 @@ +<?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 + */ + +/** + * Change metadata for a file at the given storage path in the backend. + * Parameters for this operation are outlined in FileBackend::doOperations(). + */ +class DescribeFileOp extends FileOp { + protected function allowedParams() { + return [ [ 'src' ], [ 'headers' ], [ 'src' ] ]; + } + + protected function doPrecheck( array &$predicates ) { + $status = StatusValue::newGood(); + // Check if the source file exists + if ( !$this->fileExists( $this->params['src'], $predicates ) ) { + $status->fatal( 'backend-fail-notexists', $this->params['src'] ); + + return $status; + // Check if a file can be placed/changed at the source + } elseif ( !$this->backend->isPathUsableInternal( $this->params['src'] ) ) { + $status->fatal( 'backend-fail-usable', $this->params['src'] ); + $status->fatal( 'backend-fail-describe', $this->params['src'] ); + + return $status; + } + // Update file existence predicates + $predicates['exists'][$this->params['src']] = + $this->fileExists( $this->params['src'], $predicates ); + $predicates['sha1'][$this->params['src']] = + $this->fileSha1( $this->params['src'], $predicates ); + + 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'] ]; + } +} |