summaryrefslogtreecommitdiffstats
path: root/lib/private/legacy/OC_FileChunking.php
diff options
context:
space:
mode:
authorChristoph Wurst <christoph@winzerhof-wurst.at>2020-04-01 20:44:29 +0200
committerChristoph Wurst <christoph@winzerhof-wurst.at>2020-04-07 08:48:00 +0200
commit1e086064f5b7ebf2d00d024874a1ecf4cf9d13b5 (patch)
treed723c19000a7971215e6fee12a468ffc9cf3c04f /lib/private/legacy/OC_FileChunking.php
parent9895aff4d92a738ea3248a1c03442e83fab02643 (diff)
downloadnextcloud-server-1e086064f5b7ebf2d00d024874a1ecf4cf9d13b5.tar.gz
nextcloud-server-1e086064f5b7ebf2d00d024874a1ecf4cf9d13b5.zip
Move legacy classes from PSR0 to PSR4
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to 'lib/private/legacy/OC_FileChunking.php')
-rw-r--r--lib/private/legacy/OC_FileChunking.php185
1 files changed, 185 insertions, 0 deletions
diff --git a/lib/private/legacy/OC_FileChunking.php b/lib/private/legacy/OC_FileChunking.php
new file mode 100644
index 00000000000..048bd085bb5
--- /dev/null
+++ b/lib/private/legacy/OC_FileChunking.php
@@ -0,0 +1,185 @@
+<?php
+/**
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ *
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Felix Moeller <mail@felixmoeller.de>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <robin@icewind.nl>
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Thomas Tanghus <thomas@tanghus.net>
+ * @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/>
+ *
+ */
+
+
+class OC_FileChunking {
+ protected $info;
+ protected $cache;
+
+ /**
+ * TTL of chunks
+ *
+ * @var int
+ */
+ protected $ttl;
+
+ static public function decodeName($name) {
+ preg_match('/(?P<name>.*)-chunking-(?P<transferid>\d+)-(?P<chunkcount>\d+)-(?P<index>\d+)/', $name, $matches);
+ return $matches;
+ }
+
+ /**
+ * @param string[] $info
+ */
+ public function __construct($info) {
+ $this->info = $info;
+ $this->ttl = \OC::$server->getConfig()->getSystemValue('cache_chunk_gc_ttl', 86400);
+ }
+
+ public function getPrefix() {
+ $name = $this->info['name'];
+ $transferid = $this->info['transferid'];
+
+ return $name.'-chunking-'.$transferid.'-';
+ }
+
+ protected function getCache() {
+ if (!isset($this->cache)) {
+ $this->cache = new \OC\Cache\File();
+ }
+ return $this->cache;
+ }
+
+ /**
+ * Stores the given $data under the given $key - the number of stored bytes is returned
+ *
+ * @param string $index
+ * @param resource $data
+ * @return int
+ */
+ public function store($index, $data) {
+ $cache = $this->getCache();
+ $name = $this->getPrefix().$index;
+ $cache->set($name, $data, $this->ttl);
+
+ return $cache->size($name);
+ }
+
+ public function isComplete() {
+ $prefix = $this->getPrefix();
+ $cache = $this->getCache();
+ $chunkcount = (int)$this->info['chunkcount'];
+
+ for($i=($chunkcount-1); $i >= 0; $i--) {
+ if (!$cache->hasKey($prefix.$i)) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
+ /**
+ * Assembles the chunks into the file specified by the path.
+ * Chunks are deleted afterwards.
+ *
+ * @param resource $f target path
+ *
+ * @return integer assembled file size
+ *
+ * @throws \OC\InsufficientStorageException when file could not be fully
+ * assembled due to lack of free space
+ */
+ public function assemble($f) {
+ $cache = $this->getCache();
+ $prefix = $this->getPrefix();
+ $count = 0;
+ for ($i = 0; $i < $this->info['chunkcount']; $i++) {
+ $chunk = $cache->get($prefix.$i);
+ // remove after reading to directly save space
+ $cache->remove($prefix.$i);
+ $count += fwrite($f, $chunk);
+ // let php release the memory to work around memory exhausted error with php 5.6
+ $chunk = null;
+ }
+
+ return $count;
+ }
+
+ /**
+ * Returns the size of the chunks already present
+ * @return integer size in bytes
+ */
+ public function getCurrentSize() {
+ $cache = $this->getCache();
+ $prefix = $this->getPrefix();
+ $total = 0;
+ for ($i = 0; $i < $this->info['chunkcount']; $i++) {
+ $total += $cache->size($prefix.$i);
+ }
+ return $total;
+ }
+
+ /**
+ * Removes all chunks which belong to this transmission
+ */
+ public function cleanup() {
+ $cache = $this->getCache();
+ $prefix = $this->getPrefix();
+ for($i=0; $i < $this->info['chunkcount']; $i++) {
+ $cache->remove($prefix.$i);
+ }
+ }
+
+ /**
+ * Removes one specific chunk
+ * @param string $index
+ */
+ public function remove($index) {
+ $cache = $this->getCache();
+ $prefix = $this->getPrefix();
+ $cache->remove($prefix.$index);
+ }
+
+ /**
+ * Assembles the chunks into the file specified by the path.
+ * Also triggers the relevant hooks and proxies.
+ *
+ * @param \OC\Files\Storage\Storage $storage storage
+ * @param string $path target path relative to the storage
+ * @return bool true on success or false if file could not be created
+ *
+ * @throws \OC\ServerNotAvailableException
+ */
+ public function file_assemble($storage, $path) {
+ // use file_put_contents as method because that best matches what this function does
+ if (\OC\Files\Filesystem::isValidPath($path)) {
+ $target = $storage->fopen($path, 'w');
+ if ($target) {
+ $count = $this->assemble($target);
+ fclose($target);
+ return $count > 0;
+ } else {
+ return false;
+ }
+ }
+ return false;
+ }
+}