qol: use unified exporting for logs

Disco.Services/Disco.Services.csproj

@@ -402,6 +402,7 @@
     <Compile Include="Jobs\Statistics\DailyOpenedClosed.cs" />
     <Compile Include="Logging\LogBase.cs" />
     <Compile Include="Logging\LogContext.cs" />
+    <Compile Include="Logging\LogExport.cs" />
     <Compile Include="Logging\LogReInitalizeJob.cs" />
     <Compile Include="Logging\Models\LogEvent.cs" />
     <Compile Include="Logging\Models\LogEventType.cs" />

Disco.Services/Exporting/ExportHelpers.cs

@@ -15,9 +15,6 @@ namespace Disco.Services
     {
         public static ExportResult WriteExport<T>(IExportOptions options, IScheduledTaskStatus status, List<ExportFieldMetadata<T>> metadata, List<T> records) where T : IExportRecord
         {
-            if (records.Count == 0)
-                return new ExportResult();
-
             var filenameWithoutExtension = $"{options.FilenamePrefix}-{status.StartedTimestamp.Value:yyyyMMdd-HHmmss}";
             MemoryStream stream;
             string filename;

Disco.Services/Logging/LogExport.cs

@@ -0,0 +1,67 @@
+using Disco.Models.Exporting;
+using Disco.Models.Services.Exporting;
+using Disco.Services.Logging.Models;
+using Disco.Services.Tasks;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Disco.Services.Logging
+{
+    using Metadata = ExportFieldMetadata<LogLiveEvent>;
+
+    public static class LogExport
+    {
+        public static ExportResult GenerateExport(ExportFormat format, List<LogLiveEvent> records)
+        {
+            var options = new LogExportOptions(format);
+
+            const string DateFormat = "yyyy-MM-dd";
+            const string DateTimeFormat = DateFormat + " HH:mm:ss";
+            Func<object, string> csvStringEncoded = (o) => o == null ? null : $"\"{((string)o).Replace("\"", "\"\"")}\"";
+            Func<object, string> csvToStringEncoded = (o) => o == null ? null : o.ToString();
+            Func<object, string> csvCurrencyEncoded = (o) => ((decimal?)o).HasValue ? ((decimal?)o).Value.ToString("C") : null;
+            Func<object, string> csvDateEncoded = (o) => ((DateTime)o).ToString(DateFormat);
+            Func<object, string> csvDateTimeEncoded = (o) => ((DateTime)o).ToString(DateTimeFormat);
+            Func<object, string> csvNullableDateEncoded = (o) => ((DateTime?)o).HasValue ? csvDateEncoded(o) : null;
+            Func<object, string> csvNullableDateTimeEncoded = (o) => ((DateTime?)o).HasValue ? csvDateTimeEncoded(o) : null;
+
+            var metadata = new List<Metadata>
+            {
+                new Metadata(nameof(LogLiveEvent.Timestamp), nameof(LogLiveEvent.Timestamp), typeof(DateTime), e => e.Timestamp, csvDateTimeEncoded),
+                new Metadata(nameof(LogLiveEvent.ModuleId), nameof(LogLiveEvent.ModuleId), typeof(int), e => e.ModuleId, csvToStringEncoded),
+                new Metadata(nameof(LogLiveEvent.ModuleName), nameof(LogLiveEvent.ModuleName), typeof(string), e => e.ModuleName, csvStringEncoded),
+                new Metadata(nameof(LogLiveEvent.ModuleDescription), nameof(LogLiveEvent.ModuleDescription), typeof(string), e => e.ModuleDescription, csvStringEncoded),
+                new Metadata(nameof(LogLiveEvent.EventTypeId), nameof(LogLiveEvent.EventTypeId), typeof(int), e => e.EventTypeId, csvToStringEncoded),
+                new Metadata(nameof(LogLiveEvent.EventTypeName), nameof(LogLiveEvent.EventTypeName), typeof(string), e => e.EventTypeName, csvStringEncoded),
+                new Metadata("Severity", "Severity", typeof(string), e => e.EventTypeSeverity, csvToStringEncoded),
+                new Metadata("Message", "Message", typeof(string), e => e.FormattedMessage, csvStringEncoded),
+            };
+            if (records.Count > 0)
+            {
+                var argCount = records.Max(r => r.Arguments?.Length ?? 0);
+                for (var i = 0; i < argCount; i++)
+                {
+                    var index = i;
+                    var name = $"Data{i + 1:00}";
+                    metadata.Add(new Metadata(name, name, typeof(string), e => (e.Arguments?.Length ?? 0) > index ? (e.Arguments[index] ?? "null") : null, csvStringEncoded));
+                }
+            }
+
+            return ExportHelpers.WriteExport(options, ScheduledTaskMockStatus.Create("Export Disco ICT Logs"), metadata, records);
+        }
+    }
+
+    public class LogExportOptions : IExportOptions
+    {
+        public ExportFormat Format { get; set; }
+        public string FilenamePrefix { get; } = "DiscoIctLogs";
+        public string ExcelWorksheetName { get; set; } = "Disco ICT Logs";
+        public string ExcelTableName { get; set; } = "DiscoIctLogs";
+
+        public LogExportOptions(ExportFormat format)
+        {
+            Format = format;
+        }
+    }
+}

Disco.Services/Logging/Models/LogLiveEvent.cs

@@ -1,9 +1,10 @@
 using System;
+using Disco.Models.Exporting;
 using Newtonsoft.Json;
 
 namespace Disco.Services.Logging.Models
 {
-    public class LogLiveEvent
+    public class LogLiveEvent : IExportRecord
     {
         public int ModuleId { get; set; }
         public string ModuleName { get; set; }

Disco.Services/Logging/Utilities.cs

@@ -11,56 +11,6 @@ namespace Disco.Services.Logging
     public static class Utilities
     {
 
-        public const string LogEventCSVHeader = "Timestamp,ModuleId,ModuleName,ModuleDescription,EventTypeId,EventTypeName,Severity,Message";
-        public static void ToCsvLine(this Models.LogLiveEvent e, TextWriter writer)
-        {
-            writer.Write(e.Timestamp.ToString("yyy-MM-dd HH:mm:ss"));
-            writer.Write(",");
-            writer.Write(e.ModuleId);
-            writer.Write(",\"");
-            writer.Write(e.ModuleName);
-            writer.Write("\",\"");
-            writer.Write(e.ModuleDescription);
-            writer.Write("\",");
-            writer.Write(e.EventTypeId);
-            writer.Write(",\"");
-            writer.Write(e.EventTypeName);
-            writer.Write("\",");
-            writer.Write(e.EventTypeSeverity);
-            writer.Write(",\"");
-            writer.Write(e.FormattedMessage.Replace("\"", "'"));
-            writer.Write("\"");
-            if (e.Arguments != null)
-            {
-                foreach (var arg in e.Arguments)
-                {
-                    writer.Write(",\"");
-                    if (arg == null)
-                        writer.Write("null");
-                    else
-                        writer.Write(arg.ToString().Replace("\"", "'"));
-                    writer.Write("\"");
-                }
-            }
-            writer.WriteLine();
-        }
-        public static MemoryStream ToCsv(this List<Models.LogLiveEvent> e)
-        {
-            var ms = new MemoryStream();
-            StreamWriter sw = new StreamWriter(ms);
-            sw.WriteLine(LogEventCSVHeader);
-            if (e != null)
-            {
-                foreach (var le in e)
-                {
-                    le.ToCsvLine(sw);
-                }
-            }
-            sw.Flush();
-            ms.Position = 0;
-            return ms;
-        }
-
         public static List<SelectListItem> ToSelectListItems(this List<Models.LogEventType> items)
         {
             return items.Select(et => new SelectListItem() { Value = et.Id.ToString(), Text = et.Name }).ToList();