Files
Aaru/Aaru.Images/NDIF/Read.cs

446 lines
17 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Read.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Reads Apple New Disk Image Format.
//
// --[ 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-2022 Natalia Portillo
// ****************************************************************************/
namespace Aaru.DiscImages;
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Aaru.CommonTypes;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Compression;
using Aaru.Console;
using Aaru.Helpers;
using Claunia.Encoding;
using Claunia.RsrcFork;
using Version = Resources.Version;
public sealed partial class Ndif
{
/// <inheritdoc />
public ErrorNumber Open(IFilter imageFilter)
{
if(!imageFilter.HasResourceFork ||
imageFilter.ResourceForkLength == 0)
return ErrorNumber.InvalidArgument;
ResourceFork rsrcFork;
Resource rsrc;
short[] bcems;
try
{
rsrcFork = new ResourceFork(imageFilter.GetResourceForkStream());
if(!rsrcFork.ContainsKey(NDIF_RESOURCE))
return ErrorNumber.InvalidArgument;
rsrc = rsrcFork.GetResource(NDIF_RESOURCE);
bcems = rsrc.GetIds();
if(bcems == null ||
bcems.Length == 0)
return ErrorNumber.InvalidArgument;
}
catch(InvalidCastException ex)
{
AaruConsole.ErrorWriteLine("Exception trying to open image file {0}", imageFilter.BasePath);
AaruConsole.ErrorWriteLine("Exception: {0}", ex);
return ErrorNumber.UnexpectedException;
}
_imageInfo.Sectors = 0;
foreach(byte[] bcem in bcems.Select(_ => rsrc.GetResource(NDIF_RESOURCEID)))
{
if(bcem.Length < 128)
return ErrorNumber.InvalidArgument;
_header = Marshal.ByteArrayToStructureBigEndian<ChunkHeader>(bcem);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.type = {0}", _header.version);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.driver = {0}", _header.driver);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.name = {0}",
StringHandlers.PascalToString(_header.name, Encoding.GetEncoding("macintosh")));
AaruConsole.DebugWriteLine("NDIF plugin", "footer.sectors = {0}", _header.sectors);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.maxSectorsPerChunk = {0}", _header.maxSectorsPerChunk);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.dataOffset = {0}", _header.dataOffset);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.crc = 0x{0:X7}", _header.crc);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.segmented = {0}", _header.segmented);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.p1 = 0x{0:X8}", _header.p1);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.p2 = 0x{0:X8}", _header.p2);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.unknown[0] = 0x{0:X8}", _header.unknown[0]);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.unknown[1] = 0x{0:X8}", _header.unknown[1]);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.unknown[2] = 0x{0:X8}", _header.unknown[2]);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.unknown[3] = 0x{0:X8}", _header.unknown[3]);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.unknown[4] = 0x{0:X8}", _header.unknown[4]);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.encrypted = {0}", _header.encrypted);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.hash = 0x{0:X8}", _header.hash);
AaruConsole.DebugWriteLine("NDIF plugin", "footer.chunks = {0}", _header.chunks);
// Block chunks and headers
_chunks = new Dictionary<ulong, BlockChunk>();
for(var i = 0; i < _header.chunks; i++)
{
// Obsolete read-only NDIF only prepended the header and then put the image without any kind of block references.
// So let's falsify a block chunk
var bChnk = new BlockChunk();
var sector = new byte[4];
Array.Copy(bcem, 128 + 0 + i * 12, sector, 1, 3);
bChnk.sector = BigEndianBitConverter.ToUInt32(sector, 0);
bChnk.type = bcem[128 + 3 + i * 12];
bChnk.offset = BigEndianBitConverter.ToUInt32(bcem, 128 + 4 + i * 12);
bChnk.length = BigEndianBitConverter.ToUInt32(bcem, 128 + 8 + i * 12);
AaruConsole.DebugWriteLine("NDIF plugin", "bHdr.chunk[{0}].type = 0x{1:X2}", i, bChnk.type);
AaruConsole.DebugWriteLine("NDIF plugin", "bHdr.chunk[{0}].sector = {1}", i, bChnk.sector);
AaruConsole.DebugWriteLine("NDIF plugin", "bHdr.chunk[{0}].offset = {1}", i, bChnk.offset);
AaruConsole.DebugWriteLine("NDIF plugin", "bHdr.chunk[{0}].length = {1}", i, bChnk.length);
if(bChnk.type == CHUNK_TYPE_END)
break;
bChnk.offset += _header.dataOffset;
bChnk.sector += (uint)_imageInfo.Sectors;
// TODO: Handle compressed chunks
switch(bChnk.type)
{
case CHUNK_TYPE_KENCODE:
AaruConsole.ErrorWriteLine("Chunks compressed with KenCode are not yet supported.");
return ErrorNumber.NotImplemented;
case CHUNK_TYPE_LZH:
AaruConsole.ErrorWriteLine("Chunks compressed with LZH are not yet supported.");
return ErrorNumber.NotImplemented;
case CHUNK_TYPE_STUFFIT:
AaruConsole.ErrorWriteLine("Chunks compressed with StuffIt! are not yet supported.");
return ErrorNumber.NotImplemented;
}
// TODO: Handle compressed chunks
if(bChnk.type is > CHUNK_TYPE_COPY and < CHUNK_TYPE_KENCODE ||
bChnk.type is > CHUNK_TYPE_ADC and < CHUNK_TYPE_STUFFIT ||
bChnk.type is > CHUNK_TYPE_STUFFIT and < CHUNK_TYPE_END ||
bChnk.type == 1)
{
AaruConsole.ErrorWriteLine($"Unsupported chunk type 0x{bChnk.type:X8} found");
return ErrorNumber.InvalidArgument;
}
_chunks.Add(bChnk.sector, bChnk);
}
_imageInfo.Sectors += _header.sectors;
}
if(_header.segmented > 0)
{
AaruConsole.ErrorWriteLine("Segmented images are not yet supported.");
return ErrorNumber.NotImplemented;
}
if(_header.encrypted > 0)
{
AaruConsole.ErrorWriteLine("Encrypted images are not yet supported.");
return ErrorNumber.NotImplemented;
}
_imageInfo.MediaType = _imageInfo.Sectors switch
{
1440 => MediaType.DOS_35_DS_DD_9,
1600 => MediaType.AppleSonyDS,
2880 => MediaType.DOS_35_HD,
3360 => MediaType.DMF,
_ => MediaType.GENERIC_HDD
};
if(rsrcFork.ContainsKey(0x76657273))
{
Resource versRsrc = rsrcFork.GetResource(0x76657273);
if(versRsrc != null)
{
byte[] vers = versRsrc.GetResource(versRsrc.GetIds()[0]);
var version = new Version(vers);
string release = null;
string dev = null;
string pre = null;
string major = $"{version.MajorVersion}";
string minor = $".{version.MinorVersion / 10}";
if(version.MinorVersion % 10 > 0)
release = $".{version.MinorVersion % 10}";
dev = version.DevStage switch
{
Version.DevelopmentStage.Alpha => "a",
Version.DevelopmentStage.Beta => "b",
Version.DevelopmentStage.PreAlpha => "d",
_ => dev
};
if(dev == null &&
version.PreReleaseVersion > 0)
dev = "f";
if(dev != null)
pre = $"{version.PreReleaseVersion}";
_imageInfo.ApplicationVersion = $"{major}{minor}{release}{dev}{pre}";
_imageInfo.Application = version.VersionString;
_imageInfo.Comments = version.VersionMessage;
_imageInfo.Application = version.MajorVersion switch
{
3 => "ShrinkWrap™",
6 => "DiskCopy",
_ => _imageInfo.Application
};
}
}
AaruConsole.DebugWriteLine("NDIF plugin", "Image application = {0} version {1}", _imageInfo.Application,
_imageInfo.ApplicationVersion);
_sectorCache = new Dictionary<ulong, byte[]>();
_chunkCache = new Dictionary<ulong, byte[]>();
_currentChunkCacheSize = 0;
_imageStream = imageFilter.GetDataForkStream();
_bufferSize = _header.maxSectorsPerChunk * SECTOR_SIZE;
_imageInfo.CreationTime = imageFilter.CreationTime;
_imageInfo.LastModificationTime = imageFilter.LastWriteTime;
_imageInfo.MediaTitle = StringHandlers.PascalToString(_header.name, Encoding.GetEncoding("macintosh"));
_imageInfo.SectorSize = SECTOR_SIZE;
_imageInfo.XmlMediaType = XmlMediaType.BlockMedia;
_imageInfo.ImageSize = _imageInfo.Sectors * SECTOR_SIZE;
_imageInfo.ApplicationVersion = "6";
_imageInfo.Application = "Apple DiskCopy";
switch(_imageInfo.MediaType)
{
case MediaType.AppleSonyDS:
_imageInfo.Cylinders = 80;
_imageInfo.Heads = 2;
_imageInfo.SectorsPerTrack = 10;
break;
case MediaType.DOS_35_DS_DD_9:
_imageInfo.Cylinders = 80;
_imageInfo.Heads = 2;
_imageInfo.SectorsPerTrack = 9;
break;
case MediaType.DOS_35_HD:
_imageInfo.Cylinders = 80;
_imageInfo.Heads = 2;
_imageInfo.SectorsPerTrack = 18;
break;
case MediaType.DMF:
_imageInfo.Cylinders = 80;
_imageInfo.Heads = 2;
_imageInfo.SectorsPerTrack = 21;
break;
default:
_imageInfo.MediaType = MediaType.GENERIC_HDD;
_imageInfo.Cylinders = (uint)(_imageInfo.Sectors / 16 / 63);
_imageInfo.Heads = 16;
_imageInfo.SectorsPerTrack = 63;
break;
}
return ErrorNumber.NoError;
}
/// <inheritdoc />
public ErrorNumber ReadSector(ulong sectorAddress, out byte[] buffer)
{
buffer = null;
if(sectorAddress > _imageInfo.Sectors - 1)
return ErrorNumber.OutOfRange;
if(_sectorCache.TryGetValue(sectorAddress, out buffer))
return ErrorNumber.NoError;
var currentChunk = new BlockChunk();
var chunkFound = false;
ulong chunkStartSector = 0;
foreach(KeyValuePair<ulong, BlockChunk> kvp in _chunks.Where(kvp => sectorAddress >= kvp.Key))
{
currentChunk = kvp.Value;
chunkFound = true;
chunkStartSector = kvp.Key;
}
long relOff = ((long)sectorAddress - (long)chunkStartSector) * SECTOR_SIZE;
if(relOff < 0)
return ErrorNumber.InvalidArgument;
if(!chunkFound)
return ErrorNumber.SectorNotFound;
if((currentChunk.type & CHUNK_TYPE_COMPRESSED_MASK) == CHUNK_TYPE_COMPRESSED_MASK)
{
if(!_chunkCache.TryGetValue(chunkStartSector, out byte[] data))
{
var cmpBuffer = new byte[currentChunk.length];
_imageStream.Seek(currentChunk.offset, SeekOrigin.Begin);
_imageStream.Read(cmpBuffer, 0, cmpBuffer.Length);
int realSize;
switch(currentChunk.type)
{
case CHUNK_TYPE_ADC:
{
var tmpBuffer = new byte[_bufferSize];
realSize = ADC.DecodeBuffer(cmpBuffer, tmpBuffer);
data = new byte[realSize];
Array.Copy(tmpBuffer, 0, data, 0, realSize);
break;
}
case CHUNK_TYPE_RLE:
{
var tmpBuffer = new byte[_bufferSize];
realSize = AppleRle.DecodeBuffer(cmpBuffer, tmpBuffer);
data = new byte[realSize];
Array.Copy(tmpBuffer, 0, data, 0, realSize);
break;
}
default: return ErrorNumber.NotSupported;
}
if(_currentChunkCacheSize + realSize > MAX_CACHE_SIZE)
{
_chunkCache.Clear();
_currentChunkCacheSize = 0;
}
_chunkCache.Add(chunkStartSector, data);
_currentChunkCacheSize += (uint)realSize;
}
buffer = new byte[SECTOR_SIZE];
Array.Copy(data, relOff, buffer, 0, SECTOR_SIZE);
if(_sectorCache.Count >= MAX_CACHED_SECTORS)
_sectorCache.Clear();
_sectorCache.Add(sectorAddress, buffer);
return ErrorNumber.NoError;
}
switch(currentChunk.type)
{
case CHUNK_TYPE_NOCOPY:
buffer = new byte[SECTOR_SIZE];
if(_sectorCache.Count >= MAX_CACHED_SECTORS)
_sectorCache.Clear();
_sectorCache.Add(sectorAddress, buffer);
return ErrorNumber.NoError;
case CHUNK_TYPE_COPY:
_imageStream.Seek(currentChunk.offset + relOff, SeekOrigin.Begin);
buffer = new byte[SECTOR_SIZE];
_imageStream.Read(buffer, 0, buffer.Length);
if(_sectorCache.Count >= MAX_CACHED_SECTORS)
_sectorCache.Clear();
_sectorCache.Add(sectorAddress, buffer);
return ErrorNumber.NoError;
}
return ErrorNumber.NotSupported;
}
/// <inheritdoc />
public ErrorNumber ReadSectors(ulong sectorAddress, uint length, out byte[] buffer)
{
buffer = null;
if(sectorAddress > _imageInfo.Sectors - 1)
return ErrorNumber.OutOfRange;
if(sectorAddress + length > _imageInfo.Sectors)
return ErrorNumber.OutOfRange;
var ms = new MemoryStream();
for(uint i = 0; i < length; i++)
{
ErrorNumber errno = ReadSector(sectorAddress + i, out byte[] sector);
if(errno != ErrorNumber.NoError)
return errno;
ms.Write(sector, 0, sector.Length);
}
buffer = ms.ToArray();
return ErrorNumber.NoError;
}
}