Cecilapp /
Cecil
| Total Complexity | 148 |
| Total Lines | 998 |
| Duplicated Lines | 0 % |
| Changes | 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) |
||
| 75 | { |
||
| 76 | $this->builder = $builder; |
||
| 77 | $this->config = $builder->getConfig(); |
||
| 78 | $paths = \is_array($paths) ? $paths : [$paths]; |
||
| 79 | // checks path(s) |
||
| 80 | array_walk($paths, function ($path) { |
||
| 81 | // must be a string |
||
| 82 | if (!\is_string($path)) { |
||
| 83 | throw new RuntimeException(\sprintf('The path of an asset must be a string ("%s" given).', \gettype($path))); |
||
| 84 | } |
||
| 85 | // can't be empty |
||
| 86 | if (empty($path)) { |
||
| 87 | throw new RuntimeException('The path of an asset can\'t be empty.'); |
||
| 88 | } |
||
| 89 | // can't be relative |
||
| 90 | if (substr($path, 0, 2) == '..') { |
||
| 91 | 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)); |
||
| 92 | } |
||
| 93 | }); |
||
| 94 | $this->data = [ |
||
| 95 | 'file' => '', // absolute file path |
||
| 96 | 'files' => [], // array of absolute files path |
||
| 97 | 'missing' => false, // if file not found but missing allowed: 'missing' is true |
||
| 98 | '_path' => '', // original path |
||
| 99 | 'path' => '', // public path |
||
| 100 | 'url' => null, // URL if it's a remote file |
||
| 101 | 'ext' => '', // file extension |
||
| 102 | 'type' => '', // file type (e.g.: image, audio, video, etc.) |
||
| 103 | 'subtype' => '', // file media type (e.g.: image/png, audio/mp3, etc.) |
||
| 104 | 'size' => 0, // file size (in bytes) |
||
| 105 | 'width' => 0, // image width (in pixels) |
||
| 106 | 'height' => 0, // image height (in pixels) |
||
| 107 | 'exif' => [], // image exif data |
||
| 108 | 'content' => '', // file content |
||
| 109 | 'hash' => '', // file content hash (md5) |
||
| 110 | ]; |
||
| 111 | |||
| 112 | // handles options |
||
| 113 | $options = array_merge( |
||
| 114 | [ |
||
| 115 | 'filename' => '', |
||
| 116 | 'leading_slash' => true, |
||
| 117 | 'ignore_missing' => false, |
||
| 118 | 'fingerprint' => $this->config->isEnabled('assets.fingerprint'), |
||
| 119 | 'minify' => $this->config->isEnabled('assets.minify'), |
||
| 120 | 'optimize' => $this->config->isEnabled('assets.images.optimize'), |
||
| 121 | 'fallback' => '', |
||
| 122 | 'useragent' => (string) $this->config->get('assets.remote.useragent.default'), |
||
| 123 | ], |
||
| 124 | \is_array($options) ? $options : [] |
||
| 125 | ); |
||
| 126 | |||
| 127 | // cache |
||
| 128 | $cache = new Cache($this->builder, 'assets'); |
||
| 129 | $locateCacheKey = \sprintf('%s_locate__%s__%s', $options['filename'] ?: implode('_', $paths), $this->builder->getBuildId(), $this->builder->getVersion()); |
||
| 130 | |||
| 131 | // locate file(s) and get content |
||
| 132 | if (!$cache->has($locateCacheKey)) { |
||
| 133 | $pathsCount = \count($paths); |
||
| 134 | for ($i = 0; $i < $pathsCount; $i++) { |
||
| 135 | try { |
||
| 136 | $this->data['missing'] = false; |
||
| 137 | $locate = $this->locateFile($paths[$i], $options['fallback'], $options['useragent']); |
||
| 138 | $file = $locate['file']; |
||
| 139 | $path = $locate['path']; |
||
| 140 | $type = Util\File::getMediaType($file)[0]; |
||
| 141 | if ($i > 0) { // bundle |
||
| 142 | if ($type != $this->data['type']) { |
||
| 143 | throw new RuntimeException(\sprintf('Asset bundle type error (%s != %s).', $type, $this->data['type'])); |
||
| 144 | } |
||
| 145 | } |
||
| 146 | $this->data['file'] = $file; |
||
| 147 | $this->data['files'][] = $file; |
||
| 148 | $this->data['path'] = $path; |
||
| 149 | $this->data['url'] = Util\File::isRemote($paths[$i]) ? $paths[$i] : null; |
||
| 150 | $this->data['ext'] = Util\File::getExtension($file); |
||
| 151 | $this->data['type'] = $type; |
||
| 152 | $this->data['subtype'] = Util\File::getMediaType($file)[1]; |
||
| 153 | $this->data['size'] += filesize($file); |
||
| 154 | $this->data['content'] .= Util\File::fileGetContents($file); |
||
| 155 | $this->data['hash'] = hash('md5', $this->data['content']); |
||
| 156 | // bundle default filename |
||
| 157 | $filename = $options['filename']; |
||
| 158 | if ($pathsCount > 1 && empty($filename)) { |
||
| 159 | switch ($this->data['ext']) { |
||
| 160 | case 'scss': |
||
| 161 | case 'css': |
||
| 162 | $filename = 'styles.css'; |
||
| 163 | break; |
||
| 164 | case 'js': |
||
| 165 | $filename = 'scripts.js'; |
||
| 166 | break; |
||
| 167 | default: |
||
| 168 | throw new RuntimeException(\sprintf('Asset bundle supports %s files only.', '.scss, .css and .js')); |
||
| 169 | } |
||
| 170 | } |
||
| 171 | // apply bundle filename to path |
||
| 172 | if (!empty($filename)) { |
||
| 173 | $this->data['path'] = $filename; |
||
| 174 | } |
||
| 175 | // add leading slash |
||
| 176 | if ($options['leading_slash']) { |
||
| 177 | $this->data['path'] = '/' . ltrim($this->data['path'], '/'); |
||
| 178 | } |
||
| 179 | $this->data['_path'] = $this->data['path']; |
||
| 180 | } catch (RuntimeException $e) { |
||
| 181 | if ($options['ignore_missing']) { |
||
| 182 | $this->data['missing'] = true; |
||
| 183 | continue; |
||
| 184 | } |
||
| 185 | throw new RuntimeException( |
||
| 186 | \sprintf('Can\'t handle asset "%s".', $paths[$i]), |
||
| 187 | previous: $e |
||
| 188 | ); |
||
| 189 | } |
||
| 190 | } |
||
| 191 | $cache->set($locateCacheKey, $this->data); |
||
| 192 | } |
||
| 193 | $this->data = $cache->get($locateCacheKey); |
||
| 194 | |||
| 195 | // missing |
||
| 196 | if ($this->data['missing']) { |
||
| 197 | return; |
||
| 198 | } |
||
| 199 | |||
| 200 | // cache |
||
| 201 | $cache = new Cache($this->builder, 'assets'); |
||
| 202 | // create cache tags from options |
||
| 203 | $this->cacheTags = $options; |
||
| 204 | // remove unnecessary cache tags |
||
| 205 | unset($this->cacheTags['optimize'], $this->cacheTags['ignore_missing'], $this->cacheTags['fallback'], $this->cacheTags['useragent']); |
||
| 206 | if (!\in_array($this->data['ext'], ['css', 'js', 'scss'])) { |
||
| 207 | unset($this->cacheTags['minify']); |
||
| 208 | } |
||
| 209 | // optimize image? |
||
| 210 | $optimize = false; |
||
| 211 | if ($options['optimize'] && $this->data['type'] == 'image' && !$this->isImageInCdn()) { |
||
| 212 | $optimize = true; |
||
| 213 | $quality = (int) $this->config->get('assets.images.quality'); |
||
| 214 | $this->cacheTags['quality'] = $quality; |
||
| 215 | } |
||
| 216 | $cacheKey = $cache->createKeyFromAsset($this, $this->cacheTags); |
||
| 217 | if (!$cache->has($cacheKey)) { |
||
| 218 | // fingerprinting |
||
| 219 | if ($options['fingerprint']) { |
||
| 220 | $this->doFingerprint(); |
||
| 221 | } |
||
| 222 | // compiling Sass files |
||
| 223 | $this->doCompile(); |
||
| 224 | // minifying (CSS and JavaScript files) |
||
| 225 | if ($options['minify']) { |
||
| 226 | $this->doMinify(); |
||
| 227 | } |
||
| 228 | // get image width, height and exif |
||
| 229 | if ($this->data['type'] == 'image') { |
||
| 230 | $this->data['width'] = $this->getWidth(); |
||
| 231 | $this->data['height'] = $this->getHeight(); |
||
| 232 | if ($this->data['subtype'] == 'image/jpeg') { |
||
| 233 | $this->data['exif'] = Util\File::readExif($this->data['file']); |
||
| 234 | } |
||
| 235 | } |
||
| 236 | $cache->set($cacheKey, $this->data, $this->config->get('cache.assets.ttl')); |
||
| 237 | $this->builder->getLogger()->debug(\sprintf('Asset cached: "%s"', $this->data['path'])); |
||
| 238 | // optimizing images files (in cache directory) |
||
| 239 | if ($optimize) { |
||
| 240 | $this->optimize($cache->getContentFilePathname($this->data['path']), $this->data['path'], $quality); |
||
| 241 | } |
||
| 242 | } |
||
| 243 | $this->data = $cache->get($cacheKey); |
||
| 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 |
||
| 411 | { |
||
| 412 | $this->checkImage(); |
||
| 413 | |||
| 414 | if ($padding === null) { |
||
| 415 | $padding = 20; // default padding |
||
| 416 | } |
||
| 417 | |||
| 418 | $assetMaskable = clone $this; |
||
| 419 | |||
| 420 | $quality = (int) $this->config->get('assets.images.quality'); |
||
| 421 | |||
| 422 | $cache = new Cache($this->builder, 'assets'); |
||
| 423 | $assetMaskable->cacheTags['maskable'] = true; |
||
| 424 | $cacheKey = $cache->createKeyFromAsset($assetMaskable, $assetMaskable->cacheTags); |
||
| 425 | if (!$cache->has($cacheKey)) { |
||
| 426 | $assetMaskable->data['content'] = Image::maskable($assetMaskable, $quality, $padding); |
||
| 427 | $assetMaskable->data['path'] = '/' . Util::joinPath( |
||
| 428 | (string) $this->config->get('assets.target'), |
||
| 429 | 'maskable', |
||
| 430 | $assetMaskable->data['path'] |
||
| 431 | ); |
||
| 432 | $assetMaskable->data['size'] = \strlen($assetMaskable->data['content']); |
||
| 433 | |||
| 434 | $cache->set($cacheKey, $assetMaskable->data, $this->config->get('cache.assets.ttl')); |
||
| 435 | $this->builder->getLogger()->debug(\sprintf('Asset maskabled: "%s"', $assetMaskable->data['path'])); |
||
| 436 | } |
||
| 437 | $assetMaskable->data = $cache->get($cacheKey); |
||
| 438 | |||
| 439 | return $assetMaskable; |
||
| 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('Not able 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 |
||
| 499 | { |
||
| 500 | return $this->convert('avif', $quality); |
||
| 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] |
||
| 527 | public function offsetUnset($offset): void |
||
| 528 | { |
||
| 529 | unset($this->data[$offset]); |
||
| 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 |
||
| 558 | { |
||
| 559 | if ($this->data['type'] !== 'audio') { |
||
| 560 | throw new RuntimeException(\sprintf('Not able to get audio infos of "%s".', $this->data['path'])); |
||
| 561 | } |
||
| 562 | |||
| 563 | return new Mp3Info($this->data['file']); |
||
| 564 | } |
||
| 565 | |||
| 566 | /** |
||
| 567 | * Returns MP4 file infos. |
||
| 568 | * |
||
| 569 | * @see https://github.com/clwu88/php-read-mp4info |
||
| 570 | */ |
||
| 571 | public function getVideo(): array |
||
| 572 | { |
||
| 573 | if ($this->data['type'] !== 'video') { |
||
| 574 | throw new RuntimeException(\sprintf('Not able to get video infos of "%s".', $this->data['path'])); |
||
| 575 | } |
||
| 576 | |||
| 577 | return (array) \Clwu\Mp4::getInfo($this->data['file']); |
||
| 578 | } |
||
| 579 | |||
| 580 | /** |
||
| 581 | * Returns the Data URL (encoded in Base64). |
||
| 582 | * |
||
| 583 | * @throws RuntimeException |
||
| 584 | */ |
||
| 585 | public function dataurl(): string |
||
| 586 | { |
||
| 587 | if ($this->data['type'] == 'image' && !Image::isSVG($this)) { |
||
| 588 | return Image::getDataUrl($this, (int) $this->config->get('assets.images.quality')); |
||
| 589 | } |
||
| 590 | |||
| 591 | return \sprintf('data:%s;base64,%s', $this->data['subtype'], base64_encode($this->data['content'])); |
||
| 592 | } |
||
| 593 | |||
| 594 | /** |
||
| 595 | * Adds asset path to the list of assets to save. |
||
| 596 | * |
||
| 597 | * @throws RuntimeException |
||
| 598 | */ |
||
| 599 | public function save(): void |
||
| 600 | { |
||
| 601 | if ($this->data['missing']) { |
||
| 602 | return; |
||
| 603 | } |
||
| 604 | |||
| 605 | $cache = new Cache($this->builder, 'assets'); |
||
| 606 | if (empty($this->data['path']) || !Util\File::getFS()->exists($cache->getContentFilePathname($this->data['path']))) { |
||
| 607 | throw new RuntimeException( |
||
| 608 | \sprintf('Can\'t add "%s" to assets list. Please clear cache and retry.', $this->data['path']) |
||
| 609 | ); |
||
| 610 | } |
||
| 611 | |||
| 612 | $this->builder->addAsset($this->data['path']); |
||
| 613 | } |
||
| 614 | |||
| 615 | /** |
||
| 616 | * Is the asset an image and is it in CDN? |
||
| 617 | */ |
||
| 618 | public function isImageInCdn(): bool |
||
| 619 | { |
||
| 620 | if ( |
||
| 621 | $this->data['type'] == 'image' |
||
| 622 | && $this->config->isEnabled('assets.images.cdn') |
||
| 623 | && $this->data['ext'] != 'ico' |
||
| 624 | && (Image::isSVG($this) && $this->config->isEnabled('assets.images.cdn.svg')) |
||
| 625 | ) { |
||
| 626 | return true; |
||
| 627 | } |
||
| 628 | // handle remote image? |
||
| 629 | if ($this->data['url'] !== null && $this->config->isEnabled('assets.images.cdn.remote')) { |
||
| 630 | return true; |
||
| 631 | } |
||
| 632 | |||
| 633 | return false; |
||
| 634 | } |
||
| 635 | |||
| 636 | /** |
||
| 637 | * Builds a relative path from a URL. |
||
| 638 | * Used for remote files. |
||
| 639 | */ |
||
| 640 | public static function buildPathFromUrl(string $url): string |
||
| 641 | { |
||
| 642 | $host = parse_url($url, PHP_URL_HOST); |
||
| 643 | $path = parse_url($url, PHP_URL_PATH); |
||
| 644 | $query = parse_url($url, PHP_URL_QUERY); |
||
| 645 | $ext = pathinfo(parse_url($url, PHP_URL_PATH), PATHINFO_EXTENSION); |
||
| 646 | |||
| 647 | // Google Fonts hack |
||
| 648 | if (Util\Str::endsWith($path, '/css') || Util\Str::endsWith($path, '/css2')) { |
||
| 649 | $ext = 'css'; |
||
| 650 | } |
||
| 651 | |||
| 652 | return Page::slugify(\sprintf('%s%s%s%s', $host, self::sanitize($path), $query ? "-$query" : '', $query && $ext ? ".$ext" : '')); |
||
| 653 | } |
||
| 654 | |||
| 655 | /** |
||
| 656 | * Replaces some characters by '_'. |
||
| 657 | */ |
||
| 658 | public static function sanitize(string $string): string |
||
| 659 | { |
||
| 660 | return str_replace(['<', '>', ':', '"', '\\', '|', '?', '*'], '_', $string); |
||
| 661 | } |
||
| 662 | |||
| 663 | /** |
||
| 664 | * Compiles a SCSS. |
||
| 665 | * |
||
| 666 | * @throws RuntimeException |
||
| 667 | */ |
||
| 668 | protected function doCompile(): self |
||
| 669 | { |
||
| 670 | // abort if not a SCSS file |
||
| 671 | if ($this->data['ext'] != 'scss') { |
||
| 672 | return $this; |
||
| 673 | } |
||
| 674 | $scssPhp = new Compiler(); |
||
| 675 | // import paths |
||
| 676 | $importDir = []; |
||
| 677 | $importDir[] = Util::joinPath($this->config->getStaticPath()); |
||
| 678 | $importDir[] = Util::joinPath($this->config->getAssetsPath()); |
||
| 679 | $scssDir = (array) $this->config->get('assets.compile.import'); |
||
| 680 | $themes = $this->config->getTheme() ?? []; |
||
| 681 | foreach ($scssDir as $dir) { |
||
| 682 | $importDir[] = Util::joinPath($this->config->getStaticPath(), $dir); |
||
| 683 | $importDir[] = Util::joinPath($this->config->getAssetsPath(), $dir); |
||
| 684 | $importDir[] = Util::joinPath(\dirname($this->data['file']), $dir); |
||
| 685 | foreach ($themes as $theme) { |
||
| 686 | $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "static/$dir")); |
||
| 687 | $importDir[] = Util::joinPath($this->config->getThemeDirPath($theme, "assets/$dir")); |
||
| 688 | } |
||
| 689 | } |
||
| 690 | $scssPhp->setQuietDeps(true); |
||
| 691 | $scssPhp->setImportPaths(array_unique($importDir)); |
||
| 692 | // adds source map |
||
| 693 | if ($this->builder->isDebug() && $this->config->isEnabled('assets.compile.sourcemap')) { |
||
| 694 | $importDir = []; |
||
| 695 | $assetDir = (string) $this->config->get('assets.dir'); |
||
| 696 | $assetDirPos = strrpos($this->data['file'], DIRECTORY_SEPARATOR . $assetDir . DIRECTORY_SEPARATOR); |
||
| 697 | $fileRelPath = substr($this->data['file'], $assetDirPos + 8); |
||
| 698 | $filePath = Util::joinFile($this->config->getOutputPath(), $fileRelPath); |
||
| 699 | $importDir[] = \dirname($filePath); |
||
| 700 | foreach ($scssDir as $dir) { |
||
| 701 | $importDir[] = Util::joinFile($this->config->getOutputPath(), $dir); |
||
| 702 | } |
||
| 703 | $scssPhp->setImportPaths(array_unique($importDir)); |
||
| 704 | $scssPhp->setSourceMap(Compiler::SOURCE_MAP_INLINE); |
||
| 705 | $scssPhp->setSourceMapOptions([ |
||
| 706 | 'sourceMapBasepath' => Util::joinPath($this->config->getOutputPath()), |
||
| 707 | 'sourceRoot' => '/', |
||
| 708 | ]); |
||
| 709 | } |
||
| 710 | // defines output style |
||
| 711 | $outputStyles = ['expanded', 'compressed']; |
||
| 712 | $outputStyle = strtolower((string) $this->config->get('assets.compile.style')); |
||
| 713 | if (!\in_array($outputStyle, $outputStyles)) { |
||
| 714 | throw new ConfigException(\sprintf('"%s" value must be "%s".', 'assets.compile.style', implode('" or "', $outputStyles))); |
||
| 715 | } |
||
| 716 | $scssPhp->setOutputStyle($outputStyle == 'compressed' ? OutputStyle::COMPRESSED : OutputStyle::EXPANDED); |
||
| 717 | // set variables |
||
| 718 | $variables = $this->config->get('assets.compile.variables'); |
||
| 719 | if (!empty($variables)) { |
||
| 720 | $variables = array_map('ScssPhp\ScssPhp\ValueConverter::parseValue', $variables); |
||
| 721 | $scssPhp->replaceVariables($variables); |
||
| 722 | } |
||
| 723 | // debug |
||
| 724 | if ($this->builder->isDebug()) { |
||
| 725 | $scssPhp->setQuietDeps(false); |
||
| 726 | $this->builder->getLogger()->debug(\sprintf("SCSS compiler imported paths:\n%s", Util\Str::arrayToList(array_unique($importDir)))); |
||
| 727 | } |
||
| 728 | // update data |
||
| 729 | $this->data['path'] = preg_replace('/sass|scss/m', 'css', $this->data['path']); |
||
| 730 | $this->data['ext'] = 'css'; |
||
| 731 | $this->data['type'] = 'text'; |
||
| 732 | $this->data['subtype'] = 'text/css'; |
||
| 733 | $this->data['content'] = $scssPhp->compileString($this->data['content'])->getCss(); |
||
| 734 | $this->data['size'] = \strlen($this->data['content']); |
||
| 735 | |||
| 736 | $this->builder->getLogger()->debug(\sprintf('Asset compiled: "%s"', $this->data['path'])); |
||
| 737 | |||
| 738 | return $this; |
||
| 739 | } |
||
| 740 | |||
| 741 | /** |
||
| 742 | * Minifying a CSS or a JS + cache. |
||
| 743 | * |
||
| 744 | * @throws RuntimeException |
||
| 745 | */ |
||
| 746 | protected function doMinify(): self |
||
| 747 | { |
||
| 748 | // compile SCSS files |
||
| 749 | if ($this->data['ext'] == 'scss') { |
||
| 750 | $this->doCompile(); |
||
| 751 | } |
||
| 752 | // abort if already minified |
||
| 753 | if (substr($this->data['path'], -8) == '.min.css' || substr($this->data['path'], -7) == '.min.js') { |
||
| 754 | return $this; |
||
| 755 | } |
||
| 756 | // abord if not a CSS or JS file |
||
| 757 | if (!\in_array($this->data['ext'], ['css', 'js'])) { |
||
| 758 | return $this; |
||
| 759 | } |
||
| 760 | // in debug mode: disable minify to preserve inline source map |
||
| 761 | if ($this->builder->isDebug() && $this->config->isEnabled('assets.compile.sourcemap')) { |
||
| 762 | return $this; |
||
| 763 | } |
||
| 764 | switch ($this->data['ext']) { |
||
| 765 | case 'css': |
||
| 766 | $minifier = new Minify\CSS($this->data['content']); |
||
| 767 | break; |
||
| 768 | case 'js': |
||
| 769 | $minifier = new Minify\JS($this->data['content']); |
||
| 770 | break; |
||
| 771 | default: |
||
| 772 | throw new RuntimeException(\sprintf('Not able to minify "%s".', $this->data['path'])); |
||
| 773 | } |
||
| 774 | $this->data['content'] = $minifier->minify(); |
||
| 775 | $this->data['size'] = \strlen($this->data['content']); |
||
| 776 | |||
| 777 | $this->builder->getLogger()->debug(\sprintf('Asset minified: "%s"', $this->data['path'])); |
||
| 778 | |||
| 779 | return $this; |
||
| 780 | } |
||
| 781 | |||
| 782 | /** |
||
| 783 | * Add hash to the file name. |
||
| 784 | */ |
||
| 785 | protected function doFingerprint(): self |
||
| 786 | { |
||
| 787 | $hash = hash('md5', $this->data['content']); |
||
| 788 | $this->data['path'] = preg_replace( |
||
| 789 | '/\.' . $this->data['ext'] . '$/m', |
||
| 790 | ".$hash." . $this->data['ext'], |
||
| 791 | $this->data['path'] |
||
| 792 | ); |
||
| 793 | $this->builder->getLogger()->debug(\sprintf('Asset fingerprinted: "%s"', $this->data['path'])); |
||
| 794 | |||
| 795 | return $this; |
||
| 796 | } |
||
| 797 | |||
| 798 | /** |
||
| 799 | * Returns local file path and updated path, or throw an exception. |
||
| 800 | * If $fallback path is set, it will be used if the remote file is not found. |
||
| 801 | * |
||
| 802 | * Try to locate the file in: |
||
| 803 | * (1. remote file) |
||
| 804 | * 1. assets |
||
| 805 | * 2. themes/<theme>/assets |
||
| 806 | * 3. static |
||
| 807 | * 4. themes/<theme>/static |
||
| 808 | * |
||
| 809 | * @throws RuntimeException |
||
| 810 | */ |
||
| 811 | private function locateFile(string $path, ?string $fallback = null, ?string $userAgent = null): array |
||
| 812 | { |
||
| 813 | // remote file |
||
| 814 | if (Util\File::isRemote($path)) { |
||
| 815 | try { |
||
| 816 | $content = $this->getRemoteFileContent($path, $userAgent); |
||
| 817 | $path = self::buildPathFromUrl($path); |
||
| 818 | $cache = new Cache($this->builder, 'assets/remote'); |
||
| 819 | if (!$cache->has($path)) { |
||
| 820 | $cache->set($path, [ |
||
| 821 | 'content' => $content, |
||
| 822 | 'path' => $path, |
||
| 823 | ], $this->config->get('cache.assets.remote.ttl')); |
||
| 824 | } |
||
| 825 | return [ |
||
| 826 | 'file' => $cache->getContentFilePathname($path), |
||
| 827 | 'path' => $path, |
||
| 828 | ]; |
||
| 829 | } catch (RuntimeException $e) { |
||
| 830 | if (empty($fallback)) { |
||
| 831 | throw new RuntimeException($e->getMessage()); |
||
| 832 | } |
||
| 833 | $path = $fallback; |
||
| 834 | } |
||
| 835 | } |
||
| 836 | |||
| 837 | // checks in assets/ |
||
| 838 | $file = Util::joinFile($this->config->getAssetsPath(), $path); |
||
| 839 | if (Util\File::getFS()->exists($file)) { |
||
| 840 | return [ |
||
| 841 | 'file' => $file, |
||
| 842 | 'path' => $path, |
||
| 843 | ]; |
||
| 844 | } |
||
| 845 | |||
| 846 | // checks in each themes/<theme>/assets/ |
||
| 847 | foreach ($this->config->getTheme() ?? [] as $theme) { |
||
| 848 | $file = Util::joinFile($this->config->getThemeDirPath($theme, 'assets'), $path); |
||
| 849 | if (Util\File::getFS()->exists($file)) { |
||
| 850 | return [ |
||
| 851 | 'file' => $file, |
||
| 852 | 'path' => $path, |
||
| 853 | ]; |
||
| 854 | } |
||
| 855 | } |
||
| 856 | |||
| 857 | // checks in static/ |
||
| 858 | $file = Util::joinFile($this->config->getStaticPath(), $path); |
||
| 859 | if (Util\File::getFS()->exists($file)) { |
||
| 860 | return [ |
||
| 861 | 'file' => $file, |
||
| 862 | 'path' => $path, |
||
| 863 | ]; |
||
| 864 | } |
||
| 865 | |||
| 866 | // checks in each themes/<theme>/static/ |
||
| 867 | foreach ($this->config->getTheme() ?? [] as $theme) { |
||
| 868 | $file = Util::joinFile($this->config->getThemeDirPath($theme, 'static'), $path); |
||
| 869 | if (Util\File::getFS()->exists($file)) { |
||
| 870 | return [ |
||
| 871 | 'file' => $file, |
||
| 872 | 'path' => $path, |
||
| 873 | ]; |
||
| 874 | } |
||
| 875 | } |
||
| 876 | |||
| 877 | throw new RuntimeException(\sprintf('Can\'t locate file "%s".', $path)); |
||
| 878 | } |
||
| 879 | |||
| 880 | /** |
||
| 881 | * Try to get remote file content. |
||
| 882 | * Returns file content or throw an exception. |
||
| 883 | * |
||
| 884 | * @throws RuntimeException |
||
| 885 | */ |
||
| 886 | private function getRemoteFileContent(string $path, ?string $userAgent = null): string |
||
| 887 | { |
||
| 888 | if (!Util\File::isRemoteExists($path)) { |
||
| 889 | throw new RuntimeException(\sprintf('Can\'t get remote file "%s".', $path)); |
||
| 890 | } |
||
| 891 | if (false === $content = Util\File::fileGetContents($path, $userAgent)) { |
||
| 892 | throw new RuntimeException(\sprintf('Can\'t get content of remote file "%s".', $path)); |
||
| 893 | } |
||
| 894 | if (\strlen($content) <= 1) { |
||
| 895 | throw new RuntimeException(\sprintf('Remote file "%s" is empty.', $path)); |
||
| 896 | } |
||
| 897 | |||
| 898 | return $content; |
||
| 899 | } |
||
| 900 | |||
| 901 | /** |
||
| 902 | * Optimizing $filepath image. |
||
| 903 | * Returns the new file size. |
||
| 904 | */ |
||
| 905 | private function optimize(string $filepath, string $path, int $quality): int |
||
| 906 | { |
||
| 907 | $message = \sprintf('Asset not optimized: "%s"', $path); |
||
| 908 | $sizeBefore = filesize($filepath); |
||
| 909 | Optimizer::create($quality)->optimize($filepath); |
||
| 910 | $sizeAfter = filesize($filepath); |
||
| 911 | if ($sizeAfter < $sizeBefore) { |
||
| 912 | $message = \sprintf( |
||
| 913 | 'Asset optimized: "%s" (%s Ko -> %s Ko)', |
||
| 914 | $path, |
||
| 915 | ceil($sizeBefore / 1000), |
||
| 916 | ceil($sizeAfter / 1000) |
||
| 917 | ); |
||
| 918 | } |
||
| 919 | $this->builder->getLogger()->debug($message); |
||
| 920 | |||
| 921 | return $sizeAfter; |
||
| 922 | } |
||
| 923 | |||
| 924 | /** |
||
| 925 | * Returns the width of an image/SVG. |
||
| 926 | * |
||
| 927 | * @throws RuntimeException |
||
| 928 | */ |
||
| 929 | private function getWidth(): int |
||
| 930 | { |
||
| 931 | if ($this->data['type'] != 'image') { |
||
| 932 | return 0; |
||
| 933 | } |
||
| 934 | if (Image::isSVG($this) && false !== $svg = Image::getSvgAttributes($this)) { |
||
| 935 | return (int) $svg->width; |
||
| 936 | } |
||
| 937 | if (false === $size = $this->getImageSize()) { |
||
| 938 | throw new RuntimeException(\sprintf('Not able to get width of "%s".', $this->data['path'])); |
||
| 939 | } |
||
| 940 | |||
| 941 | return $size[0]; |
||
| 942 | } |
||
| 943 | |||
| 944 | /** |
||
| 945 | * Returns the height of an image/SVG. |
||
| 946 | * |
||
| 947 | * @throws RuntimeException |
||
| 948 | */ |
||
| 949 | private function getHeight(): int |
||
| 962 | } |
||
| 963 | |||
| 964 | /** |
||
| 965 | * Returns image size informations. |
||
| 966 | * |
||
| 967 | * @see https://www.php.net/manual/function.getimagesize.php |
||
| 968 | * |
||
| 969 | * @return array|false |
||
| 970 | */ |
||
| 971 | private function getImageSize() |
||
| 986 | } |
||
| 987 | |||
| 988 | /** |
||
| 989 | * Builds CDN image URL. |
||
| 990 | */ |
||
| 991 | private function buildImageCdnUrl(): string |
||
| 992 | { |
||
| 993 | return str_replace( |
||
| 994 | [ |
||
| 995 | '%account%', |
||
| 996 | '%image_url%', |
||
| 997 | '%width%', |
||
| 998 | '%quality%', |
||
| 1009 | ); |
||
| 1010 | } |
||
| 1011 | |||
| 1012 | /** |
||
| 1013 | * Checks if the asset is not missing and is typed as an image. |
||
| 1014 | * |
||
| 1015 | * @throws RuntimeException |
||
| 1016 | */ |
||
| 1017 | private function checkImage(): void |
||
| 1018 | { |
||
| 1019 | if ($this->data['missing']) { |
||
| 1020 | throw new RuntimeException(\sprintf('Not able to resize "%s": file not found.', $this->data['path'])); |
||
| 1021 | } |
||
| 1022 | if ($this->data['type'] != 'image') { |
||
| 1023 | throw new RuntimeException(\sprintf('Not able to resize "%s": not an image.', $this->data['path'])); |
||
| 1024 | } |
||
| 1025 | } |
||
| 1026 | |||
| 1027 | /** |
||
| 1028 | * Remove redondant '/thumbnails/<width>/' in the path. |
||
| 1029 | */ |
||
| 1030 | private function deduplicateThumbPath(string $path): string |
||
| 1036 | } |
||
| 1037 | } |
||
| 1038 |
