[ECMA67] Add support for analyze command

This commit is contained in:
2026-04-11 00:23:16 +01:00
parent 78cd13385d
commit f8e9c810b1

View File

@@ -0,0 +1,178 @@
// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Analyze.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : ECMA-67 plugin.
//
// --[ Description ] ----------------------------------------------------------
//
// Sector overlap analysis for the ECMA-67 file system.
//
// --[ 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-2026 Natalia Portillo
// ****************************************************************************/
using System;
using System.Collections.Generic;
using System.Linq;
using Aaru.CommonTypes;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Structs;
namespace Aaru.Filesystems;
/// <inheritdoc />
/// <summary>Implements the filesystem described in ECMA-67</summary>
public sealed partial class ECMA67
{
#region IReadOnlyFilesystem Members
/// <inheritdoc />
public ErrorNumber GetFilesWithAffectedSectors(IEnumerable<(ulong Start, ulong End)> sectorExtents,
out List<FileSectorInfo> files,
InitProgressHandler initProgress = null,
UpdateProgressHandler updateProgress = null,
PulseProgressHandler pulseProgress = null,
EndProgressHandler endProgress = null)
{
files = [];
if(!_mounted) return ErrorNumber.AccessDenied;
if(sectorExtents is null) return ErrorNumber.InvalidArgument;
List<(ulong Start, ulong End)> normalizedExtents = NormalizeAnalyzeExtents(sectorExtents);
if(normalizedExtents.Count == 0) return ErrorNumber.NoError;
try
{
initProgress?.Invoke();
pulseProgress?.Invoke("/");
KeyValuePair<string, FileLabel>[] orderedEntries =
_fileLabels.OrderBy(static entry => entry.Key, StringComparer.OrdinalIgnoreCase).ToArray();
long maximum = orderedEntries.Length > 0 ? orderedEntries.Length : 1;
for(var i = 0; i < orderedEntries.Length; i++)
{
string path = "/" + orderedEntries[i].Key;
FileLabel label = orderedEntries[i].Value;
updateProgress?.Invoke(path, i + 1, maximum);
ErrorNumber errno = AddOverlappingFile(path, label, normalizedExtents, files);
if(errno != ErrorNumber.NoError) return errno;
}
return ErrorNumber.NoError;
}
finally
{
endProgress?.Invoke();
}
}
#endregion
ErrorNumber AddOverlappingFile(string path, in FileLabel label,
IReadOnlyList<(ulong Start, ulong End)> sectorExtents, List<FileSectorInfo> files)
{
if(!TryParseExtentAddress(label.beginOfExtent, out ulong startLba) ||
!TryParseExtentAddress(label.endOfExtent, out ulong endLba))
return ErrorNumber.NoError;
if(endLba < startLba) return ErrorNumber.NoError;
long logicalLength = ComputeFileLength(label,
startLba,
endLba,
ParseAsciiNumber(label.blockLength, PHYSICAL_RECORD_LENGTH_DATA));
if(logicalLength <= 0) return ErrorNumber.NoError;
ulong lastUsedLba = endLba;
if(TryParseExtentAddress(label.endOfData, out ulong endOfDataLba) && endOfDataLba > startLba)
lastUsedLba = Math.Min(endLba, endOfDataLba - 1);
List<(ulong Start, ulong End)> overlaps = [];
AddExtentOverlaps(startLba, lastUsedLba, sectorExtents, overlaps);
overlaps = NormalizeAnalyzeExtents(overlaps);
if(overlaps.Count == 0) return ErrorNumber.NoError;
files.Add(new FileSectorInfo
{
Path = path,
Inode = startLba,
AffectedSectors = overlaps
});
return ErrorNumber.NoError;
}
static void AddExtentOverlaps(ulong startSector, ulong endSector,
IReadOnlyList<(ulong Start, ulong End)> sectorExtents,
List<(ulong Start, ulong End)> overlaps)
{
foreach((ulong Start, ulong End) requestedExtent in sectorExtents)
{
if(requestedExtent.End < startSector || requestedExtent.Start > endSector) continue;
overlaps.Add((Math.Max(startSector, requestedExtent.Start), Math.Min(endSector, requestedExtent.End)));
}
}
static List<(ulong Start, ulong End)> NormalizeAnalyzeExtents(IEnumerable<(ulong Start, ulong End)> extents)
{
var orderedExtents = extents.Where(static extent => extent.End >= extent.Start)
.OrderBy(static extent => extent.Start)
.ThenBy(static extent => extent.End)
.ToList();
List<(ulong Start, ulong End)> normalizedExtents = [];
if(orderedExtents.Count == 0) return normalizedExtents;
(ulong Start, ulong End) currentExtent = orderedExtents[0];
for(var i = 1; i < orderedExtents.Count; i++)
{
if(orderedExtents[i].Start <= currentExtent.End + 1)
{
currentExtent.End = Math.Max(currentExtent.End, orderedExtents[i].End);
continue;
}
normalizedExtents.Add(currentExtent);
currentExtent = orderedExtents[i];
}
normalizedExtents.Add(currentExtent);
return normalizedExtents;
}
}