Passed
Push — master ( 5fd438...6c3583 )
by Arnaud
06:08
created

Asset::resize()   B

Complexity

Conditions 10
Paths 15

Size

Total Lines 61
Code Lines 41

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 32
CRAP Score 11.3498

Importance

Changes 4
Bugs 3 Features 0
Metric Value
cc 10
eloc 41
c 4
b 3
f 0
nc 15
nop 1
dl 0
loc 61
ccs 32
cts 42
cp 0.7619
crap 11.3498
rs 7.6666

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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\RuntimeException;
21
use Cecil\Util;
22
use Intervention\Image\ImageManagerStatic as ImageManager;
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
    /** @var bool */
50
    protected $optimized = false;
51
52
    /** @var bool */
53
    protected $ignore_missing = false;
54
55
    /**
56
     * Creates an Asset from a file path, an array of files path or an URL.
57
     *
58
     * @param Builder      $builder
59
     * @param string|array $paths
60
     * @param array|null   $options e.g.: ['fingerprint' => true, 'minify' => true, 'filename' => '', 'ignore_missing' => false]
61
     *
62
     * @throws RuntimeException
63
     */
64 1
    public function __construct(Builder $builder, $paths, array $options = null)
65
    {
66 1
        $this->builder = $builder;
67 1
        $this->config = $builder->getConfig();
68 1
        $paths = is_array($paths) ? $paths : [$paths];
69 1
        array_walk($paths, function ($path) {
70 1
            if (!is_string($path)) {
71
                throw new RuntimeException(\sprintf('The path to an asset must be a string (%s given).', gettype($path)));
72
            }
73 1
            if (empty($path)) {
74
                throw new RuntimeException('The path to an asset can\'t be empty.');
75
            }
76 1
            if (substr($path, 0, 2) == '..') {
77
                throw new RuntimeException(\sprintf('The path to asset "%s" is wrong: it must be directly relative to "assets" or "static" directory, or a remote URL.', $path));
78
            }
79 1
        });
80 1
        $this->data = [
81 1
            'file'           => '',    // absolute file path
82 1
            'files'          => [],    // array of files path (if bundle)
83 1
            'filename'       => '',    // filename
84 1
            'path_source'    => '',    // public path to the file, before transformations
85 1
            'path'           => '',    // public path to the file, after transformations
86 1
            'url'            => null,  // URL of a remote image
87 1
            'missing'        => false, // if file not found, but missing ollowed 'missing' is true
88 1
            'ext'            => '',    // file extension
89 1
            'type'           => '',    // file type (e.g.: image, audio, video, etc.)
90 1
            'subtype'        => '',    // file media type (e.g.: image/png, audio/mp3, etc.)
91 1
            'size'           => 0,     // file size (in bytes)
92 1
            'content_source' => '',    // file content, before transformations
93 1
            'content'        => '',    // file content, after transformations
94 1
            'width'          => 0,     // width (in pixels) in case of an image
95 1
            'height'         => 0,     // height (in pixels) in case of an image
96 1
            'exif'           => [],    // exif data
97 1
        ];
98
99
        // handles options
100 1
        $fingerprint = (bool) $this->config->get('assets.fingerprint.enabled');
101 1
        $minify = (bool) $this->config->get('assets.minify.enabled');
102 1
        $optimize = (bool) $this->config->get('assets.images.optimize.enabled');
103 1
        $filename = '';
104 1
        $ignore_missing = false;
105 1
        $remote_fallback = null;
106 1
        $force_slash = true;
107 1
        extract(is_array($options) ? $options : [], EXTR_IF_EXISTS);
108 1
        $this->ignore_missing = $ignore_missing;
109
110
        // fill data array with file(s) informations
111 1
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
112 1
        $cacheKey = \sprintf('%s__%s', implode('_', $paths), $this->builder->getVersion());
113 1
        if (!$cache->has($cacheKey)) {
114 1
            $pathsCount = count($paths);
115 1
            $file = [];
116 1
            for ($i = 0; $i < $pathsCount; $i++) {
117
                // loads file(s)
118 1
                $file[$i] = $this->loadFile($paths[$i], $ignore_missing, $remote_fallback, $force_slash);
119
                // bundle: same type/ext only
120 1
                if ($i > 0) {
121 1
                    if ($file[$i]['type'] != $file[$i - 1]['type']) {
122
                        throw new RuntimeException(\sprintf('Asset bundle type error (%s != %s).', $file[$i]['type'], $file[$i - 1]['type']));
123
                    }
124 1
                    if ($file[$i]['ext'] != $file[$i - 1]['ext']) {
125
                        throw new RuntimeException(\sprintf('Asset bundle extension error (%s != %s).', $file[$i]['ext'], $file[$i - 1]['ext']));
126
                    }
127
                }
128
                // missing allowed = empty path
129 1
                if ($file[$i]['missing']) {
130 1
                    $this->data['missing'] = true;
131 1
                    $this->data['path'] = $file[$i]['path'];
132
133 1
                    continue;
134
                }
135
                // set data
136 1
                $this->data['size'] += $file[$i]['size'];
137 1
                $this->data['content_source'] .= $file[$i]['content'];
138 1
                $this->data['content'] .= $file[$i]['content'];
139 1
                if ($i == 0) {
140 1
                    $this->data['file'] = $file[$i]['filepath'];
141 1
                    $this->data['filename'] = $file[$i]['path'];
142 1
                    $this->data['path_source'] = $file[$i]['path'];
143 1
                    $this->data['path'] = $file[$i]['path'];
144 1
                    if (!empty($filename)) { /** @phpstan-ignore-line */
145 1
                        $this->data['path'] = '/' . ltrim($filename, '/');
146
                    }
147 1
                    $this->data['url'] = $file[$i]['url'];
148 1
                    $this->data['ext'] = $file[$i]['ext'];
149 1
                    $this->data['type'] = $file[$i]['type'];
150 1
                    $this->data['subtype'] = $file[$i]['subtype'];
151 1
                    if ($this->data['type'] == 'image') {
152 1
                        $this->data['width'] = $this->getWidth();
153 1
                        $this->data['height'] = $this->getHeight();
154 1
                        if ($this->data['subtype'] == 'jpeg') {
155
                            $this->data['exif'] = Util\File::readExif($file[$i]['filepath']);
156
                        }
157
                    }
158
                }
159
                // bundle files path
160 1
                $this->data['files'][] = $file[$i]['filepath'];
161
            }
162
            // bundle: define path
163 1
            if ($pathsCount > 1 && empty($filename)) { /** @phpstan-ignore-line */
164
                switch ($this->data['ext']) {
165
                    case 'scss':
166
                    case 'css':
167
                        $this->data['path'] = '/styles.' . $file[0]['ext'];
168
                        break;
169
                    case 'js':
170
                        $this->data['path'] = '/scripts.' . $file[0]['ext'];
171
                        break;
172
                    default:
173
                        throw new RuntimeException(\sprintf('Asset bundle supports "%s" files only.', '.scss, .css and .js'));
174
                }
175
            }
176 1
            $cache->set($cacheKey, $this->data);
177
        }
178 1
        $this->data = $cache->get($cacheKey);
179
180
        // fingerprinting
181 1
        if ($fingerprint) {
182 1
            $this->fingerprint();
183
        }
184
        // compiling (Sass files)
185 1
        if ((bool) $this->config->get('assets.compile.enabled')) {
186 1
            $this->compile();
187
        }
188
        // minifying (CSS and JavScript files)
189 1
        if ($minify) {
190 1
            $this->minify();
191
        }
192
        // optimizing (images files)
193 1
        if ($optimize) {
194 1
            $this->optimize = true;
195
        }
196
    }
197
198
    /**
199
     * Returns path.
200
     *
201
     * @throws RuntimeException
202
     */
203 1
    public function __toString(): string
204
    {
205
        try {
206 1
            $this->save();
207
        } catch (\Exception $e) {
208
            $this->builder->getLogger()->error($e->getMessage());
209
        }
210
211 1
        if ($this->isImageInCdn()) {
212
            return $this->buildImageCdnUrl();
213
        }
214
215 1
        if ($this->builder->getConfig()->get('canonicalurl')) {
216
            return (string) new Url($this->builder, $this->data['path'], ['canonical' => true]);
217
        }
218
219 1
        return $this->data['path'];
220
    }
221
222
    /**
223
     * Fingerprints a file.
224
     */
225 1
    public function fingerprint(): self
226
    {
227 1
        if ($this->fingerprinted) {
228 1
            return $this;
229
        }
230
231 1
        $fingerprint = hash('md5', $this->data['content_source']);
232 1
        $this->data['path'] = preg_replace(
233 1
            '/\.' . $this->data['ext'] . '$/m',
234 1
            ".$fingerprint." . $this->data['ext'],
235 1
            $this->data['path']
236 1
        );
237
238 1
        $this->fingerprinted = true;
239
240 1
        return $this;
241
    }
242
243
    /**
244
     * Compiles a SCSS.
245
     *
246
     * @throws RuntimeException
247
     */
248 1
    public function compile(): self
249
    {
250 1
        if ($this->compiled) {
251 1
            return $this;
252
        }
253
254 1
        if ($this->data['ext'] != 'scss') {
255 1
            return $this;
256
        }
257
258 1
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
259 1
        $cacheKey = $cache->createKeyFromAsset($this, ['compiled']);
260 1
        if (!$cache->has($cacheKey)) {
261 1
            $scssPhp = new Compiler();
262 1
            $importDir = [];
263 1
            $importDir[] = Util::joinPath($this->config->getStaticPath());
264 1
            $importDir[] = Util::joinPath($this->config->getAssetsPath());
265 1
            $scssDir = $this->config->get('assets.compile.import') ?? [];
266 1
            $themes = $this->config->getTheme() ?? [];
267 1
            foreach ($scssDir as $dir) {
268 1
                $importDir[] = Util::joinPath($this->config->getStaticPath(), $dir);
269 1
                $importDir[] = Util::joinPath($this->config->getAssetsPath(), $dir);
270 1
                $importDir[] = Util::joinPath(dirname($this->data['file']), $dir);
271 1
                foreach ($themes as $theme) {
272 1
                    $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "static/$dir"));
273 1
                    $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "assets/$dir"));
274
                }
275
            }
276 1
            $scssPhp->setImportPaths(array_unique($importDir));
277
            // source map
278 1
            if ($this->builder->isDebug() && (bool) $this->config->get('assets.compile.sourcemap')) {
279
                $importDir = [];
280
                $assetDir = (string) $this->config->get('assets.dir');
281
                $assetDirPos = strrpos($this->data['file'], DIRECTORY_SEPARATOR . $assetDir . DIRECTORY_SEPARATOR);
282
                $fileRelPath = substr($this->data['file'], $assetDirPos + 8);
283
                $filePath = Util::joinFile($this->config->getOutputPath(), $fileRelPath);
284
                $importDir[] = dirname($filePath);
285
                foreach ($scssDir as $dir) {
286
                    $importDir[] = Util::joinFile($this->config->getOutputPath(), $dir);
287
                }
288
                $scssPhp->setImportPaths(array_unique($importDir));
289
                $scssPhp->setSourceMap(Compiler::SOURCE_MAP_INLINE);
290
                $scssPhp->setSourceMapOptions([
291
                    'sourceMapBasepath' => Util::joinPath($this->config->getOutputPath()),
292
                    'sourceRoot'        => '/',
293
                ]);
294
            }
295
            // output style
296 1
            $outputStyles = ['expanded', 'compressed'];
297 1
            $outputStyle = strtolower((string) $this->config->get('assets.compile.style'));
298 1
            if (!in_array($outputStyle, $outputStyles)) {
299
                throw new RuntimeException(\sprintf('Scss output style "%s" doesn\'t exists.', $outputStyle));
300
            }
301 1
            $scssPhp->setOutputStyle($outputStyle);
302
            // variables
303 1
            $variables = $this->config->get('assets.compile.variables') ?? [];
304 1
            if (!empty($variables)) {
305 1
                $variables = array_map('ScssPhp\ScssPhp\ValueConverter::parseValue', $variables);
306 1
                $scssPhp->replaceVariables($variables);
307
            }
308
            // update data
309 1
            $this->data['path'] = preg_replace('/sass|scss/m', 'css', $this->data['path']);
310 1
            $this->data['ext'] = 'css';
311 1
            $this->data['type'] = 'text';
312 1
            $this->data['subtype'] = 'text/css';
313 1
            $this->data['content'] = $scssPhp->compileString($this->data['content'])->getCss();
314 1
            $this->data['size'] = strlen($this->data['content']);
315 1
            $this->compiled = true;
316 1
            $cache->set($cacheKey, $this->data);
317
        }
318 1
        $this->data = $cache->get($cacheKey);
319
320 1
        return $this;
321
    }
322
323
    /**
324
     * Minifying a CSS or a JS.
325
     *
326
     * @throws RuntimeException
327
     */
328 1
    public function minify(): self
329
    {
330
        // disable minify to preserve inline source map
331 1
        if ($this->builder->isDebug() && (bool) $this->config->get('assets.compile.sourcemap')) {
332
            return $this;
333
        }
334
335 1
        if ($this->minified) {
336 1
            return $this;
337
        }
338
339 1
        if ($this->data['ext'] == 'scss') {
340
            $this->compile();
341
        }
342
343 1
        if ($this->data['ext'] != 'css' && $this->data['ext'] != 'js') {
344 1
            return $this;
345
        }
346
347 1
        if (substr($this->data['path'], -8) == '.min.css' || substr($this->data['path'], -7) == '.min.js') {
348 1
            $this->minified;
349
350 1
            return $this;
351
        }
352
353 1
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
354 1
        $cacheKey = $cache->createKeyFromAsset($this, ['minified']);
355 1
        if (!$cache->has($cacheKey)) {
356 1
            switch ($this->data['ext']) {
357 1
                case 'css':
358 1
                    $minifier = new Minify\CSS($this->data['content']);
359 1
                    break;
360 1
                case 'js':
361 1
                    $minifier = new Minify\JS($this->data['content']);
362 1
                    break;
363
                default:
364
                    throw new RuntimeException(\sprintf('Not able to minify "%s"', $this->data['path']));
365
            }
366 1
            $this->data['path'] = preg_replace(
367 1
                '/\.' . $this->data['ext'] . '$/m',
368 1
                '.min.' . $this->data['ext'],
369 1
                $this->data['path']
370 1
            );
371 1
            $this->data['content'] = $minifier->minify();
372 1
            $this->data['size'] = strlen($this->data['content']);
373 1
            $this->minified = true;
374 1
            $cache->set($cacheKey, $this->data);
375
        }
376 1
        $this->data = $cache->get($cacheKey);
377
378 1
        return $this;
379
    }
380
381
    /**
382
     * Optimizing an image.
383
     */
384 1
    public function optimize(string $filepath): self
385
    {
386 1
        if ($this->data['type'] != 'image') {
387 1
            return $this;
388
        }
389
390 1
        $quality = $this->config->get('assets.images.quality') ?? 75;
391 1
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
392 1
        $tags = ["q$quality", 'optimized'];
393 1
        if ($this->data['width']) {
394 1
            array_unshift($tags, "{$this->data['width']}x");
395
        }
396 1
        $cacheKey = $cache->createKeyFromAsset($this, $tags);
397 1
        if (!$cache->has($cacheKey)) {
398 1
            $message = $this->data['path'];
399 1
            $sizeBefore = filesize($filepath);
400 1
            Optimizer::create($quality)->optimize($filepath);
401 1
            $sizeAfter = filesize($filepath);
402 1
            if ($sizeAfter < $sizeBefore) {
403
                $message = \sprintf(
404
                    '%s (%s Ko -> %s Ko)',
405
                    $message,
406
                    ceil($sizeBefore / 1000),
407
                    ceil($sizeAfter / 1000)
408
                );
409
            }
410 1
            $this->data['content'] = Util\File::fileGetContents($filepath);
411 1
            $this->data['size'] = $sizeAfter;
412 1
            $cache->set($cacheKey, $this->data);
413 1
            $this->builder->getLogger()->debug(\sprintf('Asset "%s" optimized', $message));
414
        }
415 1
        $this->data = $cache->get($cacheKey);
416 1
        $this->optimized = true;
417
418 1
        return $this;
419
    }
420
421
    /**
422
     * Resizes an image with a new $width.
423
     *
424
     * @throws RuntimeException
425
     */
426 1
    public function resize(int $width): self
427
    {
428 1
        if ($this->data['missing']) {
429
            throw new RuntimeException(\sprintf('Not able to resize "%s": file not found', $this->data['path']));
430
        }
431 1
        if ($this->data['type'] != 'image') {
432
            throw new RuntimeException(\sprintf('Not able to resize "%s": not an image', $this->data['path']));
433
        }
434 1
        if ($width >= $this->data['width']) {
435
            return $this;
436
        }
437
438 1
        $assetResized = clone $this;
439 1
        $assetResized->data['width'] = $width;
440
441 1
        if ($this->isImageInCdn()) {
442
            return $assetResized; // returns the asset with the new width only: CDN do the rest of the job
443
        }
444
445 1
        $quality = $this->config->get('assets.images.quality');
446 1
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
447 1
        $cacheKey = $cache->createKeyFromAsset($assetResized, ["{$width}x", "q$quality"]);
448 1
        if (!$cache->has($cacheKey)) {
449 1
            if ($assetResized->data['type'] !== 'image') {
450
                throw new RuntimeException(\sprintf('Not able to resize "%s"', $assetResized->data['path']));
451
            }
452 1
            if (!extension_loaded('gd')) {
453
                throw new RuntimeException('GD extension is required to use images resize.');
454
            }
455
456
            try {
457 1
                $img = ImageManager::make($assetResized->data['content_source']);
458 1
                $img->resize($width, null, function (\Intervention\Image\Constraint $constraint) {
459 1
                    $constraint->aspectRatio();
460 1
                    $constraint->upsize();
461 1
                });
462
            } catch (\Exception $e) {
463
                throw new RuntimeException(\sprintf('Not able to resize image "%s": %s', $assetResized->data['path'], $e->getMessage()));
464
            }
465 1
            $assetResized->data['path'] = '/' . Util::joinPath(
466 1
                (string) $this->config->get('assets.target'),
467 1
                (string) $this->config->get('assets.images.resize.dir'),
468 1
                (string) $width,
469 1
                $assetResized->data['path']
470 1
            );
471
472
            try {
473 1
                $img->interlace();
474 1
                $assetResized->data['content'] = (string) $img->encode($assetResized->data['ext'], $quality);
475 1
                $img->destroy();
476 1
                $assetResized->data['height'] = $assetResized->getHeight();
477 1
                $assetResized->data['size'] = strlen($assetResized->data['content']);
478
            } catch (\Exception $e) {
479
                throw new RuntimeException(\sprintf('Not able to encode image "%s": %s', $assetResized->data['path'], $e->getMessage()));
480
            }
481
482 1
            $cache->set($cacheKey, $assetResized->data);
483
        }
484 1
        $assetResized->data = $cache->get($cacheKey);
485
486 1
        return $assetResized;
487
    }
488
489
    /**
490
     * Converts an image asset to WebP format.
491
     *
492
     * @throws RuntimeException
493
     */
494 1
    public function webp(?int $quality = null): self
495
    {
496 1
        if ($this->data['type'] !== 'image') {
497
            throw new RuntimeException(\sprintf('can\'t convert "%s" (%s) to WebP: it\'s not an image file.', $this->data['path'], $this->data['type']));
498
        }
499
500 1
        if ($quality === null) {
501 1
            $quality = (int) $this->config->get('assets.images.quality') ?? 75;
502
        }
503
504 1
        $assetWebp = clone $this;
505 1
        $format = 'webp';
506 1
        $assetWebp['ext'] = $format;
507
508 1
        if ($this->isImageInCdn()) {
509
            return $assetWebp; // returns the asset with the new format only: CDN do the rest of the job
510
        }
511
512 1
        $img = ImageManager::make($assetWebp['content']);
513 1
        $img->interlace();
514 1
        $assetWebp['content'] = (string) $img->encode($format, $quality);
515
        $img->interlace();
516
        $assetWebp['path'] = preg_replace('/\.' . $this->data['ext'] . '$/m', ".$format", $this->data['path']);
517
        $assetWebp['subtype'] = "image/$format";
518
        $assetWebp['size'] = strlen($assetWebp['content']);
0 ignored issues
show
Bug introduced by
It seems like $assetWebp['content'] can also be of type null; however, parameter $string of strlen() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

518
        $assetWebp['size'] = strlen(/** @scrutinizer ignore-type */ $assetWebp['content']);
Loading history...
519
520
        return $assetWebp;
521
    }
522
523
    /**
524
     * Implements \ArrayAccess.
525
     */
526
    #[\ReturnTypeWillChange]
527 1
    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
    #[\ReturnTypeWillChange]
538 1
    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
    #[\ReturnTypeWillChange]
556 1
    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
    public function getAudio(): Mp3Info
578
    {
579
        if ($this->data['type'] !== 'audio') {
580
            throw new RuntimeException(\sprintf('Not able to get audio infos of "%s"', $this->data['path']));
581
        }
582
583
        return new Mp3Info($this->data['file']);
584
    }
585
586
    /**
587
     * Returns the data URL (encoded in Base64).
588
     *
589
     * @throws RuntimeException
590
     */
591 1
    public function dataurl(): string
592
    {
593 1
        if ($this->data['type'] == 'image') {
594 1
            return (string) ImageManager::make($this->data['content'])->interlace()->encode('data-url', $this->config->get('assets.images.quality'));
595
        }
596
597 1
        return sprintf("data:%s;base64,%s", $this->data['subtype'], base64_encode($this->data['content']));
598
    }
599
600
    /**
601
     * Saves file.
602
     * Note: a file from `static/` with the same name will NOT be overridden.
603
     *
604
     * @throws RuntimeException
605
     */
606 1
    public function save(): void
607
    {
608 1
        $filepath = Util::joinFile($this->config->getOutputPath(), $this->data['path']);
609 1
        if (!$this->builder->getBuildOptions()['dry-run'] && !Util\File::getFS()->exists($filepath)) {
610
            try {
611 1
                Util\File::getFS()->dumpFile($filepath, $this->data['content']);
612 1
                $this->builder->getLogger()->debug(\sprintf('Asset "%s" saved', $this->data['path']));
613 1
                if ($this->optimize) {
614 1
                    $this->optimize($filepath);
615
                }
616
            } catch (\Symfony\Component\Filesystem\Exception\IOException $e) {
617
                if (!$this->ignore_missing) {
618
                    throw new RuntimeException(\sprintf('Can\'t save asset "%s"', $filepath));
619
                }
620
            }
621
        }
622
    }
623
624
    /**
625
     * Is Asset is an image in CDN.
626
     *
627
     * @return boolean
628
     */
629 1
    public function isImageInCdn()
630
    {
631 1
        if ($this->data['type'] != 'image' || $this->isSVG() || (bool) $this->config->get('assets.images.cdn.enabled') !== true) {
632 1
            return false;
633
        }
634
        // remote image?
635
        if ($this->data['url'] !== null && (bool) $this->config->get('assets.images.cdn.remote') !== true) {
636
            return false;
637
        }
638
639
        return true;
640
    }
641
642
    /**
643
     * Load file data.
644
     *
645
     * @throws RuntimeException
646
     */
647 1
    private function loadFile(string $path, bool $ignore_missing = false, ?string $remote_fallback = null, bool $force_slash = true): array
648
    {
649 1
        $file = [
650 1
            'url' => null,
651 1
        ];
652
653 1
        if (false === $filePath = $this->findFile($path, $remote_fallback)) {
654 1
            if ($ignore_missing) {
655 1
                $file['path'] = $path;
656 1
                $file['missing'] = true;
657
658 1
                return $file;
659
            }
660
661 1
            throw new RuntimeException(\sprintf('Asset file "%s" doesn\'t exist', $path));
662
        }
663
664 1
        if (Util\Url::isUrl($path)) {
665 1
            $file['url'] = $path;
666 1
            $path = Util\File::getFS()->makePathRelative($filePath, $this->config->getCacheAssetsRemotePath());
667 1
            $path = Util::joinPath((string) $this->config->get('assets.target'), $path);
668 1
            $force_slash = true;
669
        }
670 1
        if ($force_slash) {
671 1
            $path = '/' . ltrim($path, '/');
672
        }
673
674 1
        list($type, $subtype) = Util\File::getMimeType($filePath);
675 1
        $content = Util\File::fileGetContents($filePath);
676
677 1
        $file['filepath'] = $filePath;
678 1
        $file['path'] = $path;
679 1
        $file['ext'] = pathinfo($path)['extension'] ?? '';
680 1
        $file['type'] = $type;
681 1
        $file['subtype'] = $subtype;
682 1
        $file['size'] = filesize($filePath);
683 1
        $file['content'] = $content;
684 1
        $file['missing'] = false;
685
686 1
        return $file;
687
    }
688
689
    /**
690
     * Try to find the file:
691
     *   1. remote (if $path is a valid URL)
692
     *   2. in static/
693
     *   3. in themes/<theme>/static/
694
     * Returns local file path or false if file don't exists.
695
     *
696
     * @throws RuntimeException
697
     *
698
     * @return string|false
699
     */
700 1
    private function findFile(string $path, ?string $remote_fallback = null)
701
    {
702
        // in case of remote file: save it and returns cached file path
703 1
        if (Util\Url::isUrl($path)) {
704 1
            $url = $path;
705 1
            $urlHost = parse_url($path, PHP_URL_HOST);
706 1
            $urlPath = parse_url($path, PHP_URL_PATH);
707 1
            $urlQuery = parse_url($path, PHP_URL_QUERY);
708 1
            $extension = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION);
709
            // Google Fonts hack
710 1
            if (strpos($urlPath, '/css') !== false) {
711 1
                $extension = 'css';
712
            }
713 1
            $relativePath = Page::slugify(\sprintf(
714 1
                '%s%s%s%s',
715 1
                $urlHost,
716 1
                $this->sanitize($urlPath),
717 1
                $urlQuery ? "-$urlQuery" : '',
718 1
                $urlQuery && $extension ? " . $extension" : ''
719 1
            ));
720 1
            $filePath = Util::joinFile($this->config->getCacheAssetsRemotePath(), $relativePath);
721 1
            if (!file_exists($filePath)) {
722 1
                if (!Util\Url::isRemoteFileExists($url)) {
723
                    // is there a fallback in assets/
724 1
                    if ($remote_fallback) {
725 1
                        $filePath = Util::joinFile($this->config->getAssetsPath(), $remote_fallback);
726 1
                        if (Util\File::getFS()->exists($filePath)) {
727
                            return $filePath;
728
                        }
729
                    }
730
731 1
                    return false;
732
                }
733 1
                if (false === $content = Util\File::fileGetContents($url, true)) {
734
                    return false;
735
                }
736 1
                if (strlen($content) <= 1) {
737
                    throw new RuntimeException(\sprintf('Asset at "%s" is empty', $url));
738
                }
739 1
                Util\File::getFS()->dumpFile($filePath, $content);
740
            }
741
742 1
            return $filePath;
743
        }
744
745
        // checks in assets/
746 1
        $filePath = Util::joinFile($this->config->getAssetsPath(), $path);
747 1
        if (Util\File::getFS()->exists($filePath)) {
748 1
            return $filePath;
749
        }
750
751
        // checks in each themes/<theme>/assets/
752 1
        foreach ($this->config->getTheme() as $theme) {
753 1
            $filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'assets'), $path);
754 1
            if (Util\File::getFS()->exists($filePath)) {
755
                return $filePath;
756
            }
757
        }
758
759
        // checks in static/
760 1
        $filePath = Util::joinFile($this->config->getStaticTargetPath(), $path);
761 1
        if (Util\File::getFS()->exists($filePath)) {
762 1
            return $filePath;
763
        }
764
765
        // checks in each themes/<theme>/static/
766 1
        foreach ($this->config->getTheme() as $theme) {
767 1
            $filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'static'), $path);
768 1
            if (Util\File::getFS()->exists($filePath)) {
769 1
                return $filePath;
770
            }
771
        }
772
773 1
        return false;
774
    }
775
776
    /**
777
     * Returns the width of an image/SVG.
778
     *
779
     * @throws RuntimeException
780
     */
781 1
    private function getWidth(): int
782
    {
783 1
        if ($this->data['type'] != 'image') {
784
            return 0;
785
        }
786 1
        if ($this->isSVG() && false !== $svg = $this->getSvgAttributes()) {
787 1
            return (int) $svg->width;
788
        }
789 1
        if (false === $size = $this->getImageSize()) {
790
            throw new RuntimeException(\sprintf('Not able to get width of "%s"', $this->data['path']));
791
        }
792
793 1
        return $size[0];
794
    }
795
796
    /**
797
     * Returns the height of an image/SVG.
798
     *
799
     * @throws RuntimeException
800
     */
801 1
    private function getHeight(): int
802
    {
803 1
        if ($this->data['type'] != 'image') {
804
            return 0;
805
        }
806 1
        if ($this->isSVG() && false !== $svg = $this->getSvgAttributes()) {
807 1
            return (int) $svg->height;
808
        }
809 1
        if (false === $size = $this->getImageSize()) {
810
            throw new RuntimeException(\sprintf('Not able to get height of "%s"', $this->data['path']));
811
        }
812
813 1
        return $size[1];
814
    }
815
816
    /**
817
     * Returns image size informations.
818
     *
819
     * @see https://www.php.net/manual/function.getimagesize.php
820
     *
821
     * @return array|false
822
     */
823 1
    private function getImageSize()
824
    {
825 1
        if (!$this->data['type'] == 'image') {
826
            return false;
827
        }
828
829
        try {
830 1
            if (false === $size = getimagesizefromstring($this->data['content'])) {
831 1
                return false;
832
            }
833
        } catch (\Exception $e) {
834
            throw new RuntimeException(\sprintf('Handling asset "%s" failed: "%s"', $this->data['path_source'], $e->getMessage()));
835
        }
836
837 1
        return $size;
838
    }
839
840
    /**
841
     * Returns true if asset is a SVG.
842
     */
843 1
    private function isSVG(): bool
844
    {
845 1
        return in_array($this->data['subtype'], ['image/svg', 'image/svg+xml']) || $this->data['ext'] == 'svg';
846
    }
847
848
    /**
849
     * Returns SVG attributes.
850
     *
851
     * @return \SimpleXMLElement|false
852
     */
853 1
    private function getSvgAttributes()
854
    {
855 1
        if (false === $xml = simplexml_load_string($this->data['content_source'])) {
856
            return false;
857
        }
858
859 1
        return $xml->attributes();
860
    }
861
862
    /**
863
     * Replaces some characters by '_'.
864
     */
865 1
    private function sanitize(string $string): string
866
    {
867 1
        return str_replace(['<', '>', ':', '"', '\\', '|', '?', '*'], '_', $string);
868
    }
869
870
    /**
871
     * Builds CDN image URL.
872
     */
873
    private function buildImageCdnUrl(): string
874
    {
875
        return str_replace(
876
            [
877
                '%account%',
878
                '%image_url%',
879
                '%width%',
880
                '%quality%',
881
                '%format%',
882
            ],
883
            [
884
                $this->config->get('assets.images.cdn.account'),
885
                ltrim($this->data['url'] ?? (string) new Url($this->builder, $this->data['path'], ['canonical' => $this->config->get('assets.images.cdn.canonical') ?? true]), '/'),
886
                $this->data['width'],
887
                $this->config->get('assets.images.quality') ?? 75,
888
                $this->data['ext'],
889
            ],
890
            (string) $this->config->get('assets.images.cdn.url')
891
        );
892
    }
893
}
894