Aaru/Aaru.Filesystems/FATX/File.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : File.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : FATX filesystem plugin.
//
// --[ Description ] ----------------------------------------------------------
//
//     Methods to handle files.
//
// --[ 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-2021 Natalia Portillo
// ****************************************************************************/

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
using Aaru.Helpers;
using FileAttributes = Aaru.CommonTypes.Structs.FileAttributes;

namespace Aaru.Filesystems
{
    public sealed partial class XboxFatPlugin
    {
        /// <inheritdoc />
        public ErrorNumber MapBlock(string path, long fileBlock, out long deviceBlock)
        {
            deviceBlock = 0;

            if(!_mounted)
                return ErrorNumber.AccessDenied;

            ErrorNumber err = Stat(path, out FileEntryInfo stat);

            if(err != ErrorNumber.NoError)
                return err;

            if(stat.Attributes.HasFlag(FileAttributes.Directory) &&
               !_debug)
                return ErrorNumber.IsDirectory;

            uint[] clusters = GetClusters((uint)stat.Inode);

            if(fileBlock >= clusters.Length)
                return ErrorNumber.InvalidArgument;

            deviceBlock = (long)(_firstClusterSector + ((clusters[fileBlock] - 1) * _sectorsPerCluster));

            return ErrorNumber.NoError;
        }

        /// <inheritdoc />
        public ErrorNumber GetAttributes(string path, out FileAttributes attributes)
        {
            attributes = new FileAttributes();

            if(!_mounted)
                return ErrorNumber.AccessDenied;

            ErrorNumber err = Stat(path, out FileEntryInfo stat);

            if(err != ErrorNumber.NoError)
                return err;

            attributes = stat.Attributes;

            return ErrorNumber.NoError;
        }

        /// <inheritdoc />
        public ErrorNumber Read(string path, long offset, long size, ref byte[] buf)
        {
            if(!_mounted)
                return ErrorNumber.AccessDenied;

            ErrorNumber err = Stat(path, out FileEntryInfo stat);

            if(err != ErrorNumber.NoError)
                return err;

            if(stat.Attributes.HasFlag(FileAttributes.Directory) &&
               !_debug)
                return ErrorNumber.IsDirectory;

            if(offset >= stat.Length)
                return ErrorNumber.InvalidArgument;

            if(size + offset >= stat.Length)
                size = stat.Length - offset;

            uint[] clusters = GetClusters((uint)stat.Inode);

            long firstCluster    = offset                   / _bytesPerCluster;
            long offsetInCluster = offset                   % _bytesPerCluster;
            long sizeInClusters  = (size + offsetInCluster) / _bytesPerCluster;

            if((size + offsetInCluster) % _bytesPerCluster > 0)
                sizeInClusters++;

            var ms = new MemoryStream();

            for(int i = 0; i < sizeInClusters; i++)
            {
                if(i + firstCluster >= clusters.Length)
                    return ErrorNumber.InvalidArgument;

                byte[] buffer =
                    _imagePlugin.
                        ReadSectors(_firstClusterSector + ((clusters[i + firstCluster] - 1) * _sectorsPerCluster),
                                    _sectorsPerCluster);

                ms.Write(buffer, 0, buffer.Length);
            }

            ms.Position = offsetInCluster;
            buf         = new byte[size];
            ms.Read(buf, 0, (int)size);

            return ErrorNumber.NoError;
        }

        /// <inheritdoc />
        public ErrorNumber Stat(string path, out FileEntryInfo stat)
        {
            stat = null;

            if(!_mounted)
                return ErrorNumber.AccessDenied;

            if(_debug && (string.IsNullOrEmpty(path) || path == "$" || path == "/"))
            {
                stat = new FileEntryInfo
                {
                    Attributes = FileAttributes.Directory | FileAttributes.System | FileAttributes.Hidden,
                    Blocks     = GetClusters(_superblock.rootDirectoryCluster).Length,
                    BlockSize  = _bytesPerCluster,
                    Length     = GetClusters(_superblock.rootDirectoryCluster).Length * _bytesPerCluster,
                    Inode      = _superblock.rootDirectoryCluster,
                    Links      = 1
                };

                return ErrorNumber.NoError;
            }

            ErrorNumber err = GetFileEntry(path, out DirectoryEntry entry);

            if(err != ErrorNumber.NoError)
                return err;

            stat = new FileEntryInfo
            {
                Attributes = new FileAttributes(),
                Blocks     = entry.length / _bytesPerCluster,
                BlockSize  = _bytesPerCluster,
                Length     = entry.length,
                Inode      = entry.firstCluster,
                Links      = 1,
                CreationTime = _littleEndian
                                   ? DateHandlers.DosToDateTime(entry.creationDate, entry.creationTime).AddYears(20)
                                   : DateHandlers.DosToDateTime(entry.creationTime, entry.creationDate),
                AccessTime = _littleEndian
                                 ? DateHandlers.DosToDateTime(entry.lastAccessDate, entry.lastAccessTime).AddYears(20)
                                 : DateHandlers.DosToDateTime(entry.lastAccessTime, entry.lastAccessDate),
                LastWriteTime = _littleEndian
                                    ? DateHandlers.DosToDateTime(entry.lastWrittenDate, entry.lastWrittenTime).
                                                   AddYears(20)
                                    : DateHandlers.DosToDateTime(entry.lastWrittenTime, entry.lastWrittenDate)
            };

            if(entry.length % _bytesPerCluster > 0)
                stat.Blocks++;

            if(entry.attributes.HasFlag(Attributes.Directory))
            {
                stat.Attributes |= FileAttributes.Directory;
                stat.Blocks     =  GetClusters(entry.firstCluster).Length;
                stat.Length     =  stat.Blocks * stat.BlockSize;
            }

            if(entry.attributes.HasFlag(Attributes.ReadOnly))
                stat.Attributes |= FileAttributes.ReadOnly;

            if(entry.attributes.HasFlag(Attributes.Hidden))
                stat.Attributes |= FileAttributes.Hidden;

            if(entry.attributes.HasFlag(Attributes.System))
                stat.Attributes |= FileAttributes.System;

            if(entry.attributes.HasFlag(Attributes.Archive))
                stat.Attributes |= FileAttributes.Archive;

            return ErrorNumber.NoError;
        }

        uint[] GetClusters(uint startCluster)
        {
            if(startCluster == 0)
                return null;

            if(_fat16 is null)
            {
                if(startCluster >= _fat32.Length)
                    return null;
            }
            else if(startCluster >= _fat16.Length)
                return null;

            List<uint> clusters = new();

            uint nextCluster = startCluster;

            if(_fat16 is null)
                while((nextCluster & FAT32_MASK) > 0 &&
                      (nextCluster & FAT32_MASK) <= FAT32_RESERVED)
                {
                    clusters.Add(nextCluster);
                    nextCluster = _fat32[nextCluster];
                }
            else
                while(nextCluster > 0 &&
                      nextCluster <= FAT16_RESERVED)
                {
                    clusters.Add(nextCluster);
                    nextCluster = _fat16[nextCluster];
                }

            return clusters.ToArray();
        }

        ErrorNumber GetFileEntry(string path, out DirectoryEntry entry)
        {
            entry = new DirectoryEntry();

            string cutPath = path.StartsWith('/') ? path.Substring(1).ToLower(_cultureInfo)
                                 : path.ToLower(_cultureInfo);

            string[] pieces = cutPath.Split(new[]
            {
                '/'
            }, StringSplitOptions.RemoveEmptyEntries);

            if(pieces.Length == 0)
                return ErrorNumber.InvalidArgument;

            string parentPath = string.Join("/", pieces, 0, pieces.Length - 1);

            ErrorNumber err = ReadDir(parentPath, out _);

            if(err != ErrorNumber.NoError)
                return err;

            Dictionary<string, DirectoryEntry> parent;

            if(pieces.Length == 1)
                parent = _rootDirectory;
            else if(!_directoryCache.TryGetValue(parentPath, out parent))
                return ErrorNumber.InvalidArgument;

            KeyValuePair<string, DirectoryEntry> dirent =
                parent.FirstOrDefault(t => t.Key.ToLower(_cultureInfo) == pieces[^1]);

            if(string.IsNullOrEmpty(dirent.Key))
                return ErrorNumber.NoSuchFile;

            entry = dirent.Value;

            return ErrorNumber.NoError;
        }
    }
}