Aaru/Aaru.Filesystems/CBM/Info.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : Info.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Commodore 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.Text;
using Aaru.CommonTypes.AaruMetadata;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interfaces;
using Aaru.Helpers;
using Claunia.Encoding;
using Encoding = System.Text.Encoding;
using Partition = Aaru.CommonTypes.Partition;

namespace Aaru.Filesystems;

/// <inheritdoc />
/// <summary>Implements detection of the filesystem used in 8-bit Commodore microcomputers</summary>
public sealed partial class CBM
{
#region IReadOnlyFilesystem Members

    /// <inheritdoc />
    public bool Identify(IMediaImage imagePlugin, Partition partition)
    {
        if(partition.Start > 0) return false;

        if(imagePlugin.Info.SectorSize != 256) return false;

        if(imagePlugin.Info.Sectors != 683  &&
           imagePlugin.Info.Sectors != 768  &&
           imagePlugin.Info.Sectors != 1366 &&
           imagePlugin.Info.Sectors != 3200)
            return false;

        byte[] sector;

        if(imagePlugin.Info.Sectors == 3200)
        {
            ErrorNumber errno = imagePlugin.ReadSector(1560, out sector);

            if(errno != ErrorNumber.NoError) return false;

            Header cbmHdr = Marshal.ByteArrayToStructureLittleEndian<Header>(sector);

            if(cbmHdr.diskDosVersion == 0x44 && cbmHdr is { dosVersion: 0x33, diskVersion: 0x44 }) return true;
        }
        else
        {
            ErrorNumber errno = imagePlugin.ReadSector(357, out sector);

            if(errno != ErrorNumber.NoError) return false;

            BAM cbmBam = Marshal.ByteArrayToStructureLittleEndian<BAM>(sector);

            if(cbmBam is { dosVersion: 0x41, doubleSided: 0x00 or 0x80 } and { unused1: 0x00, directoryTrack: 0x12 })
                return true;
        }

        return false;
    }

    /// <inheritdoc />
    public void GetInformation(IMediaImage imagePlugin, Partition partition, Encoding encoding, out string information,
                               out FileSystem metadata)
    {
        encoding    = new PETSCII();
        information = "";
        byte[] sector;

        var sbInformation = new StringBuilder();

        sbInformation.AppendLine(Localization.Commodore_file_system);

        metadata = new FileSystem
        {
            Type        = FS_TYPE,
            Clusters    = imagePlugin.Info.Sectors,
            ClusterSize = 256
        };

        if(imagePlugin.Info.Sectors == 3200)
        {
            ErrorNumber errno = imagePlugin.ReadSector(1560, out sector);

            if(errno != ErrorNumber.NoError) return;

            Header cbmHdr = Marshal.ByteArrayToStructureLittleEndian<Header>(sector);

            sbInformation.AppendFormat(Localization.Directory_starts_at_track_0_sector_1,
                                       cbmHdr.directoryTrack,
                                       cbmHdr.directorySector)
                         .AppendLine();

            sbInformation.AppendFormat(Localization.Disk_DOS_Version_0,
                                       Encoding.ASCII.GetString(new[]
                                       {
                                           cbmHdr.diskDosVersion
                                       }))
                         .AppendLine();

            sbInformation.AppendFormat(Localization.DOS_Version_0,
                                       Encoding.ASCII.GetString(new[]
                                       {
                                           cbmHdr.dosVersion
                                       }))
                         .AppendLine();

            sbInformation.AppendFormat(Localization.Disk_Version_0,
                                       Encoding.ASCII.GetString(new[]
                                       {
                                           cbmHdr.diskVersion
                                       }))
                         .AppendLine();

            sbInformation.AppendFormat(Localization.Disk_ID_0, cbmHdr.diskId).AppendLine();

            sbInformation.AppendFormat(Localization.Disk_name_0, StringHandlers.CToString(cbmHdr.name, encoding))
                         .AppendLine();

            metadata.VolumeName   = StringHandlers.CToString(cbmHdr.name, encoding);
            metadata.VolumeSerial = $"{cbmHdr.diskId}";
        }
        else
        {
            ErrorNumber errno = imagePlugin.ReadSector(357, out sector);

            if(errno != ErrorNumber.NoError) return;

            BAM cbmBam = Marshal.ByteArrayToStructureLittleEndian<BAM>(sector);

            sbInformation.AppendFormat(Localization.Directory_starts_at_track_0_sector_1,
                                       cbmBam.directoryTrack,
                                       cbmBam.directorySector)
                         .AppendLine();

            sbInformation.AppendFormat(Localization.Disk_DOS_type_0,
                                       Encoding.ASCII.GetString(BitConverter.GetBytes(cbmBam.dosType)))
                         .AppendLine();

            sbInformation.AppendFormat(Localization.DOS_Version_0,
                                       Encoding.ASCII.GetString(new[]
                                       {
                                           cbmBam.dosVersion
                                       }))
                         .AppendLine();

            sbInformation.AppendFormat(Localization.Disk_ID_0, cbmBam.diskId).AppendLine();

            sbInformation.AppendFormat(Localization.Disk_name_0, StringHandlers.CToString(cbmBam.name, encoding))
                         .AppendLine();

            metadata.VolumeName   = StringHandlers.CToString(cbmBam.name, encoding);
            metadata.VolumeSerial = $"{cbmBam.diskId}";
        }

        information = sbInformation.ToString();
    }

#endregion
}