TusPHP - 🚀a HTTP based protocol for resumable file uploads.

Ankit Pokhrel

Last update: Dec 28, 2022

Related tags

HTTP php php-library file-upload uploader php71 tus resumable tus-protocol large-files resumable-upload php8 php72 php73 php74 made-in-nepal

Overview

TusPHP

Resumable file upload in PHP using tus resumable upload protocol v1.0.0

Medium Article ⚡ Laravel & Lumen Integration ⚡ Symfony Integration ⚡ CakePHP Integration ⚡ WordPress Integration

tus is a HTTP based protocol for resumable file uploads. Resumable means you can carry on where you left off without re-uploading whole data again in case of any interruptions. An interruption may happen willingly if the user wants to pause, or by accident in case of a network issue or server outage.

Installation
Usage
Extension support
- Expiration
- Concatenation
Events
- Responding to an Event
Middleware
Setting up a dev environment and/or running examples locally
- Docker
Contributing
Questions about this project?
Supporters

Installation

Pull the package via composer.

$ composer require ankitpokhrel/tus-php

// Use v1 for php7.1, Symfony 3 or 4.

$ composer require ankitpokhrel/tus-php:^1.2

Usage


Basic Tus Architecture

Server

This is how a simple server looks like.

// server.php

$server   = new \TusPhp\Tus\Server('redis'); // Either redis, file or apcu. Leave empty for file based cache.
$response = $server->serve();

$response->send();

exit(0); // Exit from current PHP process.

You need to rewrite your server to respond to a specific endpoint. For example:

Nginx

# nginx.conf

location /files {
    try_files $uri $uri/ /server.php?$query_string;
}

A new config option fastcgi_request_buffering is available since nginx 1.7.11. When buffering is enabled, the entire request body is read from the client before sending the request to a FastCGI server. Disabling this option might help with timeouts during the upload. Furthermore, it helps if you’re running out of disc space on the tmp partition of your system.

If you do not turn off fastcgi_request_buffering and you use fastcgi, you will not be able to resume uploads because nginx will not give the request back to PHP until the entire file is uploaded.

location ~ \.php$ {
    # ...

    fastcgi_request_buffering off; # Disable request buffering
    
    # ...
}

A sample nginx configuration can be found here.

Apache

# .htaccess

RewriteEngine on

RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^files/?(.*)?$ /server.php?$1 [QSA,L]

Default max upload size is 0 which means there is no restriction. You can set max upload size as described below.

$server->setMaxUploadSize(100000000); // 100 MB in bytes

Default redis and file configuration for server and client can be found inside config/server.php and config/client.php respectively. To override default config you can simply copy the file to your preferred location and update the parameters. You then need to set the config before doing anything else.

\TusPhp\Config::set('');

$server = new \TusPhp\Tus\Server('redis');

Alternately, you can set REDIS_HOST, REDIS_PORT and REDIS_DB env in your server to override redis settings for both server and client.

Client

The client can be used for creating, resuming and/or deleting uploads.

$client = new \TusPhp\Tus\Client($baseUrl);

// Key is mandatory.
$key = 'your unique key';

$client->setKey($key)->file('/path/to/file', 'filename.ext');

// Create and upload a chunk of 1MB
$bytesUploaded = $client->upload(1000000);

// Resume, $bytesUploaded = 2MB
$bytesUploaded = $client->upload(1000000);

// To upload whole file, skip length param
$client->file('/path/to/file', 'filename.ext')->upload();

To check if the file was partially uploaded before, you can use getOffset method. It returns false if the upload isn't there or invalid, returns total bytes uploaded otherwise.

$offset = $client->getOffset(); // 2000000 bytes or 2MB

Delete partial upload from the cache.

$client->delete($key);

By default, the client uses /files as an API path. You can change it with setApiPath method.

$client->setApiPath('/api');

By default, the server will use sha256 algorithm to verify the integrity of the upload. If you want to use a different hash algorithm, you can do so by using setChecksumAlgorithm method. To get the list of supported hash algorithms, you can send OPTIONS request to the server.

$client->setChecksumAlgorithm('crc32');

Third Party Client Libraries

Uppy

Uppy is a sleek, modular file uploader plugin developed by same folks behind tus protocol. You can use uppy to seamlessly integrate official tus-js-client with tus-php server. Check out more details in uppy docs.

uppy.use(Tus, {
  endpoint: 'https://tus-server.yoursite.com/files/', // use your tus endpoint here
  resume: true,
  autoRetry: true,
  retryDelays: [0, 1000, 3000, 5000]
})

Tus-JS-Client

Tus-php server is compatible with the official tus-js-client Javascript library.

var upload = new tus.Upload(file, {
  endpoint: "/tus",
  retryDelays: [0, 3000, 5000, 10000, 20000],
  metadata: {
    name: file.name,
    type: file.type
  }
})
upload.start()

Cloud Providers

Many cloud providers implement PHP streamWrapper interface that enables us to store and retrieve data from these providers using built-in PHP functions. Since tus-php relies on PHP's built-in filesystem functions, we can easily use it to upload files to the providers like Amazon S3 if their API supports writing in append binary mode. An example implementation to upload files directly to S3 bucket is as follows:

// server.php
// composer require aws/aws-sdk-php

use Aws\S3\S3Client;
use TusPhp\Tus\Server;
use Aws\Credentials\Credentials;

$awsAccessKey = 'AWS_ACCESS_KEY'; // YOUR AWS ACCESS KEY
$awsSecretKey = 'AWS_SECRET_KEY'; // YOUR AWS SECRET KEY
$awsRegion    = 'eu-west-1';      // YOUR AWS BUCKET REGION
$basePath     = 's3://your-bucket-name';

$s3Client = new S3Client([
    'version' => 'latest',
    'region' => $awsRegion,
    'credentials' => new Credentials($awsAccessKey, $awsSecretKey)
]);
$s3Client->registerStreamWrapper();

$server = new Server('file');
$server->setUploadDir($basePath);

$response = $server->serve();
$response->send();

exit(0);

Extension Support

The Creation extension is mostly implemented and is used for creating the upload. Deferring the upload's length is not possible at the moment.
The Termination extension is implemented which is used to terminate completed and unfinished uploads allowing the Server to free up used resources.
The Checksum extension is implemented, the server will use sha256 algorithm by default to verify the upload.
The Expiration extension is implemented, details below.
This Concatenation extension is implemented except that the server is not capable of handling unfinished concatenation.

Expiration

The Server is capable of removing expired but unfinished uploads. You can use the following command manually or in a cron job to remove them. Note that this command checks your cache storage to find expired uploads. So, make sure to run it before the cache is expired, else it will not find all files that needs to be cleared.

$ ./vendor/bin/tus tus:expired --help

Usage:
  tus:expired [<cache-adapter>] [options]

Arguments:
  cache-adapter         Cache adapter to use: redis, file or apcu [default: "file"]

Options:
  -c, --config=CONFIG   File to get config parameters from.

eg:

$ ./vendor/bin/tus tus:expired redis

Cleaning server resources
=========================

1. Deleted 1535888128_35094.jpg from /var/www/uploads

You can use--config option to override default redis or file configuration.

$ ./vendor/bin/tus tus:expired redis --config=<path to your config file>

Concatenation

The Server is capable of concatenating multiple uploads into a single one enabling Clients to perform parallel uploads and to upload non-contiguous chunks.

// Actual file key
$uploadKey = uniqid();

$client->setKey($uploadKey)->file('/path/to/file', 'chunk_a.ext');

// Upload 10000 bytes starting from 1000 bytes
$bytesUploaded = $client->seek(1000)->upload(10000);
$chunkAkey     = $client->getKey();

// Upload 1000 bytes starting from 0 bytes
$bytesUploaded = $client->setFileName('chunk_b.ext')->seek(0)->upload(1000);
$chunkBkey     = $client->getKey();

// Upload remaining bytes starting from 11000 bytes (10000 +  1000)
$bytesUploaded = $client->setFileName('chunk_c.ext')->seek(11000)->upload();
$chunkCkey     = $client->getKey();

// Concatenate partial uploads
$client->setFileName('actual_file.ext')->concat($uploadKey, $chunkBkey, $chunkAkey, $chunkCkey);

Additionally, the server will verify checksum against the merged file to make sure that the file is not corrupt.

Events

Often times, you may want to perform some operation after the upload is complete or created. For example, you may want to crop images after upload or transcode a file and email it to your user. You can utilize tus events for these operations. Following events are dispatched by server during different point of execution.

Event Name	Dispatched
`tus-server.upload.created`	after the upload is created during `POST` request.
`tus-server.upload.progress`	after a chunk is uploaded during `PATCH` request.
`tus-server.upload.complete`	after the upload is complete and checksum verification is done.
`tus-server.upload.merged`	after all partial uploads are merged during concatenation request.

Responding to an Event

To listen to an event, you can simply attach a listener to the event name. An TusEvent instance is created and passed to all of the listeners.

$server->event()->addListener('tus-server.upload.complete', function (\TusPhp\Events\TusEvent $event) {
    $fileMeta = $event->getFile()->details();
    $request  = $event->getRequest();
    $response = $event->getResponse();

    // ...
});

or, you can also bind some method of a custom class.

/**
 * Listener can be method from any normal class.
 */
class SomeClass
{
    public function postUploadOperation(\TusPhp\Events\TusEvent $event)
    {
        // ...
    }
}

$listener = new SomeClass();

$server->event()->addListener('tus-server.upload.complete', [$listener, 'postUploadOperation']);

Middleware

You can manipulate request and response of a server using a middleware. Middleware can be used to run a piece of code before a server calls the actual handle method. You can use middleware to authenticate a request, handle CORS, whitelist/blacklist an IP etc.

Creating a Middleware

In order to create a middleware, you need to implement TusMiddleware interface. The handle method provides request and response object for you to manipulate.



namespace Your\Namespace;

use TusPhp\Request;
use TusPhp\Response;
use TusPhp\Middleware\TusMiddleware;

class Authenticated implements TusMiddleware
{
    // ...

    /**
     * {@inheritDoc}
     */
    public function handle(Request $request, Response $response)
    {
        // Check if user is authenticated
        if (! $this->user->isLoggedIn()) {
            throw new UnauthorizedHttpException('User not authenticated');
        }

        $request->getRequest()->headers->set('Authorization', 'Bearer ' . $this->user->token());
    }

    // ...
}

Adding a Middleware

To add a middleware, get middleware object from server and simply pass middleware classes.

$server->middleware()->add(Authenticated::class, AnotherMiddleware::class);

Or, you can also pass middleware class objects.

$authenticated = new Your\Namespace\Authenticated(new User());

$server->middleware()->add($authenticated);

Skipping a Middleware

If you wish to skip or ignore any middleware, you can do so by using the skip method.

$server->middleware()->skip(Cors::class, AnotherMiddleware::class);

Setting up a dev environment and/or running examples locally

An ajax based example for this implementation can be found in examples/ folder. You can build and run it using docker as described below.

Docker

Make sure that docker and docker-compose are installed in your system. Then, run docker script from project root.

# PHP7
$ make dev

# PHP8
$ make dev8

# or, without make

# PHP7
$ bin/docker.sh

# PHP8
$ PHP_VERSION=8 bin/docker.sh

Now, the client can be accessed at http://0.0.0.0:8080 and the server can be accessed at http://0.0.0.0:8081. The default API endpoint is set to/files and uploaded files can be found inside uploads folder. All docker configs can be found in docker/ folder.

If you want a fresh start then you can use the following commands. It will delete and recreate all containers, images, and uploads folder.

# PHP7
$ make dev-fresh

# PHP8
$ make dev8-fresh

# or, without make

# PHP7
$ bin/clean.sh && bin/docker.sh

# PHP8
$ bin/clean.sh && PHP_VERSION=8 bin/docker.sh

We also have some utility scripts that will ease your local development experience. See Makefile for a list of all available commands. If you are not using make, then you can use shell scripts available here.

Contributing

Install PHPUnit and composer if you haven't already.
Install dependencies
```
$ make deps

# or

$ composer install
```

Run tests with phpunit

$ make test

# or

$ composer test

# or

$ ./vendor/bin/phpunit

Validate changes against PSR2 Coding Standards

# fix lint issues
$ make lint

# dry run
$ make lint-dry

You can use xdebug enable and xdebug disable to enable and disable Xdebug inside the container.

Questions about this project?

Please feel free to report any bug found. Pull requests, issues, and project recommendations are more than welcome!

Supporters

Comments

Cors Problem

Hello there, I keep getting cors errors. I created a new middleware to handle cors and when I remove the Access-Control-Allow-Origin I get this error "No 'Access-Control-Allow-Origin' header is present on the requested resource." but when I add it I get an error "The 'Access-Control-Allow-Origin' header contains multiple values 'http://localhost:3000, http://localhost:3000', but only one is allowed." I am using this package along side Spatie Cors. Any help? I am using this in Laravel 5.7
help/support

opened by alhaji-aki 47

Throwing 404 errors in Laravel

Your API seems great ! But i've been scratching my head for a few days now to integrate it. I'm still a beginner in Laravel and in php in general but it seems that after following all your integration process (I found it very clear), I guess it throws 405 error at the upload stage.

I already included csrf in the header request.

Error message.txt

Ever encountered this issue before ? Help would be much appreciated ! :)

Routes


//Tus routes
Route::any('/tus/{any?}', function () {
    $response = app('tus-server')->serve();
    return $response->send();
})->where('any', '.*');


Route::any('/files/{any?}', function () {
    $response = app('tus-server')->serve();

    return $response->send();
})->where('any', '.*');

Route::get('test', function (){
	return view('test');
});
Route::post('verify', 'TusController@TusFile');
Route::post('upload', 'TusController@UploadTus');

Controller

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use TusPhp\Exception\FileException;
use TusPhp\Exception\ConnectionException;
use GuzzleHttp\Exception\ConnectException;
use TusPhp\Exception\Exception as TusException;
use GuzzleHttp\Client;
require '/Users/fabrique/code/dancenote/vendor/autoload.php';




class TusController extends Controller
{

/**
 * Uploads files in 5mb chunk.
 */
public function TusFile () {


$client = new \TusPhp\Tus\Client('http://dancenote.test/tus');

// Alert: Sanitize all inputs properly in production code
if ( ! empty($_FILES)) {
    $status    = 'new';
    $fileMeta  = $_FILES['tus_file'];
    $uploadKey = hash_file('md5', $fileMeta['tmp_name']);

    try {
        $offset = $client->setKey($uploadKey)->file($fileMeta['tmp_name'])->getOffset();

        if (false !== $offset) {
            $status = $offset >= $fileMeta['size'] ? 'uploaded' : 'resume';

        } else {
            $offset = 0;
        }
        echo json_encode([
            'status' => $status,
            'bytes_uploaded' => $offset,
            'upload_key' => $uploadKey,
        ]);
    } catch (ConnectException $e) {
        echo json_encode([
            'status' => 'errorconnect',
            'bytes_uploaded' => -1,
        ]);
    } catch (FileException $e) {
        echo json_encode([
            'status' => 'resume',
            'bytes_uploaded' => 0,
            'upload_key' => '',
        ]);
    }
} else {
    echo json_encode([
        'status' => 'error',
        'bytes_uploaded' => -1,
    ]);
}

}

public function UploadTus() {
	$client = new \GuzzleHttp\Client(['base_uri'=>'http://dancenote.test/tus', 'debug'=> true);
	// Alert: Sanitize all inputs properly in production code
	if ( ! empty($_FILES)) {
	    $fileMeta  = $_FILES['tus_file'];
	    $uploadKey = hash_file('md5', $fileMeta['tmp_name']);
	    try {
	        $client->setKey($uploadKey)->file($fileMeta['tmp_name'], time() . '_' . $fileMeta['name']);
	        $bytesUploaded = $client->upload(5000000); // Chunk of 5 mb
	        echo json_encode([
	            'status' => 'uploading',
	            'bytes_uploaded' => $bytesUploaded,
	            'upload_key' => $uploadKey
	        ]);
	    } catch (ConnectionException | FileException | TusException $e) {
	        echo json_encode([
	            'status' => 'error',
	            'bytes_uploaded' => -1,
	            'upload_key' => '',
	            'error' => $e->getMessage(),
	        ]);
	    }
	} else {
	    echo json_encode([
	        'status' => 'error',
	        'bytes_uploaded' => -1,
	        'error' => 'No input!',
	    ]);

}
}
}

help/support

opened by alexandrelgy 19

Allow serving requests without relying on global request scope
I'm trying to integrate this library into our application, and in the process of writing some functional tests.

Since in https://github.com/ankitpokhrel/tus-php/blob/master/src/Request.php#L19 when the Request is instantiated the underlying http foundation request is unset, it always relies on the global request scope using createFromGlobals.

I need this library to serve the request that the Symfony Kernel provides rather than trying to build a second request object.

This PR allows my controller to look as follows, and for me to be able to test the whole process:

* TUS upload endpoint * * @Route("/documents/uploads/tus/", name="tus_post") * @Route("/documents/uploads/tus/{token?}", name="tus", requirements={"token"=".+"}) * */ public function server(Request $request, Server $server) { return $server->serve(new \TusPhp\Request($request)); }
question/confusion
opened by adamquaile 15
422 Unprocessable Entity While aws S3 as Storage Backend

Setup Details Storage : AWS S3

Errors PATCH http://localhost/files/f586e634-1ca4-4d5b-b98c-1b46905f8f5f 422 (Unprocessable Entity) Uncaught Error: tus: unexpected response while creating upload at XMLHttpRequest.t.onload
help/support

opened by alameenlr 14

Unable to create resource

Hi, I'm trying to get the demo to work and I get an error in Client.php when calling the create() method in the upload() method. I don't know if this is due to a configuration error on my part. After a search in the closed issues, I decide to post a new one.

server.php

<?php

require __DIR__ . '/../vendor/autoload.php';

$server   = new \TusPhp\Tus\Server();

$response = $server->serve();

$response->send();

exit(0); // Exit from current PHP process.

verify.php

<?php

/**
 * Sends HEAD request to figure out uploaded offset
 * if the file was uploaded partially previously.
 */

require __DIR__ . '/../../vendor/autoload.php';

use TusPhp\Exception\FileException;
use GuzzleHttp\Exception\ConnectException;

$client = new \TusPhp\Tus\Client('http://localhost/test-tus/');

// Alert: Sanitize all inputs properly in production code
if ( ! empty($_FILES)) {
    $status    = 'new';
    $fileMeta  = $_FILES['tus_file'];
    $uploadKey = hash_file('md5', $fileMeta['tmp_name']);

    try {
        $offset = $client->setKey($uploadKey)->file($fileMeta['tmp_name'])->getOffset();

        if (false !== $offset) {
            $status = $offset >= $fileMeta['size'] ? 'uploaded' : 'resume';
        } else {
            $offset = 0;
        }

        echo json_encode([
            'status' => $status,
            'bytes_uploaded' => $offset,
            'upload_key' => $uploadKey,
        ]);
    } catch (ConnectException $e) {
        echo json_encode([
            'status' => 'error',
            'bytes_uploaded' => -1,
        ]);
    } catch (FileException $e) {
        echo json_encode([
            'status' => 'resume',
            'bytes_uploaded' => 0,
            'upload_key' => '',
        ]);
    }
} else {
    echo json_encode([
        'status' => 'error',
        'bytes_uploaded' => -1,
    ]);
}

upload.php

<?php

/**
 * Uploads files in 5mb chunk.
 */

require __DIR__ . '/../../vendor/autoload.php';

use TusPhp\Exception\TusException;
use TusPhp\Exception\FileException;
use TusPhp\Exception\ConnectionException;

$client = new \TusPhp\Tus\Client('http://localhost/test-tus/');

// Alert: Sanitize all inputs properly in production code
if ( ! empty($_FILES)) {
    $fileMeta  = $_FILES['tus_file'];
    $uploadKey = hash_file('md5', $fileMeta['tmp_name']);

    try {
        $client->setKey($uploadKey)->file($fileMeta['tmp_name'], time() . '_' . $fileMeta['name']);

        $bytesUploaded = $client->upload(5000000); // Chunk of 5 mb

        echo json_encode([
            'status' => 'uploading',
            'bytes_uploaded' => $bytesUploaded,
            'upload_key' => $uploadKey
        ]);
    } catch (ConnectionException | FileException | TusException $e) {
        echo json_encode([
            'status' => 'error',
            'bytes_uploaded' => -1,
            'upload_key' => '',
            'error' => $e->getMessage(),
            'trace' => $e->getCode(),
        ]);
    }
} else {
    echo json_encode([
        'status' => 'error',
        'bytes_uploaded' => -1,
        'error' => 'No input!',
    ]);
}

Thank you in advance for your assistance.

help/support

opened by Ludoviccharruau 14

tus-example of uppy work perfacly on localhost but not on apache server
Actually this is not bug or enhancement. I am posting here because I cant find proper documentation to understand some issues I have.

I am working on a project to upload large size(max 20gb) videos to server. I have implemented your partial upload example. And I am getting "Oops! Something went wrong. Please try again!".

I tried to debug the error and it lead me to the client.php file (src file). Basically this happening because of 200 passed in $statusCode.

I am trying to figure out the problem. Some of the points I have in mind that are causing the trouble.

Where to place server.php ?

What is mandatory to included inside server.php file ?

I wanna know about "Tus Endpoint"

How can I upload file to my desired location

my File path is same as yours - "http://localhost/tus-php/example/partial/"

Thanks in advance. @ankitpokhrel
help/support
opened by janakpuri 13
Framework Support

Is it possible for this to run on request within a framework, like Laravel?

I want to test this out, however with deployment it would be ideal to have requests handled by our app instead of running a separate server.
question/confusion

opened by s1rc 13

Cache file not working on windows

When using the FileStore Cache on windows, the file can't be written due to the lock.

If i skip the lock or use LOCK_UN on the lock function and then use LOCK_EX on the put() call then it works

Thanks a lot

Notice:  file_put_contents(): write of 549 bytes failed with errno=13 Permission  denied in  C:\laragon\www\filmfest\vendor\ankitpokhrel\tus-php\src\Cache\FileStore.php  on line 191
--
1 | 0.0004 | 412504 | {main}(  ) | ...\index.php:0
2 | 0.0332 | 2608360 | TusPhp\Tus\Server->serve(  ) | ...\index.php:22
3 | 0.0332 | 2608840 | TusPhp\Tus\Server->handlePost(  ) | ...\Server.php:276
4 | 0.0773 | 5572976 | TusPhp\Cache\FileStore->set( $key = 'add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f', $value = ['name'  => 'VID-20220325-WA0010 (1).mp4', 'size' => 3142632, 'offset'  => 0, 'checksum' => '', 'location' =>  'http://filmfest.test/uploads//add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f',  'file_path' =>  'C:\\laragon\\www\\filmfest\\uploads\\files/VID-20220325-WA0010  (1).mp4', 'metadata' => ['name' => 'VID-20220325-WA0010 (1).mp4',  'type' => 'video/mp4', 'filetype' => 'video/mp4', 'filename' =>  'VID-20220325-WA0010 (1).mp4'], 'created_at' => 'Tue, 12 Apr 2022  10:22:20 GMT', 'expires_at' => 'Tue, 12 Apr 2022 11:22:20 GMT',  'upload_type' => 'normal'] ) | ...\Server.php:379
5 | 0.0787 | 5573832 | TusPhp\Cache\FileStore->lock( $path = 'C:\\laragon\\www\\filmfest\\uploads\\files.json', $type = 2, $cb = class  Closure { virtual $closure = "$this->TusPhp\Cache\{closure}", public  $static = ['cacheKey' =>  'tus:server:add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f', 'cacheFile' =>  'C:\\laragon\\www\\filmfest\\uploads\\files.json', 'value' => [...]];  public $this = class TusPhp\Cache\FileStore { protected $cacheDir =  'C:\\laragon\\www\\filmfest\\uploads\\'; protected $cacheFile =  'files.json'; protected $ttl = 3600; protected $prefix = 'tus:server:'  }; public $parameter = ['$handle' => '<required>'] } ) | ...\FileStore.php:217
6 | 0.0789 | 5574208 | TusPhp\Cache\FileStore->TusPhp\Cache\{closure:C:\laragon\www\filmfest\vendor\ankitpokhrel\tus-php\src\Cache\FileStore.php:206-217}(  $handle = resource(143) of type (stream) ) | ...\FileStore.php:150
7 | 0.0792 | 5586920 | TusPhp\Cache\FileStore->put( $path = 'C:\\laragon\\www\\filmfest\\uploads\\files.json', $contents = '{"tus:server:add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f":{"name":"VID-20220325-WA0010   (1).mp4","size":3142632,"offset":0,"checksum":"","location":"http:\\/\\/filmfest.test\\/uploads\\/\\/add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f","file_path":"C:\\\\laragon\\\\www\\\\filmfest\\\\uploads\\\\files\\/VID-20220325-WA0010  (1).mp4","metadata":{"name":"VID-20220325-WA0010  (1).mp4","type":"video\\/mp4","filetype":"video\\/mp4","filename":"VID-20220325-WA0010  (1).mp4"},"created_at":"Tue, 12 Apr 2022 10:22:20 GMT","expires_at":"', $lock = 0 ) | ...\FileStore.php:216
8 | 0.0792 | 5586920 | file_put_contents( $filename = 'C:\\laragon\\www\\filmfest\\uploads\\files.json', $data = '{"tus:server:add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f":{"name":"VID-20220325-WA0010   (1).mp4","size":3142632,"offset":0,"checksum":"","location":"http:\\/\\/filmfest.test\\/uploads\\/\\/add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f","file_path":"C:\\\\laragon\\\\www\\\\filmfest\\\\uploads\\\\files\\/VID-20220325-WA0010  (1).mp4","metadata":{"name":"VID-20220325-WA0010  (1).mp4","type":"video\\/mp4","filetype":"video\\/mp4","filename":"VID-20220325-WA0010  (1).mp4"},"created_at":"Tue, 12 Apr 2022 10:22:20 GMT","expires_at":"', $flags = 0 ) | ...\FileStore.php:191


Warning:  file_put_contents(): Only -1 of 549 bytes written, possibly out of free  disk space in  C:\laragon\www\filmfest\vendor\ankitpokhrel\tus-php\src\Cache\FileStore.php  on line 191
--
1 | 0.0004 | 412504 | {main}(  ) | ...\index.php:0
2 | 0.0332 | 2608360 | TusPhp\Tus\Server->serve(  ) | ...\index.php:22
3 | 0.0332 | 2608840 | TusPhp\Tus\Server->handlePost(  ) | ...\Server.php:276
4 | 0.0773 | 5572976 | TusPhp\Cache\FileStore->set( $key = 'add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f', $value = ['name'  => 'VID-20220325-WA0010 (1).mp4', 'size' => 3142632, 'offset'  => 0, 'checksum' => '', 'location' =>  'http://filmfest.test/uploads//add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f',  'file_path' =>  'C:\\laragon\\www\\filmfest\\uploads\\files/VID-20220325-WA0010  (1).mp4', 'metadata' => ['name' => 'VID-20220325-WA0010 (1).mp4',  'type' => 'video/mp4', 'filetype' => 'video/mp4', 'filename' =>  'VID-20220325-WA0010 (1).mp4'], 'created_at' => 'Tue, 12 Apr 2022  10:22:20 GMT', 'expires_at' => 'Tue, 12 Apr 2022 11:22:20 GMT',  'upload_type' => 'normal'] ) | ...\Server.php:379
5 | 0.0787 | 5573832 | TusPhp\Cache\FileStore->lock( $path = 'C:\\laragon\\www\\filmfest\\uploads\\files.json', $type = 2, $cb = class  Closure { virtual $closure = "$this->TusPhp\Cache\{closure}", public  $static = ['cacheKey' =>  'tus:server:add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f', 'cacheFile' =>  'C:\\laragon\\www\\filmfest\\uploads\\files.json', 'value' => [...]];  public $this = class TusPhp\Cache\FileStore { protected $cacheDir =  'C:\\laragon\\www\\filmfest\\uploads\\'; protected $cacheFile =  'files.json'; protected $ttl = 3600; protected $prefix = 'tus:server:'  }; public $parameter = ['$handle' => '<required>'] } ) | ...\FileStore.php:217
6 | 0.0789 | 5574208 | TusPhp\Cache\FileStore->TusPhp\Cache\{closure:C:\laragon\www\filmfest\vendor\ankitpokhrel\tus-php\src\Cache\FileStore.php:206-217}(  $handle = resource(143) of type (stream) ) | ...\FileStore.php:150
7 | 0.0792 | 5586920 | TusPhp\Cache\FileStore->put( $path = 'C:\\laragon\\www\\filmfest\\uploads\\files.json', $contents = '{"tus:server:add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f":{"name":"VID-20220325-WA0010   (1).mp4","size":3142632,"offset":0,"checksum":"","location":"http:\\/\\/filmfest.test\\/uploads\\/\\/add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f","file_path":"C:\\\\laragon\\\\www\\\\filmfest\\\\uploads\\\\files\\/VID-20220325-WA0010  (1).mp4","metadata":{"name":"VID-20220325-WA0010  (1).mp4","type":"video\\/mp4","filetype":"video\\/mp4","filename":"VID-20220325-WA0010  (1).mp4"},"created_at":"Tue, 12 Apr 2022 10:22:20 GMT","expires_at":"', $lock = 0 ) | ...\FileStore.php:216
8 | 0.0792 | 5586920 | file_put_contents( $filename = 'C:\\laragon\\www\\filmfest\\uploads\\files.json', $data = '{"tus:server:add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f":{"name":"VID-20220325-WA0010   (1).mp4","size":3142632,"offset":0,"checksum":"","location":"http:\\/\\/filmfest.test\\/uploads\\/\\/add7ddc4-12a0-4b60-b8ae-2efa5fc32d5f","file_path":"C:\\\\laragon\\\\www\\\\filmfest\\\\uploads\\\\files\\/VID-20220325-WA0010  (1).mp4","metadata":{"name":"VID-20220325-WA0010  (1).mp4","type":"video\\/mp4","filetype":"video\\/mp4","filename":"VID-20220325-WA0010  (1).mp4"},"created_at":"Tue, 12 Apr 2022 10:22:20 GMT","expires_at":"', $flags = 0 ) | ...\FileStore.php:191

opened by gavrochelegnou 12

Mixed Content Error when using SSL provided by CDN
Is your feature request related to a problem? Please describe. I using a CDN based https/SSL certification. My server has no SSL and CDN to server communication is without https. So when uploading a file location header is the address of the website But without https then mixed content error happens.

Describe the solution you'd like A method to manually set the root path of the website.

$server = new TusServer(...); $server ->setApiPath('/admin/helpers/uppy/upload') ->setUploadDir(...) ->setRootPath('https://mywebsite.com');

Additional context

Edit: I using this solution for now.

$response = $server->serve(); if (! empty($response->headers->get('location'))) { $response->headers->set('location', rtrim(url('/'), '/').'/'.ltrim(array_get(parse_url($response->headers->get('location')), 'path'), '/')); } $response->send();
inactive help/support
opened by amir9480 12

Unable to create resource

Hello,

I'm trying for 2 days with this issue.

I'm working on: Windows 10 Laravel 8 Redis

I followed Laravel & Lumen Integration, also I implemented Basic example.

My problem in Upload function in FileException

the response from verify function:

{"status":"new","bytes_uploaded":0,"upload_key":"tus_file_6023bf72e3b8f"}

the response from upload function:

{"status":"error","bytes_uploaded":-1,"upload_key":"","error":"Unable to create resource."}

when I print the value of src/Tus/Client.php line 488

dd(HttpResponse::HTTP_CREATED , $statusCode)

HttpResponse::HTTP_CREATED = 201 $statusCode = 404

My routes in web.php:

Route::get('create', [\App\Http\Controllers\UploadController::class, 'create'])->name('upload.create');
Route::post('verify', [\App\Http\Controllers\UploadController::class, 'verify'])->name('upload.verify');
Route::post('upload', [\App\Http\Controllers\UploadController::class, 'upload'])->name('upload.upload');

Route::any('/tus/{any?}', function () {
    return app('tus-server')->serve();
})->where('any', '.*');

What I can solve this?

inactive help/support

opened by greatsami 11

Are there speed limitations in the server setup?

Is your feature request related to a problem? Please describe. I'm not sure where to ask this, so I put it here.

We're using Uppy's Dashboard on the client and your code on the server side. We’re seeing about 38Mb/s when uploading to an AWS server, but we can use Linux’s “scp” command to push about 115Mb/s to it. We’ve also tested SFTP (I know this is just like scp) with the same results. My gut is Uppy can handle much more than a 38Mb/s upload speed, and we've implemented the server side wrong.

Since I know the problem isn’t the internet line, my guess is a the Tus protocol must have some overhead to it, but again, this looks like much more overhead than I would expect (I'd expect ~10%).

Are there any limitations to the server side in your code for speeds under 1GB? Anything you think I should check in our code?

TIA,

Dave
inactive help/support

opened by kaarta-dstrickler 11
Checksum implementation does not match TUS specification

Describe the bug While Implementing my own PHP server-side code for receiving TUS uploads, and using your implementation as a reference, I noticed that your checksum implementation works completely different from what is specified in the TUS Checksum Extension specification.

To "Reproduce" Your implementation expects a checksum for the whole upload in the Upload-Creation POST request and checks the whole upload against that checksum at the end.

Expected behavior According to the spec, the checksum should be read from the header of each PATCH request and should only be checked against the data contained in that request.

Screenshots Not applicable.

Additional context I have to say, that I much prefer your implementation, as it makes much more sense for regular (un-chunked) file uploads. However it is not conforming to the spec, which is aimed at more general-purpose uploading. The server advertises support for the checksum extension, but will then completely ignore any checksums received in PATCH-requests. And no spec-conforming client will send a Upload-Checksum header with the upload-creation POST.

In my implementation I will replicate your behaviour using upload metadata, so it won't conflict with the TUS specification.

opened by ChrisK2 0
.env dependency improvement for Redis password and Tus cache filename
Config.php Edited; getCacheHome function

Config/server.php Added; redis.password field, Edited; file.name field

Config/client.php Added; redis.password field, Edited; file.name field

README file Edit; Comments

Added keys that can be used in .env file;

REDIS_PASSWORD

TUS_CACHE_FILE

TUS_CLIENT_CACHE_FILE
opened by aihsancom 1
Unable to upload files - PATCH GONE
Hello, I am unable to set up the server properly so that it uploads files.

tus.min.js:1 PATCH <URL> 410 (Gone)

file_loader.js:283 Chunk error! Error: tus: unexpected response while uploading chunk, originated from request (method: PATCH, url: <URL>, response code: 410, response text: , request id: n/a)

I am using client as follows:

const upload = new tus.Upload(file, { endpoint: "server/tus/", retryDelays: [0, 3000, 5000, 10000, 20000], chunkSize: this.chunkUploadSizeLimit, metadata: { name: file.name, type: file.type, fileName: file.name, relativePath: relativePath, }, onError: (e) => { ... }, onProgress: (bytesUploaded, bytesTotal) => { let percentage = Math.round(bytesUploaded / bytesTotal * 100); self._onUploadProgress(bytesTotal, percentage); }, onSuccess: () => { .... } });

And the server:

require("../vendor/autoload.php"); require_once "../config.php"; $server = new \TusPhp\Tus\Server('file'); $server->setUploadDir($tmp_dir); $response = $server->serve(); $response->send(); exit(0);

The client lives two directories up relative to the tus server so that relative path to server/tus/ runs the index.php from above. The same directory also contains the access rules:

RewriteEngine on RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^files/?(.*)?$ index.php?$1 [QSA,L]

The uploading progress bar reaches 100% and then shows the error with PATCH 410 GONE

I tried curling OPTIONS (200) HEAD (404) POST (400) PATCH (410) DELETE (404) with a non-existing key (since I did not upload any file successfully yet)

The upload directory is writable, tus_php.server.cache was created

Not setting the directory gave me error about not being able to open files in ..vendor/ankitpokhrel/tus-php/uploads so I guess it is set up correctly

The rewrite rules should be OK, tested redirection to a 'print it to me' php script

Thank you for your help.
opened by Aiosa 0
Issue#414 Fix Location header behind HTTPS proxy
Server.php behind HTTPS reverse proxy

Stop assuming the FQDN in Location header in responses

Rely upon ApiPath configuration instead

Responds with relative URLs by default
opened by psmirnov-dermview 1

Releases(v2.3.0)

v2.3.0(Sep 18, 2022)
What's Changed

feat: Make file cache path configurable by @ankitpokhrel in https://github.com/ankitpokhrel/tus-php/pull/396

fix: Lock file on windows by @thide11 in https://github.com/ankitpokhrel/tus-php/pull/383

fix: Return 410 if cache is expired for inflight requests by @ankitpokhrel in https://github.com/ankitpokhrel/tus-php/pull/389

deps: Update predis/predis requirement from ^1.1 to ^1.1 || ^2.0 by @dependabot in https://github.com/ankitpokhrel/tus-php/pull/394

New Contributors

@thide11 made their first contribution in https://github.com/ankitpokhrel/tus-php/pull/383

Full Changelog: https://github.com/ankitpokhrel/tus-php/compare/v2.2.1...v2.3.0
Source code(tar.gz)
Source code(zip)
v2.2.1(Mar 31, 2022)
What's Changed

fix: Align metadata extraction with protocol by @ankitpokhrel in https://github.com/ankitpokhrel/tus-php/pull/379

fix: do not pass null to strpos by @darthf1 in https://github.com/ankitpokhrel/tus-php/pull/384

fix: do not pass null to json_decode() by @darthf1 in https://github.com/ankitpokhrel/tus-php/pull/385

Full Changelog: https://github.com/ankitpokhrel/tus-php/compare/v2.2.0...v2.3.0
Source code(tar.gz)
Source code(zip)
v2.2.0(Jan 10, 2022)
This release allow Symfony 6 dependencies.

What's Changed

chore: Allow Symfony 6 by @darthf1 in https://github.com/ankitpokhrel/tus-php/pull/374

Full Changelog: https://github.com/ankitpokhrel/tus-php/compare/v2.1.3...v2.2.0
Source code(tar.gz)
Source code(zip)
v2.1.3(Nov 18, 2021)
This release fixes data race issue in the file cache that yields to 410 Gone error.

What's Changed

fix: Data race in file cache in https://github.com/ankitpokhrel/tus-php/pull/366 https://github.com/ankitpokhrel/tus-php/pull/369

chore: Some minor dependency update and refactoring

New Contributors

@keradus made their first contribution in https://github.com/ankitpokhrel/tus-php/pull/335

@sergiy-petrov made their first contribution in https://github.com/ankitpokhrel/tus-php/pull/357

Full Changelog: https://github.com/ankitpokhrel/tus-php/compare/v2.1.2...v2.1.3
Source code(tar.gz)
Source code(zip)
v1.3.2(Nov 18, 2021)
This release fixes data race issue in the file cache that yields to 410 Gone error.

What's Changed

fix: Data race in file cache https://github.com/ankitpokhrel/tus-php/pull/368

dep: Some minor dependency update

Full Changelog: https://github.com/ankitpokhrel/tus-php/compare/v1.3.1...v1.3.2
Source code(tar.gz)
Source code(zip)
v1.3.1(Dec 15, 2020)
Changelog

feat: Support creation-with-upload extension (#326)

Source code(tar.gz)
Source code(zip)
v2.1.2(Dec 15, 2020)
Changelog

feat: Support creation-with-upload extension (#326)

Source code(tar.gz)
Source code(zip)
v2.1.1(Nov 27, 2020)
Changelog

fix(client): Handle Guzzle ClientException (#324)

Source code(tar.gz)
Source code(zip)
v1.3.0(Nov 27, 2020)
Changelog

feat(dep): Support guzzle 7 (#320)

fix(client): Handle Guzzle ClientException (#324)

Source code(tar.gz)
Source code(zip)
v2.1.0(Nov 14, 2020)
Changelog

feat: PHP 8.0 Support (#307)

fix: Ignore Tus-Resumable header in OPTIONS request (#295)

Source code(tar.gz)
Source code(zip)
v1.2.3(Nov 14, 2020)
Changelog

fix: Ignore Tus-Resumable header in OPTIONS request (#295)

Source code(tar.gz)
Source code(zip)
v2.0.1(Jul 10, 2020)
Changelog

feat(client): Pass headers to subsequent requests (#281)

dep: symfony/mime is now explicitly required to guess the mime type (#272)

core: Response::create is deprecated since Symfony 5.1 (#282, #274)

Source code(tar.gz)
Source code(zip)
v1.2.2(Jul 10, 2020)
Changelog

feat(client): Pass headers to subsequent requests (#281)

Source code(tar.gz)
Source code(zip)
v2.0.0(May 8, 2020)
Changelog

Upgrade Symfony packages to support latest version of all major PHP frameworks 🎉

Source code(tar.gz)
Source code(zip)
v1.2.1(May 7, 2020)
Changelog

feat: Allow to inject event dispatcher (#235)

minor: Remove newline in bin/tus causing extra output (#238)

minor: Dependencies update

Source code(tar.gz)
Source code(zip)
v1.2.0(Jan 11, 2020)
Changelog

feat: Support for PHP 7.4 🎉

feat: Support for APCu cache (#212)

imprv: Update Symfony package to fix security vulnerabilities (#217)

Source code(tar.gz)
Source code(zip)
v1.1.0(Nov 17, 2019)
Changelog

feat: Save user sent metadata (#166, #163)

feat: Add support for aws stream wrappers (#178)

fix: Event dispached before all headers are set (#162, #197)

imprv: Remove uniqid usage (#140, #196)

imprv: Native function invocation (#190, #193, #198)

imprv: Some minor code improvements

Source code(tar.gz)
Source code(zip)
v1.0.12(Jul 28, 2019)
Changelog

Remove iconv filename fallback (#165, #169)

Allow spaces in filename (#170, #171)

Fix partial upload (#174)

Source code(tar.gz)
Source code(zip)
v1.0.9(Jul 21, 2019)
Changelog

[Security] Fix path injection issue (#168)

Source code(tar.gz)
Source code(zip)
v1.0.8(May 26, 2019)
Changelog

Fix redis env check (#147)

Fix symfony/event-dispatcher version (#149)

Allow extra metadata in Upload-Metadata header (#152)

Example improvement (#144)

Source code(tar.gz)
Source code(zip)
v1.0.5(Apr 14, 2019)
Changelog

Fix Tus-Resumable header missing from OPTIONS response (#134 , #135)

Source code(tar.gz)
Source code(zip)
v1.0.4(Jan 15, 2019)
Changelog

Add missing checksum and key to some events (#120, #122)

Create a public setChecksum method for Client (#121, #123)

Fix ./vendor/bin/tus does not exist issue during install (#127, #128)

Some minor improvements (#129)

Source code(tar.gz)
Source code(zip)
v1.0.0(Jan 1, 2019)
First stable release

Changelog

Fix creation extension implementation (#92, #101)

Add support for events/hooks (#111)

Add shared locks in FileStore (#103, #104)

Verify expiry date-time during upload (#97, #117)

Improve dependency constraints (#108, #110)

Exclude unnecessary files from release (#113)

Source code(tar.gz)
Source code(zip)
v0.1.0(Nov 17, 2018)
Changelog

Server

Fix Upload-Metadata extract implementation (#82, #84)

Treat HEAD and GET as an identical request (#86, #87)

Add missing checks in PATCH request (#96, #98)

Client

Fix client to accept guzzle options (#75, #88, #90)

Add missing headers when sending requests to server (#91, #95)

Other improvements (#85, #89)

Source code(tar.gz)
Source code(zip)
v0.0.0(Sep 23, 2018)
First beta release

Changelog

Tus Server

Cache support: File and redis

Extension Support: Creation, Termination, Checksum, Expiration and Concatenation

Middleware to manipulate request and response of a server

Tus PHP Client for creating, resuming and/or deleting uploads

Compatible with uppy

Source code(tar.gz)
Source code(zip)

TusPHP - 🚀a HTTP based protocol for resumable file uploads.

Related tags

Overview

TusPHP

Table of Contents

Installation

Usage

Server

Nginx

Apache

Client

Third Party Client Libraries

Cloud Providers

Extension Support

Expiration

Concatenation

Events

Responding to an Event

Middleware

Creating a Middleware

Adding a Middleware

Skipping a Middleware

Setting up a dev environment and/or running examples locally

Docker

Contributing

Questions about this project?

Supporters

Comments

Releases(v2.3.0)

v2.3.0(Sep 18, 2022)

What's Changed

New Contributors

v2.2.1(Mar 31, 2022)

What's Changed

v2.2.0(Jan 10, 2022)

What's Changed

v2.1.3(Nov 18, 2021)

What's Changed

New Contributors

v1.3.2(Nov 18, 2021)

What's Changed

v1.3.1(Dec 15, 2020)

Changelog

v2.1.2(Dec 15, 2020)

Changelog

v2.1.1(Nov 27, 2020)

Changelog

v1.3.0(Nov 27, 2020)

Changelog

v2.1.0(Nov 14, 2020)

Changelog

v1.2.3(Nov 14, 2020)

Changelog

v2.0.1(Jul 10, 2020)

Changelog

v1.2.2(Jul 10, 2020)

Changelog

v2.0.0(May 8, 2020)

Changelog

v1.2.1(May 7, 2020)

Changelog

v1.2.0(Jan 11, 2020)

Changelog

v1.1.0(Nov 17, 2019)

Changelog

v1.0.12(Jul 28, 2019)

Changelog

v1.0.9(Jul 21, 2019)

Changelog

v1.0.8(May 26, 2019)

Changelog

v1.0.5(Apr 14, 2019)

Changelog

v1.0.4(Jan 15, 2019)

Changelog

v1.0.0(Jan 1, 2019)

Changelog

v0.1.0(Nov 17, 2018)

Changelog

v0.0.0(Sep 23, 2018)