evgen-dev/plupload-for-laravel

Laravel/Plupload - Handle large file uploads

v0.1.2 2023-06-15 09:18 UTC

Requires

• php: >=7.4.2
• illuminate/support: ^8.0 | ^9.0 | ^10.0

MIT

• Evgenii Devisok aka evgen_dev

• laravel
• pluload
• large files

README

Laravel plupload support.

Handeling chunked uploads.

Installation

Install using composer

composer require evgen-dev/plupload-for-laravel

Add the provider to config/app.php

'providers' => [
    EvgenDev\LaravelPlupload\LaravelPluploadServiceProvider::class,
]

And the facade for short record if you want

'aliases' => array(
    'Plupload' => EvgenDev\LaravelPlupload\Facades\Plupload::class,
),

Using

1. Create localization file resources/lang/en/validation.php file if not exists and add lines:

return [
    'invalid_file_extension' => 'It is forbidden to upload .:extension files',

    'max' => [
        'file' => 'The :attribute field must not be greater than :max :units.',
    ]
];

2. Add upload routes

Basic usage without any limitations:

Route::post('/upload', function(){
    return Plupload::receive('file', function($file){
        $file->move(storage_path() . '/plupload/', $file->getClientOriginalName());
        return true;
    });

});

Limit uploading file size:

use EvgenDev\LaravelPlupload\Filters\Filesize;

Route::post('/upload', function(){
    return Plupload::sizelimit(3, Filesize::FILE_SIZE_UNITS_MB)
    ->receive('file', function($file){
        $file->move(storage_path() . '/plupload/', $file->getClientOriginalName());
        return true;
    });
});

Limit uploading file extensions:

Route::post('/upload', function()
{
    return Plupload::extensions(['jpg', 'png', 'gif'])->receive('file', function($file){
        $file->move(storage_path() . '/plupload/', $file->getClientOriginalName());
        return true;
    });

});

Limit uploading file size and files extensions:

use \EvgenDev\LaravelPlupload\Filters\Filesize;

Route::post('/upload', function()
{
    return Plupload::sizelimit(5, Filesize::FILE_SIZE_UNITS_MB)
    ->extensions(['jpg', 'png', 'gif'])
    ->receive('file', function($file){
        $file->move(storage_path() . '/plupload/', $file->getClientOriginalName());
        return 'ready';
    });
});

Usage in controller

use EvgenDev\LaravelPlupload\Facades\Plupload;

public function upload(Request $request){
    return Plupload::sizelimit(5, Filesize::FILE_SIZE_UNITS_MB)
        ->extensions(['txt'])
        ->receive('file', function($file){
            $filename = uniqid().'.'.$file->extension();
            $file->move(storage_path() . '/plupload/', $filename);
            return ['success' => true, 'filename' => $filename];
        });
}

3. csrf-token validation

There are two ways.

1. Passing the token

Add in your blade file

<meta name="csrf-token" content="{{ csrf_token() }}">

in your Plupload inititalization JS file, add

headers: {
    'X-CSRF-TOKEN': $('meta[name="csrf-token"]').attr('content')
},

Don't forget to refresh the token after each request.

2. Disabling token validation

Add to your route rule:

->withoutMiddleware([\App\Http\Middleware\VerifyCsrfToken::class]);

It should turn out like this:

Route::post('/upload', function()
{
    return Plupload::receive('file', function($file){
        $file->move(storage_path() . '/plupload/', $file->getClientOriginalName());
        return true;
    });

})->withoutMiddleware([\App\Http\Middleware\VerifyCsrfToken::class]);

4. Preventing chunk uploading after file size or extension error

Add to your JS file event handling:

uploader.bind('ChunkUploaded', function(up, file, response) {
        response = jQuery.parseJSON(response.response);
        if(response.error && (response.error.code == 413 || response.error.code == 415)){
            alert(response.error.message);
            file.destroy();
        }
        up.refresh();
    });

Enjoy!