nextcloud/apps/dav/lib/Connector/Sabre/QuotaPlugin.php

214 lines
5.9 KiB
PHP
Raw Normal View History

<?php
2015-03-26 13:44:34 +03:00
/**
2016-07-21 17:49:16 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2015-03-26 13:44:34 +03:00
* @author Felix Moeller <mail@felixmoeller.de>
* @author Joas Schilling <coding@schilljs.com>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-03-26 13:44:34 +03:00
* @author scambra <sergio@entrecables.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @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/>
2015-03-26 13:44:34 +03:00
*
*/
namespace OCA\DAV\Connector\Sabre;
use OCA\DAV\Upload\FutureFile;
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
2013-08-08 15:33:00 +04:00
* @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;
/**
2013-08-08 15:33:00 +04:00
* Reference to main server object
*
* @var \Sabre\DAV\Server
2013-08-08 15:33:00 +04:00
*/
private $server;
/**
* @param \OC\Files\View $view
2013-08-08 15:33:00 +04:00
*/
public function __construct($view) {
$this->view = $view;
}
2013-08-08 15:33:00 +04:00
/**
* This initializes the plugin.
*
* This function is called by \Sabre\DAV\Server, after
2013-08-08 15:33:00 +04:00
* addPlugin is called.
*
* This method should set up the requires event subscriptions.
*
* @param \Sabre\DAV\Server $server
2013-08-08 15:33:00 +04:00
* @return void
*/
public function initialize(\Sabre\DAV\Server $server) {
2013-08-08 15:33:00 +04:00
$this->server = $server;
$server->on('beforeWriteContent', [$this, 'beforeWriteContent'], 10);
$server->on('beforeCreateFile', [$this, 'beforeCreateFile'], 10);
$server->on('beforeMove', [$this, 'beforeMove'], 10);
}
/**
* 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 beforeCreateFile($uri, $data, INode $parent, $modified) {
if (!$parent instanceof Node) {
return;
}
return $this->checkQuota($parent->getPath() . '/' . basename($uri));
}
/**
* 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 beforeWriteContent($uri, INode $node, $data, $modified) {
if (!$node instanceof Node) {
return;
}
return $this->checkQuota($node->getPath());
}
/**
* Check if we're moving a Futurefile in which case we need to check
* the quota on the target destination.
*
* @param string $source source path
* @param string $destination destination path
*/
public function beforeMove($source, $destination) {
$sourceNode = $this->server->tree->getNodeForPath($source);
if (!$sourceNode instanceof FutureFile) {
return;
}
// get target node for proper path conversion
if ($this->server->tree->nodeExists($destination)) {
$destinationNode = $this->server->tree->getNodeForPath($destination);
$path = $destinationNode->getPath();
} else {
$parentNode = $this->server->tree->getNodeForPath(dirname($destination));
$path = $parentNode->getPath();
}
return $this->checkQuota($path, $sourceNode->getSize());
}
/**
2013-08-08 15:33:00 +04:00
* This method is called before any HTTP method and validates there is enough free space to store the file
*
* @param string $path relative to the users home
* @param int $length
* @throws InsufficientStorage
2013-08-08 15:33:00 +04:00
* @return bool
*/
public function checkQuota($path, $length = null) {
if ($length === null) {
$length = $this->getLength();
}
if ($length) {
list($parentPath, $newName) = \Sabre\Uri\split($path);
if (is_null($parentPath)) {
$parentPath = '';
}
$req = $this->server->httpRequest;
if ($req->getHeader('OC-Chunked')) {
$info = \OC_FileChunking::decodeName($newName);
$chunkHandler = $this->getFileChunking($info);
2014-04-23 17:34:04 +04:00
// 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 >= 0 && $length > $freeSpace) {
if (isset($chunkHandler)) {
$chunkHandler->cleanup();
}
throw new InsufficientStorage("Insufficient space in $path, $length required, $freeSpace available");
}
}
return true;
}
2013-08-08 02:42:28 +04:00
public function getFileChunking($info) {
// FIXME: need a factory for better mocking support
return new \OC_FileChunking($info);
}
public function getLength() {
2013-08-08 15:33:00 +04:00
$req = $this->server->httpRequest;
$length = $req->getHeader('X-Expected-Entity-Length');
if (!is_numeric($length)) {
2013-08-08 15:33:00 +04:00
$length = $req->getHeader('Content-Length');
$length = is_numeric($length) ? $length : null;
2013-08-08 15:33:00 +04:00
}
2013-08-08 02:42:28 +04:00
2013-08-08 15:33:00 +04:00
$ocLength = $req->getHeader('OC-Total-Length');
if (is_numeric($length) && is_numeric($ocLength)) {
2013-08-08 02:42:28 +04:00
return max($length, $ocLength);
2013-08-08 15:33:00 +04:00
}
2013-08-08 02:42:28 +04:00
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());
}
}
}