PreparedPage.cs

using FastReport.Engine;
using FastReport.Utils;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.IO;
using System.Windows.Forms;

namespace FastReport.Preview
{
    internal partial class PreparedPage : IDisposable
    {
        #region Fields

        private XmlItem xmlItem;
        private PreparedPages preparedPages;
        private SizeF pageSize;
        private long tempFilePosition;
        private bool uploaded;
        private PreparedPagePostprocessor postprocessor;

        #endregion Fields

        #region Properties

        private Report Report
        {
            get { return preparedPages.Report; }
        }

        private bool UseFileCache
        {
            get { return Report.UseFileCache; }
        }

        public XmlItem Xml
        {
            get { return xmlItem; }
            set
            {
                xmlItem = value;
                value.Parent = null;
            }
        }

        public SizeF PageSize
        {
            get
            {
                if (pageSize.IsEmpty)
                {
                    ReCalcSizes();
                }
                return pageSize;
            }
            set
            {
                pageSize = value;
            }
        }

        public int CurPosition
        {
            get { return xmlItem.Count; }
        }

        #endregion Properties

        #region Private Methods

        private bool DoAdd(Base c, XmlItem item)
        {
            if (c == null)
                return false;
            ReportEngine engine = Report.Engine;
            bool isRunning = Report.IsRunning && engine != null;
            if (c is ReportComponentBase)
            {
                if (isRunning && !engine.CanPrint(c as ReportComponentBase))
                    return false;
            }

            item = item.Add();
            using (FRWriter writer = new FRWriter(item))
            {
                writer.SerializeTo = SerializeTo.Preview;
                writer.SaveChildren = false;
                writer.BlobStore = preparedPages.BlobStore;
                writer.Write(c);
            }
            if (isRunning)
                engine.AddObjectToProcess(c, item);

            if ((c.Flags & Flags.CanWriteChildren) == 0)
            {
                ObjectCollection childObjects = c.ChildObjects;
                foreach (Base obj in childObjects)
                {
                    DoAdd(obj, item);
                }
            }
            return true;
        }

        private Base ReadObject(Base parent, XmlItem item, bool readChildren, FRReader reader)
        {
            string objName = item.Name;

            // try to find the object in the dictionary
            Base obj = preparedPages.Dictionary.GetObject(objName);

            // object not found, objName is type name
            if (obj == null)
            {
                Type type = RegisteredObjects.FindType(objName);
                if (type == null)
                    return null;
                obj = Activator.CreateInstance(type) as Base;
            }
            obj.SetRunning(true);

            // read object's properties
            if (!item.IsNullOrEmptyProps())
            {
                // since the BlobStore is shared resource, lock it to avoid problems with multi-thread access.
                // this may happen in the html export that uses several threads to export one report.
                lock (reader.BlobStore)
                {
                    reader.Read(obj, item);
                }

                if (obj is TextObject txt)
                    ProcessText(txt);
            }

            if (readChildren)
            {
                for (int i = 0; i < item.Count; i++)
                {
                    ReadObject(obj, item[i], true, reader);
                }
            }

            obj.Parent = parent;
            return obj;
        }

        private void UpdateUnlimitedPage(Base obj, XmlItem item)
        {
            item.Clear();
            using (FRWriter writer = new FRWriter(item))
            {
                writer.SerializeTo = SerializeTo.Preview;
                writer.SaveChildren = false;
                writer.BlobStore = preparedPages.BlobStore;
                writer.Write(obj);
            }
            foreach (Base child in obj.ChildObjects)
            {
                UpdateUnlimitedPage(child, item.Add());
            }
        }

        #endregion Private Methods

        #region Internal Methods

        internal ReportPage ReadPage(Base parent, XmlItem item, bool readchild, FRReader reader)
        {
            ReportPage page = ReadObject(parent, item, false, reader) as ReportPage;
            if (readchild)
                for (int i = 0; i < item.Count; i++)
                {
                    ReadObject(page, item[i], true, reader);
                }
            return page;
        }

        internal ReportPage StartGetPage(int index)
        {
            Load();
            ReportPage page;
            using (FRReader reader = new FRReader(null))
            {
                reader.DeserializeFrom = SerializeTo.Preview;
                reader.ReadChildren = false;
                reader.BlobStore = preparedPages.BlobStore;
                page = ReadPage(null, xmlItem, false, reader);
                if (!(page.UnlimitedHeight || page.UnlimitedWidth))
                {
                    page.Dispose();
                    page = ReadPage(null, xmlItem, true, reader);
                    page.SetReport(preparedPages.Report);
                    postprocessor = new PreparedPagePostprocessor();
                    postprocessor.Postprocess(page);
                    postprocessor = null;
                }
                else
                {
                    page.SetReport(preparedPages.Report);
                    postprocessor = new PreparedPagePostprocessor();
                    postprocessor.PostprocessUnlimited(this, page);
                }
            }
            if (page.MirrorMargins && (index + 1) % 2 == 0)
            {
                float f = page.LeftMargin;
                page.LeftMargin = page.RightMargin;
                page.RightMargin = f;
            }
            return page;
        }

        internal void EndGetPage(ReportPage page)
        {
            if (postprocessor != null) postprocessor = null;
            if (page != null)
                page.Dispose();
            ClearUploadedXml();
        }

        internal IEnumerable<Base> GetPageItems(ReportPage page, bool postprocess)
        {
            if (!(page.UnlimitedHeight || page.UnlimitedWidth))
            {
                foreach (Base child in page.ChildObjects)
                {
                    if (postprocess) yield return child;
                    else
                        using (child)
                            yield return child;
                }
            }
            else
            {
                if (Export.ExportBase.HAVE_TO_WORK_WITH_OVERLAY)
#pragma warning disable CS0162 // Unreachable code detected
                    foreach (Base child in page.ChildObjects)
#pragma warning restore CS0162 // Unreachable code detected
                    {
                        if (child is OverlayBand)
                            yield return child;
                    }

                using (FRReader reader = new FRReader(null))
                {
                    reader.DeserializeFrom = SerializeTo.Preview;
                    reader.ReadChildren = false;
                    reader.BlobStore = preparedPages.BlobStore;
                    for (int i = 0; i < xmlItem.Count; i++)
                    {
                        if (postprocess) yield return ReadObject(page, xmlItem[i], true, reader);
                        else
                            using (Base obj = ReadObject(page, xmlItem[i], true, reader))
                            {
                                using (Base obj2 = postprocessor.PostProcessBandUnlimitedPage(obj))
                                    yield return obj2;
                            }
                    }
                }
            }
        }

        internal string GetName()
        {
            using (FRReader reader = new FRReader(null))
            {
                reader.DeserializeFrom = SerializeTo.Preview;
                reader.ReadChildren = false;
                reader.BlobStore = preparedPages.BlobStore;
                ReportPage page = ReadObject(null, xmlItem, false, reader) as ReportPage;
                return page.Name;
            }
        }

        internal void ReCalcSizes()
        {
            XmlItem item = xmlItem;
            using (FRReader reader = new FRReader(null, item))
            {
                reader.DeserializeFrom = SerializeTo.Preview;
                reader.BlobStore = preparedPages.BlobStore;
                reader.ReadChildren = false;

                using (ReportPage page = ReadPage(Report, item, false, reader))
                {
                    if (page.UnlimitedHeight | page.UnlimitedWidth)
                    {

                        float maxWidth = 0.0f;
                        float maxHeight = 0.0f;
                        for (int i = 0; i < item.Count; i++)
                        {
                            using (Base obj = ReadObject(page, item[i], true, reader))
                            {
                                if (obj is BandBase)
                                {
                                    BandBase band = obj as BandBase;
                                    float bandsHeight = band.Top + band.Height;
                                    if (maxHeight < bandsHeight)
                                        maxHeight = bandsHeight;
                                    float bandWidth = 0.0f;
                                    foreach (ComponentBase comp in band.Objects)
                                    {
                                        if ((comp.Anchor & AnchorStyles.Right) == 0 && comp.Dock == DockStyle.None)
                                        {
                                            bandWidth = Math.Max(bandWidth, comp.Left + comp.Width);
                                        }
                                    }
                                    if (maxWidth < bandWidth)
                                        maxWidth = bandWidth;
                                }
                            }
                        }

                        if (page.UnlimitedHeight)
                            page.UnlimitedHeightValue = maxHeight + (page.TopMargin + page.BottomMargin) * Units.Millimeters;
                        if (page.UnlimitedWidth)
                            page.UnlimitedWidthValue = maxWidth + (page.LeftMargin + page.RightMargin) * Units.Millimeters;

                    }
                    pageSize = new SizeF(page.WidthInPixels, page.HeightInPixels);

                    using (FRWriter writer = new FRWriter(item))
                    {
                        writer.SerializeTo = SerializeTo.Preview;
                        writer.SaveChildren = false;
                        writer.BlobStore = preparedPages.BlobStore;
                        writer.Write(page);
                    }
                }
            }
        }

        #endregion Internal Methods

        #region Public Methods

        public PreparedPage(ReportPage page, PreparedPages preparedPages)
        {
            this.preparedPages = preparedPages;
            xmlItem = new XmlItem();

            // page == null when we load prepared report from a file
            if (page != null)
            {
                using (FRWriter writer = new FRWriter(xmlItem))
                {
                    writer.SerializeTo = SerializeTo.Preview;
                    writer.SaveChildren = false;
                    writer.Write(page);
                }

                pageSize = new SizeF(page.WidthInPixels, page.HeightInPixels);
            }
        }

        public bool AddBand(BandBase band)
        {
            return DoAdd(band, xmlItem);
        }

        public ReportPage GetPage()
        {
            Load();
            ReportPage page;
            using (FRReader reader = new FRReader(null))
            {
                reader.DeserializeFrom = SerializeTo.Preview;
                reader.ReadChildren = false;
                reader.BlobStore = preparedPages.BlobStore;
                page = ReadPage(null, xmlItem, true, reader);
            }
            page.SetReport(preparedPages.Report);
            new PreparedPagePostprocessor().Postprocess(page);
            ClearUploadedXml();
            return page;
        }

        public void Load()
        {
            if (UseFileCache && uploaded)
            {
                preparedPages.TempFile.Position = tempFilePosition;
                XmlReader reader = new XmlReader(preparedPages.TempFile);
                reader.Read(xmlItem);
            }
        }

        public void ClearUploadedXml()
        {
            if (UseFileCache && uploaded)
                xmlItem.Clear();
        }

        public void Upload()
        {
            if (UseFileCache && !uploaded)
            {
                preparedPages.TempFile.Seek(0, SeekOrigin.End);
                tempFilePosition = preparedPages.TempFile.Position;

                XmlWriter writer = new XmlWriter(preparedPages.TempFile);
                writer.Write(xmlItem);

                xmlItem.Clear();
                uploaded = true;
            }
        }

        public XmlItem CutObjects(int index)
        {
            XmlItem result = new XmlItem();
            while (xmlItem.Count > index)
            {
                result.AddItem(xmlItem[index]);
            }
            return result;
        }

        public void PasteObjects(XmlItem objects, float deltaX, float deltaY)
        {
            if (objects.Count > 0)
            {
                while (objects.Count > 0)
                {
                    XmlItem obj = objects[0];

                    // shift the object's location
                    float objX = (obj.GetProp("l") != "") ?
                      Converter.StringToFloat(obj.GetProp("l")) : 0;
                    float objY = (obj.GetProp("t") != "") ?
                      Converter.StringToFloat(obj.GetProp("t")) : 0;
                    obj.SetProp("l", Converter.ToString(objX + deltaX));
                    obj.SetProp("t", Converter.ToString(objY + deltaY));

                    // add object to a page
                    xmlItem.AddItem(obj);
                }
            }
        }

        public float GetLastY()
        {
            float result = 0;

            for (int i = 0; i < xmlItem.Count; i++)
            {
                XmlItem xi = xmlItem[i];

                BandBase obj = preparedPages.Dictionary.GetOriginalObject(xi.Name) as BandBase;
                if (obj != null && !(obj is PageFooterBand) && !(obj is OverlayBand))
                {
                    string s = xi.GetProp("t");
                    float top = (s != "") ? Converter.StringToFloat(s) : obj.Top;
                    s = xi.GetProp("h");
                    float height = (s != "") ? Converter.StringToFloat(s) : obj.Height;

                    if (top + height > result)
                        result = top + height;
                }
            }

            return result;
        }

        public bool ContainsBand(Type bandType)
        {
            for (int i = 0; i < xmlItem.Count; i++)
            {
                XmlItem xi = xmlItem[i];

                BandBase obj = preparedPages.Dictionary.GetOriginalObject(xi.Name) as BandBase;
                if (obj != null && obj.GetType() == bandType)
                    return true;
            }

            return false;
        }

        public bool ContainsBand(string bandName)
        {
            for (int i = 0; i < xmlItem.Count; i++)
            {
                XmlItem xi = xmlItem[i];

                BandBase obj = preparedPages.Dictionary.GetOriginalObject(xi.Name) as BandBase;
                if (obj != null && obj.Name == bandName)
                    return true;
            }

            return false;
        }

        public void Dispose()
        {
            xmlItem.Dispose();
        }

        #endregion Public Methods
    }
}