CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 11:18:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Audio] Add track length restriction (#2465)

Browse Source 
* Added `[p]audioset maxlength`, which takes seconds or 00:00-style of formatted input for restricting the player to songs that have a length under that threshold.
This commit is contained in:
aikaterna 2019-02-23 16:44:58 -08:00 committed by Toby Harradine
parent 7b9d85c1b5
commit b0ab6bd7e2
1 changed files with 138 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

168
redbot/cogs/audio/audio.py
View File

@ -63,6 +63,7 @@ class Audio(commands.Cog):
"emptydc_timer": 0,
"jukebox": False,
"jukebox_price": 0,
"maxlength": 0,
"playlists": {},
"notify": False,
"repeat": False,
@ -309,6 +310,29 @@ class Audio(commands.Cog):
await self.config.guild(ctx.guild).emptydc_timer.set(seconds)
await self.config.guild(ctx.guild).emptydc_enabled.set(enabled)
@audioset.command()
@checks.mod_or_permissions(administrator=True)
async def maxlength(self, ctx, seconds):
"""Max length of a track to queue in seconds. 0 to disable.
Accepts seconds or a value formatted like 00:00:00 (`hh:mm:ss`) or 00:00 (`mm:ss`).
Invalid input will turn the max length setting off."""
if not isinstance(seconds, int):
seconds = int(await self._time_convert(seconds) / 1000)
if seconds < 0:
return await self._embed_msg(ctx, _("Can't be less than zero."))
if seconds == 0:
await self._embed_msg(ctx, _("Track max length disabled."))
else:
await self._embed_msg(
ctx,
_("Track max length set to {seconds}.").format(
seconds=self._dynamic_time(seconds)
),
)
await self.config.guild(ctx.guild).maxlength.set(seconds)
@audioset.command()
@checks.admin_or_permissions(manage_roles=True)
async def role(self, ctx, role_name: discord.Role):
@ -374,9 +398,9 @@ class Audio(commands.Cog):
jukebox_price = data["jukebox_price"]
thumbnail = data["thumbnail"]
jarbuild = redbot.core.__version__
maxlength = data["maxlength"]
vote_percent = data["vote_percent"]
msg = "----" + _("Server Settings") + "----\n"
msg = "----" + _("Server Settings") + "---- \n"
if emptydc_enabled:
msg += _("Disconnect timer: [{num_seconds}]\n").format(
num_seconds=self._dynamic_time(emptydc_timer)
@ -386,6 +410,10 @@ class Audio(commands.Cog):
if jukebox:
msg += _("Jukebox: [{jukebox_name}]\n").format(jukebox_name=jukebox)
msg += _("Command price: [{jukebox_price}]\n").format(jukebox_price=jukebox_price)
if maxlength > 0:
msg += _("Max track length: [{tracklength}]\n").format(
tracklength=self._dynamic_time(maxlength)
)
msg += _(
"Repeat: [{repeat}]\n"
"Shuffle: [{shuffle}]\n"
@ -399,7 +427,7 @@ class Audio(commands.Cog):
"Vote skip: [{vote_enabled}]\nSkip percentage: [{vote_percent}%]\n"
).format(**data)
msg += _(
"---Lavalink Settings---\n"
"---Lavalink Settings--- \n"
"Cog version: [{version}]\n"
"Jar build: [{jarbuild}]\n"
"External server: [{use_external_lavalink}]"
@ -918,9 +946,7 @@ class Audio(commands.Cog):
@commands.guild_only()
async def play(self, ctx, *, query):
"""Play a URL or search for a track."""
dj_enabled = await self.config.guild(ctx.guild).dj_enabled()
jukebox_price = await self.config.guild(ctx.guild).jukebox_price()
shuffle = await self.config.guild(ctx.guild).shuffle()
guild_data = await self.config.guild(ctx.guild).all()
restrict = await self.config.restrict()
if restrict:
if self._match_url(query):
@ -944,7 +970,7 @@ class Audio(commands.Cog):
return await self._embed_msg(
ctx, _("Connection to Lavalink has not yet been established.")
)
if dj_enabled:
if guild_data["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."))
player = lavalink.get_player(ctx.guild.id)
@ -957,7 +983,7 @@ class Audio(commands.Cog):
return await self._embed_msg(
ctx, _("You must be in the voice channel to use the play command.")
)
if not await self._currency_check(ctx, jukebox_price):
if not await self._currency_check(ctx, guild_data["jukebox_price"]):
return
if not query:
@ -982,14 +1008,30 @@ class Audio(commands.Cog):
before_queue_length = len(player.queue)
if ("ytsearch:" or "localtrack") not in query and len(tracks) > 1:
track_len = 0
for track in tracks:
if guild_data["maxlength"] > 0:
if self._track_limit(ctx, track, guild_data["maxlength"]):
track_len += 1
player.add(ctx.author, track)
else:
track_len += 1
player.add(ctx.author, track)
if len(tracks) > track_len:
maxlength_msg = " {bad_tracks} tracks cannot be queued.".format(
bad_tracks=(len(tracks) - track_len)
)
else:
maxlength_msg = ""
embed = discord.Embed(
colour=await ctx.embed_colour(),
title=_("Playlist Enqueued"),
description=_("Added {num} tracks to the queue.").format(num=len(tracks)),
description=_("Added {num} tracks to the queue.{maxlength_msg}").format(
num=track_len, maxlength_msg=maxlength_msg
),
)
if not shuffle and queue_duration > 0:
if not guild_data["shuffle"] and queue_duration > 0:
embed.set_footer(
text=_(
"{time} until start of playlist playback: starts at #{position} in queue"
@ -999,6 +1041,12 @@ class Audio(commands.Cog):
await player.play()
else:
single_track = tracks[0]
if guild_data["maxlength"] > 0:
if self._track_limit(ctx, single_track, guild_data["maxlength"]):
player.add(ctx.author, single_track)
else:
return await self._embed_msg(ctx, _("Track exceeds maximum length."))
else:
player.add(ctx.author, single_track)
if "localtracks" in single_track.uri:
@ -1015,7 +1063,7 @@ class Audio(commands.Cog):
embed = discord.Embed(
colour=await ctx.embed_colour(), title=_("Track Enqueued"), description=description
)
if not shuffle and queue_duration > 0:
if not guild_data["shuffle"] and queue_duration > 0:
embed.set_footer(
text=_("{time} until track playback: #{position} in queue").format(
time=queue_total_duration, position=before_queue_length + 1
@ -1389,28 +1437,35 @@ class Audio(commands.Cog):
@playlist.command(name="start")
async def _playlist_start(self, ctx, playlist_name=None):
"""Load a playlist into the queue."""
restrict = await self.config.restrict()
if not await self._playlist_check(ctx):
return
maxlength = await self.config.guild(ctx.guild).maxlength()
playlists = await self.config.guild(ctx.guild).playlists.get_raw()
author_obj = self.bot.get_user(ctx.author.id)
track_count = 0
track_len = 0
try:
player = lavalink.get_player(ctx.guild.id)
for track in playlists[playlist_name]["tracks"]:
if restrict:
url_check = self._url_check(track["info"]["uri"])
if not url_check:
continue
if track["info"]["uri"].startswith("localtracks/"):
if not os.path.isfile(track["info"]["uri"]):
continue
if maxlength > 0:
if not self._track_limit(ctx, track["info"]["length"], maxlength):
continue
player.add(author_obj, lavalink.rest_api.Track(data=track))
track_count = track_count + 1
track_len += 1
if len(playlists[playlist_name]["tracks"]) > track_len:
maxlength_msg = " {bad_tracks} tracks cannot be queued.".format(
bad_tracks=(len(playlists[playlist_name]["tracks"]) - track_len)
)
else:
maxlength_msg = ""
embed = discord.Embed(
colour=await ctx.embed_colour(),
title=_("Playlist Enqueued"),
description=_("Added {num} tracks to the queue.").format(num=track_count),
description=_("Added {num} tracks to the queue.{maxlength_msg}").format(
num=track_len, maxlength_msg=maxlength_msg
),
)
await ctx.send(embed=embed)
if not player.current:
@ -1921,7 +1976,7 @@ class Audio(commands.Cog):
ctx, _("Connection to Lavalink has not yet been established.")
)
player = lavalink.get_player(ctx.guild.id)
shuffle = await self.config.guild(ctx.guild).shuffle()
guild_data = await self.config.guild(ctx.guild).all()
player.store("channel", ctx.channel.id)
player.store("guild", ctx.guild.id)
if (
@ -1943,22 +1998,39 @@ class Audio(commands.Cog):
tracks = await self._folder_tracks(ctx, player, query)
if not tracks:
return await self._embed_msg(ctx, _("Nothing found."))
songembed = discord.Embed(
colour=await ctx.embed_colour(),
title=_("Queued {num} track(s).").format(num=len(tracks)),
)
queue_duration = await self._queue_duration(ctx)
queue_total_duration = lavalink.utils.format_time(queue_duration)
if not shuffle and queue_duration > 0:
track_len = 0
for track in tracks:
if guild_data["maxlength"] > 0:
if self._track_limit(ctx, track, guild_data["maxlength"]):
track_len += 1
player.add(ctx.author, track)
else:
track_len += 1
player.add(ctx.author, track)
if not player.current:
await player.play()
if len(tracks) > track_len:
maxlength_msg = " {bad_tracks} tracks cannot be queued.".format(
bad_tracks=(len(tracks) - track_len)
)
else:
maxlength_msg = ""
songembed = discord.Embed(
colour=await ctx.embed_colour(),
title=_("Queued {num} track(s).{maxlength_msg}").format(
num=track_len, maxlength_msg=maxlength_msg
),
)
if not guild_data["shuffle"] and queue_duration > 0:
songembed.set_footer(
text=_(
"{time} until start of search playback: starts at #{position} in queue"
).format(time=queue_total_duration, position=len(player.queue) + 1)
)
for track in tracks:
player.add(ctx.author, track)
if not player.current:
await player.play()
return await ctx.send(embed=songembed)
elif query.startswith("sc "):
query = "scsearch:{}".format(query.replace("sc ", ""))
@ -2009,10 +2081,9 @@ class Audio(commands.Cog):
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()
guild_data = await self.config.guild(ctx.guild).all()
command = ctx.invoked_with
if not await self._currency_check(ctx, jukebox_price):
if not await self._currency_check(ctx, guild_data["jukebox_price"]):
return
try:
if emoji == "1⃣":
@ -2056,7 +2127,7 @@ class Audio(commands.Cog):
)
queue_duration = await self._queue_duration(ctx)
queue_total_duration = lavalink.utils.format_time(queue_duration)
if not shuffle and queue_duration > 0:
if not guild_data["shuffle"] and queue_duration > 0:
embed.set_footer(
text=_("{time} until track playback: #{position} in queue").format(
time=queue_total_duration, position=len(player.queue) + 1
@ -2065,7 +2136,11 @@ class Audio(commands.Cog):
elif queue_duration > 0:
embed.set_footer(text=_("#{position} in queue").format(position=len(player.queue) + 1))
if guild_data["maxlength"] > 0:
if self._track_limit(ctx, search_choice.length, guild_data["maxlength"]):
player.add(ctx.author, search_choice)
else:
return await self._embed_msg(ctx, _("Track exceeds maximum length."))
if not player.current:
await player.play()
await ctx.send(embed=embed)
@ -2767,6 +2842,33 @@ class Audio(commands.Cog):
track_obj[key] = value
return track_obj
@staticmethod
def _track_limit(ctx, track, maxlength):
try:
length = round(track.length / 1000)
except AttributeError:
length = round(track / 1000)
if length > 900000000000000: # livestreams return 9223372036854775807ms
return True
elif length >= maxlength:
return False
else:
return True
async def _time_convert(self, length):
match = re.compile(r"(?:(\d+):)?([0-5]?[0-9]):([0-5][0-9])").match(length)
if match is not None:
hr = int(match.group(1)) if match.group(1) else 0
mn = int(match.group(2)) if match.group(2) else 0
sec = int(match.group(3)) if match.group(3) else 0
pos = sec + (mn * 60) + (hr * 3600)
return pos * 1000
else:
try:
return int(length) * 1000
except ValueError:
return 0
@staticmethod
def _url_check(url):
valid_tld = [