pacnpal/Pac-cogs
1
0
Fork 0
mirror of https://github.com/pacnpal/Pac-cogs.git synced 2025-12-20 10:51:05 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: Improve hybrid command implementation - Add consistent app_commands.guild_only() - Add proper parameter descriptions - Use app_commands.Range for numeric inputs

Browse Source
This commit is contained in:
pacnpal
2024-11-15 01:00:25 +00:00
parent 533afd61ed
commit 28e5736495
1 changed files with 81 additions and 86 deletions
Download Patch File Download Diff File Expand all files Collapse all files

167
videoarchiver/commands.py
View File

@@ -15,188 +15,183 @@ class VideoArchiverCommands(commands.Cog):
self.processor = processor self.processor = processor
super().__init__() super().__init__()
videoarchiver = app_commands.Group( @commands.hybrid_group(name="videoarchiver", aliases=["va"], fallback="settings")
name="videoarchiver",
description="Video Archiver configuration commands",
guild_only=True
)
@videoarchiver.command(name="settings")
@app_commands.guild_only() @app_commands.guild_only()
@commands.admin_or_permissions(administrator=True) @commands.admin_or_permissions(administrator=True)
async def settings(self, interaction: discord.Interaction): async def videoarchiver(self, ctx: commands.Context):
"""Show current settings""" """Video Archiver configuration commands"""
embed = await self.config.format_settings_embed(interaction.guild) if ctx.invoked_subcommand is None:
await interaction.response.send_message(embed=embed) embed = await self.config.format_settings_embed(ctx.guild)
await ctx.send(embed=embed)
@videoarchiver.command(name="updateytdlp") @videoarchiver.command(name="updateytdlp")
@app_commands.guild_only() @app_commands.guild_only()
@commands.is_owner() @checks.is_owner()
async def update_ytdlp(self, interaction: discord.Interaction): async def update_ytdlp(self, ctx: commands.Context):
"""Update yt-dlp to the latest version""" """Update yt-dlp to the latest version"""
success, message = await self.update_checker.update_yt_dlp() success, message = await self.update_checker.update_yt_dlp()
await interaction.response.send_message("✅ " + message if success else "❌ " + message) await ctx.send("✅ " + message if success else "❌ " + message)
@videoarchiver.command(name="toggleupdates") @videoarchiver.command(name="toggleupdates")
@app_commands.guild_only() @app_commands.guild_only()
@commands.admin_or_permissions(administrator=True) @commands.admin_or_permissions(administrator=True)
async def toggle_update_check(self, interaction: discord.Interaction): async def toggle_update_check(self, ctx: commands.Context):
"""Toggle yt-dlp update notifications""" """Toggle yt-dlp update notifications"""
state = await self.config.toggle_setting(interaction.guild.id, "disable_update_check") state = await self.config.toggle_setting(ctx.guild.id, "disable_update_check")
status = "disabled" if state else "enabled" status = "disabled" if state else "enabled"
await interaction.response.send_message(f"Update notifications {status}") await ctx.send(f"Update notifications {status}")
@videoarchiver.command(name="addrole") @videoarchiver.command(name="addrole")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(role="The role to allow (leave empty for @everyone)") @app_commands.describe(role="The role to allow (leave empty for @everyone)")
async def add_allowed_role(self, interaction: discord.Interaction, role: Optional[discord.Role] = None): async def add_allowed_role(self, ctx: commands.Context, role: Optional[discord.Role] = None):
"""Add a role that's allowed to trigger archiving""" """Add a role that's allowed to trigger archiving"""
if not role: if not role:
# If no role is specified, clear the list to allow everyone # If no role is specified, clear the list to allow everyone
await self.config.update_setting(interaction.guild.id, "allowed_roles", []) await self.config.update_setting(ctx.guild.id, "allowed_roles", [])
await interaction.response.send_message("Allowed role set to @everyone (all users can trigger archiving)") await ctx.send("Allowed role set to @everyone (all users can trigger archiving)")
return return
await self.config.add_to_list(interaction.guild.id, "allowed_roles", role.id) await self.config.add_to_list(ctx.guild.id, "allowed_roles", role.id)
await interaction.response.send_message(f"Added {role.name} to allowed roles") await ctx.send(f"Added {role.name} to allowed roles")
@videoarchiver.command(name="removerole") @videoarchiver.command(name="removerole")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(role="The role to remove") @app_commands.describe(role="The role to remove")
async def remove_allowed_role(self, interaction: discord.Interaction, role: discord.Role): async def remove_allowed_role(self, ctx: commands.Context, role: discord.Role):
"""Remove a role from allowed roles""" """Remove a role from allowed roles"""
await self.config.remove_from_list(interaction.guild.id, "allowed_roles", role.id) await self.config.remove_from_list(ctx.guild.id, "allowed_roles", role.id)
await interaction.response.send_message(f"Removed {role.name} from allowed roles") await ctx.send(f"Removed {role.name} from allowed roles")
@videoarchiver.command(name="listroles") @videoarchiver.command(name="listroles")
@app_commands.guild_only() @app_commands.guild_only()
async def list_allowed_roles(self, interaction: discord.Interaction): async def list_allowed_roles(self, ctx: commands.Context):
"""List all roles allowed to trigger archiving""" """List all roles allowed to trigger archiving"""
roles = await self.config.get_setting(interaction.guild.id, "allowed_roles") roles = await self.config.get_setting(ctx.guild.id, "allowed_roles")
if not roles: if not roles:
await interaction.response.send_message( await ctx.send(
"No roles are currently set (all users can trigger archiving)" "No roles are currently set (all users can trigger archiving)"
) )
return return
role_names = [ role_names = [
r.name if r else "@everyone" r.name if r else "@everyone"
for r in [interaction.guild.get_role(role_id) for role_id in roles] for r in [ctx.guild.get_role(role_id) for role_id in roles]
] ]
await interaction.response.send_message(f"Allowed roles: {', '.join(role_names)}") await ctx.send(f"Allowed roles: {', '.join(role_names)}")
@videoarchiver.command(name="setconcurrent") @videoarchiver.command(name="setconcurrent")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(count="Number of concurrent downloads (1-5)") @app_commands.describe(count="Number of concurrent downloads (1-5)")
async def set_concurrent_downloads(self, interaction: discord.Interaction, count: app_commands.Range[int, 1, 5]): async def set_concurrent_downloads(self, ctx: commands.Context, count: app_commands.Range[int, 1, 5]):
"""Set the number of concurrent downloads""" """Set the number of concurrent downloads"""
await self.config.update_setting(interaction.guild.id, "concurrent_downloads", count) await self.config.update_setting(ctx.guild.id, "concurrent_downloads", count)
await interaction.response.send_message(f"Concurrent downloads set to {count}") await ctx.send(f"Concurrent downloads set to {count}")
@videoarchiver.command(name="setchannel") @videoarchiver.command(name="setchannel")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(channel="The archive channel") @app_commands.describe(channel="The archive channel")
async def set_archive_channel(self, interaction: discord.Interaction, channel: discord.TextChannel): async def set_archive_channel(self, ctx: commands.Context, channel: discord.TextChannel):
"""Set the archive channel""" """Set the archive channel"""
await self.config.update_setting(interaction.guild.id, "archive_channel", channel.id) await self.config.update_setting(ctx.guild.id, "archive_channel", channel.id)
await interaction.response.send_message(f"Archive channel set to {channel.mention}") await ctx.send(f"Archive channel set to {channel.mention}")
@videoarchiver.command(name="setnotification") @videoarchiver.command(name="setnotification")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(channel="The notification channel") @app_commands.describe(channel="The notification channel")
async def set_notification_channel(self, interaction: discord.Interaction, channel: discord.TextChannel): async def set_notification_channel(self, ctx: commands.Context, channel: discord.TextChannel):
"""Set the notification channel (where archive messages appear)""" """Set the notification channel (where archive messages appear)"""
await self.config.update_setting( await self.config.update_setting(
interaction.guild.id, "notification_channel", channel.id ctx.guild.id, "notification_channel", channel.id
) )
await interaction.response.send_message(f"Notification channel set to {channel.mention}") await ctx.send(f"Notification channel set to {channel.mention}")
@videoarchiver.command(name="setlogchannel") @videoarchiver.command(name="setlogchannel")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(channel="The log channel") @app_commands.describe(channel="The log channel")
async def set_log_channel(self, interaction: discord.Interaction, channel: discord.TextChannel): async def set_log_channel(self, ctx: commands.Context, channel: discord.TextChannel):
"""Set the log channel for error messages and notifications""" """Set the log channel for error messages and notifications"""
await self.config.update_setting(interaction.guild.id, "log_channel", channel.id) await self.config.update_setting(ctx.guild.id, "log_channel", channel.id)
await interaction.response.send_message(f"Log channel set to {channel.mention}") await ctx.send(f"Log channel set to {channel.mention}")
@videoarchiver.command(name="addmonitor") @videoarchiver.command(name="addmonitor")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(channel="The channel to monitor (leave empty to monitor all channels)") @app_commands.describe(channel="The channel to monitor (leave empty to monitor all channels)")
async def add_monitored_channel(self, interaction: discord.Interaction, channel: Optional[discord.TextChannel] = None): async def add_monitored_channel(self, ctx: commands.Context, channel: Optional[discord.TextChannel] = None):
"""Add a channel to monitor for videos""" """Add a channel to monitor for videos"""
if not channel: if not channel:
# If no channel is specified, clear the list to monitor all channels # If no channel is specified, clear the list to monitor all channels
await self.config.update_setting(interaction.guild.id, "monitored_channels", []) await self.config.update_setting(ctx.guild.id, "monitored_channels", [])
await interaction.response.send_message("Now monitoring all channels for videos") await ctx.send("Now monitoring all channels for videos")
return return
await self.config.add_to_list(interaction.guild.id, "monitored_channels", channel.id) await self.config.add_to_list(ctx.guild.id, "monitored_channels", channel.id)
await interaction.response.send_message(f"Now monitoring {channel.mention} for videos") await ctx.send(f"Now monitoring {channel.mention} for videos")
@videoarchiver.command(name="removemonitor") @videoarchiver.command(name="removemonitor")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(channel="The channel to stop monitoring") @app_commands.describe(channel="The channel to stop monitoring")
async def remove_monitored_channel(self, interaction: discord.Interaction, channel: discord.TextChannel): async def remove_monitored_channel(self, ctx: commands.Context, channel: discord.TextChannel):
"""Remove a channel from monitoring""" """Remove a channel from monitoring"""
await self.config.remove_from_list( await self.config.remove_from_list(
interaction.guild.id, "monitored_channels", channel.id ctx.guild.id, "monitored_channels", channel.id
) )
await interaction.response.send_message(f"Stopped monitoring {channel.mention}") await ctx.send(f"Stopped monitoring {channel.mention}")
@videoarchiver.command(name="setformat") @videoarchiver.command(name="setformat")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(format="The video format (e.g., mp4, webm)") @app_commands.describe(format="The video format (e.g., mp4, webm)")
async def set_video_format(self, interaction: discord.Interaction, format: Literal["mp4", "webm"]): async def set_video_format(self, ctx: commands.Context, format: Literal["mp4", "webm"]):
"""Set the video format""" """Set the video format"""
await self.config.update_setting(interaction.guild.id, "video_format", format.lower()) await self.config.update_setting(ctx.guild.id, "video_format", format.lower())
await interaction.response.send_message(f"Video format set to {format.lower()}") await ctx.send(f"Video format set to {format.lower()}")
@videoarchiver.command(name="setquality") @videoarchiver.command(name="setquality")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(quality="Maximum video quality in pixels (e.g., 1080)") @app_commands.describe(quality="Maximum video quality in pixels (e.g., 1080)")
async def set_video_quality(self, interaction: discord.Interaction, quality: app_commands.Range[int, 144, 4320]): async def set_video_quality(self, ctx: commands.Context, quality: app_commands.Range[int, 144, 4320]):
"""Set the maximum video quality""" """Set the maximum video quality"""
await self.config.update_setting(interaction.guild.id, "video_quality", quality) await self.config.update_setting(ctx.guild.id, "video_quality", quality)
await interaction.response.send_message(f"Maximum video quality set to {quality}p") await ctx.send(f"Maximum video quality set to {quality}p")
@videoarchiver.command(name="setmaxsize") @videoarchiver.command(name="setmaxsize")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(size="Maximum file size in MB") @app_commands.describe(size="Maximum file size in MB")
async def set_max_file_size(self, interaction: discord.Interaction, size: app_commands.Range[int, 1, 100]): async def set_max_file_size(self, ctx: commands.Context, size: app_commands.Range[int, 1, 100]):
"""Set the maximum file size""" """Set the maximum file size"""
await self.config.update_setting(interaction.guild.id, "max_file_size", size) await self.config.update_setting(ctx.guild.id, "max_file_size", size)
await interaction.response.send_message(f"Maximum file size set to {size}MB") await ctx.send(f"Maximum file size set to {size}MB")
@videoarchiver.command(name="toggledelete") @videoarchiver.command(name="toggledelete")
@app_commands.guild_only() @app_commands.guild_only()
async def toggle_delete_after_repost(self, interaction: discord.Interaction): async def toggle_delete_after_repost(self, ctx: commands.Context):
"""Toggle whether to delete local files after reposting""" """Toggle whether to delete local files after reposting"""
state = await self.config.toggle_setting(interaction.guild.id, "delete_after_repost") state = await self.config.toggle_setting(ctx.guild.id, "delete_after_repost")
await interaction.response.send_message(f"Delete after repost: {state}") await ctx.send(f"Delete after repost: {state}")
@videoarchiver.command(name="setduration") @videoarchiver.command(name="setduration")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(hours="Duration in hours (0 for permanent)") @app_commands.describe(hours="Duration in hours (0 for permanent)")
async def set_message_duration(self, interaction: discord.Interaction, hours: app_commands.Range[int, 0, 720]): async def set_message_duration(self, ctx: commands.Context, hours: app_commands.Range[int, 0, 720]):
"""Set how long to keep archive messages""" """Set how long to keep archive messages"""
await self.config.update_setting(interaction.guild.id, "message_duration", hours) await self.config.update_setting(ctx.guild.id, "message_duration", hours)
await interaction.response.send_message(f"Archive message duration set to {hours} hours") await ctx.send(f"Archive message duration set to {hours} hours")
@videoarchiver.command(name="settemplate") @videoarchiver.command(name="settemplate")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(template="Message template using {author}, {url}, and {original_message}") @app_commands.describe(template="Message template using {author}, {url}, and {original_message}")
async def set_message_template(self, interaction: discord.Interaction, template: str): async def set_message_template(self, ctx: commands.Context, *, template: str):
"""Set the archive message template""" """Set the archive message template"""
await self.config.update_setting(interaction.guild.id, "message_template", template) await self.config.update_setting(ctx.guild.id, "message_template", template)
await interaction.response.send_message(f"Archive message template set to:\n{template}") await ctx.send(f"Archive message template set to:\n{template}")
@videoarchiver.command(name="enablesites") @videoarchiver.command(name="enablesites")
@app_commands.guild_only() @app_commands.guild_only()
@app_commands.describe(sites="Sites to enable (leave empty for all sites)") @app_commands.describe(sites="Sites to enable (leave empty for all sites)")
async def enable_sites(self, interaction: discord.Interaction, sites: Optional[str] = None): async def enable_sites(self, ctx: commands.Context, *, sites: Optional[str] = None):
"""Enable specific sites""" """Enable specific sites"""
if sites is None: if sites is None:
await self.config.update_setting(interaction.guild.id, "enabled_sites", []) await self.config.update_setting(ctx.guild.id, "enabled_sites", [])
await interaction.response.send_message("All sites enabled") await ctx.send("All sites enabled")
return return
site_list = [s.strip().lower() for s in sites.split()] site_list = [s.strip().lower() for s in sites.split()]
@@ -206,19 +201,19 @@ class VideoArchiverCommands(commands.Cog):
valid_sites = set(ie.IE_NAME.lower() for ie in ydl._ies) valid_sites = set(ie.IE_NAME.lower() for ie in ydl._ies)
invalid_sites = [s for s in site_list if s not in valid_sites] invalid_sites = [s for s in site_list if s not in valid_sites]
if invalid_sites: if invalid_sites:
await interaction.response.send_message( await ctx.send(
f"Invalid sites: {', '.join(invalid_sites)}\nValid sites: {', '.join(valid_sites)}" f"Invalid sites: {', '.join(invalid_sites)}\nValid sites: {', '.join(valid_sites)}"
) )
return return
await self.config.update_setting(interaction.guild.id, "enabled_sites", site_list) await self.config.update_setting(ctx.guild.id, "enabled_sites", site_list)
await interaction.response.send_message(f"Enabled sites: {', '.join(site_list)}") await ctx.send(f"Enabled sites: {', '.join(site_list)}")
@videoarchiver.command(name="listsites") @videoarchiver.command(name="listsites")
@app_commands.guild_only() @app_commands.guild_only()
async def list_sites(self, interaction: discord.Interaction): async def list_sites(self, ctx: commands.Context):
"""List all available sites and currently enabled sites""" """List all available sites and currently enabled sites"""
enabled_sites = await self.config.get_setting(interaction.guild.id, "enabled_sites") enabled_sites = await self.config.get_setting(ctx.guild.id, "enabled_sites")
embed = discord.Embed( embed = discord.Embed(
title="Video Sites Configuration", color=discord.Color.blue() title="Video Sites Configuration", color=discord.Color.blue()
@@ -246,14 +241,14 @@ class VideoArchiverCommands(commands.Cog):
inline=False, inline=False,
) )
await interaction.response.send_message(embed=embed) await ctx.send(embed=embed)
@videoarchiver.command(name="queue") @videoarchiver.command(name="queue")
@app_commands.guild_only() @app_commands.guild_only()
@commands.admin_or_permissions(administrator=True) @commands.admin_or_permissions(administrator=True)
async def show_queue(self, interaction: discord.Interaction): async def show_queue(self, ctx: commands.Context):
"""Show current queue status with basic metrics""" """Show current queue status with basic metrics"""
status = self.processor.queue_manager.get_queue_status(interaction.guild.id) status = self.processor.queue_manager.get_queue_status(ctx.guild.id)
embed = discord.Embed( embed = discord.Embed(
title="Video Processing Queue Status", title="Video Processing Queue Status",
@@ -285,14 +280,14 @@ class VideoArchiverCommands(commands.Cog):
) )
embed.set_footer(text="Use /videoarchiver queuemetrics for detailed performance metrics") embed.set_footer(text="Use /videoarchiver queuemetrics for detailed performance metrics")
await interaction.response.send_message(embed=embed) await ctx.send(embed=embed)
@videoarchiver.command(name="queuemetrics") @videoarchiver.command(name="queuemetrics")
@app_commands.guild_only() @app_commands.guild_only()
@commands.admin_or_permissions(administrator=True) @commands.admin_or_permissions(administrator=True)
async def show_queue_metrics(self, interaction: discord.Interaction): async def show_queue_metrics(self, ctx: commands.Context):
"""Show detailed queue performance metrics""" """Show detailed queue performance metrics"""
status = self.processor.queue_manager.get_queue_status(interaction.guild.id) status = self.processor.queue_manager.get_queue_status(ctx.guild.id)
metrics = status['metrics'] metrics = status['metrics']
embed = discord.Embed( embed = discord.Embed(
@@ -336,12 +331,12 @@ class VideoArchiverCommands(commands.Cog):
) )
embed.set_footer(text="Metrics are updated in real-time as videos are processed") embed.set_footer(text="Metrics are updated in real-time as videos are processed")
await interaction.response.send_message(embed=embed) await ctx.send(embed=embed)
@videoarchiver.command(name="clearqueue") @videoarchiver.command(name="clearqueue")
@app_commands.guild_only() @app_commands.guild_only()
@commands.admin_or_permissions(administrator=True) @commands.admin_or_permissions(administrator=True)
async def clear_queue(self, interaction: discord.Interaction): async def clear_queue(self, ctx: commands.Context):
"""Clear the video processing queue for this guild""" """Clear the video processing queue for this guild"""
cleared = await self.processor.queue_manager.clear_guild_queue(interaction.guild.id) cleared = await self.processor.queue_manager.clear_guild_queue(ctx.guild.id)
await interaction.response.send_message(f"Cleared {cleared} items from the queue") await ctx.send(f"Cleared {cleared} items from the queue")