diff --git a/ObservatoryFramework/Files/Journal/JournalBase.cs b/ObservatoryFramework/Files/Journal/JournalBase.cs index f4bb71a..fbaf8c8 100644 --- a/ObservatoryFramework/Files/Journal/JournalBase.cs +++ b/ObservatoryFramework/Files/Journal/JournalBase.cs @@ -278,7 +278,7 @@ using Travel; [JsonDerivedType(typeof(ShipyardFile))] [JsonDerivedType(typeof(Status))] [JsonDerivedType(typeof(JournalBase))] -public interface IJournal +public class JournalBase { [JsonPropertyName("timestamp")] public DateTimeOffset Timestamp { get; init; } @@ -289,10 +289,3 @@ public interface IJournal [JsonExtensionData] public Dictionary AdditionalProperties { get; init; } } - -public abstract class JournalBase : IJournal -{ - public DateTimeOffset Timestamp { get; init; } - public string Event { get; init; } - public Dictionary AdditionalProperties { get; init; } -} \ No newline at end of file diff --git a/ObservatoryFramework/Interfaces.cs b/ObservatoryFramework/Interfaces.cs index 8a1ce5c..63bd7de 100644 --- a/ObservatoryFramework/Interfaces.cs +++ b/ObservatoryFramework/Interfaces.cs @@ -54,7 +54,7 @@ public interface IObservatoryWorker : IObservatoryPlugin /// Elite Dangerous journal event, deserialized into a .NET object. /// Unhandled json values within a journal entry type will be contained in member property:
Dictionary<string, object> AdditionalProperties. /// Unhandled journal event types will be type JournalBase with all values contained in AdditionalProperties. - public void JournalEvent(TJournal journal) where TJournal : IJournal; + public void JournalEvent(TJournal journal) where TJournal : JournalBase; /// /// Method called when status.json content is updated.
diff --git a/Pulsar/Features/EventsHub.cs b/Pulsar/Features/EventsHub.cs index 0a6e9bf..10042eb 100644 --- a/Pulsar/Features/EventsHub.cs +++ b/Pulsar/Features/EventsHub.cs @@ -6,45 +6,45 @@ using Observatory.Framework.Files.Journal; public class EventsHub : Hub { public async Task StatusUpdated(Observatory.Framework.Files.Status status) => await Clients.All.StatusUpdated(status); - + public async Task OutfittingUpdated(OutfittingFile outfitting) => await Clients.All.OutfittingUpdated(outfitting); - + public async Task ShipyardUpdated(ShipyardFile shipyard) => await Clients.All.ShipyardUpdated(shipyard); - + public async Task NavRouteUpdated(NavRouteFile navRoute) => await Clients.All.NavRouteUpdated(navRoute); - + public async Task MarketUpdated(MarketFile market) => await Clients.All.MarketUpdated(market); - - public async Task JournalUpdated(IReadOnlyCollection journals) => await Clients.All.JournalUpdated(journals); - + + public async Task JournalUpdated(IReadOnlyCollection journals) => await Clients.All.JournalUpdated(journals); + public async Task ModuleInfoUpdated(ModuleInfoFile moduleInfo) => await Clients.All.ModuleInfoUpdated(moduleInfo); - + public async Task FleetCarrierUpdated(FCMaterialsFile fleetCarrier) => await Clients.All.FleetCarrierUpdated(fleetCarrier); - + public async Task CargoUpdated(CargoFile cargo) => await Clients.All.CargoUpdated(cargo); - + public async Task BackpackUpdated(BackpackFile backpack) => await Clients.All.BackpackUpdated(backpack); } public interface IEventsHub { Task StatusUpdated(Observatory.Framework.Files.Status status); - + Task OutfittingUpdated(OutfittingFile outfitting); - + Task ShipyardUpdated(ShipyardFile shipyard); - + Task NavRouteUpdated(NavRouteFile navRoute); - + Task MarketUpdated(MarketFile market); - - Task JournalUpdated(IReadOnlyCollection journals); - + + Task JournalUpdated(IReadOnlyCollection journals); + Task ModuleInfoUpdated(ModuleInfoFile moduleInfo); - + Task FleetCarrierUpdated(FCMaterialsFile fleetCarrier); - + Task CargoUpdated(CargoFile cargo); - + Task BackpackUpdated(BackpackFile backpack); } \ No newline at end of file diff --git a/Pulsar/Features/Interfaces/IJournalHandler.cs b/Pulsar/Features/Interfaces/IJournalHandler.cs index 1997cf4..d39ee0a 100644 --- a/Pulsar/Features/Interfaces/IJournalHandler.cs +++ b/Pulsar/Features/Interfaces/IJournalHandler.cs @@ -8,7 +8,7 @@ namespace Pulsar.Features; public interface IJournalHandler : IFileHandler { string FileName { get; } - + public bool ValidateFile(string filePath); } @@ -17,42 +17,6 @@ public interface IJournalHandler : IFileHandler /// Only used for Controllers /// public interface IJournalHandler : IJournalHandler - where T: IJournal { Task Get(); } - -public abstract class JournalHandlerBase(ILogger logger) : IJournalHandler - where T: IJournal -{ - public abstract string FileName { get; } - - public abstract Task HandleFile(string filePath); - - public bool ValidateFile(string filePath) - { - if (!File.Exists(filePath)) - { - logger.LogWarning("Journal file {JournalFile} does not exist", filePath); - return false; - } - - var fileInfo = new FileInfo(filePath); - - if (!string.Equals(fileInfo.Name, FileName, StringComparison.InvariantCultureIgnoreCase)) - { - logger.LogWarning("Journal file {JournalFile} is not a {NameOfCurrentHandler} file", filePath, nameof(T)); - return false; - } - - if (fileInfo.Length == 0) - { - logger.LogWarning("Journal file {JournalFile} is empty", filePath); - return false; - } - - return true; - } - - public abstract Task Get(); -} \ No newline at end of file diff --git a/Pulsar/Features/Journal/JournalController.cs b/Pulsar/Features/Journal/JournalController.cs index 8295ab5..ead198c 100644 --- a/Pulsar/Features/Journal/JournalController.cs +++ b/Pulsar/Features/Journal/JournalController.cs @@ -2,7 +2,11 @@ namespace Pulsar.Features.Journal; [ApiController] [Route("api/[controller]")] -public class JournalController : ControllerBase +public class JournalController(IJournalService journalService) : ControllerBase { - + [HttpGet] + public async Task Get() + { + return Ok(await journalService.Get()); + } } \ No newline at end of file diff --git a/Pulsar/Features/Journal/JournalService.cs b/Pulsar/Features/Journal/JournalService.cs new file mode 100644 index 0000000..8dc3033 --- /dev/null +++ b/Pulsar/Features/Journal/JournalService.cs @@ -0,0 +1,89 @@ +namespace Pulsar.Features.Journal; + +using Observatory.Framework.Files; +using Observatory.Framework.Files.Journal; + +public interface IJournalService : IJournalHandler>; + +public class JournalService +( + ILogger logger, + IOptions options, + IEventHubContext hub +) : IJournalService +{ + public string FileName => "Journal.2024-03-16T152419.01.log"; // FileHandlerService.JournalLogFileName; + + public bool ValidateFile(string filePath) + { + if (!File.Exists(filePath)) + { + logger.LogWarning("Journal file {JournalFile} does not exist", filePath); + return false; + } + + var fileInfo = new FileInfo(filePath); + + if (!string.Equals(fileInfo.Name, FileName, StringComparison.InvariantCultureIgnoreCase)) + { + logger.LogWarning("Journal file {name} is not valid"); + return false; + } + + if (fileInfo.Length == 0) + { + logger.LogWarning("Journal file {name} is empty", filePath); + return false; + } + + return true; + } + + public async Task HandleFile(string filePath) + { + if (!ValidateFile(filePath)) + { + return; + } + + var file = File.Open(filePath, FileMode.Open, FileAccess.Read, FileShare.ReadWrite); + var moduleInfo = await JsonSerializer.DeserializeAsync>(file); + + if (moduleInfo == null) + { + logger.LogWarning("Failed to deserialize status file {FilePath}", filePath); + return; + } + + // await hub.Clients.All.ModuleInfoUpdated(moduleInfo); + } + + public async Task> Get() + { + var dataFileName = Path.Combine(options.Value.JournalDirectory, FileName); + + if (!ValidateFile(dataFileName)) + { + return []; + } + + // Seems each entry is a new line. Not sure if this can be relied on? + var logs = File.ReadAllLines(dataFileName); + + var journals = new List(); + foreach (var log in logs) + { + // var info = JournalReader.ObservatoryDeserializer(log); + var info = JsonSerializer.Deserialize(log); + if (info != null) + { + journals.Add(info); + } + } + + if (journals.Count > 0) return journals; + + logger.LogWarning("Failed to deserialize module info file {file}", dataFileName); + return []; + } +} diff --git a/Pulsar/Features/ModulesInfo/ModulesInfoController.cs b/Pulsar/Features/ModulesInfo/ModulesInfoController.cs index 0dc108b..f08ccca 100644 --- a/Pulsar/Features/ModulesInfo/ModulesInfoController.cs +++ b/Pulsar/Features/ModulesInfo/ModulesInfoController.cs @@ -7,6 +7,6 @@ public class ModulesInfoController(IModulesInfoService modulesInfo) : Controller [HttpGet] public async Task Get() { - return Ok(modulesInfo.Get()); + return Ok(await modulesInfo.Get()); } } \ No newline at end of file diff --git a/Pulsar/Features/ModulesInfo/ModulesInfoService.cs b/Pulsar/Features/ModulesInfo/ModulesInfoService.cs index 6ad9df2..2c6b7b0 100644 --- a/Pulsar/Features/ModulesInfo/ModulesInfoService.cs +++ b/Pulsar/Features/ModulesInfo/ModulesInfoService.cs @@ -7,12 +7,36 @@ public interface IModulesInfoService : IJournalHandler; public class ModulesInfoService( ILogger logger, IOptions options, - IEventHubContext hub) - : JournalHandlerBase(logger), IModulesInfoService + IEventHubContext hub) : IModulesInfoService { - public override string FileName => FileHandlerService.ModulesInfoFileName; + public string FileName => FileHandlerService.ModulesInfoFileName; - public override async Task HandleFile(string filePath) + public bool ValidateFile(string filePath) + { + if (!File.Exists(filePath)) + { + logger.LogWarning("Journal file {JournalFile} does not exist", filePath); + return false; + } + + var fileInfo = new FileInfo(filePath); + + if (!string.Equals(fileInfo.Name, FileName, StringComparison.InvariantCultureIgnoreCase)) + { + logger.LogWarning("Journal file {name} is not valid"); + return false; + } + + if (fileInfo.Length == 0) + { + logger.LogWarning("Journal file {name} is empty", filePath); + return false; + } + + return true; + } + + public async Task HandleFile(string filePath) { if (!ValidateFile(filePath)) { @@ -31,7 +55,7 @@ public class ModulesInfoService( await hub.Clients.All.ModuleInfoUpdated(moduleInfo); } - public override async Task Get() + public async Task Get() { var moduleInfoFile = Path.Combine(options.Value.JournalDirectory, FileName); @@ -47,4 +71,4 @@ public class ModulesInfoService( logger.LogWarning("Failed to deserialize module info file {ModuleInfoFile}", moduleInfoFile); return new ModuleInfoFile(); } -} \ No newline at end of file +} diff --git a/Pulsar/Features/ShipLocker/ShipLockerService.cs b/Pulsar/Features/ShipLocker/ShipLockerService.cs index 632da8d..99014db 100644 --- a/Pulsar/Features/ShipLocker/ShipLockerService.cs +++ b/Pulsar/Features/ShipLocker/ShipLockerService.cs @@ -5,16 +5,41 @@ using Observatory.Framework.Files.Journal.Odyssey; public interface IShipLockerService : IJournalHandler; public class ShipLockerService(ILogger logger) - : JournalHandlerBase(logger), IShipLockerService + : IShipLockerService { - public override string FileName => FileHandlerService.ShipLockerFileName; + public string FileName => FileHandlerService.ShipLockerFileName; - public override Task Get() + public bool ValidateFile(string filePath) + { + if (!File.Exists(filePath)) + { + logger.LogWarning("Journal file {JournalFile} does not exist", filePath); + return false; + } + + var fileInfo = new FileInfo(filePath); + + if (!string.Equals(fileInfo.Name, FileName, StringComparison.InvariantCultureIgnoreCase)) + { + logger.LogWarning("Journal file {name} is not valid"); + return false; + } + + if (fileInfo.Length == 0) + { + logger.LogWarning("Journal file {name} is empty", filePath); + return false; + } + + return true; + } + + public Task Get() { throw new NotImplementedException(); } - public override Task HandleFile(string filePath) + public Task HandleFile(string filePath) { throw new NotImplementedException(); } diff --git a/Pulsar/Features/Status/StatusService.cs b/Pulsar/Features/Status/StatusService.cs index 88fd661..dc7bdaf 100644 --- a/Pulsar/Features/Status/StatusService.cs +++ b/Pulsar/Features/Status/StatusService.cs @@ -4,12 +4,41 @@ using Observatory.Framework.Files; public interface IStatusService : IJournalHandler; -public class StatusService(ILogger logger, IOptions options, IEventHubContext hub) - : JournalHandlerBase(logger), IStatusService +public class StatusService +( + ILogger logger, + IOptions options, + IEventHubContext hub +) : IStatusService { - public override string FileName => FileHandlerService.StatusFileName; + public string FileName => FileHandlerService.StatusFileName; - public override async Task HandleFile(string filePath) + public bool ValidateFile(string filePath) + { + if (!File.Exists(filePath)) + { + logger.LogWarning("Journal file {JournalFile} does not exist", filePath); + return false; + } + + var fileInfo = new FileInfo(filePath); + + if (!string.Equals(fileInfo.Name, FileName, StringComparison.InvariantCultureIgnoreCase)) + { + logger.LogWarning("Journal file {name} is not valid"); + return false; + } + + if (fileInfo.Length == 0) + { + logger.LogWarning("Journal file {name} is empty", filePath); + return false; + } + + return true; + } + + public async Task HandleFile(string filePath) { if (!ValidateFile(filePath)) { @@ -28,7 +57,7 @@ public class StatusService(ILogger logger, IOptions Get() + public async Task Get() { var statusFile = Path.Combine(options.Value.JournalDirectory, FileName); diff --git a/Pulsar/PulsarServiceRegistry.cs b/Pulsar/PulsarServiceRegistry.cs index 55ff8b8..ad36439 100644 --- a/Pulsar/PulsarServiceRegistry.cs +++ b/Pulsar/PulsarServiceRegistry.cs @@ -2,6 +2,7 @@ using System.Diagnostics.CodeAnalysis; using Lamar; using Pulsar.Features; using Pulsar.Features.ModulesInfo; +using Pulsar.Features.Journal; namespace Pulsar; @@ -13,5 +14,6 @@ public class PulsarServiceRegistry : ServiceRegistry For().Use(); For().Use(); For().Use(); + For().Use(); } } \ No newline at end of file diff --git a/Pulsar/Utils/JournalReader.cs b/Pulsar/Utils/JournalReader.cs index 43eb586..0185f3c 100644 --- a/Pulsar/Utils/JournalReader.cs +++ b/Pulsar/Utils/JournalReader.cs @@ -5,7 +5,7 @@ namespace Pulsar.Utils; public static class JournalReader { - public static TJournal ObservatoryDeserializer(string json) where TJournal : IJournal + public static TJournal ObservatoryDeserializer(string json) where TJournal : JournalBase { TJournal deserialized;