Aaru/DiscImageChef.Filesystems/ProDOS.cs

// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename       : ProDOS.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Apple ProDOS filesystem plugin.
//
// --[ Description ] ----------------------------------------------------------
//
//     Identifies the Apple ProDOS filesystem and shows information.
//
// --[ License ] --------------------------------------------------------------
//
//     This library is free software; you can redistribute it and/or modify
//     it under the terms of the GNU Lesser General Public License as
//     published by the Free Software Foundation; either version 2.1 of the
//     License, or (at your option) any later version.
//
//     This library is distributed in the hope that it will be useful, but
//     WITHOUT ANY WARRANTY; without even the implied warranty of
//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
//     Lesser General Public License for more details.
//
//     You should have received a copy of the GNU Lesser General Public
//     License along with this library; if not, see <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2017 Natalia Portillo
// ****************************************************************************/

using System;
using System.Text;
using System.Collections.Generic;
using DiscImageChef.Console;

namespace DiscImageChef.Filesystems
{
    // Information from Apple ProDOS 8 Technical Reference
    public class ProDOSPlugin : Filesystem
    {
        const byte EmptyStorageType = 0x00;
        /// <summary>
        /// A file that occupies one block or less
        /// </summary>
        const byte SeedlingFileType = 0x01;
        /// <summary>
        /// A file that occupies between 2 and 256 blocks
        /// </summary>
        const byte SaplingFileType = 0x02;
        /// <summary>
        /// A file that occupies between 257 and 32768 blocks
        /// </summary>
        const byte TreeFileType = 0x03;
        const byte PascalAreaType = 0x04;
        const byte SubDirectoryType = 0x0D;
        const byte SubDirectoryHeaderType = 0x0E;
        const byte RootDirectoryType = 0x0F;

        const byte ProDOSVersion1 = 0x00;

        const uint ProDOSYearMask = 0xFE000000;
        const uint ProDOSMonthMask = 0x1E00000;
        const uint ProDOSDayMask = 0x1F0000;
        const uint ProDOSHourMask = 0x1F00;
        const uint ProDOSMinuteMask = 0x3F;

        const byte ProDOSDestroyAttribute = 0x80;
        const byte ProDOSRenameAttribute = 0x40;
        const byte ProDOSBackupAttribute = 0x20;
        const byte ProDOSWriteAttribute = 0x02;
        const byte ProDOSReadAttribute = 0x01;
        const byte ProDOSReservedAttributeMask = 0x1C;

        const byte ProDOSStorageTypeMask = 0xF0;
        const byte ProDOSNameLengthMask = 0x0F;
        const byte ProDOSEntryLength = 0x27;
        const byte ProDOSEntriesPerBlock = 0x0D;

        public ProDOSPlugin()
        {
            Name = "Apple ProDOS filesystem";
            PluginUUID = new Guid("43874265-7B8A-4739-BCF7-07F80D5932BF");
        }

        public ProDOSPlugin(ImagePlugins.ImagePlugin imagePlugin, ulong partitionStart, ulong partitionEnd)
        {
            Name = "Apple ProDOS filesystem";
            PluginUUID = new Guid("43874265-7B8A-4739-BCF7-07F80D5932BF");
        }

        public override bool Identify(ImagePlugins.ImagePlugin imagePlugin, ulong partitionStart, ulong partitionEnd)
        {
            if(partitionEnd < 3)
                return false;

            // Blocks 0 and 1 are boot code
            byte[] rootDirectoryKeyBlock = imagePlugin.ReadSector(2 + partitionStart);

            ushort prePointer = BitConverter.ToUInt16(rootDirectoryKeyBlock, 0);
            DicConsole.DebugWriteLine("ProDOS plugin", "prePointer = {0}", prePointer);
            if(prePointer != 0)
                return false;

            byte storage_type = (byte)((rootDirectoryKeyBlock[0x04] & ProDOSStorageTypeMask) >> 4);
            DicConsole.DebugWriteLine("ProDOS plugin", "storage_type = {0}", storage_type);
            if(storage_type != RootDirectoryType)
                return false;

            byte entry_length = rootDirectoryKeyBlock[0x23];
            DicConsole.DebugWriteLine("ProDOS plugin", "entry_length = {0}", entry_length);
            if(entry_length != ProDOSEntryLength)
                return false;

            byte entries_per_block = rootDirectoryKeyBlock[0x24];
            DicConsole.DebugWriteLine("ProDOS plugin", "entries_per_block = {0}", entries_per_block);
            if(entries_per_block != ProDOSEntriesPerBlock)
                return false;

            ushort bit_map_pointer = BitConverter.ToUInt16(rootDirectoryKeyBlock, 0x27);
            DicConsole.DebugWriteLine("ProDOS plugin", "bit_map_pointer = {0}", bit_map_pointer);
            if(bit_map_pointer > partitionEnd)
                return false;

            ushort total_blocks = BitConverter.ToUInt16(rootDirectoryKeyBlock, 0x29);
            DicConsole.DebugWriteLine("ProDOS plugin", "{0} <= ({1} - {2} + 1)? {3}", total_blocks, partitionEnd, partitionStart, total_blocks <= (partitionEnd - partitionStart + 1));
            return total_blocks <= (partitionEnd - partitionStart + 1);
        }

        public override void GetInformation(ImagePlugins.ImagePlugin imagePlugin, ulong partitionStart, ulong partitionEnd, out string information)
        {
            StringBuilder sbInformation = new StringBuilder();

            // Blocks 0 and 1 are boot code
            byte[] rootDirectoryKeyBlockBytes = imagePlugin.ReadSector(2 + partitionStart);

            ProDOSRootDirectoryKeyBlock rootDirectoryKeyBlock = new ProDOSRootDirectoryKeyBlock();
            rootDirectoryKeyBlock.header = new ProDOSRootDirectoryHeader();

            byte[] temporal;
            int year, month, day, hour, minute;
            ushort temp_timestamp_left, temp_timestamp_right;
            uint temp_timestamp;

            rootDirectoryKeyBlock.zero = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x00);
            rootDirectoryKeyBlock.next_pointer = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x02);
            rootDirectoryKeyBlock.header.storage_type = (byte)((rootDirectoryKeyBlockBytes[0x04] & ProDOSStorageTypeMask) >> 4);
            rootDirectoryKeyBlock.header.name_length = (byte)(rootDirectoryKeyBlockBytes[0x04] & ProDOSNameLengthMask);
            temporal = new byte[rootDirectoryKeyBlock.header.name_length];
            Array.Copy(rootDirectoryKeyBlockBytes, 0x05, temporal, 0, rootDirectoryKeyBlock.header.name_length);
            rootDirectoryKeyBlock.header.volume_name = Encoding.ASCII.GetString(temporal);
            rootDirectoryKeyBlock.header.reserved = BitConverter.ToUInt64(rootDirectoryKeyBlockBytes, 0x14);

            temp_timestamp_left = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x1C);
            temp_timestamp_right = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x1E);
            temp_timestamp = (uint)((temp_timestamp_left << 16) + temp_timestamp_right);
            year = (int)((temp_timestamp & ProDOSYearMask) >> 25);
            month = (int)((temp_timestamp & ProDOSMonthMask) >> 21);
            day = (int)((temp_timestamp & ProDOSDayMask) >> 16);
            hour = (int)((temp_timestamp & ProDOSHourMask) >> 8);
            minute = (int)(temp_timestamp & ProDOSMinuteMask);
            year += 1900;
            if(year < 1940)
                year += 100;

            DicConsole.DebugWriteLine("ProDOS plugin", "temp_timestamp_left = 0x{0:X4}", temp_timestamp_left);
            DicConsole.DebugWriteLine("ProDOS plugin", "temp_timestamp_right = 0x{0:X4}", temp_timestamp_right);
            DicConsole.DebugWriteLine("ProDOS plugin", "temp_timestamp = 0x{0:X8}", temp_timestamp);
            DicConsole.DebugWriteLine("ProDOS plugin", "Datetime field year {0}, month {1}, day {2}, hour {3}, minute {4}.", year, month, day, hour, minute);

            rootDirectoryKeyBlock.header.creation_time = new DateTime(year, month, day, hour, minute, 0);

            rootDirectoryKeyBlock.header.version = rootDirectoryKeyBlockBytes[0x20];
            rootDirectoryKeyBlock.header.min_version = rootDirectoryKeyBlockBytes[0x21];
            rootDirectoryKeyBlock.header.access = rootDirectoryKeyBlockBytes[0x22];
            rootDirectoryKeyBlock.header.entry_length = rootDirectoryKeyBlockBytes[0x23];
            rootDirectoryKeyBlock.header.entries_per_block = rootDirectoryKeyBlockBytes[0x24];

            rootDirectoryKeyBlock.header.file_count = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x25);
            rootDirectoryKeyBlock.header.bit_map_pointer = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x27);
            rootDirectoryKeyBlock.header.total_blocks = BitConverter.ToUInt16(rootDirectoryKeyBlockBytes, 0x29);

            if(rootDirectoryKeyBlock.header.version != ProDOSVersion1 || rootDirectoryKeyBlock.header.min_version != ProDOSVersion1)
            {
                sbInformation.AppendLine("Warning! Detected unknown ProDOS version ProDOS filesystem.");
                sbInformation.AppendLine("All of the following information may be incorrect");
            }

            if(rootDirectoryKeyBlock.header.version == ProDOSVersion1)
                sbInformation.AppendLine("ProDOS version 1 used to create this volume.");
            else
                sbInformation.AppendFormat("Unknown ProDOS version with field {0} used to create this volume.", rootDirectoryKeyBlock.header.version).AppendLine();

            if(rootDirectoryKeyBlock.header.min_version == ProDOSVersion1)
                sbInformation.AppendLine("ProDOS version 1 at least required for reading this volume.");
            else
                sbInformation.AppendFormat("Unknown ProDOS version with field {0} is at least required for reading this volume.", rootDirectoryKeyBlock.header.min_version).AppendLine();

            sbInformation.AppendFormat("Volume name is {0}", rootDirectoryKeyBlock.header.volume_name).AppendLine();
            sbInformation.AppendFormat("Volume created on {0}", rootDirectoryKeyBlock.header.creation_time).AppendLine();
            sbInformation.AppendFormat("{0} bytes per directory entry", rootDirectoryKeyBlock.header.entry_length).AppendLine();
            sbInformation.AppendFormat("{0} entries per directory block", rootDirectoryKeyBlock.header.entries_per_block).AppendLine();
            sbInformation.AppendFormat("{0} files in root directory", rootDirectoryKeyBlock.header.file_count).AppendLine();
            sbInformation.AppendFormat("{0} blocks in volume", rootDirectoryKeyBlock.header.total_blocks).AppendLine();
            sbInformation.AppendFormat("Bitmap starts at block {0}", rootDirectoryKeyBlock.header.bit_map_pointer).AppendLine();

            if((rootDirectoryKeyBlock.header.access & ProDOSReadAttribute) == ProDOSReadAttribute)
                sbInformation.AppendLine("Volume can be read");
            if((rootDirectoryKeyBlock.header.access & ProDOSWriteAttribute) == ProDOSWriteAttribute)
                sbInformation.AppendLine("Volume can be written");
            if((rootDirectoryKeyBlock.header.access & ProDOSRenameAttribute) == ProDOSRenameAttribute)
                sbInformation.AppendLine("Volume can be renamed");
            if((rootDirectoryKeyBlock.header.access & ProDOSDestroyAttribute) == ProDOSDestroyAttribute)
                sbInformation.AppendLine("Volume can be destroyed");
            if((rootDirectoryKeyBlock.header.access & ProDOSBackupAttribute) == ProDOSBackupAttribute)
                sbInformation.AppendLine("Volume must be backed up");

            if((rootDirectoryKeyBlock.header.access & ProDOSReservedAttributeMask) != 0)
                DicConsole.DebugWriteLine("ProDOS plugin", "Reserved attributes are set: {0:X2}", rootDirectoryKeyBlock.header.access);

            information = sbInformation.ToString();

            xmlFSType = new Schemas.FileSystemType();
            xmlFSType.VolumeName = rootDirectoryKeyBlock.header.volume_name;
            if(year != 0 || month != 0 || day != 0 || hour != 0 || minute != 0)
            {
                xmlFSType.CreationDate = rootDirectoryKeyBlock.header.creation_time;
                xmlFSType.CreationDateSpecified = true;
            }
            xmlFSType.Files = rootDirectoryKeyBlock.header.file_count;
            xmlFSType.FilesSpecified = true;
            xmlFSType.Clusters = rootDirectoryKeyBlock.header.total_blocks;
            xmlFSType.ClusterSize = (int)((partitionEnd - partitionStart + 1) / (ulong)xmlFSType.Clusters);
            xmlFSType.Type = "ProDOS";

            return;
        }

        public override Errno Mount()
        {
            return Errno.NotImplemented;
        }

        public override Errno Mount(bool debug)
        {
            return Errno.NotImplemented;
        }

        public override Errno Unmount()
        {
            return Errno.NotImplemented;
        }

        public override Errno MapBlock(string path, long fileBlock, ref long deviceBlock)
        {
            return Errno.NotImplemented;
        }

        public override Errno GetAttributes(string path, ref FileAttributes attributes)
        {
            return Errno.NotImplemented;
        }

        public override Errno ListXAttr(string path, ref List<string> xattrs)
        {
            return Errno.NotImplemented;
        }

        public override Errno GetXattr(string path, string xattr, ref byte[] buf)
        {
            return Errno.NotImplemented;
        }

        public override Errno Read(string path, long offset, long size, ref byte[] buf)
        {
            return Errno.NotImplemented;
        }

        public override Errno ReadDir(string path, ref List<string> contents)
        {
            return Errno.NotImplemented;
        }

        public override Errno StatFs(ref FileSystemInfo stat)
        {
            return Errno.NotImplemented;
        }

        public override Errno Stat(string path, ref FileEntryInfo stat)
        {
            return Errno.NotImplemented;
        }

        public override Errno ReadLink(string path, ref string dest)
        {
            return Errno.NotImplemented;
        }

        /// <summary>
        /// ProDOS directory entry, decoded structure
        /// </summary>
        struct ProDOSEntry
        {
            /// <summary>
            /// Type of file pointed by this entry
            /// Offset 0x00, mask 0xF0
            /// </summary>
            public byte storage_type;
            /// <summary>
            /// Length of name_length pascal string
            /// Offset 0x00, mask 0x0F
            /// </summary>
            public byte name_length;
            /// <summary>
            /// Pascal string of file name
            /// Offset 0x01, 15 bytes
            /// </summary>
            public string file_name;
            /// <summary>
            /// Descriptor of internal structure of the file
            /// Offset 0x10, 1 byte
            /// </summary>
            public byte file_type;
            /// <summary>
            /// Block address of master index block for tree files.
            /// Block address of index block for sapling files.
            /// Block address of block for seedling files.
            /// Offset 0x11, 2 bytes
            /// </summary>
            public ushort key_pointer;
            /// <summary>
            /// Blocks used by file or directory, including index blocks.
            /// Offset 0x13, 2 bytes
            /// </summary>
            public ushort blocks_used;
            /// <summary>
            /// Size of file in bytes
            /// Offset 0x15, 3 bytes
            /// </summary>
            public uint EOF;
            /// <summary>
            /// File creation datetime
            /// Offset 0x18, 4 bytes
            /// </summary>
            public DateTime creation_time;
            /// <summary>
            /// Version of ProDOS that created this file
            /// Offset 0x1C, 1 byte
            /// </summary>
            public byte version;
            /// <summary>
            /// Minimum version of ProDOS needed to access this file
            /// Offset 0x1D, 1 byte
            /// </summary>
            public byte min_version;
            /// <summary>
            /// File permissions
            /// Offset 0x1E, 1 byte
            /// </summary>
            public byte access;
            /// <summary>
            /// General purpose field to store additional information about file format
            /// Offset 0x1F, 2 bytes
            /// </summary>
            public ushort aux_type;
            /// <summary>
            /// File last modification date time
            /// Offset 0x21, 4 bytes
            /// </summary>
            public DateTime last_mod;
            /// <summary>
            /// Block address pointer to key block of the directory containing this entry
            /// Offset 0x25, 2 bytes
            /// </summary>
            public ushort header_pointer;
        }

        struct ProDOSRootDirectoryHeader
        {
            /// <summary>
            /// Constant 0x0F
            /// Offset 0x04, mask 0xF0
            /// </summary>
            public byte storage_type;
            /// <summary>
            /// Length of volume_name pascal string
            /// Offset 0x04, mask 0x0F
            /// </summary>
            public byte name_length;
            /// <summary>
            /// The name of the volume.
            /// Offset 0x05, 15 bytes
            /// </summary>
            public string volume_name;
            /// <summary>
            /// Reserved for future expansion
            /// Offset 0x14, 8 bytes
            /// </summary>
            public ulong reserved;
            /// <summary>
            /// Creation time of the volume
            /// Offset 0x1C, 4 bytes
            /// </summary>
            public DateTime creation_time;
            /// <summary>
            /// Version number of the volume format
            /// Offset 0x20, 1 byte
            /// </summary>
            public byte version;
            /// <summary>
            /// Reserved for future use
            /// Offset 0x21, 1 byte
            /// </summary>
            public byte min_version;
            /// <summary>
            /// Permissions for the volume
            /// Offset 0x22, 1 byte
            /// </summary>
            public byte access;
            /// <summary>
            /// Length of an entry in this directory
            /// Const 0x27
            /// Offset 0x23, 1 byte
            /// </summary>
            public byte entry_length;
            /// <summary>
            /// Number of entries per block
            /// Const 0x0D
            /// Offset 0x24, 1 byte
            /// </summary>
            public byte entries_per_block;
            /// <summary>
            /// Number of active files in this directory
            /// Offset 0x25, 2 bytes
            /// </summary>
            public ushort file_count;
            /// <summary>
            /// Block address of the first block of the volume's bitmap,
            /// one for every 4096 blocks or fraction
            /// Offset 0x27, 2 bytes
            /// </summary>
            public ushort bit_map_pointer;
            /// <summary>
            /// Total number of blocks in the volume
            /// Offset 0x29, 2 bytes
            /// </summary>
            public ushort total_blocks;
        }

        struct ProDOSDirectoryHeader
        {
            /// <summary>
            /// Constant 0x0E
            /// Offset 0x04, mask 0xF0
            /// </summary>
            public byte storage_type;
            /// <summary>
            /// Length of volume_name pascal string
            /// Offset 0x04, mask 0x0F
            /// </summary>
            public byte name_length;
            /// <summary>
            /// The name of the directory.
            /// Offset 0x05, 15 bytes
            /// </summary>
            public string directory_name;
            /// <summary>
            /// Reserved for future expansion
            /// Offset 0x14, 8 bytes
            /// </summary>
            public ulong reserved;
            /// <summary>
            /// Creation time of the volume
            /// Offset 0x1C, 4 bytes
            /// </summary>
            public DateTime creation_time;
            /// <summary>
            /// Version number of the volume format
            /// Offset 0x20, 1 byte
            /// </summary>
            public byte version;
            /// <summary>
            /// Reserved for future use
            /// Offset 0x21, 1 byte
            /// </summary>
            public byte min_version;
            /// <summary>
            /// Permissions for the volume
            /// Offset 0x22, 1 byte
            /// </summary>
            public byte access;
            /// <summary>
            /// Length of an entry in this directory
            /// Const 0x27
            /// Offset 0x23, 1 byte
            /// </summary>
            public byte entry_length;
            /// <summary>
            /// Number of entries per block
            /// Const 0x0D
            /// Offset 0x24, 1 byte
            /// </summary>
            public byte entries_per_block;
            /// <summary>
            /// Number of active files in this directory
            /// Offset 0x25, 2 bytes
            /// </summary>
            public ushort file_count;
            /// <summary>
            /// Block address of parent directory block that contains this entry
            /// Offset 0x27, 2 bytes
            /// </summary>
            public ushort parent_pointer;
            /// <summary>
            /// Entry number within the block indicated in parent_pointer
            /// Offset 0x29, 1 byte
            /// </summary>
            public byte parent_entry_number;
            /// <summary>
            /// Length of the entry that holds this directory, in the parent entry
            /// Const 0x27
            /// Offset 0x2A, 1 byte
            /// </summary>
            public byte parent_entry_length;
        }

        struct ProDOSDirectoryKeyBlock
        {
            /// <summary>
            /// Always 0
            /// Offset 0x00, 2 bytes
            /// </summary>
            public ushort zero;
            /// <summary>
            /// Pointer to next directory block, 0 if last
            /// Offset 0x02, 2 bytes
            /// </summary>
            public ushort next_pointer;
            /// <summary>
            /// Directory header
            /// Offset 0x04, 39 bytes
            /// </summary>
            public ProDOSDirectoryHeader header;
            /// <summary>
            /// Directory entries
            /// Offset 0x2F, 39 bytes each, 12 entries
            /// </summary>
            public ProDOSEntry[] entries;
        }

        struct ProDOSRootDirectoryKeyBlock
        {
            /// <summary>
            /// Always 0
            /// Offset 0x00, 2 bytes
            /// </summary>
            public ushort zero;
            /// <summary>
            /// Pointer to next directory block, 0 if last
            /// Offset 0x02, 2 bytes
            /// </summary>
            public ushort next_pointer;
            /// <summary>
            /// Directory header
            /// Offset 0x04, 39 bytes
            /// </summary>
            public ProDOSRootDirectoryHeader header;
            /// <summary>
            /// Directory entries
            /// Offset 0x2F, 39 bytes each, 12 entries
            /// </summary>
            public ProDOSEntry[] entries;
        }

        struct ProDOSDirectoryBlock
        {
            /// <summary>
            /// Pointer to previous directory block
            /// Offset 0x00, 2 bytes
            /// </summary>
            public ushort zero;
            /// <summary>
            /// Pointer to next directory block, 0 if last
            /// Offset 0x02, 2 bytes
            /// </summary>
            public ushort next_pointer;
            /// <summary>
            /// Directory entries
            /// Offset 0x2F, 39 bytes each, 13 entries
            /// </summary>
            public ProDOSEntry[] entries;
        }

        struct ProDOSIndexBlock
        {
            /// <summary>
            /// Up to 256 pointers to blocks, 0 to indicate the block is sparsed (non-allocated)
            /// </summary>
            public ushort[] block_pointer;
        }

        struct ProDOSMasterIndexBlock
        {
            /// <summary>
            /// Up to 128 pointers to index blocks
            /// </summary>
            public ushort[] index_block_pointer;
        }
    }
}