aaru-dps/Aaru
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.git synced 2025-12-16 19:24:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
af478a92d10b418c291e0a3b51ddb2cc919c9d9c
Aaru/DiscImageChef.DiscImages/SaveDskF.cs

601 lines
23 KiB
C#
Raw Blame History

// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename : SaveDskF.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Manages IBM SaveDskF disk images.
//
// --[ 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-2018 Natalia Portillo
// ****************************************************************************/
using System;
using System.Collections.Generic;
using System.IO;
using System.Runtime.InteropServices;
using System.Text;
using DiscImageChef.CommonTypes;
using DiscImageChef.Console;
using DiscImageChef.Filters;
namespace DiscImageChef.DiscImages
{
public class SaveDskF : ImagePlugin
{
#region Internal Structures
[StructLayout(LayoutKind.Sequential, Pack = 1)]
struct SaveDskFHeader
{
/// <summary>0x00 magic number</summary>
public ushort magic;
/// <summary>0x02 media type from FAT</summary>
public ushort mediaType;
/// <summary>0x04 bytes per sector</summary>
public ushort sectorSize;
/// <summary>0x06 sectors per cluster - 1</summary>
public byte clusterMask;
/// <summary>0x07 log2(cluster / sector)</summary>
public byte clusterShift;
/// <summary>0x08 reserved sectors</summary>
public ushort reservedSectors;
/// <summary>0x0A copies of FAT</summary>
public byte fatCopies;
/// <summary>0x0B entries in root directory</summary>
public ushort rootEntries;
/// <summary>0x0D first cluster</summary>
public ushort firstCluster;
/// <summary>0x0F clusters present in image</summary>
public ushort clustersCopied;
/// <summary>0x11 sectors per FAT</summary>
public byte sectorsPerFat;
/// <summary>0x12 sector number of root directory</summary>
public ushort rootDirectorySector;
/// <summary>0x14 sum of all image bytes</summary>
public uint checksum;
/// <summary>0x18 cylinders</summary>
public ushort cylinders;
/// <summary>0x1A heads</summary>
public ushort heads;
/// <summary>0x1C sectors per track</summary>
public ushort sectorsPerTrack;
/// <summary>0x1E always zero</summary>
public uint padding;
/// <summary>0x22 sectors present in image</summary>
public ushort sectorsCopied;
/// <summary>0x24 offset to comment</summary>
public ushort commentOffset;
/// <summary>0x26 offset to data</summary>
public ushort dataOffset;
}
#endregion Internal Structures
#region Internal Constants
const ushort SDF_MAGIC_OLD = 0x58AA;
const ushort SDF_MAGIC = 0x59AA;
const ushort SDF_MAGIC_COMPRESSED = 0x5AAA;
#endregion Internal Constants
#region Internal variables
SaveDskFHeader header;
long sectors;
uint calculatedChk;
byte[] decodedDisk;
#endregion Internal variables
public SaveDskF()
{
Name = "IBM SaveDskF";
PluginUuid = new Guid("288CE058-1A51-4034-8C45-5A256CAE1461");
ImageInfo = new ImageInfo
{
ReadableSectorTags = new List<SectorTagType>(),
ReadableMediaTags = new List<MediaTagType>(),
ImageHasPartitions = false,
ImageHasSessions = false,
ImageVersion = null,
ImageApplication = null,
ImageApplicationVersion = null,
ImageCreator = null,
ImageComments = null,
MediaManufacturer = null,
MediaModel = null,
MediaSerialNumber = null,
MediaBarcode = null,
MediaPartNumber = null,
MediaSequence = 0,
LastMediaSequence = 0,
DriveManufacturer = null,
DriveModel = null,
DriveSerialNumber = null,
DriveFirmwareRevision = null
};
}
#region Public methods
public override bool IdentifyImage(Filter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();
stream.Seek(0, SeekOrigin.Begin);
if(stream.Length < 41) return false;
byte[] hdr = new byte[40];
stream.Read(hdr, 0, 40);
header = new SaveDskFHeader();
IntPtr hdrPtr = Marshal.AllocHGlobal(40);
Marshal.Copy(hdr, 0, hdrPtr, 40);
header = (SaveDskFHeader)Marshal.PtrToStructure(hdrPtr, typeof(SaveDskFHeader));
Marshal.FreeHGlobal(hdrPtr);
return (header.magic == SDF_MAGIC || header.magic == SDF_MAGIC_COMPRESSED ||
header.magic == SDF_MAGIC_OLD) && header.fatCopies <= 2 && header.padding == 0 &&
header.commentOffset < stream.Length && header.dataOffset < stream.Length;
}
public override bool OpenImage(Filter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();
stream.Seek(0, SeekOrigin.Begin);
byte[] hdr = new byte[40];
stream.Read(hdr, 0, 40);
header = new SaveDskFHeader();
IntPtr hdrPtr = Marshal.AllocHGlobal(40);
Marshal.Copy(hdr, 0, hdrPtr, 40);
header = (SaveDskFHeader)Marshal.PtrToStructure(hdrPtr, typeof(SaveDskFHeader));
Marshal.FreeHGlobal(hdrPtr);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.magic = 0x{0:X4}", header.magic);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.mediaType = 0x{0:X2}", header.mediaType);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.sectorSize = {0}", header.sectorSize);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.clusterMask = {0}", header.clusterMask);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.clusterShift = {0}", header.clusterShift);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.reservedSectors = {0}", header.reservedSectors);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.fatCopies = {0}", header.fatCopies);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.rootEntries = {0}", header.rootEntries);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.firstCluster = {0}", header.firstCluster);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.clustersCopied = {0}", header.clustersCopied);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.sectorsPerFat = {0}", header.sectorsPerFat);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.checksum = 0x{0:X8}", header.checksum);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.cylinders = {0}", header.cylinders);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.heads = {0}", header.heads);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.sectorsPerTrack = {0}", header.sectorsPerTrack);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.padding = {0}", header.padding);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.sectorsCopied = {0}", header.sectorsCopied);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.commentOffset = {0}", header.commentOffset);
DicConsole.DebugWriteLine("SaveDskF plugin", "header.dataOffset = {0}", header.dataOffset);
if(header.dataOffset == 0 && header.magic == SDF_MAGIC_OLD) header.dataOffset = 512;
byte[] cmt = new byte[header.dataOffset - header.commentOffset];
stream.Seek(header.commentOffset, SeekOrigin.Begin);
stream.Read(cmt, 0, cmt.Length);
if(cmt.Length > 1) ImageInfo.ImageComments = StringHandlers.CToString(cmt, Encoding.GetEncoding("ibm437"));
calculatedChk = 0;
stream.Seek(0, SeekOrigin.Begin);
int b;
do
{
b = stream.ReadByte();
if(b >= 0) calculatedChk += (uint)b;
}
while(b >= 0);
// In case there is omitted data
sectors = header.sectorsPerTrack * header.heads * header.cylinders;
DicConsole.DebugWriteLine("SaveDskF plugin", "Calculated checksum = 0x{0:X8}, {1}", calculatedChk,
calculatedChk == header.checksum);
ImageInfo.ImageApplication = "SaveDskF";
ImageInfo.ImageCreationTime = imageFilter.GetCreationTime();
ImageInfo.ImageLastModificationTime = imageFilter.GetLastWriteTime();
ImageInfo.ImageName = imageFilter.GetFilename();
ImageInfo.ImageSize = (ulong)(stream.Length - header.dataOffset);
ImageInfo.Sectors = (ulong)(header.sectorsPerTrack * header.heads * header.cylinders);
ImageInfo.SectorSize = header.sectorSize;
ImageInfo.MediaType = MediaType.Unknown;
switch(header.cylinders)
{
case 40:
switch(header.heads)
{
case 1:
switch(header.sectorsPerTrack)
{
case 8:
ImageInfo.MediaType = MediaType.DOS_525_SS_DD_8;
break;
case 9:
ImageInfo.MediaType = MediaType.DOS_525_SS_DD_9;
break;
}
break;
case 2:
switch(header.sectorsPerTrack)
{
case 8:
ImageInfo.MediaType = MediaType.DOS_525_DS_DD_8;
break;
case 9:
ImageInfo.MediaType = MediaType.DOS_525_DS_DD_9;
break;
}
break;
}
break;
case 70:
switch(header.heads)
{
case 1:
switch(header.sectorsPerTrack)
{
case 9:
ImageInfo.MediaType = MediaType.Apricot_35;
break;
}
break;
}
break;
case 80:
switch(header.heads)
{
case 1:
switch(header.sectorsPerTrack)
{
case 8:
ImageInfo.MediaType = MediaType.DOS_35_SS_DD_8;
break;
case 9:
ImageInfo.MediaType = MediaType.DOS_35_SS_DD_9;
break;
}
break;
case 2:
switch(header.sectorsPerTrack)
{
case 8:
ImageInfo.MediaType = MediaType.DOS_35_DS_DD_8;
break;
case 9:
ImageInfo.MediaType = MediaType.DOS_35_DS_DD_9;
break;
case 15:
ImageInfo.MediaType = MediaType.DOS_525_HD;
break;
case 18:
ImageInfo.MediaType = MediaType.DOS_35_HD;
break;
case 23:
ImageInfo.MediaType = MediaType.XDF_35;
break;
case 36:
ImageInfo.MediaType = MediaType.DOS_35_ED;
break;
}
break;
}
break;
default:
ImageInfo.MediaType = MediaType.Unknown;
break;
}
ImageInfo.XmlMediaType = XmlMediaType.BlockMedia;
DicConsole.VerboseWriteLine("SaveDskF image contains a disk of type {0}", ImageInfo.MediaType);
if(!string.IsNullOrEmpty(ImageInfo.ImageComments))
DicConsole.VerboseWriteLine("SaveDskF comments: {0}", ImageInfo.ImageComments);
// TODO: Support compressed images
if(header.magic == SDF_MAGIC_COMPRESSED)
throw new
FeatureSupportedButNotImplementedImageException("Compressed SaveDskF images are not supported.");
// SaveDskF only ommits ending clusters, leaving no gaps behind, so reading all data we have...
stream.Seek(header.dataOffset, SeekOrigin.Begin);
decodedDisk = new byte[ImageInfo.Sectors * ImageInfo.SectorSize];
stream.Read(decodedDisk, 0, (int)(stream.Length - header.dataOffset));
ImageInfo.Cylinders = header.cylinders;
ImageInfo.Heads = header.heads;
ImageInfo.SectorsPerTrack = header.sectorsPerTrack;
return true;
}
public override bool? VerifySector(ulong sectorAddress)
{
return null;
}
public override bool? VerifySector(ulong sectorAddress, uint track)
{
return null;
}
public override bool? VerifySectors(ulong sectorAddress, uint length, out List<ulong> failingLbas,
out List<ulong> unknownLbas)
{
failingLbas = new List<ulong>();
unknownLbas = new List<ulong>();
for(ulong i = sectorAddress; i < sectorAddress + length; i++) unknownLbas.Add(i);
return null;
}
public override bool? VerifySectors(ulong sectorAddress, uint length, uint track, out List<ulong> failingLbas,
out List<ulong> unknownLbas)
{
failingLbas = new List<ulong>();
unknownLbas = new List<ulong>();
for(ulong i = sectorAddress; i < sectorAddress + length; i++) unknownLbas.Add(i);
return null;
}
public override bool? VerifyMediaImage()
{
return calculatedChk == header.checksum;
}
public override bool ImageHasPartitions()
{
return ImageInfo.ImageHasPartitions;
}
public override ulong GetImageSize()
{
return ImageInfo.ImageSize;
}
public override ulong GetSectors()
{
return ImageInfo.Sectors;
}
public override uint GetSectorSize()
{
return ImageInfo.SectorSize;
}
public override byte[] ReadSector(ulong sectorAddress)
{
return ReadSectors(sectorAddress, 1);
}
public override byte[] ReadSectors(ulong sectorAddress, uint length)
{
if(sectorAddress > ImageInfo.Sectors - 1)
throw new ArgumentOutOfRangeException(nameof(sectorAddress), "Sector address not found");
if(sectorAddress + length > ImageInfo.Sectors)
throw new ArgumentOutOfRangeException(nameof(length), "Requested more sectors than available");
byte[] buffer = new byte[length * ImageInfo.SectorSize];
Array.Copy(decodedDisk, (int)sectorAddress * ImageInfo.SectorSize, buffer, 0,
length * ImageInfo.SectorSize);
return buffer;
}
public override string GetImageFormat()
{
return "IBM SaveDskF";
}
public override string GetImageVersion()
{
return ImageInfo.ImageVersion;
}
public override string GetImageApplication()
{
return ImageInfo.ImageApplication;
}
public override string GetImageApplicationVersion()
{
return ImageInfo.ImageApplicationVersion;
}
public override DateTime GetImageCreationTime()
{
return ImageInfo.ImageCreationTime;
}
public override DateTime GetImageLastModificationTime()
{
return ImageInfo.ImageLastModificationTime;
}
public override string GetImageName()
{
return ImageInfo.ImageName;
}
public override MediaType GetMediaType()
{
return ImageInfo.MediaType;
}
public override string GetImageCreator()
{
return ImageInfo.ImageCreator;
}
public override string GetImageComments()
{
return ImageInfo.ImageComments;
}
public override string GetMediaManufacturer()
{
return ImageInfo.MediaManufacturer;
}
public override string GetMediaModel()
{
return ImageInfo.MediaModel;
}
public override string GetMediaSerialNumber()
{
return ImageInfo.MediaSerialNumber;
}
public override string GetMediaBarcode()
{
return ImageInfo.MediaBarcode;
}
public override string GetMediaPartNumber()
{
return ImageInfo.MediaPartNumber;
}
public override int GetMediaSequence()
{
return ImageInfo.MediaSequence;
}
public override int GetLastDiskSequence()
{
return ImageInfo.LastMediaSequence;
}
public override string GetDriveManufacturer()
{
return ImageInfo.DriveManufacturer;
}
public override string GetDriveModel()
{
return ImageInfo.DriveModel;
}
public override string GetDriveSerialNumber()
{
return ImageInfo.DriveSerialNumber;
}
#endregion Public methods
#region Unsupported features
public override byte[] ReadSectorTag(ulong sectorAddress, SectorTagType tag)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorsTag(ulong sectorAddress, uint length, SectorTagType tag)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorLong(ulong sectorAddress)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorsLong(ulong sectorAddress, uint length)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadDiskTag(MediaTagType tag)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override List<Partition> GetPartitions()
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override List<Track> GetTracks()
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override List<Track> GetSessionTracks(Session session)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override List<Track> GetSessionTracks(ushort session)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override List<Session> GetSessions()
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSector(ulong sectorAddress, uint track)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorTag(ulong sectorAddress, uint track, SectorTagType tag)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectors(ulong sectorAddress, uint length, uint track)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorsTag(ulong sectorAddress, uint length, uint track, SectorTagType tag)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorLong(ulong sectorAddress, uint track)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
public override byte[] ReadSectorsLong(ulong sectorAddress, uint length, uint track)
{
throw new FeatureUnsupportedImageException("Feature not supported by image format");
}
#endregion Unsupported features
}
}
Reference in New Issue View Git Blame Copy Permalink