Aaru/Aaru.Filesystems/FATX/Info.cs

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

namespace Aaru.Filesystems;

public sealed partial class XboxFatPlugin
{
#region IReadOnlyFilesystem Members

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

        ErrorNumber errno = imagePlugin.ReadSector(partition.Start, out byte[] sector);

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

        Superblock sb = Marshal.ByteArrayToStructureBigEndianGenerated<Superblock>(sector);

        return sb.magic is FATX_MAGIC or FATX_CIGAM;
    }

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

        if(imagePlugin.Info.SectorSize < 512) return;

        var bigEndian = true;

        ErrorNumber errno = imagePlugin.ReadSector(partition.Start, out byte[] sector);

        if(errno != ErrorNumber.NoError) return;

        Superblock fatxSb = Marshal.ByteArrayToStructureBigEndianGenerated<Superblock>(sector);

        if(fatxSb.magic == FATX_CIGAM)
        {
            fatxSb    = Marshal.ByteArrayToStructureLittleEndian<Superblock>(sector);
            bigEndian = false;
        }

        if(fatxSb.magic != FATX_MAGIC) return;

        int logicalSectorsPerPhysicalSectors = partition.Offset == 0 && !bigEndian ? 8 : 1;

        var sb = new StringBuilder();

        sb.AppendLine(Localization.FATX_filesystem);

        sb.AppendFormat(Localization._0_logical_sectors_1_bytes_per_physical_sector,
                        logicalSectorsPerPhysicalSectors,
                        logicalSectorsPerPhysicalSectors * imagePlugin.Info.SectorSize)
          .AppendLine();

        sb.AppendFormat(Localization._0_sectors_1_bytes_per_cluster,
                        fatxSb.sectorsPerCluster,
                        fatxSb.sectorsPerCluster * logicalSectorsPerPhysicalSectors * imagePlugin.Info.SectorSize)
          .AppendLine();

        sb.AppendFormat(Localization.Root_directory_starts_at_cluster_0, fatxSb.rootDirectoryCluster).AppendLine();

        string volumeLabel = StringHandlers.CToString(fatxSb.volumeLabel,
                                                      bigEndian ? Encoding.BigEndianUnicode : Encoding.Unicode,
                                                      true);

        sb.AppendFormat(Localization.Volume_label_0,     volumeLabel).AppendLine();
        sb.AppendFormat(Localization.Volume_serial_0_X8, fatxSb.id).AppendLine();

        information = sb.ToString();

        metadata = new FileSystem
        {
            Type = FS_TYPE,
            ClusterSize = (uint)(fatxSb.sectorsPerCluster         *
                                 logicalSectorsPerPhysicalSectors *
                                 imagePlugin.Info.SectorSize),
            VolumeName   = volumeLabel,
            VolumeSerial = $"{fatxSb.id:X8}"
        };

        metadata.Clusters = (partition.End - partition.Start + 1) * imagePlugin.Info.SectorSize / metadata.ClusterSize;
    }

#endregion
}