REF: Disabled the Spotify Module for now due to API issues

FEAT: Fixed Spotify so that if it is used, it can be used by multiple users
DOC: Changed the XP to have a cooldown of 30s

config.py

@@ -18,7 +18,6 @@ YOUTUBE_API_KEY = os.getenv("YOUTUBE_API_KEY")
 
 # List of enabled modules
 ENABLED_MODULES = [
-    "modules.media.spotify_module",
     "modules.user.birthday_module",
     "modules.user.xp_module",
     "modules.money.currency_module",

modules/media/spotify_module.py

@@ -1,21 +1,27 @@
 import logging
-
 import discord
-import spotipy
 from discord import app_commands
+import spotipy
 from spotipy.oauth2 import SpotifyOAuth
-
 import config
 
 # Set up logging
 logging.basicConfig(level=logging.DEBUG)
 logger = logging.getLogger(__name__)
 
-
 class SpotifyModule:
     def __init__(self, bot):
         self.bot = bot
-        self.sp = spotipy.Spotify(
+        self.user_sessions = {}  # To store user-specific Spotify sessions
+        self.auth_managers = {}  # To store auth managers for each user
+        self.add_commands()
+
+    def get_spotify_session(self, user_id):
+        return self.user_sessions.get(user_id, None)
+
+    def add_commands(self):
+        @app_commands.command(name="login_spotify", description="Login to Spotify")
+        async def login_spotify(interaction: discord.Interaction):
             auth_manager = SpotifyOAuth(
                 client_id=config.SPOTIPY_CLIENT_ID,
                 client_secret=config.SPOTIPY_CLIENT_SECRET,
@@ -24,18 +30,47 @@ class SpotifyModule:
                     "user-library-read user-read-playback-state "
                     "user-modify-playback-state user-read-currently-playing"
                 ),
+                cache_path=f".cache-{interaction.user.id}"  # Store tokens per user
             )
+            auth_url = auth_manager.get_authorize_url()
+            self.auth_managers[interaction.user.id] = auth_manager
+            await interaction.response.send_message(
+                f"Please log in to Spotify: [Login]({auth_url})\n"
+                "After logging in, please send the `/verify_spotify` command with the URL you were redirected to."
             )
-        self.add_commands()
 
-    def add_commands(self):
+        @app_commands.command(name="verify_spotify", description="Verify Spotify login")
-        @app_commands.command(
+        async def verify_spotify(interaction: discord.Interaction, callback_url: str):
-            name="current_track", description="Get the currently playing song"
+            user_id = interaction.user.id
-        )
+            if user_id not in self.auth_managers:
+                await interaction.response.send_message("Please initiate login first using /login_spotify.")
+                return
+
+            auth_manager = self.auth_managers[user_id]
+            try:
+                code = auth_manager.parse_response_code(callback_url)
+                token_info = auth_manager.get_access_token(code)
+
+                if token_info:
+                    sp = spotipy.Spotify(auth_manager=auth_manager)
+                    self.user_sessions[user_id] = sp
+                    await interaction.response.send_message("Logged in to Spotify. You can now use Spotify commands.")
+                    del self.auth_managers[user_id]  # Clean up the used auth manager
+                else:
+                    await interaction.response.send_message("Failed to verify Spotify login. Please try again.")
+            except Exception as e:
+                logger.error(f"Error verifying Spotify login: {e}", exc_info=True)
+                await interaction.response.send_message(f"Failed to verify Spotify login: {e}")
+
+        @app_commands.command(name="current_track", description="Get the currently playing song")
         async def current_track(interaction: discord.Interaction):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                current = self.sp.currently_playing()
+                current = sp.currently_playing()
                 if current is None or current["item"] is None:
                     await interaction.followup.send(
                         embed=discord.Embed(
@@ -53,25 +88,23 @@ class SpotifyModule:
                         description=f"{track['name']} by {artist}",
                         color=discord.Color.green(),
                     )
-                    embed.add_field(
+                    embed.add_field(name="Album", value=track["album"]["name"], inline=False)
-                        name="Album", value=track["album"]["name"], inline=False
-                    )
                     embed.set_thumbnail(url=track["album"]["images"][0]["url"])
                     await interaction.followup.send(embed=embed)
-                    logger.info(
+                    logger.info(f"Currently playing: {track['name']} by {artist}")
-                        f"Currently playing: {track['name']} by {artist}"
-                    )  # noqa: E501
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in current_track command: {e}")
 
-        @app_commands.command(
+        @app_commands.command(name="play_track", description="Play a track by searching for it")
-            name="play_track", description="Play a track by searching for it"
-        )
         async def play_track(interaction: discord.Interaction, query: str):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                results = self.sp.search(q=query, limit=1, type="track")
+                results = sp.search(q=query, limit=1, type="track")
                 if not results["tracks"]["items"]:
                     await interaction.followup.send(
                         embed=discord.Embed(
@@ -86,51 +119,58 @@ class SpotifyModule:
                 track = results["tracks"]["items"][0]
                 uri = track["uri"]
 
-                devices = self.sp.devices()
+                devices = sp.devices()
                 if not devices["devices"]:
                     await interaction.followup.send(
                         embed=discord.Embed(
                             title="Play Track",
-                            description="No active devices found."
+                            description="No active devices found. Please open Spotify on a device.",
-                            "Please open Spotify on a device.",
                             color=discord.Color.red(),
                         )
                     )
                     logger.info("No active devices found for playback")
                     return
 
-                self.sp.start_playback(uris=[uri])
+                sp.start_playback(uris=[uri])
                 embed = discord.Embed(
                     title="Now Playing",
-                    description=f"{track['name']} by {', '.join([a['name'] for a in track['artists']])}",  # noqa: E501
+                    description=f"{track['name']} by {', '.join([a['name'] for a in track['artists']])}",
                     color=discord.Color.green(),
                 )
-                embed.add_field(
+                embed.add_field(name="Album", value=track["album"]["name"], inline=False)
-                    name="Album", value=track["album"]["name"], inline=False
-                )
                 embed.set_thumbnail(url=track["album"]["images"][0]["url"])
                 await interaction.followup.send(embed=embed)
-                logger.info(
+                logger.info(f"Now playing: {track['name']} by {', '.join([a['name'] for a in track['artists']])}")
-                    f"Now playing: {track['name']} by {', '.join([a['name'] for a in track['artists']])}"
+            except spotipy.SpotifyException as e:
-                )  # noqa: E501
+                if e.http_status == 403:
+                    await interaction.followup.send(
+                        embed=discord.Embed(
+                            title="Play Track",
+                            description="Permission denied. Please check your Spotify account settings.",
+                            color=discord.Color.red(),
+                        )
+                    )
+                    logger.error(f"Permission denied: {e}")
+                else:
+                    await interaction.followup.send(f"An error occurred: {e}")
+                    logger.error(f"Error in play_track command: {e}")
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in play_track command: {e}")
 
-        @app_commands.command(
+        @app_commands.command(name="play_playlist", description="Play a playlist by searching for it or providing a link")
-            name="play_playlist",
-            description="Play a playlist by searching for it" "or providing a link",
-        )
         async def play_playlist(interaction: discord.Interaction, query: str):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                # Check if the query is a link
                 if query.startswith("https://open.spotify.com/playlist/"):
                     uri = query.split("/")[-1].split("?")[0]
                     uri = f"spotify:playlist:{uri}"
                 else:
-                    # Search for the playlist
+                    results = sp.search(q=query, limit=1, type="playlist")
-                    results = self.sp.search(q=query, limit=1, type="playlist")
                     if not results["playlists"]["items"]:
                         await interaction.followup.send(
                             embed=discord.Embed(
@@ -144,46 +184,54 @@ class SpotifyModule:
                     playlist = results["playlists"]["items"][0]
                     uri = playlist["uri"]
 
-                devices = self.sp.devices()
+                devices = sp.devices()
                 if not devices["devices"]:
                     await interaction.followup.send(
                         embed=discord.Embed(
                             title="Play Playlist",
-                            description="No active devices found."
+                            description="No active devices found. Please open Spotify on a device.",
-                            "Please open Spotify on a device.",
                             color=discord.Color.red(),
                         )
                     )
                     logger.info("No active devices found for playback")
                     return
 
-                self.sp.start_playback(context_uri=uri)
+                sp.start_playback(context_uri=uri)
                 embed = discord.Embed(
                     title="Now Playing Playlist",
-                    description=(
+                    description=f"{playlist['name']} by {playlist['owner']['display_name']}" if not query.startswith("https://open.spotify.com/playlist/") else "Playing playlist",
-                        f"{playlist['name']} by {playlist['owner']['display_name']}"
-                        if not query.startswith("https://open.spotify.com/playlist/")
-                        else "Playing playlist"
-                    ),  # noqa: E501
                     color=discord.Color.green(),
                 )
                 if not query.startswith("https://open.spotify.com/playlist/"):
                     embed.set_thumbnail(url=playlist["images"][0]["url"])
                 await interaction.followup.send(embed=embed)
-                logger.info(
+                logger.info(f"Now playing playlist: {playlist['name']} by {playlist['owner']['display_name']}")
-                    f"Now playing playlist: {playlist['name']} by {playlist['owner']['display_name']}"
+            except spotipy.SpotifyException as e:
-                )  # noqa: E501
+                if e.http_status == 403:
+                    await interaction.followup.send(
+                        embed=discord.Embed(
+                            title="Play Playlist",
+                            description="Permission denied. Please check your Spotify account settings.",
+                            color=discord.Color.red(),
+                        )
+                    )
+                    logger.error(f"Permission denied: {e}")
+                else:
+                    await interaction.followup.send(f"An error occurred: {e}")
+                    logger.error(f"Error in play_playlist command: {e}")
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in play_playlist command: {e}")
 
-        @app_commands.command(
+        @app_commands.command(name="pause", description="Pause the currently playing track")
-            name="pause", description="Pause the currently playing track"
-        )
         async def pause(interaction: discord.Interaction):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                self.sp.pause_playback()
+                sp.pause_playback()
                 await interaction.followup.send(
                     embed=discord.Embed(
                         title="Pause",
@@ -192,17 +240,32 @@ class SpotifyModule:
                     )
                 )
                 logger.info("Playback paused")
+            except spotipy.SpotifyException as e:
+                if e.http_status == 403:
+                    await interaction.followup.send(
+                        embed=discord.Embed(
+                            title="Pause",
+                            description="Permission denied. Please check your Spotify account settings.",
+                            color=discord.Color.red(),
+                        )
+                    )
+                    logger.error(f"Permission denied: {e}")
+                else:
+                    await interaction.followup.send(f"An error occurred: {e}")
+                    logger.error(f"Error in pause command: {e}")
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in pause command: {e}")
 
-        @app_commands.command(
+        @app_commands.command(name="resume", description="Resume the currently playing track")
-            name="resume", description="Resume the currently playing track"
-        )
         async def resume(interaction: discord.Interaction):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                self.sp.start_playback()
+                sp.start_playback()
                 await interaction.followup.send(
                     embed=discord.Embed(
                         title="Resume",
@@ -211,6 +274,19 @@ class SpotifyModule:
                     )
                 )
                 logger.info("Playback resumed")
+            except spotipy.SpotifyException as e:
+                if e.http_status == 403:
+                    await interaction.followup.send(
+                        embed=discord.Embed(
+                            title="Resume",
+                            description="Permission denied. Please check your Spotify account settings.",
+                            color=discord.Color.red(),
+                        )
+                    )
+                    logger.error(f"Permission denied: {e}")
+                else:
+                    await interaction.followup.send(f"An error occurred: {e}")
+                    logger.error(f"Error in resume command: {e}")
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in resume command: {e}")
@@ -218,8 +294,12 @@ class SpotifyModule:
         @app_commands.command(name="next", description="Skip to the next track")
         async def next_track(interaction: discord.Interaction):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                self.sp.next_track()
+                sp.next_track()
                 await interaction.followup.send(
                     embed=discord.Embed(
                         title="Next Track",
@@ -228,17 +308,32 @@ class SpotifyModule:
                     )
                 )
                 logger.info("Skipped to the next track")
+            except spotipy.SpotifyException as e:
+                if e.http_status == 403:
+                    await interaction.followup.send(
+                        embed=discord.Embed(
+                            title="Next Track",
+                            description="Permission denied. Please check your Spotify account settings.",
+                            color=discord.Color.red(),
+                        )
+                    )
+                    logger.error(f"Permission denied: {e}")
+                else:
+                    await interaction.followup.send(f"An error occurred: {e}")
+                    logger.error(f"Error in next_track command: {e}")
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in next_track command: {e}")
 
-        @app_commands.command(
+        @app_commands.command(name="previous", description="Go back to the previous track")
-            name="previous", description="Go back to the previous track"
-        )
         async def previous_track(interaction: discord.Interaction):
             await interaction.response.defer()
+            sp = self.get_spotify_session(interaction.user.id)
+            if not sp:
+                await interaction.followup.send("Please log in to Spotify first using /login_spotify.")
+                return
             try:
-                self.sp.previous_track()
+                sp.previous_track()
                 await interaction.followup.send(
                     embed=discord.Embed(
                         title="Previous Track",
@@ -247,10 +342,25 @@ class SpotifyModule:
                     )
                 )
                 logger.info("Returned to the previous track")
+            except spotipy.SpotifyException as e:
+                if e.http_status == 403:
+                    await interaction.followup.send(
+                        embed=discord.Embed(
+                            title="Previous Track",
+                            description="Permission denied. Please check your Spotify account settings.",
+                            color=discord.Color.red(),
+                        )
+                    )
+                    logger.error(f"Permission denied: {e}")
+                else:
+                    await interaction.followup.send(f"An error occurred: {e}")
+                    logger.error(f"Error in previous_track command: {e}")
             except Exception as e:
                 await interaction.followup.send(f"An error occurred: {e}")
                 logger.error(f"Error in previous_track command: {e}")
 
+        self.bot.tree.add_command(login_spotify)
+        self.bot.tree.add_command(verify_spotify)
         self.bot.tree.add_command(current_track)
         self.bot.tree.add_command(play_track)
         self.bot.tree.add_command(play_playlist)

modules/user/xp_module.py

@@ -33,7 +33,7 @@ class XPModule:
         xp = random.randint(1, 5)  # Award between 1 and 5 XP for a message
         logger.debug(f"Awarding {xp} XP to user {user_id}")
         self.give_xp(user_id, xp)
-        self.cooldown[user_id] = now + timedelta(seconds=60)  # 1 minute cooldown # noqa: E501
+        self.cooldown[user_id] = now + timedelta(seconds=10)  # 1 minute cooldown # noqa: E501
 
     def give_xp(self, user_id, xp):
         conn = get_connection()