Cecilapp /
Cecil
| Total Complexity | 149 |
| Total Lines | 1009 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like Asset often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Asset, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 38 | class Asset implements \ArrayAccess |
||
| 39 | { |
||
| 40 | public const IMAGE_THUMB = 'thumbnails'; |
||
| 41 | |||
| 42 | /** @var Builder */ |
||
| 43 | protected $builder; |
||
| 44 | |||
| 45 | /** @var Config */ |
||
| 46 | protected $config; |
||
| 47 | |||
| 48 | /** @var array */ |
||
| 49 | protected $data = []; |
||
| 50 | |||
| 51 | /** @var array Cache tags */ |
||
| 52 | protected $cacheTags = []; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Creates an Asset from a file path, an array of files path or an URL. |
||
| 56 | * Options: |
||
| 57 | * [ |
||
| 58 | * 'filename' => <string>, |
||
| 59 | * 'leading_slash' => <bool> |
||
| 60 | * 'ignore_missing' => <bool>, |
||
| 61 | * 'fingerprint' => <bool>, |
||
| 62 | * 'minify' => <bool>, |
||
| 63 | * 'optimize' => <bool>, |
||
| 64 | * 'fallback' => <string>, |
||
| 65 | * 'useragent' => <string>, |
||
| 66 | * ] |
||
| 67 | * |
||
| 68 | * @param Builder $builder |
||
| 69 | * @param string|array $paths |
||
| 70 | * @param array|null $options |
||
| 71 | * |
||
| 72 | * @throws RuntimeException |
||
| 73 | */ |
||
| 74 | public function __construct(Builder $builder, string|array $paths, array|null $options = null) |
||
| 244 | } |
||
| 245 | |||
| 246 | /** |
||
| 247 | * Returns path. |
||
| 248 | */ |
||
| 249 | public function __toString(): string |
||
| 250 | { |
||
| 251 | $this->save(); |
||
| 252 | |||
| 253 | if ($this->isImageInCdn()) { |
||
| 254 | return $this->buildImageCdnUrl(); |
||
| 255 | } |
||
| 256 | |||
| 257 | if ($this->builder->getConfig()->isEnabled('canonicalurl')) { |
||
| 258 | return (string) new Url($this->builder, $this->data['path'], ['canonical' => true]); |
||
| 259 | } |
||
| 260 | |||
| 261 | return $this->data['path']; |
||
| 262 | } |
||
| 263 | |||
| 264 | /** |
||
| 265 | * Compiles a SCSS + cache. |
||
| 266 | * |
||
| 267 | * @throws RuntimeException |
||
| 268 | */ |
||
| 269 | public function compile(): self |
||
| 270 | { |
||
| 271 | $this->cacheTags['compile'] = true; |
||
| 272 | $cache = new Cache($this->builder, 'assets'); |
||
| 273 | $cacheKey = $cache->createKeyFromAsset($this, $this->cacheTags); |
||
| 274 | if (!$cache->has($cacheKey)) { |
||
| 275 | $this->doCompile(); |
||
| 276 | $cache->set($cacheKey, $this->data, $this->config->get('cache.assets.ttl')); |
||
| 277 | } |
||
| 278 | $this->data = $cache->get($cacheKey); |
||
| 279 | |||
| 280 | return $this; |
||
| 281 | } |
||
| 282 | |||
| 283 | /** |
||
| 284 | * Minifying a CSS or a JS. |
||
| 285 | */ |
||
| 286 | public function minify(): self |
||
| 287 | { |
||
| 288 | $this->cacheTags['minify'] = true; |
||
| 289 | $cache = new Cache($this->builder, 'assets'); |
||
| 290 | $cacheKey = $cache->createKeyFromAsset($this, $this->cacheTags); |
||
| 291 | if (!$cache->has($cacheKey)) { |
||
| 292 | $this->doMinify(); |
||
| 293 | $cache->set($cacheKey, $this->data, $this->config->get('cache.assets.ttl')); |
||
| 294 | } |
||
| 295 | $this->data = $cache->get($cacheKey); |
||
| 296 | |||
| 297 | return $this; |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Add hash to the file name + cache. |
||
| 302 | */ |
||
| 303 | public function fingerprint(): self |
||
| 304 | { |
||
| 305 | $this->cacheTags['fingerprint'] = true; |
||
| 306 | $cache = new Cache($this->builder, 'assets'); |
||
| 307 | $cacheKey = $cache->createKeyFromAsset($this, $this->cacheTags); |
||
| 308 | if (!$cache->has($cacheKey)) { |
||
| 309 | $this->doFingerprint(); |
||
| 310 | $cache->set($cacheKey, $this->data, $this->config->get('cache.assets.ttl')); |
||
| 311 | } |
||
| 312 | $this->data = $cache->get($cacheKey); |
||
| 313 | |||
| 314 | return $this; |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Scales down an image to a new $width. |
||
| 319 | * |
||
| 320 | * @throws RuntimeException |
||
| 321 | */ |
||
| 322 | public function resize(int $width): self |
||
| 323 | { |
||
| 324 | $this->checkImage(); |
||
| 325 | |||
| 326 | // if the image is already smaller than the requested width, return it |
||
| 327 | if ($width >= $this->data['width']) { |
||
| 328 | return $this; |
||
| 329 | } |
||
| 330 | |||
| 331 | $assetResized = clone $this; |
||
| 332 | $assetResized->data['width'] = $width; |
||
| 333 | |||
| 334 | if ($this->isImageInCdn()) { |
||
| 335 | $assetResized->data['height'] = round($this->data['height'] / ($this->data['width'] / $width)); |
||
| 336 | |||
| 337 | return $assetResized; // returns asset with the new dimensions only: CDN do the rest of the job |
||
| 338 | } |
||
| 339 | |||
| 340 | $quality = (int) $this->config->get('assets.images.quality'); |
||
| 341 | |||
| 342 | $cache = new Cache($this->builder, 'assets'); |
||
| 343 | $assetResized->cacheTags['quality'] = $quality; |
||
| 344 | $assetResized->cacheTags['width'] = $width; |
||
| 345 | $cacheKey = $cache->createKeyFromAsset($assetResized, $assetResized->cacheTags); |
||
| 346 | if (!$cache->has($cacheKey)) { |
||
| 347 | $assetResized->data['content'] = Image::resize($assetResized, $width, $quality); |
||
| 348 | $assetResized->data['path'] = '/' . Util::joinPath( |
||
| 349 | (string) $this->config->get('assets.target'), |
||
| 350 | self::IMAGE_THUMB, |
||
| 351 | (string) $width, |
||
| 352 | $assetResized->data['path'] |
||
| 353 | ); |
||
| 354 | $assetResized->data['path'] = $this->deduplicateThumbPath($assetResized->data['path']); |
||
| 355 | $assetResized->data['height'] = $assetResized->getHeight(); |
||
| 356 | $assetResized->data['size'] = \strlen($assetResized->data['content']); |
||
| 357 | |||
| 358 | $cache->set($cacheKey, $assetResized->data, $this->config->get('cache.assets.ttl')); |
||
| 359 | $this->builder->getLogger()->debug(\sprintf('Asset resized: "%s" (%sx)', $assetResized->data['path'], $width)); |
||
| 360 | } |
||
| 361 | $assetResized->data = $cache->get($cacheKey); |
||
| 362 | |||
| 363 | return $assetResized; |
||
| 364 | } |
||
| 365 | |||
| 366 | /** |
||
| 367 | * Crops the image to the specified width and height, keeping the specified position. |
||
| 368 | * |
||
| 369 | * @throws RuntimeException |
||
| 370 | */ |
||
| 371 | public function cover(int $width, int $height): self |
||
| 372 | { |
||
| 373 | $this->checkImage(); |
||
| 374 | |||
| 375 | $assetResized = clone $this; |
||
| 376 | $assetResized->data['width'] = $width; |
||
| 377 | $assetResized->data['height'] = $height; |
||
| 378 | |||
| 379 | $quality = (int) $this->config->get('assets.images.quality'); |
||
| 380 | |||
| 381 | $cache = new Cache($this->builder, 'assets'); |
||
| 382 | $assetResized->cacheTags['quality'] = $quality; |
||
| 383 | $assetResized->cacheTags['width'] = $width; |
||
| 384 | $assetResized->cacheTags['height'] = $height; |
||
| 385 | $cacheKey = $cache->createKeyFromAsset($assetResized, $assetResized->cacheTags); |
||
| 386 | if (!$cache->has($cacheKey)) { |
||
| 387 | $assetResized->data['content'] = Image::cover($assetResized, $width, $height, $quality); |
||
| 388 | $assetResized->data['path'] = '/' . Util::joinPath( |
||
| 389 | (string) $this->config->get('assets.target'), |
||
| 390 | self::IMAGE_THUMB, |
||
| 391 | (string) $width . 'x' . (string) $height, |
||
| 392 | $assetResized->data['path'] |
||
| 393 | ); |
||
| 394 | $assetResized->data['path'] = $this->deduplicateThumbPath($assetResized->data['path']); |
||
| 395 | $assetResized->data['size'] = \strlen($assetResized->data['content']); |
||
| 396 | |||
| 397 | $cache->set($cacheKey, $assetResized->data, $this->config->get('cache.assets.ttl')); |
||
| 398 | $this->builder->getLogger()->debug(\sprintf('Asset resized: "%s" (%sx%s)', $assetResized->data['path'], $width, $height)); |
||
| 399 | } |
||
| 400 | $assetResized->data = $cache->get($cacheKey); |
||
| 401 | |||
| 402 | return $assetResized; |
||
| 403 | } |
||
| 404 | |||
| 405 | /** |
||
| 406 | * Creates a maskable image (with a padding = 20%). |
||
| 407 | * |
||
| 408 | * @throws RuntimeException |
||
| 409 | */ |
||
| 410 | public function maskable(?int $padding = null): self |
||
| 440 | } |
||
| 441 | |||
| 442 | /** |
||
| 443 | * Converts an image asset to $format format. |
||
| 444 | * |
||
| 445 | * @throws RuntimeException |
||
| 446 | */ |
||
| 447 | public function convert(string $format, ?int $quality = null): self |
||
| 448 | { |
||
| 449 | if ($this->data['type'] != 'image') { |
||
| 450 | throw new RuntimeException(\sprintf('Unable to convert "%s" (%s) to %s: not an image.', $this->data['path'], $this->data['type'], $format)); |
||
| 451 | } |
||
| 452 | |||
| 453 | if ($quality === null) { |
||
| 454 | $quality = (int) $this->config->get('assets.images.quality'); |
||
| 455 | } |
||
| 456 | |||
| 457 | $asset = clone $this; |
||
| 458 | $asset['ext'] = $format; |
||
| 459 | $asset->data['subtype'] = "image/$format"; |
||
| 460 | |||
| 461 | if ($this->isImageInCdn()) { |
||
| 462 | return $asset; // returns the asset with the new extension only: CDN do the rest of the job |
||
| 463 | } |
||
| 464 | |||
| 465 | $cache = new Cache($this->builder, 'assets'); |
||
| 466 | $this->cacheTags['quality'] = $quality; |
||
| 467 | if ($this->data['width']) { |
||
| 468 | $this->cacheTags['width'] = $this->data['width']; |
||
| 469 | } |
||
| 470 | $cacheKey = $cache->createKeyFromAsset($asset, $this->cacheTags); |
||
| 471 | if (!$cache->has($cacheKey)) { |
||
| 472 | $asset->data['content'] = Image::convert($asset, $format, $quality); |
||
| 473 | $asset->data['path'] = preg_replace('/\.' . $this->data['ext'] . '$/m', ".$format", $this->data['path']); |
||
| 474 | $asset->data['size'] = \strlen($asset->data['content']); |
||
| 475 | $cache->set($cacheKey, $asset->data, $this->config->get('cache.assets.ttl')); |
||
| 476 | $this->builder->getLogger()->debug(\sprintf('Asset converted: "%s" (%s -> %s)', $asset->data['path'], $this->data['ext'], $format)); |
||
| 477 | } |
||
| 478 | $asset->data = $cache->get($cacheKey); |
||
| 479 | |||
| 480 | return $asset; |
||
| 481 | } |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Converts an image asset to WebP format. |
||
| 485 | * |
||
| 486 | * @throws RuntimeException |
||
| 487 | */ |
||
| 488 | public function webp(?int $quality = null): self |
||
| 489 | { |
||
| 490 | return $this->convert('webp', $quality); |
||
| 491 | } |
||
| 492 | |||
| 493 | /** |
||
| 494 | * Converts an image asset to AVIF format. |
||
| 495 | * |
||
| 496 | * @throws RuntimeException |
||
| 497 | */ |
||
| 498 | public function avif(?int $quality = null): self |
||
| 501 | } |
||
| 502 | |||
| 503 | /** |
||
| 504 | * Implements \ArrayAccess. |
||
| 505 | */ |
||
| 506 | #[\ReturnTypeWillChange] |
||
| 507 | public function offsetSet($offset, $value): void |
||
| 508 | { |
||
| 509 | if (!\is_null($offset)) { |
||
| 510 | $this->data[$offset] = $value; |
||
| 511 | } |
||
| 512 | } |
||
| 513 | |||
| 514 | /** |
||
| 515 | * Implements \ArrayAccess. |
||
| 516 | */ |
||
| 517 | #[\ReturnTypeWillChange] |
||
| 518 | public function offsetExists($offset): bool |
||
| 519 | { |
||
| 520 | return isset($this->data[$offset]); |
||
| 521 | } |
||
| 522 | |||
| 523 | /** |
||
| 524 | * Implements \ArrayAccess. |
||
| 525 | */ |
||
| 526 | #[\ReturnTypeWillChange] |
||
| 530 | } |
||
| 531 | |||
| 532 | /** |
||
| 533 | * Implements \ArrayAccess. |
||
| 534 | */ |
||
| 535 | #[\ReturnTypeWillChange] |
||
| 536 | public function offsetGet($offset) |
||
| 537 | { |
||
| 538 | return isset($this->data[$offset]) ? $this->data[$offset] : null; |
||
| 539 | } |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Hashing content of an asset with the specified algo, sha384 by default. |
||
| 543 | * Used for SRI (Subresource Integrity). |
||
| 544 | * |
||
| 545 | * @see https://developer.mozilla.org/fr/docs/Web/Security/Subresource_Integrity |
||
| 546 | */ |
||
| 547 | public function getIntegrity(string $algo = 'sha384'): string |
||
| 548 | { |
||
| 549 | return \sprintf('%s-%s', $algo, base64_encode(hash($algo, $this->data['content'], true))); |
||
| 550 | } |
||
| 551 | |||
| 552 | /** |
||
| 553 | * Returns MP3 file infos. |
||
| 554 | * |
||
| 555 | * @see https://github.com/wapmorgan/Mp3Info |
||
| 556 | */ |
||
| 557 | public function getAudio(): Mp3Info |
||
| 564 | } |
||
| 565 | |||
| 566 | /** |
||
| 567 | * Returns MP4 file infos: |
||
| 568 | * - duration (in seconds) |
||
| 569 | * - width (in pixels) |
||
| 570 | * - height (in pixels) |
||
| 571 | */ |
||
| 572 | public function getVideo(): array |
||
| 573 | { |
||
| 574 | if ($this->data['type'] !== 'video') { |
||
| 575 | throw new RuntimeException(\sprintf('Unable to get video infos of "%s".', $this->data['path'])); |
||
| 576 | } |
||
| 577 | |||
| 578 | $videoInfos = (new \getID3())->analyze($this->data['file']); |
||
| 579 | |||
| 580 | return [ |
||
| 581 | 'duration' => $videoInfos['playtime_seconds'] ?? 0, |
||
| 582 | 'width' => $videoInfos['video']['resolution_x'] ?? 0, |
||
| 583 | 'height' => $videoInfos['video']['resolution_y'] ?? 0, |
||
| 584 | ]; |
||
| 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' && !Image::isSVG($this)) { |
||
| 595 | return Image::getDataUrl($this, (int) $this->config->get('assets.images.quality')); |
||
| 596 | } |
||
| 597 | |||
| 598 | return \sprintf('data:%s;base64,%s', $this->data['subtype'], base64_encode($this->data['content'])); |
||
| 599 | } |
||
| 600 | |||
| 601 | /** |
||
| 602 | * Adds asset path to the list of assets to save. |
||
| 603 | * |
||
| 604 | * @throws RuntimeException |
||
| 605 | */ |
||
| 606 | public function save(): void |
||
| 607 | { |
||
| 608 | if ($this->data['missing']) { |
||
| 609 | return; |
||
| 610 | } |
||
| 611 | |||
| 612 | $cache = new Cache($this->builder, 'assets'); |
||
| 613 | if (empty($this->data['path']) || !Util\File::getFS()->exists($cache->getContentFilePathname($this->data['path']))) { |
||
| 614 | throw new RuntimeException( |
||
| 615 | \sprintf('Unable to add "%s" to assets list. Please clear cache and retry.', $this->data['path']) |
||
| 616 | ); |
||
| 617 | } |
||
| 618 | |||
| 619 | $this->builder->addAsset($this->data['path']); |
||
| 620 | } |
||
| 621 | |||
| 622 | /** |
||
| 623 | * Is the asset an image and is it in CDN? |
||
| 624 | */ |
||
| 625 | public function isImageInCdn(): bool |
||
| 626 | { |
||
| 627 | if ( |
||
| 628 | $this->data['type'] == 'image' |
||
| 629 | && $this->config->isEnabled('assets.images.cdn') |
||
| 630 | && $this->data['ext'] != 'ico' |
||
| 631 | && (Image::isSVG($this) && $this->config->isEnabled('assets.images.cdn.svg')) |
||
| 632 | ) { |
||
| 633 | return true; |
||
| 634 | } |
||
| 635 | // handle remote image? |
||
| 636 | if ($this->data['url'] !== null && $this->config->isEnabled('assets.images.cdn.remote')) { |
||
| 637 | return true; |
||
| 638 | } |
||
| 639 | |||
| 640 | return false; |
||
| 641 | } |
||
| 642 | |||
| 643 | /** |
||
| 644 | * Builds a relative path from a URL. |
||
| 645 | * Used for remote files. |
||
| 646 | */ |
||
| 647 | public static function buildPathFromUrl(string $url): string |
||
| 648 | { |
||
| 649 | $host = parse_url($url, PHP_URL_HOST); |
||
| 650 | $path = parse_url($url, PHP_URL_PATH); |
||
| 651 | $query = parse_url($url, PHP_URL_QUERY); |
||
| 652 | $ext = pathinfo(parse_url($url, PHP_URL_PATH), \PATHINFO_EXTENSION); |
||
| 653 | |||
| 654 | // Google Fonts hack |
||
| 655 | if (Util\Str::endsWith($path, '/css') || Util\Str::endsWith($path, '/css2')) { |
||
| 656 | $ext = 'css'; |
||
| 657 | } |
||
| 658 | |||
| 659 | return Page::slugify(\sprintf('%s%s%s%s', $host, self::sanitize($path), $query ? "-$query" : '', $query && $ext ? ".$ext" : '')); |
||
| 660 | } |
||
| 661 | |||
| 662 | /** |
||
| 663 | * Replaces some characters by '_'. |
||
| 664 | */ |
||
| 665 | public static function sanitize(string $string): string |
||
| 666 | { |
||
| 667 | return str_replace(['<', '>', ':', '"', '\\', '|', '?', '*'], '_', $string); |
||
| 668 | } |
||
| 669 | |||
| 670 | /** |
||
| 671 | * Compiles a SCSS. |
||
| 672 | * |
||
| 673 | * @throws RuntimeException |
||
| 674 | */ |
||
| 675 | protected function doCompile(): self |
||
| 676 | { |
||
| 677 | // abort if not a SCSS file |
||
| 678 | if ($this->data['ext'] != 'scss') { |
||
| 679 | return $this; |
||
| 680 | } |
||
| 681 | $scssPhp = new Compiler(); |
||
| 682 | // import paths |
||
| 683 | $importDir = []; |
||
| 684 | $importDir[] = Util::joinPath($this->config->getStaticPath()); |
||
| 685 | $importDir[] = Util::joinPath($this->config->getAssetsPath()); |
||
| 686 | $scssDir = (array) $this->config->get('assets.compile.import'); |
||
| 687 | $themes = $this->config->getTheme() ?? []; |
||
| 688 | foreach ($scssDir as $dir) { |
||
| 689 | $importDir[] = Util::joinPath($this->config->getStaticPath(), $dir); |
||
| 690 | $importDir[] = Util::joinPath($this->config->getAssetsPath(), $dir); |
||
| 691 | $importDir[] = Util::joinPath(\dirname($this->data['file']), $dir); |
||
| 692 | foreach ($themes as $theme) { |
||
| 693 | $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "static/$dir")); |
||
| 694 | $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "assets/$dir")); |
||
| 695 | } |
||
| 696 | } |
||
| 697 | $scssPhp->setQuietDeps(true); |
||
| 698 | $scssPhp->setImportPaths(array_unique($importDir)); |
||
| 699 | // adds source map |
||
| 700 | if ($this->builder->isDebug() && $this->config->isEnabled('assets.compile.sourcemap')) { |
||
| 701 | $importDir = []; |
||
| 702 | $assetDir = (string) $this->config->get('assets.dir'); |
||
| 703 | $assetDirPos = strrpos($this->data['file'], DIRECTORY_SEPARATOR . $assetDir . DIRECTORY_SEPARATOR); |
||
| 704 | $fileRelPath = substr($this->data['file'], $assetDirPos + 8); |
||
| 705 | $filePath = Util::joinFile($this->config->getOutputPath(), $fileRelPath); |
||
| 706 | $importDir[] = \dirname($filePath); |
||
| 707 | foreach ($scssDir as $dir) { |
||
| 708 | $importDir[] = Util::joinFile($this->config->getOutputPath(), $dir); |
||
| 709 | } |
||
| 710 | $scssPhp->setImportPaths(array_unique($importDir)); |
||
| 711 | $scssPhp->setSourceMap(Compiler::SOURCE_MAP_INLINE); |
||
| 712 | $scssPhp->setSourceMapOptions([ |
||
| 713 | 'sourceMapBasepath' => Util::joinPath($this->config->getOutputPath()), |
||
| 714 | 'sourceRoot' => '/', |
||
| 715 | ]); |
||
| 716 | } |
||
| 717 | // defines output style |
||
| 718 | $outputStyles = ['expanded', 'compressed']; |
||
| 719 | $outputStyle = strtolower((string) $this->config->get('assets.compile.style')); |
||
| 720 | if (!\in_array($outputStyle, $outputStyles)) { |
||
| 721 | throw new ConfigException(\sprintf('"%s" value must be "%s".', 'assets.compile.style', implode('" or "', $outputStyles))); |
||
| 722 | } |
||
| 723 | $scssPhp->setOutputStyle($outputStyle == 'compressed' ? OutputStyle::COMPRESSED : OutputStyle::EXPANDED); |
||
| 724 | // set variables |
||
| 725 | $variables = $this->config->get('assets.compile.variables'); |
||
| 726 | if (!empty($variables)) { |
||
| 727 | $variables = array_map('ScssPhp\ScssPhp\ValueConverter::parseValue', $variables); |
||
| 728 | $scssPhp->replaceVariables($variables); |
||
| 729 | } |
||
| 730 | // debug |
||
| 731 | if ($this->builder->isDebug()) { |
||
| 732 | $scssPhp->setQuietDeps(false); |
||
| 733 | $this->builder->getLogger()->debug(\sprintf("SCSS compiler imported paths:\n%s", Util\Str::arrayToList(array_unique($importDir)))); |
||
| 734 | } |
||
| 735 | // update data |
||
| 736 | $this->data['path'] = preg_replace('/sass|scss/m', 'css', $this->data['path']); |
||
| 737 | $this->data['ext'] = 'css'; |
||
| 738 | $this->data['type'] = 'text'; |
||
| 739 | $this->data['subtype'] = 'text/css'; |
||
| 740 | $this->data['content'] = $scssPhp->compileString($this->data['content'])->getCss(); |
||
| 741 | $this->data['size'] = \strlen($this->data['content']); |
||
| 742 | |||
| 743 | $this->builder->getLogger()->debug(\sprintf('Asset compiled: "%s"', $this->data['path'])); |
||
| 744 | |||
| 745 | return $this; |
||
| 746 | } |
||
| 747 | |||
| 748 | /** |
||
| 749 | * Minifying a CSS or a JS + cache. |
||
| 750 | * |
||
| 751 | * @throws RuntimeException |
||
| 752 | */ |
||
| 753 | protected function doMinify(): self |
||
| 754 | { |
||
| 755 | // compile SCSS files |
||
| 756 | if ($this->data['ext'] == 'scss') { |
||
| 757 | $this->doCompile(); |
||
| 758 | } |
||
| 759 | // abort if already minified |
||
| 760 | if (substr($this->data['path'], -8) == '.min.css' || substr($this->data['path'], -7) == '.min.js') { |
||
| 761 | return $this; |
||
| 762 | } |
||
| 763 | // abord if not a CSS or JS file |
||
| 764 | if (!\in_array($this->data['ext'], ['css', 'js'])) { |
||
| 765 | return $this; |
||
| 766 | } |
||
| 767 | // in debug mode: disable minify to preserve inline source map |
||
| 768 | if ($this->builder->isDebug() && $this->config->isEnabled('assets.compile.sourcemap')) { |
||
| 769 | return $this; |
||
| 770 | } |
||
| 771 | switch ($this->data['ext']) { |
||
| 772 | case 'css': |
||
| 773 | $minifier = new Minify\CSS($this->data['content']); |
||
| 774 | break; |
||
| 775 | case 'js': |
||
| 776 | $minifier = new Minify\JS($this->data['content']); |
||
| 777 | break; |
||
| 778 | default: |
||
| 779 | throw new RuntimeException(\sprintf('Unable to minify "%s".', $this->data['path'])); |
||
| 780 | } |
||
| 781 | $this->data['content'] = $minifier->minify(); |
||
| 782 | $this->data['size'] = \strlen($this->data['content']); |
||
| 783 | |||
| 784 | $this->builder->getLogger()->debug(\sprintf('Asset minified: "%s"', $this->data['path'])); |
||
| 785 | |||
| 786 | return $this; |
||
| 787 | } |
||
| 788 | |||
| 789 | /** |
||
| 790 | * Add hash to the file name. |
||
| 791 | */ |
||
| 792 | protected function doFingerprint(): self |
||
| 793 | { |
||
| 794 | $hash = hash('md5', $this->data['content']); |
||
| 795 | $this->data['path'] = preg_replace( |
||
| 796 | '/\.' . $this->data['ext'] . '$/m', |
||
| 797 | ".$hash." . $this->data['ext'], |
||
| 798 | $this->data['path'] |
||
| 799 | ); |
||
| 800 | $this->builder->getLogger()->debug(\sprintf('Asset fingerprinted: "%s"', $this->data['path'])); |
||
| 801 | |||
| 802 | return $this; |
||
| 803 | } |
||
| 804 | |||
| 805 | /** |
||
| 806 | * Returns local file path and updated path, or throw an exception. |
||
| 807 | * If $fallback path is set, it will be used if the remote file is not found. |
||
| 808 | * |
||
| 809 | * Try to locate the file in: |
||
| 810 | * (1. remote file) |
||
| 811 | * 1. assets |
||
| 812 | * 2. themes/<theme>/assets |
||
| 813 | * 3. static |
||
| 814 | * 4. themes/<theme>/static |
||
| 815 | * |
||
| 816 | * @throws RuntimeException |
||
| 817 | */ |
||
| 818 | private function locateFile(string $path, ?string $fallback = null, ?string $userAgent = null): array |
||
| 819 | { |
||
| 820 | // remote file |
||
| 821 | if (Util\File::isRemote($path)) { |
||
| 822 | try { |
||
| 823 | $content = $this->getRemoteFileContent($path, $userAgent); |
||
| 824 | $path = self::buildPathFromUrl($path); |
||
| 825 | $cache = new Cache($this->builder, 'assets/remote'); |
||
| 826 | if (!$cache->has($path)) { |
||
| 827 | $cache->set($path, [ |
||
| 828 | 'content' => $content, |
||
| 829 | 'path' => $path, |
||
| 830 | ], $this->config->get('cache.assets.remote.ttl')); |
||
| 831 | } |
||
| 832 | return [ |
||
| 833 | 'file' => $cache->getContentFilePathname($path), |
||
| 834 | 'path' => $path, |
||
| 835 | ]; |
||
| 836 | } catch (RuntimeException $e) { |
||
| 837 | if (empty($fallback)) { |
||
| 838 | throw new RuntimeException($e->getMessage()); |
||
| 839 | } |
||
| 840 | $path = $fallback; |
||
| 841 | } |
||
| 842 | } |
||
| 843 | |||
| 844 | // checks in assets/ |
||
| 845 | $file = Util::joinFile($this->config->getAssetsPath(), $path); |
||
| 846 | if (Util\File::getFS()->exists($file)) { |
||
| 847 | return [ |
||
| 848 | 'file' => $file, |
||
| 849 | 'path' => $path, |
||
| 850 | ]; |
||
| 851 | } |
||
| 852 | |||
| 853 | // checks in each themes/<theme>/assets/ |
||
| 854 | foreach ($this->config->getTheme() ?? [] as $theme) { |
||
| 855 | $file = Util::joinFile($this->config->getThemeDirPath($theme, 'assets'), $path); |
||
| 856 | if (Util\File::getFS()->exists($file)) { |
||
| 857 | return [ |
||
| 858 | 'file' => $file, |
||
| 859 | 'path' => $path, |
||
| 860 | ]; |
||
| 861 | } |
||
| 862 | } |
||
| 863 | |||
| 864 | // checks in static/ |
||
| 865 | $file = Util::joinFile($this->config->getStaticPath(), $path); |
||
| 866 | if (Util\File::getFS()->exists($file)) { |
||
| 867 | return [ |
||
| 868 | 'file' => $file, |
||
| 869 | 'path' => $path, |
||
| 870 | ]; |
||
| 871 | } |
||
| 872 | |||
| 873 | // checks in each themes/<theme>/static/ |
||
| 874 | foreach ($this->config->getTheme() ?? [] as $theme) { |
||
| 875 | $file = Util::joinFile($this->config->getThemeDirPath($theme, 'static'), $path); |
||
| 876 | if (Util\File::getFS()->exists($file)) { |
||
| 877 | return [ |
||
| 878 | 'file' => $file, |
||
| 879 | 'path' => $path, |
||
| 880 | ]; |
||
| 881 | } |
||
| 882 | } |
||
| 883 | |||
| 884 | throw new RuntimeException(\sprintf('Unable to locate file "%s".', $path)); |
||
| 885 | } |
||
| 886 | |||
| 887 | /** |
||
| 888 | * Try to get remote file content. |
||
| 889 | * Returns file content or throw an exception. |
||
| 890 | * |
||
| 891 | * @throws RuntimeException |
||
| 892 | */ |
||
| 893 | private function getRemoteFileContent(string $path, ?string $userAgent = null): string |
||
| 894 | { |
||
| 895 | if (!Util\File::isRemoteExists($path)) { |
||
| 896 | throw new RuntimeException(\sprintf('Unable to get remote file "%s".', $path)); |
||
| 897 | } |
||
| 898 | if (false === $content = Util\File::fileGetContents($path, $userAgent)) { |
||
| 899 | throw new RuntimeException(\sprintf('Unable to get content of remote file "%s".', $path)); |
||
| 900 | } |
||
| 901 | if (\strlen($content) <= 1) { |
||
| 902 | throw new RuntimeException(\sprintf('Remote file "%s" is empty.', $path)); |
||
| 903 | } |
||
| 904 | |||
| 905 | return $content; |
||
| 906 | } |
||
| 907 | |||
| 908 | /** |
||
| 909 | * Optimizing $filepath image. |
||
| 910 | * Returns the new file size. |
||
| 911 | */ |
||
| 912 | private function optimize(string $filepath, string $path, int $quality): int |
||
| 913 | { |
||
| 914 | $message = \sprintf('Asset not optimized: "%s"', $path); |
||
| 915 | $sizeBefore = filesize($filepath); |
||
| 916 | Optimizer::create($quality)->optimize($filepath); |
||
| 917 | $sizeAfter = filesize($filepath); |
||
| 918 | if ($sizeAfter < $sizeBefore) { |
||
| 919 | $message = \sprintf( |
||
| 920 | 'Asset optimized: "%s" (%s Ko -> %s Ko)', |
||
| 921 | $path, |
||
| 922 | ceil($sizeBefore / 1000), |
||
| 923 | ceil($sizeAfter / 1000) |
||
| 924 | ); |
||
| 925 | } |
||
| 926 | $this->builder->getLogger()->debug($message); |
||
| 927 | |||
| 928 | return $sizeAfter; |
||
| 929 | } |
||
| 930 | |||
| 931 | /** |
||
| 932 | * Returns the width of an image/SVG. |
||
| 933 | * |
||
| 934 | * @throws RuntimeException |
||
| 935 | */ |
||
| 936 | private function getWidth(): int |
||
| 937 | { |
||
| 938 | if ($this->data['type'] != 'image') { |
||
| 939 | return 0; |
||
| 940 | } |
||
| 941 | if (Image::isSVG($this) && false !== $svg = Image::getSvgAttributes($this)) { |
||
| 942 | return (int) $svg->width; |
||
| 943 | } |
||
| 944 | if (false === $size = $this->getImageSize()) { |
||
| 945 | throw new RuntimeException(\sprintf('Unable to get width of "%s".', $this->data['path'])); |
||
| 946 | } |
||
| 947 | |||
| 948 | return $size[0]; |
||
| 949 | } |
||
| 950 | |||
| 951 | /** |
||
| 952 | * Returns the height of an image/SVG. |
||
| 953 | * |
||
| 954 | * @throws RuntimeException |
||
| 955 | */ |
||
| 956 | private function getHeight(): int |
||
| 969 | } |
||
| 970 | |||
| 971 | /** |
||
| 972 | * Returns image size informations. |
||
| 973 | * |
||
| 974 | * @see https://www.php.net/manual/function.getimagesize.php |
||
| 975 | * |
||
| 976 | * @return array|false |
||
| 977 | */ |
||
| 978 | private function getImageSize() |
||
| 993 | } |
||
| 994 | |||
| 995 | /** |
||
| 996 | * Builds CDN image URL. |
||
| 997 | */ |
||
| 998 | private function buildImageCdnUrl(): string |
||
| 1016 | ); |
||
| 1017 | } |
||
| 1018 | |||
| 1019 | /** |
||
| 1020 | * Checks if the asset is not missing and is typed as an image. |
||
| 1021 | * |
||
| 1022 | * @throws RuntimeException |
||
| 1023 | */ |
||
| 1024 | private function checkImage(): void |
||
| 1025 | { |
||
| 1026 | if ($this->data['missing']) { |
||
| 1027 | throw new RuntimeException(\sprintf('Unable to resize "%s": file not found.', $this->data['path'])); |
||
| 1028 | } |
||
| 1029 | if ($this->data['type'] != 'image') { |
||
| 1030 | throw new RuntimeException(\sprintf('Unable to resize "%s": not an image.', $this->data['path'])); |
||
| 1031 | } |
||
| 1032 | } |
||
| 1033 | |||
| 1034 | /** |
||
| 1035 | * Remove redondant '/thumbnails/<width(xheight)>/' in the path. |
||
| 1036 | */ |
||
| 1037 | private function deduplicateThumbPath(string $path): string |
||
| 1047 | } |
||
| 1048 | } |
||
| 1049 |
