From 245f276f3582b2f89a01ea74cf42f5e2065292ee Mon Sep 17 00:00:00 2001
From: Pieter-Jan Briers <pieterjan.briers+git@gmail.com>
Date: Sun, 28 Feb 2021 22:11:45 +0100
Subject: [PATCH] Restart vote improvements, voting localization.

Restart votes now need 80% majority to succeed.
Restart votes now have a 3 minute cooldown on the caller.
Voting stuff has been localized.
---
 Content.Client/Voting/VoteCallMenu.xaml       |  6 +-
 Content.Client/Voting/VoteCallMenu.xaml.cs    |  4 +-
 Content.Client/Voting/VoteCallMenuButton.cs   |  2 +-
 Content.Client/Voting/VotePopup.xaml.cs       |  4 +-
 Content.Server/Voting/IVoteHandle.cs          |  5 +-
 .../Voting/VoteManager.DefaultVotes.cs        | 43 ++++++------
 Content.Server/Voting/VoteManager.cs          | 66 ++++++++++++++++++-
 Content.Shared/CCVars.cs                      |  8 +++
 Resources/Changelog/Parts/restart_votes.yml   |  4 ++
 Resources/Locale/en-US/gamemodes/modes.ftl    |  4 ++
 Resources/Locale/en-US/ui/voting.ftl          | 30 +++++++++
 11 files changed, 145 insertions(+), 31 deletions(-)
 create mode 100644 Resources/Changelog/Parts/restart_votes.yml
 create mode 100644 Resources/Locale/en-US/gamemodes/modes.ftl
 create mode 100644 Resources/Locale/en-US/ui/voting.ftl

diff --git a/Content.Client/Voting/VoteCallMenu.xaml b/Content.Client/Voting/VoteCallMenu.xaml
index 7fa7f2ade0..11e2cc4fb4 100644
--- a/Content.Client/Voting/VoteCallMenu.xaml
+++ b/Content.Client/Voting/VoteCallMenu.xaml
@@ -6,7 +6,7 @@
     <VBoxContainer>
         <HBoxContainer>
             <MarginContainer MarginLeftOverride="8" HorizontalExpand="True">
-                <Label Text="{Loc 'Call Vote'}" VAlign="Center" StyleClasses="LabelHeading" />
+                <Label Text="{Loc 'ui-vote-create-title'}" VAlign="Center" StyleClasses="LabelHeading" />
             </MarginContainer>
             <MarginContainer MarginRightOverride="8">
                 <TextureButton Name="CloseButton" StyleClasses="windowCloseButton"
@@ -27,12 +27,12 @@
 
         <MarginContainer SizeFlagsHorizontal="Fill"
                          MarginLeftOverride="8" MarginRightOverride="8" MarginBottomOverride="2">
-            <Button Name="CreateButton" Text="{Loc 'Call Vote'}" />
+            <Button Name="CreateButton" Text="{Loc 'ui-vote-create-button'}" />
         </MarginContainer>
 
         <PanelContainer StyleClasses="LowDivider" />
         <MarginContainer MarginLeftOverride="12">
-            <Label StyleClasses="LabelSubText" Text="{Loc 'Powered by Robust™ Anti-Tamper Technology'}" />
+            <Label StyleClasses="LabelSubText" Text="{Loc 'ui-vote-fluff'}" />
         </MarginContainer>
 
     </VBoxContainer>
diff --git a/Content.Client/Voting/VoteCallMenu.xaml.cs b/Content.Client/Voting/VoteCallMenu.xaml.cs
index abc8a5bfaa..cb17a694b8 100644
--- a/Content.Client/Voting/VoteCallMenu.xaml.cs
+++ b/Content.Client/Voting/VoteCallMenu.xaml.cs
@@ -20,8 +20,8 @@ namespace Content.Client.Voting
 
         public static readonly (string name, string id, (string name, string id)[]? secondaries)[] AvailableVoteTypes =
         {
-            ("Restart round", "restart", null),
-            ("Next gamemode", "preset", null)
+            ("ui-vote-type-restart", "restart", null),
+            ("ui-vote-type-gamemode", "preset", null)
         };
 
         public VoteCallMenu()
diff --git a/Content.Client/Voting/VoteCallMenuButton.cs b/Content.Client/Voting/VoteCallMenuButton.cs
index 5ec4b76d18..74c6a65de8 100644
--- a/Content.Client/Voting/VoteCallMenuButton.cs
+++ b/Content.Client/Voting/VoteCallMenuButton.cs
@@ -16,7 +16,7 @@ namespace Content.Client.Voting
         {
             IoCManager.InjectDependencies(this);
 
-            Text = Loc.GetString("Call vote");
+            Text = Loc.GetString("ui-vote-menu-button");
             OnPressed += OnOnPressed;
         }
 
diff --git a/Content.Client/Voting/VotePopup.xaml.cs b/Content.Client/Voting/VotePopup.xaml.cs
index 4427ef3fdc..0a4258446f 100644
--- a/Content.Client/Voting/VotePopup.xaml.cs
+++ b/Content.Client/Voting/VotePopup.xaml.cs
@@ -50,12 +50,12 @@ namespace Content.Client.Voting
         public void UpdateData()
         {
             VoteTitle.Text = _vote.Title;
-            VoteCaller.Text = Loc.GetString("{0} called a vote:", _vote.Initiator);
+            VoteCaller.Text = Loc.GetString("ui-vote-created", ("initiator", _vote.Initiator));
 
             for (var i = 0; i < _voteButtons.Length; i++)
             {
                 var entry = _vote.Entries[i];
-                _voteButtons[i].Text = Loc.GetString("{0} ({1})", entry.Text, entry.Votes);
+                _voteButtons[i].Text = Loc.GetString("ui-vote-button", ("text", entry.Text), ("votes", entry.Votes));
 
                 if (_vote.OurVote == i)
                     _voteButtons[i].Pressed = true;
diff --git a/Content.Server/Voting/IVoteHandle.cs b/Content.Server/Voting/IVoteHandle.cs
index a47958b3a5..b4d653f193 100644
--- a/Content.Server/Voting/IVoteHandle.cs
+++ b/Content.Server/Voting/IVoteHandle.cs
@@ -1,4 +1,5 @@
-using Robust.Server.Player;
+using System.Collections.Generic;
+using Robust.Server.Player;
 
 namespace Content.Server.Voting
 {
@@ -10,6 +11,8 @@ namespace Content.Server.Voting
         bool Finished { get; }
         bool Cancelled { get; }
 
+        IReadOnlyDictionary<object, int> VotesPerOption { get; }
+
         event VoteFinishedEventHandler OnFinished;
         bool IsValidOption(int optionId);
         void CastVote(IPlayerSession session, int? optionId);
diff --git a/Content.Server/Voting/VoteManager.DefaultVotes.cs b/Content.Server/Voting/VoteManager.DefaultVotes.cs
index de7676642c..eecf495cb8 100644
--- a/Content.Server/Voting/VoteManager.DefaultVotes.cs
+++ b/Content.Server/Voting/VoteManager.DefaultVotes.cs
@@ -1,6 +1,7 @@
 #nullable enable
 using System;
 using System.Collections.Generic;
+using Content.Shared;
 using Robust.Server.Player;
 using Robust.Shared.IoC;
 using Robust.Shared.Localization;
@@ -15,15 +16,16 @@ namespace Content.Server.Voting
             var alone = _playerManager.PlayerCount == 1 && initiator != null;
             var options = new VoteOptions
             {
-                Title = Loc.GetString("Restart round"),
+                Title = Loc.GetString("ui-vote-restart-title"),
                 Options =
                 {
-                    (Loc.GetString("Yes"), true),
-                    (Loc.GetString("No"), false)
+                    (Loc.GetString("ui-vote-restart-yes"), true),
+                    (Loc.GetString("ui-vote-restart-no"), false)
                 },
                 Duration = alone
                     ? TimeSpan.FromSeconds(10)
-                    : TimeSpan.FromSeconds(30)
+                    : TimeSpan.FromSeconds(30),
+                InitiatorTimeout = TimeSpan.FromMinutes(3)
             };
 
             if (alone)
@@ -33,23 +35,22 @@ namespace Content.Server.Voting
 
             var vote = CreateVote(options);
 
-            vote.OnFinished += (_, args) =>
+            vote.OnFinished += (_, _) =>
             {
-                if (args.Winner == null)
-                {
-                    _chatManager.DispatchServerAnnouncement(Loc.GetString("Restart vote failed due to tie."));
-                    return;
-                }
+                var votesYes = vote.VotesPerOption[true];
+                var votesNo = vote.VotesPerOption[false];
+                var total = votesYes + votesNo;
 
-                var win = (bool) args.Winner;
-                if (win)
+                var ratioRequired = _cfg.GetCVar(CCVars.VoteRestartRequiredRatio);
+                if (votesYes / (float) total >= ratioRequired)
                 {
-                    _chatManager.DispatchServerAnnouncement(Loc.GetString("Restart vote succeeded."));
+                    _chatManager.DispatchServerAnnouncement(Loc.GetString("ui-vote-restart-succeeded"));
                     _ticker.RestartRound();
                 }
                 else
                 {
-                    _chatManager.DispatchServerAnnouncement(Loc.GetString("Restart vote failed."));
+                    _chatManager.DispatchServerAnnouncement(
+                        Loc.GetString("ui-vote-restart-failed", ("ratio", ratioRequired)));
                 }
             };
 
@@ -64,16 +65,16 @@ namespace Content.Server.Voting
         {
             var presets = new Dictionary<string, string>
             {
-                ["traitor"] = "Traitor",
-                ["extended"] = "Extended",
-                ["sandbox"] = "Sandbox",
-                ["suspicion"] = "Suspicion"
+                ["traitor"] = "mode-traitor",
+                ["extended"] = "mode-extended",
+                ["sandbox"] = "mode-sandbox",
+                ["suspicion"] = "mode-suspicion",
             };
 
             var alone = _playerManager.PlayerCount == 1 && initiator != null;
             var options = new VoteOptions
             {
-                Title = Loc.GetString("Next gamemode"),
+                Title = Loc.GetString("ui-vote-gamemode-title"),
                 Duration = alone
                     ? TimeSpan.FromSeconds(10)
                     : TimeSpan.FromSeconds(30)
@@ -98,13 +99,13 @@ namespace Content.Server.Voting
                 {
                     picked = (string) IoCManager.Resolve<IRobustRandom>().Pick(args.Winners);
                     _chatManager.DispatchServerAnnouncement(
-                        Loc.GetString("Tie for gamemode vote! Picking... {0}", Loc.GetString(presets[picked])));
+                        Loc.GetString("ui-vote-gamemode-tie", ("picked", Loc.GetString(presets[picked]))));
                 }
                 else
                 {
                     picked = (string) args.Winner;
                     _chatManager.DispatchServerAnnouncement(
-                        Loc.GetString("{0} won the gamemode vote!", Loc.GetString(presets[picked])));
+                        Loc.GetString("ui-vote-gamemode-win", ("winner", Loc.GetString(presets[picked]))));
                 }
 
                 _ticker.SetStartPreset(picked);
diff --git a/Content.Server/Voting/VoteManager.cs b/Content.Server/Voting/VoteManager.cs
index c6146673e8..3f68b49bc3 100644
--- a/Content.Server/Voting/VoteManager.cs
+++ b/Content.Server/Voting/VoteManager.cs
@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Diagnostics.CodeAnalysis;
@@ -10,11 +11,13 @@ using Content.Shared.Administration;
 using Content.Shared.Network.NetMessages;
 using Content.Shared.Utility;
 using Robust.Server.Player;
+using Robust.Shared.Configuration;
 using Robust.Shared.Enums;
 using Robust.Shared.IoC;
 using Robust.Shared.Localization;
 using Robust.Shared.Network;
 using Robust.Shared.Timing;
+using Robust.Shared.Utility;
 
 #nullable enable
 
@@ -23,6 +26,7 @@ namespace Content.Server.Voting
     public sealed partial class VoteManager : IVoteManager
     {
         [Dependency] private readonly IServerNetManager _netManager = default!;
+        [Dependency] private readonly IConfigurationManager _cfg = default!;
         [Dependency] private readonly IGameTiming _timing = default!;
         [Dependency] private readonly IPlayerManager _playerManager = default!;
         [Dependency] private readonly IChatManager _chatManager = default!;
@@ -320,7 +324,7 @@ namespace Content.Server.Voting
             }
             else
             {
-                options.InitiatorText = Loc.GetString("The server");
+                options.InitiatorText = Loc.GetString("ui-vote-initiator-server");
             }
         }
 
@@ -389,6 +393,8 @@ namespace Content.Server.Voting
             public bool Finished => _reg.Finished;
             public bool Cancelled => _reg.Cancelled;
 
+            public IReadOnlyDictionary<object, int> VotesPerOption { get; }
+
             public event VoteFinishedEventHandler? OnFinished
             {
                 add => _reg.OnFinished += value;
@@ -405,6 +411,8 @@ namespace Content.Server.Voting
             {
                 _mgr = mgr;
                 _reg = reg;
+
+                VotesPerOption = new VoteDict(reg);
             }
 
             public bool IsValidOption(int optionId)
@@ -421,6 +429,62 @@ namespace Content.Server.Voting
             {
                 _mgr.CancelVote(_reg);
             }
+
+            private sealed class VoteDict : IReadOnlyDictionary<object, int>
+            {
+                private readonly VoteReg _reg;
+
+                public VoteDict(VoteReg reg)
+                {
+                    _reg = reg;
+                }
+
+                public IEnumerator<KeyValuePair<object, int>> GetEnumerator()
+                {
+                    return _reg.Entries.Select(e => KeyValuePair.Create(e.Data, e.Votes)).GetEnumerator();
+                }
+
+                IEnumerator IEnumerable.GetEnumerator()
+                {
+                    return GetEnumerator();
+                }
+
+                public int Count => _reg.Entries.Length;
+
+                public bool ContainsKey(object key)
+                {
+                    return TryGetValue(key, out _);
+                }
+
+                public bool TryGetValue(object key, out int value)
+                {
+                    var entry = _reg.Entries.FirstOrNull(a => a.Data.Equals(key));
+                    if (entry != null)
+                    {
+                        value = entry.Value.Votes;
+                        return true;
+                    }
+
+                    value = default;
+                    return false;
+                }
+
+                public int this[object key]
+                {
+                    get
+                    {
+                        if (!TryGetValue(key, out var votes))
+                        {
+                            throw new KeyNotFoundException();
+                        }
+
+                        return votes;
+                    }
+                }
+
+                public IEnumerable<object> Keys => _reg.Entries.Select(c => c.Data);
+                public IEnumerable<int> Values  => _reg.Entries.Select(c => c.Votes);
+            }
         }
 
         #endregion
diff --git a/Content.Shared/CCVars.cs b/Content.Shared/CCVars.cs
index 4ba36ccc3c..1bf009e38b 100644
--- a/Content.Shared/CCVars.cs
+++ b/Content.Shared/CCVars.cs
@@ -275,5 +275,13 @@ namespace Content.Shared
          * Context Menu Grouping Types
          */
         public static readonly CVarDef<int> ContextMenuGroupingType = CVarDef.Create("context_menu", 0, CVar.CLIENTONLY);
+
+        /*
+         * VOTE
+         */
+
+        public static readonly CVarDef<float> VoteRestartRequiredRatio =
+            CVarDef.Create("vote.restart_required_ratio", 0.8f, CVar.SERVERONLY);
+
     }
 }
diff --git a/Resources/Changelog/Parts/restart_votes.yml b/Resources/Changelog/Parts/restart_votes.yml
new file mode 100644
index 0000000000..66ba7c54ad
--- /dev/null
+++ b/Resources/Changelog/Parts/restart_votes.yml
@@ -0,0 +1,4 @@
+author: PJB
+changes:
+  - message: Restart votes now need an 80% majority to succeed, and have a longer cooldown for the caller.
+    type: Tweak
diff --git a/Resources/Locale/en-US/gamemodes/modes.ftl b/Resources/Locale/en-US/gamemodes/modes.ftl
new file mode 100644
index 0000000000..0476001dab
--- /dev/null
+++ b/Resources/Locale/en-US/gamemodes/modes.ftl
@@ -0,0 +1,4 @@
+mode-traitor = Traitor
+mode-extended = Extended
+mode-sandbox = Sandbox
+mode-suspicion = Suspicion
diff --git a/Resources/Locale/en-US/ui/voting.ftl b/Resources/Locale/en-US/ui/voting.ftl
new file mode 100644
index 0000000000..21960ad7ae
--- /dev/null
+++ b/Resources/Locale/en-US/ui/voting.ftl
@@ -0,0 +1,30 @@
+### Voting menu stuff
+
+# Displayed as initiator of vote when no user creates the vote
+ui-vote-initiator-server = The server
+
+ui-vote-restart-title = Restart round
+ui-vote-restart-succeeded = Restart vote succeeded.
+ui-vote-restart-failed = Restart vote failed (need { TOSTRING($ratio, "P0") }).
+ui-vote-restart-yes = Yes
+ui-vote-restart-no = No
+
+ui-vote-gamemode-title = Next gamemode
+ui-vote-gamemode-tie = Tie for gamemode vote! Picking... { $picked }
+ui-vote-gamemode-win = { $winner } won the gamemode vote!
+
+ui-vote-created = { $initiator } has called a vote:
+ui-vote-button  = { $text } ({ $votes })
+
+ui-vote-type-restart = Restart round
+ui-vote-type-gamemode = Next gamemode
+
+# Window title of the vote create menu
+ui-vote-create-title = Call Vote
+# Submit button in the vote create button
+ui-vote-create-button = Call Vote
+# Hue hue hue
+ui-vote-fluff = Powered by Robust™ Anti-Tamper Technology
+
+# Button text in lobby/escape menu
+ui-vote-menu-button = Call vote