Merge pull request #6054 from OrchardCMS/feature/configurable-snippets

Added support for configurable snippet elements.

src/Orchard.Web/Modules/Orchard.Layouts/Helpers/SnippetHtmlExtensions.cs

@@ -0,0 +1,68 @@
+using System;
+using System.Web;
+using System.Web.Mvc;
+using Orchard.Layouts.Elements;
+using Orchard.Layouts.Models;
+using Orchard.Localization;
+
+namespace Orchard.Layouts.Helpers {
+    public static class SnippetHtmlExtensions {
+        
+        public static SnippetFieldDescriptorBuilder SnippetField(this HtmlHelper htmlHelper, string name, string type = null) {
+            var shape = (dynamic) htmlHelper.ViewData.Model;
+
+            return new SnippetFieldDescriptorBuilder(shape)
+                .Named(name)
+                .WithType(type);
+        }
+
+        public class SnippetFieldDescriptorBuilder : IHtmlString {
+            private readonly dynamic _shape;
+
+            public SnippetFieldDescriptorBuilder(dynamic shape) {
+                _shape = shape;
+                Descriptor = new SnippetFieldDescriptor();
+            }
+
+            public SnippetFieldDescriptor Descriptor { get; private set; }
+
+            public SnippetFieldDescriptorBuilder Named(string value) {
+                Descriptor.Name = value;
+                return this;
+            }
+
+            public SnippetFieldDescriptorBuilder WithType(string value) {
+                Descriptor.Type = value;
+                return this;
+            }
+
+            public SnippetFieldDescriptorBuilder DisplayedAs(LocalizedString value) {
+                Descriptor.DisplayName = value;
+                return this;
+            }
+
+            public SnippetFieldDescriptorBuilder WithDescription(LocalizedString value) {
+                Descriptor.Description = value;
+                return this;
+            }
+
+            public override string ToString() {
+                var registratorCallback = (Action<SnippetFieldDescriptor>)_shape.DescriptorRegistrationCallback;
+
+                if (registratorCallback != null)
+                    registratorCallback(Descriptor);
+
+                var element = (Snippet)_shape.Element;
+
+                if(element != null)
+                    return element.Data.Get(Descriptor.Name);
+
+                return null;
+            }
+
+            public string ToHtmlString() {
+                return ToString();
+            }
+        }
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/Models/SnippetDescriptor.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+
+namespace Orchard.Layouts.Models {
+    public class SnippetDescriptor {
+        public SnippetDescriptor() {
+            Fields = new List<SnippetFieldDescriptor>();
+        }
+
+        public IList<SnippetFieldDescriptor> Fields { get; set; }
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/Models/SnippetFieldDescriptor.cs

@@ -0,0 +1,10 @@
+using Orchard.Localization;
+
+namespace Orchard.Layouts.Models {
+    public class SnippetFieldDescriptor {
+        public string Type { get; set; }
+        public string Name { get; set; }
+        public LocalizedString DisplayName { get; set; }
+        public LocalizedString Description { get; set; }
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/Orchard.Layouts.csproj

@@ -327,10 +327,17 @@
     <Compile Include="Helpers\ObjectStoreHelper.cs" />
     <Compile Include="Helpers\PrefixHelper.cs" />
     <Compile Include="Helpers\JsonHelper.cs" />
+    <Compile Include="Helpers\SnippetHtmlExtensions.cs" />
     <Compile Include="Helpers\StringHelper.cs" />
     <Compile Include="Permissions.cs" />
+    <Compile Include="Services\ICurrentThemeShapeBindingResolver.cs" />
+    <Compile Include="Services\CurrentThemeShapeBindingResolver.cs" />
     <Compile Include="Providers\PlaceableContentElementHarvester.cs" />
     <Compile Include="Elements\RecycleBin.cs" />
+    <Compile Include="Models\SnippetDescriptor.cs" />
+    <Compile Include="Models\SnippetFieldDescriptor.cs" />
+    <Compile Include="ViewModels\SnippetViewModel.cs" />
+    <Compile Include="ViewModels\SnippetFieldViewModel.cs" />
     <Compile Include="ViewModels\PlaceableContentItemViewModel.cs" />
     <Compile Include="Recipes\Builders\CustomElementsStep.cs" />
     <Compile Include="Recipes\Executors\CustomElementsStep.cs" />
@@ -549,6 +556,12 @@
   <ItemGroup>
     <Content Include="Views\EditorTemplates\Elements.PlaceableContentItem.cshtml" />
   </ItemGroup>
+  <ItemGroup>
+    <Content Include="Views\EditorTemplates\Elements.Snippet.cshtml" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="Views\EditorTemplates\Elements.Snippet.Field.Text.cshtml" />
+  </ItemGroup>
   <PropertyGroup>
     <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
     <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>

src/Orchard.Web/Modules/Orchard.Layouts/Providers/SnippetElementHarvester.cs

@@ -8,10 +8,17 @@ using Orchard.Environment;
 using Orchard.Environment.Extensions;
 using Orchard.Layouts.Elements;
 using Orchard.Layouts.Framework.Display;
+using Orchard.Layouts.Framework.Drivers;
 using Orchard.Layouts.Framework.Elements;
 using Orchard.Layouts.Framework.Harvesters;
+using Orchard.Layouts.Helpers;
+using Orchard.Layouts.Models;
 using Orchard.Layouts.Services;
+using Orchard.Layouts.Shapes;
+using Orchard.Layouts.ViewModels;
+using Orchard.Localization;
 using Orchard.Themes.Services;
+using Orchard.Tokens;
 using Orchard.Utility.Extensions;
 
 namespace Orchard.Layouts.Providers {
@@ -22,18 +29,27 @@ namespace Orchard.Layouts.Providers {
         private readonly Work<ISiteThemeService> _siteThemeService;
         private readonly Work<IShapeTableLocator> _shapeTableLocator;
         private readonly Work<IElementFactory> _elementFactory;
+        private readonly Work<IShapeDisplay> _shapeDisplay;
+        private readonly Work<ICurrentThemeShapeBindingResolver> _currentThemeShapeBindingResolver;
+        private readonly Work<ITokenizer> _tokenizer;
 
         public SnippetElementHarvester(
             IWorkContextAccessor workContextAccessor,
             Work<IShapeFactory> shapeFactory,
             Work<ISiteThemeService> siteThemeService,
             Work<IShapeTableLocator> shapeTableLocator, 
-            Work<IElementFactory> elementFactory) {
+            Work<IElementFactory> elementFactory,
+            Work<IShapeDisplay> shapeDisplay,
+            Work<ITokenizer> tokenizer,
+            Work<ICurrentThemeShapeBindingResolver> currentThemeShapeBindingResolver) {
 
             _shapeFactory = shapeFactory;
             _siteThemeService = siteThemeService;
             _shapeTableLocator = shapeTableLocator;
             _elementFactory = elementFactory;
+            _shapeDisplay = shapeDisplay;
+            _tokenizer = tokenizer;
+            _currentThemeShapeBindingResolver = currentThemeShapeBindingResolver;
             workContextAccessor.GetContext();
         }
 
@@ -42,23 +58,71 @@ namespace Orchard.Layouts.Providers {
             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 snippetElement = _elementFactory.Value.Activate(elementType);
+            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),
-                    ToolboxIcon = "\uf10c"
+                    Displaying = displayContext => Displaying(displayContext, closureDescriptor.Value, snippetDescriptor),
+                    ToolboxIcon = "\uf10c",
+                    EnableEditorDialog = snippetDescriptor.Fields.Any(),
+                    Editor = ctx => Editor(snippetDescriptor, ctx),
+                    UpdateEditor = ctx => UpdateEditor(snippetDescriptor, ctx)
                 };
             }
         }
 
-        private void Displaying(ElementDisplayingContext context, ShapeDescriptor shapeDescriptor) {
+        private void Editor(SnippetDescriptor descriptor, ElementEditorContext context) {
+            UpdateEditor(descriptor, context);
+        }
+
+        private void UpdateEditor(SnippetDescriptor descriptor, ElementEditorContext context) {
+            var viewModel = new SnippetViewModel {
+                Descriptor = descriptor
+            };
+            
+            if (context.Updater != null) {
+                foreach (var fieldDescriptor in descriptor.Fields) {
+                    var name = fieldDescriptor.Name;
+                    var result = context.ValueProvider.GetValue(name);
+
+                    if (result == null)
+                        continue;
+
+                    context.Element.Data[name] = result.AttemptedValue;
+                }
+            }
+
+            viewModel.FieldEditors = descriptor.Fields.Select(x => {
+                var fieldEditorTemplateName = String.Format("Elements.Snippet.Field.{0}", x.Type ?? "Text");
+                var fieldDescriptorViewModel = new SnippetFieldViewModel {
+                    Descriptor = x,
+                    Value = context.Element.Data.Get(x.Name)
+                };
+                var fieldEditor = context.ShapeFactory.EditorTemplate(TemplateName: fieldEditorTemplateName, Model: fieldDescriptorViewModel, Prefix: context.Prefix);
+
+                return fieldEditor;
+            }).ToList();
+
+            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) {
             var shapeType = shapeDescriptor.ShapeType;
-            var shape = _shapeFactory.Value.Create(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) {
@@ -66,5 +130,32 @@ namespace Orchard.Layouts.Providers {
             var lastIndex = fileName.IndexOf(SnippetShapeSuffix, StringComparison.OrdinalIgnoreCase);
             return fileName.Substring(0, lastIndex).CamelFriendly();
         }
+
+        private SnippetDescriptor DescribeSnippet(string shapeType, Snippet element) {
+            var shape = (dynamic)_shapeFactory.Value.Create(shapeType);
+            shape.Element = element;
+            return DescribeSnippet(shape);
+        }
+
+        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 => {
+                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);
+
+                if (fieldDescriptor.DisplayName == null)
+                    fieldDescriptor.DisplayName = new LocalizedString(fieldDescriptor.Name);
+            });
+
+            using (_currentThemeShapeBindingResolver.Value.Enable()) {
+                _shapeDisplay.Value.Display(shape);
+            }
+
+            shape.SnippetDescriptor = descriptor;
+            return descriptor;
+        }
     }
 }

src/Orchard.Web/Modules/Orchard.Layouts/Services/CurrentThemeShapeBindingResolver.cs

@@ -0,0 +1,44 @@
+using System;
+using Orchard.DisplayManagement;
+using Orchard.DisplayManagement.Descriptors;
+using Orchard.Environment.Extensions;
+using Orchard.Layouts.Providers;
+using Orchard.Themes.Services;
+
+namespace Orchard.Layouts.Services {
+    /// <summary>
+    /// Enables the rendering of shape templates from the admin while the shape templates reside in the current theme.
+    /// </summary>
+    [OrchardFeature("Orchard.Layouts.Snippets")]
+    public class CurrentThemeShapeBindingResolver : ICurrentThemeShapeBindingResolver, IShapeBindingResolver, IDisposable {
+        private readonly ISiteThemeService _siteThemeService;
+        private readonly IShapeTableLocator _shapeTableLocator;
+
+        public CurrentThemeShapeBindingResolver(ISiteThemeService siteThemeService, IShapeTableLocator shapeTableLocator) {
+            _siteThemeService = siteThemeService;
+            _shapeTableLocator = shapeTableLocator;
+        }
+
+        public bool Enabled { get; private set; }
+
+        public bool TryGetDescriptorBinding(string shapeType, out ShapeBinding shapeBinding) {
+            shapeBinding = null;
+
+            if (!Enabled)
+                return false;
+
+            var currentThemeName = _siteThemeService.GetCurrentThemeName();
+            var shapeTable = _shapeTableLocator.Lookup(currentThemeName);
+            return shapeTable.Bindings.TryGetValue(shapeType, out shapeBinding);
+        }
+
+        public IDisposable Enable() {
+            Enabled = true;
+            return this;
+        }
+
+        public void Dispose() {
+            Enabled = false;
+        }
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/Services/ICurrentThemeShapeBindingResolver.cs

@@ -0,0 +1,7 @@
+using System;
+
+namespace Orchard.Layouts.Services {
+    public interface ICurrentThemeShapeBindingResolver : IDependency {
+        IDisposable Enable();
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/Shapes/ElementShapes.cs

@@ -16,6 +16,19 @@ namespace Orchard.Layouts.Shapes {
         private readonly Work<IShapeFactory> _shapeFactory;
         private readonly Work<ITokenizer> _tokenizer;
 
+        public static void AddTokenizers(dynamic elementShape, ITokenizer tokenizer) {
+            var element = (Element)elementShape.Element;
+            var content = (ContentItem)elementShape.ContentItem;
+            var htmlId = element.HtmlId;
+            var htmlClass = element.HtmlClass;
+            var htmlStyle = element.HtmlStyle;
+
+            // Provide tokenizer functions.
+            elementShape.TokenizeHtmlId = (Func<string>)(() => tokenizer.Replace(htmlId, new { Content = content }));
+            elementShape.TokenizeHtmlClass = (Func<string>)(() => tokenizer.Replace(htmlClass, new { Content = content }));
+            elementShape.TokenizeHtmlStyle = (Func<string>)(() => tokenizer.Replace(htmlStyle, new { Content = content }));
+        }
+
         public ElementShapes(
             ITagBuilderFactory tagBuilderFactory, 
             Work<IShapeFactory> shapeFactory, 
@@ -32,16 +45,7 @@ namespace Orchard.Layouts.Shapes {
 
         public void Discover(ShapeTableBuilder builder) {
             builder.Describe("Element").OnDisplaying(context => {
-                var element = (Element)context.Shape.Element;
-                var content = (ContentItem)context.Shape.ContentItem;
-                var htmlId = element.HtmlId;
-                var htmlClass = element.HtmlClass;
-                var htmlStyle = element.HtmlStyle;
-
-                // Provide tokenizer functions.
-                context.Shape.TokenizeHtmlId = (Func<string>)(() => _tokenizer.Value.Replace(htmlId, new { Content = content }));
-                context.Shape.TokenizeHtmlClass = (Func<string>)(() => _tokenizer.Value.Replace(htmlClass, new { Content = content }));
-                context.Shape.TokenizeHtmlStyle = (Func<string>)(() => _tokenizer.Value.Replace(htmlStyle, new { Content = content }));
+                AddTokenizers(context.Shape, _tokenizer.Value);
             });
         }
 

src/Orchard.Web/Modules/Orchard.Layouts/ViewModels/SnippetFieldViewModel.cs

@@ -0,0 +1,8 @@
+using Orchard.Layouts.Models;
+
+namespace Orchard.Layouts.ViewModels {
+    public class SnippetFieldViewModel {
+        public SnippetFieldDescriptor Descriptor { get; set; }
+        public string Value { get; set; }
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/ViewModels/SnippetViewModel.cs

@@ -0,0 +1,13 @@
+using System.Collections.Generic;
+using Orchard.Layouts.Models;
+
+namespace Orchard.Layouts.ViewModels {
+    public class SnippetViewModel {
+        public SnippetViewModel() {
+            FieldEditors = new List<dynamic>();
+        }
+
+        public SnippetDescriptor Descriptor { get; set; }
+        public IList<dynamic> FieldEditors { get; set; }
+    }
+}

src/Orchard.Web/Modules/Orchard.Layouts/Views/EditorTemplates/Elements.Snippet.Field.Text.cshtml

@@ -0,0 +1,11 @@
+@model Orchard.Layouts.ViewModels.SnippetFieldViewModel
+@{
+    var field = Model;
+}
+<div class="form-group">
+    @Html.Label(field.Descriptor.Name, field.Descriptor.DisplayName.ToString())
+    @Html.TextBox(field.Descriptor.Name, field.Value, new { @class = "text large" })
+    @if (field.Descriptor.Description != null) {
+        @Html.Hint(field.Descriptor.Description)
+    }
+</div>

src/Orchard.Web/Modules/Orchard.Layouts/Views/EditorTemplates/Elements.Snippet.cshtml

@@ -0,0 +1,10 @@
+@model Orchard.Layouts.ViewModels.SnippetViewModel
+@{
+    var descriptor = Model;
+    var fieldEditors = descriptor.FieldEditors;
+}
+<fieldset>
+    @foreach (var fieldEditor in fieldEditors) {
+        @Display(fieldEditor)
+    }
+</fieldset>

src/Orchard.Web/Modules/Orchard.Layouts/Views/Elements/Snippet.Design.cshtml

@@ -1,8 +1,17 @@
 @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">
-    <span class="fa fa-circle"></span>
     @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>

src/Orchard.Web/Themes/Themes.csproj

@@ -25,6 +25,7 @@
     <IISExpressAnonymousAuthentication />
     <IISExpressWindowsAuthentication />
     <IISExpressUseClassicPipelineMode />
+    <UseGlobalApplicationHostFile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -160,6 +161,10 @@
       <Name>Orchard.Framework</Name>
       <Private>False</Private>
     </ProjectReference>
+    <ProjectReference Include="..\Modules\Orchard.Layouts\Orchard.Layouts.csproj">
+      <Project>{6bd8b2fa-f2e3-4ac8-a4c3-2925a653889a}</Project>
+      <Name>Orchard.Layouts</Name>
+    </ProjectReference>
   </ItemGroup>
   <ItemGroup>
     <Content Include="TheThemeMachine\Views\Pager.cshtml" />