spazzmarticus/tus-server

Tus.io-protocol server implementation using PSR standards

2.0.0-rc4 2024-03-13 06:31 UTC

Requires

• php: ^8.2|^8.3
• psr/event-dispatcher: ^1.0
• psr/http-factory: ^1.0.2
• psr/http-server-handler: ^1.0.2
• psr/log: ^1.1|^2.0|^3.0
• psr/simple-cache: ^1.0|^2.0|^3.0
• ramsey/uuid: ^4.7.5

Requires (Dev)

• cache/filesystem-adapter: ^1.2.0
• friendsofphp/php-cs-fixer: ^3.51.0
• laminas/laminas-diactoros: ^3.3.1
• laminas/laminas-httphandlerrunner: ^2.10.0
• mikey179/vfsstream: ^1.6.11
• monolog/monolog: ^3.5.0
• phpstan/phpstan: ^1.10.60
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^11.0.5
• psr/http-server-middleware: ^1.0.2
• rector/rector: ^1.0.2
• symfony/event-dispatcher: ^7.0.3

GPL-3.0-or-later

• SpazzMarticus

README

A server implementation of the "tus.io Resumable File Uploads" protocol using PSR HTTP standards.

Installation

Use composer to install:

composer require spazzmarticus/tus-server

Don't forget to install a PSR-7 and PSR-17 implementation you want to use.

PSR

Implements

• PSR-15: HTTP Server Request Handlers - TusServer implements Psr\Http\Server\RequestHandlerInterface

Uses

• PSR-3: Logger Interface - (optional) Pass a Psr\Log\LoggerInterface to TusServer

• PSR-7: HTTP Message Interface - An instance of Psr\Http\Message\ServerRequestInterface must be passed to TusServer .

• PSR-17: HTTP Factories - Responses are created by using a Psr\Http\Message\ResponseFactoryInterface

• PSR-16: Simple Cache - Is used to store metadata (path to the file, Upload-Metadata passed by client, ... ) while uploading. [see "Cache as storage?!" below]

• PSR-12: Extended Coding Style Guide - Code is written and formatted according to PSR-12.

Demo

You can demo TusServer by installing the dev-dependencies ( composer install ) and running the provided server.php :

php -S localhost:8000 example/server.php

Open your browser, surf to localhost:8000/ and use (Uppy) to upload.

Uploads are stored at example/uploads/... , the filesystem cache is at example/cache/ .

Surf to localhost:8000/reset to permanently delete uploads, intermediate chunks and the metadata-storage. There might be an error log at example/log/php-error.php and a server log at example/log/tus-server.log containing some additional information.

Test

Automated testing is done with:

• PHPUnit - unit- and integration-tests
• newman - Verify TusServer meets the tus. io-protocol.

Examples

• Slim v4 - Slim routes allow to directly call this tus-server implementation.

👋 This is how I use tus-server.

Cache as storage?!

TusServer needs something fast to store metadata about uploads. Since the payload is small and performance is important, caches can be used.

Instead of using a volatile cache only, you should use a chain containing both a fast volatile and a slower non-volatile cache. (Losing the metadata mid-upload does not allow for resuming uploads. )

👋 I use symfony/cache:

 $volatileCache = new Symfony\Component\Cache\Adapter\ApcuAdapter('...');
 $nonVolatileCache = new Symfony\Component\Cache\Adapter\FilesystemAdapter('', 0, __DIR__ . '/...');

 $cacheChain = new Symfony\Component\Cache\Adapter\ChainAdapter([$volatileCache, $nonVolatileCache]);

 $storage = new Symfony\Component\Cache\Psr16Cache($cacheChain);

Alternatives

• ankitpokhrel/tus-php - Did not provide enough flexibility for my needs and is the reason I decided to start my own implementation. (Provides a php tus-client, if you are looking for that.)