1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
/* |
6
|
|
|
* This file is part of Cecil. |
7
|
|
|
* |
8
|
|
|
* Copyright (c) Arnaud Ligny <[email protected]> |
9
|
|
|
* |
10
|
|
|
* For the full copyright and license information, please view the LICENSE |
11
|
|
|
* file that was distributed with this source code. |
12
|
|
|
*/ |
13
|
|
|
|
14
|
|
|
namespace Cecil\Assets; |
15
|
|
|
|
16
|
|
|
use Cecil\Assets\Image\Optimizer; |
17
|
|
|
use Cecil\Builder; |
18
|
|
|
use Cecil\Collection\Page\Page; |
19
|
|
|
use Cecil\Config; |
20
|
|
|
use Cecil\Exception\ConfigException; |
21
|
|
|
use Cecil\Exception\RuntimeException; |
22
|
|
|
use Cecil\Util; |
23
|
|
|
use MatthiasMullie\Minify; |
24
|
|
|
use ScssPhp\ScssPhp\Compiler; |
25
|
|
|
use wapmorgan\Mp3Info\Mp3Info; |
26
|
|
|
|
27
|
|
|
class Asset implements \ArrayAccess |
28
|
|
|
{ |
29
|
|
|
/** @var Builder */ |
30
|
|
|
protected $builder; |
31
|
|
|
|
32
|
|
|
/** @var Config */ |
33
|
|
|
protected $config; |
34
|
|
|
|
35
|
|
|
/** @var array */ |
36
|
|
|
protected $data = []; |
37
|
|
|
|
38
|
|
|
/** @var bool */ |
39
|
|
|
protected $fingerprinted = false; |
40
|
|
|
|
41
|
|
|
/** @var bool */ |
42
|
|
|
protected $compiled = false; |
43
|
|
|
|
44
|
|
|
/** @var bool */ |
45
|
|
|
protected $minified = false; |
46
|
|
|
|
47
|
|
|
/** @var bool */ |
48
|
|
|
protected $optimize = false; |
49
|
|
|
|
50
|
|
|
/** @var bool */ |
51
|
|
|
protected $ignore_missing = false; |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* Creates an Asset from a file path, an array of files path or an URL. |
55
|
|
|
* |
56
|
|
|
* @param Builder $builder |
57
|
|
|
* @param string|array $paths |
58
|
|
|
* @param array|null $options e.g.: ['fingerprint' => true, 'minify' => true, 'filename' => '', 'ignore_missing' => false] |
59
|
|
|
* |
60
|
|
|
* @throws RuntimeException |
61
|
|
|
*/ |
62
|
1 |
|
public function __construct(Builder $builder, string|array $paths, array|null $options = null) |
63
|
|
|
{ |
64
|
1 |
|
$this->builder = $builder; |
65
|
1 |
|
$this->config = $builder->getConfig(); |
66
|
1 |
|
$paths = \is_array($paths) ? $paths : [$paths]; |
67
|
1 |
|
array_walk($paths, function ($path) { |
68
|
1 |
|
if (!\is_string($path)) { |
69
|
|
|
throw new RuntimeException(sprintf('The path of an asset must be a string ("%s" given).', \gettype($path))); |
70
|
|
|
} |
71
|
1 |
|
if (empty($path)) { |
72
|
|
|
throw new RuntimeException('The path of an asset can\'t be empty.'); |
73
|
|
|
} |
74
|
1 |
|
if (substr($path, 0, 2) == '..') { |
75
|
|
|
throw new RuntimeException(sprintf('The path of asset "%s" is wrong: it must be directly relative to "assets" or "static" directory, or a remote URL.', $path)); |
76
|
|
|
} |
77
|
1 |
|
}); |
78
|
1 |
|
$this->data = [ |
79
|
1 |
|
'file' => '', // absolute file path |
80
|
1 |
|
'files' => [], // array of files path (if bundle) |
81
|
1 |
|
'filename' => '', // filename |
82
|
1 |
|
'path_source' => '', // public path to the file, before transformations |
83
|
1 |
|
'path' => '', // public path to the file, after transformations |
84
|
1 |
|
'url' => null, // URL of a remote image |
85
|
1 |
|
'missing' => false, // if file not found, but missing ollowed 'missing' is true |
86
|
1 |
|
'ext' => '', // file extension |
87
|
1 |
|
'type' => '', // file type (e.g.: image, audio, video, etc.) |
88
|
1 |
|
'subtype' => '', // file media type (e.g.: image/png, audio/mp3, etc.) |
89
|
1 |
|
'size' => 0, // file size (in bytes) |
90
|
1 |
|
'content_source' => '', // file content, before transformations |
91
|
1 |
|
'content' => '', // file content, after transformations |
92
|
1 |
|
'width' => 0, // width (in pixels) in case of an image |
93
|
1 |
|
'height' => 0, // height (in pixels) in case of an image |
94
|
1 |
|
'exif' => [], // exif data |
95
|
1 |
|
]; |
96
|
|
|
|
97
|
|
|
// handles options |
98
|
1 |
|
$fingerprint = (bool) $this->config->get('assets.fingerprint.enabled'); |
99
|
1 |
|
$minify = (bool) $this->config->get('assets.minify.enabled'); |
100
|
1 |
|
$optimize = (bool) $this->config->get('assets.images.optimize.enabled'); |
101
|
1 |
|
$filename = ''; |
102
|
1 |
|
$ignore_missing = false; |
103
|
1 |
|
$remote_fallback = null; |
104
|
1 |
|
$force_slash = true; |
105
|
1 |
|
extract(\is_array($options) ? $options : [], EXTR_IF_EXISTS); |
106
|
1 |
|
$this->ignore_missing = $ignore_missing; |
107
|
|
|
|
108
|
|
|
// fill data array with file(s) informations |
109
|
1 |
|
$cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir')); |
110
|
1 |
|
$cacheKey = sprintf('%s__%s', $filename ?: implode('_', $paths), $this->builder->getVersion()); |
111
|
1 |
|
if (!$cache->has($cacheKey)) { |
112
|
1 |
|
$pathsCount = \count($paths); |
113
|
1 |
|
$file = []; |
114
|
1 |
|
for ($i = 0; $i < $pathsCount; $i++) { |
115
|
|
|
// loads file(s) |
116
|
1 |
|
$file[$i] = $this->loadFile($paths[$i], $ignore_missing, $remote_fallback, $force_slash); |
117
|
|
|
// bundle: same type only |
118
|
1 |
|
if ($i > 0) { |
119
|
1 |
|
if ($file[$i]['type'] != $file[$i - 1]['type']) { |
120
|
|
|
throw new RuntimeException(sprintf('Asset bundle type error (%s != %s).', $file[$i]['type'], $file[$i - 1]['type'])); |
121
|
|
|
} |
122
|
|
|
} |
123
|
|
|
// missing allowed = empty path |
124
|
1 |
|
if ($file[$i]['missing']) { |
125
|
1 |
|
$this->data['missing'] = true; |
126
|
1 |
|
$this->data['path'] = $file[$i]['path']; |
127
|
|
|
|
128
|
1 |
|
continue; |
129
|
|
|
} |
130
|
|
|
// set data |
131
|
1 |
|
$this->data['size'] += $file[$i]['size']; |
132
|
1 |
|
$this->data['content_source'] .= $file[$i]['content']; |
133
|
1 |
|
$this->data['content'] .= $file[$i]['content']; |
134
|
1 |
|
if ($i == 0) { |
135
|
1 |
|
$this->data['file'] = $file[$i]['filepath']; |
136
|
1 |
|
$this->data['filename'] = $file[$i]['path']; |
137
|
1 |
|
$this->data['path_source'] = $file[$i]['path']; |
138
|
1 |
|
$this->data['path'] = $file[$i]['path']; |
139
|
1 |
|
$this->data['url'] = $file[$i]['url']; |
140
|
1 |
|
$this->data['ext'] = $file[$i]['ext']; |
141
|
1 |
|
$this->data['type'] = $file[$i]['type']; |
142
|
1 |
|
$this->data['subtype'] = $file[$i]['subtype']; |
143
|
1 |
|
if ($this->data['type'] == 'image') { |
144
|
1 |
|
$this->data['width'] = $this->getWidth(); |
145
|
1 |
|
$this->data['height'] = $this->getHeight(); |
146
|
1 |
|
if ($this->data['subtype'] == 'image/jpeg') { |
147
|
1 |
|
$this->data['exif'] = Util\File::readExif($file[$i]['filepath']); |
148
|
|
|
} |
149
|
|
|
} |
150
|
|
|
// bundle: default filename |
151
|
1 |
|
if ($pathsCount > 1 && empty($filename)) { |
152
|
1 |
|
switch ($this->data['ext']) { |
153
|
1 |
|
case 'scss': |
154
|
1 |
|
case 'css': |
155
|
1 |
|
$filename = '/styles.css'; |
156
|
1 |
|
break; |
157
|
1 |
|
case 'js': |
158
|
1 |
|
$filename = '/scripts.js'; |
159
|
1 |
|
break; |
160
|
|
|
default: |
161
|
|
|
throw new RuntimeException(sprintf('Asset bundle supports %s files only.', '.scss, .css and .js')); |
162
|
|
|
} |
163
|
|
|
} |
164
|
|
|
// bundle: filename and path |
165
|
1 |
|
if (!empty($filename)) { |
166
|
1 |
|
$this->data['filename'] = $filename; |
167
|
1 |
|
$this->data['path'] = '/' . ltrim($filename, '/'); |
168
|
|
|
} |
169
|
|
|
} |
170
|
|
|
// bundle: files path |
171
|
1 |
|
$this->data['files'][] = $file[$i]['filepath']; |
172
|
|
|
} |
173
|
1 |
|
$cache->set($cacheKey, $this->data); |
174
|
|
|
} |
175
|
1 |
|
$this->data = $cache->get($cacheKey); |
176
|
|
|
|
177
|
|
|
// fingerprinting |
178
|
1 |
|
if ($fingerprint) { |
179
|
1 |
|
$this->fingerprint(); |
180
|
|
|
} |
181
|
|
|
// compiling (Sass files) |
182
|
1 |
|
if ((bool) $this->config->get('assets.compile.enabled')) { |
183
|
1 |
|
$this->compile(); |
184
|
|
|
} |
185
|
|
|
// minifying (CSS and JavScript files) |
186
|
1 |
|
if ($minify) { |
187
|
1 |
|
$this->minify(); |
188
|
|
|
} |
189
|
|
|
// optimizing (images files) |
190
|
1 |
|
if ($optimize) { |
191
|
1 |
|
$this->optimize = true; |
192
|
|
|
} |
193
|
|
|
} |
194
|
|
|
|
195
|
|
|
/** |
196
|
|
|
* Returns path. |
197
|
|
|
* |
198
|
|
|
* @throws RuntimeException |
199
|
|
|
*/ |
200
|
1 |
|
public function __toString(): string |
201
|
|
|
{ |
202
|
|
|
try { |
203
|
1 |
|
$this->save(); |
204
|
|
|
} catch (RuntimeException $e) { |
205
|
|
|
$this->builder->getLogger()->error($e->getMessage()); |
206
|
|
|
} |
207
|
|
|
|
208
|
1 |
|
if ($this->isImageInCdn()) { |
209
|
|
|
return $this->buildImageCdnUrl(); |
210
|
|
|
} |
211
|
|
|
|
212
|
1 |
|
if ($this->builder->getConfig()->get('canonicalurl')) { |
213
|
|
|
return (string) new Url($this->builder, $this->data['path'], ['canonical' => true]); |
214
|
|
|
} |
215
|
|
|
|
216
|
1 |
|
return $this->data['path']; |
217
|
|
|
} |
218
|
|
|
|
219
|
|
|
/** |
220
|
|
|
* Fingerprints a file. |
221
|
|
|
*/ |
222
|
1 |
|
public function fingerprint(): self |
223
|
|
|
{ |
224
|
1 |
|
if ($this->fingerprinted) { |
225
|
1 |
|
return $this; |
226
|
|
|
} |
227
|
|
|
|
228
|
1 |
|
$fingerprint = hash('md5', $this->data['content_source']); |
229
|
1 |
|
$this->data['path'] = preg_replace( |
230
|
1 |
|
'/\.' . $this->data['ext'] . '$/m', |
231
|
1 |
|
".$fingerprint." . $this->data['ext'], |
232
|
1 |
|
$this->data['path'] |
233
|
1 |
|
); |
234
|
|
|
|
235
|
1 |
|
$this->fingerprinted = true; |
236
|
|
|
|
237
|
1 |
|
return $this; |
238
|
|
|
} |
239
|
|
|
|
240
|
|
|
/** |
241
|
|
|
* Compiles a SCSS. |
242
|
|
|
* |
243
|
|
|
* @throws RuntimeException |
244
|
|
|
*/ |
245
|
1 |
|
public function compile(): self |
246
|
|
|
{ |
247
|
1 |
|
if ($this->compiled) { |
248
|
1 |
|
return $this; |
249
|
|
|
} |
250
|
|
|
|
251
|
1 |
|
if ($this->data['ext'] != 'scss') { |
252
|
1 |
|
return $this; |
253
|
|
|
} |
254
|
|
|
|
255
|
1 |
|
$cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir')); |
256
|
1 |
|
$cacheKey = $cache->createKeyFromAsset($this, ['compiled']); |
257
|
1 |
|
if (!$cache->has($cacheKey)) { |
258
|
1 |
|
$scssPhp = new Compiler(); |
259
|
1 |
|
$importDir = []; |
260
|
1 |
|
$importDir[] = Util::joinPath($this->config->getStaticPath()); |
261
|
1 |
|
$importDir[] = Util::joinPath($this->config->getAssetsPath()); |
262
|
1 |
|
$scssDir = $this->config->get('assets.compile.import') ?? []; |
263
|
1 |
|
$themes = $this->config->getTheme() ?? []; |
264
|
1 |
|
foreach ($scssDir as $dir) { |
265
|
1 |
|
$importDir[] = Util::joinPath($this->config->getStaticPath(), $dir); |
266
|
1 |
|
$importDir[] = Util::joinPath($this->config->getAssetsPath(), $dir); |
267
|
1 |
|
$importDir[] = Util::joinPath(\dirname($this->data['file']), $dir); |
268
|
1 |
|
foreach ($themes as $theme) { |
269
|
1 |
|
$importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "static/$dir")); |
270
|
1 |
|
$importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "assets/$dir")); |
271
|
|
|
} |
272
|
|
|
} |
273
|
1 |
|
$scssPhp->setImportPaths(array_unique($importDir)); |
274
|
|
|
// source map |
275
|
1 |
|
if ($this->builder->isDebug() && (bool) $this->config->get('assets.compile.sourcemap')) { |
276
|
|
|
$importDir = []; |
277
|
|
|
$assetDir = (string) $this->config->get('assets.dir'); |
278
|
|
|
$assetDirPos = strrpos($this->data['file'], DIRECTORY_SEPARATOR . $assetDir . DIRECTORY_SEPARATOR); |
279
|
|
|
$fileRelPath = substr($this->data['file'], $assetDirPos + 8); |
280
|
|
|
$filePath = Util::joinFile($this->config->getOutputPath(), $fileRelPath); |
281
|
|
|
$importDir[] = \dirname($filePath); |
282
|
|
|
foreach ($scssDir as $dir) { |
283
|
|
|
$importDir[] = Util::joinFile($this->config->getOutputPath(), $dir); |
284
|
|
|
} |
285
|
|
|
$scssPhp->setImportPaths(array_unique($importDir)); |
286
|
|
|
$scssPhp->setSourceMap(Compiler::SOURCE_MAP_INLINE); |
287
|
|
|
$scssPhp->setSourceMapOptions([ |
288
|
|
|
'sourceMapBasepath' => Util::joinPath($this->config->getOutputPath()), |
289
|
|
|
'sourceRoot' => '/', |
290
|
|
|
]); |
291
|
|
|
} |
292
|
|
|
// output style |
293
|
1 |
|
$outputStyles = ['expanded', 'compressed']; |
294
|
1 |
|
$outputStyle = strtolower((string) $this->config->get('assets.compile.style')); |
295
|
1 |
|
if (!\in_array($outputStyle, $outputStyles)) { |
296
|
|
|
throw new ConfigException(sprintf('"%s" value must be "%s".', 'assets.compile.style', implode('" or "', $outputStyles))); |
297
|
|
|
} |
298
|
1 |
|
$scssPhp->setOutputStyle($outputStyle); |
299
|
|
|
// variables |
300
|
1 |
|
$variables = $this->config->get('assets.compile.variables') ?? []; |
301
|
1 |
|
if (!empty($variables)) { |
302
|
1 |
|
$variables = array_map('ScssPhp\ScssPhp\ValueConverter::parseValue', $variables); |
303
|
1 |
|
$scssPhp->replaceVariables($variables); |
304
|
|
|
} |
305
|
|
|
// update data |
306
|
1 |
|
$this->data['path'] = preg_replace('/sass|scss/m', 'css', $this->data['path']); |
307
|
1 |
|
$this->data['ext'] = 'css'; |
308
|
1 |
|
$this->data['type'] = 'text'; |
309
|
1 |
|
$this->data['subtype'] = 'text/css'; |
310
|
1 |
|
$this->data['content'] = $scssPhp->compileString($this->data['content'])->getCss(); |
311
|
1 |
|
$this->data['size'] = \strlen($this->data['content']); |
312
|
1 |
|
$this->compiled = true; |
313
|
1 |
|
$cache->set($cacheKey, $this->data); |
314
|
|
|
} |
315
|
1 |
|
$this->data = $cache->get($cacheKey); |
316
|
|
|
|
317
|
1 |
|
return $this; |
318
|
|
|
} |
319
|
|
|
|
320
|
|
|
/** |
321
|
|
|
* Minifying a CSS or a JS. |
322
|
|
|
* |
323
|
|
|
* @throws RuntimeException |
324
|
|
|
*/ |
325
|
1 |
|
public function minify(): self |
326
|
|
|
{ |
327
|
|
|
// disable minify to preserve inline source map |
328
|
1 |
|
if ($this->builder->isDebug() && (bool) $this->config->get('assets.compile.sourcemap')) { |
329
|
|
|
return $this; |
330
|
|
|
} |
331
|
|
|
|
332
|
1 |
|
if ($this->minified) { |
333
|
|
|
return $this; |
334
|
|
|
} |
335
|
|
|
|
336
|
1 |
|
if ($this->data['ext'] == 'scss') { |
337
|
|
|
$this->compile(); |
338
|
|
|
} |
339
|
|
|
|
340
|
1 |
|
if ($this->data['ext'] != 'css' && $this->data['ext'] != 'js') { |
341
|
|
|
return $this; |
342
|
|
|
} |
343
|
|
|
|
344
|
1 |
|
if (substr($this->data['path'], -8) == '.min.css' || substr($this->data['path'], -7) == '.min.js') { |
345
|
|
|
$this->minified; |
346
|
|
|
|
347
|
|
|
return $this; |
348
|
|
|
} |
349
|
|
|
|
350
|
1 |
|
$cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir')); |
351
|
1 |
|
$cacheKey = $cache->createKeyFromAsset($this, ['minified']); |
352
|
1 |
|
if (!$cache->has($cacheKey)) { |
353
|
1 |
|
switch ($this->data['ext']) { |
354
|
1 |
|
case 'css': |
355
|
1 |
|
$minifier = new Minify\CSS($this->data['content']); |
356
|
1 |
|
break; |
357
|
1 |
|
case 'js': |
358
|
1 |
|
$minifier = new Minify\JS($this->data['content']); |
359
|
1 |
|
break; |
360
|
|
|
default: |
361
|
|
|
throw new RuntimeException(sprintf('Not able to minify "%s".', $this->data['path'])); |
362
|
|
|
} |
363
|
1 |
|
$this->data['path'] = preg_replace( |
364
|
1 |
|
'/\.' . $this->data['ext'] . '$/m', |
365
|
1 |
|
'.min.' . $this->data['ext'], |
366
|
1 |
|
$this->data['path'] |
367
|
1 |
|
); |
368
|
1 |
|
$this->data['content'] = $minifier->minify(); |
369
|
1 |
|
$this->data['size'] = \strlen($this->data['content']); |
370
|
1 |
|
$this->minified = true; |
371
|
1 |
|
$cache->set($cacheKey, $this->data); |
372
|
|
|
} |
373
|
1 |
|
$this->data = $cache->get($cacheKey); |
374
|
|
|
|
375
|
1 |
|
return $this; |
376
|
|
|
} |
377
|
|
|
|
378
|
|
|
/** |
379
|
|
|
* Optimizing an image. |
380
|
|
|
*/ |
381
|
1 |
|
public function optimize(string $filepath): self |
382
|
|
|
{ |
383
|
1 |
|
if ($this->data['type'] != 'image') { |
384
|
1 |
|
return $this; |
385
|
|
|
} |
386
|
|
|
|
387
|
1 |
|
$quality = $this->config->get('assets.images.quality') ?? 75; |
388
|
1 |
|
$cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir')); |
389
|
1 |
|
$tags = ["q$quality", 'optimized']; |
390
|
1 |
|
if ($this->data['width']) { |
391
|
1 |
|
array_unshift($tags, "{$this->data['width']}x"); |
392
|
|
|
} |
393
|
1 |
|
$cacheKey = $cache->createKeyFromAsset($this, $tags); |
394
|
1 |
|
if (!$cache->has($cacheKey)) { |
395
|
1 |
|
$message = $filepath; |
396
|
1 |
|
$sizeBefore = filesize($filepath); |
397
|
1 |
|
Optimizer::create($quality)->optimize($filepath); |
398
|
1 |
|
$sizeAfter = filesize($filepath); |
399
|
1 |
|
if ($sizeAfter < $sizeBefore) { |
400
|
|
|
$message = sprintf( |
401
|
|
|
'%s (%s Ko -> %s Ko)', |
402
|
|
|
$message, |
403
|
|
|
ceil($sizeBefore / 1000), |
404
|
|
|
ceil($sizeAfter / 1000) |
405
|
|
|
); |
406
|
|
|
} |
407
|
1 |
|
$this->data['content'] = Util\File::fileGetContents($filepath); |
408
|
1 |
|
$this->data['size'] = $sizeAfter; |
409
|
1 |
|
$cache->set($cacheKey, $this->data); |
410
|
1 |
|
$this->builder->getLogger()->debug(sprintf('Asset "%s" optimized', $message)); |
411
|
|
|
} |
412
|
1 |
|
$this->data = $cache->get($cacheKey, $this->data); |
413
|
|
|
|
414
|
1 |
|
return $this; |
415
|
|
|
} |
416
|
|
|
|
417
|
|
|
/** |
418
|
|
|
* Resizes an image with a new $width. |
419
|
|
|
* |
420
|
|
|
* @throws RuntimeException |
421
|
|
|
*/ |
422
|
1 |
|
public function resize(int $width): self |
423
|
|
|
{ |
424
|
1 |
|
if ($this->data['missing']) { |
425
|
|
|
throw new RuntimeException(sprintf('Not able to resize "%s": file not found.', $this->data['path'])); |
426
|
|
|
} |
427
|
1 |
|
if ($this->data['type'] != 'image') { |
428
|
|
|
throw new RuntimeException(sprintf('Not able to resize "%s": not an image.', $this->data['path'])); |
429
|
|
|
} |
430
|
1 |
|
if ($width >= $this->data['width']) { |
431
|
1 |
|
return $this; |
432
|
|
|
} |
433
|
|
|
|
434
|
1 |
|
$assetResized = clone $this; |
435
|
1 |
|
$assetResized->data['width'] = $width; |
436
|
|
|
|
437
|
1 |
|
if ($this->isImageInCdn()) { |
438
|
|
|
return $assetResized; // returns asset with the new width only: CDN do the rest of the job |
439
|
|
|
} |
440
|
|
|
|
441
|
1 |
|
$quality = $this->config->get('assets.images.quality') ?? 75; |
442
|
1 |
|
$cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir')); |
443
|
1 |
|
$cacheKey = $cache->createKeyFromAsset($assetResized, ["{$width}x", "q$quality"]); |
444
|
1 |
|
if (!$cache->has($cacheKey)) { |
445
|
1 |
|
$assetResized->data['content'] = Image::resize($assetResized, $width, $quality); |
446
|
1 |
|
$assetResized->data['path'] = '/' . Util::joinPath( |
447
|
1 |
|
(string) $this->config->get('assets.target'), |
448
|
1 |
|
(string) $this->config->get('assets.images.resize.dir'), |
449
|
1 |
|
(string) $width, |
450
|
1 |
|
$assetResized->data['path'] |
451
|
1 |
|
); |
452
|
1 |
|
$assetResized->data['height'] = $assetResized->getHeight(); |
453
|
1 |
|
$assetResized->data['size'] = \strlen($assetResized->data['content']); |
454
|
|
|
|
455
|
1 |
|
$cache->set($cacheKey, $assetResized->data); |
456
|
|
|
} |
457
|
1 |
|
$assetResized->data = $cache->get($cacheKey); |
458
|
|
|
|
459
|
1 |
|
return $assetResized; |
460
|
|
|
} |
461
|
|
|
|
462
|
|
|
/** |
463
|
|
|
* Converts an image asset to $format format. |
464
|
|
|
* |
465
|
|
|
* @throws RuntimeException |
466
|
|
|
*/ |
467
|
1 |
|
public function convert(string $format, ?int $quality = null): self |
468
|
|
|
{ |
469
|
1 |
|
if ($this->data['type'] != 'image') { |
470
|
|
|
throw new RuntimeException(sprintf('Not able to convert "%s" (%s) to %s: not an image.', $this->data['path'], $this->data['type'], $format)); |
471
|
|
|
} |
472
|
|
|
|
473
|
1 |
|
if ($quality === null) { |
474
|
1 |
|
$quality = (int) $this->config->get('assets.images.quality') ?? 75; |
475
|
|
|
} |
476
|
|
|
|
477
|
1 |
|
$asset = clone $this; |
478
|
1 |
|
$asset['ext'] = $format; |
479
|
|
|
|
480
|
1 |
|
if ($this->isImageInCdn()) { |
481
|
|
|
return $asset; // returns the asset with the new extension only: CDN do the rest of the job |
482
|
|
|
} |
483
|
|
|
|
484
|
1 |
|
$cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir')); |
485
|
1 |
|
$tags = ["q$quality"]; |
486
|
1 |
|
if ($this->data['width']) { |
487
|
1 |
|
array_unshift($tags, "{$this->data['width']}x"); |
488
|
|
|
} |
489
|
1 |
|
$cacheKey = $cache->createKeyFromAsset($asset, $tags); |
490
|
1 |
|
if (!$cache->has($cacheKey)) { |
491
|
1 |
|
$asset->data['content'] = Image::convert($asset, $format, $quality); |
492
|
|
|
$asset->data['path'] = preg_replace('/\.' . $this->data['ext'] . '$/m', ".$format", $this->data['path']); |
493
|
|
|
$asset->data['subtype'] = "image/$format"; |
494
|
|
|
$asset->data['size'] = \strlen($asset->data['content']); |
495
|
|
|
|
496
|
|
|
$cache->set($cacheKey, $asset->data); |
497
|
|
|
} |
498
|
|
|
$asset->data = $cache->get($cacheKey); |
499
|
|
|
|
500
|
|
|
return $asset; |
501
|
|
|
} |
502
|
|
|
|
503
|
|
|
/** |
504
|
|
|
* Converts an image asset to WebP format. |
505
|
|
|
* |
506
|
|
|
* @throws RuntimeException |
507
|
|
|
*/ |
508
|
1 |
|
public function webp(?int $quality = null): self |
509
|
|
|
{ |
510
|
1 |
|
return $this->convert('webp', $quality); |
511
|
|
|
} |
512
|
|
|
|
513
|
|
|
/** |
514
|
|
|
* Converts an image asset to AVIF format. |
515
|
|
|
* |
516
|
|
|
* @throws RuntimeException |
517
|
|
|
*/ |
518
|
|
|
public function avif(?int $quality = null): self |
519
|
|
|
{ |
520
|
|
|
return $this->convert('avif', $quality); |
521
|
|
|
} |
522
|
|
|
|
523
|
|
|
/** |
524
|
|
|
* Implements \ArrayAccess. |
525
|
|
|
*/ |
526
|
1 |
|
#[\ReturnTypeWillChange] |
527
|
|
|
public function offsetSet($offset, $value): void |
528
|
|
|
{ |
529
|
1 |
|
if (!\is_null($offset)) { |
530
|
1 |
|
$this->data[$offset] = $value; |
531
|
|
|
} |
532
|
|
|
} |
533
|
|
|
|
534
|
|
|
/** |
535
|
|
|
* Implements \ArrayAccess. |
536
|
|
|
*/ |
537
|
1 |
|
#[\ReturnTypeWillChange] |
538
|
|
|
public function offsetExists($offset): bool |
539
|
|
|
{ |
540
|
1 |
|
return isset($this->data[$offset]); |
541
|
|
|
} |
542
|
|
|
|
543
|
|
|
/** |
544
|
|
|
* Implements \ArrayAccess. |
545
|
|
|
*/ |
546
|
|
|
#[\ReturnTypeWillChange] |
547
|
|
|
public function offsetUnset($offset): void |
548
|
|
|
{ |
549
|
|
|
unset($this->data[$offset]); |
550
|
|
|
} |
551
|
|
|
|
552
|
|
|
/** |
553
|
|
|
* Implements \ArrayAccess. |
554
|
|
|
*/ |
555
|
1 |
|
#[\ReturnTypeWillChange] |
556
|
|
|
public function offsetGet($offset) |
557
|
|
|
{ |
558
|
1 |
|
return isset($this->data[$offset]) ? $this->data[$offset] : null; |
559
|
|
|
} |
560
|
|
|
|
561
|
|
|
/** |
562
|
|
|
* Hashing content of an asset with the specified algo, sha384 by default. |
563
|
|
|
* Used for SRI (Subresource Integrity). |
564
|
|
|
* |
565
|
|
|
* @see https://developer.mozilla.org/fr/docs/Web/Security/Subresource_Integrity |
566
|
|
|
*/ |
567
|
1 |
|
public function getIntegrity(string $algo = 'sha384'): string |
568
|
|
|
{ |
569
|
1 |
|
return sprintf('%s-%s', $algo, base64_encode(hash($algo, $this->data['content'], true))); |
570
|
|
|
} |
571
|
|
|
|
572
|
|
|
/** |
573
|
|
|
* Returns MP3 file infos. |
574
|
|
|
* |
575
|
|
|
* @see https://github.com/wapmorgan/Mp3Info |
576
|
|
|
*/ |
577
|
1 |
|
public function getAudio(): Mp3Info |
578
|
|
|
{ |
579
|
1 |
|
if ($this->data['type'] !== 'audio') { |
580
|
|
|
throw new RuntimeException(sprintf('Not able to get audio infos of "%s".', $this->data['path'])); |
581
|
|
|
} |
582
|
|
|
|
583
|
1 |
|
return new Mp3Info($this->data['file']); |
584
|
|
|
} |
585
|
|
|
|
586
|
|
|
/** |
587
|
|
|
* Returns MP4 file infos. |
588
|
|
|
* |
589
|
|
|
* @see https://github.com/clwu88/php-read-mp4info |
590
|
|
|
*/ |
591
|
|
|
public function getVideo(): array |
592
|
|
|
{ |
593
|
|
|
if ($this->data['type'] !== 'video') { |
594
|
|
|
throw new RuntimeException(sprintf('Not able to get video infos of "%s".', $this->data['path'])); |
595
|
|
|
} |
596
|
|
|
|
597
|
|
|
return \Clwu\Mp4::getInfo($this->data['file']); |
598
|
|
|
} |
599
|
|
|
|
600
|
|
|
/** |
601
|
|
|
* Returns the Data URL (encoded in Base64). |
602
|
|
|
* |
603
|
|
|
* @throws RuntimeException |
604
|
|
|
*/ |
605
|
1 |
|
public function dataurl(): string |
606
|
|
|
{ |
607
|
1 |
|
if ($this->data['type'] == 'image' && !Image::isSVG($this)) { |
608
|
1 |
|
return Image::getDataUrl($this, $this->config->get('assets.images.quality') ?? 75); |
609
|
|
|
} |
610
|
|
|
|
611
|
1 |
|
return sprintf('data:%s;base64,%s', $this->data['subtype'], base64_encode($this->data['content'])); |
612
|
|
|
} |
613
|
|
|
|
614
|
|
|
/** |
615
|
|
|
* Saves file. |
616
|
|
|
* Note: a file from `static/` with the same name will NOT be overridden. |
617
|
|
|
* |
618
|
|
|
* @throws RuntimeException |
619
|
|
|
*/ |
620
|
1 |
|
public function save(): void |
621
|
|
|
{ |
622
|
1 |
|
$filepath = Util::joinFile($this->config->getOutputPath(), $this->data['path']); |
623
|
1 |
|
if (!$this->builder->getBuildOptions()['dry-run'] && !Util\File::getFS()->exists($filepath)) { |
624
|
|
|
try { |
625
|
1 |
|
Util\File::getFS()->dumpFile($filepath, $this->data['content']); |
626
|
1 |
|
$this->builder->getLogger()->debug(sprintf('Asset "%s" saved', $filepath)); |
627
|
1 |
|
if ($this->optimize) { |
628
|
1 |
|
$this->optimize($filepath); |
629
|
|
|
} |
630
|
|
|
} catch (\Symfony\Component\Filesystem\Exception\IOException) { |
631
|
|
|
if (!$this->ignore_missing) { |
632
|
|
|
throw new RuntimeException(sprintf('Can\'t save asset "%s".', $filepath)); |
633
|
|
|
} |
634
|
|
|
} |
635
|
|
|
} |
636
|
|
|
} |
637
|
|
|
|
638
|
|
|
/** |
639
|
|
|
* Is Asset is an image in CDN. |
640
|
|
|
* |
641
|
|
|
* @return bool |
642
|
|
|
*/ |
643
|
1 |
|
public function isImageInCdn() |
644
|
|
|
{ |
645
|
1 |
|
if ($this->data['type'] != 'image' || (bool) $this->config->get('assets.images.cdn.enabled') !== true || (Image::isSVG($this) && (bool) $this->config->get('assets.images.cdn.svg') !== true)) { |
646
|
1 |
|
return false; |
647
|
|
|
} |
648
|
|
|
// remote image? |
649
|
|
|
if ($this->data['url'] !== null && (bool) $this->config->get('assets.images.cdn.remote') !== true) { |
650
|
|
|
return false; |
651
|
|
|
} |
652
|
|
|
|
653
|
|
|
return true; |
654
|
|
|
} |
655
|
|
|
|
656
|
|
|
/** |
657
|
|
|
* Load file data. |
658
|
|
|
* |
659
|
|
|
* @throws RuntimeException |
660
|
|
|
*/ |
661
|
1 |
|
private function loadFile(string $path, bool $ignore_missing = false, ?string $remote_fallback = null, bool $force_slash = true): array |
662
|
|
|
{ |
663
|
1 |
|
$file = [ |
664
|
1 |
|
'url' => null, |
665
|
1 |
|
]; |
666
|
|
|
|
667
|
|
|
try { |
668
|
1 |
|
$filePath = $this->findFile($path, $remote_fallback); |
669
|
1 |
|
} catch (RuntimeException $e) { |
670
|
1 |
|
if ($ignore_missing) { |
671
|
1 |
|
$file['path'] = $path; |
672
|
1 |
|
$file['missing'] = true; |
673
|
|
|
|
674
|
1 |
|
return $file; |
675
|
|
|
} |
676
|
|
|
|
677
|
|
|
throw new RuntimeException(sprintf('Can\'t load asset file "%s" (%s).', $path, $e->getMessage())); |
678
|
|
|
} |
679
|
|
|
|
680
|
1 |
|
if (Util\Url::isUrl($path)) { |
681
|
1 |
|
$file['url'] = $path; |
682
|
1 |
|
$path = Util::joinPath( |
683
|
1 |
|
(string) $this->config->get('assets.target'), |
684
|
1 |
|
Util\File::getFS()->makePathRelative($filePath, $this->config->getCacheAssetsRemotePath()) |
685
|
1 |
|
); |
686
|
|
|
// remote_fallback in assets/ ont in cache/assets/remote/ |
687
|
1 |
|
if (substr(Util\File::getFS()->makePathRelative($filePath, $this->config->getCacheAssetsRemotePath()), 0, 2) == '..') { |
688
|
|
|
$path = Util::joinPath( |
689
|
|
|
(string) $this->config->get('assets.target'), |
690
|
|
|
Util\File::getFS()->makePathRelative($filePath, $this->config->getAssetsPath()) |
691
|
|
|
); |
692
|
|
|
} |
693
|
1 |
|
$force_slash = true; |
694
|
|
|
} |
695
|
1 |
|
if ($force_slash) { |
696
|
1 |
|
$path = '/' . ltrim($path, '/'); |
697
|
|
|
} |
698
|
|
|
|
699
|
1 |
|
list($type, $subtype) = Util\File::getMimeType($filePath); |
700
|
1 |
|
$content = Util\File::fileGetContents($filePath); |
701
|
|
|
|
702
|
1 |
|
$file['filepath'] = $filePath; |
703
|
1 |
|
$file['path'] = $path; |
704
|
1 |
|
$file['ext'] = pathinfo($path)['extension'] ?? ''; |
705
|
1 |
|
$file['type'] = $type; |
706
|
1 |
|
$file['subtype'] = $subtype; |
707
|
1 |
|
$file['size'] = filesize($filePath); |
708
|
1 |
|
$file['content'] = $content; |
709
|
1 |
|
$file['missing'] = false; |
710
|
|
|
|
711
|
1 |
|
return $file; |
712
|
|
|
} |
713
|
|
|
|
714
|
|
|
/** |
715
|
|
|
* Try to find the file: |
716
|
|
|
* 1. remote (if $path is a valid URL) |
717
|
|
|
* 2. in static/ |
718
|
|
|
* 3. in themes/<theme>/static/ |
719
|
|
|
* Returns local file path or throw an exception. |
720
|
|
|
* |
721
|
|
|
* @throws RuntimeException |
722
|
|
|
*/ |
723
|
1 |
|
private function findFile(string $path, ?string $remote_fallback = null): string |
724
|
|
|
{ |
725
|
|
|
// in case of remote file: save it and returns cached file path |
726
|
1 |
|
if (Util\Url::isUrl($path)) { |
727
|
1 |
|
$url = $path; |
728
|
1 |
|
$urlHost = parse_url($path, PHP_URL_HOST); |
729
|
1 |
|
$urlPath = parse_url($path, PHP_URL_PATH); |
730
|
1 |
|
$urlQuery = parse_url($path, PHP_URL_QUERY); |
731
|
1 |
|
$extension = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION); |
732
|
|
|
// Google Fonts hack |
733
|
1 |
|
if (Util\Str::endsWith($urlPath, '/css') || Util\Str::endsWith($urlPath, '/css2')) { |
734
|
1 |
|
$extension = 'css'; |
735
|
|
|
} |
736
|
1 |
|
$relativePath = Page::slugify(sprintf( |
737
|
1 |
|
'%s%s%s%s', |
738
|
1 |
|
$urlHost, |
739
|
1 |
|
$this->sanitize($urlPath), |
740
|
1 |
|
$urlQuery ? "-$urlQuery" : '', |
741
|
1 |
|
$urlQuery && $extension ? ".$extension" : '' |
742
|
1 |
|
)); |
743
|
1 |
|
$filePath = Util::joinFile($this->config->getCacheAssetsRemotePath(), $relativePath); |
744
|
|
|
// not already in cache |
745
|
1 |
|
if (!file_exists($filePath)) { |
746
|
|
|
try { |
747
|
1 |
|
if (!Util\Url::isRemoteFileExists($url)) { |
748
|
|
|
throw new RuntimeException(sprintf('File "%s" doesn\'t exists', $url)); |
749
|
|
|
} |
750
|
1 |
|
if (false === $content = Util\File::fileGetContents($url, true)) { |
751
|
|
|
throw new RuntimeException(sprintf('Can\'t get content of file "%s".', $url)); |
752
|
|
|
} |
753
|
1 |
|
if (\strlen($content) <= 1) { |
754
|
1 |
|
throw new RuntimeException(sprintf('File "%s" is empty.', $url)); |
755
|
|
|
} |
756
|
|
|
} catch (RuntimeException $e) { |
757
|
|
|
// is there a fallback in assets/ |
758
|
|
|
if ($remote_fallback) { |
759
|
|
|
$filePath = Util::joinFile($this->config->getAssetsPath(), $remote_fallback); |
760
|
|
|
if (Util\File::getFS()->exists($filePath)) { |
761
|
|
|
return $filePath; |
762
|
|
|
} |
763
|
|
|
throw new RuntimeException(sprintf('Fallback file "%s" doesn\'t exists.', $filePath)); |
764
|
|
|
} |
765
|
|
|
|
766
|
|
|
throw new RuntimeException($e->getMessage()); |
767
|
|
|
} |
768
|
1 |
|
if (false === $content = Util\File::fileGetContents($url, true)) { |
769
|
|
|
throw new RuntimeException(sprintf('Can\'t get content of "%s"', $url)); |
770
|
|
|
} |
771
|
1 |
|
if (\strlen($content) <= 1) { |
772
|
|
|
throw new RuntimeException(sprintf('Asset at "%s" is empty', $url)); |
773
|
|
|
} |
774
|
|
|
// put file in cache |
775
|
1 |
|
Util\File::getFS()->dumpFile($filePath, $content); |
776
|
|
|
} |
777
|
|
|
|
778
|
1 |
|
return $filePath; |
779
|
|
|
} |
780
|
|
|
|
781
|
|
|
// checks in assets/ |
782
|
1 |
|
$filePath = Util::joinFile($this->config->getAssetsPath(), $path); |
783
|
1 |
|
if (Util\File::getFS()->exists($filePath)) { |
784
|
1 |
|
return $filePath; |
785
|
|
|
} |
786
|
|
|
|
787
|
|
|
// checks in each themes/<theme>/assets/ |
788
|
1 |
|
foreach ($this->config->getTheme() as $theme) { |
789
|
1 |
|
$filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'assets'), $path); |
790
|
1 |
|
if (Util\File::getFS()->exists($filePath)) { |
791
|
1 |
|
return $filePath; |
792
|
|
|
} |
793
|
|
|
} |
794
|
|
|
|
795
|
|
|
// checks in static/ |
796
|
1 |
|
$filePath = Util::joinFile($this->config->getStaticTargetPath(), $path); |
797
|
1 |
|
if (Util\File::getFS()->exists($filePath)) { |
798
|
1 |
|
return $filePath; |
799
|
|
|
} |
800
|
|
|
|
801
|
|
|
// checks in each themes/<theme>/static/ |
802
|
1 |
|
foreach ($this->config->getTheme() as $theme) { |
803
|
1 |
|
$filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'static'), $path); |
804
|
1 |
|
if (Util\File::getFS()->exists($filePath)) { |
805
|
1 |
|
return $filePath; |
806
|
|
|
} |
807
|
|
|
} |
808
|
|
|
|
809
|
1 |
|
throw new RuntimeException(sprintf('Can\'t find file "%s".', $path)); |
810
|
|
|
} |
811
|
|
|
|
812
|
|
|
/** |
813
|
|
|
* Returns the width of an image/SVG. |
814
|
|
|
* |
815
|
|
|
* @throws RuntimeException |
816
|
|
|
*/ |
817
|
1 |
|
private function getWidth(): int |
818
|
|
|
{ |
819
|
1 |
|
if ($this->data['type'] != 'image') { |
820
|
|
|
return 0; |
821
|
|
|
} |
822
|
1 |
|
if (Image::isSVG($this) && false !== $svg = Image::getSvgAttributes($this)) { |
823
|
1 |
|
return (int) $svg->width; |
824
|
|
|
} |
825
|
1 |
|
if (false === $size = $this->getImageSize()) { |
826
|
|
|
throw new RuntimeException(sprintf('Not able to get width of "%s".', $this->data['path'])); |
827
|
|
|
} |
828
|
|
|
|
829
|
1 |
|
return $size[0]; |
830
|
|
|
} |
831
|
|
|
|
832
|
|
|
/** |
833
|
|
|
* Returns the height of an image/SVG. |
834
|
|
|
* |
835
|
|
|
* @throws RuntimeException |
836
|
|
|
*/ |
837
|
1 |
|
private function getHeight(): int |
838
|
|
|
{ |
839
|
1 |
|
if ($this->data['type'] != 'image') { |
840
|
|
|
return 0; |
841
|
|
|
} |
842
|
1 |
|
if (Image::isSVG($this) && false !== $svg = Image::getSvgAttributes($this)) { |
843
|
1 |
|
return (int) $svg->height; |
844
|
|
|
} |
845
|
1 |
|
if (false === $size = $this->getImageSize()) { |
846
|
|
|
throw new RuntimeException(sprintf('Not able to get height of "%s".', $this->data['path'])); |
847
|
|
|
} |
848
|
|
|
|
849
|
1 |
|
return $size[1]; |
850
|
|
|
} |
851
|
|
|
|
852
|
|
|
/** |
853
|
|
|
* Returns image size informations. |
854
|
|
|
* |
855
|
|
|
* @see https://www.php.net/manual/function.getimagesize.php |
856
|
|
|
* |
857
|
|
|
* @return array|false |
858
|
|
|
*/ |
859
|
1 |
|
private function getImageSize() |
860
|
|
|
{ |
861
|
1 |
|
if (!$this->data['type'] == 'image') { |
862
|
|
|
return false; |
863
|
|
|
} |
864
|
|
|
|
865
|
|
|
try { |
866
|
1 |
|
if (false === $size = getimagesizefromstring($this->data['content'])) { |
867
|
1 |
|
return false; |
868
|
|
|
} |
869
|
|
|
} catch (\Exception $e) { |
870
|
|
|
throw new RuntimeException(sprintf('Handling asset "%s" failed: "%s"', $this->data['path_source'], $e->getMessage())); |
871
|
|
|
} |
872
|
|
|
|
873
|
1 |
|
return $size; |
874
|
|
|
} |
875
|
|
|
|
876
|
|
|
/** |
877
|
|
|
* Replaces some characters by '_'. |
878
|
|
|
*/ |
879
|
1 |
|
private function sanitize(string $string): string |
880
|
|
|
{ |
881
|
1 |
|
return str_replace(['<', '>', ':', '"', '\\', '|', '?', '*'], '_', $string); |
882
|
|
|
} |
883
|
|
|
|
884
|
|
|
/** |
885
|
|
|
* Builds CDN image URL. |
886
|
|
|
*/ |
887
|
|
|
private function buildImageCdnUrl(): string |
888
|
|
|
{ |
889
|
|
|
return str_replace( |
890
|
|
|
[ |
891
|
|
|
'%account%', |
892
|
|
|
'%image_url%', |
893
|
|
|
'%width%', |
894
|
|
|
'%quality%', |
895
|
|
|
'%format%', |
896
|
|
|
], |
897
|
|
|
[ |
898
|
|
|
$this->config->get('assets.images.cdn.account'), |
899
|
|
|
ltrim($this->data['url'] ?? (string) new Url($this->builder, $this->data['path'], ['canonical' => $this->config->get('assets.images.cdn.canonical') ?? true]), '/'), |
900
|
|
|
$this->data['width'], |
901
|
|
|
$this->config->get('assets.images.quality') ?? 75, |
902
|
|
|
$this->data['ext'], |
903
|
|
|
], |
904
|
|
|
(string) $this->config->get('assets.images.cdn.url') |
905
|
|
|
); |
906
|
|
|
} |
907
|
|
|
} |
908
|
|
|
|