[Audio] Connect to lavalink in the background (#2460)

Also:
- restart and reconnect if connection settings change
  - shutdown and restart if not configured to use external
- show a message in [p]play et al. when the connection hasn't been made
- move the JAR download to manager so audio.py can access it
- only start if no process exists
- bump red-lavalink to 0.2.3

Resolves #2306
This commit is contained in:
Caleb Johnson
2019-02-16 17:22:55 -05:00
committed by Toby Harradine
parent 5359fec195
commit 8e6db0829c
5 changed files with 131 additions and 53 deletions

View File

@@ -25,7 +25,7 @@ from redbot.core.utils.menus import (
)
from redbot.core.utils.predicates import MessagePredicate, ReactionPredicate
from urllib.parse import urlparse
from .manager import shutdown_lavalink_server
from .manager import shutdown_lavalink_server, start_lavalink_server, maybe_download_lavalink
_ = Translator("Audio", __file__)
@@ -74,26 +74,47 @@ class Audio(commands.Cog):
self.config.register_global(**default_global)
self.skip_votes = {}
self.session = aiohttp.ClientSession()
self._connect_task = None
self._disconnect_task = None
self._cleaned_up = False
async def initialize(self):
host = await self.config.host()
password = await self.config.password()
rest_port = await self.config.rest_port()
ws_port = await self.config.ws_port()
await lavalink.initialize(
bot=self.bot,
host=host,
password=password,
rest_port=rest_port,
ws_port=ws_port,
timeout=60,
)
self._restart_connect()
self._disconnect_task = self.bot.loop.create_task(self.disconnect_timer())
lavalink.register_event_listener(self.event_handler)
self._disconnect_task = self.bot.loop.create_task(self.disconnect_timer())
def _restart_connect(self):
if self._connect_task:
self._connect_task.cancel()
self._connect_task = self.bot.loop.create_task(self.attempt_connect())
async def attempt_connect(self, timeout: int = 30):
while True: # run until success
external = await self.config.use_external_lavalink()
if not external:
shutdown_lavalink_server()
await maybe_download_lavalink(self.bot.loop, self)
await start_lavalink_server(self.bot.loop)
try:
host = await self.config.host()
password = await self.config.password()
rest_port = await self.config.rest_port()
ws_port = await self.config.ws_port()
await lavalink.initialize(
bot=self.bot,
host=host,
password=password,
rest_port=rest_port,
ws_port=ws_port,
timeout=timeout,
)
return # break infinite loop
except Exception:
if not external:
shutdown_lavalink_server()
await asyncio.sleep(1) # prevent busylooping
async def event_handler(self, player, event_type, extra):
notify = await self.config.guild(player.channel.guild).notify()
@@ -903,6 +924,10 @@ class Audio(commands.Cog):
player.store("connect", datetime.datetime.utcnow())
except AttributeError:
return await self._embed_msg(ctx, _("Connect to a voice channel first."))
except IndexError:
return await self._embed_msg(
ctx, _("Connection to Lavalink has not yet been established.")
)
if dj_enabled:
if not await self._can_instaskip(ctx, ctx.author):
return await self._embed_msg(ctx, _("You need the DJ role to queue tracks."))
@@ -1413,9 +1438,15 @@ class Audio(commands.Cog):
await lavalink.connect(ctx.author.voice.channel)
player = lavalink.get_player(ctx.guild.id)
player.store("connect", datetime.datetime.utcnow())
except IndexError:
await self._embed_msg(
ctx, _("Connection to Lavalink has not yet been established.")
)
return False
except AttributeError:
await self._embed_msg(ctx, _("Connect to a voice channel first."))
return False
player = lavalink.get_player(ctx.guild.id)
player.store("channel", ctx.channel.id)
player.store("guild", ctx.guild.id)
@@ -1793,6 +1824,10 @@ class Audio(commands.Cog):
player.store("connect", datetime.datetime.utcnow())
except AttributeError:
return await self._embed_msg(ctx, _("Connect to a voice channel first."))
except IndexError:
return await self._embed_msg(
ctx, _("Connection to Lavalink has not yet been established.")
)
player = lavalink.get_player(ctx.guild.id)
shuffle = await self.config.guild(ctx.guild).shuffle()
player.store("channel", ctx.channel.id)
@@ -1877,6 +1912,10 @@ class Audio(commands.Cog):
player.store("connect", datetime.datetime.utcnow())
except AttributeError:
return await self._embed_msg(ctx, _("Connect to a voice channel first."))
except IndexError:
return await self._embed_msg(
ctx, _("Connection to Lavalink has not yet been established.")
)
player = lavalink.get_player(ctx.guild.id)
jukebox_price = await self.config.guild(ctx.guild).jukebox_price()
shuffle = await self.config.guild(ctx.guild).shuffle()
@@ -1897,7 +1936,6 @@ class Audio(commands.Cog):
except IndexError:
search_choice = tracks[-1]
try:
search_check = search_choice.uri
if "localtracks" in search_choice.uri:
if search_choice.title == "Unknown title":
description = "**{} - {}**\n{}".format(
@@ -2333,6 +2371,7 @@ class Audio(commands.Cog):
"""Toggle using external lavalink servers."""
external = await self.config.use_external_lavalink()
await self.config.use_external_lavalink.set(not external)
if external:
await self.config.host.set("localhost")
await self.config.password.set("youshallnotpass")
@@ -2345,13 +2384,15 @@ class Audio(commands.Cog):
),
)
embed.set_footer(text=_("Defaults reset."))
return await ctx.send(embed=embed)
await ctx.send(embed=embed)
else:
await self._embed_msg(
ctx,
_("External lavalink server: {true_or_false}.").format(true_or_false=not external),
)
self._restart_connect()
@llsetup.command()
async def host(self, ctx, host):
"""Set the lavalink server host."""
@@ -2365,6 +2406,8 @@ class Audio(commands.Cog):
else:
await self._embed_msg(ctx, _("Host set to {host}.").format(host=host))
self._restart_connect()
@llsetup.command()
async def password(self, ctx, password):
"""Set the lavalink server password."""
@@ -2381,6 +2424,8 @@ class Audio(commands.Cog):
ctx, _("Server password set to {password}.").format(password=password)
)
self._restart_connect()
@llsetup.command()
async def restport(self, ctx, rest_port: int):
"""Set the lavalink REST server port."""
@@ -2395,6 +2440,8 @@ class Audio(commands.Cog):
else:
await self._embed_msg(ctx, _("REST port set to {port}.").format(port=rest_port))
self._restart_connect()
@llsetup.command()
async def wsport(self, ctx, ws_port: int):
"""Set the lavalink websocket server port."""
@@ -2409,6 +2456,8 @@ class Audio(commands.Cog):
else:
await self._embed_msg(ctx, _("Websocket port set to {port}.").format(port=ws_port))
self._restart_connect()
async def _check_external(self):
external = await self.config.use_external_lavalink()
if not external:
@@ -2555,7 +2604,7 @@ class Audio(commands.Cog):
try:
query_url = urlparse(url)
return all([query_url.scheme, query_url.netloc, query_url.path])
except:
except Exception:
return False
@staticmethod
@@ -2659,8 +2708,13 @@ class Audio(commands.Cog):
def __unload(self):
if not self._cleaned_up:
self.session.detach()
if self._disconnect_task:
self._disconnect_task.cancel()
if self._connect_task:
self._connect_task.cancel()
lavalink.unregister_event_listener(self.event_handler)
self.bot.loop.create_task(lavalink.close())
shutdown_lavalink_server()