apps/dav/lib/Connector/Sabre/QuotaPlugin.php
<?php
/**
* @author Felix Moeller <mail@felixmoeller.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author scambra <sergio@entrecables.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2018, ownCloud GmbH
* @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 OCA\DAV\Upload\FutureFile;
use OCP\Files\FileInfo;
use OCP\Files\StorageNotAvailableException;
use Sabre\DAV\Exception\InsufficientStorage;
use Sabre\DAV\Exception\ServiceUnavailable;
use Sabre\DAV\INode;
/**
* This plugin check user quota and deny creating files when they exceeds the quota.
*
* @author Sergio Cambra
* @copyright Copyright (C) 2012 entreCables S.L. All rights reserved.
* @license http://code.google.com/p/sabredav/wiki/License Modified BSD License
*/
class QuotaPlugin extends \Sabre\DAV\ServerPlugin {
/**
* @var \OC\Files\View
*/
private $view;
/**
* Reference to main server object
*
* @var \Sabre\DAV\Server
*/
private $server;
/**
* @param \OC\Files\View $view
*/
public function __construct($view) {
$this->view = $view;
}
/**
* This initializes the plugin.
*
* This function is called by \Sabre\DAV\Server, after
* addPlugin is called.
*
* This method should set up the requires event subscriptions.
*
* @param \Sabre\DAV\Server $server
* @return void
*/
public function initialize(\Sabre\DAV\Server $server) {
$this->server = $server;
$server->on('beforeWriteContent', [$this, 'handleBeforeWriteContent'], 10);
$server->on('beforeCreateFile', [$this, 'handleBeforeCreateFile'], 10);
$server->on('beforeMove', [$this, 'handleBeforeMove'], 10);
$server->on('beforeCopy', [$this, 'handleBeforeCopy'], 10);
}
/**
* Check if we're moving a Futurefile in which case we need to check
* the quota on the target destination.
* If target and source storages are different, quota plugin should check
* free space in target storage.
*
* @param string $source source path
* @param string $destination destination path
*/
public function handleBeforeMove($source, $destination) {
$sourceNode = $this->server->tree->getNodeForPath($source);
// get target node for proper path conversion
$destinationSize = 0;
if ($this->server->tree->nodeExists($destination)) {
$targetNode = $this->server->tree->getNodeForPath($destination);
if ($targetNode instanceof Node) {
$destinationSize = $targetNode->getSize() ?? 0;
}
} else {
$dirname = \dirname($destination);
$dirname = $dirname === '.' ? '/' : $dirname;
$targetNode = $this->server->tree->getNodeForPath($dirname);
}
// Check quota for only FutureFile or
// target storage different than source storage
if (!$sourceNode instanceof FutureFile) {
if (!$sourceNode instanceof Node || !$targetNode instanceof Node) {
return;
}
$sourceStorage = $sourceNode->getFileInfo()->getStorage()->getId();
$targetStorage = $targetNode->getFileInfo()->getStorage()->getId();
if ($sourceStorage === $targetStorage) {
return;
}
}
$path = $targetNode->getPath();
return $this->checkQuota($path, $sourceNode->getSize(), $destinationSize);
}
public function handleBeforeCopy($source, $destination) {
$sourceNode = $this->server->tree->getNodeForPath($source); // might throw a NotFound exception
$sourceSize = null;
if ($sourceNode instanceof Node) {
$sourceSize = $sourceNode->getSize();
}
$destinationSize = 0;
if ($this->server->tree->nodeExists($destination)) {
$targetNode = $this->server->tree->getNodeForPath($destination);
if ($targetNode instanceof Node) {
$destinationSize = $targetNode->getSize() ?? 0;
}
} else {
$dirname = \dirname($destination);
$dirname = $dirname === '.' ? '/' : $dirname;
$targetNode = $this->server->tree->getNodeForPath($dirname);
}
$path = $targetNode->getPath();
return $this->checkQuota($path, $sourceSize, $destinationSize);
}
/**
* Check quota before writing content
*
* @param string $uri target file URI
* @param INode $node Sabre Node
* @param resource $data data
* @param bool $modified modified
*/
public function handleBeforeWriteContent($uri, $node, $data, $modified) {
if (!$node instanceof Node) {
return;
}
$nodeSize = $node->getSize() ?? 0; // it might return null, so assume 0 in that case.
return $this->checkQuota($node->getPath(), null, $nodeSize);
}
/**
* Check quota before creating file
*
* @param string $uri target file URI
* @param resource $data data
* @param INode $parent Sabre Node
* @param bool $modified modified
*/
public function handleBeforeCreateFile($uri, $data, $parent, $modified) {
if (!$parent instanceof Node) {
return;
}
return $this->checkQuota($parent->getPath() . '/' . \basename($uri));
}
/**
* This method is called before any HTTP method and validates there is enough free space to store the file
*
* @param string $path path of the user's home
* @param int|float $length size to check whether it fits
* @param int|float $extraSpace additional space granted, usually used when overwriting files
* @throws InsufficientStorage
* @return bool
*/
public function checkQuota($path, $length = null, $extraSpace = 0) {
if ($length === null) {
$length = $this->getLength();
}
if ($length !== null) {
list($parentPath, $newName) = \Sabre\Uri\split($path);
if ($parentPath === null) {
$parentPath = '';
}
$req = $this->server->httpRequest;
if ($req->getHeader('OC-Chunked')) {
$info = \OC_FileChunking::decodeName($newName);
$chunkHandler = $this->getFileChunking($info);
// subtract the already uploaded size to see whether
// there is still enough space for the remaining chunks
$length -= $chunkHandler->getCurrentSize();
// use target file name for free space check in case of shared files
$path = \rtrim($parentPath, '/') . '/' . $info['name'];
}
$freeSpace = $this->getFreeSpace($path);
if ($freeSpace === false) {
$freeSpace = 0;
}
// There could be cases where both $freeSpace and $extraSpace are floats:
// * $freeSpace could come from local storage, which calls disk_free_space, which returns float
// * $extraSpace could come from the DB. "size" column is bigint, which is returned as string. The storage
// cache uses `0 + $data['size']` where the $data['size'] should be a string, which should return an int if
// the result fits inside, but it could also be a float if it doesn't (more likely in 32 bits)
$availableSpace = $freeSpace + $extraSpace;
if ($freeSpace !== FileInfo::SPACE_UNKNOWN && $freeSpace !== FileInfo::SPACE_UNLIMITED && (($length > $availableSpace) || ($availableSpace <= 0.0))) {
if (isset($chunkHandler)) {
$chunkHandler->cleanup();
}
throw new InsufficientStorage();
}
}
return true;
}
public function getFileChunking($info) {
// FIXME: need a factory for better mocking support
return new \OC_FileChunking($info);
}
public function getLength() {
$req = $this->server->httpRequest;
$length = $req->getHeader('X-Expected-Entity-Length');
if (!\is_numeric($length)) {
$length = $req->getHeader('Content-Length');
$length = \is_numeric($length) ? $length : null;
}
$ocLength = $req->getHeader('OC-Total-Length');
if (\is_numeric($length) && \is_numeric($ocLength)) {
return \max($length, $ocLength);
}
return $length;
}
/**
* @param string $uri
* @return mixed
* @throws ServiceUnavailable
*/
public function getFreeSpace($uri) {
try {
$freeSpace = $this->view->free_space(\ltrim($uri, '/'));
return $freeSpace;
} catch (StorageNotAvailableException $e) {
throw new ServiceUnavailable($e->getMessage());
}
}
}