Refactored Workflows import/export step.

This commit is contained in:
Sipke Schoorstra
2015-07-17 14:47:31 +01:00
parent aa91768bf1
commit de37e29610
4 changed files with 158 additions and 179 deletions

View File

@@ -1,14 +0,0 @@
using System.Collections.Generic;
using Orchard.Events;
namespace Orchard.Workflows.ImportExport {
public interface ICustomExportStep : IEventHandler {
void Register(IList<string> steps);
}
public class WorkflowsCustomExportStep : ICustomExportStep {
public void Register(IList<string> steps) {
steps.Add("Workflows");
}
}
}

View File

@@ -154,9 +154,8 @@
<Compile Include="Forms\WebRequestForm.cs" />
<Compile Include="Handlers\WorkflowContentHandler.cs" />
<Compile Include="Handlers\WorkflowHandler.cs" />
<Compile Include="ImportExport\WorkflowsCustomExportStep.cs" />
<Compile Include="ImportExport\WorkflowsExportEventHandler.cs" />
<Compile Include="ImportExport\WorkflowsRecipeHandler.cs" />
<Compile Include="Recipes\Builders\WorkflowsStep.cs" />
<Compile Include="Recipes\Executors\WorkflowsStep.cs" />
<Compile Include="Models\AwaitingActivityRecord.cs" />
<Compile Include="Models\CancellationToken.cs" />
<Compile Include="Models\ActivityContext.cs" />

View File

@@ -1,62 +1,61 @@
using System.Collections.Generic;
using System.Linq;
using System.Xml.Linq;
using Orchard.Data;
using Orchard.Events;
using Orchard.Workflows.Models;
namespace Orchard.Workflows.ImportExport {
public interface IExportEventHandler : IEventHandler {
void Exporting(dynamic context);
void Exported(dynamic context);
}
public class WorkflowsExportEventHandler : IExportEventHandler {
private readonly IRepository<WorkflowDefinitionRecord> _workflowDefinitionRepository;
public WorkflowsExportEventHandler(IRepository<WorkflowDefinitionRecord> workflowDefinitionRepository) {
_workflowDefinitionRepository = workflowDefinitionRepository;
}
public void Exporting(dynamic context) {
}
public void Exported(dynamic context) {
if (!((IEnumerable<string>)context.ExportOptions.CustomSteps).Contains("Workflows")) {
return;
}
var workflowDefinitions = _workflowDefinitionRepository.Table.ToList();
if (!workflowDefinitions.Any()) {
return;
}
var root = new XElement("Workflows");
context.Document.Element("Orchard").Add(root);
foreach (var workflowDefinition in workflowDefinitions.OrderBy(x => x.Name)) {
root.Add(new XElement("Workflow",
new XAttribute("Name", workflowDefinition.Name),
new XAttribute("Enabled", workflowDefinition.Enabled),
new XElement("Activities", workflowDefinition.ActivityRecords.Select(activity =>
new XElement("Activity",
new XAttribute("Id", activity.Id),
new XAttribute("Name", activity.Name),
new XAttribute("Start", activity.Start),
new XAttribute("X", activity.X),
new XAttribute("Y", activity.Y),
new XElement("State", activity.State)))),
new XElement("Transitions", workflowDefinition.TransitionRecords.Select(transition =>
new XElement("Transition",
new XAttribute("SourceActivityId", transition.SourceActivityRecord.Id),
new XAttribute("SourceEndpoint", transition.SourceEndpoint ?? ""),
new XAttribute("DestinationActivityId", transition.DestinationActivityRecord.Id),
new XAttribute("DestinationEndpoint", transition.DestinationEndpoint ?? ""))))));
}
}
}
}
using System.Collections.Generic;
using System.Linq;
using System.Xml.Linq;
using Orchard.Data;
using Orchard.Localization;
using Orchard.Recipes.Services;
using Orchard.Workflows.Models;
namespace Orchard.Workflows.Recipes.Builders {
public class WorkflowsStep : RecipeBuilderStep {
private readonly IRepository<WorkflowDefinitionRecord> _workflowDefinitionRepository;
public WorkflowsStep(IRepository<WorkflowDefinitionRecord> workflowDefinitionRepository) {
_workflowDefinitionRepository = workflowDefinitionRepository;
}
public override string Name {
get { return "Workflows"; }
}
public override LocalizedString DisplayName {
get { return T("Workflows"); }
}
public override LocalizedString Description {
get { return T("Exports workflow definitions."); }
}
public override void Build(BuildContext context) {
var workflowDefinitions = _workflowDefinitionRepository.Table.ToList();
if (!workflowDefinitions.Any()) {
return;
}
var root = new XElement("Workflows");
context.RecipeDocument.Element("Orchard").Add(root);
foreach (var workflowDefinition in workflowDefinitions.OrderBy(x => x.Name)) {
root.Add(new XElement("Workflow",
new XAttribute("Name", workflowDefinition.Name),
new XAttribute("Enabled", workflowDefinition.Enabled),
new XElement("Activities", workflowDefinition.ActivityRecords.Select(activity =>
new XElement("Activity",
new XAttribute("Id", activity.Id),
new XAttribute("Name", activity.Name),
new XAttribute("Start", activity.Start),
new XAttribute("X", activity.X),
new XAttribute("Y", activity.Y),
new XElement("State", activity.State)))),
new XElement("Transitions", workflowDefinition.TransitionRecords.Select(transition =>
new XElement("Transition",
new XAttribute("SourceActivityId", transition.SourceActivityRecord.Id),
new XAttribute("SourceEndpoint", transition.SourceEndpoint ?? ""),
new XAttribute("DestinationActivityId", transition.DestinationActivityRecord.Id),
new XAttribute("DestinationEndpoint", transition.DestinationEndpoint ?? ""))))));
}
}
}
}

View File

@@ -1,100 +1,95 @@
using System;
using System.Collections.Generic;
using Orchard.Data;
using Orchard.Localization;
using Orchard.Logging;
using Orchard.Recipes.Models;
using Orchard.Recipes.Services;
using Orchard.Workflows.Models;
namespace Orchard.Workflows.ImportExport {
public class WorkflowsRecipeHandler : IRecipeHandler {
private readonly IRepository<WorkflowDefinitionRecord> _workflowDefinitionRepository;
private readonly IRepository<ActivityRecord> _activityRepository;
private readonly IRepository<TransitionRecord> _transitionRepository;
public WorkflowsRecipeHandler(IRepository<WorkflowDefinitionRecord> workflowDefinitionRepository, IRepository<ActivityRecord> activityRepository, IRepository<TransitionRecord> transitionRepository) {
_workflowDefinitionRepository = workflowDefinitionRepository;
_activityRepository = activityRepository;
_transitionRepository = transitionRepository;
Logger = NullLogger.Instance;
T = NullLocalizer.Instance;
}
public Localizer T { get; set; }
public ILogger Logger { get; set; }
public void ExecuteRecipeStep(RecipeContext recipeContext) {
if (!String.Equals(recipeContext.RecipeStep.Name, "Workflows", StringComparison.OrdinalIgnoreCase)) {
return;
}
foreach (var workflowDefinitionElement in recipeContext.RecipeStep.Step.Elements()) {
var workflowDefinition = GetOrCreateWorkflowDefinition(workflowDefinitionElement.Attribute("Name").Value);
var activitiesElement = workflowDefinitionElement.Element("Activities");
var transitionsElement = workflowDefinitionElement.Element("Transitions");
var activitiesDictionary = new Dictionary<int, ActivityRecord>();
workflowDefinition.Enabled = Boolean.Parse(workflowDefinitionElement.Attribute("Enabled").Value);
foreach (var activityElement in activitiesElement.Elements()) {
var localId = Int32.Parse(activityElement.Attribute("Id").Value);
var activity = new ActivityRecord {
Name = activityElement.Attribute("Name").Value,
Start = Boolean.Parse(activityElement.Attribute("Start").Value),
X = Int32.Parse(activityElement.Attribute("X").Value),
Y = Int32.Parse(activityElement.Attribute("Y").Value),
State = activityElement.Element("State").Value
};
activitiesDictionary.Add(localId, activity);
workflowDefinition.ActivityRecords.Add(activity);
}
foreach (var transitionElement in transitionsElement.Elements()) {
var sourceActivityId = Int32.Parse(transitionElement.Attribute("SourceActivityId").Value);
var sourceEndpoint = transitionElement.Attribute("SourceEndpoint").Value;
var destinationActivityId = Int32.Parse(transitionElement.Attribute("DestinationActivityId").Value);
var destinationEndpoint = transitionElement.Attribute("DestinationEndpoint").Value;
workflowDefinition.TransitionRecords.Add(new TransitionRecord {
SourceActivityRecord = activitiesDictionary[sourceActivityId],
SourceEndpoint = sourceEndpoint,
DestinationActivityRecord = activitiesDictionary[destinationActivityId],
DestinationEndpoint = destinationEndpoint
});
}
}
recipeContext.Executed = true;
}
private WorkflowDefinitionRecord GetOrCreateWorkflowDefinition(string name) {
var workflowDefinition = _workflowDefinitionRepository.Get(x => x.Name == name);
if (workflowDefinition == null) {
workflowDefinition = new WorkflowDefinitionRecord {
Name = name
};
_workflowDefinitionRepository.Create(workflowDefinition);
}
else {
CleanWorkFlow(workflowDefinition);
}
return workflowDefinition;
}
private void CleanWorkFlow(WorkflowDefinitionRecord workflowDefinition) {
foreach (var activityRecord in workflowDefinition.ActivityRecords) {
_activityRepository.Delete(activityRecord);
}
workflowDefinition.ActivityRecords.Clear();
foreach (var transitionRecord in workflowDefinition.TransitionRecords) {
_transitionRepository.Delete(transitionRecord);
}
workflowDefinition.TransitionRecords.Clear();
}
}
}
using System;
using System.Collections.Generic;
using Orchard.Data;
using Orchard.Recipes.Models;
using Orchard.Recipes.Services;
using Orchard.Workflows.Models;
namespace Orchard.Workflows.Recipes.Executors {
public class WorkflowsStep : RecipeExecutionStep {
private readonly IRepository<WorkflowDefinitionRecord> _workflowDefinitionRepository;
private readonly IRepository<ActivityRecord> _activityRepository;
private readonly IRepository<TransitionRecord> _transitionRepository;
public WorkflowsStep(
IRepository<WorkflowDefinitionRecord> workflowDefinitionRepository,
IRepository<ActivityRecord> activityRepository,
IRepository<TransitionRecord> transitionRepository) {
_workflowDefinitionRepository = workflowDefinitionRepository;
_activityRepository = activityRepository;
_transitionRepository = transitionRepository;
}
public override string Name {
get { return "Workflows"; }
}
public override void Execute(RecipeExecutionContext context) {
foreach (var workflowDefinitionElement in context.RecipeStep.Step.Elements()) {
var workflowDefinition = GetOrCreateWorkflowDefinition(workflowDefinitionElement.Attribute("Name").Value);
var activitiesElement = workflowDefinitionElement.Element("Activities");
var transitionsElement = workflowDefinitionElement.Element("Transitions");
var activitiesDictionary = new Dictionary<int, ActivityRecord>();
workflowDefinition.Enabled = Boolean.Parse(workflowDefinitionElement.Attribute("Enabled").Value);
foreach (var activityElement in activitiesElement.Elements()) {
var localId = Int32.Parse(activityElement.Attribute("Id").Value);
var activity = new ActivityRecord {
Name = activityElement.Attribute("Name").Value,
Start = Boolean.Parse(activityElement.Attribute("Start").Value),
X = Int32.Parse(activityElement.Attribute("X").Value),
Y = Int32.Parse(activityElement.Attribute("Y").Value),
State = activityElement.Element("State").Value
};
activitiesDictionary.Add(localId, activity);
workflowDefinition.ActivityRecords.Add(activity);
}
foreach (var transitionElement in transitionsElement.Elements()) {
var sourceActivityId = Int32.Parse(transitionElement.Attribute("SourceActivityId").Value);
var sourceEndpoint = transitionElement.Attribute("SourceEndpoint").Value;
var destinationActivityId = Int32.Parse(transitionElement.Attribute("DestinationActivityId").Value);
var destinationEndpoint = transitionElement.Attribute("DestinationEndpoint").Value;
workflowDefinition.TransitionRecords.Add(new TransitionRecord {
SourceActivityRecord = activitiesDictionary[sourceActivityId],
SourceEndpoint = sourceEndpoint,
DestinationActivityRecord = activitiesDictionary[destinationActivityId],
DestinationEndpoint = destinationEndpoint
});
}
}
}
private WorkflowDefinitionRecord GetOrCreateWorkflowDefinition(string name) {
var workflowDefinition = _workflowDefinitionRepository.Get(x => x.Name == name);
if (workflowDefinition == null) {
workflowDefinition = new WorkflowDefinitionRecord {
Name = name
};
_workflowDefinitionRepository.Create(workflowDefinition);
}
else {
CleanWorkFlow(workflowDefinition);
}
return workflowDefinition;
}
private void CleanWorkFlow(WorkflowDefinitionRecord workflowDefinition) {
foreach (var activityRecord in workflowDefinition.ActivityRecords) {
_activityRepository.Delete(activityRecord);
}
workflowDefinition.ActivityRecords.Clear();
foreach (var transitionRecord in workflowDefinition.TransitionRecords) {
_transitionRepository.Delete(transitionRecord);
}
workflowDefinition.TransitionRecords.Clear();
}
}
}