* @author J0WI * @author John Molakvoæ (skjnldsv) * @author Jörn Friedrich Dreyer * @author Julius Härtl * @author Lukas Reschke * @author Morris Jobke * @author Robin Appelman * @author Robin McCorkell * @author Roeland Jago Douma * @author Tigran Mkrtchyan * @author Vincent Petry * * @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 * */ namespace OC\Files\Storage\Wrapper; use OC\Files\Filesystem; use OCP\Files\Cache\ICacheEntry; use OCP\Files\Storage\IStorage; class Quota extends Wrapper { /** * @var int $quota */ protected $quota; /** * @var string $sizeRoot */ protected $sizeRoot; private $config; /** * @param array $parameters */ public function __construct($parameters) { parent::__construct($parameters); $this->quota = $parameters['quota']; $this->sizeRoot = isset($parameters['root']) ? $parameters['root'] : ''; $this->config = \OC::$server->getSystemConfig(); } /** * @return int quota value */ public function getQuota() { return $this->quota; } /** * @param string $path * @param \OC\Files\Storage\Storage $storage */ protected function getSize($path, $storage = null) { if ($this->config->getValue('quota_include_external_storage', false)) { $rootInfo = Filesystem::getFileInfo('', 'ext'); if ($rootInfo) { return $rootInfo->getSize(true); } return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED; } else { if (is_null($storage)) { $cache = $this->getCache(); } else { $cache = $storage->getCache(); } $data = $cache->get($path); if ($data instanceof ICacheEntry and isset($data['size'])) { return $data['size']; } else { return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED; } } } /** * Get free space as limited by the quota * * @param string $path * @return int|bool */ public function free_space($path) { if ($this->quota < 0 || strpos($path, 'cache') === 0 || strpos($path, 'uploads') === 0) { return $this->storage->free_space($path); } else { $used = $this->getSize($this->sizeRoot); if ($used < 0) { return \OCP\Files\FileInfo::SPACE_NOT_COMPUTED; } else { $free = $this->storage->free_space($path); $quotaFree = max($this->quota - $used, 0); // if free space is known if ($free >= 0) { $free = min($free, $quotaFree); } else { $free = $quotaFree; } return $free; } } } /** * see https://www.php.net/manual/en/function.file_put_contents.php * * @param string $path * @param mixed $data * @return int|false */ public function file_put_contents($path, $data) { $free = $this->free_space($path); if ($free < 0 or strlen($data) < $free) { return $this->storage->file_put_contents($path, $data); } else { return false; } } /** * see https://www.php.net/manual/en/function.copy.php * * @param string $source * @param string $target * @return bool */ public function copy($source, $target) { $free = $this->free_space($target); if ($free < 0 or $this->getSize($source) < $free) { return $this->storage->copy($source, $target); } else { return false; } } /** * see https://www.php.net/manual/en/function.fopen.php * * @param string $path * @param string $mode * @return resource|bool */ public function fopen($path, $mode) { $source = $this->storage->fopen($path, $mode); // don't apply quota for part files if (!$this->isPartFile($path)) { $free = $this->free_space($path); if ($source && is_int($free) && $free >= 0 && $mode !== 'r' && $mode !== 'rb') { // only apply quota for files, not metadata, trash or others if ($this->shouldApplyQuota($path)) { return \OC\Files\Stream\Quota::wrap($source, $free); } } } return $source; } /** * Checks whether the given path is a part file * * @param string $path Path that may identify a .part file * @return string File path without .part extension * @note this is needed for reusing keys */ private function isPartFile($path) { $extension = pathinfo($path, PATHINFO_EXTENSION); return ($extension === 'part'); } /** * Only apply quota for files, not metadata, trash or others */ private function shouldApplyQuota(string $path): bool { return strpos(ltrim($path, '/'), 'files/') === 0; } /** * @param IStorage $sourceStorage * @param string $sourceInternalPath * @param string $targetInternalPath * @return bool */ public function copyFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { $free = $this->free_space($targetInternalPath); if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) { return $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); } else { return false; } } /** * @param IStorage $sourceStorage * @param string $sourceInternalPath * @param string $targetInternalPath * @return bool */ public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath) { $free = $this->free_space($targetInternalPath); if ($free < 0 or $this->getSize($sourceInternalPath, $sourceStorage) < $free) { return $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); } else { return false; } } public function mkdir($path) { $free = $this->free_space($path); if ($this->shouldApplyQuota($path) && $free === 0.0) { return false; } return parent::mkdir($path); } public function touch($path, $mtime = null) { $free = $this->free_space($path); if ($free === 0.0) { return false; } return parent::touch($path, $mtime); } }