Merge pull request #6 from jarulsamy/dev

v0.0.4

.gitignore

@@ -1,6 +1,7 @@
 # Project specific
 config.yaml
 config/
+deploy.sh
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

Dockerfile

@@ -1,11 +1,11 @@
-# Python 3.7
-FROM python:3.7
+FROM python:3.7-slim
 
-# Update system
-RUN apt-get -y update
-RUN apt-get -y upgrade
 # Install ffmpeg
-RUN apt-get install -y ffmpeg
+RUN apt-get -y update && \
+    apt-get install -y --no-install-recommends ffmpeg && \
+    apt-get autoremove -y && \
+    apt-get clean && \
+    rm -rf /var/lib/apt/lists/*
 
 # All source code
 WORKDIR /src
@@ -14,11 +14,10 @@ WORKDIR /src
 COPY requirements.txt .
 
 # Install all dependencies.
-RUN pip install -r requirements.txt
+RUN pip install --only-binary all --no-cache-dir -r requirements.txt
 
 # Copy PlexBot over to src.
 COPY PlexBot/ PlexBot
 
 # Run the bot
-# CMD ["python", "-OO", "-m", "PlexBot"]
-CMD ["python", "-m", "PlexBot"]
+CMD ["python", "-OO", "-m", "PlexBot"]

Jenkinsfile

@@ -35,7 +35,7 @@ pipeline {
                 echo "Style check"
                 sh  ''' source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh
                         conda activate ${BUILD_TAG}
-                        pylint CHANGE_ME || true
+                        pylint PlexBot || true
                     '''
             }
         }
@@ -49,9 +49,7 @@ pipeline {
             steps {
                 sh  ''' source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh
                         conda activate ${BUILD_TAG}
-                        pwd
-                        ls
-                        python setup.py bdist_wheel
+                        python deploy/build.py
                     '''
             }
             post {
@@ -60,6 +58,7 @@ pipeline {
                     archiveArtifacts (allowEmptyArchive: true,
                                      artifacts: 'dist/*whl',
                                      fingerprint: true)
+                    // sh 'python deploy/push.py'
                 }
             }
         }
@@ -68,14 +67,7 @@ pipeline {
     post {
         always {
             sh 'conda remove --yes -n ${BUILD_TAG} --all'
-        }
-        failure {
-            emailext (
-                subject: "FAILED: Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]'",
-                body: """<p>FAILED: Job '${env.JOB_NAME} [${env.BUILD_NUMBER}]':</p>
-                         <p>Check console output at &QUOT;<a href='${env.BUILD_URL}'>${env.JOB_NAME} [${env.BUILD_NUMBER}]</a>&QUOT;</p>""",
-                recipientProviders: [[$class: 'DevelopersRecipientProvider']]
-            )
+            sh 'docker system prune -a -f'
         }
     }
 }

PlexBot/__init__.py

@@ -8,7 +8,9 @@ import yaml
 FORMAT = "%(asctime)s %(levelname)s: [%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s"
 
 logging.basicConfig(format=FORMAT)
-logger = logging.getLogger("PlexBot")
+root_log = logging.getLogger()
+plex_log = logging.getLogger("Plex")
+bot_log = logging.getLogger("Bot")
 
 
 def load_config(filename: str) -> Dict[str, str]:
@@ -20,7 +22,7 @@ def load_config(filename: str) -> Dict[str, str]:
         with open(filename, "r") as f:
             config = yaml.safe_load(f)
     except FileNotFoundError:
-        logging.fatal("Configuration file not found.")
+        root_log.fatal("Configuration file not found.")
         sys.exit(-1)
 
     # Convert str level type to logging constant
@@ -31,7 +33,9 @@ def load_config(filename: str) -> Dict[str, str]:
         "ERROR": logging.ERROR,
         "CRITICAL": logging.CRITICAL,
     }
-    level = config["general"]["log_level"]
-    config["general"]["log_level"] = levels[level.upper()]
+
+    config["root"]["log_level"] = levels[config["root"]["log_level"].upper()]
+    config["plex"]["log_level"] = levels[config["plex"]["log_level"].upper()]
+    config["discord"]["log_level"] = levels[config["discord"]["log_level"].upper()]
 
     return config

PlexBot/__main__.py

@@ -16,12 +16,14 @@ TOKEN = config["discord"]["token"]
 BASE_URL = config["plex"]["base_url"]
 PLEX_TOKEN = config["plex"]["token"]
 LIBRARY_NAME = config["plex"]["library_name"]
-LOG_LEVEL = config["general"]["log_level"]
 
 # Set appropiate log level
-logger = logging.getLogger("PlexBot")
-logging.basicConfig(format=FORMAT)
-logger.setLevel(LOG_LEVEL)
+root_log = logging.getLogger()
+plex_log = logging.getLogger("Plex")
+bot_log = logging.getLogger("Bot")
+
+plex_log.setLevel(config["plex"]["log_level"])
+bot_log.setLevel(config["discord"]["log_level"])
 
 bot = Bot(command_prefix=BOT_PREFIX)
 bot.add_cog(General(bot))

PlexBot/__version__.py

@@ -0,0 +1 @@
+VERSION = "0.0.4"

PlexBot/bot.py

@@ -4,6 +4,7 @@ import logging
 from urllib.request import urlopen
 
 import discord
+from async_timeout import timeout
 from discord import FFmpegPCMAudio
 from discord.ext import commands
 from discord.ext.commands import command
@@ -11,7 +12,9 @@ from fuzzywuzzy import fuzz
 from plexapi.exceptions import Unauthorized
 from plexapi.server import PlexServer
 
-logger = logging.getLogger("PlexBot")
+root_log = logging.getLogger()
+plex_log = logging.getLogger("Plex")
+bot_log = logging.getLogger("Bot")
 
 
 class General(commands.Cog):
@@ -19,10 +22,28 @@ class General(commands.Cog):
         self.bot = bot
 
     @command()
-    async def kill(self, ctx):
-        await ctx.send(f"Stopping upon the request of {ctx.author.mention}")
+    async def kill(self, ctx, *args):
+        if "silent" not in args:
+            await ctx.send(f"Stopping upon the request of {ctx.author.mention}")
+
         await self.bot.close()
-        logger.info(f"Stopping upon the request of {ctx.author.mention}")
+        bot_log.info(f"Stopping upon the request of {ctx.author.mention}")
+
+    @command()
+    async def cleanup(self, ctx, limit=250):
+        channel = ctx.message.channel
+
+        try:
+            async for i in channel.history(limit=limit):
+                # Only delete messages sent by self
+                if i.author == self.bot.user:
+                    try:
+                        await i.delete()
+                    except (discord.Forbidden, discord.NotFound, discord.HTTPException):
+                        pass
+
+        except discord.Forbidden:
+            await ctx.send("I don't have the necessary permissions to delete messages.")
 
 
 class Plex(commands.Cog):
@@ -36,19 +57,22 @@ class Plex(commands.Cog):
         try:
             self.pms = PlexServer(self.base_url, self.plex_token)
         except Unauthorized:
-            logger.fatal("Invalid Plex token, stopping...")
+            plex_log.fatal("Invalid Plex token, stopping...")
             raise Unauthorized("Invalid Plex token")
 
         self.music = self.pms.library.section(self.library_name)
+        plex_log.debug(f"Connected to plex library: {self.library_name}")
 
         self.vc = None
         self.current_track = None
+        self.np_message_id = None
+
         self.play_queue = asyncio.Queue()
         self.play_next_event = asyncio.Event()
 
         self.bot.loop.create_task(self._audio_player_task())
 
-        logger.info("Started bot successfully")
+        bot_log.info("Started bot successfully")
 
     def _search_tracks(self, title):
         tracks = self.music.searchTracks()
@@ -63,35 +87,41 @@ class Plex(commands.Cog):
 
         return score[0]
 
-    @command()
-    async def hello(self, ctx, *, member: discord.member = None):
-        member = member or ctx.author
-        await ctx.send(f"Hello {member}")
-
     async def _play(self):
         track_url = self.current_track.getStreamURL()
-
         audio_stream = FFmpegPCMAudio(track_url)
 
         while self.vc.is_playing():
-            asyncio.sleep(10)
+            asyncio.sleep(2)
 
         self.vc.play(audio_stream, after=self._toggle_next)
 
-        logger.debug(f"Playing {self.current_track.title}")
-        logger.debug(f"URL: {track_url}")
+        plex_log.debug(f"{self.current_track.title} - URL: {track_url}")
 
         embed, f = self._build_embed(self.current_track)
-        await self.ctx.send(embed=embed, file=f)
+        self.np_message_id = await self.ctx.send(embed=embed, file=f)
 
     async def _audio_player_task(self):
         while True:
             self.play_next_event.clear()
-            self.current_track = await self.play_queue.get()
+            if self.vc:
+                try:
+                    # Disconnect after 15 seconds idle
+                    async with timeout(15):
+                        self.current_track = await self.play_queue.get()
+                except asyncio.TimeoutError:
+                    await self.vc.disconnect()
+                    self.vc = None
+
+            if not self.current_track:
+                self.current_track = await self.play_queue.get()
+
             await self._play()
             await self.play_next_event.wait()
+            await self.np_message_id.delete()
 
     def _toggle_next(self, error=None):
+        self.current_track = None
         self.bot.loop.call_soon_threadsafe(self.play_next_event.set)
 
     def _build_embed(self, track, t="play"):
@@ -103,6 +133,7 @@ class Plex(commands.Cog):
 
         # Attach to discord embed
         f = discord.File(img, filename="image0.png")
+        # Get appropiate status message
         if t == "play":
             title = f"Now Playing - {track.title}"
         elif t == "queue":
@@ -110,24 +141,29 @@ class Plex(commands.Cog):
         else:
             raise ValueError(f"Unsupported type of embed {t}")
 
+        # Include song details
         descrip = f"{track.album().title} - {track.artist().title}"
 
         # Build the actual embed
         embed = discord.Embed(
             title=title, description=descrip, colour=discord.Color.red()
         )
-
         embed.set_author(name="Plex")
         # Point to file attached with ctx object.
         embed.set_thumbnail(url="attachment://image0.png")
 
+        bot_log.debug(f"Built embed for {track.title}")
+
         return embed, f
 
     @command()
     async def play(self, ctx, *args):
+        # Save the context to use with async callbacks
+        self.ctx = ctx
 
         if not len(args):
             await ctx.send(f"Usage: {self.bot_prefix}play TITLE_OF_SONG")
+            bot_log.debug("Failed to play, invalid usage")
             return
 
         title = " ".join(args)
@@ -136,24 +172,26 @@ class Plex(commands.Cog):
         # Fail if song title can't be found
         if not track:
             await ctx.send(f"Can't find song: {title}")
+            bot_log.debug(f"Failed to play, can't find song - {title}")
             return
+
         # Fail if user not in vc
         elif not ctx.author.voice:
             await ctx.send("Join a voice channel first!")
+            bot_log.debug("Failed to play, requester not in voice channel")
             return
 
         # Connect to voice if not already
         if not self.vc:
             self.vc = await ctx.author.voice.channel.connect()
-            logger.debug("Connected to vc.")
+            bot_log.debug("Connected to vc.")
 
         # Specific add to queue message
         if self.vc.is_playing():
+            bot_log.debug(f"Added to queue - {title}")
             embed, f = self._build_embed(track, t="queue")
             await ctx.send(embed=embed, file=f)
 
-        # Save the context to use with async callbacks
-        self.ctx = ctx
         # Add the song to the async queue
         await self.play_queue.put(track)
 
@@ -163,34 +201,46 @@ class Plex(commands.Cog):
             self.vc.stop()
             await self.vc.disconnect()
             self.vc = None
+            self.ctx = None
+            bot_log.debug("Stopped")
             await ctx.send(":stop_button: Stopped")
 
     @command()
     async def pause(self, ctx):
         if self.vc:
             self.vc.pause()
+            bot_log.debug("Paused")
             await ctx.send(":play_pause: Paused")
 
     @command()
     async def resume(self, ctx):
         if self.vc:
             self.vc.resume()
+            bot_log.debug("Resumed")
             await ctx.send(":play_pause: Resumed")
 
     @command()
     async def skip(self, ctx):
-        logger.debug("Skip")
+        bot_log.debug("Skip")
         if self.vc:
             self.vc.stop()
+            bot_log.debug("Skipped")
             self._toggle_next()
 
     @command()
     async def np(self, ctx):
         if self.current_track:
             embed, f = self._build_embed(self.current_track)
-            await ctx.send(embed=embed, file=f)
+            bot_log.debug("Now playing")
+            if self.np_message_id:
+                await self.np_message_id.delete()
+                bot_log("Deleted old np status")
+
+            bot_log("Created np status")
+            self.np_message_id = await ctx.send(embed=embed, file=f)
 
     @command()
     async def clear(self, ctx):
         self.play_queue = asyncio.Queue()
+        bot_log.debug("Cleared queue")
         await ctx.send(":boom: Queue cleared.")

deploy/build.py

@@ -0,0 +1,8 @@
+import os
+import sys
+
+sys.path.append("PlexBot")
+
+from __version__ import VERSION
+
+sys.exit(os.system(f"docker build -t jarulsamy/plex-bot:{VERSION} ."))

deploy/push.py

@@ -0,0 +1,8 @@
+import os
+import sys
+
+sys.path.append("PlexBot")
+
+from __version__ import VERSION
+
+sys.exit(os.system(f"docker push jarulsamy/plex-bot:{VERSION}"))

requirements.txt

@@ -1,7 +1,6 @@
 discord.py==1.3.4
 PlexAPI==4.0.0
 fuzzywuzzy==0.18.0
-python-Levenshtein==0.12.0
 pynacl==1.4.0
 ffmpeg==1.4
 PyYAML==5.3.1

sample-config.yaml

@@ -1,12 +1,13 @@
-general:
-  # Options: debug, info, warning, error, critical
+root:
   log_level: "info"
 
 discord:
   prefix: "?"
   token: "<BOT_TOKEN>"
+  log_level: "debug"
 
 plex:
   base_url: "<BASE_URL>"
   token: "<PLEX_TOKEN>"
   library_name: "<LIBRARY_NAME>"
+  log_level: "debug"