Feat: Port All Delta-V Mail Improvements

Content.Client/CartridgeLoader/Cartridges/MailMetricUi.cs

@@ -0,0 +1,28 @@
+using Content.Client.UserInterface.Fragments;
+using Content.Shared.CartridgeLoader.Cartridges;
+using Robust.Client.UserInterface;
+
+namespace Content.Client.CartridgeLoader.Cartridges;
+
+public sealed partial class MailMetricUi : UIFragment
+{
+    private MailMetricUiFragment? _fragment;
+
+    public override Control GetUIFragmentRoot()
+    {
+        return _fragment!;
+    }
+
+    public override void Setup(BoundUserInterface userInterface, EntityUid? fragmentOwner)
+    {
+        _fragment = new MailMetricUiFragment();
+    }
+
+    public override void UpdateState(BoundUserInterfaceState state)
+    {
+        if (state is MailMetricUiState cast)
+        {
+            _fragment?.UpdateState(cast);
+        }
+    }
+}

Content.Client/CartridgeLoader/Cartridges/MailMetricUiFragment.xaml

@@ -0,0 +1,183 @@
+<cartridges:MailMetricUiFragment
+    xmlns:cartridges="clr-namespace:Content.Client.CartridgeLoader.Cartridges"
+    xmlns:customControls="clr-namespace:Content.Client.Administration.UI.CustomControls"
+    xmlns:controls="clr-namespace:Content.Client.UserInterface.Controls"
+    xmlns="https://spacestation14.io"
+    Margin="5"
+    VerticalExpand="True"
+    Orientation="Vertical">
+    <PanelContainer StyleClasses="BackgroundDark"></PanelContainer>
+    <controls:StripeBack Name="MailMetricHeaderContainer">
+        <PanelContainer>
+            <Label Name="MailMetricHeader"
+                Align="Center"
+                Text="{Loc 'mail-metrics-header'}" />
+        </PanelContainer>
+    </controls:StripeBack>
+    <BoxContainer
+        Orientation="Vertical"
+        HorizontalExpand="True"
+        Margin="20 0">
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="TitleEmpty1"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True" />
+            <Label Name="MailCountLabel"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                ClipText="True"
+                StyleClasses="monospace"
+                Align="Center"
+                Text="{Loc 'mail-metrics-count-header'}" />
+            <Label Name="SpesosLabel"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                ClipText="True"
+                Align="Center"
+                StyleClasses="monospace"
+                Text="{Loc 'mail-metrics-money-header'}" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="OpenedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-opened'}" />
+            <Label Name="OpenedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="OpenedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="ExpiredLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-expired'}" />
+            <Label Name="ExpiredMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="ExpiredMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="TamperedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-tampered'}" />
+            <Label Name="TamperedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="TamperedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="DamagedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-damaged'}" />
+            <Label Name="DamagedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="DamagedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                StyleClasses="monospace"
+                Align="Right"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="UnopenedLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-unopened'}" />
+            <Label Name="UnopenedMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                StyleClasses="monospace"
+                Align="Right"
+                ClipText="True" />
+            <Label Name="UnopenedMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+        <BoxContainer Orientation="Horizontal"
+            HorizontalExpand="True"
+            SeparationOverride="2">
+            <Label Name="TotalMailLabel"
+                SizeFlagsStretchRatio="2"
+                HorizontalExpand="True"
+                ClipText="True"
+                Text="{Loc 'mail-metrics-total'}" />
+            <Label Name="TotalMailCount"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+            <Label Name="TotalMailSpesos"
+                SizeFlagsStretchRatio="1"
+                HorizontalExpand="True"
+                Align="Right"
+                StyleClasses="monospace"
+                ClipText="True" />
+        </BoxContainer>
+    </BoxContainer>
+    <BoxContainer
+        Orientation="Vertical"
+        HorizontalExpand="True"
+        Margin="10">
+        <Label
+            Name="SuccessRateCounts"
+            Align="Center"
+            StyleClasses="LabelBig" />
+        <Label
+            Name="SuccessRatePercent"
+            Align="Center"
+            StyleClasses="LabelBig" />
+    </BoxContainer>
+</cartridges:MailMetricUiFragment>

Content.Client/CartridgeLoader/Cartridges/MailMetricUiFragment.xaml.cs

@@ -0,0 +1,104 @@
+using Content.Shared.CartridgeLoader.Cartridges;
+using Robust.Client.AutoGenerated;
+using Robust.Client.UserInterface.Controls;
+using Robust.Client.UserInterface.XAML;
+
+namespace Content.Client.CartridgeLoader.Cartridges;
+
+[GenerateTypedNameReferences]
+public sealed partial class MailMetricUiFragment : BoxContainer
+{
+
+    private OpenedMailPercentGrade? _successGrade;
+
+    public MailMetricUiFragment()
+    {
+        RobustXamlLoader.Load(this);
+
+        // This my way of adding multiple classes to a XAML control.
+        // Haha Batman I'm going to blow up Gotham City
+        OpenedMailCount.StyleClasses.Add("Good");
+        OpenedMailSpesos.StyleClasses.Add("Good");
+        TamperedMailCount.StyleClasses.Add("Danger");
+        TamperedMailSpesos.StyleClasses.Add("Danger");
+        ExpiredMailCount.StyleClasses.Add("Danger");
+        ExpiredMailSpesos.StyleClasses.Add("Danger");
+        DamagedMailCount.StyleClasses.Add("Danger");
+        DamagedMailSpesos.StyleClasses.Add("Danger");
+        UnopenedMailCount.StyleClasses.Add("Caution");
+    }
+
+    public void UpdateState(MailMetricUiState state)
+    {
+        UpdateTextLabels(state);
+        UpdateSuccessGrade(state);
+    }
+
+    public void UpdateTextLabels(MailMetricUiState state)
+    {
+        var stats = state.Metrics;
+
+        OpenedMailCount.Text = stats.OpenedCount.ToString();
+        OpenedMailSpesos.Text = stats.Earnings.ToString();
+        TamperedMailCount.Text = stats.TamperedCount.ToString();
+        TamperedMailSpesos.Text = stats.TamperedLosses.ToString();
+        ExpiredMailCount.Text = stats.ExpiredCount.ToString();
+        ExpiredMailSpesos.Text = stats.ExpiredLosses.ToString();
+        DamagedMailCount.Text = stats.DamagedCount.ToString();
+        DamagedMailSpesos.Text = stats.DamagedLosses.ToString();
+        UnopenedMailCount.Text = state.UnopenedMailCount.ToString();
+        TotalMailCount.Text = state.TotalMail.ToString();
+        TotalMailSpesos.Text = stats.TotalIncome.ToString();
+        SuccessRateCounts.Text = Loc.GetString("mail-metrics-progress",
+            ("opened", stats.OpenedCount),
+            ("total", state.TotalMail));
+        SuccessRatePercent.Text = Loc.GetString("mail-metrics-progress-percent",
+            ("successRate", state.SuccessRate));
+    }
+
+    public void UpdateSuccessGrade(MailMetricUiState state)
+    {
+        var previousGrade = _successGrade;
+        _successGrade = GetSuccessRateGrade(state.SuccessRate);
+
+        // No need to update if they're the same
+        if (previousGrade == _successGrade)
+            return;
+
+        var previousGradeClass = GetClassForGrade(previousGrade);
+        if (previousGradeClass != string.Empty)
+        {
+            SuccessRatePercent.StyleClasses.Remove(previousGradeClass);
+        }
+
+        SuccessRatePercent.StyleClasses.Add(GetClassForGrade(_successGrade));
+    }
+
+    private static OpenedMailPercentGrade GetSuccessRateGrade(double successRate)
+    {
+        return successRate switch
+        {
+            > 75 => OpenedMailPercentGrade.Good,
+            > 50 => OpenedMailPercentGrade.Average,
+            _ => OpenedMailPercentGrade.Bad,
+        };
+    }
+
+    private string GetClassForGrade(OpenedMailPercentGrade? grade)
+    {
+        return grade switch
+        {
+            OpenedMailPercentGrade.Good => "Good",
+            OpenedMailPercentGrade.Average => "Caution",
+            OpenedMailPercentGrade.Bad => "Danger",
+            _ => string.Empty,
+        };
+    }
+}
+
+enum OpenedMailPercentGrade
+{
+    Good,
+    Average,
+    Bad
+}

Content.Server/Cargo/Components/StationLogisticStatsDatabaseComponent.cs

@@ -0,0 +1,14 @@
+using Content.Shared.Cargo;
+using Content.Shared.CartridgeLoader.Cartridges;
+
+namespace Content.Server.Cargo.Components;
+
+/// <summary>
+/// Added to the abstract representation of a station to track stats related to mail delivery and income
+/// </summary>
+[RegisterComponent, Access(typeof(SharedCargoSystem))]
+public sealed partial class StationLogisticStatsComponent : Component
+{
+    [DataField]
+    public MailStats Metrics { get; set; }
+}

Content.Server/Cargo/Systems/LogisticStatsSystem.cs

@@ -0,0 +1,63 @@
+using Content.Shared.Cargo;
+using Content.Server.Cargo.Components;
+using JetBrains.Annotations;
+
+namespace Content.Server.Cargo.Systems;
+
+public sealed partial class LogisticStatsSystem : SharedCargoSystem
+{
+    [PublicAPI]
+    public void AddOpenedMailEarnings(EntityUid uid, StationLogisticStatsComponent component, int earnedMoney)
+    {
+        component.Metrics = component.Metrics with
+        {
+            Earnings = component.Metrics.Earnings + earnedMoney,
+            OpenedCount = component.Metrics.OpenedCount + 1
+        };
+        UpdateLogisticsStats(uid);
+    }
+
+    [PublicAPI]
+    public void AddExpiredMailLosses(EntityUid uid, StationLogisticStatsComponent component, int lostMoney)
+    {
+        component.Metrics = component.Metrics with
+        {
+            ExpiredLosses = component.Metrics.ExpiredLosses + lostMoney,
+            ExpiredCount = component.Metrics.ExpiredCount + 1
+        };
+        UpdateLogisticsStats(uid);
+    }
+
+    [PublicAPI]
+    public void AddDamagedMailLosses(EntityUid uid, StationLogisticStatsComponent component, int lostMoney)
+    {
+        component.Metrics = component.Metrics with
+        {
+            DamagedLosses = component.Metrics.DamagedLosses + lostMoney,
+            DamagedCount = component.Metrics.DamagedCount + 1
+        };
+        UpdateLogisticsStats(uid);
+    }
+
+    [PublicAPI]
+    public void AddTamperedMailLosses(EntityUid uid, StationLogisticStatsComponent component, int lostMoney)
+    {
+        component.Metrics = component.Metrics with
+        {
+            TamperedLosses = component.Metrics.TamperedLosses + lostMoney,
+            TamperedCount = component.Metrics.TamperedCount + 1
+        };
+        UpdateLogisticsStats(uid);
+    }
+
+    private void UpdateLogisticsStats(EntityUid uid) => RaiseLocalEvent(new LogisticStatsUpdatedEvent(uid));
+}
+
+public sealed class LogisticStatsUpdatedEvent : EntityEventArgs
+{
+    public EntityUid Station;
+    public LogisticStatsUpdatedEvent(EntityUid station)
+    {
+        Station = station;
+    }
+}