Merge pull request #303 from lykoss/fspectate

Spectate changes

messages/en.json

@@ -779,12 +779,14 @@
     "already_up_to_date": "Already up-to-date.",
     "admin_fleave_deadchat": "You have forced {0} to leave the deadchat.",
     "available_mode_setters_help": "Votes to make a specific game mode more likely. Available game mode setters: ",
+    "spectate_help": "Usage: spectate <wolfchat> [on|off]",
     "fspectate_help": "Usage: fspectate <wolfchat|deadchat> [on|off]",
     "fspectate_restricted": "You may not spectate while playing.",
     "fspectate_deadchat_disabled": "Deadchat is disabled and may not be spectated.",
     "fspectate_in_deadchat": "You are currently in deadchat.",
     "fspectate_on": "You are now spectating {0}.",
     "fspectate_off": "You are no longer spectating {0}.",
+    "fspectate_notice": "{0} is now spectating {1}.",
     "maelstrom_dead": "You are dead and cannot join again.",
     "villagergame_lose": "Game over! The villagers realize too late that there are actually no wolves, and never manage to rebuild to what they had before this fiasco. Nobody wins. (Hint: next time if you suspect there are no wolves, have everyone {0}vote {1}.)",
     "villagergame_win": "Game over! The villagers come to their senses and realize there are actually no wolves, the previous deaths having been freak accidents. Everybody wins.",

src/settings.py

@@ -89,6 +89,11 @@ AUTO_SANCTION = (
         (20, 20, {"tempban": 10})
         )
 
+# Send a message to deadchat or wolfchat when a user spectates them
+SPECTATE_NOTICE = True
+# Whether to include which user is doing the spectating in the message
+SPECTATE_NOTICE_USER = False
+
 # The following is a bitfield, and they can be mixed together
 # Defaults to none of these, can be changed on a per-game-mode basis
 RESTRICT_WOLFCHAT = 0x00
@@ -345,7 +350,7 @@ ROLE_COMMAND_EXCEPTIONS = set()
 
 GIF_CHANCE = 1/50
 
-ALL_FLAGS = frozenset("AaDdFgjmNSsw")
+ALL_FLAGS = frozenset("AaDdFgjmNpSsw")
 
 GRAVEYARD_LOCK = threading.RLock()
 WARNING_LOCK = threading.RLock()

src/utilities.py

@@ -170,7 +170,10 @@ def relay_wolfchat_command(cli, nick, message, roles, is_wolf_command=False, is_
     wcwolves = list_players(wcroles)
     wcwolves.remove(nick)
     mass_privmsg(cli, wcwolves, message)
-    mass_privmsg(cli, var.SPECTATING_WOLFCHAT, "[wolfchat] " + message)
+    for player in var.SPECTATING_WOLFCHAT:
+        player.queue_message("[wolfchat] " + message)
+    if var.SPECTATING_WOLFCHAT:
+        player.send_messages()
 
 @proxy.stub
 def chk_nightdone(cli):

src/wolfgame.py

@@ -924,7 +924,7 @@ def join_player(var, wrapper, who=None, forced=False, *, sanity=True):
             # Abandon Hope All Ye Who Enter Here
             leave_deadchat(var, wrapper.source)
             var.SPECTATING_DEADCHAT.discard(wrapper.source)
-            var.SPECTATING_WOLFCHAT.discard(wrapper.source.nick)
+            var.SPECTATING_WOLFCHAT.discard(wrapper.source)
             return True
         var.ROLES["person"].add(wrapper.source.nick)
         var.MAIN_ROLES[wrapper.source] = "person"
@@ -2959,11 +2959,6 @@ def return_to_village(var, chan, target, *, show_message):
 def rename_player(var, user, prefix):
     nick = user.nick
 
-    if var.PHASE in var.GAME_PHASES:
-        if prefix in var.SPECTATING_WOLFCHAT:
-            var.SPECTATING_WOLFCHAT.remove(prefix)
-            var.SPECTATING_WOLFCHAT.add(nick)
-
     event = Event("rename_player", {})
     event.dispatch(user.client, var, prefix, nick) # FIXME: Need to update all the callbacks
 
@@ -3220,7 +3215,7 @@ def leave(var, what, user, why=None):
         killplayer = False
 
     channels.Main.send(msg.format(user, get_reveal_role(user.nick)) + population) # FIXME: Need to fix this once get_reveal_role() accepts User instances
-    var.SPECTATING_WOLFCHAT.discard(user.nick) # FIXME: Need to fix this once the variable holds User instances
+    var.SPECTATING_WOLFCHAT.discard(user)
     var.SPECTATING_DEADCHAT.discard(user)
     leave_deadchat(var, user)
 
@@ -5128,10 +5123,16 @@ def relay(var, wrapper, message):
         if message.startswith("\u0001ACTION"):
             message = message[7:-1]
             mass_privmsg(wrapper.client, to_msg, "* \u0002{0}\u0002{1}".format(wrapper.source, message))
-            mass_privmsg(wrapper.client, var.SPECTATING_WOLFCHAT, "* [wolfchat] \u0002{0}\u0002{1}".format(wrapper.source, message))
+            for player in var.SPECTATING_WOLFCHAT:
+                player.queue_message("* [wolfchat] \u0002{0}\u0002{1}".format(wrapper.source, message))
+            if var.SPECTATING_WOLFCHAT:
+                player.send_messages()
         else:
             mass_privmsg(wrapper.client, to_msg, "\u0002{0}\u0002 says: {1}".format(wrapper.source, message))
-            mass_privmsg(wrapper.client, var.SPECTATING_WOLFCHAT, "[wolfchat] \u0002{0}\u0002 says: {1}".format(wrapper.source, message))
+            for player in var.SPECTATING_WOLFCHAT:
+                player.queue_message("[wolfchat] \u0002{0}\u0002 says: {1}".format(wrapper.source, message))
+            if var.SPECTATING_WOLFCHAT:
+                player.send_messages()
 
 @handle_error
 def transition_night(cli):
@@ -6908,9 +6909,7 @@ def can_run_restricted_cmd(user):
 
     return True
 
-@command("spectate", "fspectate", flag="a", pm=True, phases=("day", "night"))
+def spectate_chat(var, wrapper, message, *, is_fspectate):
-def fspectate(var, wrapper, message):
-    """Spectate wolfchat or deadchat."""
     if not can_run_restricted_cmd(wrapper.source):
         wrapper.pm(messages["fspectate_restricted"])
         return
@@ -6923,32 +6922,50 @@ def fspectate(var, wrapper, message):
     elif len(params) > 1:
         on = params[1].lower()
     what = params[0].lower()
-    if what not in ("wolfchat", "deadchat") or on not in ("on", "off"):
+    allowed = ("wolfchat", "deadchat") if is_fspectate else ("wolfchat",)
-        wrapper.pm(messages["fspectate_help"])
+    if what not in allowed or on not in ("on", "off"):
+        wrapper.pm(messages["fspectate_help" if is_fspectate else "spectate_help"])
         return
 
     if on == "off":
         if what == "wolfchat":
-            var.SPECTATING_WOLFCHAT.discard(wrapper.source.nick)
+            var.SPECTATING_WOLFCHAT.discard(wrapper.source)
         else:
             var.SPECTATING_DEADCHAT.discard(wrapper.source)
         wrapper.pm(messages["fspectate_off"].format(what))
     else:
         players = []
         if what == "wolfchat":
-            var.SPECTATING_WOLFCHAT.add(wrapper.source.nick)
+            already_spectating = wrapper.source in var.SPECTATING_WOLFCHAT
-            players = [p for p in list_players() if in_wolflist(p, p)]
+            var.SPECTATING_WOLFCHAT.add(wrapper.source)
+            players = [p for p in get_players() if in_wolflist(p.nick, p.nick)]
+            if not is_fspectate and not already_spectating and var.SPECTATE_NOTICE:
+                spectator = wrapper.source.nick if var.SPECTATE_NOTICE_USER else "Someone"
+                for player in players:
+                    player.queue_message(messages["fspectate_notice"].format(spectator, what))
+                if players:
+                    player.send_messages()
         elif var.ENABLE_DEADCHAT:
             if wrapper.source in var.DEADCHAT_PLAYERS:
                 wrapper.pm(messages["fspectate_in_deadchat"])
                 return
             var.SPECTATING_DEADCHAT.add(wrapper.source)
-            players = [user.nick for user in var.DEADCHAT_PLAYERS]
+            players = var.DEADCHAT_PLAYERS
         else:
             wrapper.pm(messages["fspectate_deadchat_disabled"])
             return
         wrapper.pm(messages["fspectate_on"].format(what))
-        wrapper.pm("People in {0}: {1}".format(what, ", ".join(players)))
+        wrapper.pm("People in {0}: {1}".format(what, ", ".join([player.nick for player in players])))
+
+@command("spectate", flag="p", pm=True, phases=("day", "night"))
+def spectate(var, wrapper, message):
+    """Spectate wolfchat or deadchat."""
+    spectate_chat(var, wrapper, message, is_fspectate=False)
+
+@command("fspectate", flag="F", pm=True, phases=("day", "night"))
+def fspectate(var, wrapper, message):
+    """Spectate wolfchat or deadchat."""
+    spectate_chat(var, wrapper, message, is_fspectate=True)
 
 @command("revealroles", flag="a", pm=True, phases=("day", "night"))
 def revealroles(var, wrapper, message):