Aaru/Aaru.Images/BLU/Read.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : Read.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
//     Reads Basic Lisa Utility 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-2025 Natalia Portillo
// ****************************************************************************/

using System;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using Aaru.CommonTypes;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Helpers;
using Aaru.Logging;

namespace Aaru.Images;

[SuppressMessage("ReSharper", "UnusedType.Global")]
public sealed partial class Blu
{
#region IWritableImage Members

    /// <inheritdoc />
    public ErrorNumber Open(IFilter imageFilter)
    {
        Stream stream = imageFilter.GetDataForkStream();
        stream.Seek(0, SeekOrigin.Begin);

        _imageHeader = new BluHeader
        {
            DeviceName = new byte[0x0D]
        };

        var header = new byte[0x17];
        stream.EnsureRead(header, 0, 0x17);
        Array.Copy(header, 0, _imageHeader.DeviceName, 0, 0x0D);
        _imageHeader.DeviceType    = BigEndianBitConverter.ToUInt32(header, 0x0C) & 0x00FFFFFF;
        _imageHeader.DeviceBlocks  = BigEndianBitConverter.ToUInt32(header, 0x11) & 0x00FFFFFF;
        _imageHeader.BytesPerBlock = BigEndianBitConverter.ToUInt16(header, 0x15);

        AaruLogging.Debug(MODULE_NAME,
                          "ImageHeader.deviceName = \"{0}\"",
                          StringHandlers.CToString(_imageHeader.DeviceName));

        AaruLogging.Debug(MODULE_NAME, "ImageHeader.deviceType = {0}",    _imageHeader.DeviceType);
        AaruLogging.Debug(MODULE_NAME, "ImageHeader.deviceBlock = {0}",   _imageHeader.DeviceBlocks);
        AaruLogging.Debug(MODULE_NAME, "ImageHeader.bytesPerBlock = {0}", _imageHeader.BytesPerBlock);

        for(var i = 0; i < 0xD; i++)
        {
            if(_imageHeader.DeviceName[i] < 0x20) return ErrorNumber.InvalidArgument;
        }

        if((_imageHeader.BytesPerBlock & 0xFE00) != 0x200) return ErrorNumber.InvalidArgument;

        stream.Seek(0, SeekOrigin.Begin);
        header = new byte[_imageHeader.BytesPerBlock];
        stream.EnsureRead(header, 0, _imageHeader.BytesPerBlock);

        _imageInfo.SectorSize = 0x200;

        _imageInfo.Sectors   = _imageHeader.DeviceBlocks;
        _imageInfo.ImageSize = _imageHeader.DeviceBlocks * _imageHeader.BytesPerBlock;
        _bptag               = _imageHeader.BytesPerBlock - 0x200;
        var hdrTag = new byte[_bptag];
        Array.Copy(header, 0x200, hdrTag, 0, _bptag);

        switch(StringHandlers.CToString(_imageHeader.DeviceName))
        {
            case PROFILE_NAME:
                _imageInfo.MediaType = _imageInfo.Sectors == 0x2600 ? MediaType.AppleProfile : MediaType.GENERIC_HDD;

                _imageInfo.Cylinders       = 152;
                _imageInfo.Heads           = 4;
                _imageInfo.SectorsPerTrack = 16;

                break;
            case PROFILE10_NAME:
                _imageInfo.MediaType = _imageInfo.Sectors == 0x4C00 ? MediaType.AppleProfile : MediaType.GENERIC_HDD;

                _imageInfo.Cylinders       = 304;
                _imageInfo.Heads           = 4;
                _imageInfo.SectorsPerTrack = 16;

                break;
            case WIDGET_NAME:
                _imageInfo.MediaType = _imageInfo.Sectors == 0x4C00 ? MediaType.AppleWidget : MediaType.GENERIC_HDD;

                _imageInfo.Cylinders       = 304;
                _imageInfo.Heads           = 4;
                _imageInfo.SectorsPerTrack = 16;

                break;
            case PRIAM_NAME:
                _imageInfo.MediaType = _imageInfo.Sectors == 0x022C7C
                                           ? MediaType.PriamDataTower
                                           : MediaType.GENERIC_HDD;

                // This values are invented...
                _imageInfo.Cylinders       = 419;
                _imageInfo.Heads           = 4;
                _imageInfo.SectorsPerTrack = 85;

                break;
            default:
                _imageInfo.MediaType       = MediaType.GENERIC_HDD;
                _imageInfo.Cylinders       = (uint)(_imageInfo.Sectors / 16 / 63);
                _imageInfo.Heads           = 16;
                _imageInfo.SectorsPerTrack = 63;

                break;
        }

        _imageInfo.Application = StringHandlers.CToString(hdrTag);

        _imageInfo.CreationTime         = imageFilter.CreationTime;
        _imageInfo.LastModificationTime = imageFilter.LastWriteTime;
        _imageInfo.MediaTitle           = Path.GetFileNameWithoutExtension(imageFilter.Filename);

        _bluImageFilter = imageFilter;

        _imageInfo.MetadataMediaType = MetadataMediaType.BlockMedia;

        if(_bptag > 0) _imageInfo.ReadableSectorTags.Add(SectorTagType.AppleSonyTag);

        AaruLogging.Verbose(Localization.BLU_image_contains_a_disk_of_type_0, _imageInfo.MediaType);

        return ErrorNumber.NoError;
    }

    /// <inheritdoc />
    public ErrorNumber ReadSector(ulong sectorAddress, out byte[] buffer, out SectorStatus sectorStatus)
    {
        sectorStatus = SectorStatus.Dumped;

        return ReadSectors(sectorAddress, 1, out buffer, out _);
    }

    /// <inheritdoc />
    public ErrorNumber ReadSectorTag(ulong sectorAddress, SectorTagType tag, out byte[] buffer) =>
        ReadSectorsTag(sectorAddress, 1, tag, out buffer);

    /// <inheritdoc />
    public ErrorNumber ReadSectors(ulong sectorAddress, uint length, out byte[] buffer, out SectorStatus[] sectorStatus)
    {
        buffer       = null;
        sectorStatus = null;

        if(sectorAddress > _imageInfo.Sectors - 1) return ErrorNumber.OutOfRange;

        if(sectorAddress + length > _imageInfo.Sectors) return ErrorNumber.OutOfRange;

        sectorStatus = new SectorStatus[length];
        for(uint i = 0; i < length; i++) sectorStatus[i] = SectorStatus.Dumped;

        var       ms   = new MemoryStream();
        const int read = 0x200;
        int       skip = _bptag;

        Stream stream = _bluImageFilter.GetDataForkStream();
        stream.Seek((long)((sectorAddress + 1) * _imageHeader.BytesPerBlock), SeekOrigin.Begin);

        for(var i = 0; i < length; i++)
        {
            var sector = new byte[read];
            stream.EnsureRead(sector, 0, read);
            ms.Write(sector, 0, read);
            stream.Seek(skip, SeekOrigin.Current);
        }

        buffer = ms.ToArray();

        return ErrorNumber.NoError;
    }

    /// <inheritdoc />
    public ErrorNumber ReadSectorsTag(ulong sectorAddress, uint length, SectorTagType tag, out byte[] buffer)
    {
        buffer = null;

        if(tag != SectorTagType.AppleSonyTag) return ErrorNumber.NotSupported;

        if(_bptag == 0) return ErrorNumber.NoData;

        if(sectorAddress > _imageInfo.Sectors - 1) return ErrorNumber.SectorNotFound;

        if(sectorAddress + length > _imageInfo.Sectors) return ErrorNumber.SectorNotFound;

        var       ms   = new MemoryStream();
        const int seek = 0x200;
        int       read = _bptag;

        Stream stream = _bluImageFilter.GetDataForkStream();
        stream.Seek((long)((sectorAddress + 1) * _imageHeader.BytesPerBlock), SeekOrigin.Begin);

        for(var i = 0; i < length; i++)
        {
            stream.Seek(seek, SeekOrigin.Current);
            var sector = new byte[read];
            stream.EnsureRead(sector, 0, read);
            ms.Write(sector, 0, read);
        }

        buffer = ms.ToArray();

        return ErrorNumber.NoError;
    }

    /// <inheritdoc />
    public ErrorNumber ReadSectorLong(ulong sectorAddress, out byte[] buffer, out SectorStatus sectorStatus)
    {
        sectorStatus = SectorStatus.Dumped;

        return ReadSectorsLong(sectorAddress, 1, out buffer, out _);
    }

    /// <inheritdoc />
    public ErrorNumber ReadSectorsLong(ulong              sectorAddress, uint length, out byte[] buffer,
                                       out SectorStatus[] sectorStatus)
    {
        buffer       = null;
        sectorStatus = null;

        if(sectorAddress > _imageInfo.Sectors - 1) return ErrorNumber.OutOfRange;

        if(sectorAddress + length > _imageInfo.Sectors) return ErrorNumber.OutOfRange;

        sectorStatus = new SectorStatus[length];
        for(uint i = 0; i < length; i++) sectorStatus[i] = SectorStatus.Dumped;

        buffer = new byte[length * _imageHeader.BytesPerBlock];
        Stream stream = _bluImageFilter.GetDataForkStream();
        stream.Seek((long)((sectorAddress + 1) * _imageHeader.BytesPerBlock), SeekOrigin.Begin);
        stream.EnsureRead(buffer, 0, buffer.Length);

        return ErrorNumber.NoError;
    }

#endregion
}