ecolinet/large-file-upload

Allow file uploads with a very low memory consumption

Large File Upload

The class is a way to make use of PHP's built-in enable_post_data_reading setting., _(*1)

The idea is to allow files upload with a very low memory consumption., _(*2)

Note : due to a bug in the PHP-FPM SAPI, that package doesn't, currently, works with PHP-FPM., _(*3)

Installation

Install the latest version with :, _(*4)

$ composer require ecolinet/large-file-upload

How to ?

Deactivate enable_post_data_reading

First be sure to set enable_post_data_reading to 0 on a specific directory (e.g. public/upload/)., _(*5)

There are many ways to do that, but keep in mind that, since this directive is PHP_INI_PER_DIR, it can't be changed with ini_set (it's logical since _POST & _FILES are processed before the script runs)., _(*6)

And since it changes in many ways how PHP behaves it is not a good idea to set it globally (e.g. in php.ini)., _(*7)

.htaccess

Here is an example with apache2 & mod_php with .htaccess overriding enabled :, _(*8)

# Root of all things
php_flag enable_post_data_reading 0

Note : of course it is a better idea to do that in the main configuration., _(*9)

.user.ini

Here is an example if you are using php-fpm :, _(*10)

; Root of all things
enable_post_data_reading=0

Note : unlike .htaccess files, that kind of files are cached among requests (300s per default), so you can use them without the performance penalty., _(*11)

Use the class

Here is a small snippet of how to use it :, _(*12)

$uploader = new \LargeFile\Uploader();
$parts = $uploader->read();

$parts will be an array of elements composed of :, _(*13)

• headers : array of all MIME headers sent by the browser
• file : local filename of an uploaded file
• or content : content of a posted field

Typical setup

Tree-ish view

my-app
└── public
    └── upload
        ├── .htaccess
        ├── .user.ini
        └── index.php

index.php

<?php
require_once __DIR__ . '/../../vendor/autoload.php';

try {

    // Get uploaded files
    $uploader = new \LargeFile\Uploader();
    $parts = $uploader->read();

} catch (\Exception $e) {

    header('Content-type: application/json; charset=utf-8', true, 500);
    echo json_encode([
        'status'  => "KO",
        'message' => "Error !",
    ]);
    error_log(get_class($e) . ': ' . $e->getMessage());
}

// Persist files out of tmp
foreach ($parts as $part) {
    $filename = $part['headers']['filename'];
    rename(
        $part['file'],
        __DIR__ . '/../../data/upload/' . uniqid() . '-' . $filename
    );
}

// Send success status
header('Content-type: application/json; charset=utf-8', true, 200);
echo json_encode([
    'status'  => "OK",
    'message' => "File(s) uploaded",
]);