forked from dotnet/blazor
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reference static content from referenced assemblies. Implements #340
- Loading branch information
1 parent
2e41f05
commit c8575af
Showing
20 changed files
with
393 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
src/Microsoft.AspNetCore.Blazor.Build/Core/EmbeddedResources/EmbeddedResourceInfo.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| namespace Microsoft.AspNetCore.Blazor.Build | ||
| { | ||
| internal class EmbeddedResourceInfo | ||
| { | ||
| public EmbeddedResourceKind Kind { get; } | ||
| public string RelativePath { get; } | ||
|
|
||
| public EmbeddedResourceInfo(EmbeddedResourceKind kind, string relativePath) | ||
| { | ||
| Kind = kind; | ||
| RelativePath = relativePath; | ||
| } | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
src/Microsoft.AspNetCore.Blazor.Build/Core/EmbeddedResources/EmbeddedResourceKind.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| namespace Microsoft.AspNetCore.Blazor.Build | ||
| { | ||
| internal enum EmbeddedResourceKind | ||
| { | ||
| JavaScript, | ||
| Css, | ||
| Static | ||
| } | ||
| } |
137 changes: 137 additions & 0 deletions
137
src/Microsoft.AspNetCore.Blazor.Build/Core/EmbeddedResources/EmbeddedResourcesProcessor.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| // Copyright (c) .NET Foundation. All rights reserved. | ||
| // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
|
||
| using Mono.Cecil; | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
|
|
||
| namespace Microsoft.AspNetCore.Blazor.Build | ||
| { | ||
| internal class EmbeddedResourcesProcessor | ||
| { | ||
| const string ContentSubdirName = "_content"; | ||
|
|
||
| private readonly static Dictionary<string, EmbeddedResourceKind> _knownResourceKindsByNamePrefix = new Dictionary<string, EmbeddedResourceKind> | ||
| { | ||
| { "blazor:js:", EmbeddedResourceKind.JavaScript }, | ||
| { "blazor:css:", EmbeddedResourceKind.Css }, | ||
| { "blazor:file:", EmbeddedResourceKind.Static }, | ||
| }; | ||
|
|
||
| /// <summary> | ||
| /// Finds Blazor-specific embedded resources in the specified assemblies, writes them | ||
| /// to disk, and returns a description of those resources in dependency order. | ||
| /// </summary> | ||
| /// <param name="referencedAssemblyPaths">The paths to assemblies that may contain embedded resources.</param> | ||
| /// <param name="outputDir">The path to the directory where output is being written.</param> | ||
| /// <returns>A description of the embedded resources that were written to disk.</returns> | ||
| public static IReadOnlyList<EmbeddedResourceInfo> ExtractEmbeddedResources( | ||
| IEnumerable<string> referencedAssemblyPaths, string outputDir) | ||
| { | ||
| // Clean away any earlier state | ||
| var contentDir = Path.Combine(outputDir, ContentSubdirName); | ||
| if (Directory.Exists(contentDir)) | ||
| { | ||
| Directory.Delete(contentDir, recursive: true); | ||
| } | ||
|
|
||
| // First, get an ordered list of AssemblyDefinition instances | ||
| var referencedAssemblyDefinitions = referencedAssemblyPaths | ||
| .Where(path => !Path.GetFileName(path).StartsWith("System.", StringComparison.Ordinal)) // Skip System.* because they are never going to contain embedded resources that we want | ||
| .Select(path => AssemblyDefinition.ReadAssembly(path)) | ||
| .ToList(); | ||
| referencedAssemblyDefinitions.Sort(OrderWithReferenceSubjectFirst); | ||
|
|
||
| // Now process them in turn | ||
| return referencedAssemblyDefinitions | ||
| .SelectMany(def => ExtractEmbeddedResourcesFromSingleAssembly(def, outputDir)) | ||
| .ToList() | ||
| .AsReadOnly(); | ||
| } | ||
|
|
||
| private static IEnumerable<EmbeddedResourceInfo> ExtractEmbeddedResourcesFromSingleAssembly( | ||
| AssemblyDefinition assemblyDefinition, string outputDirPath) | ||
| { | ||
| var assemblyName = assemblyDefinition.Name.Name; | ||
| foreach (var res in assemblyDefinition.MainModule.Resources) | ||
| { | ||
| if (TryExtractEmbeddedResource(assemblyName, res, outputDirPath, out var extractedResourceInfo)) | ||
| { | ||
| yield return extractedResourceInfo; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static bool TryExtractEmbeddedResource(string assemblyName, Resource resource, string outputDirPath, out EmbeddedResourceInfo extractedResourceInfo) | ||
| { | ||
| if (resource is EmbeddedResource embeddedResource) | ||
| { | ||
| if (TryInterpretLogicalName(resource.Name, out var kind, out var name)) | ||
| { | ||
| // Prefix the output path with the assembly name to ensure no clashes | ||
| // Also be invariant to the OS on which the package was built | ||
| name = Path.Combine(ContentSubdirName, assemblyName, EnsureHasPathSeparators(name, Path.DirectorySeparatorChar)); | ||
|
|
||
| // Write the file content to disk, ensuring we don't try to write outside the output root | ||
| var outputPath = Path.GetFullPath(Path.Combine(outputDirPath, name)); | ||
| if (!outputPath.StartsWith(outputDirPath)) | ||
| { | ||
| throw new InvalidOperationException($"Cannot write embedded resource from assembly '{assemblyName}' to '{outputPath}' because it is outside the expected directory {outputDirPath}"); | ||
| } | ||
| WriteResourceFile(embeddedResource, outputPath); | ||
|
|
||
| // The URLs we write into the index.html file need to use web-style directory separators | ||
| extractedResourceInfo = new EmbeddedResourceInfo(kind, EnsureHasPathSeparators(name, '/')); | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| extractedResourceInfo = null; | ||
| return false; | ||
| } | ||
|
|
||
| private static void WriteResourceFile(EmbeddedResource resource, string outputPath) | ||
| { | ||
| Directory.CreateDirectory(Path.GetDirectoryName(outputPath)); | ||
| using (var outputStream = File.OpenWrite(outputPath)) | ||
| { | ||
| resource.GetResourceStream().CopyTo(outputStream); | ||
| } | ||
| } | ||
|
|
||
| private static string EnsureHasPathSeparators(string name, char desiredSeparatorChar) => name | ||
| .Replace('\\', desiredSeparatorChar) | ||
| .Replace('/', desiredSeparatorChar); | ||
|
|
||
| private static bool TryInterpretLogicalName(string logicalName, out EmbeddedResourceKind kind, out string resolvedName) | ||
| { | ||
| foreach (var kvp in _knownResourceKindsByNamePrefix) | ||
| { | ||
| if (logicalName.StartsWith(kvp.Key, StringComparison.Ordinal)) | ||
| { | ||
| kind = kvp.Value; | ||
| resolvedName = logicalName.Substring(kvp.Key.Length); | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| kind = default; | ||
| resolvedName = default; | ||
| return false; | ||
| } | ||
|
|
||
| // For each assembly B that references A, we want the resources from A to be loaded before | ||
| // the references for B (because B's resources might depend on A's resources) | ||
| private static int OrderWithReferenceSubjectFirst(AssemblyDefinition a, AssemblyDefinition b) | ||
| => AssemblyHasReference(a, b) ? 1 | ||
| : AssemblyHasReference(b, a) ? -1 | ||
| : 0; | ||
|
|
||
| private static bool AssemblyHasReference(AssemblyDefinition from, AssemblyDefinition to) | ||
| => from.MainModule.AssemblyReferences | ||
| .Select(reference => reference.Name) | ||
| .Contains(to.Name.Name, StringComparer.Ordinal); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
12 changes: 12 additions & 0 deletions
12
...etCore.Blazor.Templates/content/BlazorContent.CSharp/.template.config/dotnetcli.host.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "$schema": "http://json.schemastore.org/dotnetcli.host", | ||
| "symbolInfo": { | ||
| "skipRestore": { | ||
| "longName": "no-restore", | ||
| "shortName": "" | ||
| }, | ||
| "Framework": { | ||
| "longName": "framework" | ||
| } | ||
| } | ||
| } |
Binary file added
BIN
+1.17 KB
...NetCore.Blazor.Templates/content/BlazorContent.CSharp/.template.config/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.