Data Localization

OrchardCore.sln

@@ -418,6 +418,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Search.Elastics
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Search.Elasticsearch", "src\OrchardCore.Modules\OrchardCore.Search.Elasticsearch\OrchardCore.Search.Elasticsearch.csproj", "{B6A54EA8-F285-436D-8257-6F6EDE4C3339}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.DataLocalization", "src\OrchardCore.Modules\OrchardCore.DataLocalization\OrchardCore.DataLocalization.csproj", "{64598086-231E-40F9-8163-1042A0533697}"
+EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Data.YesSql", "src\OrchardCore\OrchardCore.Data.YesSql\OrchardCore.Data.YesSql.csproj", "{F06E4E20-3675-4BA5-AD2D-4538FAB154D5}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OrchardCore.Data.YesSql.Abstractions", "src\OrchardCore\OrchardCore.Data.YesSql.Abstractions\OrchardCore.Data.YesSql.Abstractions.csproj", "{AB47A65C-7BA9-4CE7-BA73-285EB7A2CEFD}"
@@ -1340,6 +1342,10 @@ Global
 		{19594A96-A033-4820-820B-C6186D00D507}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{19594A96-A033-4820-820B-C6186D00D507}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{19594A96-A033-4820-820B-C6186D00D507}.Release|Any CPU.Build.0 = Release|Any CPU
+		{64598086-231E-40F9-8163-1042A0533697}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{64598086-231E-40F9-8163-1042A0533697}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{64598086-231E-40F9-8163-1042A0533697}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{64598086-231E-40F9-8163-1042A0533697}.Release|Any CPU.Build.0 = Release|Any CPU
 		{91CED599-45B1-474D-A7F2-231BF857A5F2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{91CED599-45B1-474D-A7F2-231BF857A5F2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{91CED599-45B1-474D-A7F2-231BF857A5F2}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -1634,6 +1640,7 @@ Global
 		{307AA9CB-D62E-4E30-B715-53E3BF535D94} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{2A6E7DF9-E417-42F8-94F7-0060E252E4D6} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{19594A96-A033-4820-820B-C6186D00D507} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
+		{64598086-231E-40F9-8163-1042A0533697} = {A066395F-6F73-45DC-B5A6-B4E306110DCE}
 		{91CED599-45B1-474D-A7F2-231BF857A5F2} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{C61CC748-39BD-4900-9FEE-A2483259573D} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}
 		{2D93F509-1FB3-4E22-92F0-588D0EFBA921} = {F23AC6C2-DE44-4699-999D-3C478EF3D691}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Deployment/AllDataTranslationsDeploymentSource.cs

@@ -0,0 +1,43 @@
+using System;
+using System.Text.Json.Nodes;
+using System.Threading.Tasks;
+using OrchardCore.DataLocalization.Services;
+using OrchardCore.Deployment;
+
+namespace OrchardCore.DataLocalization.Deployment;
+
+public class AllDataTranslationsDeploymentSource : IDeploymentSource
+{
+    private readonly TranslationsManager _translationsManager;
+
+    public AllDataTranslationsDeploymentSource(TranslationsManager translationsManager)
+    {
+        _translationsManager = translationsManager ?? throw new ArgumentNullException(nameof(translationsManager));
+    }
+
+    public async Task ProcessDeploymentStepAsync(DeploymentStep step, DeploymentPlanResult result)
+    {
+        var allDataTranslationsState = step as AllDataTranslationsDeploymentStep;
+
+        if (allDataTranslationsState == null)
+        {
+            return;
+        }
+
+        var translationObjects = new JsonArray();
+        var translationsDocument = await _translationsManager.GetTranslationsDocumentAsync();
+
+        foreach (var translation in translationsDocument.Translations)
+        {
+            translationObjects[translation.Key] = JObject.FromObject(translation.Value);
+        }
+
+        result.Steps.Add(new JsonObject
+        {
+            ["name"] = "DynamicDataTranslations",
+            ["DynamicDataTranslations"] = translationObjects,
+        });
+
+        await Task.CompletedTask;
+    }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Deployment/AllDataTranslationsDeploymentStep.cs

@@ -0,0 +1,11 @@
+using OrchardCore.Deployment;
+
+namespace OrchardCore.DataLocalization.Deployment;
+
+public class AllDataTranslationsDeploymentStep : DeploymentStep
+{
+    public AllDataTranslationsDeploymentStep()
+    {
+        Name = "AllDataTranslations";
+    }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Deployment/AllDataTranslationsDeploymentStepDriver.cs

@@ -0,0 +1,23 @@
+using OrchardCore.Deployment;
+using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.DisplayManagement.Views;
+
+namespace OrchardCore.DataLocalization.Deployment
+{
+    public class AllDataTranslationsDeploymentStepDriver : DisplayDriver<DeploymentStep, AllDataTranslationsDeploymentStep>
+    {
+        public override IDisplayResult Display(AllDataTranslationsDeploymentStep step)
+        {
+            return
+                Combine(
+                    View("AllDataTranslationsDeploymentStep_Summary", step).Location("Summary", "Content"),
+                    View("AllDataTranslationsDeploymentStep_Thumbnail", step).Location("Thumbnail", "Content")
+                );
+        }
+
+        public override IDisplayResult Edit(AllDataTranslationsDeploymentStep step)
+        {
+            return View("AllDataTranslationsDeploymentStep_Edit", step).Location("Content");
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Manifest.cs

@@ -0,0 +1,11 @@
+using OrchardCore.Modules.Manifest;
+
+[assembly: Module(
+    Name = "Data Localization",
+    Author = ManifestConstants.OrchardCoreTeam,
+    Website = ManifestConstants.OrchardCoreWebsite,
+    Version = ManifestConstants.OrchardCoreVersion,
+    Description = "Provides support for data localization.",
+    Category = "Internationalization",
+    Dependencies = new[] { "OrchardCore.Localization" }
+)]

src/OrchardCore.Modules/OrchardCore.DataLocalization/Models/Translation.cs

@@ -0,0 +1,10 @@
+namespace OrchardCore.DataLocalization.Models;
+
+public class Translation
+{
+    public string Context { get; set; }
+
+    public string Key { get; set; }
+
+    public string Value { get; set; }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Models/TranslationsDocument.cs

@@ -0,0 +1,15 @@
+using System;
+using System.Collections.Generic;
+using OrchardCore.Data.Documents;
+
+namespace OrchardCore.DataLocalization.Models;
+
+public class TranslationsDocument : Document
+{
+    public TranslationsDocument()
+    {
+        Translations = new Dictionary<string, IEnumerable<Translation>>(StringComparer.OrdinalIgnoreCase);
+    }
+
+    public Dictionary<string, IEnumerable<Translation>> Translations { get; }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/OrchardCore.DataLocalization.csproj

@@ -0,0 +1,31 @@
+<Project Sdk="Microsoft.NET.Sdk.Razor">
+
+  <PropertyGroup>
+    <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
+    <!-- NuGet properties-->
+    <Title>OrchardCore Data Localization</Title>
+    <Description>$(OCFrameworkDescription)
+
+    Provides the infrastructure necessary to support localized data string.
+    </Description>
+    <PackageTags>$(PackageTags) OrchardCoreFramework Localization</PackageTags>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <FrameworkReference Include="Microsoft.AspNetCore.App" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Apis.GraphQL.Abstractions\OrchardCore.Apis.GraphQL.Abstractions.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Deployment.Abstractions\OrchardCore.Deployment.Abstractions.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.DisplayManagement\OrchardCore.DisplayManagement.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Localization.Abstractions\OrchardCore.Localization.Abstractions.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Localization.Core\OrchardCore.Localization.Core.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Module.Targets\OrchardCore.Module.Targets.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Navigation.Core\OrchardCore.Navigation.Core.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.ResourceManagement\OrchardCore.ResourceManagement.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Settings.Core\OrchardCore.Settings.Core.csproj" />
+    <ProjectReference Include="..\OrchardCore.ContentTypes\OrchardCore.ContentTypes.csproj" />
+  </ItemGroup>
+
+</Project>

src/OrchardCore.Modules/OrchardCore.DataLocalization/Permissions.cs

@@ -0,0 +1,33 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using OrchardCore.Security.Permissions;
+
+namespace OrchardCore.DataLocalization;
+
+/// <summary>
+/// Represents the localization module permissions.
+/// </summary>
+public class Permissions : IPermissionProvider
+{
+    /// <summary>
+    /// Gets a permission for managing the cultures.
+    /// </summary>
+    public static readonly Permission ManageLocalization = new("ManageLocalization", "Manage dynamic localizations");
+
+    private readonly IEnumerable<Permission> _allPermissions =
+    [
+        ManageLocalization
+    ];
+
+    public Task<IEnumerable<Permission>> GetPermissionsAsync()
+        => Task.FromResult(_allPermissions);
+
+    public IEnumerable<PermissionStereotype> GetDefaultStereotypes() =>
+    [
+        new PermissionStereotype
+        {
+            Name = "Administrator",
+            Permissions = _allPermissions,
+        },
+    ];
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Recipes/TranslationsStep.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Text.Json.Nodes;
+using System.Threading.Tasks;
+using OrchardCore.DataLocalization.Models;
+using OrchardCore.DataLocalization.Services;
+using OrchardCore.Recipes.Models;
+using OrchardCore.Recipes.Services;
+
+namespace OrchardCore.DataLocalization.Recipes;
+
+public class TranslationsStep : IRecipeStepHandler
+{
+    private readonly TranslationsManager _translationsManager;
+
+    public TranslationsStep(TranslationsManager translationsManager)
+    {
+        _translationsManager = translationsManager;
+    }
+
+    public async Task ExecuteAsync(RecipeExecutionContext context)
+    {
+        if (!string.Equals(context.Name, "DynamicDataTranslations", StringComparison.OrdinalIgnoreCase))
+        {
+            return;
+        }
+
+        var model = context.Step.ToObject<TranslationsStepModel>();
+
+        foreach (var importedTranslation in model.Translations)
+        {
+            if (string.IsNullOrWhiteSpace(importedTranslation.Name))
+            {
+                continue;
+            }
+
+            await _translationsManager.UpdateTranslationAsync(importedTranslation.Name, new[] { importedTranslation.Translation });
+        }
+    }
+
+    public class TranslationsStepModel
+    {
+        public TranslationsStepRoleModel[] Translations { get; set; }
+    }
+}
+
+public class TranslationsStepRoleModel
+{
+    public string Name { get; set; }
+
+    public Translation Translation { get; set; }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Services/ContentFieldLocalizationDataProvider.cs

@@ -0,0 +1,25 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using OrchardCore.ContentTypes.Services;
+using OrchardCore.Localization.Data;
+
+namespace OrchardCore.DataLocalization.Services;
+
+public class ContentFieldDataLocalizationProvider : ILocalizationDataProvider
+{
+    private readonly IContentDefinitionService _contentDefinitionService;
+
+    private static readonly string _contentFieldsContext = "Content Fields";
+
+    public ContentFieldDataLocalizationProvider(IContentDefinitionService contentDefinitionService)
+    {
+        _contentDefinitionService = contentDefinitionService;
+    }
+
+    // TODO: Check if there's a better way to get the fields
+    public async Task<IEnumerable<DataLocalizedString>> GetDescriptorsAsync()
+        => (await _contentDefinitionService.GetTypesAsync())
+            .SelectMany(t => t.TypeDefinition.Parts)
+            .SelectMany(p => p.PartDefinition.Fields.Select(f => new DataLocalizedString(_contentFieldsContext, f.Name)));
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Services/ContentTypeLocalizationDataProvider.cs

@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using OrchardCore.ContentTypes.Services;
+using OrchardCore.Localization.Data;
+
+namespace OrchardCore.DataLocalization.Services;
+
+public class ContentTypeDataLocalizationProvider : ILocalizationDataProvider
+{
+    private readonly IContentDefinitionService _contentDefinitionService;
+
+    private static readonly string _contentTypesContext = "Content Types";
+
+    public ContentTypeDataLocalizationProvider(IContentDefinitionService contentDefinitionService)
+    {
+        _contentDefinitionService = contentDefinitionService;
+    }
+
+    public async Task<IEnumerable<DataLocalizedString>> GetDescriptorsAsync()
+        => (await _contentDefinitionService.GetTypesAsync())
+            .Select(t => new DataLocalizedString(_contentTypesContext, t.DisplayName));
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Services/DataTranslationProvider.cs

@@ -0,0 +1,35 @@
+using Microsoft.Extensions.DependencyInjection;
+using OrchardCore.Localization.Data;
+using OrchardCore.Localization;
+using System.Linq;
+
+namespace OrchardCore.DataLocalization.Services;
+
+public class DataTranslationProvider : IDataTranslationProvider
+{
+    private readonly IServiceScopeFactory _scopeFactory;
+
+    public DataTranslationProvider(IServiceScopeFactory scopeFactory)
+    {
+        _scopeFactory = scopeFactory;
+    }
+
+    /// <inheritdoc/>
+    public void LoadTranslations(string cultureName, CultureDictionary dictionary)
+    {
+        using (var scope = _scopeFactory.CreateScope())
+        {
+            var translationsManager = scope.ServiceProvider.GetService<TranslationsManager>();
+
+            var translationsDocument = translationsManager.GetTranslationsDocumentAsync().Result;
+
+            if (translationsDocument.Translations.ContainsKey(cultureName))
+            {
+                var records = translationsDocument.Translations[cultureName]
+                    .Select(t => new CultureDictionaryRecord(t.Key, t.Context, new[] { t.Value }));
+
+                dictionary.MergeTranslations(records);
+            }
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.DataLocalization/Services/ITranslationsManager.cs

@@ -0,0 +1,16 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using OrchardCore.DataLocalization.Models;
+
+namespace OrchardCore.DataLocalization.Services;
+
+public interface ITranslationsManager
+{
+    Task<TranslationsDocument> LoadTranslationsDocumentAsync();
+
+    Task<TranslationsDocument> GetTranslationsDocumentAsync();
+
+    Task RemoveTranslationAsync(string name);
+
+    Task UpdateTranslationAsync(string name, IEnumerable<Translation> translations);
+}