566 lines
11 KiB
PHP
566 lines
11 KiB
PHP
|
|
<?php
|
||
|
|
|
||
|
|
namespace TusPhp;
|
||
|
|
|
||
|
|
use Carbon\Carbon;
|
||
|
|
use TusPhp\Cache\Cacheable;
|
||
|
|
use TusPhp\Exception\FileException;
|
||
|
|
use TusPhp\Exception\ConnectionException;
|
||
|
|
use TusPhp\Exception\OutOfRangeException;
|
||
|
|
|
||
|
|
class File
|
||
|
|
{
|
||
|
|
/** @const Max chunk size */
|
||
|
|
public const CHUNK_SIZE = 8192; // 8 kilobytes.
|
||
|
|
|
||
|
|
/** @const Input stream */
|
||
|
|
public const INPUT_STREAM = 'php://input';
|
||
|
|
|
||
|
|
/** @const Read binary mode */
|
||
|
|
public const READ_BINARY = 'rb';
|
||
|
|
|
||
|
|
/** @const Append binary mode */
|
||
|
|
public const APPEND_BINARY = 'ab';
|
||
|
|
|
||
|
|
/** @var string */
|
||
|
|
protected $key;
|
||
|
|
|
||
|
|
/** @var string */
|
||
|
|
protected $checksum;
|
||
|
|
|
||
|
|
/** @var string */
|
||
|
|
protected $name;
|
||
|
|
|
||
|
|
/** @var Cacheable */
|
||
|
|
protected $cache;
|
||
|
|
|
||
|
|
/** @var int */
|
||
|
|
protected $offset;
|
||
|
|
|
||
|
|
/** @var string */
|
||
|
|
protected $location;
|
||
|
|
|
||
|
|
/** @var string */
|
||
|
|
protected $filePath;
|
||
|
|
|
||
|
|
/** @var int */
|
||
|
|
protected $fileSize;
|
||
|
|
|
||
|
|
/** @var string[] */
|
||
|
|
private $uploadMetadata = [];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* File constructor.
|
||
|
|
*
|
||
|
|
* @param string|null $name
|
||
|
|
* @param Cacheable|null $cache
|
||
|
|
*/
|
||
|
|
public function __construct(string $name = null, Cacheable $cache = null)
|
||
|
|
{
|
||
|
|
$this->name = $name;
|
||
|
|
$this->cache = $cache;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set file meta.
|
||
|
|
*
|
||
|
|
* @param int $offset
|
||
|
|
* @param int $fileSize
|
||
|
|
* @param string $filePath
|
||
|
|
* @param string $location
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setMeta(int $offset, int $fileSize, string $filePath, string $location = null) : self
|
||
|
|
{
|
||
|
|
$this->offset = $offset;
|
||
|
|
$this->fileSize = $fileSize;
|
||
|
|
$this->filePath = $filePath;
|
||
|
|
$this->location = $location;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set name.
|
||
|
|
*
|
||
|
|
* @param string $name
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setName(string $name) : self
|
||
|
|
{
|
||
|
|
$this->name = $name;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get name.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getName() : string
|
||
|
|
{
|
||
|
|
return $this->name;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set file size.
|
||
|
|
*
|
||
|
|
* @param int $size
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setFileSize(int $size) : self
|
||
|
|
{
|
||
|
|
$this->fileSize = $size;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get file size.
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getFileSize() : int
|
||
|
|
{
|
||
|
|
return $this->fileSize;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set key.
|
||
|
|
*
|
||
|
|
* @param string $key
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setKey(string $key) : self
|
||
|
|
{
|
||
|
|
$this->key = $key;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get key.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getKey() : string
|
||
|
|
{
|
||
|
|
return $this->key;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set checksum.
|
||
|
|
*
|
||
|
|
* @param string $checksum
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setChecksum(string $checksum) : self
|
||
|
|
{
|
||
|
|
$this->checksum = $checksum;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get checksum.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getChecksum() : string
|
||
|
|
{
|
||
|
|
return $this->checksum;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set offset.
|
||
|
|
*
|
||
|
|
* @param int $offset
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setOffset(int $offset) : self
|
||
|
|
{
|
||
|
|
$this->offset = $offset;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get offset.
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getOffset() : int
|
||
|
|
{
|
||
|
|
return $this->offset;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set location.
|
||
|
|
*
|
||
|
|
* @param string $location
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setLocation(string $location) : self
|
||
|
|
{
|
||
|
|
$this->location = $location;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get location.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getLocation() : string
|
||
|
|
{
|
||
|
|
return $this->location;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Set absolute file location.
|
||
|
|
*
|
||
|
|
* @param string $path
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setFilePath(string $path) : self
|
||
|
|
{
|
||
|
|
$this->filePath = $path;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get absolute location.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getFilePath() : string
|
||
|
|
{
|
||
|
|
return $this->filePath;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string[] $metadata
|
||
|
|
*
|
||
|
|
* @return File
|
||
|
|
*/
|
||
|
|
public function setUploadMetadata(array $metadata) : self
|
||
|
|
{
|
||
|
|
$this->uploadMetadata = $metadata;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get input stream.
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getInputStream() : string
|
||
|
|
{
|
||
|
|
return self::INPUT_STREAM;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get file meta.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function details() : array
|
||
|
|
{
|
||
|
|
$now = Carbon::now();
|
||
|
|
|
||
|
|
return [
|
||
|
|
'name' => $this->name,
|
||
|
|
'size' => $this->fileSize,
|
||
|
|
'offset' => $this->offset,
|
||
|
|
'checksum' => $this->checksum,
|
||
|
|
'location' => $this->location,
|
||
|
|
'file_path' => $this->filePath,
|
||
|
|
'metadata' => $this->uploadMetadata,
|
||
|
|
'created_at' => $now->format($this->cache::RFC_7231),
|
||
|
|
'expires_at' => $now->addSeconds($this->cache->getTtl())->format($this->cache::RFC_7231),
|
||
|
|
];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Upload file to server.
|
||
|
|
*
|
||
|
|
* @param int $totalBytes
|
||
|
|
*
|
||
|
|
* @throws ConnectionException
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function upload(int $totalBytes) : int
|
||
|
|
{
|
||
|
|
if ($this->offset === $totalBytes) {
|
||
|
|
return $this->offset;
|
||
|
|
}
|
||
|
|
|
||
|
|
$input = $this->open($this->getInputStream(), self::READ_BINARY);
|
||
|
|
$output = $this->open($this->getFilePath(), self::APPEND_BINARY);
|
||
|
|
$key = $this->getKey();
|
||
|
|
|
||
|
|
try {
|
||
|
|
$this->seek($output, $this->offset);
|
||
|
|
|
||
|
|
while ( ! feof($input)) {
|
||
|
|
if (CONNECTION_NORMAL !== connection_status()) {
|
||
|
|
throw new ConnectionException('Connection aborted by user.');
|
||
|
|
}
|
||
|
|
|
||
|
|
$data = $this->read($input, self::CHUNK_SIZE);
|
||
|
|
$bytes = $this->write($output, $data, self::CHUNK_SIZE);
|
||
|
|
|
||
|
|
$this->offset += $bytes;
|
||
|
|
|
||
|
|
$this->cache->set($key, ['offset' => $this->offset]);
|
||
|
|
|
||
|
|
if ($this->offset > $totalBytes) {
|
||
|
|
throw new OutOfRangeException('The uploaded file is corrupt.');
|
||
|
|
}
|
||
|
|
|
||
|
|
if ($this->offset === $totalBytes) {
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
} finally {
|
||
|
|
$this->close($input);
|
||
|
|
$this->close($output);
|
||
|
|
}
|
||
|
|
|
||
|
|
return $this->offset;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Open file in given mode.
|
||
|
|
*
|
||
|
|
* @param string $filePath
|
||
|
|
* @param string $mode
|
||
|
|
*
|
||
|
|
* @throws FileException
|
||
|
|
*
|
||
|
|
* @return resource
|
||
|
|
*/
|
||
|
|
public function open(string $filePath, string $mode)
|
||
|
|
{
|
||
|
|
$this->exists($filePath, $mode);
|
||
|
|
|
||
|
|
$ptr = @fopen($filePath, $mode);
|
||
|
|
|
||
|
|
if (false === $ptr) {
|
||
|
|
throw new FileException("Unable to open $filePath.");
|
||
|
|
}
|
||
|
|
|
||
|
|
return $ptr;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Check if file to read exists.
|
||
|
|
*
|
||
|
|
* @param string $filePath
|
||
|
|
* @param string $mode
|
||
|
|
*
|
||
|
|
* @throws FileException
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function exists(string $filePath, string $mode = self::READ_BINARY) : bool
|
||
|
|
{
|
||
|
|
if (self::INPUT_STREAM === $filePath) {
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (self::READ_BINARY === $mode && ! file_exists($filePath)) {
|
||
|
|
throw new FileException('File not found.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Move file pointer to given offset.
|
||
|
|
*
|
||
|
|
* @param resource $handle
|
||
|
|
* @param int $offset
|
||
|
|
* @param int $whence
|
||
|
|
*
|
||
|
|
* @throws FileException
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function seek($handle, int $offset, int $whence = SEEK_SET) : int
|
||
|
|
{
|
||
|
|
$position = fseek($handle, $offset, $whence);
|
||
|
|
|
||
|
|
if (-1 === $position) {
|
||
|
|
throw new FileException('Cannot move pointer to desired position.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return $position;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Read data from file.
|
||
|
|
*
|
||
|
|
* @param resource $handle
|
||
|
|
* @param int $chunkSize
|
||
|
|
*
|
||
|
|
* @throws FileException
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function read($handle, int $chunkSize) : string
|
||
|
|
{
|
||
|
|
$data = fread($handle, $chunkSize);
|
||
|
|
|
||
|
|
if (false === $data) {
|
||
|
|
throw new FileException('Cannot read file.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return (string) $data;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Write data to file.
|
||
|
|
*
|
||
|
|
* @param resource $handle
|
||
|
|
* @param string $data
|
||
|
|
* @param int|null $length
|
||
|
|
*
|
||
|
|
* @throws FileException
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function write($handle, string $data, $length = null) : int
|
||
|
|
{
|
||
|
|
$bytesWritten = \is_int($length) ? fwrite($handle, $data, $length) : fwrite($handle, $data);
|
||
|
|
|
||
|
|
if (false === $bytesWritten) {
|
||
|
|
throw new FileException('Cannot write to a file.');
|
||
|
|
}
|
||
|
|
|
||
|
|
return $bytesWritten;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Merge 2 or more files.
|
||
|
|
*
|
||
|
|
* @param array $files File data with meta info.
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function merge(array $files) : int
|
||
|
|
{
|
||
|
|
$destination = $this->getFilePath();
|
||
|
|
$firstFile = array_shift($files);
|
||
|
|
|
||
|
|
// First partial file can directly be copied.
|
||
|
|
$this->copy($firstFile['file_path'], $destination);
|
||
|
|
|
||
|
|
$this->offset = $firstFile['offset'];
|
||
|
|
$this->fileSize = filesize($firstFile['file_path']);
|
||
|
|
|
||
|
|
$handle = $this->open($destination, self::APPEND_BINARY);
|
||
|
|
|
||
|
|
foreach ($files as $file) {
|
||
|
|
if ( ! file_exists($file['file_path'])) {
|
||
|
|
throw new FileException('File to be merged not found.');
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->fileSize += $this->write($handle, file_get_contents($file['file_path']));
|
||
|
|
|
||
|
|
$this->offset += $file['offset'];
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->close($handle);
|
||
|
|
|
||
|
|
return $this->fileSize;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Copy file from source to destination.
|
||
|
|
*
|
||
|
|
* @param string $source
|
||
|
|
* @param string $destination
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function copy(string $source, string $destination) : bool
|
||
|
|
{
|
||
|
|
$status = @copy($source, $destination);
|
||
|
|
|
||
|
|
if (false === $status) {
|
||
|
|
throw new FileException(sprintf('Cannot copy source (%s) to destination (%s).', $source, $destination));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $status;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete file and/or folder.
|
||
|
|
*
|
||
|
|
* @param array $files
|
||
|
|
* @param bool $folder
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function delete(array $files, bool $folder = false) : bool
|
||
|
|
{
|
||
|
|
$status = $this->deleteFiles($files);
|
||
|
|
|
||
|
|
if ($status && $folder) {
|
||
|
|
return rmdir(\dirname(current($files)));
|
||
|
|
}
|
||
|
|
|
||
|
|
return $status;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Delete multiple files.
|
||
|
|
*
|
||
|
|
* @param array $files
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function deleteFiles(array $files) : bool
|
||
|
|
{
|
||
|
|
if (empty($files)) {
|
||
|
|
return false;
|
||
|
|
}
|
||
|
|
|
||
|
|
$status = true;
|
||
|
|
|
||
|
|
foreach ($files as $file) {
|
||
|
|
if (file_exists($file)) {
|
||
|
|
$status = $status && unlink($file);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return $status;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Close file.
|
||
|
|
*
|
||
|
|
* @param $handle
|
||
|
|
*
|
||
|
|
* @return bool
|
||
|
|
*/
|
||
|
|
public function close($handle) : bool
|
||
|
|
{
|
||
|
|
return fclose($handle);
|
||
|
|
}
|
||
|
|
}
|