Files

362 lines
15 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Info.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Amiga Fast File System plugin.
//
// --[ 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-2025 Natalia Portillo
// ****************************************************************************/
using System;
using System.Linq;
using System.Text;
using Aaru.Checksums;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Helpers;
using Aaru.Logging;
using Partition = Aaru.CommonTypes.Partition;
namespace Aaru.Filesystems;
/// <inheritdoc />
/// <summary>Implements detection of Amiga Fast File System (AFFS)</summary>
public sealed partial class AmigaDOSPlugin
{
#region IFilesystem Members
/// <inheritdoc />
public bool Identify(IMediaImage imagePlugin, Partition partition)
{
if(partition.Start + 4 >= partition.End) return false;
// Boot block is unless defined otherwise, 2 blocks
// Funny, you may need boot block to find root block if it's not in standard place just to know size of
// block size and then read the whole boot block.
// However while you can set a block size different from the sector size on formatting, the bootblock block
// size for floppies is the sector size, and for RDB is usually is the hard disk sector size,
// so this is not entirely wrong...
ErrorNumber errno = imagePlugin.ReadSectors(0 + partition.Start, false, 2, out byte[] sector, out _);
if(errno != ErrorNumber.NoError) return false;
BootBlock bblk = Marshal.ByteArrayToStructureBigEndian<BootBlock>(sector);
// AROS boot floppies...
if(sector.Length >= 512 &&
sector[510] == 0x55 &&
sector[511] == 0xAA &&
(bblk.diskType & FFS_MASK) != FFS_MASK &&
(bblk.diskType & MUFS_MASK) != MUFS_MASK)
{
errno = imagePlugin.ReadSectors(1 + partition.Start, false, 2, out sector, out _);
if(errno != ErrorNumber.NoError) return false;
bblk = Marshal.ByteArrayToStructureBigEndian<BootBlock>(sector);
}
// Not FFS or MuFS?
if((bblk.diskType & FFS_MASK) != FFS_MASK && (bblk.diskType & MUFS_MASK) != MUFS_MASK) return false;
// Clear checksum on sector
sector[4] = sector[5] = sector[6] = sector[7] = 0;
uint bsum = AmigaBootChecksum(sector);
AaruLogging.Debug(MODULE_NAME, "bblk.checksum = 0x{0:X8}", bblk.checksum);
AaruLogging.Debug(MODULE_NAME, "bsum = 0x{0:X8}", bsum);
ulong bRootPtr = 0;
// If bootblock is correct, let's take its rootblock pointer
if(bsum == bblk.checksum)
{
bRootPtr = bblk.root_ptr + partition.Start;
AaruLogging.Debug(MODULE_NAME, Localization.Bootblock_points_to_0_as_Rootblock, bRootPtr);
}
ulong[] rootPtrs =
[
bRootPtr + partition.Start, (partition.End - partition.Start + 1) / 2 + partition.Start - 2,
(partition.End - partition.Start + 1) / 2 + partition.Start - 1,
(partition.End - partition.Start + 1) / 2 + partition.Start,
(partition.End - partition.Start + 1) / 2 + partition.Start + 4
];
var rblk = new RootBlock();
// So to handle even number of sectors
foreach(ulong rootPtr in rootPtrs.Where(rootPtr => rootPtr < partition.End && rootPtr >= partition.Start))
{
AaruLogging.Debug(MODULE_NAME, Localization.Searching_for_Rootblock_in_sector_0, rootPtr);
errno = imagePlugin.ReadSector(rootPtr, false, out sector, out _);
if(errno != ErrorNumber.NoError) continue;
rblk.type = BigEndianBitConverter.ToUInt32(sector, 0x00);
AaruLogging.Debug(MODULE_NAME, "rblk.type = {0}", rblk.type);
if(rblk.type != TYPE_HEADER) continue;
rblk.hashTableSize = BigEndianBitConverter.ToUInt32(sector, 0x0C);
AaruLogging.Debug(MODULE_NAME, "rblk.hashTableSize = {0}", rblk.hashTableSize);
uint blockSize = (rblk.hashTableSize + 56) * 4;
var sectorsPerBlock = (uint)(blockSize / sector.Length);
AaruLogging.Debug(MODULE_NAME, "blockSize = {0}", blockSize);
AaruLogging.Debug(MODULE_NAME, "sectorsPerBlock = {0}", sectorsPerBlock);
if(blockSize % sector.Length > 0) sectorsPerBlock++;
if(rootPtr + sectorsPerBlock >= partition.End) continue;
errno = imagePlugin.ReadSectors(rootPtr, false, sectorsPerBlock, out sector, out _);
if(errno != ErrorNumber.NoError) continue;
// Clear checksum on sector
rblk.checksum = BigEndianBitConverter.ToUInt32(sector, 20);
sector[20] = sector[21] = sector[22] = sector[23] = 0;
uint rsum = AmigaChecksum(sector);
AaruLogging.Debug(MODULE_NAME, "rblk.checksum = 0x{0:X8}", rblk.checksum);
AaruLogging.Debug(MODULE_NAME, "rsum = 0x{0:X8}", rsum);
rblk.sec_type = BigEndianBitConverter.ToUInt32(sector, sector.Length - 4);
AaruLogging.Debug(MODULE_NAME, "rblk.sec_type = {0}", rblk.sec_type);
if(rblk.sec_type == SUBTYPE_ROOT && rblk.checksum == rsum) return true;
}
return false;
}
/// <inheritdoc />
public void GetInformation(IMediaImage imagePlugin, Partition partition, Encoding encoding, out string information,
out FileSystem metadata)
{
encoding ??= Encoding.GetEncoding("iso-8859-1");
var sbInformation = new StringBuilder();
metadata = new FileSystem();
information = null;
ErrorNumber errno = imagePlugin.ReadSectors(0 + partition.Start, false, 2, out byte[] bootBlockSectors, out _);
if(errno != ErrorNumber.NoError) return;
BootBlock bootBlk = Marshal.ByteArrayToStructureBigEndian<BootBlock>(bootBlockSectors);
bootBlk.bootCode = new byte[bootBlockSectors.Length - 12];
Array.Copy(bootBlockSectors, 12, bootBlk.bootCode, 0, bootBlk.bootCode.Length);
bootBlockSectors[4] = bootBlockSectors[5] = bootBlockSectors[6] = bootBlockSectors[7] = 0;
uint bsum = AmigaBootChecksum(bootBlockSectors);
ulong bRootPtr = 0;
// If bootblock is correct, let's take its rootblock pointer
if(bsum == bootBlk.checksum)
{
bRootPtr = bootBlk.root_ptr + partition.Start;
AaruLogging.Debug(MODULE_NAME, Localization.Bootblock_points_to_0_as_Rootblock, bRootPtr);
}
ulong[] rootPtrs =
[
bRootPtr + partition.Start, (partition.End - partition.Start + 1) / 2 + partition.Start - 2,
(partition.End - partition.Start + 1) / 2 + partition.Start - 1,
(partition.End - partition.Start + 1) / 2 + partition.Start,
(partition.End - partition.Start + 1) / 2 + partition.Start + 4
];
var rootBlk = new RootBlock();
byte[] rootBlockSector = null;
var rootFound = false;
uint blockSize = 0;
// So to handle even number of sectors
foreach(ulong rootPtr in rootPtrs.Where(rootPtr => rootPtr < partition.End && rootPtr >= partition.Start))
{
AaruLogging.Debug(MODULE_NAME, Localization.Searching_for_Rootblock_in_sector_0, rootPtr);
errno = imagePlugin.ReadSector(rootPtr, false, out rootBlockSector, out _);
if(errno != ErrorNumber.NoError) continue;
rootBlk.type = BigEndianBitConverter.ToUInt32(rootBlockSector, 0x00);
AaruLogging.Debug(MODULE_NAME, "rootBlk.type = {0}", rootBlk.type);
if(rootBlk.type != TYPE_HEADER) continue;
rootBlk.hashTableSize = BigEndianBitConverter.ToUInt32(rootBlockSector, 0x0C);
AaruLogging.Debug(MODULE_NAME, "rootBlk.hashTableSize = {0}", rootBlk.hashTableSize);
blockSize = (rootBlk.hashTableSize + 56) * 4;
var sectorsPerBlock = (uint)(blockSize / rootBlockSector.Length);
AaruLogging.Debug(MODULE_NAME, "blockSize = {0}", blockSize);
AaruLogging.Debug(MODULE_NAME, "sectorsPerBlock = {0}", sectorsPerBlock);
if(blockSize % rootBlockSector.Length > 0) sectorsPerBlock++;
if(rootPtr + sectorsPerBlock >= partition.End) continue;
errno = imagePlugin.ReadSectors(rootPtr, false, sectorsPerBlock, out rootBlockSector, out _);
if(errno != ErrorNumber.NoError) continue;
// Clear checksum on sector
rootBlk.checksum = BigEndianBitConverter.ToUInt32(rootBlockSector, 20);
rootBlockSector[20] = rootBlockSector[21] = rootBlockSector[22] = rootBlockSector[23] = 0;
uint rsum = AmigaChecksum(rootBlockSector);
AaruLogging.Debug(MODULE_NAME, "rootBlk.checksum = 0x{0:X8}", rootBlk.checksum);
AaruLogging.Debug(MODULE_NAME, "rsum = 0x{0:X8}", rsum);
rootBlk.sec_type = BigEndianBitConverter.ToUInt32(rootBlockSector, rootBlockSector.Length - 4);
AaruLogging.Debug(MODULE_NAME, "rootBlk.sec_type = {0}", rootBlk.sec_type);
if(rootBlk.sec_type != SUBTYPE_ROOT || rootBlk.checksum != rsum) continue;
errno = imagePlugin.ReadSectors(rootPtr, false, sectorsPerBlock, out rootBlockSector, out _);
if(errno != ErrorNumber.NoError) continue;
rootFound = true;
break;
}
if(!rootFound) return;
rootBlk = MarshalRootBlock(rootBlockSector);
string diskName = StringHandlers.PascalToString(rootBlk.diskName, encoding);
switch(bootBlk.diskType & 0xFF)
{
case 0:
sbInformation.Append(Localization.Amiga_Original_File_System);
metadata.Type = FS_TYPE_OFS;
break;
case 1:
sbInformation.Append(Localization.Amiga_Fast_File_System);
metadata.Type = FS_TYPE_FFS;
break;
case 2:
sbInformation.Append(Localization.Amiga_Original_File_System_with_international_characters);
metadata.Type = FS_TYPE_OFS;
break;
case 3:
sbInformation.Append(Localization.Amiga_Fast_File_System_with_international_characters);
metadata.Type = FS_TYPE_FFS;
break;
case 4:
sbInformation.Append(Localization.Amiga_Original_File_System_with_directory_cache);
metadata.Type = FS_TYPE_OFS;
break;
case 5:
sbInformation.Append(Localization.Amiga_Fast_File_System_with_directory_cache);
metadata.Type = FS_TYPE_FFS;
break;
case 6:
sbInformation.Append(Localization.Amiga_Original_File_System_with_long_filenames);
metadata.Type = FS_TYPE_OFS2;
break;
case 7:
sbInformation.Append(Localization.Amiga_Fast_File_System_with_long_filenames);
metadata.Type = FS_TYPE_FFS2;
break;
}
if((bootBlk.diskType & 0x6D754600) == 0x6D754600) sbInformation.Append(Localization.with_multi_user_patches);
sbInformation.AppendLine();
sbInformation.AppendFormat(Localization.Volume_name_0, diskName).AppendLine();
if(bootBlk.checksum == bsum)
{
var sha1Ctx = new Sha1Context();
sha1Ctx.Update(bootBlk.bootCode);
sbInformation.AppendLine(Localization.Volume_is_bootable);
sbInformation.AppendFormat(Localization.Boot_code_SHA1_0, sha1Ctx.End()).AppendLine();
}
if(rootBlk.bitmapFlag == 0xFFFFFFFF) sbInformation.AppendLine(Localization.Volume_bitmap_is_valid);
if(rootBlk.bitmapExtensionBlock != 0x00000000 && rootBlk.bitmapExtensionBlock != 0xFFFFFFFF)
{
sbInformation.AppendFormat(Localization.Bitmap_extension_at_block_0, rootBlk.bitmapExtensionBlock)
.AppendLine();
}
if((bootBlk.diskType & 0xFF) == 4 || (bootBlk.diskType & 0xFF) == 5)
sbInformation.AppendFormat(Localization.Directory_cache_starts_at_block_0, rootBlk.extension).AppendLine();
ulong blocks = (partition.End - partition.Start + 1) * imagePlugin.Info.SectorSize / blockSize;
sbInformation.AppendFormat(Localization.Volume_block_size_is_0_bytes, blockSize).AppendLine();
sbInformation.AppendFormat(Localization.Volume_has_0_blocks, blocks).AppendLine();
sbInformation.AppendFormat(Localization.Volume_created_on_0,
DateHandlers.AmigaToDateTime(rootBlk.cDays, rootBlk.cMins, rootBlk.cTicks))
.AppendLine();
sbInformation.AppendFormat(Localization.Volume_last_modified_on_0,
DateHandlers.AmigaToDateTime(rootBlk.vDays, rootBlk.vMins, rootBlk.vTicks))
.AppendLine();
sbInformation.AppendFormat(Localization.Volume_root_directory_last_modified_on_0,
DateHandlers.AmigaToDateTime(rootBlk.rDays, rootBlk.rMins, rootBlk.rTicks))
.AppendLine();
sbInformation.AppendFormat(Localization.Root_block_checksum_is_0, rootBlk.checksum).AppendLine();
information = sbInformation.ToString();
metadata.CreationDate = DateHandlers.AmigaToDateTime(rootBlk.cDays, rootBlk.cMins, rootBlk.cTicks);
metadata.ModificationDate = DateHandlers.AmigaToDateTime(rootBlk.vDays, rootBlk.vMins, rootBlk.vTicks);
metadata.Dirty = rootBlk.bitmapFlag != 0xFFFFFFFF;
metadata.Clusters = blocks;
metadata.ClusterSize = blockSize;
metadata.VolumeName = diskName;
metadata.Bootable = bsum == bootBlk.checksum;
// Useful as a serial
metadata.VolumeSerial = $"{rootBlk.checksum:X8}";
}
#endregion
}