Adding Azure and AWS-specific Image Caches of ImageSharp (Lombiq Technologies: OCORE-136) #15028
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| namespace OrchardCore.Media.AmazonS3; | ||
|
|
||
| internal static class AmazonS3Constants | ||
| { | ||
| internal static class ValidationMessages | ||
| { | ||
| public const string BucketNameIsEmpty = "BucketName is required attribute for S3 storage."; | ||
| public const string RegionAndServiceUrlAreEmpty = "Region or ServiceURL is a required attribute for S3 storage."; | ||
| } | ||
|
|
||
| internal static class AwsCredentialParamNames | ||
| { | ||
| public const string SecretKey = "SecretKey"; | ||
| public const string AccessKey = "AccessKey"; | ||
| } | ||
|
|
||
| internal static class ConfigSections | ||
| { | ||
| public const string AmazonS3 = "OrchardCore_Media_AmazonS3"; | ||
| public const string AmazonS3ImageSharpCache = "OrchardCore_Media_AmazonS3_ImageSharp_Cache"; | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| using Fluid; | ||
| using OrchardCore.Environment.Shell; | ||
|
|
||
| namespace OrchardCore.Media.AmazonS3.Helpers; | ||
|
|
||
| // This is almost the same as in OrchardCore.Media.Azure but there isn't really a good common place for it. | ||
MikeAlhayek marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| internal sealed class OptionsFluidParserHelper<TOptions> where TOptions : class | ||
| { | ||
| // Local instance since it can be discarded once the startup is over. | ||
| private readonly FluidParser _fluidParser = new(); | ||
| private readonly ShellSettings _shellSettings; | ||
|
|
||
| private TemplateContext _templateContext; | ||
|
|
||
| public OptionsFluidParserHelper(ShellSettings shellSettings) | ||
| { | ||
| _shellSettings = shellSettings; | ||
| } | ||
|
|
||
| public string ParseAndFormat(string template) | ||
| { | ||
| var templateContext = GetTemplateContext(); | ||
|
|
||
| // Use Fluid directly as this is transient and cannot invoke _liquidTemplateManager. | ||
| var parsedTemplate = _fluidParser.Parse(template); | ||
| return parsedTemplate.Render(templateContext, NullEncoder.Default) | ||
| .Replace("\r", string.Empty) | ||
| .Replace("\n", string.Empty) | ||
| .Trim(); | ||
| } | ||
|
|
||
| private TemplateContext GetTemplateContext() | ||
| { | ||
| if (_templateContext == null) | ||
| { | ||
| var templateOptions = new TemplateOptions(); | ||
| _templateContext = new TemplateContext(templateOptions); | ||
| templateOptions.MemberAccessStrategy.Register<ShellSettings>(); | ||
| templateOptions.MemberAccessStrategy.Register<TOptions>(); | ||
| _templateContext.SetValue("ShellSettings", _shellSettings); | ||
| } | ||
|
|
||
| return _templateContext; | ||
| } | ||
| } | ||
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
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,30 @@ | ||
| using Microsoft.Extensions.Options; | ||
| using OrchardCore.FileStorage.AmazonS3; | ||
| using SixLabors.ImageSharp.Web.Caching.AWS; | ||
|
|
||
| namespace OrchardCore.Media.AmazonS3.Services; | ||
|
|
||
| // Configuration for ImageSharp's own configuration object. We just pass the settings from the Orchard Core | ||
|
There was a problem hiding this comment. You asked about the Azure version of this previously, why that was necessary in addition to There was a problem hiding this comment. I am not sure that the comment is helpful, answer any questions or adds any value here. There was a problem hiding this comment. What comment would make it clear for you here why we need a second, seemingly unnecessary configuration class? There was a problem hiding this comment. I suggest removing it. but it's up to you. There was a problem hiding this comment. I'd keep it really because apparently it's not clear at a first glance. I can't come up with a better comment. |
||
| // configuration. | ||
| internal sealed class AWSS3StorageCacheOptionsConfiguration : IConfigureOptions<AWSS3StorageCacheOptions> | ||
| { | ||
| private readonly AwsImageSharpImageCacheOptions _options; | ||
|
|
||
| public AWSS3StorageCacheOptionsConfiguration(IOptions<AwsImageSharpImageCacheOptions> options) | ||
| { | ||
| _options = options.Value; | ||
| } | ||
|
|
||
| public void Configure(AWSS3StorageCacheOptions options) | ||
| { | ||
| var credentials = _options.AwsOptions.Credentials.GetCredentials(); | ||
|
|
||
| // Only Endpoint or Region is necessary. | ||
| options.Endpoint = _options.AwsOptions.DefaultClientConfig.ServiceURL; | ||
| options.Region = _options.AwsOptions.Region?.SystemName; | ||
| options.BucketName = _options.BucketName; | ||
| options.AccessKey = credentials.AccessKey; | ||
| options.AccessSecret = credentials.SecretKey; | ||
| options.CacheFolder = _options.BasePath; | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the same as the section on the page: https://docs.orchardcore.net/en/latest/docs/reference/#search-indexing-querying And that looks good so, since while these are tightly related topics, it's not just search (like SQL queries have nothing to do with search, but queries in general do relate to Lucene and Elasticsearch, which are about indexing, and usually, but not necessarily search...)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The term should be Search. `Indexing and Querying are implementation details for search.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indexing maybe, but Queries is about much more than search. SQL Queries (i.e. the module feature) doesn't have anything to do with search nor indexing, and you can use both Lucene and Elasticsearch querying (e.g. listing all content items with the type Blog Post) without utilizing them for full-text search. That's why I'm saying these three are tightly related, but the whole feature set is neither just search, nor just querying, nor just indexing.