+ An all in one Laravel backend for FilePond
+
+ We currently support the `process` and `revert` methods and are securing those via the Laravel encryption/decryption methods. +
+ +## :rocket: Be up and running in 2 minutes + +### Laravel setup + +Require this package in the `composer.json` of your Laravel project. + +```php +composer require sopamo/laravel-filepond +``` + +If you need to edit the configuration, you can publish it with: + +```php +php artisan vendor:publish --provider="Sopamo\LaravelFilepond\LaravelFilepondServiceProvider" +``` + +When you receive the serverId from Filepond (that's the value which you get via the hidden input fields) in your controller you can decode it via: + +```php +// Get the temporary path +$filepond = app(Sopamo\LaravelFilepond\Filepond::class); +$path = $filepond->getPathFromServerId($serverId); + +// Move the file from the temporary path to the final location +$finalLocation = public_path('output.jpg'); +\File::move($path, $finalLocation); +``` + +### Filepond setup + +Set at least the following Filepond configuration: + +```javascript +FilePond.setOptions({ + name: 'file', + server: 'https://yourdomain.com/filepond/api/process', +}) +``` + diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..9d87637 --- /dev/null +++ b/composer.json @@ -0,0 +1,37 @@ +{ + "name": "sopamo/laravel-filepond", + "description": "Laravel backend module for filepond uploads", + "license": "MIT", + "keywords": [ + "laravel", + "php", + "filepond", + "upload", + "image" + ], + "authors": [ + { + "name": "Paul Mohr", + "email": "p.mohr@sopamo.de" + } + ], + "require": { + "php": "^7.0", + "illuminate/support": "~5.5.0|~5.6.0|~5.7.0|~5.8.0", + "illuminate/contracts": "~5.5.0|~5.6.0|~5.7.0|~5.8.0" + }, + "autoload": { + "psr-4": { + "Sopamo\\LaravelFilepond\\": "src/" + } + }, + "extra": { + "laravel": { + "providers": [ + "Sopamo\\LaravelFilepond\\LaravelFilepondServiceProvider" + ] + } + }, + "minimum-stability": "dev", + "prefer-stable": true +} diff --git a/config/filepond.php b/config/filepond.php new file mode 100644 index 0000000..ac98e4b --- /dev/null +++ b/config/filepond.php @@ -0,0 +1,24 @@ + 'api', + + /* + |-------------------------------------------------------------------------- + | Local Temporary Path + |-------------------------------------------------------------------------- + | + | When initially uploading the files we store them in this path + | + */ + 'temporary_files_path' => sys_get_temp_dir(), + +]; diff --git a/routes/web.php b/routes/web.php new file mode 100644 index 0000000..bad280b --- /dev/null +++ b/routes/web.php @@ -0,0 +1,7 @@ +group(function () { + Route::post('/process', 'FilepondController@upload')->name('filepond.upload'); + Route::delete('/process', 'FilepondController@delete')->name('filepond.delete'); +}); diff --git a/src/Exceptions/InvalidPathException.php b/src/Exceptions/InvalidPathException.php new file mode 100644 index 0000000..796fd18 --- /dev/null +++ b/src/Exceptions/InvalidPathException.php @@ -0,0 +1,16 @@ +filepond = $filepond; + } + + /** + * Uploads the file to the temporary directory + * and returns an encrypted path to the file + * + * @param Request $request + * @return \Illuminate\Http\Response + */ + public function upload(Request $request) + { + $file = $request->file('file'); + + $filePath = tempnam(config('filepond.temporary_files_path'), "laravel-filepond"); + $filePathParts = pathinfo($filePath); + + if(!$file->move($filePathParts['dirname'], $filePathParts['basename'])) { + return Response::make('Could not save file', 500); + } + return Response::make($this->filepond->getServerIdFromPath($filePath), 200); + } + + /** + * Takes the given encrypted filepath and deletes + * it if it hasn't been tampered with + * + * @param Request $request + * @return mixed + */ + public function delete(Request $request) { + $filePath = $this->filepond->getPathFromServerId($request->getContent()); + if(unlink($filePath)) { + return Response::make('', 200); + } else { + return Response::make('', 500); + } + } +} \ No newline at end of file diff --git a/src/LaravelFilepondServiceProvider.php b/src/LaravelFilepondServiceProvider.php new file mode 100644 index 0000000..b964e54 --- /dev/null +++ b/src/LaravelFilepondServiceProvider.php @@ -0,0 +1,48 @@ +registerRoutes(); + } + + /** + * {@inheritdoc} + */ + public function register() + { + $this->mergeConfigFrom( + $this->getConfigFile(), + 'filepond' + ); + } + + /** + * Register the Horizon routes. + * + * @return void + */ + protected function registerRoutes() + { + Route::group([ + 'prefix' => 'filepond', + 'namespace' => 'Sopamo\LaravelFilepond\Http\Controllers', + 'middleware' => config('filepond.middleware', null), + ], function () { + $this->loadRoutesFrom(__DIR__.'/../routes/web.php'); + }); + } + + /** + * @return string + */ + protected function getConfigFile(): string + { + return __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'filepond.php'; + } +}