Refactor image classes and split them to smaller files.

This commit is contained in:
2018-07-23 23:25:43 +01:00
parent 55ca2d23b6
commit ed88989642
445 changed files with 50086 additions and 34342 deletions

View File

@@ -0,0 +1,364 @@
// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename : Read.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Reads partimage 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 DiscImageChef.CommonTypes;
using DiscImageChef.CommonTypes.Enums;
using DiscImageChef.CommonTypes.Exceptions;
using DiscImageChef.CommonTypes.Extents;
using DiscImageChef.CommonTypes.Interfaces;
using DiscImageChef.Console;
namespace DiscImageChef.DiscImages
{
public partial class Partimage
{
public bool Open(IFilter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();
stream.Seek(0, SeekOrigin.Begin);
if(stream.Length < 512) return false;
byte[] hdrB = new byte[Marshal.SizeOf(cVolumeHeader)];
stream.Read(hdrB, 0, Marshal.SizeOf(cVolumeHeader));
cVolumeHeader = new PartimageHeader();
IntPtr headerPtr = Marshal.AllocHGlobal(Marshal.SizeOf(cVolumeHeader));
Marshal.Copy(hdrB, 0, headerPtr, Marshal.SizeOf(cVolumeHeader));
cVolumeHeader = (PartimageHeader)Marshal.PtrToStructure(headerPtr, typeof(PartimageHeader));
Marshal.FreeHGlobal(headerPtr);
DicConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.magic = {0}",
StringHandlers.CToString(cVolumeHeader.magic));
DicConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.version = {0}",
StringHandlers.CToString(cVolumeHeader.version));
DicConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.volumeNumber = {0}",
cVolumeHeader.volumeNumber);
DicConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.identificator = {0:X16}",
cVolumeHeader.identificator);
// TODO: Support multifile volumes
if(cVolumeHeader.volumeNumber > 0)
throw new FeatureSupportedButNotImplementedImageException("Support for multiple volumes not supported");
hdrB = new byte[Marshal.SizeOf(cMainHeader)];
stream.Read(hdrB, 0, Marshal.SizeOf(cMainHeader));
cMainHeader = new PartimageMainHeader();
headerPtr = Marshal.AllocHGlobal(Marshal.SizeOf(cMainHeader));
Marshal.Copy(hdrB, 0, headerPtr, Marshal.SizeOf(cMainHeader));
cMainHeader = (PartimageMainHeader)Marshal.PtrToStructure(headerPtr, typeof(PartimageMainHeader));
Marshal.FreeHGlobal(headerPtr);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szFileSystem = {0}",
StringHandlers.CToString(cMainHeader.szFileSystem));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szPartDescription = {0}",
StringHandlers.CToString(cMainHeader.szPartDescription));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szOriginalDevice = {0}",
StringHandlers.CToString(cMainHeader.szOriginalDevice));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szFirstImageFilepath = {0}",
StringHandlers.CToString(cMainHeader.szFirstImageFilepath));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameSysname = {0}",
StringHandlers.CToString(cMainHeader.szUnameSysname));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameNodename = {0}",
StringHandlers.CToString(cMainHeader.szUnameNodename));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameRelease = {0}",
StringHandlers.CToString(cMainHeader.szUnameRelease));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameVersion = {0}",
StringHandlers.CToString(cMainHeader.szUnameVersion));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameMachine = {0}",
StringHandlers.CToString(cMainHeader.szUnameMachine));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwCompression = {0} ({1})",
cMainHeader.dwCompression, (uint)cMainHeader.dwCompression);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwMainFlags = {0}", cMainHeader.dwMainFlags);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_sec = {0}",
cMainHeader.dateCreate.Second);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_min = {0}",
cMainHeader.dateCreate.Minute);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_hour = {0}",
cMainHeader.dateCreate.Hour);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_mday = {0}",
cMainHeader.dateCreate.DayOfMonth);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_mon = {0}",
cMainHeader.dateCreate.Month);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_year = {0}",
cMainHeader.dateCreate.Year);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_wday = {0}",
cMainHeader.dateCreate.DayOfWeek);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_yday = {0}",
cMainHeader.dateCreate.DayOfYear);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_isdst = {0}",
cMainHeader.dateCreate.IsDst);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_gmtoffsec = {0}",
cMainHeader.dateCreate.GmtOff);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_zone = {0}",
cMainHeader.dateCreate.Timezone);
DateTime dateCreate = new DateTime(1900 + (int)cMainHeader.dateCreate.Year,
(int)cMainHeader.dateCreate.Month + 1,
(int)cMainHeader.dateCreate.DayOfMonth, (int)cMainHeader.dateCreate.Hour,
(int)cMainHeader.dateCreate.Minute, (int)cMainHeader.dateCreate.Second);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate = {0}", dateCreate);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.qwPartSize = {0}", cMainHeader.qwPartSize);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szHostname = {0}",
StringHandlers.CToString(cMainHeader.szHostname));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szVersion = {0}",
StringHandlers.CToString(cMainHeader.szVersion));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwMbrCount = {0}", cMainHeader.dwMbrCount);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwMbrSize = {0}", cMainHeader.dwMbrSize);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwEncryptAlgo = {0} ({1})",
cMainHeader.dwEncryptAlgo, (uint)cMainHeader.dwEncryptAlgo);
DicConsole.DebugWriteLine("Partimage plugin", "ArrayIsNullOrEmpty(CMainHeader.cHashTestKey) = {0}",
ArrayHelpers.ArrayIsNullOrEmpty(cMainHeader.cHashTestKey));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture000 = {0}",
cMainHeader.dwReservedFuture000);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture001 = {0}",
cMainHeader.dwReservedFuture001);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture002 = {0}",
cMainHeader.dwReservedFuture002);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture003 = {0}",
cMainHeader.dwReservedFuture003);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture004 = {0}",
cMainHeader.dwReservedFuture004);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture005 = {0}",
cMainHeader.dwReservedFuture005);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture006 = {0}",
cMainHeader.dwReservedFuture006);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture007 = {0}",
cMainHeader.dwReservedFuture007);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture008 = {0}",
cMainHeader.dwReservedFuture008);
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture009 = {0}",
cMainHeader.dwReservedFuture009);
DicConsole.DebugWriteLine("Partimage plugin", "ArrayIsNullOrEmpty(CMainHeader.cReserved) = {0}",
ArrayHelpers.ArrayIsNullOrEmpty(cMainHeader.cReserved));
DicConsole.DebugWriteLine("Partimage plugin", "CMainHeader.crc = 0x{0:X8}", cMainHeader.crc);
// partimage 0.6.1 does not support them either
if(cMainHeader.dwEncryptAlgo != PEncryption.None)
throw new ImageNotSupportedException("Encrypted images are currently not supported.");
string magic;
// Skip MBRs
if(cMainHeader.dwMbrCount > 0)
{
hdrB = new byte[MAGIC_BEGIN_MBRBACKUP.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_MBRBACKUP.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_MBRBACKUP)) throw new ImageNotSupportedException("Cannot find MBRs");
stream.Seek(cMainHeader.dwMbrSize * cMainHeader.dwMbrCount, SeekOrigin.Current);
}
// Skip extended headers and their CRC fields
stream.Seek((MAGIC_BEGIN_EXT000.Length + 4) * 10, SeekOrigin.Current);
hdrB = new byte[MAGIC_BEGIN_LOCALHEADER.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_LOCALHEADER.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_LOCALHEADER)) throw new ImageNotSupportedException("Cannot find local header");
hdrB = new byte[Marshal.SizeOf(typeof(CLocalHeader))];
stream.Read(hdrB, 0, Marshal.SizeOf(typeof(CLocalHeader)));
headerPtr = Marshal.AllocHGlobal(Marshal.SizeOf(typeof(CLocalHeader)));
Marshal.Copy(hdrB, 0, headerPtr, Marshal.SizeOf(typeof(CLocalHeader)));
CLocalHeader localHeader = (CLocalHeader)Marshal.PtrToStructure(headerPtr, typeof(CLocalHeader));
Marshal.FreeHGlobal(headerPtr);
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBlockSize = {0}", localHeader.qwBlockSize);
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwUsedBlocks = {0}", localHeader.qwUsedBlocks);
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBlocksCount = {0}",
localHeader.qwBlocksCount);
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBitmapSize = {0}", localHeader.qwBitmapSize);
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBadBlocksCount = {0}",
localHeader.qwBadBlocksCount);
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.szLabel = {0}",
StringHandlers.CToString(localHeader.szLabel));
DicConsole.DebugWriteLine("Partimage plugin", "ArrayIsNullOrEmpty(CLocalHeader.cReserved) = {0}",
ArrayHelpers.ArrayIsNullOrEmpty(localHeader.cReserved));
DicConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.crc = 0x{0:X8}", localHeader.crc);
hdrB = new byte[MAGIC_BEGIN_BITMAP.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_BITMAP.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_BITMAP)) throw new ImageNotSupportedException("Cannot find bitmap");
bitmap = new byte[localHeader.qwBitmapSize];
stream.Read(bitmap, 0, (int)localHeader.qwBitmapSize);
hdrB = new byte[MAGIC_BEGIN_INFO.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_INFO.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_INFO)) throw new ImageNotSupportedException("Cannot find info block");
// Skip info block and its checksum
stream.Seek(16384 + 4, SeekOrigin.Current);
hdrB = new byte[MAGIC_BEGIN_DATABLOCKS.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_DATABLOCKS.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_DATABLOCKS)) throw new ImageNotSupportedException("Cannot find data blocks");
dataOff = stream.Position;
DicConsole.DebugWriteLine("Partimage plugin", "dataOff = {0}", dataOff);
// Seek to tail
stream.Seek(-(Marshal.SizeOf(typeof(CMainTail)) + MAGIC_BEGIN_TAIL.Length), SeekOrigin.End);
hdrB = new byte[MAGIC_BEGIN_TAIL.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_TAIL.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_TAIL))
throw new
ImageNotSupportedException("Cannot find tail. Multiple volumes are not supported or image is corrupt.");
DicConsole.DebugWriteLine("Partimage plugin", "Filling extents");
DateTime start = DateTime.Now;
extents = new ExtentsULong();
extentsOff = new Dictionary<ulong, ulong>();
bool current = (bitmap[0] & (1 << (0 % 8))) != 0;
ulong blockOff = 0;
ulong extentStart = 0;
for(ulong i = 1; i <= localHeader.qwBlocksCount; i++)
{
bool next = (bitmap[i / 8] & (1 << (int)(i % 8))) != 0;
// Flux
if(next != current)
if(next)
{
extentStart = i;
extentsOff.Add(i, ++blockOff);
}
else
{
extents.Add(extentStart, i);
extentsOff.TryGetValue(extentStart, out ulong _);
}
if(next && current) blockOff++;
current = next;
}
DateTime end = DateTime.Now;
DicConsole.DebugWriteLine("Partimage plugin", "Took {0} seconds to fill extents",
(end - start).TotalSeconds);
sectorCache = new Dictionary<ulong, byte[]>();
imageInfo.CreationTime = dateCreate;
imageInfo.LastModificationTime = imageFilter.GetLastWriteTime();
imageInfo.MediaTitle = Path.GetFileNameWithoutExtension(imageFilter.GetFilename());
imageInfo.Sectors = localHeader.qwBlocksCount + 1;
imageInfo.SectorSize = (uint)localHeader.qwBlockSize;
imageInfo.XmlMediaType = XmlMediaType.BlockMedia;
imageInfo.MediaType = MediaType.GENERIC_HDD;
imageInfo.Version = StringHandlers.CToString(cMainHeader.szVersion);
imageInfo.Comments = StringHandlers.CToString(cMainHeader.szPartDescription);
imageInfo.ImageSize =
(ulong)(stream.Length - (dataOff + Marshal.SizeOf(typeof(CMainTail)) + MAGIC_BEGIN_TAIL.Length));
imageStream = stream;
return true;
}
public byte[] ReadSector(ulong sectorAddress)
{
if(sectorAddress > imageInfo.Sectors - 1)
throw new ArgumentOutOfRangeException(nameof(sectorAddress),
$"Sector address {sectorAddress} not found");
if((bitmap[sectorAddress / 8] & (1 << (int)(sectorAddress % 8))) == 0)
return new byte[imageInfo.SectorSize];
if(sectorCache.TryGetValue(sectorAddress, out byte[] sector)) return sector;
ulong blockOff = BlockOffset(sectorAddress);
// Offset of requested sector is:
// Start of data +
long imageOff = dataOff +
// How many stored bytes to skip
(long)(blockOff * imageInfo.SectorSize) +
// How many bytes of CRC blocks to skip
(long)(blockOff / (CHECK_FREQUENCY / imageInfo.SectorSize)) *
Marshal.SizeOf(typeof(CCheck));
sector = new byte[imageInfo.SectorSize];
imageStream.Seek(imageOff, SeekOrigin.Begin);
imageStream.Read(sector, 0, (int)imageInfo.SectorSize);
if(sectorCache.Count > MAX_CACHED_SECTORS) sectorCache.Clear();
sectorCache.Add(sectorAddress, sector);
return sector;
}
public byte[] ReadSectors(ulong sectorAddress, uint length)
{
if(sectorAddress > imageInfo.Sectors - 1)
throw new ArgumentOutOfRangeException(nameof(sectorAddress),
$"Sector address {sectorAddress} not found");
if(sectorAddress + length > imageInfo.Sectors)
throw new ArgumentOutOfRangeException(nameof(length), "Requested more sectors than available");
MemoryStream ms = new MemoryStream();
bool allEmpty = true;
for(uint i = 0; i < length; i++)
if((bitmap[sectorAddress / 8] & (1 << (int)(sectorAddress % 8))) != 0)
{
allEmpty = false;
break;
}
if(allEmpty) return new byte[imageInfo.SectorSize * length];
for(uint i = 0; i < length; i++)
{
byte[] sector = ReadSector(sectorAddress + i);
ms.Write(sector, 0, sector.Length);
}
return ms.ToArray();
}
}
}