• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

Cecilapp / Cecil / 12021297559

26 Nov 2024 12:25AM UTC coverage: 83.555% (-0.2%) from 83.781%
12021297559

push

github

web-flow
refactor: rebuild configuration (#2068)

63 of 85 new or added lines in 11 files covered. (74.12%)

6 existing lines in 1 file now uncovered.

2957 of 3539 relevant lines covered (83.55%)

0.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

79.67
/src/Assets/Asset.php
1
<?php
2

3
declare(strict_types=1);
4

5
/*
6
 * This file is part of Cecil.
7
 *
8
 * Copyright (c) Arnaud Ligny <arnaud@ligny.fr>
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
    public function __construct(Builder $builder, string|array $paths, array|null $options = null)
63
    {
64
        $this->builder = $builder;
1✔
65
        $this->config = $builder->getConfig();
1✔
66
        $paths = \is_array($paths) ? $paths : [$paths];
1✔
67
        array_walk($paths, function ($path) {
1✔
68
            if (!\is_string($path)) {
1✔
69
                throw new RuntimeException(\sprintf('The path of an asset must be a string ("%s" given).', \gettype($path)));
×
70
            }
71
            if (empty($path)) {
1✔
72
                throw new RuntimeException('The path of an asset can\'t be empty.');
×
73
            }
74
            if (substr($path, 0, 2) == '..') {
1✔
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
        $this->data = [
1✔
79
            'file'           => '',    // absolute file path
1✔
80
            'files'          => [],    // array of files path (if bundle)
1✔
81
            'filename'       => '',    // filename
1✔
82
            'path_source'    => '',    // public path to the file, before transformations
1✔
83
            'path'           => '',    // public path to the file, after transformations
1✔
84
            'url'            => null,  // URL of a remote image
1✔
85
            'missing'        => false, // if file not found, but missing ollowed 'missing' is true
1✔
86
            'ext'            => '',    // file extension
1✔
87
            'type'           => '',    // file type (e.g.: image, audio, video, etc.)
1✔
88
            'subtype'        => '',    // file media type (e.g.: image/png, audio/mp3, etc.)
1✔
89
            'size'           => 0,     // file size (in bytes)
1✔
90
            'content_source' => '',    // file content, before transformations
1✔
91
            'content'        => '',    // file content, after transformations
1✔
92
            'width'          => 0,     // width (in pixels) in case of an image
1✔
93
            'height'         => 0,     // height (in pixels) in case of an image
1✔
94
            'exif'           => [],    // exif data
1✔
95
        ];
1✔
96

97
        // handles options
98
        $fingerprint = (bool) $this->config->get('assets.fingerprint.enabled');
1✔
99
        $minify = (bool) $this->config->get('assets.minify.enabled');
1✔
100
        $optimize = (bool) $this->config->get('assets.images.optimize.enabled');
1✔
101
        $filename = '';
1✔
102
        $ignore_missing = false;
1✔
103
        $remote_fallback = null;
1✔
104
        $force_slash = true;
1✔
105
        extract(\is_array($options) ? $options : [], EXTR_IF_EXISTS);
1✔
106
        $this->ignore_missing = $ignore_missing;
1✔
107

108
        // fill data array with file(s) informations
109
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
110
        $cacheKey = \sprintf('%s__%s', $filename ?: implode('_', $paths), $this->builder->getVersion());
1✔
111
        if (!$cache->has($cacheKey)) {
1✔
112
            $pathsCount = \count($paths);
1✔
113
            $file = [];
1✔
114
            for ($i = 0; $i < $pathsCount; $i++) {
1✔
115
                // loads file(s)
116
                $file[$i] = $this->loadFile($paths[$i], $ignore_missing, $remote_fallback, $force_slash);
1✔
117
                // bundle: same type only
118
                if ($i > 0) {
1✔
119
                    if ($file[$i]['type'] != $file[$i - 1]['type']) {
1✔
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
                if ($file[$i]['missing']) {
1✔
125
                    $this->data['missing'] = true;
1✔
126
                    $this->data['path'] = $file[$i]['path'];
1✔
127

128
                    continue;
1✔
129
                }
130
                // set data
131
                $this->data['size'] += $file[$i]['size'];
1✔
132
                $this->data['content_source'] .= $file[$i]['content'];
1✔
133
                $this->data['content'] .= $file[$i]['content'];
1✔
134
                if ($i == 0) {
1✔
135
                    $this->data['file'] = $file[$i]['filepath'];
1✔
136
                    $this->data['filename'] = $file[$i]['path'];
1✔
137
                    $this->data['path_source'] = $file[$i]['path'];
1✔
138
                    $this->data['path'] = $file[$i]['path'];
1✔
139
                    $this->data['url'] = $file[$i]['url'];
1✔
140
                    $this->data['ext'] = $file[$i]['ext'];
1✔
141
                    $this->data['type'] = $file[$i]['type'];
1✔
142
                    $this->data['subtype'] = $file[$i]['subtype'];
1✔
143
                    if ($this->data['type'] == 'image') {
1✔
144
                        $this->data['width'] = $this->getWidth();
1✔
145
                        $this->data['height'] = $this->getHeight();
1✔
146
                        if ($this->data['subtype'] == 'image/jpeg') {
1✔
147
                            $this->data['exif'] = Util\File::readExif($file[$i]['filepath']);
1✔
148
                        }
149
                    }
150
                    // bundle: default filename
151
                    if ($pathsCount > 1 && empty($filename)) {
1✔
152
                        switch ($this->data['ext']) {
1✔
153
                            case 'scss':
1✔
154
                            case 'css':
1✔
155
                                $filename = '/styles.css';
1✔
156
                                break;
1✔
157
                            case 'js':
1✔
158
                                $filename = '/scripts.js';
1✔
159
                                break;
1✔
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
                    if (!empty($filename)) {
1✔
166
                        $this->data['filename'] = $filename;
1✔
167
                        $this->data['path'] = '/' . ltrim($filename, '/');
1✔
168
                    }
169
                }
170
                // bundle: files path
171
                $this->data['files'][] = $file[$i]['filepath'];
1✔
172
            }
173
            $cache->set($cacheKey, $this->data);
1✔
174
        }
175
        $this->data = $cache->get($cacheKey);
1✔
176

177
        // fingerprinting
178
        if ($fingerprint) {
1✔
179
            $this->fingerprint();
1✔
180
        }
181
        // compiling (Sass files)
182
        if ((bool) $this->config->get('assets.compile.enabled')) {
1✔
183
            $this->compile();
1✔
184
        }
185
        // minifying (CSS and JavScript files)
186
        if ($minify) {
1✔
187
            $this->minify();
1✔
188
        }
189
        // optimizing (images files)
190
        if ($optimize) {
1✔
191
            $this->optimize = true;
1✔
192
        }
193
    }
194

195
    /**
196
     * Returns path.
197
     *
198
     * @throws RuntimeException
199
     */
200
    public function __toString(): string
201
    {
202
        try {
203
            $this->save();
1✔
204
        } catch (RuntimeException $e) {
×
205
            $this->builder->getLogger()->error($e->getMessage());
×
206
        }
207

208
        if ($this->isImageInCdn()) {
1✔
209
            return $this->buildImageCdnUrl();
×
210
        }
211

212
        if ($this->builder->getConfig()->get('canonicalurl')) {
1✔
213
            return (string) new Url($this->builder, $this->data['path'], ['canonical' => true]);
×
214
        }
215

216
        return $this->data['path'];
1✔
217
    }
218

219
    /**
220
     * Fingerprints a file.
221
     */
222
    public function fingerprint(): self
223
    {
224
        if ($this->fingerprinted) {
1✔
225
            return $this;
1✔
226
        }
227

228
        $fingerprint = hash('md5', $this->data['content_source']);
1✔
229
        $this->data['path'] = preg_replace(
1✔
230
            '/\.' . $this->data['ext'] . '$/m',
1✔
231
            ".$fingerprint." . $this->data['ext'],
1✔
232
            $this->data['path']
1✔
233
        );
1✔
234

235
        $this->fingerprinted = true;
1✔
236

237
        return $this;
1✔
238
    }
239

240
    /**
241
     * Compiles a SCSS.
242
     *
243
     * @throws RuntimeException
244
     */
245
    public function compile(): self
246
    {
247
        if ($this->compiled) {
1✔
248
            return $this;
1✔
249
        }
250

251
        if ($this->data['ext'] != 'scss') {
1✔
252
            return $this;
1✔
253
        }
254

255
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
256
        $cacheKey = $cache->createKeyFromAsset($this, ['compiled']);
1✔
257
        if (!$cache->has($cacheKey)) {
1✔
258
            $scssPhp = new Compiler();
1✔
259
            $importDir = [];
1✔
260
            $importDir[] = Util::joinPath($this->config->getStaticPath());
1✔
261
            $importDir[] = Util::joinPath($this->config->getAssetsPath());
1✔
262
            $scssDir = $this->config->get('assets.compile.import');
1✔
263
            $themes = $this->config->getTheme() ?? [];
1✔
264
            foreach ($scssDir as $dir) {
1✔
265
                $importDir[] = Util::joinPath($this->config->getStaticPath(), $dir);
1✔
266
                $importDir[] = Util::joinPath($this->config->getAssetsPath(), $dir);
1✔
267
                $importDir[] = Util::joinPath(\dirname($this->data['file']), $dir);
1✔
268
                foreach ($themes as $theme) {
1✔
269
                    $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "static/$dir"));
1✔
270
                    $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "assets/$dir"));
1✔
271
                }
272
            }
273
            $scssPhp->setImportPaths(array_unique($importDir));
1✔
274
            // source map
275
            if ($this->builder->isDebug() && (bool) $this->config->get('assets.compile.sourcemap')) {
1✔
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
            $outputStyles = ['expanded', 'compressed'];
1✔
294
            $outputStyle = strtolower((string) $this->config->get('assets.compile.style'));
1✔
295
            if (!\in_array($outputStyle, $outputStyles)) {
1✔
296
                throw new ConfigException(\sprintf('"%s" value must be "%s".', 'assets.compile.style', implode('" or "', $outputStyles)));
×
297
            }
298
            $scssPhp->setOutputStyle($outputStyle);
1✔
299
            // variables
300
            $variables = $this->config->get('assets.compile.variables');
1✔
301
            if (!empty($variables)) {
1✔
302
                $variables = array_map('ScssPhp\ScssPhp\ValueConverter::parseValue', $variables);
1✔
303
                $scssPhp->replaceVariables($variables);
1✔
304
            }
305
            // update data
306
            $this->data['path'] = preg_replace('/sass|scss/m', 'css', $this->data['path']);
1✔
307
            $this->data['ext'] = 'css';
1✔
308
            $this->data['type'] = 'text';
1✔
309
            $this->data['subtype'] = 'text/css';
1✔
310
            $this->data['content'] = $scssPhp->compileString($this->data['content'])->getCss();
1✔
311
            $this->data['size'] = \strlen($this->data['content']);
1✔
312
            $this->compiled = true;
1✔
313
            $cache->set($cacheKey, $this->data);
1✔
314
        }
315
        $this->data = $cache->get($cacheKey);
1✔
316

317
        return $this;
1✔
318
    }
319

320
    /**
321
     * Minifying a CSS or a JS.
322
     *
323
     * @throws RuntimeException
324
     */
325
    public function minify(): self
326
    {
327
        // disable minify to preserve inline source map
328
        if ($this->builder->isDebug() && (bool) $this->config->get('assets.compile.sourcemap')) {
1✔
329
            return $this;
×
330
        }
331

332
        if ($this->minified) {
1✔
333
            return $this;
×
334
        }
335

336
        if ($this->data['ext'] == 'scss') {
1✔
337
            $this->compile();
×
338
        }
339

340
        if ($this->data['ext'] != 'css' && $this->data['ext'] != 'js') {
1✔
341
            return $this;
×
342
        }
343

344
        if (substr($this->data['path'], -8) == '.min.css' || substr($this->data['path'], -7) == '.min.js') {
1✔
345
            $this->minified;
×
346

347
            return $this;
×
348
        }
349

350
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
351
        $cacheKey = $cache->createKeyFromAsset($this, ['minified']);
1✔
352
        if (!$cache->has($cacheKey)) {
1✔
353
            switch ($this->data['ext']) {
1✔
354
                case 'css':
1✔
355
                    $minifier = new Minify\CSS($this->data['content']);
1✔
356
                    break;
1✔
357
                case 'js':
1✔
358
                    $minifier = new Minify\JS($this->data['content']);
1✔
359
                    break;
1✔
360
                default:
361
                    throw new RuntimeException(\sprintf('Not able to minify "%s".', $this->data['path']));
×
362
            }
363
            $this->data['path'] = preg_replace(
1✔
364
                '/\.' . $this->data['ext'] . '$/m',
1✔
365
                '.min.' . $this->data['ext'],
1✔
366
                $this->data['path']
1✔
367
            );
1✔
368
            $this->data['content'] = $minifier->minify();
1✔
369
            $this->data['size'] = \strlen($this->data['content']);
1✔
370
            $this->minified = true;
1✔
371
            $cache->set($cacheKey, $this->data);
1✔
372
        }
373
        $this->data = $cache->get($cacheKey);
1✔
374

375
        return $this;
1✔
376
    }
377

378
    /**
379
     * Optimizing an image.
380
     */
381
    public function optimize(string $filepath): self
382
    {
383
        if ($this->data['type'] != 'image') {
1✔
384
            return $this;
1✔
385
        }
386

387
        $quality = $this->config->get('assets.images.quality');
1✔
388
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
389
        $tags = ["q$quality", 'optimized'];
1✔
390
        if ($this->data['width']) {
1✔
391
            array_unshift($tags, "{$this->data['width']}x");
1✔
392
        }
393
        $cacheKey = $cache->createKeyFromAsset($this, $tags);
1✔
394
        if (!$cache->has($cacheKey)) {
1✔
395
            $message = $filepath;
1✔
396
            $sizeBefore = filesize($filepath);
1✔
397
            Optimizer::create($quality)->optimize($filepath);
1✔
398
            $sizeAfter = filesize($filepath);
1✔
399
            if ($sizeAfter < $sizeBefore) {
1✔
400
                $message = \sprintf(
1✔
401
                    '%s (%s Ko -> %s Ko)',
1✔
402
                    $message,
1✔
403
                    ceil($sizeBefore / 1000),
1✔
404
                    ceil($sizeAfter / 1000)
1✔
405
                );
1✔
406
            }
407
            $this->data['content'] = Util\File::fileGetContents($filepath);
1✔
408
            $this->data['size'] = $sizeAfter;
1✔
409
            $cache->set($cacheKey, $this->data);
1✔
410
            $this->builder->getLogger()->debug(\sprintf('Asset "%s" optimized', $message));
1✔
411
        }
412
        $this->data = $cache->get($cacheKey, $this->data);
1✔
413

414
        return $this;
1✔
415
    }
416

417
    /**
418
     * Resizes an image with a new $width.
419
     *
420
     * @throws RuntimeException
421
     */
422
    public function resize(int $width): self
423
    {
424
        if ($this->data['missing']) {
1✔
425
            throw new RuntimeException(\sprintf('Not able to resize "%s": file not found.', $this->data['path']));
×
426
        }
427
        if ($this->data['type'] != 'image') {
1✔
428
            throw new RuntimeException(\sprintf('Not able to resize "%s": not an image.', $this->data['path']));
×
429
        }
430
        if ($width >= $this->data['width']) {
1✔
431
            return $this;
1✔
432
        }
433

434
        $assetResized = clone $this;
1✔
435
        $assetResized->data['width'] = $width;
1✔
436

437
        if ($this->isImageInCdn()) {
1✔
438
            return $assetResized; // returns asset with the new width only: CDN do the rest of the job
×
439
        }
440

441
        $quality = $this->config->get('assets.images.quality');
1✔
442
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
443
        $cacheKey = $cache->createKeyFromAsset($assetResized, ["{$width}x", "q$quality"]);
1✔
444
        if (!$cache->has($cacheKey)) {
1✔
445
            $assetResized->data['content'] = Image::resize($assetResized, $width, $quality);
1✔
446
            $assetResized->data['path'] = '/' . Util::joinPath(
1✔
447
                (string) $this->config->get('assets.target'),
1✔
448
                (string) $this->config->get('assets.images.resize.dir'),
1✔
449
                (string) $width,
1✔
450
                $assetResized->data['path']
1✔
451
            );
1✔
452
            $assetResized->data['height'] = $assetResized->getHeight();
1✔
453
            $assetResized->data['size'] = \strlen($assetResized->data['content']);
1✔
454

455
            $cache->set($cacheKey, $assetResized->data);
1✔
456
        }
457
        $assetResized->data = $cache->get($cacheKey);
1✔
458

459
        return $assetResized;
1✔
460
    }
461

462
    /**
463
     * Converts an image asset to $format format.
464
     *
465
     * @throws RuntimeException
466
     */
467
    public function convert(string $format, ?int $quality = null): self
468
    {
469
        if ($this->data['type'] != 'image') {
1✔
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
        if ($quality === null) {
1✔
474
            $quality = (int) $this->config->get('assets.images.quality');
1✔
475
        }
476

477
        $asset = clone $this;
1✔
478
        $asset['ext'] = $format;
1✔
479

480
        if ($this->isImageInCdn()) {
1✔
481
            return $asset; // returns the asset with the new extension only: CDN do the rest of the job
×
482
        }
483

484
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
485
        $tags = ["q$quality"];
1✔
486
        if ($this->data['width']) {
1✔
487
            array_unshift($tags, "{$this->data['width']}x");
1✔
488
        }
489
        $cacheKey = $cache->createKeyFromAsset($asset, $tags);
1✔
490
        if (!$cache->has($cacheKey)) {
1✔
491
            $asset->data['content'] = Image::convert($asset, $format, $quality);
1✔
492
            $asset->data['path'] = preg_replace('/\.' . $this->data['ext'] . '$/m', ".$format", $this->data['path']);
1✔
493
            $asset->data['subtype'] = "image/$format";
1✔
494
            $asset->data['size'] = \strlen($asset->data['content']);
1✔
495

496
            $cache->set($cacheKey, $asset->data);
1✔
497
        }
498
        $asset->data = $cache->get($cacheKey);
1✔
499

500
        return $asset;
1✔
501
    }
502

503
    /**
504
     * Converts an image asset to WebP format.
505
     *
506
     * @throws RuntimeException
507
     */
508
    public function webp(?int $quality = null): self
509
    {
510
        return $this->convert('webp', $quality);
1✔
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);
1✔
521
    }
522

523
    /**
524
     * Implements \ArrayAccess.
525
     */
526
    #[\ReturnTypeWillChange]
527
    public function offsetSet($offset, $value): void
528
    {
529
        if (!\is_null($offset)) {
1✔
530
            $this->data[$offset] = $value;
1✔
531
        }
532
    }
533

534
    /**
535
     * Implements \ArrayAccess.
536
     */
537
    #[\ReturnTypeWillChange]
538
    public function offsetExists($offset): bool
539
    {
540
        return isset($this->data[$offset]);
1✔
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
    public function offsetGet($offset)
557
    {
558
        return isset($this->data[$offset]) ? $this->data[$offset] : null;
1✔
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
    public function getIntegrity(string $algo = 'sha384'): string
568
    {
569
        return \sprintf('%s-%s', $algo, base64_encode(hash($algo, $this->data['content'], true)));
1✔
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') {
1✔
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']);
1✔
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
    public function dataurl(): string
606
    {
607
        if ($this->data['type'] == 'image' && !Image::isSVG($this)) {
1✔
608
            return Image::getDataUrl($this, $this->config->get('assets.images.quality'));
1✔
609
        }
610

611
        return \sprintf('data:%s;base64,%s', $this->data['subtype'], base64_encode($this->data['content']));
1✔
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
    public function save(): void
621
    {
622
        $filepath = Util::joinFile($this->config->getOutputPath(), $this->data['path']);
1✔
623
        if (!$this->builder->getBuildOptions()['dry-run'] && !Util\File::getFS()->exists($filepath)) {
1✔
624
            try {
625
                Util\File::getFS()->dumpFile($filepath, $this->data['content']);
1✔
626
                $this->builder->getLogger()->debug(\sprintf('Asset "%s" saved', $filepath));
1✔
627
                if ($this->optimize) {
1✔
628
                    $this->optimize($filepath);
1✔
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
    public function isImageInCdn()
644
    {
645
        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)) {
1✔
646
            return false;
1✔
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
    private function loadFile(string $path, bool $ignore_missing = false, ?string $remote_fallback = null, bool $force_slash = true): array
662
    {
663
        $file = [
1✔
664
            'url' => null,
1✔
665
        ];
1✔
666

667
        try {
668
            $filePath = $this->findFile($path, $remote_fallback);
1✔
669
        } catch (RuntimeException $e) {
1✔
670
            if ($ignore_missing) {
1✔
671
                $file['path'] = $path;
1✔
672
                $file['missing'] = true;
1✔
673

674
                return $file;
1✔
675
            }
676

677
            throw new RuntimeException(\sprintf('Can\'t load asset file "%s" (%s).', $path, $e->getMessage()));
×
678
        }
679

680
        if (Util\Url::isUrl($path)) {
1✔
681
            $file['url'] = $path;
1✔
682
            $path = Util::joinPath(
1✔
683
                (string) $this->config->get('assets.target'),
1✔
684
                Util\File::getFS()->makePathRelative($filePath, $this->config->getCacheAssetsRemotePath())
1✔
685
            );
1✔
686
            // remote_fallback in assets/ ont in cache/assets/remote/
687
            if (substr(Util\File::getFS()->makePathRelative($filePath, $this->config->getCacheAssetsRemotePath()), 0, 2) == '..') {
1✔
688
                $path = Util::joinPath(
×
689
                    (string) $this->config->get('assets.target'),
×
690
                    Util\File::getFS()->makePathRelative($filePath, $this->config->getAssetsPath())
×
691
                );
×
692
            }
693
            $force_slash = true;
1✔
694
        }
695
        if ($force_slash) {
1✔
696
            $path = '/' . ltrim($path, '/');
1✔
697
        }
698

699
        list($type, $subtype) = Util\File::getMimeType($filePath);
1✔
700
        $content = Util\File::fileGetContents($filePath);
1✔
701

702
        $file['filepath'] = $filePath;
1✔
703
        $file['path'] = $path;
1✔
704
        $file['ext'] = pathinfo($path)['extension'] ?? '';
1✔
705
        $file['type'] = $type;
1✔
706
        $file['subtype'] = $subtype;
1✔
707
        $file['size'] = filesize($filePath);
1✔
708
        $file['content'] = $content;
1✔
709
        $file['missing'] = false;
1✔
710

711
        return $file;
1✔
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
    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
        if (Util\Url::isUrl($path)) {
1✔
727
            $url = $path;
1✔
728
            $urlHost = parse_url($path, PHP_URL_HOST);
1✔
729
            $urlPath = parse_url($path, PHP_URL_PATH);
1✔
730
            $urlQuery = parse_url($path, PHP_URL_QUERY);
1✔
731
            $extension = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION);
1✔
732
            // Google Fonts hack
733
            if (Util\Str::endsWith($urlPath, '/css') || Util\Str::endsWith($urlPath, '/css2')) {
1✔
734
                $extension = 'css';
1✔
735
            }
736
            $relativePath = Page::slugify(\sprintf(
1✔
737
                '%s%s%s%s',
1✔
738
                $urlHost,
1✔
739
                $this->sanitize($urlPath),
1✔
740
                $urlQuery ? "-$urlQuery" : '',
1✔
741
                $urlQuery && $extension ? ".$extension" : ''
1✔
742
            ));
1✔
743
            $filePath = Util::joinFile($this->config->getCacheAssetsRemotePath(), $relativePath);
1✔
744
            // not already in cache
745
            if (!file_exists($filePath)) {
1✔
746
                try {
747
                    if (!Util\Url::isRemoteFileExists($url)) {
1✔
748
                        throw new RuntimeException(\sprintf('File "%s" doesn\'t exists', $url));
×
749
                    }
750
                    if (false === $content = Util\File::fileGetContents($url, true)) {
1✔
751
                        throw new RuntimeException(\sprintf('Can\'t get content of file "%s".', $url));
×
752
                    }
753
                    if (\strlen($content) <= 1) {
1✔
754
                        throw new RuntimeException(\sprintf('File "%s" is empty.', $url));
1✔
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
                if (false === $content = Util\File::fileGetContents($url, true)) {
1✔
769
                    throw new RuntimeException(\sprintf('Can\'t get content of "%s"', $url));
×
770
                }
771
                if (\strlen($content) <= 1) {
1✔
772
                    throw new RuntimeException(\sprintf('Asset at "%s" is empty', $url));
×
773
                }
774
                // put file in cache
775
                Util\File::getFS()->dumpFile($filePath, $content);
1✔
776
            }
777

778
            return $filePath;
1✔
779
        }
780

781
        // checks in assets/
782
        $filePath = Util::joinFile($this->config->getAssetsPath(), $path);
1✔
783
        if (Util\File::getFS()->exists($filePath)) {
1✔
784
            return $filePath;
1✔
785
        }
786

787
        // checks in each themes/<theme>/assets/
788
        foreach ($this->config->getTheme() as $theme) {
1✔
789
            $filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'assets'), $path);
1✔
790
            if (Util\File::getFS()->exists($filePath)) {
1✔
791
                return $filePath;
1✔
792
            }
793
        }
794

795
        // checks in static/
796
        $filePath = Util::joinFile($this->config->getStaticTargetPath(), $path);
1✔
797
        if (Util\File::getFS()->exists($filePath)) {
1✔
798
            return $filePath;
1✔
799
        }
800

801
        // checks in each themes/<theme>/static/
802
        foreach ($this->config->getTheme() as $theme) {
1✔
803
            $filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'static'), $path);
1✔
804
            if (Util\File::getFS()->exists($filePath)) {
1✔
805
                return $filePath;
1✔
806
            }
807
        }
808

809
        throw new RuntimeException(\sprintf('Can\'t find file "%s".', $path));
1✔
810
    }
811

812
    /**
813
     * Returns the width of an image/SVG.
814
     *
815
     * @throws RuntimeException
816
     */
817
    private function getWidth(): int
818
    {
819
        if ($this->data['type'] != 'image') {
1✔
820
            return 0;
×
821
        }
822
        if (Image::isSVG($this) && false !== $svg = Image::getSvgAttributes($this)) {
1✔
823
            return (int) $svg->width;
1✔
824
        }
825
        if (false === $size = $this->getImageSize()) {
1✔
826
            throw new RuntimeException(\sprintf('Not able to get width of "%s".', $this->data['path']));
×
827
        }
828

829
        return $size[0];
1✔
830
    }
831

832
    /**
833
     * Returns the height of an image/SVG.
834
     *
835
     * @throws RuntimeException
836
     */
837
    private function getHeight(): int
838
    {
839
        if ($this->data['type'] != 'image') {
1✔
840
            return 0;
×
841
        }
842
        if (Image::isSVG($this) && false !== $svg = Image::getSvgAttributes($this)) {
1✔
843
            return (int) $svg->height;
1✔
844
        }
845
        if (false === $size = $this->getImageSize()) {
1✔
846
            throw new RuntimeException(\sprintf('Not able to get height of "%s".', $this->data['path']));
×
847
        }
848

849
        return $size[1];
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
    private function getImageSize()
860
    {
861
        if (!$this->data['type'] == 'image') {
1✔
862
            return false;
×
863
        }
864

865
        try {
866
            if (false === $size = getimagesizefromstring($this->data['content'])) {
1✔
867
                return false;
1✔
868
            }
869
        } catch (\Exception $e) {
×
870
            throw new RuntimeException(\sprintf('Handling asset "%s" failed: "%s"', $this->data['path_source'], $e->getMessage()));
×
871
        }
872

873
        return $size;
1✔
874
    }
875

876
    /**
877
     * Replaces some characters by '_'.
878
     */
879
    private function sanitize(string $string): string
880
    {
881
        return str_replace(['<', '>', ':', '"', '\\', '|', '?', '*'], '_', $string);
1✔
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'),
×
NEW
899
                ltrim($this->data['url'] ?? (string) new Url($this->builder, $this->data['path'], ['canonical' => $this->config->get('assets.images.cdn.canonical')]), '/'),
×
900
                $this->data['width'],
×
NEW
901
                $this->config->get('assets.images.quality'),
×
902
                $this->data['ext'],
×
903
            ],
×
904
            (string) $this->config->get('assets.images.cdn.url')
×
905
        );
×
906
    }
907
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc