Aaru/DiscImageChef/Commands/Verify.cs

// /***************************************************************************
// The Disc Image Chef
// ----------------------------------------------------------------------------
//
// Filename       : Verify.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Verbs.
//
// --[ Description ] ----------------------------------------------------------
//
//     Implements the 'verify' verb.
//
// --[ 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-2019 Natalia Portillo
// ****************************************************************************/

using System;
using System.Collections.Generic;
using DiscImageChef.CommonTypes;
using DiscImageChef.CommonTypes.Enums;
using DiscImageChef.CommonTypes.Interfaces;
using DiscImageChef.CommonTypes.Structs;
using DiscImageChef.Console;
using DiscImageChef.Core;
using Mono.Options;

namespace DiscImageChef.Commands
{
    class VerifyCommand : Command
    {
        string inputFile;
        bool   showHelp;
        bool   verifyDisc    = true;
        bool   verifySectors = true;

        public VerifyCommand() : base("verify", "Verifies a disc image integrity, and if supported, sector integrity.")
        {
            Options = new OptionSet
            {
                $"{MainClass.AssemblyTitle} {MainClass.AssemblyVersion?.InformationalVersion}",
                $"{MainClass.AssemblyCopyright}",
                "",
                $"usage: DiscImageChef {Name} [OPTIONS] imagefile",
                "",
                Help,
                {"verify-disc|w", "Verify disc image if supported.", b => verifyDisc        = b != null},
                {"verify-sectors|s", "Verify all sectors if supported.", b => verifySectors = b != null},
                {"help|h|?", "Show this message and exit.", v => showHelp                   = v != null}
            };
        }

        public override int Invoke(IEnumerable<string> arguments)
        {
            List<string> extra = Options.Parse(arguments);

            if(showHelp)
            {
                Options.WriteOptionDescriptions(CommandSet.Out);
                return (int)ErrorNumber.HelpRequested;
            }

            MainClass.PrintCopyright();
            if(MainClass.Debug) DicConsole.DebugWriteLineEvent     += System.Console.Error.WriteLine;
            if(MainClass.Verbose) DicConsole.VerboseWriteLineEvent += System.Console.WriteLine;

            if(extra.Count > 1)
            {
                DicConsole.ErrorWriteLine("Too many arguments.");
                return (int)ErrorNumber.UnexpectedArgumentCount;
            }

            if(extra.Count == 0)
            {
                DicConsole.ErrorWriteLine("Missing input image.");
                return (int)ErrorNumber.MissingArgument;
            }

            inputFile = extra[0];

            DicConsole.DebugWriteLine("Verify command", "--debug={0}",          MainClass.Debug);
            DicConsole.DebugWriteLine("Verify command", "--input={0}",          inputFile);
            DicConsole.DebugWriteLine("Verify command", "--verbose={0}",        MainClass.Verbose);
            DicConsole.DebugWriteLine("Verify command", "--verify-disc={0}",    verifyDisc);
            DicConsole.DebugWriteLine("Verify command", "--verify-sectors={0}", verifySectors);

            FiltersList filtersList = new FiltersList();
            IFilter     inputFilter = filtersList.GetFilter(inputFile);

            if(inputFilter == null)
            {
                DicConsole.ErrorWriteLine("Cannot open specified file.");
                return (int)ErrorNumber.CannotOpenFile;
            }

            IMediaImage inputFormat = ImageFormat.Detect(inputFilter);

            if(inputFormat == null)
            {
                DicConsole.ErrorWriteLine("Unable to recognize image format, not verifying");
                return (int)ErrorNumber.FormatNotFound;
            }

            inputFormat.Open(inputFilter);
            Statistics.AddMediaFormat(inputFormat.Format);
            Statistics.AddMedia(inputFormat.Info.MediaType, false);
            Statistics.AddFilter(inputFilter.Name);

            bool? correctImage   = null;
            long  totalSectors   = 0;
            long  errorSectors   = 0;
            bool? correctSectors = null;
            long  unknownSectors = 0;

            if(verifyDisc)
            {
                DateTime startCheck      = DateTime.UtcNow;
                bool?    discCheckStatus = inputFormat.VerifyMediaImage();
                DateTime endCheck        = DateTime.UtcNow;

                TimeSpan checkTime = endCheck - startCheck;

                switch(discCheckStatus)
                {
                    case true:
                        DicConsole.WriteLine("Disc image checksums are correct");
                        break;
                    case false:
                        DicConsole.WriteLine("Disc image checksums are incorrect");
                        break;
                    case null:
                        DicConsole.WriteLine("Disc image does not contain checksums");
                        break;
                }

                correctImage = discCheckStatus;
                DicConsole.VerboseWriteLine("Checking disc image checksums took {0} seconds", checkTime.TotalSeconds);
            }

            if(verifySectors)
            {
                bool formatHasTracks;
                try
                {
                    List<Track> inputTracks = inputFormat.Tracks;
                    formatHasTracks = inputTracks.Count > 0;
                }
                catch { formatHasTracks = false; }

                DateTime    startCheck;
                DateTime    endCheck;
                List<ulong> failingLbas = new List<ulong>();
                List<ulong> unknownLbas = new List<ulong>();

                if(formatHasTracks)
                {
                    List<Track> inputTracks      = inputFormat.Tracks;
                    ulong       currentSectorAll = 0;

                    startCheck = DateTime.UtcNow;
                    foreach(Track currentTrack in inputTracks)
                    {
                        ulong remainingSectors = currentTrack.TrackEndSector - currentTrack.TrackStartSector;
                        ulong currentSector    = 0;

                        while(remainingSectors > 0)
                        {
                            DicConsole.Write("\rChecking sector {0} of {1}, on track {2}", currentSectorAll,
                                             inputFormat.Info.Sectors, currentTrack.TrackSequence);

                            List<ulong> tempfailingLbas;
                            List<ulong> tempunknownLbas;

                            if(remainingSectors < 512)
                                inputFormat.VerifySectors(currentSector, (uint)remainingSectors,
                                                          currentTrack.TrackSequence, out tempfailingLbas,
                                                          out tempunknownLbas);
                            else
                                inputFormat.VerifySectors(currentSector, 512, currentTrack.TrackSequence,
                                                          out tempfailingLbas, out tempunknownLbas);

                            failingLbas.AddRange(tempfailingLbas);

                            unknownLbas.AddRange(tempunknownLbas);

                            if(remainingSectors < 512)
                            {
                                currentSector    += remainingSectors;
                                currentSectorAll += remainingSectors;
                                remainingSectors =  0;
                            }
                            else
                            {
                                currentSector    += 512;
                                currentSectorAll += 512;
                                remainingSectors -= 512;
                            }
                        }
                    }

                    endCheck = DateTime.UtcNow;
                }
                else
                {
                    ulong remainingSectors = inputFormat.Info.Sectors;
                    ulong currentSector    = 0;

                    startCheck = DateTime.UtcNow;
                    while(remainingSectors > 0)
                    {
                        DicConsole.Write("\rChecking sector {0} of {1}", currentSector, inputFormat.Info.Sectors);

                        List<ulong> tempfailingLbas;
                        List<ulong> tempunknownLbas;

                        if(remainingSectors < 512)
                            inputFormat.VerifySectors(currentSector, (uint)remainingSectors, out tempfailingLbas,
                                                      out tempunknownLbas);
                        else inputFormat.VerifySectors(currentSector, 512, out tempfailingLbas, out tempunknownLbas);

                        failingLbas.AddRange(tempfailingLbas);

                        unknownLbas.AddRange(tempunknownLbas);

                        if(remainingSectors < 512)
                        {
                            currentSector    += remainingSectors;
                            remainingSectors =  0;
                        }
                        else
                        {
                            currentSector    += 512;
                            remainingSectors -= 512;
                        }
                    }

                    endCheck = DateTime.UtcNow;
                }

                TimeSpan checkTime = endCheck - startCheck;

                DicConsole.Write("\r" + new string(' ', System.Console.WindowWidth - 1) + "\r");

                if(unknownSectors > 0)
                    DicConsole.WriteLine("There is at least one sector that does not contain a checksum");
                if(errorSectors > 0)
                    DicConsole.WriteLine("There is at least one sector with incorrect checksum or errors");
                if(unknownSectors == 0 && errorSectors == 0) DicConsole.WriteLine("All sector checksums are correct");

                DicConsole.VerboseWriteLine("Checking sector checksums took {0} seconds", checkTime.TotalSeconds);

                if(MainClass.Verbose)
                {
                    DicConsole.VerboseWriteLine("LBAs with error:");
                    if(failingLbas.Count == (int)inputFormat.Info.Sectors)
                        DicConsole.VerboseWriteLine("\tall sectors.");
                    else
                        foreach(ulong t in failingLbas)
                            DicConsole.VerboseWriteLine("\t{0}", t);

                    DicConsole.WriteLine("LBAs without checksum:");
                    if(unknownLbas.Count == (int)inputFormat.Info.Sectors)
                        DicConsole.VerboseWriteLine("\tall sectors.");
                    else
                        foreach(ulong t in unknownLbas)
                            DicConsole.VerboseWriteLine("\t{0}", t);
                }

                DicConsole.WriteLine("Total sectors........... {0}", inputFormat.Info.Sectors);
                DicConsole.WriteLine("Total errors............ {0}", failingLbas.Count);
                DicConsole.WriteLine("Total unknowns.......... {0}", unknownLbas.Count);
                DicConsole.WriteLine("Total errors+unknowns... {0}", failingLbas.Count + unknownLbas.Count);

                totalSectors   = (long)inputFormat.Info.Sectors;
                errorSectors   = failingLbas.Count;
                unknownSectors = unknownLbas.Count;
                if(failingLbas.Count             > 0) correctSectors                        = false;
                else if((ulong)unknownLbas.Count < inputFormat.Info.Sectors) correctSectors = true;
            }

            Statistics.AddCommand("verify");

            switch(correctImage)
            {
                case null when correctSectors is null:   return (int)ErrorNumber.NotVerificable;
                case null when correctSectors == false:  return (int)ErrorNumber.BadSectorsImageNotVerified;
                case null when correctSectors == true:   return (int)ErrorNumber.CorrectSectorsImageNotVerified;
                case false when correctSectors is null:  return (int)ErrorNumber.BadImageSectorsNotVerified;
                case false when correctSectors == false: return (int)ErrorNumber.BadImageBadSectors;
                case false when correctSectors == true:  return (int)ErrorNumber.CorrectSectorsBadImage;
                case true when correctSectors is null:   return (int)ErrorNumber.CorrectImageSectorsNotVerified;
                case true when correctSectors == false:  return (int)ErrorNumber.CorrectImageBadSectors;
                case true when correctSectors == true:   return (int)ErrorNumber.NoError;
            }

            return (int)ErrorNumber.NoError;
        }
    }
}