Extract out DatFiles + Reporting namespace

SabreTools.DatFiles/DatFiles/Reports/BaseReport.cs

@@ -0,0 +1,200 @@
+using System;
+using System.IO;
+
+using SabreTools.Core;
+using SabreTools.DatFiles;
+
+namespace SabreTools.DatFiles.Reports
+{
+    /// <summary>
+    /// Base class for a report output format
+    /// </summary>
+    /// TODO: Can this be overhauled to have all types write like DatFiles?
+    public abstract class BaseReport
+    {
+        protected string _name;
+        protected long _machineCount;
+        protected ItemDictionary _stats;
+
+        protected StreamWriter _writer;
+        protected bool _baddumpCol;
+        protected bool _nodumpCol;
+
+        /// <summary>
+        /// Create a new report from the filename
+        /// </summary>
+        /// <param name="filename">Name of the file to write out to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public BaseReport(string filename, bool baddumpCol = false, bool nodumpCol = false)
+        {
+            var fs = File.Create(filename);
+            if (fs != null)
+                _writer = new StreamWriter(fs);
+
+            _baddumpCol = baddumpCol;
+            _nodumpCol = nodumpCol;
+        }
+
+        /// <summary>
+        /// Create a new report from the stream
+        /// </summary>
+        /// <param name="stream">Output stream to write to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public BaseReport(Stream stream, bool baddumpCol = false, bool nodumpCol = false)
+        {
+            if (!stream.CanWrite)
+                throw new ArgumentException(nameof(stream));
+
+            _writer = new StreamWriter(stream);
+            _baddumpCol = baddumpCol;
+            _nodumpCol = nodumpCol;
+        }
+
+        /// <summary>
+        /// Create a specific type of BaseReport to be used based on a format and user inputs
+        /// </summary>
+        /// <param name="statReportFormat">Format of the Statistics Report to be created</param>
+        /// <param name="filename">Name of the file to write out to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        /// <returns>BaseReport of the specific internal type that corresponds to the inputs</returns>
+        public static BaseReport Create(StatReportFormat statReportFormat, string filename, bool baddumpCol, bool nodumpCol)
+        {
+#if NET_FRAMEWORK
+            switch (statReportFormat)
+            {
+                case StatReportFormat.None:
+                    return new Textfile(Console.OpenStandardOutput(), baddumpCol, nodumpCol);
+
+                case StatReportFormat.Textfile:
+                    return new Textfile(filename, baddumpCol, nodumpCol);
+
+                case StatReportFormat.CSV:
+                    return new SeparatedValue(filename, ',', baddumpCol, nodumpCol);
+
+                case StatReportFormat.HTML:
+                    return new Html(filename, baddumpCol, nodumpCol);
+
+                case StatReportFormat.SSV:
+                    return new SeparatedValue(filename, ';', baddumpCol, nodumpCol);
+
+                case StatReportFormat.TSV:
+                    return new SeparatedValue(filename, '\t', baddumpCol, nodumpCol);
+
+                default:
+                    return null;
+            }
+#else
+            return statReportFormat switch
+            {
+                StatReportFormat.None => new Textfile(Console.OpenStandardOutput(), baddumpCol, nodumpCol),
+                StatReportFormat.Textfile => new Textfile(filename, baddumpCol, nodumpCol),
+                StatReportFormat.CSV => new SeparatedValue(filename, ',', baddumpCol, nodumpCol),
+                StatReportFormat.HTML => new Html(filename, baddumpCol, nodumpCol),
+                StatReportFormat.SSV => new SeparatedValue(filename, ';', baddumpCol, nodumpCol),
+                StatReportFormat.TSV => new SeparatedValue(filename, '\t', baddumpCol, nodumpCol),
+                _ => null,
+            };
+#endif
+        }
+
+        /// <summary>
+        /// Replace the statistics that is being output
+        /// </summary>
+        public void ReplaceStatistics(string datName, long machineCount, ItemDictionary datStats)
+        {
+            _name = datName;
+            _machineCount = machineCount;
+            _stats = datStats;
+        }
+
+        /// <summary>
+        /// Write the report to the output stream
+        /// </summary>
+        public abstract void Write();
+
+        /// <summary>
+        /// Write out the header to the stream, if any exists
+        /// </summary>
+        public abstract void WriteHeader();
+
+        /// <summary>
+        /// Write out the mid-header to the stream, if any exists
+        /// </summary>
+        public abstract void WriteMidHeader();
+
+        /// <summary>
+        /// Write out the separator to the stream, if any exists
+        /// </summary>
+        public abstract void WriteMidSeparator();
+
+        /// <summary>
+        /// Write out the footer-separator to the stream, if any exists
+        /// </summary>
+        public abstract void WriteFooterSeparator();
+
+        /// <summary>
+        /// Write out the footer to the stream, if any exists
+        /// </summary>
+        public abstract void WriteFooter();
+    
+        /// <summary>
+        /// Returns the human-readable file size for an arbitrary, 64-bit file size 
+        /// The default format is "0.### XB", e.g. "4.2 KB" or "1.434 GB"
+        /// </summary>
+        /// <param name="input"></param>
+        /// <returns>Human-readable file size</returns>
+        /// <link>http://www.somacon.com/p576.php</link>
+        protected static string GetBytesReadable(long input)
+        {
+            // Get absolute value
+            long absolute_i = (input < 0 ? -input : input);
+
+            // Determine the suffix and readable value
+            string suffix;
+            double readable;
+            if (absolute_i >= 0x1000000000000000) // Exabyte
+            {
+                suffix = "EB";
+                readable = (input >> 50);
+            }
+            else if (absolute_i >= 0x4000000000000) // Petabyte
+            {
+                suffix = "PB";
+                readable = (input >> 40);
+            }
+            else if (absolute_i >= 0x10000000000) // Terabyte
+            {
+                suffix = "TB";
+                readable = (input >> 30);
+            }
+            else if (absolute_i >= 0x40000000) // Gigabyte
+            {
+                suffix = "GB";
+                readable = (input >> 20);
+            }
+            else if (absolute_i >= 0x100000) // Megabyte
+            {
+                suffix = "MB";
+                readable = (input >> 10);
+            }
+            else if (absolute_i >= 0x400) // Kilobyte
+            {
+                suffix = "KB";
+                readable = input;
+            }
+            else
+            {
+                return input.ToString("0 B"); // Byte
+            }
+
+            // Divide by 1024 to get fractional value
+            readable /= 1024;
+
+            // Return formatted number with suffix
+            return readable.ToString("0.### ") + suffix;
+        }
+    }
+}

SabreTools.DatFiles/DatFiles/Reports/Html.cs

@@ -0,0 +1,148 @@
+using System;
+using System.IO;
+using System.Net;
+
+namespace SabreTools.DatFiles.Reports
+{
+    /// <summary>
+    /// HTML report format
+    /// </summary>
+    /// TODO: Make output standard width, without making the entire thing a table
+    internal class Html : BaseReport
+    {
+        /// <summary>
+        /// Create a new report from the filename
+        /// </summary>
+        /// <param name="filename">Name of the file to write out to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public Html(string filename, bool baddumpCol = false, bool nodumpCol = false)
+            : base(filename, baddumpCol, nodumpCol)
+        {
+        }
+
+        /// <summary>
+        /// Create a new report from the stream
+        /// </summary>
+        /// <param name="datfile">DatFile to write out statistics for</param>
+        /// <param name="stream">Output stream to write to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public Html(Stream stream, bool baddumpCol = false, bool nodumpCol = false)
+            : base(stream, baddumpCol, nodumpCol)
+        {
+        }
+
+        /// <summary>
+        /// Write the report to file
+        /// </summary>
+        public override void Write()
+        {
+            string line = "\t\t\t<tr" + (_name.StartsWith("DIR: ")
+                            ? $" class=\"dir\"><td>{WebUtility.HtmlEncode(_name.Remove(0, 5))}"
+                            : $"><td>{WebUtility.HtmlEncode(_name)}") + "</td>"
+                        + $"<td align=\"right\">{GetBytesReadable(_stats.TotalSize)}</td>"
+                        + $"<td align=\"right\">{_machineCount}</td>"
+                        + $"<td align=\"right\">{_stats.RomCount}</td>"
+                        + $"<td align=\"right\">{_stats.DiskCount}</td>"
+                        + $"<td align=\"right\">{_stats.CRCCount}</td>"
+                        + $"<td align=\"right\">{_stats.MD5Count}</td>"
+#if NET_FRAMEWORK
+                        + $"<td align=\"right\">{_stats.RIPEMD160Count}</td>"
+#endif
+                        + $"<td align=\"right\">{_stats.SHA1Count}</td>"
+                        + $"<td align=\"right\">{_stats.SHA256Count}</td>"
+                        + (_baddumpCol ? $"<td align=\"right\">{_stats.BaddumpCount}</td>" : string.Empty)
+                        + (_nodumpCol ? $"<td align=\"right\">{_stats.NodumpCount}</td>" : string.Empty)
+                        + "</tr>\n";
+            _writer.Write(line);
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the header to the stream, if any exists
+        /// </summary>
+        public override void WriteHeader()
+        {
+            _writer.Write(@"<!DOCTYPE html>
+<html>
+    <header>
+        <title>DAT Statistics Report</title>
+        <style>
+            body {
+                background-color: lightgray;
+            }
+            .dir {
+                color: #0088FF;
+            }
+            .right {
+                align: right;
+            }
+        </style>
+    </header>
+    <body>
+        <h2>DAT Statistics Report (" + DateTime.Now.ToShortDateString() + @")</h2>
+        <table border=string.Empty1string.Empty cellpadding=string.Empty5string.Empty cellspacing=string.Empty0string.Empty>
+");
+            _writer.Flush();
+
+            // Now write the mid header for those who need it
+            WriteMidHeader();
+        }
+
+        /// <summary>
+        /// Write out the mid-header to the stream, if any exists
+        /// </summary>
+        public override void WriteMidHeader()
+        {
+            _writer.Write(@"			<tr bgcolor=string.Emptygraystring.Empty><th>File Name</th><th align=string.Emptyrightstring.Empty>Total Size</th><th align=string.Emptyrightstring.Empty>Games</th><th align=string.Emptyrightstring.Empty>Roms</th>"
++ @"<th align=string.Emptyrightstring.Empty>Disks</th><th align=string.Emptyrightstring.Empty>&#35; with CRC</th><th align=string.Emptyrightstring.Empty>&#35; with MD5</th><th align=string.Emptyrightstring.Empty>&#35; with SHA-1</th><th align=string.Emptyrightstring.Empty>&#35; with SHA-256</th>"
++ (_baddumpCol ? "<th class=\".right\">Baddumps</th>" : string.Empty) + (_nodumpCol ? "<th class=\".right\">Nodumps</th>" : string.Empty) + "</tr>\n");
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the separator to the stream, if any exists
+        /// </summary>
+        public override void WriteMidSeparator()
+        {
+            _writer.Write("<tr><td colspan=\""
+                        + (_baddumpCol && _nodumpCol
+                            ? "12"
+                            : (_baddumpCol ^ _nodumpCol
+                                ? "11"
+                                : "10")
+                            )
+                        + "\"></td></tr>\n");
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the footer-separator to the stream, if any exists
+        /// </summary>
+        public override void WriteFooterSeparator()
+        {
+            _writer.Write("<tr border=\"0\"><td colspan=\""
+                        + (_baddumpCol && _nodumpCol
+                            ? "12"
+                            : (_baddumpCol ^ _nodumpCol
+                                ? "11"
+                                : "10")
+                            )
+                        + "\"></td></tr>\n");
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the footer to the stream, if any exists
+        /// </summary>
+        public override void WriteFooter()
+        {
+            _writer.Write(@"		</table>
+    </body>
+</html>
+");
+            _writer.Flush();
+        }
+    }
+}

SabreTools.DatFiles/DatFiles/Reports/SeparatedValue.cs

@@ -0,0 +1,108 @@
+using System.IO;
+
+namespace SabreTools.DatFiles.Reports
+{
+    /// <summary>
+    /// Separated-Value report format
+    /// </summary>
+    internal class SeparatedValue : BaseReport
+    {
+        private readonly char _separator;
+
+        /// <summary>
+        /// Create a new report from the filename
+        /// </summary>
+        /// <param name="filename">Name of the file to write out to</param>
+        /// <param name="separator">Separator character to use in output</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public SeparatedValue(string filename, char separator, bool baddumpCol = false, bool nodumpCol = false)
+            : base(filename, baddumpCol, nodumpCol)
+        {
+            _separator = separator;
+        }
+
+        /// <summary>
+        /// Create a new report from the input DatFile and the stream
+        /// </summary>
+        /// <param name="stream">Output stream to write to</param>
+        /// <param name="separator">Separator character to use in output</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public SeparatedValue(Stream stream, char separator, bool baddumpCol = false, bool nodumpCol = false)
+            : base(stream, baddumpCol, nodumpCol)
+        {
+            _separator = separator;
+        }
+
+        /// <summary>
+        /// Write the report to file
+        /// </summary>
+        public override void Write()
+        {
+            string line = string.Format("\"" + _name + "\"{0}"
+                    + "\"" + _stats.TotalSize + "\"{0}"
+                    + "\"" + _machineCount + "\"{0}"
+                    + "\"" + _stats.RomCount + "\"{0}"
+                    + "\"" + _stats.DiskCount + "\"{0}"
+                    + "\"" + _stats.CRCCount + "\"{0}"
+                    + "\"" + _stats.MD5Count + "\"{0}"
+#if NET_FRAMEWORK
+                    + "\"" + _stats.RIPEMD160Count + "\"{0}"
+#endif
+                    + "\"" + _stats.SHA1Count + "\"{0}"
+                    + "\"" + _stats.SHA256Count + "\"{0}"
+                    + "\"" + _stats.SHA384Count + "\"{0}"
+                    + "\"" + _stats.SHA512Count + "\""
+                    + (_baddumpCol ? "{0}\"" + _stats.BaddumpCount + "\"" : string.Empty)
+                    + (_nodumpCol ? "{0}\"" + _stats.NodumpCount + "\"" : string.Empty)
+                    + "\n", _separator);
+
+            _writer.Write(line);
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the header to the stream, if any exists
+        /// </summary>
+        public override void WriteHeader()
+        {
+            _writer.Write(string.Format("\"File Name\"{0}\"Total Size\"{0}\"Games\"{0}\"Roms\"{0}\"Disks\"{0}\"# with CRC\"{0}\"# with MD5\"{0}\"# with SHA-1\"{0}\"# with SHA-256\""
+                + (_baddumpCol ? "{0}\"BadDumps\"" : string.Empty) + (_nodumpCol ? "{0}\"Nodumps\"" : string.Empty) + "\n", _separator));
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the mid-header to the stream, if any exists
+        /// </summary>
+        public override void WriteMidHeader()
+        {
+            // This call is a no-op for separated value formats
+        }
+
+        /// <summary>
+        /// Write out the separator to the stream, if any exists
+        /// </summary>
+        public override void WriteMidSeparator()
+        {
+            // This call is a no-op for separated value formats
+        }
+
+        /// <summary>
+        /// Write out the footer-separator to the stream, if any exists
+        /// </summary>
+        public override void WriteFooterSeparator()
+        {
+            _writer.Write("\n");
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the footer to the stream, if any exists
+        /// </summary>
+        public override void WriteFooter()
+        {
+            // This call is a no-op for separated value formats
+        }
+    }
+}

SabreTools.DatFiles/DatFiles/Reports/Textfile.cs

@@ -0,0 +1,109 @@
+using System.IO;
+
+namespace SabreTools.DatFiles.Reports
+{
+    /// <summary>
+    /// Textfile report format
+    /// </summary>
+    internal class Textfile : BaseReport
+    {
+        /// <summary>
+        /// Create a new report from the filename
+        /// </summary>
+        /// <param name="filename">Name of the file to write out to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public Textfile(string filename, bool baddumpCol = false, bool nodumpCol = false)
+            : base(filename, baddumpCol, nodumpCol)
+        {
+        }
+
+        /// <summary>
+        /// Create a new report from the stream
+        /// </summary>
+        /// <param name="stream">Output stream to write to</param>
+        /// <param name="baddumpCol">True if baddumps should be included in output, false otherwise</param>
+        /// <param name="nodumpCol">True if nodumps should be included in output, false otherwise</param>
+        public Textfile(Stream stream, bool baddumpCol = false, bool nodumpCol = false)
+            : base(stream, baddumpCol, nodumpCol)
+        {
+        }
+
+        /// <summary>
+        /// Write the report to file
+        /// </summary>
+        public override void Write()
+        {
+            string line = @"'" + _name + @"':
+--------------------------------------------------
+    Uncompressed size:       " + GetBytesReadable(_stats.TotalSize) + @"
+    Games found:             " + _machineCount + @"
+    Roms found:              " + _stats.RomCount + @"
+    Disks found:             " + _stats.DiskCount + @"
+    Roms with CRC:           " + _stats.CRCCount + @"
+    Roms with MD5:           " + _stats.MD5Count
+#if NET_FRAMEWORK
++ @"
+    Roms with RIPEMD160:     " + _stats.RIPEMD160Count
+#endif
++ @"
+    Roms with SHA-1:         " + _stats.SHA1Count + @"
+    Roms with SHA-256:       " + _stats.SHA256Count + @"
+    Roms with SHA-384:       " + _stats.SHA384Count + @"
+    Roms with SHA-512:       " + _stats.SHA512Count + "\n";
+
+            if (_baddumpCol)
+                line += "	Roms with BadDump status: " + _stats.BaddumpCount + "\n";
+
+            if (_nodumpCol)
+                line += "	Roms with Nodump status: " + _stats.NodumpCount + "\n";
+
+            // For spacing between DATs
+            line += "\n\n";
+
+            _writer.Write(line);
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the header to the stream, if any exists
+        /// </summary>
+        public override void WriteHeader()
+        {
+            // This call is a no-op for textfile output
+        }
+
+        /// <summary>
+        /// Write out the mid-header to the stream, if any exists
+        /// </summary>
+        public override void WriteMidHeader()
+        {
+            // This call is a no-op for textfile output
+        }
+
+        /// <summary>
+        /// Write out the separator to the stream, if any exists
+        /// </summary>
+        public override void WriteMidSeparator()
+        {
+            // This call is a no-op for textfile output
+        }
+
+        /// <summary>
+        /// Write out the footer-separator to the stream, if any exists
+        /// </summary>
+        public override void WriteFooterSeparator()
+        {
+            _writer.Write("\n");
+            _writer.Flush();
+        }
+
+        /// <summary>
+        /// Write out the footer to the stream, if any exists
+        /// </summary>
+        public override void WriteFooter()
+        {
+            // This call is a no-op for textfile output
+        }
+    }
+}