-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
ManifestHelper.php
352 lines (323 loc) · 10.8 KB
/
ManifestHelper.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
<?php
/**
* Vite plugin for Craft CMS 3.x
*
* Allows the use of the Vite.js next generation frontend tooling with Craft CMS
*
* @link https://nystudio107.com
* @copyright Copyright (c) 2021 nystudio107
*/
namespace nystudio107\pluginvite\helpers;
use Craft;
use craft\helpers\Json as JsonHelper;
/**
* @author nystudio107
* @package Vite
* @since 1.0.5
*/
class ManifestHelper
{
// Constants
// =========================================================================
const LEGACY_EXTENSION = '-legacy.';
// Protected Static Properties
// =========================================================================
/**
* @var array|null
*/
protected static $manifest;
/**
* @var array|null
*/
protected static $assetFiles;
// Public Static Methods
// =========================================================================
/**
* Fetch and memoize the manifest file
*
* @param string $manifestPath
*/
public static function fetchManifest(string $manifestPath)
{
// Grab the manifest
$pathOrUrl = (string)Craft::parseEnv($manifestPath);
$manifest = FileHelper::fetch($pathOrUrl, [JsonHelper::class, 'decodeIfJson']);
// If no manifest file is found, log it
if ($manifest === null) {
Craft::error('Manifest not found at ' . $manifestPath, __METHOD__);
}
// Ensure we're dealing with an array
self::$manifest = (array)$manifest;
}
/**
* Return an array of tags from the manifest, for both modern and legacy builds
*
* @param string $path
* @param bool $asyncCss
* @param array $scriptTagAttrs
* @param array $cssTagAttrs
*
* @return array
*/
public static function manifestTags(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = []): array
{
// Get the modern tags for this $path
return self::extractManifestTags($path, $asyncCss, $scriptTagAttrs, $cssTagAttrs);
}
/**
* Return an array of data describing the script, module link, and CSS link tags for the
* script from the manifest.json file
*
* @param string $path
* @param bool $asyncCss
* @param array $scriptTagAttrs
* @param array $cssTagAttrs
* @param bool $legacy
*
* @return array
*/
public static function extractManifestTags(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = [], bool $legacy = false): array
{
if (self::$manifest === null) {
return [];
}
$tags = [];
// Set the async CSS args
$asyncCssOptions = [];
if ($asyncCss) {
$asyncCssOptions = [
'media' => 'print',
'onload' => "this.media='all'",
];
}
// Set the script args
$scriptOptions = [
'type' => 'module',
'crossorigin' => true,
];
if ($legacy) {
$scriptOptions = [
'nomodule' => true,
];
}
// Iterate through the manifest
foreach (self::$manifest as $manifestKey => $entry) {
// If it's not an entry, skip it
if (!isset($entry['isEntry']) || !$entry['isEntry']) {
continue;
}
// If there's no file, skip it
if (!isset($entry['file'])) {
continue;
}
// If the $path isn't in the $manifestKey, and vice versus, skip it
if (strpos($manifestKey, $path) === false && strpos($path, $manifestKey) === false) {
continue;
}
// Handle optional `integrity` tags
$integrityAttributes = [];
if (isset($entry['integrity'])) {
$integrityAttributes = [
'integrity' => $entry['integrity'],
];
}
// Add an onload event so listeners can know when the event has fired
$tagOptions = array_merge(
$scriptOptions,
[
'onload' => "e=new CustomEvent('vite-script-loaded', {detail:{path: '$manifestKey'}});document.dispatchEvent(e);",
],
$integrityAttributes,
$scriptTagAttrs
);
// Include the entry script
$tags[$manifestKey] = [
'type' => 'file',
'url' => $entry['file'],
'options' => $tagOptions,
];
// Include any imports
$importFiles = [];
// Only include import tags for the non-legacy scripts
if (!$legacy) {
self::extractImportFiles(self::$manifest, $manifestKey, $importFiles);
foreach ($importFiles as $importKey => $importFile) {
$tags[$importFile] = [
'crossorigin' => $tagOptions['crossorigin'] ?? true,
'type' => 'import',
'url' => $importFile,
'integrity' => self::$manifest[$importKey]['integrity'] ?? '',
];
}
}
// Include any CSS tags
$cssFiles = [];
self::extractCssFiles(self::$manifest, $manifestKey, $cssFiles);
foreach ($cssFiles as $cssFile) {
$tags[$cssFile] = [
'type' => 'css',
'url' => $cssFile,
'options' => array_merge([
'rel' => 'stylesheet',
], $asyncCssOptions, $cssTagAttrs),
];
}
}
return $tags;
}
/**
* Return an array of tags from the manifest, for both modern and legacy builds
*
* @param string $path
* @param bool $asyncCss
* @param array $scriptTagAttrs
* @param array $cssTagAttrs
*
* @return array
*/
public static function legacyManifestTags(string $path, bool $asyncCss = true, array $scriptTagAttrs = [], array $cssTagAttrs = []): array
{
// Get the legacy tags for this $path
$parts = pathinfo($path);
$legacyPath = $parts['dirname']
. '/'
. $parts['filename']
. self::LEGACY_EXTENSION
. $parts['extension'];
return self::extractManifestTags($legacyPath, $asyncCss, $scriptTagAttrs, $cssTagAttrs, true);
}
/**
* Extract an entry file URL from all of the entries in the manifest
*
* @param string $path
* @return string
*/
public static function extractEntry(string $path): string
{
foreach (self::$manifest as $entryKey => $entry) {
if (strpos($entryKey, $path) !== false) {
return $entry['file'] ?? '';
}
// Check CSS
$styles = $entry['css'] ?? [];
foreach ($styles as $style) {
$styleKey = self::filenameWithoutHash($style);
if (strpos($styleKey, $path) !== false) {
return $style;
}
}
// Check assets
$assets = $entry['assets'] ?? [];
foreach ($assets as $asset) {
$assetKey = self::filenameWithoutHash($asset);
if (strpos($assetKey, $path) !== false) {
return $asset;
}
}
}
return '';
}
/**
* Extract an integrity hash for the given $path from the entries in the manifest
*
* @param string $path
* @return string
*/
public static function extractIntegrity(string $path): string
{
foreach (self::$manifest as $entryKey => $entry) {
if (strpos($entryKey, $path) !== false) {
return $entry['integrity'] ?? '';
}
}
return '';
}
/**
* Extract any asset files from all of the entries in the manifest
*
* @return array
*/
public static function extractAssetFiles(): array
{
// Used the memoized version if available
if (self::$assetFiles !== null) {
return self::$assetFiles;
}
$assetFiles = [];
foreach (self::$manifest as $entry) {
$assets = $entry['assets'] ?? [];
foreach ($assets as $asset) {
$assetKey = self::filenameWithoutHash($asset);
$assetFiles[$assetKey] = $asset;
}
}
self::$assetFiles = $assetFiles;
return $assetFiles;
}
// Protected Static Methods
// =========================================================================
/**
* Extract any import files from entries recursively
*
* @param array $manifest
* @param string $manifestKey
* @param array $importFiles
*
* @return array
*/
protected static function extractImportFiles(array $manifest, string $manifestKey, array &$importFiles): array
{
$entry = $manifest[$manifestKey] ?? null;
if (!$entry) {
return [];
}
$imports = $entry['imports'] ?? [];
foreach ($imports as $import) {
$importFiles[$import] = $manifest[$import]['file'];
self::extractImportFiles($manifest, $import, $importFiles);
}
return $importFiles;
}
/**
* Extract any CSS files from entries recursively
*
* @param array $manifest
* @param string $manifestKey
* @param array $cssFiles
*
* @return array
*/
protected static function extractCssFiles(array $manifest, string $manifestKey, array &$cssFiles): array
{
$entry = $manifest[$manifestKey] ?? null;
if (!$entry) {
return [];
}
$cssFiles = array_merge($cssFiles, $entry['css'] ?? []);
$imports = $entry['imports'] ?? [];
foreach ($imports as $import) {
self::extractCssFiles($manifest, $import, $cssFiles);
}
return $cssFiles;
}
/**
* Return a file name from the passed in $path, with any version hash removed from it
*
* @param string $path
* @return string
*/
protected static function filenameWithoutHash(string $path): string
{
$pathInfo = pathinfo($path);
$filename = $pathInfo['filename'];
$extension = $pathInfo['extension'];
$hashPos = strrpos($filename, '.') ?: strlen($filename);
$hash = substr($filename, $hashPos);
// Vite 5 now uses a `-` to separate the version hash, so account for that as well
if (empty($hash) && str_contains($filename, '-')) {
$hash = substr($filename, strrpos($filename, '-'));
}
$filename = str_replace($hash, '', $filename);
return implode('.', [$filename, $extension]);
}
}