Feat: settime chat command #702

ToeKneeRED · 2024-08-15T00:48:18Z

It is about the same if not the same as the previous PR for it from cosi.
Adds a /settime chat command that can be used on any server that is not public.

Ideally, there would be some feedback from the server that it succeeded or failed besides the time change (e.g. a localized chat message, but that turned out to be too complex for me).

EDIT:
Since admins should be the only ones allowed to use the /settime chat command, there are now two different ways of becoming an admin; either by joining the server using the admin password specified in the STServer.ini file, or using the new /AddAdmin console command.
Unfortunately, spaces in names seem to be nearly impossible to deal with without replacing the characters and re-checking for the name over and over again. For the sake of this PR, you can't /AddAdmin or /RemoveAdmin on a name with an underscore in it as that is what is used to replace since spaces are more likely to be in names rather than underscores.

Three new console commands:

/AddAdmin : add the player with the username given to the adminSessions Set
ex.
/AddAdmin Toe_Knee = Toe Knee
/AddAdmin ToeKnee = ToeKnee
/RemoveAdmin : remove the player with the username given from the adminSessions Set
/admins: list out all admins

The PR also now includes a fix for a crash with the ConsoleRegistry's manual resize once it reaches a size() of 10 (it tried to erase m_commandHistory.end()).

Properly sets time for connected players, but with no system chat message

…olution into feat/setTime

* tweak: Add Services, World, and GameServer bindings GameServer_Bindings: - SendGlobalChatMessage - SetTime Player_Bindings: - IsPartyLeader Service_Bindings: - "get" for all services - CalendarService : GetTimeScale - PartyService : IsPlayerInParty World_Bindings: - "get" * tweak: bool return for GameServer SetTime * tweak: Add onSetTime scripting event * tweak: Set up for settime chat command * tweak: different .cpp binding file for each service

- /AddAdmin: add the player with the username given to the adminSessions Set - /RemoveAdmin: remove the player with the username given from the adminSessions Set - /admins: list out all admins

also includes a fix for crashing after 10 commands are sent to the server

Properly sets time for connected players, but with no system chat message

- /AddAdmin: add the player with the username given to the adminSessions Set - /RemoveAdmin: remove the player with the username given from the adminSessions Set - /admins: list out all admins

also includes a fix for crashing after 10 commands are sent to the server

…olution into feat/setTime

ToeKneeRED · 2024-08-18T01:02:35Z

Since admins should be the only ones allowed to use the /settime chat command, there are now two different ways of becoming an admin; either by joining the server using the admin password specified in the STServer.ini file, or using the new /AddAdmin console command.
Unfortunately, spaces in names seem to be nearly impossible to deal with without replacing the characters and re-checking for the name over and over again. For the sake of this PR, you can't /AddAdmin or /RemoveAdmin on a name with an underscore in it as that is what is used to replace since spaces are more likely to be in names rather than underscores.

Three new console commands:

/AddAdmin <username>: add the player with the username given to the adminSessions Set
ex.
/AddAdmin Toe_Knee = Toe Knee
/AddAdmin ToeKnee = ToeKnee
/RemoveAdmin <username>: remove the player with the username given from the adminSessions Set
/admins: list out all admins

The PR also now includes a fix for a crash with the ConsoleRegistry's manual resize once it reaches a size() of 10 (it tried to erase m_commandHistory.end()).

Force67

Also please run clang format python script (tools/scripts/clang_format.py) over your changes.

Force67 · 2024-08-21T08:40:10Z

Code/server/GameServer.cpp

@@ -383,6 +391,129 @@ void GameServer::BindServerCommands()
                out->error("Day must be between 0 and 31, month must be between 0 and 11, and year must be between 0 and 999.");
            }
        });
+
+    m_commands.RegisterCommand<std::string>(
+        "AddAdmin", "Add admin privileges from player", [&](Console::ArgStack& aStack) {


Force67 · 2024-08-21T08:41:27Z

Code/server/GameServer.cpp

+            if (!playerFound)
+            {
+                // space in username handling
+                String backupUsername = cUsername;


Should factor out the user name sanitizing / cleaning into a separate utility fn.

Fixed with GameServer::SanitizeUsername (currently only replaces any _ with space if name is not found the first time through)

Force67 · 2024-08-21T08:42:05Z

Code/server/GameServer.cpp

+
+            for (const auto& cAdmin : m_adminSessions)
+            {
+                Player* pPlayer = PlayerManager::Get()->GetByConnectionId(cAdmin);


Probably the get user by name stuff too. maybe have a fn there to get a user by name.

Added two things for this, GameServer::GetAdminByUsername and PlayerManager::GetByUsername
Reworked that part to adapt it in as well

Force67 · 2024-08-21T08:43:07Z

Code/server/GameServer.cpp

+            for (const auto& cAdmin : m_adminSessions)
+            {
+                const auto& cUsername = PlayerManager::Get()->GetByConnectionId(cAdmin)->GetUsername();
+


Even though unlikely, we should still handle if GetConnectionId somehow returns null

Now has a nullptr check and prints to console if m_adminSessions contains a session it shouldn't

Force67 · 2024-08-21T08:45:19Z

Code/client/Services/TransportService.h


 protected:
    // Event handlers
    void HandleUpdate(const UpdateEvent& acEvent) noexcept;
+    void HandleConnect(const ConnectedEvent& acEvent) noexcept;


We should for safety reasons tombstone the localplayerid on disconnect. e.g. set it to invalid.

Fixed with new HandleDisconnected

Force67 · 2024-08-21T08:46:24Z

Code/server/GameServer.cpp

@@ -747,8 +879,14 @@ void GameServer::HandleAuthenticationRequest(const ConnectionId_t aConnectionId,
    }

    // check if the proper server password was supplied.
-    if (acRequest->Token == sPassword.value())
+    if (acRequest->Token == sPassword.value() || (acRequest->Token == sAdminPassword.value() && !sAdminPassword.empty()))


might be nicer to assign the result of the second expr to a boolean then we can also use the result below

Fixed with additional bool above

Force67 · 2024-08-21T08:46:40Z

Code/server/GameServer.h

+    {
+        m_isPublic = aIsPublic;
+    }
+    bool IsPublic() const noexcept


Force67 · 2024-08-21T08:48:49Z

Code/server/GameServer.h

@@ -78,6 +78,14 @@ struct GameServer final : Server
    {
        return m_isPasswordProtected;
    }
+    void SetPublic(bool aIsPublic) noexcept


There is no need for this. the value if a server is "public" is contained by bAnnounceServer convar. if you need it from another cpp file, you can extern Convar name it.

Removed it, and the reference to it that was in ServerListService

formatted all files except those that were in the scripting expansion

ToeKneeRED · 2024-08-21T16:22:34Z

clang-format'd all files except those in the scripting expansion because I accidentally rebased instead of merge and it wants to re-add those files

rfortier · 2024-08-26T17:34:54Z

I'm late to the party since this was just merged. But I added it to the latest Modded Animation pre-release binary build, after verifying (shocker, it just works). So we can get a few more testers hands-on before a Master release.

ToeKneeRED added 20 commits August 9, 2024 16:44

feat: WIP settime chat command

6382886

Properly sets time for connected players, but with no system chat message

feat: WIP settime chat command

952b72e

Properly sets time for connected players, but with no system chat message

Merge branch 'feat/setTime' of https://github.com/ToeKneeRED/TiltedEv…

8aeecb9

…olution into feat/setTime

tweak: some cleanup

dd7ae08

tweak: more cleanup

22b82ad

tweak: unfix world

9e14544

tweak: final touches

d8679db

feat: require admin password to use settime chat command

e6250c4

feat: /AddAdmin, /RemoveAdmin /admins console commands

a9e535a

- /AddAdmin: add the player with the username given to the adminSessions Set - /RemoveAdmin: remove the player with the username given from the adminSessions Set - /admins: list out all admins

tweak: hacky fix for spaces in usernames for /AddAdmin and /RemoveAdmin

bf963a9

also includes a fix for crashing after 10 commands are sent to the server

feat: WIP settime chat command

9be5c52

Properly sets time for connected players, but with no system chat message

tweak: some cleanup

a3f03b2

tweak: more cleanup

c298c29

tweak: unfix world

02c0b2d

tweak: final touches

4be55c0

feat: require admin password to use settime chat command

cb8c5fa

feat: /AddAdmin, /RemoveAdmin /admins console commands

57aeaca

- /AddAdmin: add the player with the username given to the adminSessions Set - /RemoveAdmin: remove the player with the username given from the adminSessions Set - /admins: list out all admins

tweak: hacky fix for spaces in usernames for /AddAdmin and /RemoveAdmin

f771f8c

also includes a fix for crashing after 10 commands are sent to the server

Merge branch 'feat/setTime' of https://github.com/ToeKneeRED/TiltedEv…

62e84a5

…olution into feat/setTime

Force67 requested changes Aug 21, 2024

View reviewed changes

ToeKneeRED added 2 commits August 21, 2024 11:23

tweak: review changes minus clang format

4b2fc01

tweak: clang format

4563e3e

formatted all files except those that were in the scripting expansion

tweak: admin password used bool

5184f3b

Force67 approved these changes Aug 23, 2024

View reviewed changes

tweak: yeet ispublic bool member from GameServer

7c5e2af

Force67 merged commit 6adb5d0 into tiltedphoques:dev Aug 25, 2024
0 of 2 checks passed

ToeKneeRED deleted the feat/setTime branch August 25, 2024 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: settime chat command #702

Feat: settime chat command #702

ToeKneeRED commented Aug 15, 2024 •

edited

Loading

ToeKneeRED commented Aug 18, 2024

Force67 left a comment

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

Force67 Aug 21, 2024

Force67 Aug 21, 2024

ToeKneeRED Aug 21, 2024

ToeKneeRED commented Aug 21, 2024

rfortier commented Aug 26, 2024

Feat: settime chat command #702

Feat: settime chat command #702

Conversation

ToeKneeRED commented Aug 15, 2024 • edited Loading

ToeKneeRED commented Aug 18, 2024

Force67 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ToeKneeRED commented Aug 21, 2024

rfortier commented Aug 26, 2024

ToeKneeRED commented Aug 15, 2024 •

edited

Loading