Fixed #68: Added new report type (MHTML)

README.md

@@ -7,7 +7,7 @@ ReportGenerator supports merging several reports into one.
 It is also possible to pass one XML file containing several reports to ReportGenerator (e.g. a build log file).
 
 The following output formats are supported by ReportGenerator:
-* HTML, HTMLSummary, HTMLChart
+* HTML, HTMLSummary, HTMLChart, [MHTML](https://en.wikipedia.org/wiki/MHTML)
 * XML, XMLSummary
 * Latex, LatexSummary
 * TextSummary

Readme.txt

@@ -24,7 +24,7 @@ ReportGenerator (e.g. a build log file).
 
 The following output formats are supported by ReportGenerator:
 
--HTML, HTMLSummary, HTMLChart
+-HTML, HTMLSummary, HTMLChart, MHTML
 -XML, XMLSummary
 -Latex, LatexSummary
 -TextSummary
@@ -65,6 +65,7 @@ CHANGELOG
     * New: Issue #57: Added support for OpenCover's 'Crap Score' and 'NPath 
            complexity' metric
     * New: Issue #61: Added support for Cobertura
+    * New: Issue #68: Added new report type (MHTML)
     * New: Issue #63: Visual indicator for partially covered lines
            (OpenCover, CodeCoverage.exe, Cobertura)
     * Fix: Issue #62: Improved HTML report (Keeping state of summary report,

ReportGenerator.Reporting/MhtmlReportBuilder.cs

@@ -0,0 +1,166 @@
+using System.Collections.Generic;
+using System.IO;
+using Palmmedia.ReportGenerator.Parser.Analysis;
+
+namespace Palmmedia.ReportGenerator.Reporting
+{
+    /// <summary>
+    /// Creates MHTML which is a container for the complete HTML report.
+    /// </summary>
+    [System.ComponentModel.Composition.Export(typeof(IReportBuilder))]
+    public class MhtmlReportBuilder : IReportBuilder
+    {
+        /// <summary>
+        /// The <see cref="HtmlReportBuilder"/>.
+        /// </summary>
+        private readonly IReportBuilder htmlReportBuilder = new HtmlReportBuilder();
+
+        /// <summary>
+        /// The target directory.
+        /// </summary>
+        private string targetDirectory;
+
+        /// <summary>
+        /// The temporary HTML report target directory.
+        /// </summary>
+        private string htmlReportTargetDirectory;
+
+        /// <summary>
+        /// Gets the report type.
+        /// </summary>
+        /// <value>
+        /// The report type.
+        /// </value>
+        public string ReportType => "MHtml";
+
+        /// <summary>
+        /// Gets or sets the target directory where reports are stored.
+        /// </summary>
+        /// <value>
+        /// The target directory.
+        /// </value>
+        public string TargetDirectory
+        {
+            get
+            {
+                return this.targetDirectory;
+            }
+
+            set
+            {
+                this.targetDirectory = value;
+                this.htmlReportTargetDirectory = Path.Combine(value, "tmphtml");
+
+                this.htmlReportBuilder.TargetDirectory = this.htmlReportTargetDirectory;
+            }
+        }
+
+        /// <summary>
+        /// Creates a class report.
+        /// </summary>
+        /// <param name="class">The class.</param>
+        /// <param name="fileAnalyses">The file analyses that correspond to the class.</param>
+        public void CreateClassReport(Class @class, IEnumerable<FileAnalysis> fileAnalyses)
+        {
+            if (!Directory.Exists(this.htmlReportTargetDirectory))
+            {
+                Directory.CreateDirectory(this.htmlReportTargetDirectory);
+            }
+
+            this.htmlReportBuilder.CreateClassReport(@class, fileAnalyses);
+        }
+
+        /// <summary>
+        /// Creates the summary report.
+        /// </summary>
+        /// <param name="summaryResult">The summary result.</param>
+        public void CreateSummaryReport(SummaryResult summaryResult)
+        {
+            this.htmlReportBuilder.CreateSummaryReport(summaryResult);
+
+            this.CreateMhtmlFile();
+
+            Directory.Delete(this.htmlReportTargetDirectory, true);
+        }
+
+        /// <summary>
+        /// Writes a file to the given StreamWriter.
+        /// </summary>
+        /// <param name="writer">The writer.</param>
+        /// <param name="filePath">The file path.</param>
+        /// <param name="contentType">Type of the content.</param>
+        /// <param name="content">The content.</param>
+        private static void WriteFile(StreamWriter writer, string filePath, string contentType, string content)
+        {
+            writer.WriteLine("------=_NextPart_000_0000_01D23618.54EBCBE0");
+            writer.Write("Content-Type: ");
+            writer.Write(contentType);
+            writer.WriteLine(";");
+            writer.WriteLine("\tcharset=\"utf-8\"");
+            writer.WriteLine("Content-Transfer-Encoding: 8bit");
+            writer.Write("Content-Location: file:///");
+            writer.WriteLine(filePath);
+            writer.WriteLine();
+            writer.WriteLine(content);
+            writer.WriteLine();
+        }
+
+        /// <summary>
+        /// Adds the 'file:///' prefix for CSS and java script links.
+        /// </summary>
+        /// <param name="content">The content.</param>
+        /// <returns>The processed content.</returns>
+        private static string AddFilePrefixForCssAndJavaScript(string content)
+        {
+            content = content.Replace("<link rel=\"stylesheet\" type=\"text/css\" href=\"report.css\" />", "<link rel=\"stylesheet\" type=\"text/css\" href=\"file:///report.css\" />");
+            content = content.Replace("<script type=\"text/javascript\" src=\"combined.js\"></script>", "<script type=\"text/javascript\" src=\"file:///combined.js\"></script>");
+
+            return content;
+        }
+
+        /// <summary>
+        /// Creates the MHTML file.
+        /// </summary>
+        private void CreateMhtmlFile()
+        {
+            using (var writer = new StreamWriter(new FileStream(Path.Combine(this.TargetDirectory, "Summary.mht"), FileMode.Create)))
+            {
+                writer.WriteLine("MIME-Version: 1.0");
+                writer.WriteLine("Content-Type: multipart/related;");
+                writer.WriteLine("\ttype=\"text/html\";");
+                writer.WriteLine("\tboundary=\"----=_NextPart_000_0000_01D23618.54EBCBE0\"");
+                writer.WriteLine();
+
+                string file = "index.htm";
+                string content = File.ReadAllText(Path.Combine(this.htmlReportTargetDirectory, file));
+                content = AddFilePrefixForCssAndJavaScript(content);
+                content = content.Replace("<tr><td><a href=\"", "<tr><td><a href=\"file:///");
+                WriteFile(writer, file, "text/html", content);
+
+                foreach (var reportFile in Directory.EnumerateFiles(this.htmlReportTargetDirectory, "*.htm"))
+                {
+                    if (reportFile.EndsWith("index.htm"))
+                    {
+                        continue;
+                    }
+
+                    file = reportFile.Substring(reportFile.LastIndexOf(Path.DirectorySeparatorChar) + 1);
+                    content = File.ReadAllText(reportFile);
+                    content = AddFilePrefixForCssAndJavaScript(content);
+                    WriteFile(writer, file, "text/html", content);
+                }
+
+                file = "combined.js";
+                content = File.ReadAllText(Path.Combine(this.htmlReportTargetDirectory, file));
+                content = content.Replace(", \"reportPath\" : \"", ", \"reportPath\" : \"file:///");
+                WriteFile(writer, file, "application/javascript", content);
+
+                file = "report.css";
+                content = File.ReadAllText(Path.Combine(this.htmlReportTargetDirectory, file));
+                WriteFile(writer, file, "text/css", content);
+
+                writer.Write("------=_NextPart_000_0000_01D23618.54EBCBE0--");
+            }
+        }
+    }
+}

ReportGenerator.Reporting/ReportGenerator.Reporting.csproj

@@ -46,6 +46,7 @@
   <ItemGroup>
     <Compile Include="BadgeReportBuilder.cs" />
     <Compile Include="CsvSummaryReportBuilder.cs" />
+    <Compile Include="MhtmlReportBuilder.cs" />
     <Compile Include="HtmlChartReportBuilder.cs" />
     <Compile Include="PngChartReportBuilder.cs" />
     <Compile Include="TextSummaryReportBuilder.cs" />