Orchard/src/Orchard.Web/Modules/Orchard.DesignerTools/Services/ShapeTracingFactory.cs

using System;
using System.IO;
using System.Web;
using System.Xml;
using Orchard.DisplayManagement.Descriptors;
using Orchard.DisplayManagement.Implementation;
using Orchard.DisplayManagement.Shapes;
using Orchard.Environment.Extensions;
using Orchard.FileSystems.WebSite;
using Orchard.Themes;

namespace Orchard.DesignerTools.Services {
    [OrchardFeature("Orchard.DesignerTools")]
    public class ShapeTracingFactory : IShapeFactoryEvents, IShapeDisplayEvents {
        private readonly WorkContext _workContext;
        private readonly IShapeTableManager _shapeTableManager;
        private readonly IThemeManager _themeManager;
        private readonly IWebSiteFolder _webSiteFolder;

        public ShapeTracingFactory(WorkContext workContext, IShapeTableManager shapeTableManager, IThemeManager themeManager, IWebSiteFolder webSiteFolder) {
            _workContext = workContext;
            _shapeTableManager = shapeTableManager;
            _themeManager = themeManager;
            _webSiteFolder = webSiteFolder;
        }

        public void Creating(ShapeCreatingContext context) {
        }

        public void Created(ShapeCreatedContext context) {
            if (context.ShapeType != "Layout"
                && context.ShapeType != "DocumentZone"
                && context.ShapeType != "PlaceChildContent"
                && context.ShapeType != "ContentZone"
                && context.ShapeType != "ShapeTracingMeta") {
                
                var shape = context.Shape;
                var shapeMetadata = (ShapeMetadata)context.Shape.Metadata;

                var currentTheme = _themeManager.GetRequestTheme(_workContext.HttpContext.Request.RequestContext);

                var shapeTable = _shapeTableManager.GetShapeTable(currentTheme.Id);

                if(!shapeTable.Descriptors.ContainsKey(shapeMetadata.Type)) {
                    return;
                }

                var descriptor = shapeTable.Descriptors[shapeMetadata.Type];

                shapeMetadata.Wrappers.Add("ShapeTracingWrapper");
                
                shape.Definition = descriptor.BindingSource;

                try {
                    if (_webSiteFolder.FileExists(descriptor.BindingSource)) {
                        shape.DefinitionContent = _webSiteFolder.ReadFile(descriptor.BindingSource);
                    }
                }
                catch {
                    // the url might be invalid in case of a code shape
                }

                shape.Dump = DumpObject(shape);
            }
        }

        static string DumpObject(object o) {
            var dumper = new ObjectDumper(6);
            var el = dumper.Dump(o, "Model");
            using (var sw = new StringWriter()) {
                el.WriteTo(new XmlTextWriter(sw) { Formatting = Formatting.Indented });
                return sw.ToString();
            }
        }

        public void Displaying(ShapeDisplayingContext context) {
            var shapeMetadata = (ShapeMetadata)context.Shape.Metadata;
            
            if(!shapeMetadata.Wrappers.Contains("ShapeTracingWrapper")) {
                return;
            }

            if( shapeMetadata.PlacementSource != null && _webSiteFolder.FileExists(shapeMetadata.PlacementSource)) {
                context.Shape.PlacementContent = _webSiteFolder.ReadFile(shapeMetadata.PlacementSource);
            }
        }

        public void Displayed(ShapeDisplayedContext context) {
        }
    }
}