lib/private/legacy/files.php
<?php
/**
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
* @author Bart Visscher <bartv@thisnet.nl>
* @author Björn Schießle <bjoern@schiessle.org>
* @author Clark Tomlinson <fallen013@gmail.com>
* @author Frank Karlitschek <frank@karlitschek.de>
* @author Jakob Sack <mail@jakobsack.de>
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@statuscode.ch>
* @author Michael Gapczynski <GapczynskiM@gmail.com>
* @author Nicolai Ehemann <en@enlightened.de>
* @author Piotr Filiciak <piotr@filiciak.pl>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <robin@mccorkell.me.uk>
* @author Thibaut GRIDEL <tgridel@free.fr>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Victor Dubiniuk <dubiniuk@owncloud.com>
* @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/>
*
*/
use OC\Files\View;
use OC\Streamer;
use OCP\Lock\ILockingProvider;
/**
* Class for file server access
*
*/
class OC_Files {
public const FILE = 1;
public const ZIP_FILES = 2;
public const ZIP_DIR = 3;
public const UPLOAD_MIN_LIMIT_BYTES = 1048576; // 1 MiB
private static $multipartBoundary = '';
/**
* @return string
*/
private static function getBoundary() {
if (empty(self::$multipartBoundary)) {
self::$multipartBoundary = \md5(\mt_rand());
}
return self::$multipartBoundary;
}
/**
* @param string $filename
* @param string $name
* @param array $rangeArray ('from'=>int,'to'=>int), ...
*/
private static function sendHeaders($filename, $name, array $rangeArray) {
OC_Response::setContentDispositionHeader($name, 'attachment');
\header('Content-Transfer-Encoding: binary', true);
OC_Response::disableCaching();
$fileSize = \OC\Files\Filesystem::filesize($filename);
$type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
if ($fileSize > -1) {
if (!empty($rangeArray)) {
\http_response_code(206);
\header('Accept-Ranges: bytes', true);
if (\count($rangeArray) > 1) {
$type = 'multipart/byteranges; boundary='.self::getBoundary();
// no Content-Length header here
} else {
\header(\sprintf('Content-Range: bytes %d-%d/%d', $rangeArray[0]['from'], $rangeArray[0]['to'], $fileSize), true);
OC_Response::setContentLengthHeader($rangeArray[0]['to'] - $rangeArray[0]['from'] + 1);
}
} else {
OC_Response::setContentLengthHeader($fileSize);
}
}
\header('Content-Type: '.$type, true);
}
/**
* return the content of a file or return a zip file containing multiple files
*
* @param string $dir
* @param string $files ; separated list of files to download
* @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
*/
public static function get($dir, $files, $params = null) {
$view = \OC\Files\Filesystem::getView();
if (!\is_array($files)) {
// "files" contains a string with a filename
$listOfFiles = [$files];
} else {
$listOfFiles = $files;
}
try {
/*
* $listOfFiles might be an empty array,
* for example if the client requests to download a whole folder
* and does not supply individual files.
*/
if (\count($listOfFiles) === 0) {
$filename = $dir;
$getType = self::ZIP_DIR;
} elseif (\count($listOfFiles) === 1) {
$filename = "{$dir}/{$listOfFiles[0]}";
if (!$view->is_dir($filename)) {
self::getSingleFile($view, $dir, $listOfFiles[0], $params === null ? [] : $params);
return;
} else {
$getType = self::ZIP_DIR;
}
} else {
$filename = $dir;
$getType = self::ZIP_FILES;
}
//Dispatch an event to see if any apps have problem with download.
// 'files' event param will be always an array now
$event = new \Symfony\Component\EventDispatcher\GenericEvent(null, ['dir' => $dir, 'files' => $listOfFiles, 'run' => true]);
OC::$server->getEventDispatcher()->dispatch($event, 'file.beforeCreateZip');
if (($event->getArgument('run') === false) or ($event->hasArgument('errorMessage'))) {
throw new \OC\ForbiddenException($event->getArgument('errorMessage'));
}
$streamer = new Streamer();
OC_Util::obEnd();
self::lockFiles($view, $dir, $listOfFiles);
if ($filename === '' || $filename === '/') {
$filename = 'download';
// default filename. Could happen downloading the root folder
}
$streamer->sendHeaders(\basename($filename));
$executionTime = \intval(OC::$server->getIniWrapper()->getNumeric('max_execution_time'));
\set_time_limit(0);
\ignore_user_abort(true);
if ($getType === self::ZIP_FILES) {
foreach ($listOfFiles as $file) {
$file = "{$dir}/{$file}";
if (\OC\Files\Filesystem::is_file($file)) {
$fileSize = \OC\Files\Filesystem::filesize($file);
$fileOpts = [
'timestamp' => \OC\Files\Filesystem::filemtime($file),
];
$fh = \OC\Files\Filesystem::fopen($file, 'r');
$streamer->addFileFromStream($fh, \basename($file), $fileSize, $fileOpts);
\fclose($fh);
} elseif (\OC\Files\Filesystem::is_dir($file)) {
$streamer->addDirRecursive($file);
}
}
} elseif ($getType === self::ZIP_DIR) {
$file = "{$dir}/{$listOfFiles[0]}";
$streamer->addDirRecursive($file);
}
$streamer->finalize();
\set_time_limit($executionTime);
self::unlockFiles($view, $dir, $listOfFiles);
$event = new \Symfony\Component\EventDispatcher\GenericEvent(null, ['result' => 'success', 'dir' => $dir, 'files' => $files]);
OC::$server->getEventDispatcher()->dispatch($event, 'file.afterCreateZip');
} catch (\OCP\Lock\LockedException $ex) {
self::unlockFiles($view, $dir, $listOfFiles);
OC::$server->getLogger()->logException($ex);
$l = \OC::$server->getL10N('lib');
/* @phan-suppress-next-line PhanUndeclaredMethod */
$hint = \method_exists($ex, 'getHint') ? $ex->getHint() : '';
\OC_Template::printErrorPage($l->t('File is currently busy, please try again later'), $hint);
} catch (\OCP\Files\ForbiddenException $ex) {
self::unlockFiles($view, $dir, $listOfFiles);
OC::$server->getLogger()->logException($ex);
$l = \OC::$server->getL10N('lib');
\OC_Template::printErrorPage($l->t('Access to this resource or one of its sub-items has been denied.'), $ex->getMessage(), 403);
} catch (\OC\ForbiddenException $ex) {
self::unlockFiles($view, $dir, $listOfFiles);
\OC_Template::printErrorPage('Access denied', $ex->getMessage(), 403);
} catch (\Exception $ex) {
self::unlockFiles($view, $dir, $listOfFiles);
if (\connection_status() !== 0) {
// assume the client closed the connection
OC::$server->getLogger()->debug($ex->getMessage());
} else {
OC::$server->getLogger()->logException($ex);
$l = \OC::$server->getL10N('lib');
/* @phan-suppress-next-line PhanUndeclaredMethod */
$hint = \method_exists($ex, 'getHint') ? $ex->getHint() : '';
\OC_Template::printErrorPage($l->t('File cannot be downloaded'), $hint);
}
}
}
/**
* @param string $rangeHeaderPos
* @param int $fileSize
* @return array $rangeArray ('from'=>int,'to'=>int), ...
*/
private static function parseHttpRangeHeader($rangeHeaderPos, $fileSize) {
$rArray=\explode(',', $rangeHeaderPos);
$minOffset = 0;
$ind = 0;
$rangeArray = [];
foreach ($rArray as $value) {
$ranges = \explode('-', $value);
if (\is_numeric($ranges[0])) {
if ($ranges[0] < $minOffset) { // case: bytes=500-700,601-999
$ranges[0] = $minOffset;
}
if ($ind > 0 && $rangeArray[$ind-1]['to']+1 == $ranges[0]) { // case: bytes=500-600,601-999
$ind--;
$ranges[0] = $rangeArray[$ind]['from'];
}
}
if (\is_numeric($ranges[0]) && \is_numeric($ranges[1]) && $ranges[0] < $fileSize && $ranges[0] <= $ranges[1]) {
// case: x-x
if ($ranges[1] >= $fileSize) {
$ranges[1] = $fileSize-1;
}
$rangeArray[$ind++] = ['from' => $ranges[0], 'to' => $ranges[1], 'size' => $fileSize];
$minOffset = $ranges[1] + 1;
if ($minOffset >= $fileSize) {
break;
}
} elseif (\is_numeric($ranges[0]) && $ranges[0] < $fileSize) {
// case: x-
$rangeArray[$ind++] = ['from' => $ranges[0], 'to' => $fileSize-1, 'size' => $fileSize];
break;
} elseif (\is_numeric($ranges[1])) {
// case: -x
if ($ranges[1] > $fileSize) {
$ranges[1] = $fileSize;
}
$rangeArray[$ind++] = ['from' => $fileSize-$ranges[1], 'to' => $fileSize-1, 'size' => $fileSize];
break;
}
}
return $rangeArray;
}
/**
* @param View $view
* @param string $name
* @param string $dir
* @param array $params ; 'head' boolean to only send header of the request ; 'range' http range header
*/
private static function getSingleFile($view, $dir, $name, $params) {
$filename = "{$dir}/{$name}";
OC_Util::obEnd();
$view->lockFile($filename, ILockingProvider::LOCK_SHARED);
$rangeArray = [];
if (isset($params['range']) && \substr($params['range'], 0, 6) === 'bytes=') {
$rangeArray = self::parseHttpRangeHeader(
\substr($params['range'], 6),
\OC\Files\Filesystem::filesize($filename)
);
}
$event = new \Symfony\Component\EventDispatcher\GenericEvent(null, ['path' => $filename]);
OC::$server->getEventDispatcher()->dispatch($event, 'file.beforeGetDirect');
if (\OC\Files\Filesystem::isReadable($filename) && !$event->hasArgument('errorMessage')) {
self::sendHeaders($filename, $name, $rangeArray);
if (isset($params['head']) && $params['head']) {
// if it's a HEAD request, stop here.
$view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
return;
}
} elseif (!\OC\Files\Filesystem::file_exists($filename)) {
$view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
\http_response_code(404);
$tmpl = new OC_Template('', '404', 'guest');
$tmpl->printPage();
exit();
} else {
$view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
if (!$event->hasArgument('errorMessage')) {
$msg = $event->getArgument('errorMessage');
} else {
$msg = 'Access denied';
}
\OC_Template::printErrorPage('Access denied', $msg, 403);
return;
}
if (!empty($rangeArray)) {
try {
if (\count($rangeArray) == 1) {
$view->readfilePart($filename, $rangeArray[0]['from'], $rangeArray[0]['to']);
} else {
// check if file is seekable (if not throw UnseekableException)
// we have to check it before body contents
$view->readfilePart($filename, $rangeArray[0]['size'], $rangeArray[0]['size']);
$type = \OC::$server->getMimeTypeDetector()->getSecureMimeType(\OC\Files\Filesystem::getMimeType($filename));
foreach ($rangeArray as $range) {
echo "\r\n--".self::getBoundary()."\r\n".
"Content-type: ".$type."\r\n".
"Content-range: bytes ".$range['from']."-".$range['to']."/".$range['size']."\r\n\r\n";
$view->readfilePart($filename, $range['from'], $range['to']);
}
echo "\r\n--".self::getBoundary()."--\r\n";
}
} catch (\OCP\Files\UnseekableException $ex) {
// file is unseekable
\header_remove('Accept-Ranges');
\header_remove('Content-Range');
\http_response_code(200);
self::sendHeaders($filename, $name, []);
$view->readfile($filename);
}
} else {
$view->readfile($filename);
}
$view->unlockFile($filename, ILockingProvider::LOCK_SHARED);
}
/**
* @param View $view
* @param string $dir
* @param string[] $files
*/
private static function lockFiles($view, $dir, $files) {
foreach ($files as $file) {
$filePath = "{$dir}/{$file}";
$view->lockFile($filePath, ILockingProvider::LOCK_SHARED);
if ($view->is_dir($filePath)) {
$contents = $view->getDirectoryContent($filePath);
$contents = \array_map(function ($fileInfo) use ($file) {
/** @var \OCP\Files\FileInfo $fileInfo */
return "{$file}/" . $fileInfo->getName();
}, $contents);
self::lockFiles($view, $dir, $contents);
// $dir is expected to remain constant while $files can
// evolve to ["d1/d2/d3/file001", "d1/d2/d3/file002", ...]
}
}
}
/**
* @param View $view
* @param string $dir
* @param string[] $files
*/
private static function unlockFiles($view, $dir, $files) {
foreach ($files as $file) {
$filePath = "{$dir}/{$file}";
$view->unlockFile($filePath, ILockingProvider::LOCK_SHARED);
if ($view->is_dir($filePath)) {
$contents = $view->getDirectoryContent($filePath);
$contents = \array_map(function ($fileInfo) use ($file) {
/** @var \OCP\Files\FileInfo $fileInfo */
return "{$file}/" . $fileInfo->getName();
}, $contents);
self::unlockFiles($view, $dir, $contents);
// $dir is expected to remain constant while $files can
// evolve to ["d1/d2/d3/file001", "d1/d2/d3/file002", ...]
}
}
}
}