1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Customer\Model\Metadata\Form;
use Magento\Customer\Api\AddressMetadataInterface;
use Magento\Customer\Api\CustomerMetadataInterface;
use Magento\Customer\Model\FileProcessor;
use Magento\Framework\Api\ArrayObjectSearch;
use Magento\Framework\Api\Data\ImageContentInterface;
use Magento\Framework\Api\Data\ImageContentInterfaceFactory;
use Magento\Framework\App\ObjectManager;
use Magento\Framework\File\UploaderFactory;
use Magento\Framework\Filesystem;
/**
* Metadata for form image field
*
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
*/
class Image extends File
{
/**
* @var ImageContentInterfaceFactory
*/
private $imageContentFactory;
/**
* Constructor
*
* @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate
* @param \Psr\Log\LoggerInterface $logger
* @param \Magento\Customer\Api\Data\AttributeMetadataInterface $attribute
* @param \Magento\Framework\Locale\ResolverInterface $localeResolver
* @param null|string $value
* @param string $entityTypeCode
* @param bool $isAjax
* @param \Magento\Framework\Url\EncoderInterface $urlEncoder
* @param \Magento\MediaStorage\Model\File\Validator\NotProtectedExtension $fileValidator
* @param Filesystem $fileSystem
* @param UploaderFactory $uploaderFactory
* @param \Magento\Customer\Model\FileProcessorFactory|null $fileProcessorFactory
* @param \Magento\Framework\Api\Data\ImageContentInterfaceFactory|null $imageContentInterfaceFactory
* @SuppressWarnings(PHPMD.ExcessiveParameterList)
*/
public function __construct(
\Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate,
\Psr\Log\LoggerInterface $logger,
\Magento\Customer\Api\Data\AttributeMetadataInterface $attribute,
\Magento\Framework\Locale\ResolverInterface $localeResolver,
$value,
$entityTypeCode,
$isAjax,
\Magento\Framework\Url\EncoderInterface $urlEncoder,
\Magento\MediaStorage\Model\File\Validator\NotProtectedExtension $fileValidator,
Filesystem $fileSystem,
UploaderFactory $uploaderFactory,
\Magento\Customer\Model\FileProcessorFactory $fileProcessorFactory = null,
\Magento\Framework\Api\Data\ImageContentInterfaceFactory $imageContentInterfaceFactory = null
) {
parent::__construct(
$localeDate,
$logger,
$attribute,
$localeResolver,
$value,
$entityTypeCode,
$isAjax,
$urlEncoder,
$fileValidator,
$fileSystem,
$uploaderFactory,
$fileProcessorFactory
);
$this->imageContentFactory = $imageContentInterfaceFactory ?: ObjectManager::getInstance()
->get(\Magento\Framework\Api\Data\ImageContentInterfaceFactory::class);
}
/**
* Validate file by attribute validate rules
*
* Return array of errors
*
* @param array $value
* @return string[]
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
protected function _validateByRules($value)
{
$label = $value['name'];
$rules = $this->getAttribute()->getValidationRules();
$imageProp = @getimagesize($value['tmp_name']);
if (!$this->_isUploadedFile($value['tmp_name']) || !$imageProp) {
return [__('"%1" is not a valid file.', $label)];
}
$allowImageTypes = [1 => 'gif', 2 => 'jpg', 3 => 'png'];
if (!isset($allowImageTypes[$imageProp[2]])) {
return [__('"%1" is not a valid image format.', $label)];
}
// modify image name
$extension = pathinfo($value['name'], PATHINFO_EXTENSION);
if ($extension != $allowImageTypes[$imageProp[2]]) {
$value['name'] = pathinfo($value['name'], PATHINFO_FILENAME) . '.' . $allowImageTypes[$imageProp[2]];
}
$maxFileSize = ArrayObjectSearch::getArrayElementByName(
$rules,
'max_file_size'
);
$errors = [];
if ($maxFileSize !== null) {
$size = $value['size'];
if ($maxFileSize < $size) {
$errors[] = __('"%1" exceeds the allowed file size.', $label);
}
}
$maxImageWidth = ArrayObjectSearch::getArrayElementByName(
$rules,
'max_image_width'
);
if ($maxImageWidth !== null) {
if ($maxImageWidth < $imageProp[0]) {
$r = $maxImageWidth;
$errors[] = __('"%1" width exceeds allowed value of %2 px.', $label, $r);
}
}
$maxImageHeight = ArrayObjectSearch::getArrayElementByName(
$rules,
'max_image_height'
);
if ($maxImageHeight !== null) {
if ($maxImageHeight < $imageProp[1]) {
$r = $maxImageHeight;
$errors[] = __('"%1" height exceeds allowed value of %2 px.', $label, $r);
}
}
return $errors;
}
/**
* Process file uploader UI component data
*
* @param array $value
* @return bool|int|ImageContentInterface|string
*/
protected function processUiComponentValue(array $value)
{
if ($this->_entityTypeCode == AddressMetadataInterface::ENTITY_TYPE_ADDRESS) {
$result = $this->processCustomerAddressValue($value);
return $result;
}
if ($this->_entityTypeCode == CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER) {
$result = $this->processCustomerValue($value);
return $result;
}
return $this->_value;
}
/**
* Process file uploader UI component data for customer_address entity
*
* @param array $value
* @return string
*/
protected function processCustomerAddressValue(array $value)
{
$result = $this->getFileProcessor()->moveTemporaryFile($value['file']);
return $result;
}
/**
* Process file uploader UI component data for customer entity
*
* @param array $value
* @return bool|int|ImageContentInterface|string
*/
protected function processCustomerValue(array $value)
{
$temporaryFile = FileProcessor::TMP_DIR . '/' . ltrim($value['file'], '/');
if ($this->getFileProcessor()->isExist($temporaryFile)) {
$base64EncodedData = $this->getFileProcessor()->getBase64EncodedData($temporaryFile);
/** @var ImageContentInterface $imageContentDataObject */
$imageContentDataObject = $this->imageContentFactory->create()
->setName($value['name'])
->setBase64EncodedData($base64EncodedData)
->setType($value['type']);
// Remove temporary file
$this->getFileProcessor()->removeUploadedFile($temporaryFile);
return $imageContentDataObject;
}
return $this->_value;
}
}