silverstripe-framework/src/Forms/FileField.php

254 lines
7.5 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\Forms;
use SilverStripe\Assets\File;
use SilverStripe\Control\HTTP;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DataObjectInterface;
/**
* Represents a file type which can be added to a form.
* Automatically tries to save has_one-relations on the saved
* record.
2014-08-15 08:53:05 +02:00
*
* Please set a validator on the form-object to get feedback
* about imposed filesize/extension restrictions.
2014-08-15 08:53:05 +02:00
*
* <b>Usage</p>
2014-08-15 08:53:05 +02:00
*
* If you want to implement a FileField into a form element, you need to pass it an array of source data.
2014-08-15 08:53:05 +02:00
*
* <code>
* class ExampleFormController extends PageController {
2014-08-15 08:53:05 +02:00
*
2016-11-29 04:18:48 +01:00
* function Form() {
* $fields = new FieldList(
* new TextField('MyName'),
* new FileField('MyFile')
* );
* $actions = new FieldList(
* new FormAction('doUpload', 'Upload file')
* );
* $validator = new RequiredFields(['MyName', 'MyFile']);
2014-08-15 08:53:05 +02:00
*
2016-11-29 04:18:48 +01:00
* return new Form($this, 'Form', $fields, $actions, $validator);
* }
2014-08-15 08:53:05 +02:00
*
2016-11-29 04:18:48 +01:00
* function doUpload($data, $form) {
* $file = $data['MyFile'];
* $content = file_get_contents($file['tmp_name']);
* // ... process content
* }
* }
* </code>
*/
class FileField extends FormField implements FileHandleField
2016-11-29 04:18:48 +01:00
{
use UploadReceiver;
protected $inputType = 'file';
2016-11-29 04:18:48 +01:00
/**
* Flag to automatically determine and save a has_one-relationship
* on the saved record (e.g. a "Player" has_one "PlayerImage" would
* trigger saving the ID of newly created file into "PlayerImageID"
* on the record).
*
* @var boolean
*/
protected $relationAutoSetting = true;
/**
* Create a new file field.
*
* @param string $name The internal field name, passed to forms.
* @param string $title The field label.
* @param int $value The value of the field.
*/
public function __construct($name, $title = null, $value = null)
{
$this->constructUploadReceiver();
parent::__construct($name, $title, $value);
}
/**
* @param array $properties
* @return string
*/
public function Field($properties = [])
2016-11-29 04:18:48 +01:00
{
$properties = array_merge($properties, [
2016-11-29 04:18:48 +01:00
'MaxFileSize' => $this->getValidator()->getAllowedMaxFileSize()
]);
2016-11-29 04:18:48 +01:00
return parent::Field($properties);
}
public function getAttributes()
{
$attributes = parent::getAttributes();
$accept = $this->getAcceptFileTypes();
if ($accept) {
$attributes = array_merge(['accept' => implode(',', $accept)], $attributes);
}
return $attributes;
}
/**
* Returns a list of file extensions (and corresponding mime types) that will be accepted
*
* @return array
*/
protected function getAcceptFileTypes()
{
$extensions = $this->getValidator()->getAllowedExtensions();
if (!$extensions) {
return [];
}
$accept = [];
$mimeTypes = HTTP::config()->uninherited('MimeTypes');
foreach ($extensions as $extension) {
$accept[] = ".{$extension}";
// Check for corresponding mime type
if (isset($mimeTypes[$extension])) {
$accept[] = $mimeTypes[$extension];
}
}
2022-04-14 03:12:59 +02:00
return array_unique($accept ?? []);
}
2016-11-29 04:18:48 +01:00
/**
* @param DataObject|DataObjectInterface $record
*/
public function saveInto(DataObjectInterface $record)
{
if (!isset($_FILES[$this->name]['error']) || $_FILES[$this->name]['error'] == UPLOAD_ERR_NO_FILE) {
2016-11-29 04:18:48 +01:00
return;
}
$fileClass = File::get_class_for_file_extension(
File::get_file_extension($_FILES[$this->name]['name'])
);
/** @var File $file */
if ($this->relationAutoSetting) {
// assume that the file is connected via a has-one
$objectClass = DataObject::getSchema()->hasOneComponent(get_class($record), $this->name);
if ($objectClass === File::class || empty($objectClass)) {
// Create object of the appropriate file class
$file = Injector::inst()->create($fileClass);
2016-11-29 04:18:48 +01:00
} else {
// try to create a file matching the relation
$file = Injector::inst()->create($objectClass);
2016-11-29 04:18:48 +01:00
}
} elseif ($record instanceof File) {
$file = $record;
} else {
$file = Injector::inst()->create($fileClass);
2016-11-29 04:18:48 +01:00
}
$this->upload->loadIntoFile($_FILES[$this->name], $file, $this->getFolderName());
if ($this->upload->isError()) {
return;
}
if ($this->relationAutoSetting) {
if (empty($objectClass)) {
return;
}
$file = $this->upload->getFile();
$record->{$this->name . 'ID'} = $file->ID;
}
}
public function Value()
{
return isset($_FILES[$this->getName()]) ? $_FILES[$this->getName()] : null;
}
public function validate($validator)
{
// FileField with the name multi_file_syntax[] or multi_file_syntax[key] will have the brackets trimmed in
// $_FILES super-global so it will be stored as $_FILES['mutli_file_syntax']
// multi-file uploads, which are not officially supported by Silverstripe, though may be
// implemented in custom code, so we should still ensure they are at least validated
2022-04-14 03:12:59 +02:00
$isMultiFileUpload = strpos($this->name ?? '', '[') !== false;
$fieldName = preg_replace('#\[(.*?)\]$#', '', $this->name ?? '');
if (!isset($_FILES[$fieldName])) {
2016-11-29 04:18:48 +01:00
return true;
}
if ($isMultiFileUpload) {
$isValid = true;
2022-04-14 03:12:59 +02:00
foreach (array_keys($_FILES[$fieldName]['name'] ?? []) as $key) {
$fileData = [
'name' => $_FILES[$fieldName]['name'][$key],
'type' => $_FILES[$fieldName]['type'][$key],
'tmp_name' => $_FILES[$fieldName]['tmp_name'][$key],
'error' => $_FILES[$fieldName]['error'][$key],
'size' => $_FILES[$fieldName]['size'][$key],
];
if (!$this->validateFileData($validator, $fileData)) {
$isValid = false;
}
}
return $isValid;
}
// regular single-file upload
return $this->validateFileData($validator, $_FILES[$this->name]);
}
2016-11-29 04:18:48 +01:00
/**
* @param Validator $validator
* @param array $fileData
* @return bool
*/
private function validateFileData($validator, array $fileData): bool
{
$valid = $this->upload->validate($fileData);
2016-11-29 04:18:48 +01:00
if (!$valid) {
$errors = $this->upload->getErrors();
if ($errors) {
foreach ($errors as $error) {
$validator->validationError($this->name, $error, "validation");
}
}
return false;
}
return true;
}
/**
* Set if relation can be automatically assigned to the underlying dataobject
*
* @param bool $auto
* @return $this
*/
public function setRelationAutoSetting($auto)
{
$this->relationAutoSetting = $auto;
return $this;
}
/**
* Check if relation can be automatically assigned to the underlying dataobject
*
* @return bool
*/
public function getRelationAutoSetting()
{
return $this->relationAutoSetting;
}
}