Created /core module with specialized files:

base.py: Main cog class and initialization logic
cleanup.py: Resource cleanup functionality
commands.py: Command handlers
events.py: Event listeners
guild.py: Guild component management
init.py: Module exports
Improved code organization by:

Separating concerns into focused modules
Maintaining clear dependencies between modules
Keeping related functionality together
Making the codebase more maintainable
Preserved all existing functionality while making the code more modular and easier to maintain.
This commit is contained in:
pacnpal
2024-11-15 20:01:45 +00:00
parent 434911abf0
commit 42b3ceb314
11 changed files with 747 additions and 1020 deletions

View File

@@ -1,347 +0,0 @@
"""Discord commands for VideoArchiver"""
import discord
from redbot.core import commands, app_commands, checks
from typing import Optional, Literal
import yt_dlp
from datetime import datetime
class VideoArchiverCommands(commands.Cog):
"""Command handler for VideoArchiver"""
def __init__(self, bot, config_manager=None, update_checker=None, processor=None):
self.bot = bot
self.config = config_manager
self.update_checker = update_checker
self.processor = processor
super().__init__()
async def cog_before_invoke(self, ctx: commands.Context) -> None:
"""This hook is called before every command."""
# For hybrid commands, we'll handle the interaction response here
if isinstance(ctx.command, commands.HybridCommand) and ctx.interaction:
await ctx.defer()
# Core Video Archiver Commands
@commands.hybrid_command(name="va_settings")
@app_commands.guild_only()
@commands.admin_or_permissions(administrator=True)
async def va_settings(self, ctx: commands.Context):
"""Show current video archiver settings"""
embed = await self.config.format_settings_embed(ctx.guild)
await ctx.send(embed=embed)
@commands.hybrid_command(name="va_update")
@app_commands.guild_only()
@checks.is_owner()
async def va_update(self, ctx: commands.Context):
"""Update yt-dlp to the latest version"""
success, message = await self.update_checker.update_yt_dlp()
await ctx.send("" + message if success else "" + message)
@commands.hybrid_command(name="va_toggleupdates")
@app_commands.guild_only()
@commands.admin_or_permissions(administrator=True)
async def va_toggleupdates(self, ctx: commands.Context):
"""Toggle yt-dlp update notifications"""
state = await self.config.toggle_setting(ctx.guild.id, "disable_update_check")
status = "disabled" if state else "enabled"
await ctx.send(f"Update notifications {status}")
# Role Management Commands
@commands.hybrid_command(name="var_add")
@app_commands.guild_only()
@app_commands.describe(role="The role to allow (leave empty for @everyone)")
async def var_add(self, ctx: commands.Context, role: Optional[discord.Role] = None):
"""Add a role that's allowed to trigger archiving"""
if not role:
# If no role is specified, clear the list to allow everyone
await self.config.update_setting(ctx.guild.id, "allowed_roles", [])
await ctx.send("Allowed role set to @everyone (all users can trigger archiving)")
return
await self.config.add_to_list(ctx.guild.id, "allowed_roles", role.id)
await ctx.send(f"Added {role.name} to allowed roles")
@commands.hybrid_command(name="var_remove")
@app_commands.guild_only()
@app_commands.describe(role="The role to remove")
async def var_remove(self, ctx: commands.Context, role: discord.Role):
"""Remove a role from allowed roles"""
await self.config.remove_from_list(ctx.guild.id, "allowed_roles", role.id)
await ctx.send(f"Removed {role.name} from allowed roles")
@commands.hybrid_command(name="var_list")
@app_commands.guild_only()
async def var_list(self, ctx: commands.Context):
"""List all roles allowed to trigger archiving"""
roles = await self.config.get_setting(ctx.guild.id, "allowed_roles")
if not roles:
await ctx.send("No roles are currently set (all users can trigger archiving)")
return
role_names = [
r.name if r else "@everyone"
for r in [ctx.guild.get_role(role_id) for role_id in roles]
]
await ctx.send(f"Allowed roles: {', '.join(role_names)}")
@commands.hybrid_command(name="va_concurrent")
@app_commands.guild_only()
@app_commands.describe(count="Number of concurrent downloads (1-5)")
async def va_concurrent(self, ctx: commands.Context, count: app_commands.Range[int, 1, 5]):
"""Set the number of concurrent downloads"""
await self.config.update_setting(ctx.guild.id, "concurrent_downloads", count)
await ctx.send(f"Concurrent downloads set to {count}")
# Channel Configuration Commands
@commands.hybrid_command(name="vac_archive")
@app_commands.guild_only()
@app_commands.describe(channel="The archive channel")
async def vac_archive(self, ctx: commands.Context, channel: discord.TextChannel):
"""Set the archive channel"""
await self.config.update_setting(ctx.guild.id, "archive_channel", channel.id)
await ctx.send(f"Archive channel set to {channel.mention}")
@commands.hybrid_command(name="vac_notify")
@app_commands.guild_only()
@app_commands.describe(channel="The notification channel")
async def vac_notify(self, ctx: commands.Context, channel: discord.TextChannel):
"""Set the notification channel (where archive messages appear)"""
await self.config.update_setting(ctx.guild.id, "notification_channel", channel.id)
await ctx.send(f"Notification channel set to {channel.mention}")
@commands.hybrid_command(name="vac_log")
@app_commands.guild_only()
@app_commands.describe(channel="The log channel")
async def vac_log(self, ctx: commands.Context, channel: discord.TextChannel):
"""Set the log channel for error messages and notifications"""
await self.config.update_setting(ctx.guild.id, "log_channel", channel.id)
await ctx.send(f"Log channel set to {channel.mention}")
@commands.hybrid_command(name="vac_monitor")
@app_commands.guild_only()
@app_commands.describe(channel="The channel to monitor (leave empty to monitor all channels)")
async def vac_monitor(self, ctx: commands.Context, channel: Optional[discord.TextChannel] = None):
"""Add a channel to monitor for videos"""
if not channel:
# If no channel is specified, clear the list to monitor all channels
await self.config.update_setting(ctx.guild.id, "monitored_channels", [])
await ctx.send("Now monitoring all channels for videos")
return
await self.config.add_to_list(ctx.guild.id, "monitored_channels", channel.id)
await ctx.send(f"Now monitoring {channel.mention} for videos")
@commands.hybrid_command(name="vac_unmonitor")
@app_commands.guild_only()
@app_commands.describe(channel="The channel to stop monitoring")
async def vac_unmonitor(self, ctx: commands.Context, channel: discord.TextChannel):
"""Remove a channel from monitoring"""
await self.config.remove_from_list(ctx.guild.id, "monitored_channels", channel.id)
await ctx.send(f"Stopped monitoring {channel.mention}")
# Video Format Commands
@commands.hybrid_command(name="va_format")
@app_commands.guild_only()
@app_commands.describe(format="The video format (e.g., mp4, webm)")
async def va_format(self, ctx: commands.Context, format: Literal["mp4", "webm"]):
"""Set the video format"""
await self.config.update_setting(ctx.guild.id, "video_format", format.lower())
await ctx.send(f"Video format set to {format.lower()}")
@commands.hybrid_command(name="va_quality")
@app_commands.guild_only()
@app_commands.describe(quality="Maximum video quality in pixels (e.g., 1080)")
async def va_quality(self, ctx: commands.Context, quality: app_commands.Range[int, 144, 4320]):
"""Set the maximum video quality"""
await self.config.update_setting(ctx.guild.id, "video_quality", quality)
await ctx.send(f"Maximum video quality set to {quality}p")
@commands.hybrid_command(name="va_maxsize")
@app_commands.guild_only()
@app_commands.describe(size="Maximum file size in MB")
async def va_maxsize(self, ctx: commands.Context, size: app_commands.Range[int, 1, 100]):
"""Set the maximum file size"""
await self.config.update_setting(ctx.guild.id, "max_file_size", size)
await ctx.send(f"Maximum file size set to {size}MB")
@commands.hybrid_command(name="va_toggledelete")
@app_commands.guild_only()
async def va_toggledelete(self, ctx: commands.Context):
"""Toggle whether to delete local files after reposting"""
state = await self.config.toggle_setting(ctx.guild.id, "delete_after_repost")
await ctx.send(f"Delete after repost: {state}")
@commands.hybrid_command(name="va_duration")
@app_commands.guild_only()
@app_commands.describe(hours="Duration in hours (0 for permanent)")
async def va_duration(self, ctx: commands.Context, hours: app_commands.Range[int, 0, 720]):
"""Set how long to keep archive messages"""
await self.config.update_setting(ctx.guild.id, "message_duration", hours)
await ctx.send(f"Archive message duration set to {hours} hours")
@commands.hybrid_command(name="va_template")
@app_commands.guild_only()
@app_commands.describe(template="Message template using {author}, {url}, and {original_message}")
async def va_template(self, ctx: commands.Context, template: str):
"""Set the archive message template"""
await self.config.update_setting(ctx.guild.id, "message_template", template)
await ctx.send(f"Archive message template set to:\n{template}")
# Site Management Commands
@commands.hybrid_command(name="vas_enable")
@app_commands.guild_only()
@app_commands.describe(sites="Sites to enable (leave empty for all sites)")
async def vas_enable(self, ctx: commands.Context, *, sites: Optional[str] = None):
"""Enable specific sites"""
if sites is None:
await self.config.update_setting(ctx.guild.id, "enabled_sites", [])
await ctx.send("All sites enabled")
return
site_list = [s.strip().lower() for s in sites.split()]
# Verify sites are valid
with yt_dlp.YoutubeDL() as ydl:
valid_sites = set(ie.IE_NAME.lower() for ie in ydl._ies if hasattr(ie, 'IE_NAME'))
invalid_sites = [s for s in site_list if s not in valid_sites]
if invalid_sites:
await ctx.send(
f"Invalid sites: {', '.join(invalid_sites)}\nValid sites: {', '.join(valid_sites)}"
)
return
await self.config.update_setting(ctx.guild.id, "enabled_sites", site_list)
await ctx.send(f"Enabled sites: {', '.join(site_list)}")
@commands.hybrid_command(name="vas_list")
@app_commands.guild_only()
async def vas_list(self, ctx: commands.Context):
"""List all available sites and currently enabled sites"""
enabled_sites = await self.config.get_setting(ctx.guild.id, "enabled_sites")
embed = discord.Embed(title="Video Sites Configuration", color=discord.Color.blue())
with yt_dlp.YoutubeDL() as ydl:
# Filter out any extractors that don't have IE_NAME attribute
all_sites = sorted(ie.IE_NAME for ie in ydl._ies if hasattr(ie, 'IE_NAME') and ie.IE_NAME is not None)
# Split sites into chunks for Discord's field value limit
chunk_size = 20
site_chunks = [
all_sites[i : i + chunk_size] for i in range(0, len(all_sites), chunk_size)
]
for i, chunk in enumerate(site_chunks, 1):
embed.add_field(
name=f"Available Sites ({i}/{len(site_chunks)})",
value=", ".join(chunk),
inline=False,
)
embed.add_field(
name="Currently Enabled",
value=", ".join(enabled_sites) if enabled_sites else "All sites",
inline=False,
)
await ctx.send(embed=embed)
# Queue Management Commands
@commands.hybrid_command(name="vaq_status")
@app_commands.guild_only()
@commands.admin_or_permissions(administrator=True)
async def vaq_status(self, ctx: commands.Context):
"""Show current queue status with basic metrics"""
status = self.processor.queue_manager.get_queue_status(ctx.guild.id)
embed = discord.Embed(
title="Video Processing Queue Status",
color=discord.Color.blue(),
timestamp=datetime.utcnow(),
)
# Queue Status
embed.add_field(
name="Queue Status",
value=(
f"📥 Pending: {status['pending']}\n"
f"⚙️ Processing: {status['processing']}\n"
f"✅ Completed: {status['completed']}\n"
f"❌ Failed: {status['failed']}"
),
inline=False,
)
# Basic Metrics
metrics = status["metrics"]
embed.add_field(
name="Basic Metrics",
value=(
f"Success Rate: {metrics['success_rate']:.1%}\n"
f"Avg Processing Time: {metrics['avg_processing_time']:.1f}s"
),
inline=False,
)
embed.set_footer(text="Use /vaq_metrics for detailed performance metrics")
await ctx.send(embed=embed)
@commands.hybrid_command(name="vaq_metrics")
@app_commands.guild_only()
@commands.admin_or_permissions(administrator=True)
async def vaq_metrics(self, ctx: commands.Context):
"""Show detailed queue performance metrics"""
status = self.processor.queue_manager.get_queue_status(ctx.guild.id)
metrics = status["metrics"]
embed = discord.Embed(
title="Queue Performance Metrics",
color=discord.Color.blue(),
timestamp=datetime.utcnow(),
)
# Processing Statistics
embed.add_field(
name="Processing Statistics",
value=(
f"Total Processed: {metrics['total_processed']}\n"
f"Total Failed: {metrics['total_failed']}\n"
f"Success Rate: {metrics['success_rate']:.1%}\n"
f"Avg Processing Time: {metrics['avg_processing_time']:.1f}s"
),
inline=False,
)
# Resource Usage
embed.add_field(
name="Resource Usage",
value=(
f"Peak Memory Usage: {metrics['peak_memory_usage']:.1f}MB\n"
f"Last Cleanup: {metrics['last_cleanup']}"
),
inline=False,
)
# Current Queue State
embed.add_field(
name="Current Queue State",
value=(
f"📥 Pending: {status['pending']}\n"
f"⚙️ Processing: {status['processing']}\n"
f"✅ Completed: {status['completed']}\n"
f"❌ Failed: {status['failed']}"
),
inline=False,
)
embed.set_footer(text="Metrics are updated in real-time as videos are processed")
await ctx.send(embed=embed)
@commands.hybrid_command(name="vaq_clear")
@app_commands.guild_only()
@commands.admin_or_permissions(administrator=True)
async def vaq_clear(self, ctx: commands.Context):
"""Clear the video processing queue for this guild"""
cleared = await self.processor.queue_manager.clear_guild_queue(ctx.guild.id)
await ctx.send(f"Cleared {cleared} items from the queue")