lsm/Orchard
1
0
Fork 0
mirror of https://github.com/OrchardCMS/Orchard.git synced 2025-04-05 21:01:35 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Removed copy of SetupService from ImportExport.

Browse Source 
Refactored ISetupService and SetupContext to work with an actual Recipe object so that client code can control what recipe to use.
This commit is contained in:
Sipke Schoorstra 2015-09-07 17:29:30 +01:00
parent 999a10b6e4
commit 7ba273b4c4
16 changed files with 100 additions and 244 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/Orchard.Tests/Orchard.Framework.Tests.csproj
View File

@ -294,6 +294,7 @@
<Compile Include="Stubs\StubVirtualPathMonitor.cs" />
<Compile Include="Stubs\StubCacheManager.cs" />
<Compile Include="Stubs\StubWebSiteFolder.cs" />
<Compile Include="Stubs\StubWorkContextScope.cs" />
<Compile Include="Tasks\DistributedLockServiceTests.cs" />
<Compile Include="Time\TimeZoneSelectorTests.cs" />
<Compile Include="UI\Resources\ResourceManagerTests.cs" />

6
src/Orchard.Tests/Stubs/StubWorkContextAccessor.cs
View File

@ -13,7 +13,7 @@ namespace Orchard.Tests.Stubs {
public StubWorkContextAccessor(ILifetimeScope lifetimeScope) {
_lifetimeScope = lifetimeScope;
_workContext = new WorkContextImpl(_lifetimeScope);
_workContext = new WorkContextImpl(lifetimeScope);
}
public class WorkContextImpl : WorkContext {
@ -149,7 +149,9 @@ namespace Orchard.Tests.Stubs {
}
public IWorkContextScope CreateWorkContextScope() {
throw new NotSupportedException();
var workLifetime = _lifetimeScope.BeginLifetimeScope("work");
var workContext = new WorkContextImpl(workLifetime);
return new StubWorkContextScope(workContext, workLifetime);
}
}
}

26
src/Orchard.Tests/Stubs/StubWorkContextScope.cs Normal file
View File

@ -0,0 +1,26 @@
using Autofac;
namespace Orchard.Tests.Stubs {
public class StubWorkContextScope : IWorkContextScope {
private readonly ILifetimeScope _lifetimeScope;
public StubWorkContextScope(WorkContext workContext, ILifetimeScope lifetimeScope) {
_lifetimeScope = lifetimeScope;
WorkContext = workContext;
}
public WorkContext WorkContext { get; }
public void Dispose() {
_lifetimeScope.Dispose();
}
public TService Resolve<TService>() {
return WorkContext.Resolve<TService>();
}
public bool TryResolve<TService>(out TService service) {
return WorkContext.TryResolve(out service);
}
}
}

15
src/Orchard.Web/Modules/Orchard.ImportExport/Models/SetupContext.cs
View File

@ -1,15 +0,0 @@
using System.Collections.Generic;
using System.Xml.Linq;
namespace Orchard.ImportExport.Models {
public class SetupContext {
public string SiteName { get; set; }
public string AdminUsername { get; set; }
public string AdminPassword { get; set; }
public string DatabaseProvider { get; set; }
public string DatabaseConnectionString { get; set; }
public string DatabaseTablePrefix { get; set; }
public IEnumerable<string> EnabledFeatures { get; set; }
public XDocument RecipeDocument { get; set; }
}
}

2
src/Orchard.Web/Modules/Orchard.ImportExport/Module.txt
View File

@ -11,4 +11,4 @@ Features:
Name: Import Export
Description: Imports and exports content item data.
Category: Content
Dependencies: Orchard.jQuery, Orchard.Recipes
Dependencies: Orchard.jQuery, Orchard.Recipes, Orchard.Setup.Services

7
src/Orchard.Web/Modules/Orchard.ImportExport/Orchard.ImportExport.csproj
View File

@ -90,9 +90,6 @@
<Compile Include="Services\DatabaseManager.cs" />
<Compile Include="Services\IDatabaseManager.cs" />
<Compile Include="ViewModels\RecipeExecutionStepViewModel.cs" />
<Compile Include="Services\ISetupService.cs" />
<Compile Include="Models\SetupContext.cs" />
<Compile Include="Services\SetupService.cs" />
<Compile Include="ViewModels\UploadRecipeViewModel.cs" />
<Compile Include="Providers\ImportActions\ExecuteRecipeAction.cs" />
<Compile Include="Recipes\Builders\CustomStepsStep.cs" />
@ -139,6 +136,10 @@
<Project>{fc1d74e8-7a4d-48f4-83de-95c6173780c4}</Project>
<Name>Orchard.Recipes</Name>
</ProjectReference>
<ProjectReference Include="..\Orchard.Setup\Orchard.Setup.csproj">
<Project>{8c7fcbc2-e6e1-405e-bfb5-d8d9e67a09c4}</Project>
<Name>Orchard.Setup</Name>
</ProjectReference>
</ItemGroup>
<ItemGroup>
<Content Include="Styles\images\menu.importexport.png" />

3
src/Orchard.Web/Modules/Orchard.ImportExport/Providers/ImportActions/ExecuteRecipeAction.cs
View File

@ -12,6 +12,7 @@ using Orchard.ImportExport.ViewModels;
using Orchard.Mvc;
using Orchard.Recipes.Models;
using Orchard.Recipes.Services;
using Orchard.Setup.Services;
using Orchard.Tasks;
using Orchard.UI.Notify;
@ -181,7 +182,7 @@ namespace Orchard.ImportExport.Providers.ImportActions {
private string Setup(XDocument recipeDocument) {
// Prepare Setup.
var setupContext = new SetupContext {
RecipeDocument = recipeDocument,
Recipe = _recipeParser.ParseRecipe(recipeDocument),
AdminPassword = SuperUserPassword,
AdminUsername = _orchardServices.WorkContext.CurrentSite.SuperUser,
DatabaseConnectionString = _shellSettings.DataConnectionString,

7
src/Orchard.Web/Modules/Orchard.ImportExport/Services/ISetupService.cs
View File

@ -1,7 +0,0 @@
using Orchard.ImportExport.Models;
namespace Orchard.ImportExport.Services {
public interface ISetupService : IDependency {
string Setup(SetupContext context);
}
}

180
src/Orchard.Web/Modules/Orchard.ImportExport/Services/SetupService.cs
View File

@ -1,180 +0,0 @@
using System;
using System.Linq;
using System.Security.Cryptography;
using System.Web;
using Orchard.ContentManagement;
using Orchard.Core.Settings.Models;
using Orchard.Data;
using Orchard.Data.Migration;
using Orchard.Data.Migration.Interpreters;
using Orchard.Data.Migration.Schema;
using Orchard.Environment;
using Orchard.Environment.Configuration;
using Orchard.Environment.Descriptor;
using Orchard.Environment.Descriptor.Models;
using Orchard.Environment.ShellBuilders;
using Orchard.Environment.State;
using Orchard.ImportExport.Models;
using Orchard.Localization.Services;
using Orchard.Logging;
using Orchard.Recipes.Services;
using Orchard.Security;
using Orchard.Settings;
using Orchard.Utility.Extensions;
namespace Orchard.ImportExport.Services
{
public class SetupService : Component, ISetupService {
private readonly ShellSettings _shellSettings;
private readonly IOrchardHost _orchardHost;
private readonly IShellSettingsManager _shellSettingsManager;
private readonly IShellContainerFactory _shellContainerFactory;
private readonly ICompositionStrategy _compositionStrategy;
private readonly IProcessingEngine _processingEngine;
public SetupService(
ShellSettings shellSettings,
IOrchardHost orchardHost,
IShellSettingsManager shellSettingsManager,
IShellContainerFactory shellContainerFactory,
ICompositionStrategy compositionStrategy,
IProcessingEngine processingEngine) {
_shellSettings = shellSettings;
_orchardHost = orchardHost;
_shellSettingsManager = shellSettingsManager;
_shellContainerFactory = shellContainerFactory;
_compositionStrategy = compositionStrategy;
_processingEngine = processingEngine;
}
public string Setup(SetupContext context) {
string executionId;
Logger.Information("Running setup for tenant '{0}'.", _shellSettings.Name);
// The vanilla Orchard distibution has the following features enabled.
string[] hardcoded = {
// Framework
"Orchard.Framework",
// Core
"Common", "Containers", "Contents", "Dashboard", "Feeds", "Navigation","Scheduling", "Settings", "Shapes", "Title",
// Modules
"Orchard.Pages", "Orchard.ContentPicker", "Orchard.Themes", "Orchard.Users", "Orchard.Roles", "Orchard.Modules",
"PackagingServices", "Orchard.Packaging", "Gallery", "Orchard.Recipes"
};
context.EnabledFeatures = hardcoded.Union(context.EnabledFeatures ?? Enumerable.Empty<string>()).Distinct().ToList();
var shellSettings = new ShellSettings(_shellSettings);
if (String.IsNullOrEmpty(shellSettings.DataProvider)) {
shellSettings.DataProvider = context.DatabaseProvider;
shellSettings.DataConnectionString = context.DatabaseConnectionString;
shellSettings.DataTablePrefix = context.DatabaseTablePrefix;
}
shellSettings.EncryptionAlgorithm = "AES";
shellSettings.EncryptionKey = SymmetricAlgorithm.Create(shellSettings.EncryptionAlgorithm).Key.ToHexString();
shellSettings.HashAlgorithm = "HMACSHA256";
shellSettings.HashKey = HMAC.Create(shellSettings.HashAlgorithm).Key.ToHexString();
var shellDescriptor = new ShellDescriptor {
Features = context.EnabledFeatures.Select(name => new ShellFeature { Name = name })
};
var shellBlueprint = _compositionStrategy.Compose(shellSettings, shellDescriptor);
// Initialize database explicitly, and store shell descriptor.
using (var bootstrapLifetimeScope = _shellContainerFactory.CreateContainer(shellSettings, shellBlueprint)) {
using (var environment = bootstrapLifetimeScope.CreateWorkContextScope()) {
// Workaround to avoid a Transaction issue with PostgreSQL.
environment.Resolve<ITransactionManager>().RequireNew();
var schemaBuilder = new SchemaBuilder(environment.Resolve<IDataMigrationInterpreter>());
schemaBuilder.CreateTable("Orchard_Framework_DataMigrationRecord", table => table
.Column<int>("Id", column => column.PrimaryKey().Identity())
.Column<string>("DataMigrationClass")
.Column<int>("Version"));
schemaBuilder.AlterTable("Orchard_Framework_DataMigrationRecord",
table => table.AddUniqueConstraint("UC_DMR_DataMigrationClass_Version", "DataMigrationClass", "Version"));
var dataMigrationManager = environment.Resolve<IDataMigrationManager>();
dataMigrationManager.Update("Settings");
foreach (var feature in context.EnabledFeatures) {
dataMigrationManager.Update(feature);
}
var descriptorManager = environment.Resolve<IShellDescriptorManager>();
descriptorManager.UpdateShellDescriptor(0, shellDescriptor.Features, shellDescriptor.Parameters);
}
}
// In effect "pump messages" see PostMessage circa 1980.
while ( _processingEngine.AreTasksPending() )
_processingEngine.ExecuteNextTask();
// Create a standalone environment.
// Must mark state as Running - otherwise standalone environment is created "for setup".
shellSettings.State = TenantState.Running;
using (var environment = _orchardHost.CreateStandaloneEnvironment(shellSettings)) {
try {
executionId = CreateTenantData(context, environment);
}
catch {
environment.Resolve<ITransactionManager>().Cancel();
throw;
}
}
_shellSettingsManager.SaveSettings(shellSettings);
return executionId;
}
private string CreateTenantData(SetupContext context, IWorkContextScope environment) {
// Create superuser.
var membershipService = environment.Resolve<IMembershipService>();
var user = membershipService.CreateUser(
new CreateUserParams(
context.AdminUsername,
context.AdminPassword,
email: String.Empty,
passwordQuestion: String.Empty,
passwordAnswer: String.Empty,
isApproved: true));
// Set superuser as current user for request (it will be set as the owner of all content items).
var authenticationService = environment.Resolve<IAuthenticationService>();
authenticationService.SetAuthenticatedUserForRequest(user);
// Set site name and settings.
var siteService = environment.Resolve<ISiteService>();
var siteSettings = siteService.GetSiteSettings().As<SiteSettingsPart>();
siteSettings.SiteSalt = Guid.NewGuid().ToString("N");
siteSettings.SiteName = context.SiteName;
siteSettings.SuperUser = context.AdminUsername;
siteSettings.SiteCulture = "en-US";
// Add default culture.
var cultureManager = environment.Resolve<ICultureManager>();
cultureManager.AddCulture("en-US");
// Execute recipe
var recipeParser = environment.Resolve<IRecipeParser>();
var recipe = recipeParser.ParseRecipe(context.RecipeDocument);
var recipeManager = environment.Resolve<IRecipeManager>();
var executionId = recipeManager.Execute(recipe);
// Null check: temporary fix for running setup in command line.
if (HttpContext.Current != null) {
authenticationService.SignIn(user, true);
}
return executionId;
}
}
}

41
src/Orchard.Web/Modules/Orchard.Recipes/Services/RecipeHarvester.cs
View File

@ -3,6 +3,7 @@ using System.Collections.Generic;
using System.IO;
using System.Linq;
using Orchard.Environment.Extensions;
using Orchard.Environment.Extensions.Models;
using Orchard.FileSystems.WebSite;
using Orchard.Localization;
using Orchard.Logging;
@ -29,27 +30,35 @@ namespace Orchard.Recipes.Services {
public Localizer T { get; set; }
public ILogger Logger { get; set; }
public IEnumerable<Recipe> HarvestRecipes(string extensionId) {
var recipes = new List<Recipe>();
public IEnumerable<Recipe> HarvestRecipes() {
return _extensionManager.AvailableExtensions().SelectMany(HarvestRecipes);
}
public IEnumerable<Recipe> HarvestRecipes(string extensionId) {
var extension = _extensionManager.GetExtension(extensionId);
if (extension != null) {
var recipeLocation = Path.Combine(extension.Location, extensionId, "Recipes");
var recipeFiles = _webSiteFolder.ListFiles(recipeLocation, true);
recipeFiles.Where(r => r.EndsWith(".recipe.xml", StringComparison.OrdinalIgnoreCase)).ToList().ForEach(r => {
try {
recipes.Add(_recipeParser.ParseRecipe(_webSiteFolder.ReadFile(r)));
}
catch (Exception ex) {
Logger.Error(ex, "Error while parsing recipe file '{0}'.", r);
}
});
}
else {
Logger.Error("Could not discover recipes because module '{0}' was not found.", extensionId);
return HarvestRecipes(extension);
}
Logger.Error("Could not discover recipes because module '{0}' was not found.", extensionId);
return Enumerable.Empty<Recipe>();
}
private IEnumerable<Recipe> HarvestRecipes(ExtensionDescriptor extension) {
var recipes = new List<Recipe>();
var recipeLocation = Path.Combine(extension.Location, extension.Id, "Recipes");
var recipeFiles = _webSiteFolder.ListFiles(recipeLocation, true);
recipeFiles.Where(r => r.EndsWith(".recipe.xml", StringComparison.OrdinalIgnoreCase)).ToList().ForEach(r => {
try {
recipes.Add(_recipeParser.ParseRecipe(_webSiteFolder.ReadFile(r)));
}
catch (Exception ex) {
Logger.Error(ex, "Error while parsing recipe file '{0}'.", r);
}
});
return recipes;
}
}

8
src/Orchard.Web/Modules/Orchard.Setup/Commands/SetupCommand.cs
View File

@ -2,14 +2,17 @@
using System.Collections.Generic;
using System.Linq;
using Orchard.Commands;
using Orchard.Recipes.Services;
using Orchard.Setup.Services;
namespace Orchard.Setup.Commands {
public class SetupCommand : DefaultOrchardCommandHandler {
private readonly ISetupService _setupService;
private readonly IRecipeHarvester _recipeHarvester;
public SetupCommand(ISetupService setupService) {
public SetupCommand(ISetupService setupService, IRecipeHarvester recipeHarvester) {
_setupService = setupService;
_recipeHarvester = recipeHarvester;
}
[OrchardSwitch]
@ -51,6 +54,7 @@ namespace Orchard.Setup.Commands {
.Where(s => !String.IsNullOrEmpty(s));
}
Recipe = String.IsNullOrEmpty(Recipe) ? "Default" : Recipe;
var recipe = _setupService.Recipes().GetRecipeByName(Recipe);
var setupContext = new SetupContext {
SiteName = SiteName,
@ -60,7 +64,7 @@ namespace Orchard.Setup.Commands {
DatabaseConnectionString = DatabaseConnectionString,
DatabaseTablePrefix = DatabaseTablePrefix,
EnabledFeatures = enabledFeatures,
Recipe = Recipe,
Recipe = recipe,
};
var executionId = _setupService.Setup(setupContext);

4
src/Orchard.Web/Modules/Orchard.Setup/Controllers/SetupController.cs
View File

@ -7,6 +7,7 @@ using Orchard.Logging;
using Orchard.Setup.Services;
using Orchard.Setup.ViewModels;
using Orchard.Localization;
using Orchard.Recipes.Services;
using Orchard.Themes;
using Orchard.UI.Notify;
@ -137,6 +138,7 @@ namespace Orchard.Setup.Controllers {
throw new ApplicationException("Unknown database type: " + model.DatabaseProvider);
}
var recipe = _setupService.Recipes().GetRecipeByName(model.Recipe);
var setupContext = new SetupContext {
SiteName = model.SiteName,
AdminUsername = model.AdminUsername,
@ -145,7 +147,7 @@ namespace Orchard.Setup.Controllers {
DatabaseConnectionString = model.DatabaseConnectionString,
DatabaseTablePrefix = model.DatabaseTablePrefix,
EnabledFeatures = null, // Default list
Recipe = model.Recipe
Recipe = recipe
};
var executionId = _setupService.Setup(setupContext);

6
src/Orchard.Web/Modules/Orchard.Setup/Module.txt
View File

@ -6,3 +6,9 @@ OrchardVersion: 1.9
Description: The setup module is creating the application's setup experience.
FeatureDescription: Standard site setup. This feature is disabled automatically once setup is over.
Category: Core
Dependencies: Orchard.Setup.Services
Features:
Orchard.Setup.Services
Name: Setup Services
Description: Provides programmatic APIs to the setup service.
Category: Core

3
src/Orchard.Web/Modules/Orchard.Setup/Services/SetupContext.cs
View File

@ -1,4 +1,5 @@
using System.Collections.Generic;
using Orchard.Recipes.Models;
namespace Orchard.Setup.Services {
public class SetupContext {
@ -9,6 +10,6 @@ namespace Orchard.Setup.Services {
public string DatabaseConnectionString { get; set; }
public string DatabaseTablePrefix { get; set; }
public IEnumerable<string> EnabledFeatures { get; set; }
public string Recipe { get; set; }
public Recipe Recipe { get; set; }
}
}

17
src/Orchard.Web/Modules/Orchard.Setup/Services/SetupService.cs
View File

@ -26,6 +26,7 @@ using Orchard.Settings;
using Orchard.Utility.Extensions;
namespace Orchard.Setup.Services {
[OrchardFeature("Orchard.Setup.Services")]
public class SetupService : Component, ISetupService {
private readonly ShellSettings _shellSettings;
private readonly IOrchardHost _orchardHost;
@ -33,7 +34,6 @@ namespace Orchard.Setup.Services {
private readonly IShellContainerFactory _shellContainerFactory;
private readonly ICompositionStrategy _compositionStrategy;
private readonly IProcessingEngine _processingEngine;
private readonly IExtensionManager _extensionManager;
private readonly IRecipeHarvester _recipeHarvester;
private IEnumerable<Recipe> _recipes;
@ -44,7 +44,6 @@ namespace Orchard.Setup.Services {
IShellContainerFactory shellContainerFactory,
ICompositionStrategy compositionStrategy,
IProcessingEngine processingEngine,
IExtensionManager extensionManager,
IRecipeHarvester recipeHarvester) {
_shellSettings = shellSettings;
@ -53,7 +52,6 @@ namespace Orchard.Setup.Services {
_shellContainerFactory = shellContainerFactory;
_compositionStrategy = compositionStrategy;
_processingEngine = processingEngine;
_extensionManager = extensionManager;
_recipeHarvester = recipeHarvester;
}
@ -64,14 +62,9 @@ namespace Orchard.Setup.Services {
public IEnumerable<Recipe> Recipes() {
if (_recipes == null) {
var recipes = new List<Recipe>();
foreach (var extension in _extensionManager.AvailableExtensions()) {
recipes.AddRange(_recipeHarvester.HarvestRecipes(extension.Id).Where(recipe => recipe.IsSetupRecipe));
}
recipes.AddRange(_recipeHarvester.HarvestRecipes().Where(recipe => recipe.IsSetupRecipe));
_recipes = recipes;
}
return _recipes;
}
@ -212,11 +205,7 @@ namespace Orchard.Setup.Services {
cultureManager.AddCulture("en-US");
var recipeManager = environment.Resolve<IRecipeManager>();
var recipe = Recipes().FirstOrDefault(r => r.Name.Equals(context.Recipe, StringComparison.OrdinalIgnoreCase));
if (recipe == null)
throw new OrchardException(T("The recipe '{0}' could not be found.", context.Recipe));
var recipe = context.Recipe;
var executionId = recipeManager.Execute(recipe);
// Once the recipe has finished executing, we need to update the shell state to "Running", so add a recipe step that does exactly that.

18
src/Orchard/Recipes/Services/IRecipeHarvester.cs
View File

@ -1,8 +1,24 @@
using System.Collections.Generic;
using System;
using System.Collections.Generic;
using System.Linq;
using Orchard.Recipes.Models;
namespace Orchard.Recipes.Services {
public interface IRecipeHarvester : IDependency {
/// <summary>
/// Returns a collection of all recipes.
/// </summary>
IEnumerable<Recipe> HarvestRecipes();
/// <summary>
/// Returns a collection of all recipes found in the specified extension.
/// </summary>
IEnumerable<Recipe> HarvestRecipes(string extensionId);
}
public static class RecipeHarvesterExtensions {
public static Recipe GetRecipeByName(this IEnumerable<Recipe> recipes, string recipeName) {
return recipes.FirstOrDefault(r => r.Name.Equals(recipeName, StringComparison.OrdinalIgnoreCase));
}
}
}