Moved submodules to directories.

Aaru.CommonTypes/Metadata/CdOffset.cs

@@ -0,0 +1,58 @@
+// /***************************************************************************
+// Aaru Data Preservation Suite
+// ----------------------------------------------------------------------------
+//
+// Filename       : CdOffset.cs
+// Author(s)      : Natalia Portillo <claunia@claunia.com>
+//
+// Component      : Device database.
+//
+// --[ Description ] ----------------------------------------------------------
+//
+//     Models Compact Disc read offset entries from AccurateRip database.
+//
+// --[ License ] --------------------------------------------------------------
+//
+//     Permission is hereby granted, free of charge, to any person obtaining a
+//     copy of this software and associated documentation files (the
+//     "Software"), to deal in the Software without restriction, including
+//     without limitation the rights to use, copy, modify, merge, publish,
+//     distribute, sublicense, and/or sell copies of the Software, and to
+//     permit persons to whom the Software is furnished to do so, subject to
+//     the following conditions:
+//
+//     The above copyright notice and this permission notice shall be included
+//     in all copies or substantial portions of the Software.
+//
+//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+//     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+//     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+//     CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+//     TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+//     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+// ----------------------------------------------------------------------------
+// Copyright © 2011-2023 Natalia Portillo
+// ****************************************************************************/
+
+using System.ComponentModel.DataAnnotations;
+
+namespace Aaru.CommonTypes.Metadata
+{
+    /// <summary>Describes CD reading offset</summary>
+    public class CdOffset
+    {
+        /// <summary>Drive manufacturer</summary>
+        public string Manufacturer { get; set; }
+        /// <summary>Drive model</summary>
+        public string Model { get; set; }
+        /// <summary>Reading offset</summary>
+        public short Offset { get; set; }
+        /// <summary>Number of times this offset has been submitted</summary>
+        public int Submissions { get; set; }
+        /// <summary>Percentage of submissions in agreement with this offset</summary>
+        [DisplayFormat(ApplyFormatInEditMode = true, DataFormatString = "{0:P0}")]
+        public float Agreement { get; set; }
+    }
+}

Aaru.CommonTypes/Metadata/Resume.cs

@@ -0,0 +1,80 @@
+// /***************************************************************************
+// Aaru Data Preservation Suite
+// ----------------------------------------------------------------------------
+//
+// Filename       : Resume.cs
+// Author(s)      : Natalia Portillo <claunia@claunia.com>
+//
+// Component      : XML metadata.
+//
+// --[ Description ] ----------------------------------------------------------
+//
+//     Defines XML format of a dump resume file.
+//
+// --[ License ] --------------------------------------------------------------
+//
+//     Permission is hereby granted, free of charge, to any person obtaining a
+//     copy of this software and associated documentation files (the
+//     "Software"), to deal in the Software without restriction, including
+//     without limitation the rights to use, copy, modify, merge, publish,
+//     distribute, sublicense, and/or sell copies of the Software, and to
+//     permit persons to whom the Software is furnished to do so, subject to
+//     the following conditions:
+//
+//     The above copyright notice and this permission notice shall be included
+//     in all copies or substantial portions of the Software.
+//
+//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+//     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+//     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+//     CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+//     TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+//     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+// ----------------------------------------------------------------------------
+// Copyright © 2011-2023 Natalia Portillo
+// ****************************************************************************/
+
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using Schemas;
+
+namespace Aaru.CommonTypes.Metadata
+{
+    /// <summary>Information that allows to resume a dump</summary>
+    [Serializable, XmlRoot("DicResume", Namespace = "", IsNullable = false)]
+    public class Resume
+    {
+        /// <summary>List of blocks that returned an error on reading</summary>
+        [XmlArrayItem("Block")]
+        public List<ulong> BadBlocks;
+        /// <summary>Date/time this resume file was created</summary>
+        [XmlElement(DataType = "dateTime")]
+        public DateTime CreationDate;
+        /// <summary>Last block on media</summary>
+        public ulong LastBlock;
+        /// <summary>Date/time this resume file was last written to</summary>
+        [XmlElement(DataType = "dateTime")]
+        public DateTime LastWriteDate;
+        /// <summary>Next block to read</summary>
+        public ulong NextBlock;
+        /// <summary>Is media removable?</summary>
+        public bool Removable;
+        /// <summary>Is media a tape?</summary>
+        public bool Tape;
+        /// <summary>List of CD subchannels that did not read correctly</summary>
+        [XmlArrayItem("Block")]
+        public List<int> BadSubchannels;
+        /// <summary>Extents of BLANK sectors for magneto-opticals</summary>
+        [XmlArrayItem("Extent")]
+        public ExtentType[] BlankExtents;
+        /// <summary>Title keys that has not been read</summary>
+        [XmlArrayItem("Block")]
+        public List<ulong> MissingTitleKeys;
+        /// <summary>List of dump tries</summary>
+        [XmlArrayItem("DumpTry")]
+        public List<DumpHardwareType> Tries;
+    }
+}

Aaru.CommonTypes/Metadata/Statistics.cs

@@ -0,0 +1,309 @@
+// /***************************************************************************
+// Aaru Data Preservation Suite
+// ----------------------------------------------------------------------------
+//
+// Filename       : Statistics.cs
+// Author(s)      : Natalia Portillo <claunia@claunia.com>
+//
+// Component      : XML metadata.
+//
+// --[ Description ] ----------------------------------------------------------
+//
+//     Define XML for statistics.
+//
+// --[ License ] --------------------------------------------------------------
+//
+//     Permission is hereby granted, free of charge, to any person obtaining a
+//     copy of this software and associated documentation files (the
+//     "Software"), to deal in the Software without restriction, including
+//     without limitation the rights to use, copy, modify, merge, publish,
+//     distribute, sublicense, and/or sell copies of the Software, and to
+//     permit persons to whom the Software is furnished to do so, subject to
+//     the following conditions:
+//
+//     The above copyright notice and this permission notice shall be included
+//     in all copies or substantial portions of the Software.
+//
+//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+//     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+//     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+//     CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+//     TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+//     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+// ----------------------------------------------------------------------------
+// Copyright © 2011-2023 Natalia Portillo
+// ****************************************************************************/
+
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Xml.Serialization;
+
+// ReSharper disable ClassNeverInstantiated.Global
+// ReSharper disable UnusedMember.Global
+
+namespace Aaru.CommonTypes.Metadata
+{
+    /// <summary>Statistics</summary>
+    [XmlRoot("DicStats", Namespace = "", IsNullable = false)]
+    public class Stats
+    {
+        /// <summary>Executed commands</summary>
+        public CommandsStats Commands;
+        /// <summary>Operating systems Aaru has run from</summary>
+        [XmlArrayItem("OperatingSystem")]
+        public List<OsStats> OperatingSystems { get; set; }
+        /// <summary>Aaru versions</summary>
+        [XmlArrayItem("Version")]
+        public List<NameValueStats> Versions { get; set; }
+        /// <summary>Detected filesystems</summary>
+        [XmlArrayItem("Filesystem")]
+        public List<NameValueStats> Filesystems { get; set; }
+        /// <summary>Detected partitioning schemes</summary>
+        [XmlArrayItem("Scheme")]
+        public List<NameValueStats> Partitions { get; set; }
+        /// <summary>Media image formats</summary>
+        [XmlArrayItem("Format")]
+        public List<NameValueStats> MediaImages { get; set; }
+        /// <summary>Used filters</summary>
+        [XmlArrayItem("Filter", IsNullable = true)]
+        public List<NameValueStats> Filters { get; set; }
+        /// <summary>Found devices</summary>
+        [XmlArrayItem("Device", IsNullable = true)]
+        public List<DeviceStats> Devices { get; set; }
+        /// <summary>Found media types, real, and in image</summary>
+        [XmlArrayItem("Media")]
+        public List<MediaStats> Medias { get; set; }
+        /// <summary>Benchmark statistics</summary>
+        public BenchmarkStats Benchmark { get; set; }
+        /// <summary>Media scanning statistics</summary>
+        public MediaScanStats MediaScan { get; set; }
+        /// <summary>Image verification statistics</summary>
+        public VerifyStats Verify { get; set; }
+    }
+
+    /// <summary>DTO for statistics</summary>
+    [SuppressMessage("ReSharper", "CollectionNeverQueried.Global")]
+    public class StatsDto
+    {
+        /// <summary>Executed commands</summary>
+        public List<NameValueStats> Commands { get; set; }
+        /// <summary>Operating systems Aaru has run from</summary>
+        public List<OsStats> OperatingSystems { get; set; }
+        /// <summary>Aaru versions</summary>
+        public List<NameValueStats> Versions { get; set; }
+        /// <summary>Detected filesystems</summary>
+        public List<NameValueStats> Filesystems { get; set; }
+        /// <summary>Detected partitioning schemes</summary>
+        public List<NameValueStats> Partitions { get; set; }
+        /// <summary>Media image formats</summary>
+        public List<NameValueStats> MediaFormats { get; set; }
+        /// <summary>Used filters</summary>
+        public List<NameValueStats> Filters { get; set; }
+        /// <summary>Found devices</summary>
+        public List<DeviceStats> Devices { get; set; }
+        /// <summary>Found media types, real, and in image</summary>
+        public List<MediaStats> Medias { get; set; }
+        /// <summary>Remote applications</summary>
+        public List<OsStats> RemoteApplications { get; set; }
+        /// <summary>Remote application architectures</summary>
+        public List<NameValueStats> RemoteArchitectures { get; set; }
+        /// <summary>Operating systems where a remote application has been running</summary>
+        public List<OsStats> RemoteOperatingSystems { get; set; }
+    }
+
+    /// <summary>Command execution statistics</summary>
+    [SuppressMessage("ReSharper", "UnassignedField.Global")]
+    public class CommandsStats
+    {
+        /// <summary>Number of times the filesystem info command has been used</summary>
+        public long Analyze;
+        /// <summary>Number of times the benchmark command has been used</summary>
+        public long Benchmark;
+        /// <summary>Number of times the image checksum command has been used</summary>
+        public long Checksum;
+        /// <summary>Number of times the image compare command has been used</summary>
+        public long Compare;
+        /// <summary>Number of times the image convert command has been used</summary>
+        public long ConvertImage;
+        /// <summary>Number of times the image create-sidecar command has been used</summary>
+        public long CreateSidecar;
+        /// <summary>Number of times the image decode command has been used</summary>
+        public long Decode;
+        /// <summary>Number of times the device info command has been used</summary>
+        public long DeviceInfo;
+        /// <summary>Number of times the device report command has been used</summary>
+        public long DeviceReport;
+        /// <summary>Number of times the media dump command has been used</summary>
+        public long DumpMedia;
+        /// <summary>Number of times the image entropy command has been used</summary>
+        public long Entropy;
+        /// <summary>Number of times the filesystem extract command has been used</summary>
+        public long ExtractFiles;
+        /// <summary>Number of times the list formats command has been used</summary>
+        public long Formats;
+        /// <summary>Number of times the image info command has been used</summary>
+        public long ImageInfo;
+        /// <summary>Number of times the device list command has been used</summary>
+        public long ListDevices;
+        /// <summary>Number of times the list encodings command has been used</summary>
+        public long ListEncodings;
+        /// <summary>Number of times the filesystem ls command has been used</summary>
+        public long Ls;
+        /// <summary>Number of times the media info command has been used</summary>
+        public long MediaInfo;
+        /// <summary>Number of times the media scan command has been used</summary>
+        public long MediaScan;
+        /// <summary>Number of times the image printhex command has been used</summary>
+        public long PrintHex;
+        /// <summary>Number of times the image verify command has been used</summary>
+        public long Verify;
+    }
+
+    /// <summary>Statistics of verified media</summary>
+    public class VerifiedItems
+    {
+        /// <summary>Number of correct images</summary>
+        public long Correct;
+        /// <summary>Number of failed images</summary>
+        public long Failed;
+    }
+
+    /// <summary>Verification statistics</summary>
+    public class VerifyStats
+    {
+        /// <summary>Image verification statistics</summary>
+        public VerifiedItems MediaImages;
+        /// <summary>Image contents verification statistics</summary>
+        public ScannedSectors Sectors;
+    }
+
+    /// <summary>Image contents verification statistics</summary>
+    public class ScannedSectors
+    {
+        /// <summary>Sectors found to be correct</summary>
+        public long Correct;
+        /// <summary>Sectors found to be incorrect</summary>
+        public long Error;
+        /// <summary>Total number of verified sectors</summary>
+        public long Total;
+        /// <summary>Total number of sectors that could not be verified</summary>
+        public long Unverifiable;
+    }
+
+    /// <summary>Media scanning time statistics</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming")]
+    public class TimeStats
+    {
+        /// <summary>Number of sectors that took more than 3ms but less than 100ms to read</summary>
+        public long LessThan10ms;
+        /// <summary>Number of sectors that took more than 50ms but less than 150ms to read</summary>
+        public long LessThan150ms;
+        /// <summary>Number of sectors that took less than 3ms to read</summary>
+        public long LessThan3ms;
+        /// <summary>Number of sectors that took more than 150ms but less than 500ms to read</summary>
+        public long LessThan500ms;
+        /// <summary>Number of sectors that took more than 10ms but less than 50ms to read</summary>
+        public long LessThan50ms;
+        /// <summary>Number of sectors that took more than 500ms to read</summary>
+        public long MoreThan500ms;
+    }
+
+    /// <summary>Media scanning statistics</summary>
+    public class MediaScanStats
+    {
+        /// <summary>Statistics of scanned sectors</summary>
+        public ScannedSectors Sectors;
+        /// <summary>Scan time statistics</summary>
+        public TimeStats Times;
+    }
+
+    /// <summary>Checksum type statistics</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming")]
+    public class ChecksumStats
+    {
+        /// <summary>Checksum algorithm</summary>
+        [XmlAttribute]
+        public string algorithm;
+        /// <summary>Time taken to execute algorithm</summary>
+        [XmlText]
+        public double Value;
+    }
+
+    /// <summary>Benchmark statistics</summary>
+    public class BenchmarkStats
+    {
+        /// <summary>Total time taken to run the checksum algorithms in parallel</summary>
+        public double All;
+        /// <summary>List of time taken by each checksum algorithm</summary>
+        [XmlElement("Checksum")]
+        public List<ChecksumStats> Checksum;
+        /// <summary>Time taken to benchmark entropy calculation</summary>
+        public double Entropy;
+        /// <summary>Maximum amount of memory used while running the benchmark</summary>
+        public long MaxMemory;
+        /// <summary>Minimum amount of memory used while running the benchmark</summary>
+        public long MinMemory;
+        /// <summary>Total time taken to run the checksum algorithms sequentially</summary>
+        public double Sequential;
+    }
+
+    /// <summary>Media statistics</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming")]
+    public class MediaStats
+    {
+        /// <summary>Found in a real device?</summary>
+        [XmlAttribute]
+        public bool real;
+        /// <summary>Media type</summary>
+        [XmlAttribute]
+        public string type;
+        /// <summary>Number of times it has been found</summary>
+        [XmlText]
+        public long Value;
+    }
+
+    /// <summary>Device statistics</summary>
+    public class DeviceStats
+    {
+        /// <summary>Is manufacturer null?</summary>
+        [XmlIgnore]
+        public bool ManufacturerSpecified;
+        /// <summary>Manufacturer string</summary>
+        public string Manufacturer { get; set; }
+        /// <summary>Model string</summary>
+        public string Model { get; set; }
+        /// <summary>Revision or firmware version</summary>
+        public string Revision { get; set; }
+        /// <summary>Bus the device was attached to</summary>
+        public string Bus { get; set; }
+    }
+
+    /// <summary>Name=value pair statistics</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming")]
+    public class NameValueStats
+    {
+        /// <summary>Name</summary>
+        [XmlAttribute]
+        public string name { get; set; }
+        /// <summary>Number of times it has been used/found</summary>
+        [XmlText]
+        public long Value { get; set; }
+    }
+
+    /// <summary>Operating system statistics</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming")]
+    public class OsStats
+    {
+        /// <summary>Operating system name</summary>
+        [XmlAttribute]
+        public string name { get; set; }
+        /// <summary>Operating system version</summary>
+        [XmlAttribute]
+        public string version { get; set; }
+        /// <summary>Number of times Aaru run on it</summary>
+        [XmlText]
+        public long Value { get; set; }
+    }
+}

Aaru.CommonTypes/Metadata/Version.cs

@@ -0,0 +1,56 @@
+// /***************************************************************************
+// Aaru Data Preservation Suite
+// ----------------------------------------------------------------------------
+//
+// Filename       : Statistics.cs
+// Author(s)      : Natalia Portillo <claunia@claunia.com>
+//
+// Component      : XML metadata.
+//
+// --[ Description ] ----------------------------------------------------------
+//
+//     Returns Aaru version in XML software type format.
+//
+// --[ License ] --------------------------------------------------------------
+//
+//     Permission is hereby granted, free of charge, to any person obtaining a
+//     copy of this software and associated documentation files (the
+//     "Software"), to deal in the Software without restriction, including
+//     without limitation the rights to use, copy, modify, merge, publish,
+//     distribute, sublicense, and/or sell copies of the Software, and to
+//     permit persons to whom the Software is furnished to do so, subject to
+//     the following conditions:
+//
+//     The above copyright notice and this permission notice shall be included
+//     in all copies or substantial portions of the Software.
+//
+//     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+//     OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+//     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+//     IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+//     CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+//     TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+//     SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+// ----------------------------------------------------------------------------
+// Copyright © 2011-2023 Natalia Portillo
+// ****************************************************************************/
+
+using Aaru.CommonTypes.Interop;
+using Schemas;
+
+namespace Aaru.CommonTypes.Metadata
+{
+    /// <summary>Manages Aaru's version for metadata</summary>
+    public static class Version
+    {
+        /// <summary>Gets XML software type for the running version</summary>
+        /// <returns>XML software type</returns>
+        public static SoftwareType GetSoftwareType() => new SoftwareType
+        {
+            Name            = "Aaru",
+            OperatingSystem = DetectOS.GetRealPlatformID().ToString(),
+            Version         = typeof(Version).Assembly.GetName().Version?.ToString()
+        };
+    }
+}