nextcloud/lib/private/Streamer.php

186 lines
5.9 KiB
PHP
Raw Normal View History

2015-09-23 19:00:15 +03:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Daniel Calviño Sánchez <danxuliu@gmail.com>
2016-07-21 18:07:57 +03:00
* @author Joas Schilling <coding@schilljs.com>
* @author Roeland Jago Douma <roeland@famdouma.nl>
2015-10-05 21:54:56 +03:00
* @author Thomas Müller <thomas.mueller@tmit.eu>
2015-09-23 19:00:15 +03:00
* @author Victor Dubiniuk <dubiniuk@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-09-23 19:00:15 +03:00
*
*/
2015-09-24 01:08:42 +03:00
namespace OC;
use OC\Files\Filesystem;
use OCP\Files\File;
use OCP\Files\Folder;
use OCP\Files\InvalidPathException;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\IRequest;
2015-09-26 00:33:06 +03:00
use ownCloud\TarStreamer\TarStreamer;
2015-09-24 01:08:42 +03:00
use ZipStreamer\ZipStreamer;
2015-09-23 19:00:15 +03:00
2015-09-24 01:08:42 +03:00
class Streamer {
2015-09-24 00:04:33 +03:00
// array of regexp. Matching user agents will get tar instead of zip
private $preferTarFor = [ '/macintosh|mac os x/i' ];
2015-09-23 19:00:15 +03:00
2015-09-24 00:04:33 +03:00
// streamer instance
2015-09-23 19:00:15 +03:00
private $streamerInstance;
/**
* Streamer constructor.
*
* @param IRequest $request
* @param int $size The size of the files in bytes
* @param int $numberOfFiles The number of files (and directories) that will
* be included in the streamed file
*/
public function __construct(IRequest $request, int $size, int $numberOfFiles){
/**
* zip32 constraints for a basic (without compression, volumes nor
* encryption) zip file according to the Zip specification:
* - No file size is larger than 4 bytes (file size < 4294967296); see
* 4.4.9 uncompressed size
* - The size of all files plus their local headers is not larger than
* 4 bytes; see 4.4.16 relative offset of local header and 4.4.24
* offset of start of central directory with respect to the starting
* disk number
* - The total number of entries (files and directories) in the zip file
* is not larger than 2 bytes (number of entries < 65536); see 4.4.22
* total number of entries in the central dir
* - The size of the central directory is not larger than 4 bytes; see
* 4.4.23 size of the central directory
*
* Due to all that, zip32 is used if the size is below 4GB and there are
* less than 65536 files; the margin between 4*1000^3 and 4*1024^3
* should give enough room for the extra zip metadata. Technically, it
* would still be possible to create an invalid zip32 file (for example,
* a zip file from files smaller than 4GB with a central directory
* larger than 4GiB), but it should not happen in the real world.
*/
if ($size < 4 * 1000 * 1000 * 1000 && $numberOfFiles < 65536) {
$this->streamerInstance = new ZipStreamer(['zip64' => false]);
} else if ($request->isUserAgent($this->preferTarFor)) {
2015-09-23 19:00:15 +03:00
$this->streamerInstance = new TarStreamer();
2015-09-24 00:04:33 +03:00
} else {
$this->streamerInstance = new ZipStreamer(['zip64' => PHP_INT_SIZE !== 4]);
2015-09-23 19:00:15 +03:00
}
}
2015-09-24 00:04:33 +03:00
/**
* Send HTTP headers
* @param string $name
2015-09-24 00:04:33 +03:00
*/
2015-09-23 19:00:15 +03:00
public function sendHeaders($name){
$extension = $this->streamerInstance instanceof ZipStreamer ? '.zip' : '.tar';
2015-09-24 22:31:05 +03:00
$fullName = $name . $extension;
$this->streamerInstance->sendHeaders($fullName);
2015-09-23 19:00:15 +03:00
}
2015-09-23 19:00:15 +03:00
/**
2015-09-24 00:04:33 +03:00
* Stream directory recursively
*
* @throws NotFoundException
* @throws NotPermittedException
* @throws InvalidPathException
2015-09-23 19:00:15 +03:00
*/
public function addDirRecursive(string $dir, string $internalDir = ''): void {
2015-09-23 19:00:15 +03:00
$dirname = basename($dir);
$rootDir = $internalDir . $dirname;
if (!empty($rootDir)) {
$this->streamerInstance->addEmptyDir($rootDir);
}
2015-09-24 18:23:10 +03:00
$internalDir .= $dirname . '/';
2015-09-23 19:00:15 +03:00
// prevent absolute dirs
$internalDir = ltrim($internalDir, '/');
$userFolder = \OC::$server->getRootFolder()->get(Filesystem::getRoot());
/** @var Folder $dirNode */
$dirNode = $userFolder->get($dir);
$files = $dirNode->getDirectoryListing();
2015-09-23 19:00:15 +03:00
foreach($files as $file) {
if($file instanceof File) {
try {
$fh = $file->fopen('r');
} catch (NotPermittedException $e) {
continue;
}
$this->addFileFromStream(
$fh,
$internalDir . $file->getName(),
$file->getSize(),
$file->getMTime()
);
2015-09-23 19:00:15 +03:00
fclose($fh);
} elseif ($file instanceof Folder) {
if($file->isReadable()) {
$this->addDirRecursive($dir . '/' . $file->getName(), $internalDir);
}
2015-09-23 19:00:15 +03:00
}
}
}
2015-09-24 00:04:33 +03:00
/**
* Add a file to the archive at the specified location and file name.
*
2015-09-28 14:14:32 +03:00
* @param string $stream Stream to read data from
* @param string $internalName Filepath and name to be used in the archive.
* @param int $size Filesize
* @param int|bool $time File mtime as int, or false
2015-09-24 00:04:33 +03:00
* @return bool $success
*/
public function addFileFromStream($stream, $internalName, $size, $time) {
$options = [];
if ($time) {
$options = [
'timestamp' => $time
];
}
2015-09-23 19:00:15 +03:00
if ($this->streamerInstance instanceof ZipStreamer) {
return $this->streamerInstance->addFileFromStream($stream, $internalName, $options);
2015-09-23 19:00:15 +03:00
} else {
return $this->streamerInstance->addFileFromStream($stream, $internalName, $size, $options);
2015-09-23 19:00:15 +03:00
}
}
2015-09-28 14:14:32 +03:00
2015-09-24 00:04:33 +03:00
/**
* Add an empty directory entry to the archive.
*
2015-09-28 14:14:32 +03:00
* @param string $dirName Directory Path and name to be added to the archive.
2015-09-24 00:04:33 +03:00
* @return bool $success
*/
2015-09-23 19:00:15 +03:00
public function addEmptyDir($dirName){
return $this->streamerInstance->addEmptyDir($dirName);
}
2015-09-28 14:14:32 +03:00
2015-09-24 00:04:33 +03:00
/**
* Close the archive.
* A closed archive can no longer have new files added to it. After
* closing, the file is completely written to the output stream.
* @return bool $success
*/
2015-09-23 19:00:15 +03:00
public function finalize(){
return $this->streamerInstance->finalize();
}
}