From d82e6b8e592a988f74756c326b4858feb8ead713 Mon Sep 17 00:00:00 2001
From: Salanto <62221668+Salanto@users.noreply.github.com>
Date: Sun, 22 May 2022 14:34:51 +0200
Subject: [PATCH] Disable music change for spectator (#21)

* Disable music change for spectator

* Appease clang-format

* Properly handle this bullshit.
---
 core/include/aoclient.h | 29 +++++++++++++++++++++++++++++
 core/src/aoclient.cpp   | 12 ++++++++++++
 core/src/packets.cpp    | 12 +++++++++++-
 3 files changed, 52 insertions(+), 1 deletion(-)

diff --git a/core/include/aoclient.h b/core/include/aoclient.h
index bcf33ad..3c06c5c 100644
--- a/core/include/aoclient.h
+++ b/core/include/aoclient.h
@@ -316,6 +316,11 @@ class AOClient : public QObject
      */
     bool m_is_logging_in = false;
 
+    /**
+     * @brief If true, the client is a spectator and his IC interactions will be limtied.
+     */
+    bool m_is_spectator = false;
+
     /**
      * @brief Checks if the client's ACL role has permission for the given permission.
      *
@@ -325,6 +330,30 @@ class AOClient : public QObject
      */
     bool checkPermission(ACLRole::Permission f_permission) const;
 
+    /**
+     * @brief Returns if the client is a spectator.
+     *
+     * @return True if the client is a spectator, false otherwise.
+     */
+    bool isSpectator() const;
+
+    /**
+     * @brief Sets the spectator state for the client.
+     *
+     * @param f_spectator
+     */
+    void setSpectator(bool f_spectator);
+
+    /**
+     * @brief The spectator character ID
+     *
+     * @details You may assume that AO has a sane way to determine if a user is a spectator
+     * or an actual player. Well, to nobodys surprise, this is not the case, so the character id -1 is used
+     * to determine if a client has entered spectator or user mode. I am making this a const mostly
+     * for the case this could change at some point in the future, but don't count on it.
+     */
+    const int SPECTATOR_ID = -1;
+
   public slots:
     /**
      * @brief A slot for when the client disconnects from the server.
diff --git a/core/src/aoclient.cpp b/core/src/aoclient.cpp
index 656fc6a..80e18fd 100644
--- a/core/src/aoclient.cpp
+++ b/core/src/aoclient.cpp
@@ -303,6 +303,8 @@ bool AOClient::changeCharacter(int char_id)
 
     if (char_id < 0) {
         m_current_char = "";
+        m_char_id = char_id;
+        setSpectator(true);
     }
 
     if (l_successfulChange == true) {
@@ -518,6 +520,16 @@ bool AOClient::isAuthenticated() const
 
 Server *AOClient::getServer() { return server; }
 
+void AOClient::setSpectator(bool f_spectator)
+{
+    m_is_spectator = f_spectator;
+}
+
+bool AOClient::isSpectator() const
+{
+    return m_is_spectator;
+}
+
 void AOClient::onAfkTimeout()
 {
     if (!m_is_afk)
diff --git a/core/src/packets.cpp b/core/src/packets.cpp
index 83bbe53..f59a36d 100644
--- a/core/src/packets.cpp
+++ b/core/src/packets.cpp
@@ -194,11 +194,15 @@ void AOClient::pktSelectChar(AreaData *area, int argc, QStringList argv, AOPacke
     bool argument_ok;
     int l_selected_char_id = argv[1].toInt(&argument_ok);
     if (!argument_ok) {
-        l_selected_char_id = -1;
+        l_selected_char_id = SPECTATOR_ID;
     }
 
     if (changeCharacter(l_selected_char_id))
         m_char_id = l_selected_char_id;
+
+    if (m_char_id > SPECTATOR_ID) {
+        setSpectator(false);
+    }
 }
 
 void AOClient::pktIcChat(AreaData *area, int argc, QStringList argv, AOPacket packet)
@@ -302,6 +306,12 @@ void AOClient::pktChangeMusic(AreaData *area, int argc, QStringList argv, AOPack
 
     if (server->getMusicList().contains(l_argument) || m_music_manager->isCustom(m_current_area, l_argument) || l_argument == "~stop.mp3") { // ~stop.mp3 is a dummy track used by 2.9+
         // We have a song here
+
+        if (m_is_spectator) {
+            sendServerMessage("Spectator are blocked from changing the music.");
+            return;
+        }
+
         if (m_is_dj_blocked) {
             sendServerMessage("You are blocked from changing the music.");
             return;