Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FileElement: Preserve file across requests #107

Merged
merged 2 commits into from
Feb 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions asset/css/file-element.less
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
form .uploaded-files {
list-style-type: none;
padding: 0;
margin: 0;

> li:not(:last-of-type) {
margin-bottom: .5em;
}

button[type="submit"].remove-uploaded-file {
.icon {
font-size: 1.2em;
}

&:focus, &:hover {
cursor: pointer;

.icon {
color: red;
}
}
}

// text-overflow: ellipsis layout rules, yes, exclusively
> li {
display: flex;

> button[type="submit"].remove-uploaded-file {
display: inline-flex;
flex: 1 1 auto;
width: 0;

> span {
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
}
}
}
5 changes: 2 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,10 @@
},
"require": {
"php": ">=7.2",
"ext-fileinfo": "*",
"ipl/stdlib": ">=0.12.0",
"ipl/validator": "dev-master",
"psr/http-message": "~1.0"
},
"require-dev": {
"psr/http-message": "~1.0",
"guzzlehttp/psr7": "^1"
},
"autoload": {
Expand Down
247 changes: 240 additions & 7 deletions src/FormElement/FileElement.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,41 @@

namespace ipl\Html\FormElement;

use GuzzleHttp\Psr7\UploadedFile;
use InvalidArgumentException;
use ipl\Html\Attributes;
use ipl\Html\Form;
use ipl\Html\HtmlDocument;
use ipl\Html\HtmlElement;
use ipl\Html\Text;
use ipl\I18n\Translation;
use ipl\Validator\FileValidator;
use ipl\Validator\ValidatorChain;
use ipl\Web\Widget\Icon;
use Psr\Http\Message\UploadedFileInterface;
use ipl\Html\Common\MultipleAttribute;

use function ipl\Stdlib\get_php_type;

class FileElement extends InputElement
{
use MultipleAttribute;
use Translation;

protected $type = 'file';

/** @var UploadedFileInterface|UploadedFileInterface[] */
protected $value;

/** @var UploadedFileInterface[] Files that are stored on disk */
protected $files = [];

/** @var string[] Files to be removed from disk */
protected $filesToRemove = [];

/** @var ?string The path where to store the file contents */
protected $destination;

/** @var int The default maximum file size */
protected static $defaultMaxFileSize;

Expand All @@ -27,6 +47,30 @@ public function __construct($name, $attributes = null)
parent::__construct($name, $attributes);
}

/**
* Set the path where to store the file contents
*
* @param string $path
*
* @return $this
*/
public function setDestination(string $path): self
{
$this->destination = $path;

return $this;
}

/**
* Get the path where file contents are stored
*
* @return ?string
*/
public function getDestination(): ?string
{
return $this->destination;
}

public function getValueAttribute()
{
// Value attributes of file inputs are set only client-side.
Expand All @@ -43,21 +87,166 @@ public function getNameAttribute()
public function hasValue()
{
if ($this->value === null) {
return false;
}
$files = $this->loadFiles();
if (empty($files)) {
return false;
}

$file = $this->value;
if (! $this->isMultiple()) {
$files = $files[0];
}

if ($this->isMultiple()) {
return $file[0]->getError() !== UPLOAD_ERR_NO_FILE;
$this->value = $files;
}

return $file->getError() !== UPLOAD_ERR_NO_FILE;
return $this->value !== null;
}

public function getValue()
{
return $this->hasValue() ? $this->value : null;
if (! $this->hasValue()) {
return null;
}

if (! $this->hasFiles()) {
$files = $this->value;
if (! $this->isMultiple()) {
$files = [$files];
}

$storedFiles = $this->storeFiles(...$files);
if (! $this->isMultiple()) {
$storedFiles = $storedFiles[0];
}

$this->value = $storedFiles;
}

return $this->value;
}

public function setValue($value)
{
if (! empty($value)) {
$fileToTest = $value;
if ($this->isMultiple()) {
$fileToTest = $value[0];
}

if (! $fileToTest instanceof UploadedFileInterface) {
throw new InvalidArgumentException(
sprintf('%s is not an uploaded file', get_php_type($fileToTest))
);
}

if ($fileToTest->getError() === UPLOAD_ERR_NO_FILE && ! $fileToTest->getClientFilename()) {
$value = null;
}
} else {
$value = null;
}

return parent::setValue($value);
}

/**
* Get whether there are any files stored on disk
*
* @return bool
*/
protected function hasFiles(): bool
{
return $this->destination !== null && reset($this->files);
}

/**
* Load and return all files stored on disk
*
* @return UploadedFileInterface[]
*/
protected function loadFiles(): array
{
if (empty($this->files) || $this->destination === null) {
return [];
}

foreach ($this->files as $name => $_) {
$filePath = $this->getFilePath($name);
if (! is_readable($filePath) || ! is_file($filePath)) {
// If one file isn't accessible, none is
return [];
}

if (in_array($name, $this->filesToRemove, true)) {
@unlink($filePath);
} else {
$this->files[$name] = new UploadedFile(
$filePath,
filesize($filePath),
0,
$name,
mime_content_type($filePath)
);
}
}

$this->files = array_diff_key($this->files, array_flip($this->filesToRemove));

return array_values($this->files);
}

/**
* Store the given files on disk
*
* @param UploadedFileInterface ...$files
*
* @return UploadedFileInterface[]
*/
protected function storeFiles(UploadedFileInterface ...$files): array
{
if ($this->destination === null || ! is_writable($this->destination)) {
return $files;
}

foreach ($files as $file) {
$name = $file->getClientFilename();
$path = $this->getFilePath($name);

$file->moveTo($path);

// Re-created to ensure moveTo() still works if called externally
$this->files[$name] = new UploadedFile(
$path,
$file->getSize(),
0,
$name,
$file->getClientMediaType()
);
}

return array_values($this->files);
}

/**
* Get the file path on disk of the given file
*
* @param string $name
*
* @return string
*/
protected function getFilePath(string $name): string
{
return implode(DIRECTORY_SEPARATOR, [$this->destination, sha1($name)]);
}

public function onRegistered(Form $form)
{
$chosenFiles = (array) $form->getPopulatedValue('chosen_file_' . $this->getName(), []);
foreach ($chosenFiles as $chosenFile) {
$this->files[$chosenFile] = null;
}

$this->filesToRemove = (array) $form->getPopulatedValue('remove_file_' . $this->getName(), []);
}

protected function addDefaultValidators(ValidatorChain $chain): void
Expand All @@ -79,6 +268,7 @@ protected function registerAttributeCallbacks(Attributes $attributes)
{
parent::registerAttributeCallbacks($attributes);
$this->registerMultipleAttributeCallback($attributes);
$this->getAttributes()->registerAttributeCallback('destination', null, [$this, 'setDestination']);
}

/**
Expand Down Expand Up @@ -159,4 +349,47 @@ protected static function getUploadMaxFilesize(): string
{
return ini_get('upload_max_filesize') ?: '2M';
}

protected function assemble()
{
$doc = new HtmlDocument();
if ($this->hasFiles()) {
foreach ($this->files as $file) {
$doc->addHtml(new HiddenElement('chosen_file_' . $this->getNameAttribute(), [
'value' => $file->getClientFilename()
]));
}

$this->prependWrapper($doc);
}
}

public function renderUnwrapped()
{
if (! $this->hasValue() || ! $this->hasFiles()) {
return parent::renderUnwrapped();
}

$uploadedFiles = new HtmlElement('ul', Attributes::create(['class' => 'uploaded-files']));
foreach ($this->files as $file) {
$uploadedFiles->addHtml(new HtmlElement(
'li',
null,
(new ButtonElement('remove_file_' . $this->getNameAttribute(), Attributes::create([
'type' => 'submit',
'formnovalidate' => true,
'class' => 'remove-uploaded-file',
'value' => $file->getClientFilename(),
'title' => sprintf($this->translate('Remove file "%s"'), $file->getClientFilename())
])))->addHtml(new HtmlElement(
'span',
null,
new Icon('remove'),
Text::create($file->getClientFilename())
))
));
}

return $uploadedFiles->render();
}
}
Loading