forked from yii2mod/yii2-image
/
ImageComponent.php
executable file
·356 lines (318 loc) · 10 KB
/
ImageComponent.php
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?php
namespace yii2mod\image;
use Imagine\Exception\InvalidArgumentException;
use Imagine\Image\Box;
use Imagine\Image\ImageInterface;
use Imagine\Image\ManipulatorInterface;
use Imagine\Image\Palette\RGB;
use Imagine\Image\Point;
use Yii;
use yii\base\Component;
use yii\helpers\ArrayHelper;
use yii\helpers\FileHelper;
use yii\helpers\Url;
use yii\imagine\Image;
/**
* Class Image
* Database representation for image path:
* /uploads/folder/imagename.jpg
* @package yii2mod\image
*/
class ImageComponent extends Component
{
/**
* @var string use png for cached files for transparency support
*/
const TRANSPARENT_EXTENSION = 'png';
/**
* @var string
*/
const IMAGE_ORIGINAL = 'original';
/**
* @var string relative path where the cache files are kept
*/
public $cachePath = '/web/assets/image/';
/**
* @var string relative public path where the cache files are kept
*/
public $cachePublicPath = '/assets/image/';
/**
* @var string system path to original image
*/
public $sourcePath = '/uploads/Image/';
/**
* @var int cache lifetime in seconds
*/
public $cacheTime = 2592000;
/**
* Default offset for x coordinate
* @var
*/
public $defaultOffsetX = 0;
/**
* Default offset for y coordinate
* @var
*/
public $defaultOffsetY = 0;
/**
* @var string path to image for no image
*/
public $noImage = '@vendor/yii2mod/yii2-image/assets/no-image.png';
/**
* @var array
*/
public $config = [
'original' => [],
'small' => [
'thumbnail' => [
'box' => [60, 60],
'mode' => ManipulatorInterface::THUMBNAIL_OUTBOUND
]
],
'medium' => [
'thumbnail' => [
'box' => [240, 240],
'mode' => ManipulatorInterface::THUMBNAIL_OUTBOUND
]
],
];
/**
* Init component.
*/
public function init()
{
$this->config = ArrayHelper::merge($this->config, isset(Yii::$app->params['image']) ? Yii::$app->params['image'] : []);
parent::init();
}
/**
* This method detects which (absolute or relative) path is used.
*
* @param array $file path
* @return string path
*/
public function detectPath($file)
{
if ($file == $this->noImage) {
return Yii::getAlias($this->noImage);
}
$fullPath = $this->getImageSourcePath() . $file;
if (is_file($fullPath)) {
return $fullPath;
}
return false;
}
/**
* Get image url
*
* @param $file
* @param $type
* @return $this
*/
public function getUrl($file, $type)
{
if (!$this->checkPermission($type)) {
$file = $this->noImage;
}
$filePath = $this->getCachePath($file, $type);
if (file_exists($filePath['system']) && (time() - filemtime($filePath['system']) < $this->cacheTime)) {
return $filePath['public'];
} else {
return Url::toRoute(['/site/image', 'path' => urlencode($file), 'type' => $type]);
}
}
/**
* Get image cache path
*
* @param $file
* @param $type
* @return array
*/
private function getCachePath($file, $type)
{
$hash = md5($file . $type);
if (isset($type) && isset($this->config[$type])) {
$isTransparent = ArrayHelper::getValue($this->config[$type], 'transparent', false);
} else {
$isTransparent = false;
}
$cacheFileExt = $isTransparent ? self::TRANSPARENT_EXTENSION : strtolower(pathinfo($file, PATHINFO_EXTENSION));
$cachePath = $this->cachePath . $hash{0} . DIRECTORY_SEPARATOR;
$cachePublicPath = $this->cachePublicPath . $hash{0} . DIRECTORY_SEPARATOR;
$cacheFile = "{$hash}.{$cacheFileExt}";
$systemPath = Yii::getAlias('@app') . $cachePath;
if (!is_dir($systemPath)) {
FileHelper::createDirectory($systemPath);
}
return [
'system' => $systemPath . $cacheFile,
'web' => $cachePath . $cacheFile,
'public' => $cachePublicPath . $cacheFile,
'extension' => $cacheFileExt
];
}
/**
* Show image
*
* @param $path
* @param $type
*/
public function show($path, $type = self::IMAGE_ORIGINAL)
{
if (!in_array($type, array_keys($this->config))) {
$type = self::IMAGE_ORIGINAL;
}
if ($this->checkPermission($type)) {
if ($file = $this->detectPath($path)) {
$image = Image::getImagine()
->open($file)
->copy();
$actions = $this->config[$type];
ArrayHelper::remove($actions, 'transparent');
foreach ($actions as $action => $options) {
if (method_exists($this, $action)) {
$image = $this->$action($image, $options);
}
}
$cachePath = $this->getCachePath($path, $type);
if (!file_exists($cachePath['system'])) {
$image->save($cachePath['system']);
}
$image->show($cachePath['extension']);
Yii::$app->end();
}
}
$this->show($this->noImage, $type);
}
/**
* Crop image
*
* @param $image \Imagine\Imagick\Image
* @param $options
* @return mixed
*/
private function crop($image, $options)
{
return $image->crop(new Point($options['point'][0], $options['point'][1]), new Box($options['box'][0], $options['box'][1]));
}
/**
* Create thumbnail
*
* @param $image \Imagine\Imagick\Image
* @param $options
* @param string $filter
* @return ImageInterface
* @throws InvalidArgumentException
*/
private function thumbnail($image, $options, $filter = ImageInterface::FILTER_UNDEFINED)
{
$width = $options['box'][0];
$height = $options['box'][1];
$size = $box = new Box($width, $height);
$mode = $options['mode'];
if ($mode !== ImageInterface::THUMBNAIL_INSET && $mode !== ImageInterface::THUMBNAIL_OUTBOUND) {
throw new InvalidArgumentException('Invalid mode specified');
}
$imageSize = $image->getSize();
$ratios = array(
$size->getWidth() / $imageSize->getWidth(),
$size->getHeight() / $imageSize->getHeight()
);
$image->strip();
// if target width is larger than image width
// AND target height is longer than image height
if (!$size->contains($imageSize)) {
if ($mode === ImageInterface::THUMBNAIL_INSET) {
$ratio = min($ratios);
} else {
$ratio = max($ratios);
}
if ($mode === ImageInterface::THUMBNAIL_OUTBOUND) {
if (!$imageSize->contains($size)) {
$size = new Box(
min($imageSize->getWidth(), $size->getWidth()),
min($imageSize->getHeight(), $size->getHeight())
);
} else {
$imageSize = $image->getSize()->scale($ratio);
$image->resize($imageSize, $filter);
}
if ($ratios[0] > $ratios[1]) {
$cropPoint = new Point(0, 0);
} else {
$cropPoint = new Point(
max(0, round(($imageSize->getWidth() - $size->getWidth()) / 2)),
max(0, round(($imageSize->getHeight() - $size->getHeight()) / 2))
);
}
$image->crop($cropPoint, $size);
} else {
if (!$imageSize->contains($size)) {
$imageSize = $imageSize->scale($ratio);
$image->resize($imageSize, $filter);
} else {
$imageSize = $image->getSize()->scale($ratio);
$image->resize($imageSize, $filter);
}
}
}
// create empty image to preserve aspect ratio of thumbnail
$palette = new RGB();
$color = $palette->color('#000', 0); //transparent png with imagick
$thumb = Image::getImagine()->create($box, $color);
// calculate points
$size = $image->getSize();
$startX = 0;
$startY = 0;
if ($size->getWidth() < $width) {
$startX = ceil($width - $size->getWidth()) / 2;
}
if ($size->getHeight() < $height) {
$startY = ceil($height - $size->getHeight()) / 2;
}
$thumb->paste($image, new Point($startX, $startY));
return $thumb;
}
/**
* Add watermark
*
* @param $image \Imagine\Imagick\Image
* @param $options
* @return mixed
*/
private function watermark($image, $options)
{
$watermarkFilename = $options['watermarkFilename'];
$watermark = Image::getImagine()->open(Yii::getAlias($watermarkFilename));
$size = $image->getSize();
$wSize = $watermark->getSize();
$bottomRight = new Point($size->getWidth() - $wSize->getWidth(), $size->getHeight() - $wSize->getHeight());
$image->paste($watermark, $bottomRight);
return $image;
}
/**
* Check permission for current user
*
* @param $type
* @return bool
*/
private function checkPermission($type)
{
if (isset($this->config[$type]['visible'])) {
$role = $this->config[$type]['visible'];
unset($this->config[$type]['visible']);
if (!Yii::$app->getUser()->can($role)) {
return false;
}
}
return true;
}
/**
* Get image source path
*
* @return string
*/
private function getImageSourcePath()
{
return Yii::getAlias('@app') . $this->sourcePath;
}
}