-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Asset.php
372 lines (335 loc) · 13 KB
/
Asset.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 4.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Routing;
use Cake\Core\Configure;
use Cake\Core\Plugin;
use Cake\Utility\Inflector;
/**
* Class for generating asset URLs.
*/
class Asset
{
/**
* Inflection type.
*
* @var string
*/
protected static $inflectionType = 'underscore';
/**
* Set inflection type to use when inflecting plugin/theme name.
*
* @param string $inflectionType Inflection type. Value should be a valid
* method name of `Inflector` class like `'dasherize'` or `'underscore`'`.
* @return void
*/
public static function setInflectionType(string $inflectionType): void
{
static::$inflectionType = $inflectionType;
}
/**
* Generates URL for given image file.
*
* Depending on options passed provides full URL with domain name. Also calls
* `Asset::assetTimestamp()` to add timestamp to local files.
*
* @param string $path Path string.
* @param array $options Options array. Possible keys:
* `fullBase` Return full URL with domain name
* `pathPrefix` Path prefix for relative URLs
* `plugin` False value will prevent parsing path as a plugin
* `timestamp` Overrides the value of `Asset.timestamp` in Configure.
* Set to false to skip timestamp generation.
* Set to true to apply timestamps when debug is true. Set to 'force' to always
* enable timestamping regardless of debug value.
* @return string Generated URL
*/
public static function imageUrl(string $path, array $options = []): string
{
$pathPrefix = Configure::read('App.imageBaseUrl');
return static::url($path, $options + compact('pathPrefix'));
}
/**
* Generates URL for given CSS file.
*
* Depending on options passed provides full URL with domain name. Also calls
* `Asset::assetTimestamp()` to add timestamp to local files.
*
* @param string $path Path string.
* @param array $options Options array. Possible keys:
* `fullBase` Return full URL with domain name
* `pathPrefix` Path prefix for relative URLs
* `ext` Asset extension to append
* `plugin` False value will prevent parsing path as a plugin
* `timestamp` Overrides the value of `Asset.timestamp` in Configure.
* Set to false to skip timestamp generation.
* Set to true to apply timestamps when debug is true. Set to 'force' to always
* enable timestamping regardless of debug value.
* @return string Generated URL
*/
public static function cssUrl(string $path, array $options = []): string
{
$pathPrefix = Configure::read('App.cssBaseUrl');
$ext = '.css';
return static::url($path, $options + compact('pathPrefix', 'ext'));
}
/**
* Generates URL for given javascript file.
*
* Depending on options passed provides full URL with domain name. Also calls
* `Asset::assetTimestamp()` to add timestamp to local files.
*
* @param string $path Path string.
* @param array $options Options array. Possible keys:
* `fullBase` Return full URL with domain name
* `pathPrefix` Path prefix for relative URLs
* `ext` Asset extension to append
* `plugin` False value will prevent parsing path as a plugin
* `timestamp` Overrides the value of `Asset.timestamp` in Configure.
* Set to false to skip timestamp generation.
* Set to true to apply timestamps when debug is true. Set to 'force' to always
* enable timestamping regardless of debug value.
* @return string Generated URL
*/
public static function scriptUrl(string $path, array $options = []): string
{
$pathPrefix = Configure::read('App.jsBaseUrl');
$ext = '.js';
return static::url($path, $options + compact('pathPrefix', 'ext'));
}
/**
* Generates URL for given asset file.
*
* Depending on options passed provides full URL with domain name. Also calls
* `Asset::assetTimestamp()` to add timestamp to local files.
*
* ### Options:
*
* - `fullBase` Boolean true or a string (e.g. https://example) to
* return full URL with protocol and domain name.
* - `pathPrefix` Path prefix for relative URLs
* - `ext` Asset extension to append
* - `plugin` False value will prevent parsing path as a plugin
* - `theme` Optional theme name
* - `timestamp` Overrides the value of `Asset.timestamp` in Configure.
* Set to false to skip timestamp generation.
* Set to true to apply timestamps when debug is true. Set to 'force' to always
* enable timestamping regardless of debug value.
*
* @param string $path Path string or URL array
* @param array $options Options array.
* @return string Generated URL
*/
public static function url(string $path, array $options = []): string
{
if (preg_match('/^data:[a-z]+\/[a-z]+;/', $path)) {
return $path;
}
if (strpos($path, '://') !== false || preg_match('/^[a-z]+:/i', $path)) {
return ltrim(Router::url($path), '/');
}
if (!array_key_exists('plugin', $options) || $options['plugin'] !== false) {
[$plugin, $path] = static::pluginSplit($path);
}
if (!empty($options['pathPrefix']) && $path[0] !== '/') {
$pathPrefix = $options['pathPrefix'];
$placeHolderVal = '';
if (!empty($options['theme'])) {
$placeHolderVal = static::inflectString($options['theme']) . '/';
} elseif (isset($plugin)) {
$placeHolderVal = static::inflectString($plugin) . '/';
}
$path = str_replace('{plugin}', $placeHolderVal, $pathPrefix) . $path;
}
if (
!empty($options['ext']) &&
strpos($path, '?') === false &&
substr($path, -strlen($options['ext'])) !== $options['ext']
) {
$path .= $options['ext'];
}
// Check again if path has protocol as `pathPrefix` could be for CDNs.
if (preg_match('|^([a-z0-9]+:)?//|', $path)) {
return Router::url($path);
}
if (isset($plugin)) {
$path = static::inflectString($plugin) . '/' . $path;
}
$optionTimestamp = null;
if (array_key_exists('timestamp', $options)) {
$optionTimestamp = $options['timestamp'];
}
$webPath = static::assetTimestamp(
static::webroot($path, $options),
$optionTimestamp
);
$path = static::encodeUrl($webPath);
if (!empty($options['fullBase'])) {
$fullBaseUrl = is_string($options['fullBase'])
? $options['fullBase']
: Router::fullBaseUrl();
$path = rtrim($fullBaseUrl, '/') . '/' . ltrim($path, '/');
}
return $path;
}
/**
* Encodes URL parts using rawurlencode().
*
* @param string $url The URL to encode.
* @return string
*/
protected static function encodeUrl(string $url): string
{
$path = parse_url($url, PHP_URL_PATH);
if ($path === false) {
$path = $url;
}
$parts = array_map('rawurldecode', explode('/', $path));
$parts = array_map('rawurlencode', $parts);
$encoded = implode('/', $parts);
return str_replace($path, $encoded, $url);
}
/**
* Adds a timestamp to a file based resource based on the value of `Asset.timestamp` in
* Configure. If Asset.timestamp is true and debug is true, or Asset.timestamp === 'force'
* a timestamp will be added.
*
* @param string $path The file path to timestamp, the path must be inside `App.wwwRoot` in Configure.
* @param bool|string $timestamp If set will overrule the value of `Asset.timestamp` in Configure.
* @return string Path with a timestamp added, or not.
*/
public static function assetTimestamp(string $path, $timestamp = null): string
{
if (strpos($path, '?') !== false) {
return $path;
}
if ($timestamp === null) {
$timestamp = Configure::read('Asset.timestamp');
}
$timestampEnabled = $timestamp === 'force' || ($timestamp === true && Configure::read('debug'));
if ($timestampEnabled) {
$filepath = preg_replace(
'/^' . preg_quote(static::requestWebroot(), '/') . '/',
'',
urldecode($path)
);
$webrootPath = Configure::read('App.wwwRoot') . str_replace('/', DIRECTORY_SEPARATOR, $filepath);
if (is_file($webrootPath)) {
return $path . '?' . filemtime($webrootPath);
}
// Check for plugins and org prefixed plugins.
$segments = explode('/', ltrim($filepath, '/'));
$plugin = Inflector::camelize($segments[0]);
if (!Plugin::isLoaded($plugin) && count($segments) > 1) {
$plugin = implode('/', [$plugin, Inflector::camelize($segments[1])]);
unset($segments[1]);
}
if (Plugin::isLoaded($plugin)) {
unset($segments[0]);
$pluginPath = Plugin::path($plugin)
. 'webroot'
. DIRECTORY_SEPARATOR
. implode(DIRECTORY_SEPARATOR, $segments);
if (is_file($pluginPath)) {
return $path . '?' . filemtime($pluginPath);
}
}
}
return $path;
}
/**
* Checks if a file exists when theme is used, if no file is found default location is returned.
*
* ### Options:
*
* - `theme` Optional theme name
*
* @param string $file The file to create a webroot path to.
* @param array $options Options array.
* @return string Web accessible path to file.
*/
public static function webroot(string $file, array $options = []): string
{
$options += ['theme' => null];
$requestWebroot = static::requestWebroot();
$asset = explode('?', $file);
$asset[1] = isset($asset[1]) ? '?' . $asset[1] : '';
$webPath = $requestWebroot . $asset[0];
$file = $asset[0];
$themeName = $options['theme'];
if ($themeName) {
$file = trim($file, '/');
$theme = static::inflectString($themeName) . '/';
if (DIRECTORY_SEPARATOR === '\\') {
$file = str_replace('/', '\\', $file);
}
if (is_file(Configure::read('App.wwwRoot') . $theme . $file)) {
$webPath = $requestWebroot . $theme . $asset[0];
} else {
$themePath = Plugin::path($themeName);
$path = $themePath . 'webroot/' . $file;
if (is_file($path)) {
$webPath = $requestWebroot . $theme . $asset[0];
}
}
}
if (strpos($webPath, '//') !== false) {
return str_replace('//', '/', $webPath . $asset[1]);
}
return $webPath . $asset[1];
}
/**
* Inflect the theme/plugin name to type set using `Asset::setInflectionType()`.
*
* @param string $string String inflected.
* @return string Inflected name of the theme
*/
protected static function inflectString(string $string): string
{
return Inflector::{static::$inflectionType}($string);
}
/**
* Get webroot from request.
*
* @return string
*/
protected static function requestWebroot(): string
{
$request = Router::getRequest();
if ($request === null) {
return '/';
}
return $request->getAttribute('webroot');
}
/**
* Splits a dot syntax plugin name into its plugin and filename.
* If $name does not have a dot, then index 0 will be null.
* It checks if the plugin is loaded, else filename will stay unchanged for filenames containing dot.
*
* @param string $name The name you want to plugin split.
* @return array Array with 2 indexes. 0 => plugin name, 1 => filename.
* @psalm-return array{string|null, string}
*/
protected static function pluginSplit(string $name): array
{
$plugin = null;
[$first, $second] = pluginSplit($name);
if ($first && Plugin::isLoaded($first)) {
$name = $second;
$plugin = $first;
}
return [$plugin, $name];
}
}