522 lines
18 KiB
PHP
522 lines
18 KiB
PHP
<?php
|
|
/**
|
|
* @author Bart Visscher <bartv@thisnet.nl>
|
|
* @author Björn Schießle <schiessle@owncloud.com>
|
|
* @author Jakob Sack <mail@jakobsack.de>
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
* @author Lukas Reschke <lukas@owncloud.com>
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
* @author Owen Winkler <a_github@midnightcircus.com>
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
|
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
* @author Thomas Tanghus <thomas@tanghus.net>
|
|
* @author Vincent Petry <pvince81@owncloud.com>
|
|
*
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
* @license AGPL-3.0
|
|
*
|
|
* This code is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation.
|
|
*
|
|
* 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 Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License, version 3,
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
*
|
|
*/
|
|
|
|
namespace OCA\DAV\Connector\Sabre;
|
|
|
|
use OC\Files\Filesystem;
|
|
use OCA\DAV\Connector\Sabre\Exception\EntityTooLarge;
|
|
use OCA\DAV\Connector\Sabre\Exception\FileLocked;
|
|
use OCA\DAV\Connector\Sabre\Exception\Forbidden as DAVForbiddenException;
|
|
use OCA\DAV\Connector\Sabre\Exception\UnsupportedMediaType;
|
|
use OCP\Encryption\Exceptions\GenericEncryptionException;
|
|
use OCP\Files\EntityTooLargeException;
|
|
use OCP\Files\ForbiddenException;
|
|
use OCP\Files\InvalidContentException;
|
|
use OCP\Files\InvalidPathException;
|
|
use OCP\Files\LockNotAcquiredException;
|
|
use OCP\Files\NotPermittedException;
|
|
use OCP\Files\StorageNotAvailableException;
|
|
use OCP\Lock\ILockingProvider;
|
|
use OCP\Lock\LockedException;
|
|
use Sabre\DAV\Exception;
|
|
use Sabre\DAV\Exception\BadRequest;
|
|
use Sabre\DAV\Exception\Forbidden;
|
|
use Sabre\DAV\Exception\NotImplemented;
|
|
use Sabre\DAV\Exception\ServiceUnavailable;
|
|
use Sabre\DAV\IFile;
|
|
|
|
class File extends Node implements IFile {
|
|
|
|
/**
|
|
* Updates the data
|
|
*
|
|
* The data argument is a readable stream resource.
|
|
*
|
|
* After a successful put operation, you may choose to return an ETag. The
|
|
* etag must always be surrounded by double-quotes. These quotes must
|
|
* appear in the actual string you're returning.
|
|
*
|
|
* Clients may use the ETag from a PUT request to later on make sure that
|
|
* when they update the file, the contents haven't changed in the mean
|
|
* time.
|
|
*
|
|
* If you don't plan to store the file byte-by-byte, and you return a
|
|
* different object on a subsequent GET you are strongly recommended to not
|
|
* return an ETag, and just return null.
|
|
*
|
|
* @param resource $data
|
|
*
|
|
* @throws Forbidden
|
|
* @throws UnsupportedMediaType
|
|
* @throws BadRequest
|
|
* @throws Exception
|
|
* @throws EntityTooLarge
|
|
* @throws ServiceUnavailable
|
|
* @throws FileLocked
|
|
* @return string|null
|
|
*/
|
|
public function put($data) {
|
|
try {
|
|
$exists = $this->fileView->file_exists($this->path);
|
|
if ($this->info && $exists && !$this->info->isUpdateable()) {
|
|
throw new Forbidden();
|
|
}
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new ServiceUnavailable("File is not updatable: " . $e->getMessage());
|
|
}
|
|
|
|
// verify path of the target
|
|
$this->verifyPath();
|
|
|
|
// chunked handling
|
|
if (isset($_SERVER['HTTP_OC_CHUNKED'])) {
|
|
try {
|
|
return $this->createFileChunked($data);
|
|
} catch (\Exception $e) {
|
|
$this->convertToSabreException($e);
|
|
}
|
|
}
|
|
|
|
list($partStorage) = $this->fileView->resolvePath($this->path);
|
|
$needsPartFile = $this->needsPartFile($partStorage) && (strlen($this->path) > 1);
|
|
|
|
if ($needsPartFile) {
|
|
// mark file as partial while uploading (ignored by the scanner)
|
|
$partFilePath = $this->path . '.ocTransferId' . rand() . '.part';
|
|
} else {
|
|
// upload file directly as the final path
|
|
$partFilePath = $this->path;
|
|
}
|
|
|
|
// the part file and target file might be on a different storage in case of a single file storage (e.g. single file share)
|
|
/** @var \OC\Files\Storage\Storage $partStorage */
|
|
list($partStorage, $internalPartPath) = $this->fileView->resolvePath($partFilePath);
|
|
/** @var \OC\Files\Storage\Storage $storage */
|
|
list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
|
|
try {
|
|
$target = $partStorage->fopen($internalPartPath, 'wb');
|
|
if ($target === false) {
|
|
\OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::fopen() failed', \OCP\Util::ERROR);
|
|
// because we have no clue about the cause we can only throw back a 500/Internal Server Error
|
|
throw new Exception('Could not write file contents');
|
|
}
|
|
list($count,) = \OC_Helper::streamCopy($data, $target);
|
|
fclose($target);
|
|
|
|
// if content length is sent by client:
|
|
// double check if the file was fully received
|
|
// compare expected and actual size
|
|
if (isset($_SERVER['CONTENT_LENGTH']) && $_SERVER['REQUEST_METHOD'] !== 'LOCK') {
|
|
$expected = $_SERVER['CONTENT_LENGTH'];
|
|
if ($count != $expected) {
|
|
throw new BadRequest('expected filesize ' . $expected . ' got ' . $count);
|
|
}
|
|
}
|
|
|
|
} catch (\Exception $e) {
|
|
if ($needsPartFile) {
|
|
$partStorage->unlink($internalPartPath);
|
|
}
|
|
$this->convertToSabreException($e);
|
|
}
|
|
|
|
try {
|
|
$view = \OC\Files\Filesystem::getView();
|
|
if ($view) {
|
|
$run = $this->emitPreHooks($exists);
|
|
} else {
|
|
$run = true;
|
|
}
|
|
|
|
try {
|
|
$this->changeLock(ILockingProvider::LOCK_EXCLUSIVE);
|
|
} catch (LockedException $e) {
|
|
if ($needsPartFile) {
|
|
$partStorage->unlink($internalPartPath);
|
|
}
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
|
|
if ($needsPartFile) {
|
|
// rename to correct path
|
|
try {
|
|
if ($run) {
|
|
$renameOkay = $storage->moveFromStorage($partStorage, $internalPartPath, $internalPath);
|
|
$fileExists = $storage->file_exists($internalPath);
|
|
}
|
|
if (!$run || $renameOkay === false || $fileExists === false) {
|
|
\OCP\Util::writeLog('webdav', 'renaming part file to final file failed', \OCP\Util::ERROR);
|
|
throw new Exception('Could not rename part file to final file');
|
|
}
|
|
} catch (ForbiddenException $ex) {
|
|
throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
|
|
} catch (\Exception $e) {
|
|
$partStorage->unlink($internalPartPath);
|
|
$this->convertToSabreException($e);
|
|
}
|
|
}
|
|
|
|
try {
|
|
$this->changeLock(ILockingProvider::LOCK_SHARED);
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
|
|
// since we skipped the view we need to scan and emit the hooks ourselves
|
|
$storage->getUpdater()->update($internalPath);
|
|
|
|
if ($view) {
|
|
$this->emitPostHooks($exists);
|
|
}
|
|
|
|
// allow sync clients to send the mtime along in a header
|
|
$request = \OC::$server->getRequest();
|
|
if (isset($request->server['HTTP_X_OC_MTIME'])) {
|
|
if ($this->fileView->touch($this->path, $request->server['HTTP_X_OC_MTIME'])) {
|
|
header('X-OC-MTime: accepted');
|
|
}
|
|
}
|
|
$this->refreshInfo();
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new ServiceUnavailable("Failed to check file size: " . $e->getMessage());
|
|
}
|
|
|
|
return '"' . $this->info->getEtag() . '"';
|
|
}
|
|
|
|
/**
|
|
* @param string $path
|
|
*/
|
|
private function emitPreHooks($exists, $path = null) {
|
|
if (is_null($path)) {
|
|
$path = $this->path;
|
|
}
|
|
$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
|
|
$run = true;
|
|
|
|
if (!$exists) {
|
|
\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_create, array(
|
|
\OC\Files\Filesystem::signal_param_path => $hookPath,
|
|
\OC\Files\Filesystem::signal_param_run => &$run,
|
|
));
|
|
} else {
|
|
\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_update, array(
|
|
\OC\Files\Filesystem::signal_param_path => $hookPath,
|
|
\OC\Files\Filesystem::signal_param_run => &$run,
|
|
));
|
|
}
|
|
\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_write, array(
|
|
\OC\Files\Filesystem::signal_param_path => $hookPath,
|
|
\OC\Files\Filesystem::signal_param_run => &$run,
|
|
));
|
|
return $run;
|
|
}
|
|
|
|
/**
|
|
* @param string $path
|
|
*/
|
|
private function emitPostHooks($exists, $path = null) {
|
|
if (is_null($path)) {
|
|
$path = $this->path;
|
|
}
|
|
$hookPath = Filesystem::getView()->getRelativePath($this->fileView->getAbsolutePath($path));
|
|
if (!$exists) {
|
|
\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_create, array(
|
|
\OC\Files\Filesystem::signal_param_path => $hookPath
|
|
));
|
|
} else {
|
|
\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_update, array(
|
|
\OC\Files\Filesystem::signal_param_path => $hookPath
|
|
));
|
|
}
|
|
\OC_Hook::emit(\OC\Files\Filesystem::CLASSNAME, \OC\Files\Filesystem::signal_post_write, array(
|
|
\OC\Files\Filesystem::signal_param_path => $hookPath
|
|
));
|
|
}
|
|
|
|
/**
|
|
* Returns the data
|
|
*
|
|
* @return resource
|
|
* @throws Forbidden
|
|
* @throws ServiceUnavailable
|
|
*/
|
|
public function get() {
|
|
//throw exception if encryption is disabled but files are still encrypted
|
|
try {
|
|
$res = $this->fileView->fopen(ltrim($this->path, '/'), 'rb');
|
|
if ($res === false) {
|
|
throw new ServiceUnavailable("Could not open file");
|
|
}
|
|
return $res;
|
|
} catch (GenericEncryptionException $e) {
|
|
// returning 503 will allow retry of the operation at a later point in time
|
|
throw new ServiceUnavailable("Encryption not ready: " . $e->getMessage());
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new ServiceUnavailable("Failed to open file: " . $e->getMessage());
|
|
} catch (ForbiddenException $ex) {
|
|
throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete the current file
|
|
*
|
|
* @throws Forbidden
|
|
* @throws ServiceUnavailable
|
|
*/
|
|
public function delete() {
|
|
if (!$this->info->isDeletable()) {
|
|
throw new Forbidden();
|
|
}
|
|
|
|
try {
|
|
if (!$this->fileView->unlink($this->path)) {
|
|
// assume it wasn't possible to delete due to permissions
|
|
throw new Forbidden();
|
|
}
|
|
} catch (StorageNotAvailableException $e) {
|
|
throw new ServiceUnavailable("Failed to unlink: " . $e->getMessage());
|
|
} catch (ForbiddenException $ex) {
|
|
throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
|
|
} catch (LockedException $e) {
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the mime-type for a file
|
|
*
|
|
* If null is returned, we'll assume application/octet-stream
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getContentType() {
|
|
$mimeType = $this->info->getMimetype();
|
|
|
|
// PROPFIND needs to return the correct mime type, for consistency with the web UI
|
|
if (isset($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PROPFIND') {
|
|
return $mimeType;
|
|
}
|
|
return \OC_Helper::getSecureMimeType($mimeType);
|
|
}
|
|
|
|
/**
|
|
* @return array|false
|
|
*/
|
|
public function getDirectDownload() {
|
|
if (\OCP\App::isEnabled('encryption')) {
|
|
return [];
|
|
}
|
|
/** @var \OCP\Files\Storage $storage */
|
|
list($storage, $internalPath) = $this->fileView->resolvePath($this->path);
|
|
if (is_null($storage)) {
|
|
return [];
|
|
}
|
|
|
|
return $storage->getDirectDownload($internalPath);
|
|
}
|
|
|
|
/**
|
|
* @param resource $data
|
|
* @return null|string
|
|
* @throws Exception
|
|
* @throws BadRequest
|
|
* @throws NotImplemented
|
|
* @throws ServiceUnavailable
|
|
*/
|
|
private function createFileChunked($data) {
|
|
list($path, $name) = \Sabre\HTTP\URLUtil::splitPath($this->path);
|
|
|
|
$info = \OC_FileChunking::decodeName($name);
|
|
if (empty($info)) {
|
|
throw new NotImplemented('Invalid chunk name');
|
|
}
|
|
|
|
$chunk_handler = new \OC_FileChunking($info);
|
|
$bytesWritten = $chunk_handler->store($info['index'], $data);
|
|
|
|
//detect aborted upload
|
|
if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT') {
|
|
if (isset($_SERVER['CONTENT_LENGTH'])) {
|
|
$expected = $_SERVER['CONTENT_LENGTH'];
|
|
if ($bytesWritten != $expected) {
|
|
$chunk_handler->remove($info['index']);
|
|
throw new BadRequest(
|
|
'expected filesize ' . $expected . ' got ' . $bytesWritten);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($chunk_handler->isComplete()) {
|
|
list($storage,) = $this->fileView->resolvePath($path);
|
|
$needsPartFile = $this->needsPartFile($storage);
|
|
$partFile = null;
|
|
|
|
$targetPath = $path . '/' . $info['name'];
|
|
/** @var \OC\Files\Storage\Storage $targetStorage */
|
|
list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
|
|
|
|
$exists = $this->fileView->file_exists($targetPath);
|
|
|
|
try {
|
|
$this->fileView->lockFile($targetPath, ILockingProvider::LOCK_SHARED);
|
|
|
|
$this->emitPreHooks($exists, $targetPath);
|
|
$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_EXCLUSIVE);
|
|
/** @var \OC\Files\Storage\Storage $targetStorage */
|
|
list($targetStorage, $targetInternalPath) = $this->fileView->resolvePath($targetPath);
|
|
|
|
if ($needsPartFile) {
|
|
// we first assembly the target file as a part file
|
|
$partFile = $path . '/' . $info['name'] . '.ocTransferId' . $info['transferid'] . '.part';
|
|
/** @var \OC\Files\Storage\Storage $targetStorage */
|
|
list($partStorage, $partInternalPath) = $this->fileView->resolvePath($partFile);
|
|
|
|
|
|
$chunk_handler->file_assemble($partStorage, $partInternalPath, $this->fileView->getAbsolutePath($targetPath));
|
|
|
|
// here is the final atomic rename
|
|
$renameOkay = $targetStorage->moveFromStorage($partStorage, $partInternalPath, $targetInternalPath);
|
|
$fileExists = $targetStorage->file_exists($targetInternalPath);
|
|
if ($renameOkay === false || $fileExists === false) {
|
|
\OCP\Util::writeLog('webdav', '\OC\Files\Filesystem::rename() failed', \OCP\Util::ERROR);
|
|
// only delete if an error occurred and the target file was already created
|
|
if ($fileExists) {
|
|
// set to null to avoid double-deletion when handling exception
|
|
// stray part file
|
|
$partFile = null;
|
|
$targetStorage->unlink($targetInternalPath);
|
|
}
|
|
$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
|
|
throw new Exception('Could not rename part file assembled from chunks');
|
|
}
|
|
} else {
|
|
// assemble directly into the final file
|
|
$chunk_handler->file_assemble($targetStorage, $targetInternalPath, $this->fileView->getAbsolutePath($targetPath));
|
|
}
|
|
|
|
// allow sync clients to send the mtime along in a header
|
|
$request = \OC::$server->getRequest();
|
|
if (isset($request->server['HTTP_X_OC_MTIME'])) {
|
|
if ($targetStorage->touch($targetInternalPath, $request->server['HTTP_X_OC_MTIME'])) {
|
|
header('X-OC-MTime: accepted');
|
|
}
|
|
}
|
|
|
|
$this->fileView->changeLock($targetPath, ILockingProvider::LOCK_SHARED);
|
|
|
|
// since we skipped the view we need to scan and emit the hooks ourselves
|
|
$targetStorage->getUpdater()->update($targetInternalPath);
|
|
|
|
$this->emitPostHooks($exists, $targetPath);
|
|
|
|
$info = $this->fileView->getFileInfo($targetPath);
|
|
|
|
$this->fileView->unlockFile($targetPath, ILockingProvider::LOCK_SHARED);
|
|
|
|
return $info->getEtag();
|
|
} catch (\Exception $e) {
|
|
if ($partFile !== null) {
|
|
$targetStorage->unlink($targetInternalPath);
|
|
}
|
|
$this->convertToSabreException($e);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns whether a part file is needed for the given storage
|
|
* or whether the file can be assembled/uploaded directly on the
|
|
* target storage.
|
|
*
|
|
* @param \OCP\Files\Storage $storage
|
|
* @return bool true if the storage needs part file handling
|
|
*/
|
|
private function needsPartFile($storage) {
|
|
// TODO: in the future use ChunkHandler provided by storage
|
|
// and/or add method on Storage called "needsPartFile()"
|
|
return !$storage->instanceOfStorage('OCA\Files_Sharing\External\Storage') &&
|
|
!$storage->instanceOfStorage('OC\Files\Storage\OwnCloud');
|
|
}
|
|
|
|
/**
|
|
* Convert the given exception to a SabreException instance
|
|
*
|
|
* @param \Exception $e
|
|
*
|
|
* @throws \Sabre\DAV\Exception
|
|
*/
|
|
private function convertToSabreException(\Exception $e) {
|
|
if ($e instanceof \Sabre\DAV\Exception) {
|
|
throw $e;
|
|
}
|
|
if ($e instanceof NotPermittedException) {
|
|
// a more general case - due to whatever reason the content could not be written
|
|
throw new Forbidden($e->getMessage(), 0, $e);
|
|
}
|
|
if ($e instanceof ForbiddenException) {
|
|
// the path for the file was forbidden
|
|
throw new DAVForbiddenException($e->getMessage(), $e->getRetry(), $e);
|
|
}
|
|
if ($e instanceof EntityTooLargeException) {
|
|
// the file is too big to be stored
|
|
throw new EntityTooLarge($e->getMessage(), 0, $e);
|
|
}
|
|
if ($e instanceof InvalidContentException) {
|
|
// the file content is not permitted
|
|
throw new UnsupportedMediaType($e->getMessage(), 0, $e);
|
|
}
|
|
if ($e instanceof InvalidPathException) {
|
|
// the path for the file was not valid
|
|
// TODO: find proper http status code for this case
|
|
throw new Forbidden($e->getMessage(), 0, $e);
|
|
}
|
|
if ($e instanceof LockedException || $e instanceof LockNotAcquiredException) {
|
|
// the file is currently being written to by another process
|
|
throw new FileLocked($e->getMessage(), $e->getCode(), $e);
|
|
}
|
|
if ($e instanceof GenericEncryptionException) {
|
|
// returning 503 will allow retry of the operation at a later point in time
|
|
throw new ServiceUnavailable('Encryption not ready: ' . $e->getMessage(), 0, $e);
|
|
}
|
|
if ($e instanceof StorageNotAvailableException) {
|
|
throw new ServiceUnavailable('Failed to write file contents: ' . $e->getMessage(), 0, $e);
|
|
}
|
|
|
|
throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
|
|
}
|
|
}
|