Aaru/Aaru.Filesystems/PFS/Info.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : Info.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Professional 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
// ****************************************************************************/

// ReSharper disable UnusedType.Local

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;

/// <inheritdoc />
/// <summary>Implements detection of the Professional File System</summary>
public sealed partial class PFS
{
#region IFilesystem Members

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

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

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

        var magic = BigEndianBitConverter.ToUInt32(sector, 0x00);

        return magic is AFS_DISK or PFS2_DISK or PFS_DISK or MUAF_DISK or MUPFS_DISK;
    }

    /// <inheritdoc />
    public void GetInformation(IMediaImage imagePlugin, Partition partition, Encoding encoding, out string information,
                               out FileSystem metadata)
    {
        information =   "";
        encoding    ??= Encoding.GetEncoding("iso-8859-1");
        metadata    =   new FileSystem();
        ErrorNumber errno = imagePlugin.ReadSector(2 + partition.Start, false, out byte[] rootBlockSector, out _);

        if(errno != ErrorNumber.NoError) return;

        RootBlock rootBlock = Marshal.ByteArrayToStructureBigEndian<RootBlock>(rootBlockSector);

        var sbInformation = new StringBuilder();
        metadata = new FileSystem();

        switch(rootBlock.diskType)
        {
            case AFS_DISK:
            case MUAF_DISK:
                sbInformation.Append(Localization.Professional_File_System_v1);
                metadata.Type = FS_TYPE;

                break;
            case PFS2_DISK:
                sbInformation.Append(Localization.Professional_File_System_v2);
                metadata.Type = FS_TYPE;

                break;
            case PFS_DISK:
            case MUPFS_DISK:
                sbInformation.Append(Localization.Professional_File_System_v3);
                metadata.Type = FS_TYPE;

                break;
        }

        if(rootBlock.diskType is MUAF_DISK or MUPFS_DISK) sbInformation.Append(Localization.with_multi_user_support);

        sbInformation.AppendLine();

        sbInformation
           .AppendFormat(Localization.Volume_name_0, StringHandlers.PascalToString(rootBlock.diskname, encoding))
           .AppendLine();

        sbInformation
           .AppendFormat(Localization.Volume_has_0_free_sectors_of_1, rootBlock.blocksfree, rootBlock.diskSize)
           .AppendLine();

        sbInformation.AppendFormat(Localization.Volume_created_on_0,
                                   DateHandlers.AmigaToDateTime(rootBlock.creationday,
                                                                rootBlock.creationminute,
                                                                rootBlock.creationtick))
                     .AppendLine();

        if(rootBlock.extension > 0)
        {
            sbInformation.AppendFormat(Localization.Root_block_extension_resides_at_block_0, rootBlock.extension)
                         .AppendLine();
        }

        information = sbInformation.ToString();

        metadata.CreationDate =
            DateHandlers.AmigaToDateTime(rootBlock.creationday, rootBlock.creationminute, rootBlock.creationtick);

        metadata.FreeClusters = rootBlock.blocksfree;
        metadata.Clusters     = rootBlock.diskSize;
        metadata.ClusterSize  = imagePlugin.Info.SectorSize;
        metadata.VolumeName   = StringHandlers.PascalToString(rootBlock.diskname, encoding);
    }

#endregion
}