mirror of
https://github.com/OrchardCMS/Orchard.git
synced 2025-10-15 19:54:57 +08:00
Implementing Projection element.
This commit is contained in:
Sipke Schoorstra
@@ -0,0 +1,291 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Web.Mvc;
|
||||
using Orchard.ContentManagement;
|
||||
using Orchard.Core.Title.Models;
|
||||
using Orchard.Data;
|
||||
using Orchard.DisplayManagement;
|
||||
using Orchard.Environment.Extensions;
|
||||
using Orchard.Forms.Services;
|
||||
using Orchard.Layouts.Elements;
|
||||
using Orchard.Layouts.Framework.Display;
|
||||
using Orchard.Layouts.Framework.Drivers;
|
||||
using Orchard.Projections.Descriptors.Layout;
|
||||
using Orchard.Projections.Descriptors.Property;
|
||||
using Orchard.Projections.Models;
|
||||
using Orchard.Projections.Services;
|
||||
using Orchard.Projections.ViewModels;
|
||||
using Orchard.Tokens;
|
||||
using Orchard.UI.Navigation;
|
||||
using DescribeContext = Orchard.Forms.Services.DescribeContext;
|
||||
|
||||
namespace Orchard.Layouts.Drivers {
|
||||
[OrchardFeature("Orchard.Layouts.Projections")]
|
||||
public class ProjectionDriver : FormsElementDriver<Projection> {
|
||||
private readonly IProjectionManager _projectionManager;
|
||||
private readonly IContentManager _contentManager;
|
||||
private readonly IOrchardServices _services;
|
||||
private readonly IRepository<LayoutRecord> _layoutRepository;
|
||||
private readonly ITokenizer _tokenizer;
|
||||
private readonly IDisplayHelperFactory _displayHelperFactory;
|
||||
|
||||
public ProjectionDriver(
|
||||
IFormManager formManager,
|
||||
IProjectionManager projectionManager,
|
||||
IOrchardServices services,
|
||||
IRepository<LayoutRecord> layoutRepository,
|
||||
ITokenizer tokenizer,
|
||||
IDisplayHelperFactory displayHelperFactory)
|
||||
: base(formManager) {
|
||||
|
||||
_projectionManager = projectionManager;
|
||||
_contentManager = services.ContentManager;
|
||||
_services = services;
|
||||
_layoutRepository = layoutRepository;
|
||||
_tokenizer = tokenizer;
|
||||
_displayHelperFactory = displayHelperFactory;
|
||||
}
|
||||
|
||||
protected override IEnumerable<string> FormNames {
|
||||
get {
|
||||
yield return "ProjectionForm";
|
||||
}
|
||||
}
|
||||
|
||||
protected override void OnDisplaying(Projection element, ElementDisplayContext context) {
|
||||
var queryId = element.QueryId;
|
||||
var layoutId = element.LayoutId;
|
||||
|
||||
if (queryId == null || layoutId == null)
|
||||
return;
|
||||
|
||||
var query = _contentManager.Get<QueryPart>(queryId.Value);
|
||||
|
||||
// Retrieving paging parameters.
|
||||
var queryString = _services.WorkContext.HttpContext.Request.QueryString;
|
||||
var pageKey = String.IsNullOrWhiteSpace(element.PagerSuffix) ? "page" : "page-" + element.PagerSuffix;
|
||||
var page = 0;
|
||||
|
||||
// Default page size.
|
||||
var pageSize = element.ItemsToDisplay;
|
||||
|
||||
// Don't try to page if not necessary.
|
||||
if (element.DisplayPager && queryString.AllKeys.Contains(pageKey)) {
|
||||
Int32.TryParse(queryString[pageKey], out page);
|
||||
}
|
||||
|
||||
// If 0, then assume "All", limit to 128 by default.
|
||||
if (pageSize == 128) {
|
||||
pageSize = Int32.MaxValue;
|
||||
}
|
||||
|
||||
// If pageSize is provided on the query string, ensure it is compatible within allowed limits.
|
||||
var pageSizeKey = "pageSize" + element.PagerSuffix;
|
||||
|
||||
if (queryString.AllKeys.Contains(pageSizeKey)) {
|
||||
int qsPageSize;
|
||||
|
||||
if (Int32.TryParse(queryString[pageSizeKey], out qsPageSize)) {
|
||||
if (element.MaxItems == 0 || qsPageSize <= element.MaxItems) {
|
||||
pageSize = qsPageSize;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
var pager = new Pager(_services.WorkContext.CurrentSite, page, pageSize);
|
||||
var pagerShape = _services.New.Pager(pager)
|
||||
.Element(element)
|
||||
.PagerId(pageKey);
|
||||
|
||||
context.ElementShape.Pager = pagerShape;
|
||||
|
||||
// TODO: Investigate this further and see if it makes sense to implement for a Projection Element.
|
||||
//// Generates a link to the RSS feed for this term.
|
||||
//var metaData = _services.ContentManager.GetItemMetadata(part.ContentItem);
|
||||
//_feedManager.Register(metaData.DisplayText, "rss", new RouteValueDictionary { { "projection", part.Id } });
|
||||
|
||||
// Execute the query.
|
||||
var contentItems = _projectionManager.GetContentItems(query.Id, pager.GetStartIndex() + element.Skip, pager.PageSize).ToList();
|
||||
|
||||
// TODO: Figure out if we need this for a Projection Element, and if so, how.
|
||||
//// Sanity check so that content items with ProjectionPart can't be added here, or it will result in an infinite loop.
|
||||
//contentItems = contentItems.Where(x => !x.Has<ProjectionPart>()).ToList();
|
||||
|
||||
// Applying layout.
|
||||
var layout = _layoutRepository.Get(layoutId.Value);
|
||||
var layoutDescriptor = layout == null ? null : _projectionManager.DescribeLayouts().SelectMany(x => x.Descriptors).FirstOrDefault(x => x.Category == layout.Category && x.Type == layout.Type);
|
||||
|
||||
// Create pager shape.
|
||||
if (element.DisplayPager) {
|
||||
var contentItemsCount = _projectionManager.GetCount(query.Id) - element.Skip;
|
||||
contentItemsCount = Math.Max(0, contentItemsCount);
|
||||
pagerShape.TotalItemCount(contentItemsCount);
|
||||
}
|
||||
|
||||
// Renders in a standard List shape if no specific layout could be found.
|
||||
if (layoutDescriptor == null) {
|
||||
var contentShapes = contentItems.Select(item => _contentManager.BuildDisplay(item, "Summary"));
|
||||
|
||||
var list = context.ElementShape.List = _services.New.List();
|
||||
list.AddRange(contentShapes);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
var allFielDescriptors = _projectionManager.DescribeProperties().ToList();
|
||||
var fieldDescriptors = layout.Properties.OrderBy(p => p.Position).Select(p => allFielDescriptors.SelectMany(x => x.Descriptors).Select(d => new { Descriptor = d, Property = p }).FirstOrDefault(x => x.Descriptor.Category == p.Category && x.Descriptor.Type == p.Type)).ToList();
|
||||
|
||||
var layoutComponents = contentItems.Select(contentItem => {
|
||||
var contentItemMetadata = _contentManager.GetItemMetadata(contentItem);
|
||||
var propertyDescriptors = fieldDescriptors.Select( d => {
|
||||
var fieldContext = new PropertyContext {
|
||||
State = FormParametersHelper.ToDynamic(d.Property.State),
|
||||
Tokens = new Dictionary<string, object> { { "Content", contentItem } }
|
||||
};
|
||||
|
||||
return new { d.Property, Shape = d.Descriptor.Property(fieldContext, contentItem) };
|
||||
});
|
||||
|
||||
// Apply all settings to the field content, wrapping it in a FieldWrapper shape.
|
||||
var properties = _services.New.Properties(
|
||||
Items: propertyDescriptors.Select(
|
||||
pd => _services.New.PropertyWrapper(
|
||||
Item: pd.Shape,
|
||||
Property: pd.Property,
|
||||
ContentItem: contentItem,
|
||||
ContentItemMetadata: contentItemMetadata
|
||||
)
|
||||
)
|
||||
);
|
||||
|
||||
return new LayoutComponentResult {
|
||||
ContentItem = contentItem,
|
||||
ContentItemMetadata = contentItemMetadata,
|
||||
Properties = properties
|
||||
};
|
||||
|
||||
}).ToList();
|
||||
|
||||
var tokenizedState = _tokenizer.Replace(layout.State, new Dictionary<string, object> { { "Content", context.Content.ContentItem } });
|
||||
|
||||
var renderLayoutContext = new LayoutContext {
|
||||
State = FormParametersHelper.ToDynamic(tokenizedState),
|
||||
LayoutRecord = layout,
|
||||
};
|
||||
|
||||
if (layout.GroupProperty != null) {
|
||||
var groupPropertyId = layout.GroupProperty.Id;
|
||||
var display = _displayHelperFactory.CreateHelper(new ViewContext { HttpContext = _services.WorkContext.HttpContext }, new ViewDataContainer());
|
||||
|
||||
// Index by PropertyWrapper shape.
|
||||
var groups = layoutComponents.GroupBy(x => {
|
||||
var propertyShape = ((IEnumerable<dynamic>)x.Properties.Items).First(p => ((PropertyRecord)p.Property).Id == groupPropertyId);
|
||||
|
||||
// clear the wrappers, as they shouldn't be needed to generate the grouping key itself
|
||||
// otherwise the DisplayContext.View is null, and throws an exception if a wrapper is rendered (#18558)
|
||||
((IShape)propertyShape).Metadata.Wrappers.Clear();
|
||||
|
||||
string key = Convert.ToString(display(propertyShape));
|
||||
return key;
|
||||
}).Select(x => new { Key = x.Key, Components = x });
|
||||
|
||||
var list = context.ElementShape.List = _services.New.List();
|
||||
foreach (var group in groups) {
|
||||
var localResult = layoutDescriptor.Render(renderLayoutContext, group.Components);
|
||||
|
||||
// Add the Context to the shape.
|
||||
localResult.Context(renderLayoutContext);
|
||||
list.Add(_services.New.LayoutGroup(Key: new MvcHtmlString(group.Key), List: localResult));
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
var layoutResult = layoutDescriptor.Render(renderLayoutContext, layoutComponents);
|
||||
|
||||
// Add the Context to the shape.
|
||||
layoutResult.Context(renderLayoutContext);
|
||||
|
||||
// Set the List shape to be the layout result.
|
||||
context.ElementShape.List = layoutResult;
|
||||
}
|
||||
|
||||
protected override void DescribeForm(DescribeContext context) {
|
||||
context.Form("ProjectionForm", factory => {
|
||||
var shape = (dynamic)factory;
|
||||
var form = shape.Fieldset(
|
||||
Id: "ProjectionForm",
|
||||
_QueryLayoutId: shape.SelectList(
|
||||
Id: "QueryLayoutId",
|
||||
Name: "QueryLayoutId",
|
||||
Title: T("For Query"),
|
||||
Description: T("The query to display.")),
|
||||
_ItemsToDisplay: shape.Textbox(
|
||||
Id: "ItemsToDisplay",
|
||||
Name: "ItemsToDisplay",
|
||||
Title: T("Items to display"),
|
||||
Value: "0",
|
||||
Description: T("The number of items to display. Enter 0 for no limit. When using pagination, this is the number of items per page."),
|
||||
Classes: new[] { "text", "medium", "tokenized" }),
|
||||
_Skip: shape.Textbox(
|
||||
Id: "Skip",
|
||||
Name: "Skip",
|
||||
Title: T("Offset"),
|
||||
Value: "0",
|
||||
Description: T("The number of items to skip (e.g., if 2 is entered, the first 2 items won't be diplayed)."),
|
||||
Classes: new[] { "text", "medium", "tokenized" }),
|
||||
_MaxItems: shape.Textbox(
|
||||
Id: "MaxItems",
|
||||
Name: "MaxItems",
|
||||
Title: T("MaxItems items"),
|
||||
Value: "20",
|
||||
Description: T("Maximum number of items which can be queried at once. Use 0 for unlimited. This is only used as a failsafe when the number of items comes from a user-provided source such as the query string."),
|
||||
Classes: new[] { "text", "medium", "tokenized" }),
|
||||
_PagerSuffix: shape.Textbox(
|
||||
Id: "PagerSuffix",
|
||||
Name: "PagerSuffix",
|
||||
Title: T("Suffix"),
|
||||
Description: T("Optional. Provide a suffix to use when multiple pagers are displayed on the same page, e.g., when using multiple Projection Widgets, or to define alternates."),
|
||||
Classes: new[] { "text", "medium", "tokenized" }),
|
||||
_DisplayPager: shape.Checkbox(
|
||||
Id: "DisplayPager",
|
||||
Name: "DisplayPager",
|
||||
Title: T("Show Pager"),
|
||||
Value: "true",
|
||||
Description: T("Check to add a pager to the list.")));
|
||||
|
||||
// Populate the list of queries and layouts.
|
||||
var layouts = _projectionManager.DescribeLayouts().SelectMany(x => x.Descriptors).ToList();
|
||||
var queries = _contentManager.Query<QueryPart, QueryPartRecord>().Join<TitlePartRecord>().OrderBy(x => x.Title).List()
|
||||
.Select(x => new QueryRecordEntry {
|
||||
Id = x.Id,
|
||||
Name = x.Name,
|
||||
LayoutRecordEntries = x.Layouts.Select(l => new LayoutRecordEntry {
|
||||
Id = l.Id,
|
||||
Description = GetLayoutDescription(layouts, l)
|
||||
})
|
||||
}).ToArray();
|
||||
|
||||
foreach (var queryRecord in queries.OrderBy(x => x.Name)) {
|
||||
form._QueryLayoutId.Add(new SelectListGroup { Name = queryRecord.Name });
|
||||
form._QueryLayoutId.Add(new SelectListItem { Text = queryRecord.Name + " " + T("(Default Layout)").Text, Value = queryRecord.Id + ";-1" });
|
||||
|
||||
foreach (var layoutRecord in queryRecord.LayoutRecordEntries.OrderBy(x => x.Description)) {
|
||||
form._QueryLayoutId.Add(new SelectListItem { Text = queryRecord.Name + " " + T("({0})", layoutRecord.Description).Text, Value = queryRecord.Id + ";" + layoutRecord.Id });
|
||||
}
|
||||
}
|
||||
|
||||
return form;
|
||||
});
|
||||
}
|
||||
|
||||
private static string GetLayoutDescription(IEnumerable<LayoutDescriptor> layouts, LayoutRecord l) {
|
||||
var descriptor = layouts.First(x => l.Category == x.Category && l.Type == x.Type);
|
||||
return String.IsNullOrWhiteSpace(l.Description) ? descriptor.Display(new LayoutContext { State = FormParametersHelper.ToDynamic(l.State) }).Text : l.Description;
|
||||
}
|
||||
|
||||
private class ViewDataContainer : IViewDataContainer {
|
||||
public ViewDataDictionary ViewData { get; set; }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,59 @@
|
||||
using System;
|
||||
using System.Globalization;
|
||||
using Orchard.Layouts.Framework.Elements;
|
||||
using Orchard.Layouts.Helpers;
|
||||
|
||||
namespace Orchard.Layouts.Elements {
|
||||
public class Projection : Element {
|
||||
|
||||
public override bool HasEditor {
|
||||
get { return true; }
|
||||
}
|
||||
|
||||
public override string Category {
|
||||
get { return "Content"; }
|
||||
}
|
||||
|
||||
public string QueryLayoutId {
|
||||
get { return State.Get("QueryLayoutId"); }
|
||||
set { State["QueryLayoutId"] = value; }
|
||||
}
|
||||
|
||||
public int? QueryId {
|
||||
get {
|
||||
return String.IsNullOrWhiteSpace(QueryLayoutId) ? null : QueryLayoutId.Split(new[] { ';' })[0].ToInt32();
|
||||
}
|
||||
}
|
||||
|
||||
public int? LayoutId {
|
||||
get {
|
||||
return String.IsNullOrWhiteSpace(QueryLayoutId) ? null : QueryLayoutId.Split(new[] { ';' })[1].ToInt32();
|
||||
}
|
||||
}
|
||||
|
||||
public int ItemsToDisplay {
|
||||
get { return State.Get("ItemsToDisplay").ToInt32().GetValueOrDefault(); }
|
||||
set { State["ItemsToDisplay"] = value.ToString(CultureInfo.InvariantCulture); }
|
||||
}
|
||||
|
||||
public int Skip {
|
||||
get { return State.Get("Skip").ToInt32().GetValueOrDefault(); }
|
||||
set { State["Skip"] = value.ToString(CultureInfo.InvariantCulture); }
|
||||
}
|
||||
|
||||
public int MaxItems {
|
||||
get { return State.Get("MaxItems").ToInt32().GetValueOrDefault(); }
|
||||
set { State["MaxItems"] = value.ToString(CultureInfo.InvariantCulture); }
|
||||
}
|
||||
|
||||
public string PagerSuffix {
|
||||
get { return State.Get("PagerSuffix"); }
|
||||
set { State["PagerSuffix"] = value; }
|
||||
}
|
||||
|
||||
public bool DisplayPager {
|
||||
get { return State.Get("DisplayPager").ToBoolean().GetValueOrDefault(); }
|
||||
set { State["DisplayPager"] = value.ToString(CultureInfo.InvariantCulture); }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -22,3 +22,8 @@ Features:
|
||||
Description: Adds a Markdown element to the system.
|
||||
Category: Layout
|
||||
Dependencies: Orchard.Layouts, Markdown
|
||||
Orchard.Layouts.Projections:
|
||||
Name: Projection Element
|
||||
Description: Adds a Projection element to the system.
|
||||
Category: Layout
|
||||
Dependencies: Orchard.Layouts, Orchard.Projections
|
||||
|
||||
@@ -198,6 +198,10 @@
|
||||
<Project>{73a7688a-5bd3-4f7e-adfa-ce36c5a10e3b}</Project>
|
||||
<Name>Orchard.MediaLibrary</Name>
|
||||
</ProjectReference>
|
||||
<ProjectReference Include="..\Orchard.Projections\Orchard.Projections.csproj">
|
||||
<Project>{5531e894-d259-45a3-aa61-26dbe720c1ce}</Project>
|
||||
<Name>Orchard.Projections</Name>
|
||||
</ProjectReference>
|
||||
<ProjectReference Include="..\Orchard.Themes\Orchard.Themes.csproj">
|
||||
<Project>{cde24a24-01d3-403c-84b9-37722e18dfb7}</Project>
|
||||
<Name>Orchard.Themes</Name>
|
||||
@@ -210,10 +214,12 @@
|
||||
<ItemGroup>
|
||||
<Compile Include="AdminMenu.cs" />
|
||||
<Compile Include="Controllers\BlueprintAdminController.cs" />
|
||||
<Compile Include="Drivers\ProjectionDriver.cs" />
|
||||
<Compile Include="Drivers\ImageDriver.cs" />
|
||||
<Compile Include="Drivers\ParagraphDriver.cs" />
|
||||
<Compile Include="Elements\Image.cs" />
|
||||
<Compile Include="Elements\Paragraph.cs" />
|
||||
<Compile Include="Elements\Projection.cs" />
|
||||
<Compile Include="Filters\ControllerAccessorFilter.cs" />
|
||||
<Compile Include="Framework\Display\ElementCreatingDisplayShapeContext.cs" />
|
||||
<Compile Include="Handlers\ElementDriversCoordinator.cs" />
|
||||
@@ -353,6 +359,9 @@
|
||||
<ItemGroup>
|
||||
<Content Include="Views\Element-Snippets-Snippet.Design.cshtml" />
|
||||
</ItemGroup>
|
||||
<ItemGroup>
|
||||
<Content Include="Views\Element-Content-Projection.cshtml" />
|
||||
</ItemGroup>
|
||||
<PropertyGroup>
|
||||
<VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
|
||||
<VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
@{
|
||||
var list = Model.List;
|
||||
var pager = Model.Pager;
|
||||
|
||||
if (list != null) {
|
||||
@Display(list)
|
||||
}
|
||||
|
||||
if (pager != null) {
|
||||
@Display(pager)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user