Data Localization

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

@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+using System.Linq;
+using OrchardCore.Localization;
+
+namespace OrchardCore.ContentTypes.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 IEnumerable<DataLocalizedString> GetAllStrings()
+            => _contentDefinitionService.GetTypes()
+                    .SelectMany(t => t.TypeDefinition.Parts)
+                    .SelectMany(p => p.PartDefinition.Fields.Select(f => new DataLocalizedString(ContentFieldsContext, f.Name)));
+    }
+}

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

@@ -0,0 +1,21 @@
+using System.Collections.Generic;
+using System.Linq;
+using OrchardCore.Localization;
+
+namespace OrchardCore.ContentTypes.Services
+{
+    public class ContentTypeDataLocalizationProvider : ILocalizationDataProvider
+    {
+        private readonly IContentDefinitionService _contentDefinitionService;
+
+        private static readonly string ContentTypesContext = "Content Types";
+
+        public ContentTypeDataLocalizationProvider(IContentDefinitionService contentDefinitionService)
+        {
+            _contentDefinitionService = contentDefinitionService;
+        }
+
+        public IEnumerable<DataLocalizedString> GetAllStrings()
+            => _contentDefinitionService.GetTypes().Select(t => new DataLocalizedString(ContentTypesContext, t.DisplayName));
+    }
+}

src/OrchardCore.Modules/OrchardCore.ContentTypes/Startup.cs

@@ -16,6 +16,7 @@
 using OrchardCore.Navigation;
 using OrchardCore.Recipes;
 using OrchardCore.Security.Permissions;
+using OrchardCore.Localization;
 
 namespace OrchardCore.ContentTypes
 {
@@ -140,4 +141,14 @@ public override void ConfigureServices(IServiceCollection services)
             services.AddScoped<IDisplayDriver<DeploymentStep>, ContentDefinitionDeploymentStepDriver>();
         }
     }
+
+    [RequireFeatures("OrchardCore.Localization")]
+    public class LocalizationStartup : StartupBase
+    {
+        public override void ConfigureServices(IServiceCollection services)
+        {
+            services.AddTransient<ILocalizationDataProvider, ContentTypeDataLocalizationProvider>();
+            services.AddTransient<ILocalizationDataProvider, ContentFieldDataLocalizationProvider>();
+        }
+    }
 }

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

@@ -0,0 +1,43 @@
+using System;
+using System.Threading.Tasks;
+using Newtonsoft.Json.Linq;
+using OrchardCore.Deployment;
+using OrchardCore.Localization.Services;
+
+namespace OrchardCore.Localization.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 JObject();
+            var translationsDocument = await _translationsManager.GetTranslationsDocumentAsync();
+
+            foreach (var translation in translationsDocument.Translations)
+            {
+                translationObjects[translation.Key] = JObject.FromObject(translation.Values);
+            }
+
+            result.Steps.Add(new JObject(
+                new JProperty("name", "DynamicDataTranslations"),
+                new JProperty("DynamicDataTranslations", translationObjects)
+            ));
+
+            await Task.CompletedTask;
+        }
+    }
+}

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

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

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

@@ -0,0 +1,23 @@
+using OrchardCore.Deployment;
+using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.DisplayManagement.Views;
+
+namespace OrchardCore.Localization.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.Localization/Models/Translation.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+
+namespace OrchardCore.Localization.Models
+{
+    public class Translation
+    {
+        public string Context { get; set; }
+        public string Key { get; set; }
+        public IDictionary<string, string> Values { get; set; }
+    }
+}

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

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+
+namespace OrchardCore.Localization.Models
+{
+    public class TranslationsDocument
+    {
+        public int Id { get; set; }
+        public List<Translation> Translations { get; } = new List<Translation>();
+    }
+}

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

@@ -0,0 +1,39 @@
+using System;
+using System.Threading.Tasks;
+using Newtonsoft.Json.Linq;
+using OrchardCore.Recipes.Models;
+using OrchardCore.Recipes.Services;
+using OrchardCore.Localization.Models;
+using OrchardCore.Localization.Services;
+
+namespace OrchardCore.Localization.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;
+            }
+
+            if (context.Step.Property("DynamicDataTranslations").Value is JObject translations)
+            {
+                foreach (var property in translations.Properties())
+                {
+                    var name = property.Name;
+                    var value = property.Value.ToObject<Translation>();
+
+                    await _translationsManager.UpdateTranslationAsync(name, value);
+                }
+            }
+        }
+    }
+}

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

@@ -0,0 +1,12 @@
+using System.Threading.Tasks;
+using OrchardCore.Localization.Models;
+
+namespace OrchardCore.Localization.Services
+{
+    public interface ITranslationsManager
+    {
+        Task<TranslationsDocument> GetTranslationsDocumentAsync();
+
+        Task UpdateTranslationAsync(string name, Translation template);
+    }
+}

src/OrchardCore.Modules/OrchardCore.Localization/Services/TranslationsManager.cs

@@ -0,0 +1,23 @@
+using System.Threading.Tasks;
+using OrchardCore.Localization.Models;
+
+namespace OrchardCore.Localization.Services
+{
+    public class TranslationsManager : ITranslationsManager
+    {
+        public async Task<TranslationsDocument> GetTranslationsDocumentAsync()
+        {
+            // TODO: Fetch the translations from the database
+            var document = new TranslationsDocument();
+            await Task.CompletedTask;
+
+            return document;
+        }
+
+        public async Task UpdateTranslationAsync(string name, Translation template)
+        {
+            // TODO: update the translations into the database
+            await Task.CompletedTask;
+        }
+    }
+}

src/OrchardCore.Modules/OrchardCore.Localization/Startup.cs

@@ -4,11 +4,15 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Options;
+using OrchardCore.Deployment;
 using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.Localization.Deployment;
 using OrchardCore.Localization.Drivers;
+using OrchardCore.Localization.Recipes;
 using OrchardCore.Localization.Services;
 using OrchardCore.Modules;
 using OrchardCore.Navigation;
+using OrchardCore.Recipes;
 using OrchardCore.Security.Permissions;
 using OrchardCore.Settings;
 
@@ -31,6 +35,13 @@ public override void ConfigureServices(IServiceCollection services)
 
             services.AddPortableObjectLocalization(options => options.ResourcesPath = "Localization");
             services.Replace(ServiceDescriptor.Singleton<ILocalizationFileLocationProvider, ModularPoFileLocationProvider>());
+
+            services.AddScoped<TranslationsManager>();
+            services.AddRecipeExecutionStep<TranslationsStep>();
+
+            services.AddTransient<IDeploymentSource, AllDataTranslationsDeploymentSource>();
+            services.AddSingleton<IDeploymentStepFactory>(new DeploymentStepFactory<AllDataTranslationsDeploymentStep>());
+            services.AddScoped<IDisplayDriver<DeploymentStep>, AllDataTranslationsDeploymentStepDriver>();
         }
 
         /// <inheritdocs />

src/OrchardCore.Modules/OrchardCore.Localization/Views/Items/AllDataTranslationsDeploymentStep.Edit.cshtml

@@ -0,0 +1,3 @@
+@model dynamic
+
+<h5>@T["Dynamic Data Translations"]</h5>

src/OrchardCore.Modules/OrchardCore.Localization/Views/Items/AllDataTranslationsDeploymentStep.Summary.cshtml

@@ -0,0 +1,5 @@
+@model dynamic
+
+<h5>@T["Dynamic Data Translations"]</h5>
+
+<span class="hint">@T["Adds all data translations to the plan."]</span>

src/OrchardCore.Modules/OrchardCore.Localization/Views/Items/AllDataTranslationsDeploymentStep.Thumbnail.cshtml

@@ -0,0 +1,4 @@
+@model dynamic
+
+<h4 class="card-title">@T["Dynamic Data Translations"]</h4>
+<p>@T["Exports all data translations."]</p>

src/OrchardCore/OrchardCore.Abstractions/Localization/DataLocalizedString.cs

@@ -0,0 +1,17 @@
+namespace OrchardCore.Localization
+{
+    public class DataLocalizedString
+    {
+        public DataLocalizedString(string context, string name)
+        {
+            Context = context;
+            Name = name;
+        }
+
+        public string Context { get; }
+
+        public string Name { get; }
+
+        public override string ToString() => $"{Context}-{Name}";
+    }
+}

src/OrchardCore/OrchardCore.Abstractions/Localization/ILocalizationDataProvider.cs

@@ -0,0 +1,9 @@
+using System.Collections.Generic;
+
+namespace OrchardCore.Localization
+{
+    public interface ILocalizationDataProvider
+    {
+        IEnumerable<DataLocalizedString> GetAllStrings();
+    }
+}

src/OrchardCore/OrchardCore.Localization.Abstractions/DataLocalizer.cs

@@ -0,0 +1,31 @@
+using System;
+using System.Collections.Generic;
+using System.Globalization;
+using Microsoft.Extensions.Localization;
+
+namespace OrchardCore.Localization
+{
+    public class DataLocalizer : IDataLocalizer
+    {
+        private IDataLocalizer _localizer;
+
+        public DataLocalizer(IDataLocalizerFactory factory)
+        {
+            if (factory == null)
+            {
+                throw new ArgumentNullException(nameof(factory));
+            }
+
+            _localizer = factory.Create();
+        }
+
+        public LocalizedString this[string name] => _localizer[name];
+
+        public LocalizedString this[string name, params object[] arguments] => _localizer[name, arguments];
+
+        public IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures)
+            => _localizer.GetAllStrings(includeParentCultures);
+
+        public IStringLocalizer WithCulture(CultureInfo culture) => _localizer;
+    }
+}

src/OrchardCore/OrchardCore.Localization.Abstractions/IDataLocalizer.cs

@@ -0,0 +1,9 @@
+using Microsoft.Extensions.Localization;
+
+namespace OrchardCore.Localization
+{
+    public interface IDataLocalizer : IStringLocalizer
+    {
+
+    }
+}

src/OrchardCore/OrchardCore.Localization.Abstractions/IDataLocalizerFactory.cs

@@ -0,0 +1,7 @@
+namespace OrchardCore.Localization
+{
+    public interface IDataLocalizerFactory
+    {
+        IDataLocalizer Create();
+    }
+}