add alert/notification functionality (for server connection events and messages)

SharedLibraryCore/Alerts/Alert.cs

@@ -0,0 +1,33 @@
+using System;
+using Data.Models.Client;
+
+namespace SharedLibraryCore.Alerts;
+
+public class Alert
+{
+    public enum AlertCategory
+    {
+        Information,
+        Warning,
+        Error,
+        Message,
+    }
+
+    public class AlertState
+    {
+        public Guid AlertId { get; } = Guid.NewGuid();
+        public AlertCategory Category { get; set; }
+        public DateTime OccuredAt { get; set; } = DateTime.UtcNow;
+        public DateTime? ExpiresAt { get; set; }
+        public string Message { get; set; }
+        public string Source { get; set; } 
+        public int? RecipientId { get; set; }
+        public int? SourceId { get; set; }
+        public int? ReferenceId { get; set; }
+        public bool? Delivered { get; set; }
+        public bool? Consumed { get; set; }
+        public EFClient.Permission? MinimumPermission { get; set; }
+        public string Type { get; set; }
+        public static AlertState Build() => new();
+    }
+}

SharedLibraryCore/BaseController.cs

@@ -20,6 +20,8 @@ namespace SharedLibraryCore
 {
     public class BaseController : Controller
     {
+        protected readonly IAlertManager AlertManager;
+
         /// <summary>
         ///     life span in months
         /// </summary>
@@ -34,6 +36,7 @@ namespace SharedLibraryCore
 
         public BaseController(IManager manager)
         {
+            AlertManager = manager.AlertManager;
             Manager = manager;
             Localization ??= Utilities.CurrentLocalization.LocalizationIndex;
             AppConfig = Manager.GetApplicationSettings().Configuration();
@@ -169,6 +172,7 @@ namespace SharedLibraryCore
             ViewBag.ReportCount = Manager.GetServers().Sum(server =>
                 server.Reports.Count(report => DateTime.UtcNow - report.ReportedOn <= TimeSpan.FromHours(24)));
             ViewBag.PermissionsSet = PermissionsSet;
+            ViewBag.Alerts = AlertManager.RetrieveAlerts(Client).ToList();
 
             base.OnActionExecuting(context);
         }

SharedLibraryCore/Configuration/ApplicationConfiguration.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
 using System.Linq;
+using Data.Models.Misc;
 using Newtonsoft.Json;
 using SharedLibraryCore.Configuration.Attributes;
 using SharedLibraryCore.Interfaces;
@@ -154,6 +155,13 @@ namespace SharedLibraryCore.Configuration
             { Permission.Console.ToString(), new List<string> { "*" } }
         };
 
+        public Dictionary<string, Permission> MinimumAlertPermissions { get; set; } = new()
+        {
+            { nameof(EFInboxMessage), Permission.Trusted },
+            { GameEvent.EventType.ConnectionLost.ToString(), Permission.Administrator },
+            { GameEvent.EventType.ConnectionRestored.ToString(), Permission.Administrator }
+        };
+
         [ConfigurationIgnore]
         [LocalizedDisplayName("WEBFRONT_CONFIGURATION_PRESET_BAN_REASONS")]
         public Dictionary<string, string> PresetPenaltyReasons { get; set; } = new()

SharedLibraryCore/Interfaces/IAlertManager.cs

@@ -0,0 +1,54 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using SharedLibraryCore.Alerts;
+using SharedLibraryCore.Database.Models;
+
+namespace SharedLibraryCore.Interfaces;
+
+public interface IAlertManager
+{
+    /// <summary>
+    /// Initializes the manager
+    /// </summary>
+    /// <returns></returns>
+    Task Initialize();
+    
+    /// <summary>
+    /// Get all the alerts for given client
+    /// </summary>
+    /// <param name="client">client to retrieve alerts for</param>
+    /// <returns></returns>
+    IEnumerable<Alert.AlertState> RetrieveAlerts(EFClient client);
+    
+    /// <summary>
+    /// Trigger a new alert
+    /// </summary>
+    /// <param name="alert">Alert to trigger</param>
+    void AddAlert(Alert.AlertState alert);
+    
+    /// <summary>
+    /// Marks an alert as read and removes it from the manager
+    /// </summary>
+    /// <param name="alertId">Id of the alert to mark as read</param>
+    void MarkAlertAsRead(Guid alertId);
+    
+    /// <summary>
+    /// Mark all alerts intended for the given recipientId as read
+    /// </summary>
+    /// <param name="recipientId">Identifier of the recipient</param>
+    void MarkAllAlertsAsRead(int recipientId);
+    
+    /// <summary>
+    /// Registers a static (persistent) event source eg datastore that
+    /// gets initialized at startup
+    /// </summary>
+    /// <param name="alertSource">Source action</param>
+    void RegisterStaticAlertSource(Func<Task<IEnumerable<Alert.AlertState>>> alertSource);
+    
+    /// <summary>
+    /// Fires when an alert has been consumed (dimissed)
+    /// </summary>
+    EventHandler<Alert.AlertState> OnAlertConsumed { get; set; }
+    
+}

SharedLibraryCore/Interfaces/IManager.cs

@@ -102,5 +102,7 @@ namespace SharedLibraryCore.Interfaces
         ///     event executed when event has finished executing
         /// </summary>
         event EventHandler<GameEvent> OnGameEventExecuted;
+        
+        IAlertManager AlertManager { get; }
     }
 }