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

Cecilapp / Cecil / 5046064611

pending completion
5046064611

push

github

GitHub
perf: native_function_invocation (#1697)

322 of 322 new or added lines in 62 files covered. (100.0%)

2784 of 4121 relevant lines covered (67.56%)

0.68 hits per line

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

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

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

110
        // fill data array with file(s) informations
111
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
112
        $cacheKey = sprintf('%s__%s', implode('_', $paths), $this->builder->getVersion());
1✔
113
        if (!$cache->has($cacheKey)) {
1✔
114
            $pathsCount = \count($paths);
1✔
115
            $file = [];
1✔
116
            for ($i = 0; $i < $pathsCount; $i++) {
1✔
117
                // loads file(s)
118
                $file[$i] = $this->loadFile($paths[$i], $ignore_missing, $remote_fallback, $force_slash);
1✔
119
                // bundle: same type/ext only
120
                if ($i > 0) {
1✔
121
                    if ($file[$i]['type'] != $file[$i - 1]['type']) {
1✔
122
                        throw new RuntimeException(sprintf('Asset bundle type error (%s != %s).', $file[$i]['type'], $file[$i - 1]['type']));
×
123
                    }
124
                    if ($file[$i]['ext'] != $file[$i - 1]['ext']) {
1✔
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
                if ($file[$i]['missing']) {
1✔
130
                    $this->data['missing'] = true;
1✔
131
                    $this->data['path'] = $file[$i]['path'];
1✔
132

133
                    continue;
1✔
134
                }
135
                // set data
136
                $this->data['size'] += $file[$i]['size'];
1✔
137
                $this->data['content_source'] .= $file[$i]['content'];
1✔
138
                $this->data['content'] .= $file[$i]['content'];
1✔
139
                if ($i == 0) {
1✔
140
                    $this->data['file'] = $file[$i]['filepath'];
1✔
141
                    $this->data['filename'] = $file[$i]['path'];
1✔
142
                    $this->data['path_source'] = $file[$i]['path'];
1✔
143
                    $this->data['path'] = $file[$i]['path'];
1✔
144
                    if (!empty($filename)) { /** @phpstan-ignore-line */
1✔
145
                        $this->data['path'] = '/' . ltrim($filename, '/');
1✔
146
                    }
147
                    $this->data['url'] = $file[$i]['url'];
1✔
148
                    $this->data['ext'] = $file[$i]['ext'];
1✔
149
                    $this->data['type'] = $file[$i]['type'];
1✔
150
                    $this->data['subtype'] = $file[$i]['subtype'];
1✔
151
                    if ($this->data['type'] == 'image') {
1✔
152
                        $this->data['width'] = $this->getWidth();
1✔
153
                        $this->data['height'] = $this->getHeight();
1✔
154
                        if ($this->data['subtype'] == 'jpeg') {
1✔
155
                            $this->data['exif'] = Util\File::readExif($file[$i]['filepath']);
×
156
                        }
157
                    }
158
                }
159
                // bundle files path
160
                $this->data['files'][] = $file[$i]['filepath'];
1✔
161
            }
162
            // bundle: define path
163
            if ($pathsCount > 1 && empty($filename)) { /** @phpstan-ignore-line */
1✔
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
            $cache->set($cacheKey, $this->data);
1✔
177
        }
178
        $this->data = $cache->get($cacheKey);
1✔
179

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

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

211
        if ($this->isImageInCdn()) {
1✔
212
            return $this->buildImageCdnUrl();
×
213
        }
214

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

219
        return $this->data['path'];
1✔
220
    }
221

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

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

238
        $this->fingerprinted = true;
1✔
239

240
        return $this;
1✔
241
    }
242

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

254
        if ($this->data['ext'] != 'scss') {
1✔
255
            return $this;
1✔
256
        }
257

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

320
        return $this;
1✔
321
    }
322

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

335
        if ($this->minified) {
1✔
336
            return $this;
1✔
337
        }
338

339
        if ($this->data['ext'] == 'scss') {
1✔
340
            $this->compile();
×
341
        }
342

343
        if ($this->data['ext'] != 'css' && $this->data['ext'] != 'js') {
1✔
344
            return $this;
1✔
345
        }
346

347
        if (substr($this->data['path'], -8) == '.min.css' || substr($this->data['path'], -7) == '.min.js') {
1✔
348
            $this->minified;
1✔
349

350
            return $this;
1✔
351
        }
352

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

378
        return $this;
1✔
379
    }
380

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

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

418
        return $this;
1✔
419
    }
420

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

438
        $assetResized = clone $this;
1✔
439
        $assetResized->data['width'] = $width;
1✔
440

441
        if ($this->isImageInCdn()) {
1✔
442
            return $assetResized; // returns the asset with the new width only: CDN do the rest of the job
×
443
        }
444

445
        $quality = $this->config->get('assets.images.quality');
1✔
446
        $cache = new Cache($this->builder, (string) $this->builder->getConfig()->get('cache.assets.dir'));
1✔
447
        $cacheKey = $cache->createKeyFromAsset($assetResized, ["{$width}x", "q$quality"]);
1✔
448
        if (!$cache->has($cacheKey)) {
1✔
449
            if ($assetResized->data['type'] !== 'image') {
1✔
450
                throw new RuntimeException(sprintf('Not able to resize "%s"', $assetResized->data['path']));
×
451
            }
452
            if (!\extension_loaded('gd')) {
1✔
453
                throw new RuntimeException('GD extension is required to use images resize.');
×
454
            }
455

456
            try {
457
                $img = ImageManager::make($assetResized->data['content_source'])->encode($assetResized->data['ext']);
1✔
458
                $img->resize($width, null, function (\Intervention\Image\Constraint $constraint) {
1✔
459
                    $constraint->aspectRatio();
1✔
460
                    $constraint->upsize();
1✔
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
            $assetResized->data['path'] = '/' . Util::joinPath(
1✔
466
                (string) $this->config->get('assets.target'),
1✔
467
                (string) $this->config->get('assets.images.resize.dir'),
1✔
468
                (string) $width,
1✔
469
                $assetResized->data['path']
1✔
470
            );
1✔
471

472
            try {
473
                if ($assetResized->data['subtype'] == 'image/jpeg') {
1✔
474
                    $img->interlace();
×
475
                }
476
                $assetResized->data['content'] = (string) $img->encode($assetResized->data['ext'], $quality);
1✔
477
                $img->destroy();
1✔
478
                $assetResized->data['height'] = $assetResized->getHeight();
1✔
479
                $assetResized->data['size'] = \strlen($assetResized->data['content']);
1✔
480
            } catch (\Exception $e) {
×
481
                throw new RuntimeException(sprintf('Not able to encode image "%s": %s', $assetResized->data['path'], $e->getMessage()));
×
482
            }
483

484
            $cache->set($cacheKey, $assetResized->data);
1✔
485
        }
486
        $assetResized->data = $cache->get($cacheKey);
1✔
487

488
        return $assetResized;
1✔
489
    }
490

491
    /**
492
     * Converts an image asset to WebP format.
493
     *
494
     * @throws RuntimeException
495
     */
496
    public function webp(?int $quality = null): self
497
    {
498
        if ($this->data['type'] !== 'image') {
1✔
499
            throw new RuntimeException(sprintf('can\'t convert "%s" (%s) to WebP: it\'s not an image file.', $this->data['path'], $this->data['type']));
×
500
        }
501

502
        if ($quality === null) {
1✔
503
            $quality = (int) $this->config->get('assets.images.quality') ?? 75;
1✔
504
        }
505

506
        $assetWebp = clone $this;
1✔
507
        $format = 'webp';
1✔
508
        $assetWebp['ext'] = $format;
1✔
509

510
        if ($this->isImageInCdn()) {
1✔
511
            return $assetWebp; // returns the asset with the new extension ('webp') only: CDN do the rest of the job
×
512
        }
513

514
        $img = ImageManager::make($assetWebp['content']);
1✔
515
        $assetWebp['content'] = (string) $img->encode($format, $quality);
1✔
516
        $img->destroy();
1✔
517
        $assetWebp['path'] = preg_replace('/\.' . $this->data['ext'] . '$/m', ".$format", $this->data['path']);
1✔
518
        $assetWebp['subtype'] = "image/$format";
1✔
519
        $assetWebp['size'] = \strlen($assetWebp['content']);
1✔
520

521
        return $assetWebp;
1✔
522
    }
523

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

535
    /**
536
     * Implements \ArrayAccess.
537
     */
538
    #[\ReturnTypeWillChange]
539
    public function offsetExists($offset): bool
540
    {
541
        return isset($this->data[$offset]);
1✔
542
    }
543

544
    /**
545
     * Implements \ArrayAccess.
546
     */
547
    #[\ReturnTypeWillChange]
548
    public function offsetUnset($offset): void
549
    {
550
        unset($this->data[$offset]);
×
551
    }
552

553
    /**
554
     * Implements \ArrayAccess.
555
     */
556
    #[\ReturnTypeWillChange]
557
    public function offsetGet($offset)
558
    {
559
        return isset($this->data[$offset]) ? $this->data[$offset] : null;
1✔
560
    }
561

562
    /**
563
     * Hashing content of an asset with the specified algo, sha384 by default.
564
     * Used for SRI (Subresource Integrity).
565
     *
566
     * @see https://developer.mozilla.org/fr/docs/Web/Security/Subresource_Integrity
567
     */
568
    public function getIntegrity(string $algo = 'sha384'): string
569
    {
570
        return sprintf('%s-%s', $algo, base64_encode(hash($algo, $this->data['content'], true)));
1✔
571
    }
572

573
    /**
574
     * Returns MP3 file infos.
575
     *
576
     * @see https://github.com/wapmorgan/Mp3Info
577
     */
578
    public function getAudio(): Mp3Info
579
    {
580
        if ($this->data['type'] !== 'audio') {
×
581
            throw new RuntimeException(sprintf('Not able to get audio infos of "%s"', $this->data['path']));
×
582
        }
583

584
        return new Mp3Info($this->data['file']);
×
585
    }
586

587
    /**
588
     * Returns the data URL (encoded in Base64).
589
     *
590
     * @throws RuntimeException
591
     */
592
    public function dataurl(): string
593
    {
594
        if ($this->data['type'] == 'image' && !$this->isSVG()) {
1✔
595
            return (string) ImageManager::make($this->data['content'])->encode('data-url', $this->config->get('assets.images.quality'));
1✔
596
        }
597

598
        return sprintf("data:%s;base64,%s", $this->data['subtype'], base64_encode($this->data['content']));
1✔
599
    }
600

601
    /**
602
     * Saves file.
603
     * Note: a file from `static/` with the same name will NOT be overridden.
604
     *
605
     * @throws RuntimeException
606
     */
607
    public function save(): void
608
    {
609
        $filepath = Util::joinFile($this->config->getOutputPath(), $this->data['path']);
1✔
610
        if (!$this->builder->getBuildOptions()['dry-run'] && !Util\File::getFS()->exists($filepath)) {
1✔
611
            try {
612
                Util\File::getFS()->dumpFile($filepath, $this->data['content']);
1✔
613
                $this->builder->getLogger()->debug(sprintf('Asset "%s" saved', $filepath));
1✔
614
                if ($this->optimize) {
1✔
615
                    $this->optimize($filepath);
1✔
616
                }
617
            } catch (\Symfony\Component\Filesystem\Exception\IOException $e) {
×
618
                if (!$this->ignore_missing) {
×
619
                    throw new RuntimeException(sprintf('Can\'t save asset "%s"', $filepath));
×
620
                }
621
            }
622
        }
623
    }
624

625
    /**
626
     * Is Asset is an image in CDN.
627
     *
628
     * @return boolean
629
     */
630
    public function isImageInCdn()
631
    {
632
        if ($this->data['type'] != 'image' || $this->isSVG() || (bool) $this->config->get('assets.images.cdn.enabled') !== true) {
1✔
633
            return false;
1✔
634
        }
635
        // remote image?
636
        if ($this->data['url'] !== null && (bool) $this->config->get('assets.images.cdn.remote') !== true) {
×
637
            return false;
×
638
        }
639

640
        return true;
×
641
    }
642

643
    /**
644
     * Load file data.
645
     *
646
     * @throws RuntimeException
647
     */
648
    private function loadFile(string $path, bool $ignore_missing = false, ?string $remote_fallback = null, bool $force_slash = true): array
649
    {
650
        $file = [
1✔
651
            'url' => null,
1✔
652
        ];
1✔
653

654
        if (false === $filePath = $this->findFile($path, $remote_fallback)) {
1✔
655
            if ($ignore_missing) {
1✔
656
                $file['path'] = $path;
1✔
657
                $file['missing'] = true;
1✔
658

659
                return $file;
1✔
660
            }
661

662
            throw new RuntimeException(sprintf('Asset file "%s" doesn\'t exist', $path));
×
663
        }
664

665
        if (Util\Url::isUrl($path)) {
1✔
666
            $file['url'] = $path;
1✔
667
            $path = Util\File::getFS()->makePathRelative($filePath, $this->config->getCacheAssetsRemotePath());
1✔
668
            $path = Util::joinPath((string) $this->config->get('assets.target'), $path);
1✔
669
            $force_slash = true;
1✔
670
        }
671
        if ($force_slash) {
1✔
672
            $path = '/' . ltrim($path, '/');
1✔
673
        }
674

675
        list($type, $subtype) = Util\File::getMimeType($filePath);
1✔
676
        $content = Util\File::fileGetContents($filePath);
1✔
677

678
        $file['filepath'] = $filePath;
1✔
679
        $file['path'] = $path;
1✔
680
        $file['ext'] = pathinfo($path)['extension'] ?? '';
1✔
681
        $file['type'] = $type;
1✔
682
        $file['subtype'] = $subtype;
1✔
683
        $file['size'] = filesize($filePath);
1✔
684
        $file['content'] = $content;
1✔
685
        $file['missing'] = false;
1✔
686

687
        return $file;
1✔
688
    }
689

690
    /**
691
     * Try to find the file:
692
     *   1. remote (if $path is a valid URL)
693
     *   2. in static/
694
     *   3. in themes/<theme>/static/
695
     * Returns local file path or false if file don't exists.
696
     *
697
     * @throws RuntimeException
698
     *
699
     * @return string|false
700
     */
701
    private function findFile(string $path, ?string $remote_fallback = null)
702
    {
703
        // in case of remote file: save it and returns cached file path
704
        if (Util\Url::isUrl($path)) {
1✔
705
            $url = $path;
1✔
706
            $urlHost = parse_url($path, PHP_URL_HOST);
1✔
707
            $urlPath = parse_url($path, PHP_URL_PATH);
1✔
708
            $urlQuery = parse_url($path, PHP_URL_QUERY);
1✔
709
            $extension = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION);
1✔
710
            // Google Fonts hack
711
            if (strpos($urlPath, '/css') !== false) {
1✔
712
                $extension = 'css';
1✔
713
            }
714
            $relativePath = Page::slugify(sprintf(
1✔
715
                '%s%s%s%s',
1✔
716
                $urlHost,
1✔
717
                $this->sanitize($urlPath),
1✔
718
                $urlQuery ? "-$urlQuery" : '',
1✔
719
                $urlQuery && $extension ? ".$extension" : ''
1✔
720
            ));
1✔
721
            $filePath = Util::joinFile($this->config->getCacheAssetsRemotePath(), $relativePath);
1✔
722
            if (!file_exists($filePath)) {
1✔
723
                if (!Util\Url::isRemoteFileExists($url)) {
1✔
724
                    // is there a fallback in assets/
725
                    if ($remote_fallback) {
×
726
                        $filePath = Util::joinFile($this->config->getAssetsPath(), $remote_fallback);
×
727
                        if (Util\File::getFS()->exists($filePath)) {
×
728
                            return $filePath;
×
729
                        }
730
                    }
731

732
                    return false;
×
733
                }
734
                if (false === $content = Util\File::fileGetContents($url, true)) {
1✔
735
                    return false;
×
736
                }
737
                if (\strlen($content) <= 1) {
1✔
738
                    throw new RuntimeException(sprintf('Asset at "%s" is empty', $url));
×
739
                }
740
                Util\File::getFS()->dumpFile($filePath, $content);
1✔
741
            }
742

743
            return $filePath;
1✔
744
        }
745

746
        // checks in assets/
747
        $filePath = Util::joinFile($this->config->getAssetsPath(), $path);
1✔
748
        if (Util\File::getFS()->exists($filePath)) {
1✔
749
            return $filePath;
1✔
750
        }
751

752
        // checks in each themes/<theme>/assets/
753
        foreach ($this->config->getTheme() as $theme) {
1✔
754
            $filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'assets'), $path);
1✔
755
            if (Util\File::getFS()->exists($filePath)) {
1✔
756
                return $filePath;
×
757
            }
758
        }
759

760
        // checks in static/
761
        $filePath = Util::joinFile($this->config->getStaticTargetPath(), $path);
1✔
762
        if (Util\File::getFS()->exists($filePath)) {
1✔
763
            return $filePath;
1✔
764
        }
765

766
        // checks in each themes/<theme>/static/
767
        foreach ($this->config->getTheme() as $theme) {
1✔
768
            $filePath = Util::joinFile($this->config->getThemeDirPath($theme, 'static'), $path);
1✔
769
            if (Util\File::getFS()->exists($filePath)) {
1✔
770
                return $filePath;
1✔
771
            }
772
        }
773

774
        return false;
1✔
775
    }
776

777
    /**
778
     * Returns the width of an image/SVG.
779
     *
780
     * @throws RuntimeException
781
     */
782
    private function getWidth(): int
783
    {
784
        if ($this->data['type'] != 'image') {
1✔
785
            return 0;
×
786
        }
787
        if ($this->isSVG() && false !== $svg = $this->getSvgAttributes()) {
1✔
788
            return (int) $svg->width;
1✔
789
        }
790
        if (false === $size = $this->getImageSize()) {
1✔
791
            throw new RuntimeException(sprintf('Not able to get width of "%s"', $this->data['path']));
×
792
        }
793

794
        return $size[0];
1✔
795
    }
796

797
    /**
798
     * Returns the height of an image/SVG.
799
     *
800
     * @throws RuntimeException
801
     */
802
    private function getHeight(): int
803
    {
804
        if ($this->data['type'] != 'image') {
1✔
805
            return 0;
×
806
        }
807
        if ($this->isSVG() && false !== $svg = $this->getSvgAttributes()) {
1✔
808
            return (int) $svg->height;
1✔
809
        }
810
        if (false === $size = $this->getImageSize()) {
1✔
811
            throw new RuntimeException(sprintf('Not able to get height of "%s"', $this->data['path']));
×
812
        }
813

814
        return $size[1];
1✔
815
    }
816

817
    /**
818
     * Returns image size informations.
819
     *
820
     * @see https://www.php.net/manual/function.getimagesize.php
821
     *
822
     * @return array|false
823
     */
824
    private function getImageSize()
825
    {
826
        if (!$this->data['type'] == 'image') {
1✔
827
            return false;
×
828
        }
829

830
        try {
831
            if (false === $size = getimagesizefromstring($this->data['content'])) {
1✔
832
                return false;
1✔
833
            }
834
        } catch (\Exception $e) {
×
835
            throw new RuntimeException(sprintf('Handling asset "%s" failed: "%s"', $this->data['path_source'], $e->getMessage()));
×
836
        }
837

838
        return $size;
1✔
839
    }
840

841
    /**
842
     * Returns true if asset is a SVG.
843
     */
844
    private function isSVG(): bool
845
    {
846
        return \in_array($this->data['subtype'], ['image/svg', 'image/svg+xml']) || $this->data['ext'] == 'svg';
1✔
847
    }
848

849
    /**
850
     * Returns SVG attributes.
851
     *
852
     * @return \SimpleXMLElement|false
853
     */
854
    private function getSvgAttributes()
855
    {
856
        if (false === $xml = simplexml_load_string($this->data['content_source'])) {
1✔
857
            return false;
×
858
        }
859

860
        return $xml->attributes();
1✔
861
    }
862

863
    /**
864
     * Replaces some characters by '_'.
865
     */
866
    private function sanitize(string $string): string
867
    {
868
        return str_replace(['<', '>', ':', '"', '\\', '|', '?', '*'], '_', $string);
1✔
869
    }
870

871
    /**
872
     * Builds CDN image URL.
873
     */
874
    private function buildImageCdnUrl(): string
875
    {
876
        return str_replace(
×
877
            [
×
878
                '%account%',
×
879
                '%image_url%',
×
880
                '%width%',
×
881
                '%quality%',
×
882
                '%format%',
×
883
            ],
×
884
            [
×
885
                $this->config->get('assets.images.cdn.account'),
×
886
                ltrim($this->data['url'] ?? (string) new Url($this->builder, $this->data['path'], ['canonical' => $this->config->get('assets.images.cdn.canonical') ?? true]), '/'),
×
887
                $this->data['width'],
×
888
                $this->config->get('assets.images.quality') ?? 75,
×
889
                $this->data['ext'],
×
890
            ],
×
891
            (string) $this->config->get('assets.images.cdn.url')
×
892
        );
×
893
    }
894
}
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