NPOI/Code/Npoi.Core.Ooxml/POIXMLDocument.cs

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for Additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

namespace Npoi.Core
{
    using Npoi.Core.OpenXml4Net;
    using Npoi.Core.OpenXml4Net.Exceptions;
    using Npoi.Core.OpenXml4Net.OPC;
    using Npoi.Core.POIFS.Common;
    using Npoi.Core.Util;
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Reflection;

    public abstract class POIXMLDocument : POIXMLDocumentPart
    {
        public static String DOCUMENT_CREATOR = "NPOI";

        // OLE embeddings relation name
        public static String OLE_OBJECT_REL_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject";

        // Embedded OPC documents relation name
        public static String PACK_OBJECT_REL_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/package";

        /** The OPC Package */
        private OPCPackage pkg;

        /**
         * The properties of the OPC namespace, opened as needed
         */
        private POIXMLProperties properties;

        protected POIXMLDocument(OPCPackage pkg)
            : base(pkg)
        {
            this.pkg = pkg;
        }

        /**
         * Wrapper to open a namespace, returning an IOException
         *  in the event of a problem.
         * Works around shortcomings in java's this() constructor calls
         */

        public static OPCPackage OpenPackage(string path)
        {
            try
            {
                return OPCPackage.Open(path);
            }
            catch (InvalidFormatException e)
            {
                throw new IOException(e.ToString());
            }
        }

        public OPCPackage Package
        {
            get
            {
                return this.pkg;
            }
        }

        protected PackagePart CorePart
        {
            get
            {
                return GetPackagePart();
            }
        }

        /**
         * Retrieves all the PackageParts which are defined as
         *  relationships of the base document with the
         *  specified content type.
         */

        protected PackagePart[] GetRelatedByType(string contentType)
        {
            PackageRelationshipCollection partsC =
                GetPackagePart().GetRelationshipsByType(contentType);

            PackagePart[] parts = new PackagePart[partsC.Size];
            int count = 0;
            foreach (PackageRelationship rel in partsC)
            {
                parts[count] = GetPackagePart().GetRelatedPart(rel);
                count++;
            }
            return parts;
        }

        /**
         * Checks that the supplied Stream (which MUST
         *  support mark and reSet, or be a PushbackStream)
         *  has a OOXML (zip) header at the start of it.
         * If your Stream does not support mark / reSet,
         *  then wrap it in a PushBackStream, then be
         *  sure to always use that, and not the original!
         * @param inp An Stream which supports either mark/reSet, or is a PushbackStream
         */

        public static bool HasOOXMLHeader(Stream inp)
        {
            // We want to peek at the first 4 bytes

            byte[] header = new byte[4];
            IOUtils.ReadFully(inp, header);

            // Wind back those 4 bytes
            if (inp is PushbackStream)
            {
                PushbackStream pin = (PushbackStream)inp;
                pin.Position = pin.Position - 4;
            }
            else
            {
                inp.Position = 0;
            }

            // Did it match the ooxml zip signature?
            return (
                    header[0] == POIFSConstants.OOXML_FILE_HEADER[0] &&
                    header[1] == POIFSConstants.OOXML_FILE_HEADER[1] &&
                    header[2] == POIFSConstants.OOXML_FILE_HEADER[2] &&
                    header[3] == POIFSConstants.OOXML_FILE_HEADER[3]
            );
        }

        /**
         * Get the document properties. This gives you access to the
         *  core ooxml properties, and the extended ooxml properties.
         */

        public POIXMLProperties GetProperties()
        {
            if (properties == null)
            {
                try
                {
                    properties = new POIXMLProperties(pkg);
                }
                catch (Exception e)
                {
                    throw new POIXMLException(e);
                }
            }
            return properties;
        }

        /**
         * Get the document's embedded files.
         */

        public abstract List<PackagePart> GetAllEmbedds();

        protected void Load(POIXMLFactory factory)
        {
            Dictionary<PackagePart, POIXMLDocumentPart> context = new Dictionary<PackagePart, POIXMLDocumentPart>();
            try
            {
                Read(factory, context);
            }
            catch (OpenXml4NetException e)
            {
                throw new POIXMLException(e);
            }
            OnDocumentRead();
            context.Clear();
        }

        /**
         * Closes the underlying {@link OPCPackage} from which this
         *  document was read, if there is one
         */

        public void Close()
        {
            if (pkg != null)
            {
                if (pkg.GetPackageAccess() == PackageAccess.READ)
                {
                    pkg.Revert();
                }
                else
                {
                    pkg.Close();
                }
                pkg = null;
            }
        }

        /**
         * Write out this document to an Outputstream.
         *
         * @param stream - the java Stream you wish to write the file to
         *
         * @exception IOException if anything can't be written.
         */

        public void Write(Stream stream)
        {
            if (!this.GetProperties().CustomProperties.Contains("Generator"))
                this.GetProperties().CustomProperties.AddProperty("Generator", "NPOI");
            if (!this.GetProperties().CustomProperties.Contains("Generator Version"))
                this.GetProperties().CustomProperties.AddProperty("Generator Version", typeof(POIXMLDocument).GetTypeInfo().Assembly.GetName().Version.ToString(3));
            //force all children to commit their Changes into the underlying OOXML Package
            List<PackagePart> context = new List<PackagePart>();
            OnSave(context);
            context.Clear();

            //save extended and custom properties
            GetProperties().Commit();

            Package.Save(stream);
        }
    }
}