Improved snippets harvester.

Fixes #6432
This commit is contained in:
Sipke Schoorstra 2016-02-20 17:44:31 +01:00
parent cc0593497e
commit 1e2d919b02
2 changed files with 24 additions and 25 deletions

View File

@ -32,12 +32,13 @@ namespace Orchard.Layouts.Providers {
private readonly Work<IShapeDisplay> _shapeDisplay;
private readonly Work<ICurrentThemeShapeBindingResolver> _currentThemeShapeBindingResolver;
private readonly Work<ITokenizer> _tokenizer;
private readonly IWorkContextAccessor _wca;
public SnippetElementHarvester(
IWorkContextAccessor workContextAccessor,
Work<IShapeFactory> shapeFactory,
Work<ISiteThemeService> siteThemeService,
Work<IShapeTableLocator> shapeTableLocator,
Work<IShapeTableLocator> shapeTableLocator,
Work<IElementFactory> elementFactory,
Work<IShapeDisplay> shapeDisplay,
Work<ITokenizer> tokenizer,
@ -50,27 +51,26 @@ namespace Orchard.Layouts.Providers {
_shapeDisplay = shapeDisplay;
_tokenizer = tokenizer;
_currentThemeShapeBindingResolver = currentThemeShapeBindingResolver;
workContextAccessor.GetContext();
_wca = workContextAccessor;
}
public IEnumerable<ElementDescriptor> HarvestElements(HarvestElementsContext context) {
var currentThemeName = _siteThemeService.Value.GetCurrentThemeName();
var shapeTable = _shapeTableLocator.Value.Lookup(currentThemeName);
var shapeDescriptors = shapeTable.Bindings.Where(x => !String.Equals(x.Key, "Elements_Snippet", StringComparison.OrdinalIgnoreCase) && x.Key.EndsWith(SnippetShapeSuffix, StringComparison.OrdinalIgnoreCase)).ToDictionary(x => x.Key, x => x.Value.ShapeDescriptor);
var elementType = typeof (Snippet);
var elementType = typeof(Snippet);
var snippetElement = (Snippet)_elementFactory.Value.Activate(elementType);
foreach (var shapeDescriptor in shapeDescriptors) {
var shapeType = shapeDescriptor.Value.ShapeType;
var snippetDescriptor = DescribeSnippet(shapeType, snippetElement);
var elementName = GetDisplayName(shapeDescriptor.Value.BindingSource);
var closureDescriptor = shapeDescriptor;
yield return new ElementDescriptor(elementType, shapeType, T(elementName), T("An element that renders the {0} shape.", shapeType), snippetElement.Category) {
Displaying = displayContext => Displaying(displayContext, closureDescriptor.Value, snippetDescriptor),
Displaying = displayContext => Displaying(displayContext, closureDescriptor.Value),
ToolboxIcon = "\uf10c",
EnableEditorDialog = snippetDescriptor.Fields.Any(),
Editor = ctx => Editor(snippetDescriptor, ctx),
UpdateEditor = ctx => UpdateEditor(snippetDescriptor, ctx)
EnableEditorDialog = HasSnippetFields(shapeDescriptor.Value),
Editor = ctx => Editor(DescribeSnippet(shapeType, snippetElement), ctx),
UpdateEditor = ctx => UpdateEditor(DescribeSnippet(shapeType, snippetElement), ctx)
};
}
}
@ -83,7 +83,7 @@ namespace Orchard.Layouts.Providers {
var viewModel = new SnippetViewModel {
Descriptor = descriptor
};
if (context.Updater != null) {
foreach (var fieldDescriptor in descriptor.Fields) {
var name = fieldDescriptor.Name;
@ -109,20 +109,18 @@ namespace Orchard.Layouts.Providers {
var snippetEditorShape = context.ShapeFactory.EditorTemplate(TemplateName: "Elements.Snippet", Model: viewModel, Prefix: context.Prefix);
snippetEditorShape.Metadata.Position = "Fields:0";
context.EditorResult.Add(snippetEditorShape);
}
private void Displaying(ElementDisplayingContext context, ShapeDescriptor shapeDescriptor, SnippetDescriptor snippetDescriptor) {
private void Displaying(ElementDisplayingContext context, ShapeDescriptor shapeDescriptor) {
var shapeType = shapeDescriptor.ShapeType;
var shape = (dynamic)_shapeFactory.Value.Create(shapeType);
shape.Element = context.Element;
shape.SnippetDescriptor = snippetDescriptor;
ElementShapes.AddTokenizers(shape, _tokenizer.Value);
context.ElementShape.Snippet = shape;
context.ElementShape.SnippetDescriptor = snippetDescriptor;
}
private string GetDisplayName(string bindingSource) {
@ -140,9 +138,9 @@ namespace Orchard.Layouts.Providers {
private SnippetDescriptor DescribeSnippet(dynamic shape) {
// Execute the shape and intercept calls to the Html.SnippetField method.
var descriptor = new SnippetDescriptor();
shape.DescriptorRegistrationCallback = (Action<SnippetFieldDescriptor>) (fieldDescriptor => {
shape.DescriptorRegistrationCallback = (Action<SnippetFieldDescriptor>)(fieldDescriptor => {
var existingDescriptor = descriptor.Fields.SingleOrDefault(x => x.Name == fieldDescriptor.Name); // Not using Dictionary, as that will break rendering the view for some obscure reason.
if (existingDescriptor == null)
descriptor.Fields.Add(fieldDescriptor);
@ -157,5 +155,16 @@ namespace Orchard.Layouts.Providers {
shape.SnippetDescriptor = descriptor;
return descriptor;
}
private bool HasSnippetFields(ShapeDescriptor shapeDescriptor) {
var bindingSource = shapeDescriptor.BindingSource;
var localFileName = _wca.GetContext().HttpContext.Server.MapPath(bindingSource);
if (!File.Exists(localFileName))
return false;
var markup = File.ReadAllText(localFileName);
return markup.Contains("@Html.SnippetField");
}
}
}

View File

@ -1,17 +1,7 @@
@using Orchard.Layouts.Elements
@using Orchard.Layouts.Helpers
@using Orchard.Layouts.Models
@{
var element = (Snippet) Model.Element;
var snippetDescriptor = (SnippetDescriptor)Model.SnippetDescriptor;
}
<div class="element-snippet layout-placeholder">
@T("{0} Snippet", element.Descriptor.DisplayText)
@if (snippetDescriptor.Fields.Any()) {
<ul>
@foreach(var field in snippetDescriptor.Fields) {
<li>@field.DisplayName: @element.Data.Get(field.Name)</li>
}
</ul>
}
</div>