mirror of
https://github.com/aaru-dps/Aaru.git
synced 2025-12-16 19:24:25 +00:00
Natalia Portillo
874c7d92ff
Introduces constant fields for respective debug module names, replacing the hardcoded ones. This is done to standardize the naming convention, reduce redundancy and potentially avoid any typos or name mismatches across the project. This change makes the code more maintainable and easier to update in case module names need to be changed.
119 lines
5.1 KiB
C#
119 lines
5.1 KiB
C#
// /***************************************************************************
|
|
// Aaru Data Preservation Suite
|
|
// ----------------------------------------------------------------------------
|
|
//
|
|
// Filename : MediaScan.cs
|
|
// Author(s) : Natalia Portillo <claunia@claunia.com>
|
|
//
|
|
// Component : Core algorithms.
|
|
//
|
|
// --[ Description ] ----------------------------------------------------------
|
|
//
|
|
// Scans media from devices.
|
|
//
|
|
// --[ License ] --------------------------------------------------------------
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as
|
|
// published by the Free Software Foundation, either version 3 of the
|
|
// License, or (at your option) any later version.
|
|
//
|
|
// This program 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 General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
//
|
|
// ----------------------------------------------------------------------------
|
|
// Copyright © 2011-2023 Natalia Portillo
|
|
// ****************************************************************************/
|
|
|
|
using System;
|
|
using System.Diagnostics;
|
|
using Aaru.CommonTypes;
|
|
using Aaru.CommonTypes.Enums;
|
|
using Aaru.Devices;
|
|
using Humanizer;
|
|
|
|
namespace Aaru.Core.Devices.Scanning;
|
|
|
|
public sealed partial class MediaScan
|
|
{
|
|
readonly Device _dev;
|
|
readonly string _devicePath;
|
|
readonly string _ibgLogPath;
|
|
readonly string _mhddLogPath;
|
|
readonly bool _seekTest;
|
|
readonly bool _useBufferedReads;
|
|
bool _aborted;
|
|
static readonly TimeSpan _oneSecond = 1.Seconds();
|
|
readonly Stopwatch _scanStopwatch;
|
|
readonly Stopwatch _speedStopwatch;
|
|
const string MODULE_NAME = "Media scanning";
|
|
|
|
/// <param name="mhddLogPath">Path to a MHDD log file</param>
|
|
/// <param name="ibgLogPath">Path to a IMGBurn log file</param>
|
|
/// <param name="devicePath">Device path</param>
|
|
/// <param name="dev">Device</param>
|
|
/// <param name="seekTest">Enable seek test</param>
|
|
/// <param name="useBufferedReads">
|
|
/// If MMC/SD does not support CMD23, use OS buffered reads instead of multiple single block
|
|
/// commands
|
|
/// </param>
|
|
public MediaScan(string mhddLogPath, string ibgLogPath, string devicePath, Device dev, bool useBufferedReads,
|
|
bool seekTest = true)
|
|
{
|
|
_mhddLogPath = mhddLogPath;
|
|
_ibgLogPath = ibgLogPath;
|
|
_devicePath = devicePath;
|
|
_dev = dev;
|
|
_aborted = false;
|
|
_seekTest = seekTest;
|
|
_useBufferedReads = useBufferedReads;
|
|
_scanStopwatch = new Stopwatch();
|
|
_speedStopwatch = new Stopwatch();
|
|
}
|
|
|
|
/// <summary>Starts a media scan</summary>
|
|
/// <returns>Media scan results</returns>
|
|
/// <exception cref="NotSupportedException">Unknown device type</exception>
|
|
public ScanResults Scan()
|
|
{
|
|
switch(_dev.Type)
|
|
{
|
|
case DeviceType.ATA: return Ata();
|
|
case DeviceType.MMC:
|
|
case DeviceType.SecureDigital: return SecureDigital();
|
|
case DeviceType.NVMe: return Nvme();
|
|
case DeviceType.ATAPI:
|
|
case DeviceType.SCSI: return Scsi();
|
|
default: throw new NotSupportedException(Localization.Core.Unknown_device_type);
|
|
}
|
|
}
|
|
|
|
/// <summary>Aborts the running media scan</summary>
|
|
public void Abort() => _aborted = true;
|
|
|
|
/// <summary>Event raised when the progress bar is not longer needed</summary>
|
|
public event EndProgressHandler EndProgress;
|
|
/// <summary>Event raised when a progress bar is needed</summary>
|
|
public event InitProgressHandler InitProgress;
|
|
/// <summary>Event raised to report status updates</summary>
|
|
public event UpdateStatusHandler UpdateStatus;
|
|
/// <summary>Event raised to report a fatal error that stops the dumping operation and should call user's attention</summary>
|
|
public event ErrorMessageHandler StoppingErrorMessage;
|
|
/// <summary>Event raised to update the values of a determinate progress bar</summary>
|
|
public event UpdateProgressHandler UpdateProgress;
|
|
/// <summary>Event raised to update the status of an indeterminate progress bar</summary>
|
|
public event PulseProgressHandler PulseProgress;
|
|
/// <summary>Updates lists of time taken on scanning from the specified sector</summary>
|
|
public event ScanTimeHandler ScanTime;
|
|
/// <summary>Specified a number of blocks could not be read on scan</summary>
|
|
public event ScanUnreadableHandler ScanUnreadable;
|
|
/// <summary>Initializes a block map that's going to be filled with a media scan</summary>
|
|
public event InitBlockMapHandler InitBlockMap;
|
|
/// <summary>Sends the speed of scanning a specific sector</summary>
|
|
public event ScanSpeedHandler ScanSpeed;
|
|
} |