Add attendance counter to sideops

Author: Gehock

config.py

@@ -72,13 +72,22 @@
     "j",
 ]
 
-# ATTENDANCE_EMOJI = "\N{HEAVY PLUS SIGN}"
-ATTENDANCE_EMOJI = None
+# By default, the number of attendees will only be displayed for sideops
+ALWAYS_DISPLAY_ATTENDANCE = False
 
-EXTRA_EMOJIS: List[str] = [
+ATTENDANCE_EMOJI = "\N{HEAVY PLUS SIGN}"
+
+# These are emojis that can be added to the event but are ignored when a user
+# reacts to them
+IGNORED_EMOJIS: List[str] = [
     # ATTENDANCE_EMOJI
 ]
 
+# The are emojis that are handled separately from regular sign-up emojis
+SPECIAL_EMOJIS: List[str] = [
+    ATTENDANCE_EMOJI,
+]
+
 PLATOON_SIZES = ['1PLT', '2PLT', 'sideop', 'WW2side']
 
 # Dummy: an empty spacer. An embed can only have either one or three

errors.py

@@ -24,3 +24,7 @@ class RoleError(Exception):
 
 class RoleTaken(Exception):
     pass
+
+
+class UnknownEmoji(Exception):
+    pass

event.py

@@ -32,6 +32,13 @@ def __init__(self, id: int = None, display_name: str = None):
         self.id = id
         self.display_name = display_name
 
+    def __eq__(self, other: Union['User', discord.abc.User]):
+        # This makes it so that User objects can be compared to
+        # discord.abc.User by doing `user == discord.abc.User`. The comparison
+        # will not work in the other direction because discord.abc.User checks
+        # for the object type.
+        return self.id == other.id
+
 
 class Event:
 
@@ -49,6 +56,8 @@ def __init__(self, date: datetime.datetime, guildEmojis: Tuple[Emoji, ...],
         self.messageID = 0
         self.id = eventID
         self.sideop = sideop
+        self.attendees: list[User] = []
+
         if platoon_size is None:
             if sideop:
                 self.platoon_size = "sideop"
@@ -254,7 +263,11 @@ def createEmbed(self) -> Embed:
                                      value="\N{ZERO WIDTH SPACE}",
                                      inline=group.isInline)
 
-        eventEmbed.set_footer(text="Event ID: " + str(self.id))
+        if self.sideop or cfg.ALWAYS_DISPLAY_ATTENDANCE:
+            attendees = f"Attendees: {len(self.attendees)}\n\n"
+        else:
+            attendees = ""
+        eventEmbed.set_footer(text=f"{attendees}Event ID: {str(self.id)}")
 
         return eventEmbed
 
@@ -470,6 +483,21 @@ def findSignupRole(self, userID) -> Optional[Role]:
         # TODO: raise RoleNotFound instead of returning None?
         return None
 
+    def has_attendee(self, user: discord.abc.User) -> bool:
+        """Check if the given user has been marked as attending."""
+        return user in self.attendees
+
+    def add_attendee(self, user: discord.abc.User) -> None:
+        """Add user to the attendance list"""
+        if not self.has_attendee(user):
+            self.attendees.append(
+                User(id=user.id, display_name=user.display_name))
+
+    def remove_attendee(self, user: discord.abc.User) -> None:
+        """Remove user from the attendance list"""
+        if self.has_attendee(user):
+            self.attendees.remove(user)
+
     def __str__(self):
         return f"{self.title} (ID {self.id}) at {self.date}"
 
@@ -481,6 +509,10 @@ def toJson(self, brief_output=False) -> Dict[str, Any]:
         for groupName, roleGroup in self.roleGroups.items():
             roleGroupsData[groupName] = roleGroup.toJson(brief_output)
 
+        attendees_data = {}
+        for user in self.attendees:
+            attendees_data[user.id] = user.display_name
+
         data: Dict[str, Any] = {}
         data["title"] = self.title
         data["date"] = self.date.strftime("%Y-%m-%d")
@@ -495,6 +527,7 @@ def toJson(self, brief_output=False) -> Dict[str, Any]:
             data["messageID"] = self.messageID
             data["platoon_size"] = self.platoon_size
             data["sideop"] = self.sideop
+            data["attendees"] = attendees_data
         data["roleGroups"] = roleGroupsData
         return data
 
@@ -513,6 +546,10 @@ def fromJson(self, eventID, data: dict, emojis, manual_load=False):
             self.messageID = int(data.get("messageID", 0))
             self.platoon_size = str(data.get("platoon_size", PLATOON_SIZE))
             self.sideop = bool(data.get("sideop", False))
+            attendees_data = data.get("attendees", {})
+            for userID, name in attendees_data.items():
+                self.attendees.append(User(int(userID), name))
+
         # TODO: Handle missing roleGroups
         groups: List[str] = []
         for groupName, roleGroupData in data["roleGroups"].items():

eventListener.py

@@ -9,7 +9,7 @@
 
 import config as cfg
 import messageFunctions as msgFnc
-from errors import EventNotFound, RoleNotFound, RoleTaken
+from errors import EventNotFound, RoleNotFound, RoleTaken, UnknownEmoji
 from event import Event
 from eventDatabase import EventDatabase
 from operationbot import OperationBot
@@ -50,7 +50,7 @@ async def on_raw_reaction_add(self, payload: RawReactionActionEvent):
             # Bot's own reaction, or reaction outside of the event channel
             return
 
-        if payload.emoji.name in cfg.EXTRA_EMOJIS:
+        if payload.emoji.name in cfg.IGNORED_EMOJIS:
             return
 
         message: Message = await self.bot.eventchannel.fetch_message(
@@ -78,16 +78,20 @@ async def on_raw_reaction_add(self, payload: RawReactionActionEvent):
                 f"{message.jump_url}")
             return
         else:
-            await self._handle_signup(event, payload.emoji, user, message)
+            if payload.emoji.is_custom_emoji():
+                emoji: Union[PartialEmoji, str] = payload.emoji
+            else:
+                emoji = cast(str, payload.emoji.name)
 
-    async def _handle_signup(self, event: Event, partial_emoji: PartialEmoji,
-                             user: User, message: Message):
-        # Get emoji string
-        if partial_emoji.is_custom_emoji():
-            emoji: Union[PartialEmoji, str] = partial_emoji
-        else:
-            emoji = cast(str, partial_emoji.name)
+            if payload.emoji.name in cfg.SPECIAL_EMOJIS:
+                await self._handle_special_emoji(event, emoji, user,
+                                                 message)
+            else:
+                await self._handle_signup(event, emoji, user, message)
 
+    async def _handle_signup(self, event: Event,
+                             emoji: Union[PartialEmoji, str], user: User,
+                             message: Message):
         # Find signup of user
         old_signup: Optional[Role] = event.findSignupRole(user.id)
 
@@ -156,6 +160,21 @@ async def _handle_signup(self, event: Event, partial_emoji: PartialEmoji,
 
         await self.bot.logchannel.send(text)
 
+    async def _handle_special_emoji(self, event: Event,
+                                    emoji: Union[PartialEmoji, str],
+                                    user: User, message: Message):
+
+        if emoji == cfg.ATTENDANCE_EMOJI:
+            if event.has_attendee(user):
+                event.remove_attendee(user)
+            else:
+                event.add_attendee(user)
+            await msgFnc.updateMessageEmbed(message, event)
+            EventDatabase.toJson()
+        else:
+            raise UnknownEmoji(f"Reaction to unknown special emoji {emoji} "
+                               f"in event {event} by user {user}")
+
     @Cog.listener()
     async def on_message(self, message: Message):
         if message.author == self.bot.user: