nissl-lab-npoi/main/POIFS/FileSystem/NPOIFSDocument.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.
==================================================================== */


using NPOI.POIFS.Common;
using NPOI.POIFS.Dev;
using NPOI.POIFS.Properties;
using NPOI.Util;
using System.IO;
using System.Collections.Generic;
using System;
using System.Text;
using System.Collections;
using NPOI.POIFS.EventFileSystem;

namespace NPOI.POIFS.FileSystem
{
    /**
 * This class manages a document in the NIO POIFS filesystem.
 * This is the {@link NPOIFSFileSystem} version.
 */
    public class NPOIFSDocument : POIFSViewable
    {
        private readonly DocumentProperty _property;

        private readonly NPOIFSFileSystem _filesystem;
        private NPOIFSStream _stream;
        private int _block_size;

        /**
    * Constructor for an existing Document 
    */
        public NPOIFSDocument(DocumentNode document)
            : this((DocumentProperty)document.Property,
                 ((DirectoryNode)document.Parent).NFileSystem)
        {
        }
        /**
         * Constructor for an existing Document 
         */
        public NPOIFSDocument(DocumentProperty property, NPOIFSFileSystem filesystem)
        {
            this._property = property;
            this._filesystem = filesystem;

            if (property.Size < POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE)
            {
                _stream = new NPOIFSStream(_filesystem.GetMiniStore(), property.StartBlock);
                _block_size = _filesystem.GetMiniStore().GetBlockStoreBlockSize();
            }
            else
            {
                _stream = new NPOIFSStream(_filesystem, property.StartBlock);
                _block_size = _filesystem.GetBlockStoreBlockSize();
            }
        }

        /**
         * Constructor for a new Document
         *
         * @param name the name of the POIFSDocument
         * @param stream the InputStream we read data from
         */
        public NPOIFSDocument(String name, NPOIFSFileSystem filesystem, Stream stream)
        {
            this._filesystem = filesystem;
            // sotre it
            int length = Store(stream);

            // Build the property for it
            this._property = new DocumentProperty(name, length);
            _property.StartBlock = _stream.GetStartBlock();
        }

        private int Store(Stream inStream)
        {
            int bigBlockSize = POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE;
            //BufferedStream bis = new BufferedStream(stream, bigBlockSize + 1);
            //bis.mark(bigBlockSize);

            //// Buffer the contents into memory. This is a bit icky...
            //// TODO Replace with a buffer up to the mini stream size, then streaming write
            //byte[] contents;
            //if (stream is MemoryStream)
            //{
            //    MemoryStream bais = (MemoryStream)stream;
            //    contents = new byte[bais.Length];
            //    bais.Read(contents, 0, contents.Length);
            //}
            //else
            //{
            //    MemoryStream baos = new MemoryStream();
            //    IOUtils.Copy(stream, baos);
            //    contents = baos.ToArray();
            //}

            // Do we need to store as a mini stream or a full one?
            if (inStream.Length < bigBlockSize)
            {
                _stream = new NPOIFSStream(_filesystem.GetMiniStore());
                _block_size = _filesystem.GetMiniStore().GetBlockStoreBlockSize();
            }
            else
            {
                _stream = new NPOIFSStream(_filesystem);
                _block_size = _filesystem.GetBlockStoreBlockSize();
            }

            // start from the beginning 
            //bis.Seek(0, SeekOrigin.Begin);

            // Store it
            Stream outStream = _stream.GetOutputStream();
            byte[] buf = new byte[1024];
            int length = 0;

            //for (int readBytes; (readBytes = bis.Read(buf, 0, buf.Length)) != 0; length += readBytes)
            //{
            //    outStream.Write(buf, 0, readBytes);
            //}

            for (int readBytes = 0; ; )
            {
                readBytes = inStream.Read(buf, 0, buf.Length);
                if (readBytes <= 0)
                    break;
                length += readBytes;
                outStream.Write(buf, 0, readBytes);
            }
            // Pad to the end of the block with -1s
            int usedInBlock = length % _block_size;
            if (usedInBlock != 0 && usedInBlock != _block_size)
            {
                int toBlockEnd = _block_size - usedInBlock;
                byte[] padding = new byte[toBlockEnd];
                Arrays.Fill(padding, (byte)0xFF);
                outStream.Write(padding, 0, padding.Length);
            }

            // Tidy and return the length
            outStream.Close();
            return length;
        }

        public NPOIFSDocument(String name, int size, NPOIFSFileSystem filesystem, POIFSWriterListener Writer)
        {
            this._filesystem = filesystem;

            if (size < POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE)
            {
                _stream = new NPOIFSStream(filesystem.GetMiniStore());
                _block_size = _filesystem.GetMiniStore().GetBlockStoreBlockSize();
            }
            else
            {
                _stream = new NPOIFSStream(filesystem);
                _block_size = _filesystem.GetBlockStoreBlockSize();
            }

            Stream innerOs = _stream.GetOutputStream();
            DocumentOutputStream os = new DocumentOutputStream(innerOs, size);
            POIFSDocumentPath path = new POIFSDocumentPath(name.Split([@"\\"], StringSplitOptions.RemoveEmptyEntries));
            String docName = path.GetComponent(path.Length - 1);
            POIFSWriterEvent event1 = new POIFSWriterEvent(os, path, docName, size);
            Writer.ProcessPOIFSWriterEvent(event1);
            innerOs.Close();

            // And build the property for it
            this._property = new DocumentProperty(name, size);
            _property.StartBlock = (/*setter*/_stream.GetStartBlock());
        }
        /**
        * Frees the underlying stream and property
        */
        internal void Free() {
            _stream.Free();
            _property.StartBlock = (POIFSConstants.END_OF_CHAIN);
        }

        internal NPOIFSFileSystem FileSystem
        {
            get
            {
                return _filesystem;
            }
        }

        public int GetDocumentBlockSize()
        {
            return _block_size;
        }

        public IEnumerator<ByteBuffer> GetBlockIterator()
        {
            if (Size > 0)
            {
                return _stream.GetBlockIterator();
            }
            else
            {
                //List<byte[]> empty = Collections.emptyList();
                List<ByteBuffer> empty = new List<ByteBuffer>();
                return empty.GetEnumerator();
            }
        }

        /**
         * @return size of the document
         */
        public int Size
        {
            get
            {
                return _property.Size;
            }
        }
        public void ReplaceContents(Stream stream)
        {
            Free();
            int size = Store(stream);
            _property.StartBlock = (_stream.GetStartBlock());
            _property.UpdateSize(size);
        }
        /**
         * @return the instance's DocumentProperty
         */
        public DocumentProperty DocumentProperty
        {
            get
            {
                return _property;
            }
        }

        /**
         * Get an array of objects, some of which may implement POIFSViewable
         *
         * @return an array of Object; may not be null, but may be empty
         */
        protected Object[] GetViewableArray()
        {
            String result = "<NO DATA>";
            if (Size > 0)
            {
                // Get all the data into a single array
                byte[] data = new byte[Size];
                int offset = 0;
                foreach (ByteBuffer buffer in _stream)
                {
                    int length = Math.Min(_block_size, data.Length - offset);
                    buffer.Read(data, offset, length);
                    offset += length;
                }
                result = HexDump.Dump(data, 0, 0);
            }

            return new String[] { result };
        }

        /**
         * Get an Iterator of objects, some of which may implement POIFSViewable
         *
         * @return an Iterator; may not be null, but may have an empty back end
         *		 store
         */
        protected IEnumerator<Object> GetViewableIterator()
        {
            //  return Collections.EMPTY_LIST.iterator();
            return null;

        }


        /**
         * Provides a short description of the object, to be used when a
         * POIFSViewable object has not provided its contents.
         *
         * @return short description
         */
        protected String GetShortDescription()
        {
            StringBuilder buffer = new StringBuilder();

            buffer.Append("Document: \"").Append(_property.Name).Append("\"");
            buffer.Append(" size = ").Append(Size);
            return buffer.ToString();
        }

        #region POIFSViewable Members

        public bool PreferArray
        {
            get { return true; }
        }

        public string ShortDescription
        {
            get { return GetShortDescription(); }
        }

        public Object[] ViewableArray
        {
            get { return GetViewableArray(); }
        }

        public IEnumerator<Object> ViewableIterator
        {
            get { return GetViewableIterator(); }
        }

        #endregion
    }
}