BinaryObjectScanner/BurnOutSharp.Builders/MicrosoftCabinet.cs

using System.Collections.Generic;
using System.IO;
using System.Text;
using BurnOutSharp.Models.MicrosoftCabinet;
using BurnOutSharp.Utilities;

namespace BurnOutSharp.Builders
{
    // TODO: Add multi-cabinet reading
    public class MicrosoftCabinet
    {
        #region Byte Data

        /// <summary>
        /// Parse a byte array into a Microsoft Cabinet file
        /// </summary>
        /// <param name="data">Byte array to parse</param>
        /// <param name="offset">Offset into the byte array</param>
        /// <returns>Filled cabinet on success, null on error</returns>
        public static Cabinet ParseCabinet(byte[] data, int offset)
        {
            // If the data is invalid
            if (data == null)
                return null;

            // If the offset is out of bounds
            if (offset < 0 || offset >= data.Length)
                return null;

            // Create a memory stream and parse that
            MemoryStream dataStream = new MemoryStream(data, offset, data.Length - offset);
            return ParseCabinet(dataStream);
        }

        #endregion

        #region Stream Data

        /// <summary>
        /// Parse a Stream into a Microsoft Cabinet file
        /// </summary>
        /// <param name="data">Stream to parse</param>
        /// <returns>Filled cabinet on success, null on error</returns>
        public static Cabinet ParseCabinet(Stream data)
        {
            // If the data is invalid
            if (data == null || data.Length == 0 || !data.CanSeek || !data.CanRead)
                return null;

            // If the offset is out of bounds
            if (data.Position < 0 || data.Position >= data.Length)
                return null;

            // Cache the current offset
            int initialOffset = (int)data.Position;

            // Create a new cabinet to fill
            var cabinet = new Cabinet();

            #region Cabinet Header

            // Try to parse the cabinet header
            var cabinetHeader = ParseCabinetHeader(data);
            if (cabinetHeader == null)
                return null;

            // Set the cabinet header
            cabinet.Header = cabinetHeader;

            #endregion

            #region Folders

            // Set the folder array
            cabinet.Folders = new CFFOLDER[cabinetHeader.FolderCount];

            // Try to parse each folder, if we have any
            for (int i = 0; i < cabinetHeader.FolderCount; i++)
            {
                var folder = ParseFolder(data, cabinetHeader);
                if (folder == null)
                    return null;

                // Set the folder
                cabinet.Folders[i] = folder;
            }

            #endregion

            #region Files

            // Get the files offset
            int filesOffset = (int)cabinetHeader.FilesOffset + initialOffset;
            if (filesOffset > data.Length)
                return null;

            // Seek to the offset
            data.Seek(filesOffset, SeekOrigin.Begin);

            // Set the file array
            cabinet.Files = new CFFILE[cabinetHeader.FileCount];

            // Try to parse each file, if we have any
            for (int i = 0; i < cabinetHeader.FileCount; i++)
            {
                var file = ParseFile(data);
                if (file == null)
                    return null;

                // Set the file
                cabinet.Files[i] = file;
            }

            #endregion

            return cabinet;
        }

        /// <summary>
        /// Parse a Stream into a cabinet header
        /// </summary>
        /// <param name="data">Stream to parse</param>
        /// <returns>Filled cabinet header on success, null on error</returns>
        private static CFHEADER ParseCabinetHeader(Stream data)
        {
            CFHEADER header = new CFHEADER();

            header.Signature = data.ReadUInt32();
            if (header.Signature != 0x4643534D)
                return null;

            header.Reserved1 = data.ReadUInt32();
            header.CabinetSize = data.ReadUInt32();
            header.Reserved2 = data.ReadUInt32();
            header.FilesOffset = data.ReadUInt32();
            header.Reserved3 = data.ReadUInt32();
            header.VersionMinor = data.ReadByteValue();
            header.VersionMajor = data.ReadByteValue();
            header.FolderCount = data.ReadUInt16();
            header.FileCount = data.ReadUInt16();
            header.Flags = (HeaderFlags)data.ReadUInt16();
            header.SetID = data.ReadUInt16();
            header.CabinetIndex = data.ReadUInt16();

            if (header.Flags.HasFlag(HeaderFlags.RESERVE_PRESENT))
            {
                header.HeaderReservedSize = data.ReadUInt16();
                if (header.HeaderReservedSize > 60_000)
                    return null;

                header.FolderReservedSize = data.ReadByteValue();
                header.DataReservedSize = data.ReadByteValue();

                if (header.HeaderReservedSize > 0)
                    header.ReservedData = data.ReadBytes(header.HeaderReservedSize);
            }

            if (header.Flags.HasFlag(HeaderFlags.PREV_CABINET))
            {
                header.CabinetPrev = data.ReadString(Encoding.ASCII);
                header.DiskPrev = data.ReadString(Encoding.ASCII);
            }

            if (header.Flags.HasFlag(HeaderFlags.NEXT_CABINET))
            {
                header.CabinetNext = data.ReadString(Encoding.ASCII);
                header.DiskNext = data.ReadString(Encoding.ASCII);
            }

            return header;
        }

        /// <summary>
        /// Parse a Stream into a folder
        /// </summary>
        /// <param name="data">Stream to parse</param>
        /// <param name="header">Cabinet header to get flags and sizes from</param>
        /// <returns>Filled folder on success, null on error</returns>
        private static CFFOLDER ParseFolder(Stream data, CFHEADER header)
        {
            CFFOLDER folder = new CFFOLDER();

            folder.CabStartOffset = data.ReadUInt32();
            folder.DataCount = data.ReadUInt16();
            folder.CompressionType = (CompressionType)data.ReadUInt16();

            if (header.FolderReservedSize > 0)
                folder.ReservedData = data.ReadBytes(header.FolderReservedSize);

            if (folder.CabStartOffset > 0)
            {
                long currentPosition = data.Position;
                data.Seek(folder.CabStartOffset, SeekOrigin.Begin);

                folder.DataBlocks = new Dictionary<int, CFDATA>();
                for (int i = 0; i < folder.DataCount; i++)
                {
                    long dataBlockStart = data.Position;
                    CFDATA dataBlock = ParseDataBlock(data, header.DataReservedSize);
                    folder.DataBlocks[(int)dataBlockStart] = dataBlock;
                }

                data.Seek(currentPosition, SeekOrigin.Begin);
            }

            return folder;
        }

        /// <summary>
        /// Parse a Stream into a data block
        /// </summary>
        /// <param name="data">Stream to parse</param>
        /// <param name="dataReservedSize">Reserved byte size for data blocks</param>
        /// <returns>Filled folder on success, null on error</returns>
        private static CFDATA ParseDataBlock(Stream data, byte dataReservedSize)
        {
            CFDATA dataBlock = new CFDATA();

            dataBlock.Checksum = data.ReadUInt32();
            dataBlock.CompressedSize = data.ReadUInt16();
            dataBlock.UncompressedSize = data.ReadUInt16();

            if (dataBlock.UncompressedSize != 0 && dataBlock.CompressedSize > dataBlock.UncompressedSize)
                return null;

            if (dataReservedSize > 0)
                dataBlock.ReservedData = data.ReadBytes(dataReservedSize);

            if (dataBlock.CompressedSize > 0)
                dataBlock.CompressedData = data.ReadBytes(dataBlock.CompressedSize);

            return dataBlock;
        }

        /// <summary>
        /// Parse a Stream into a file
        /// </summary>
        /// <param name="data">Stream to parse</param>
        /// <returns>Filled file on success, null on error</returns>
        private static CFFILE ParseFile(Stream data)
        {
            CFFILE file = new CFFILE();

            file.FileSize = data.ReadUInt32();
            file.FolderStartOffset = data.ReadUInt32();
            file.FolderIndex = (FolderIndex)data.ReadUInt16();
            file.Date = data.ReadUInt16();
            file.Time = data.ReadUInt16();
            file.Attributes = (Models.MicrosoftCabinet.FileAttributes)data.ReadUInt16();

            if (file.Attributes.HasFlag(Models.MicrosoftCabinet.FileAttributes.NAME_IS_UTF))
                file.Name = data.ReadString(Encoding.Unicode);
            else
                file.Name = data.ReadString(Encoding.ASCII);

            return file;
        }

        #endregion
    }
}