425 lines
18 KiB
Python
425 lines
18 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING
|
|
|
|
import discord
|
|
import sentry_sdk
|
|
from apscheduler.job import Job
|
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
|
from apscheduler.triggers.cron import CronTrigger
|
|
from apscheduler.triggers.interval import IntervalTrigger
|
|
from discord.ui import Button, Select
|
|
from loguru import logger
|
|
|
|
from discord_reminder_bot.misc import calc_time, calculate
|
|
from discord_reminder_bot.parser import parse_time
|
|
|
|
if TYPE_CHECKING:
|
|
import datetime
|
|
|
|
from apscheduler.job import Job
|
|
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
|
|
|
|
|
class ModifyJobModal(discord.ui.Modal, title="Modify Job"):
|
|
"""Modal for modifying a job."""
|
|
|
|
job_name = discord.ui.TextInput(label="Name", placeholder="Enter new job name", required=False)
|
|
job_date = discord.ui.TextInput(label="Date", placeholder="Enter new job date", required=False)
|
|
|
|
def __init__(self, job: Job, scheduler: AsyncIOScheduler) -> None:
|
|
"""Initialize the modify job modal.
|
|
|
|
Args:
|
|
job: The job to modify.
|
|
scheduler: The scheduler to modify the job with.
|
|
"""
|
|
super().__init__()
|
|
self.job: Job = job
|
|
self.scheduler: AsyncIOScheduler = scheduler
|
|
|
|
# Use "Name" as label if the message is too long, otherwise use the old message
|
|
job_name_label: str = f"Name ({self.job.kwargs.get('message', 'X' * 46)})"
|
|
if len(job_name_label) > 45:
|
|
job_name_label = "Name"
|
|
|
|
self.job_name.label = job_name_label
|
|
self.job_date.label = f"Date ({self.job.next_run_time.strftime('%Y-%m-%d %H:%M:%S')})"
|
|
|
|
# Replace placeholders with current values
|
|
self.job_name.placeholder = self.job.kwargs.get("message", "No message found")
|
|
self.job_date.placeholder = self.job.next_run_time.strftime("%Y-%m-%d %H:%M:%S %Z")
|
|
|
|
logger.info(f"Job '{job_name_label}' modified: Initializing modal")
|
|
logger.info(f"\tCurrent date: '{self.job.next_run_time}'")
|
|
logger.info(f"\tCurrent message: '{self.job.kwargs.get('message', 'No message found')}")
|
|
|
|
logger.info(f"\tName label: '{self.job_name.label}'")
|
|
logger.info(f"\tDate label: '{self.job_date.label}'")
|
|
|
|
async def on_submit(self, interaction: discord.Interaction) -> None:
|
|
"""Submit the job modifications.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
"""
|
|
job_msg: str = self.job.kwargs.get("message", "No message found")
|
|
logger.info(f"Job '{job_msg}' modified: Submitting changes")
|
|
new_name: str = self.job_name.value
|
|
new_date_str: str = self.job_date.value
|
|
old_date: datetime.datetime = self.job.next_run_time
|
|
|
|
# if both are empty, do nothing
|
|
if not new_name and not new_date_str:
|
|
logger.info(f"Job '{job_msg}' modified: No changes submitted.")
|
|
|
|
await interaction.response.send_message(
|
|
content=f"Job **{job_msg}**.\nNo changes submitted.",
|
|
ephemeral=True,
|
|
)
|
|
return
|
|
|
|
if new_date_str and new_date_str != old_date.strftime("%Y-%m-%d %H:%M:%S %Z"):
|
|
new_date: datetime.datetime | None = parse_time(new_date_str)
|
|
if not new_date:
|
|
logger.error(f"Job '{job_msg}' modified: Failed to parse date: '{new_date_str}'")
|
|
await interaction.response.send_message(
|
|
content=(
|
|
f"Failed modifying job **{job_msg}**\n"
|
|
f"Job ID: **{self.job.id}**\n"
|
|
f"Failed to parse date: **{new_date_str}**\n"
|
|
f"Defaulting to old date: **{old_date.strftime('%Y-%m-%d %H:%M:%S')}** {calc_time(old_date)}"
|
|
),
|
|
)
|
|
return
|
|
|
|
logger.info(f"Job '{job_msg}' modified: New date: '{new_date}'")
|
|
logger.info(f"Job '{job_msg}' modified: Old date: '{old_date}'")
|
|
self.job.modify(next_run_time=new_date)
|
|
|
|
old_date_str: str = old_date.strftime("%Y-%m-%d %H:%M:%S")
|
|
new_date_str: str = new_date.strftime("%Y-%m-%d %H:%M:%S")
|
|
|
|
await interaction.response.send_message(
|
|
content=(
|
|
f"Job **{job_msg}** was modified by {interaction.user.mention}:\n"
|
|
f"Job ID: **{self.job.id}**\n"
|
|
f"Old date: **{old_date_str}** {calculate(self.job)} {calc_time(old_date)}\n"
|
|
f"New date: **{new_date_str}** {calculate(self.job)} {calc_time(new_date)}"
|
|
),
|
|
)
|
|
|
|
if self.job_name.value and job_msg != new_name:
|
|
logger.info(f"Job '{job_msg}' modified: New name: '{new_name}'")
|
|
logger.info(f"Job '{job_msg}' modified: Old name: '{job_msg}'")
|
|
self.job.modify(name=new_name)
|
|
|
|
await interaction.response.send_message(
|
|
content=(
|
|
f"Job **{self.job.name}** was modified by {interaction.user.mention}:\n"
|
|
f"Job ID: **{self.job.id}**\n"
|
|
f"Old name: **{self.job.name}**\n"
|
|
f"New name: **{new_name}**"
|
|
),
|
|
)
|
|
|
|
|
|
def create_job_embed(job: Job) -> discord.Embed:
|
|
"""Create an embed for a job.
|
|
|
|
Args:
|
|
job: The job to create the embed for.
|
|
|
|
Returns:
|
|
discord.Embed: The embed for the job.
|
|
"""
|
|
job_kwargs: dict = job.kwargs or {}
|
|
|
|
msg: str = ""
|
|
if hasattr(job, "next_run_time"):
|
|
if job.next_run_time:
|
|
msg += f"Next run: {job.next_run_time.strftime('%Y-%m-%d %H:%M:%S')}\n"
|
|
else:
|
|
msg += "Status: Paused\n"
|
|
if isinstance(job.trigger, IntervalTrigger):
|
|
msg += f"Interval: {job.trigger.interval}\n"
|
|
|
|
# ID: d8a4e850245f4b06bcc04e53f13ccbbb
|
|
channel_id: int = job_kwargs.get("channel_id", 0)
|
|
if channel_id:
|
|
msg += f"Channel: <#{channel_id}>\n"
|
|
|
|
# Author: @TheLovinator
|
|
author_id: int = job_kwargs.get("author_id", 0)
|
|
if author_id:
|
|
msg += f"Created by: <@{author_id}>"
|
|
|
|
embed = discord.Embed(description=msg, color=discord.Color.blue())
|
|
embed.set_footer(text=f"{job.id}. Only jobs in the current guild are shown.")
|
|
|
|
# Set the title of the embed to the message of the job
|
|
message: str = job_kwargs.get("message", "N/A")
|
|
embed_title: str = f"{message[:256]}..." if len(message) > 256 else message
|
|
embed.title = embed_title
|
|
|
|
return embed
|
|
|
|
|
|
class JobSelector(Select):
|
|
"""Select menu for selecting a job to manage."""
|
|
|
|
def __init__(self, scheduler: AsyncIOScheduler, guild: discord.Guild) -> None:
|
|
"""Initialize the job selector.
|
|
|
|
Args:
|
|
scheduler: The scheduler to get the jobs from.
|
|
guild: The guild this view is for.
|
|
"""
|
|
self.scheduler: AsyncIOScheduler = scheduler
|
|
self.guild: discord.Guild = guild
|
|
|
|
options: list[discord.SelectOption] = []
|
|
jobs: list[Job] = scheduler.get_jobs()
|
|
|
|
jobs_in_guild: list[Job] = []
|
|
list_of_channels_in_current_guild: list[int] = [c.id for c in guild.channels]
|
|
for job in jobs:
|
|
# If the job has guild_id and it's not the current guild, skip it
|
|
if job.kwargs.get("guild_id") and job.kwargs.get("guild_id") != guild.id:
|
|
logger.debug(f"Skipping job: {job.id} because it's not in the current guild.")
|
|
continue
|
|
|
|
# If the job has channel_id and it's not in the current guild, skip it
|
|
if job.kwargs.get("channel_id") and job.kwargs.get("channel_id") not in list_of_channels_in_current_guild:
|
|
logger.debug(f"Skipping job: {job.id} because it's not from a channel in the current guild.")
|
|
continue
|
|
|
|
jobs_in_guild.append(job)
|
|
|
|
# Only 25 options are allowed in a select menu.
|
|
# TODO(TheLovinator): Add pagination for more than 25 jobs. # noqa: TD003
|
|
max_jobs: int = 25
|
|
if len(jobs_in_guild) > max_jobs:
|
|
jobs_in_guild = jobs_in_guild[:max_jobs]
|
|
|
|
for job in jobs_in_guild:
|
|
label_prefix: str = ""
|
|
label_prefix = "Paused: " if job.next_run_time is None else label_prefix
|
|
label_prefix = "Interval: " if isinstance(job.trigger, IntervalTrigger) else label_prefix
|
|
label_prefix = "Cron: " if isinstance(job.trigger, CronTrigger) else label_prefix
|
|
|
|
job_kwargs: dict = job.kwargs or {}
|
|
message: str = job_kwargs.get("message", f"{job.id}")
|
|
message = f"{label_prefix}{message}"
|
|
message = message[:96] + "..." if len(message) > 100 else message
|
|
|
|
options.append(discord.SelectOption(label=message, value=job.id))
|
|
|
|
super().__init__(placeholder="Select a job...", options=options)
|
|
|
|
async def callback(self, interaction: discord.Interaction) -> None:
|
|
"""Callback for the job selector.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
"""
|
|
job: Job | None = self.scheduler.get_job(self.values[0])
|
|
if job:
|
|
embed: discord.Embed = create_job_embed(job)
|
|
view = JobManagementView(job, self.scheduler, guild=self.guild)
|
|
await interaction.response.edit_message(embed=embed, view=view)
|
|
|
|
|
|
class JobManagementView(discord.ui.View):
|
|
"""View for managing jobs."""
|
|
|
|
def __init__(self, job: Job, scheduler: AsyncIOScheduler, guild: discord.Guild, message: discord.Message | None = None) -> None:
|
|
"""Initialize the job management view.
|
|
|
|
Args:
|
|
job: The job to manage.
|
|
scheduler: The scheduler to manage the job with.
|
|
guild: The guild this view is for.
|
|
message: The message to manage.
|
|
"""
|
|
super().__init__(timeout=None)
|
|
self.job: Job = job
|
|
self.scheduler: AsyncIOScheduler = scheduler
|
|
self.guild: discord.Guild = guild
|
|
self.message: discord.Message | None = message
|
|
|
|
self.add_item(JobSelector(scheduler, self.guild))
|
|
self.update_buttons()
|
|
|
|
logger.debug(f"JobManagementView created for job: {self.job.id}")
|
|
|
|
async def on_error(self, interaction: discord.Interaction, error: Exception, item: discord.ui.Item) -> None:
|
|
"""Handle errors that occur within the view.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
error: The exception that was raised.
|
|
item: The item that caused the error.
|
|
"""
|
|
with sentry_sdk.push_scope() as scope:
|
|
# Interaction-related context
|
|
scope.set_extra("interaction_id", interaction.id)
|
|
scope.set_extra("interaction_user", interaction.user.id)
|
|
scope.set_extra("interaction_user_tag", str(interaction.user))
|
|
scope.set_extra("interaction_command", interaction.command.name if interaction.command else None)
|
|
scope.set_extra("interaction_channel", str(interaction.channel))
|
|
scope.set_extra("interaction_guild", str(interaction.guild) if interaction.guild else None)
|
|
|
|
# Item-related context
|
|
scope.set_extra("item_type", type(item).__name__)
|
|
scope.set_extra("item_label", getattr(item, "label", None))
|
|
|
|
# Job and scheduler context
|
|
scope.set_extra("job_id", self.job.id if self.job else None)
|
|
scope.set_extra("job_kwargs", self.job.kwargs if self.job else None)
|
|
|
|
# Guild and message context
|
|
scope.set_extra("guild_id", self.guild.id if self.guild else None)
|
|
scope.set_extra("guild_name", self.guild.name if self.guild else None)
|
|
scope.set_extra("message_id", self.message.id if self.message else None)
|
|
scope.set_extra("message_content", self.message.content if self.message else None)
|
|
|
|
# Tags for categorization
|
|
scope.set_tag("error_type", type(error).__name__)
|
|
scope.set_tag("interaction_type", "command" if interaction.command else "other")
|
|
if interaction.guild:
|
|
scope.set_tag("guild_id", interaction.guild.id)
|
|
scope.set_tag("guild_name", interaction.guild.name)
|
|
|
|
sentry_sdk.capture_exception(error)
|
|
|
|
@discord.ui.button(label="Delete", style=discord.ButtonStyle.danger)
|
|
async def delete_button(self, interaction: discord.Interaction, button: Button) -> None: # noqa: ARG002
|
|
"""Delete the job.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
button: The button that was clicked.
|
|
"""
|
|
job_kwargs: dict = self.job.kwargs or {}
|
|
|
|
logger.info(f"Deleting job: {self.job.id}. Clicked by {interaction.user.name}")
|
|
if hasattr(self.job, "__getstate__"):
|
|
logger.debug(f"State: {self.job.__getstate__() if hasattr(self.job, '__getstate__') else 'No state'}")
|
|
|
|
job_msg: str | int = job_kwargs.get("message", "No message found")
|
|
msg: str = f"**Job '{job_msg}' has been deleted.**\n"
|
|
msg += f"**Job ID**: {self.job.id}"
|
|
|
|
# The time the job was supposed to run
|
|
if hasattr(self.job, "next_run_time"):
|
|
if self.job.next_run_time:
|
|
msg += f"\n**Next run time**: {self.job.next_run_time} ({calculate(self.job)})"
|
|
else:
|
|
msg += "\n**Next run time**: Paused"
|
|
msg += f"\n**Trigger**: {self.job.trigger}"
|
|
else:
|
|
msg += "\n**Next run time**: Pending\n"
|
|
|
|
# The Discord user who created the job
|
|
if job_kwargs.get("author_id"):
|
|
msg += f"\n**Created by**: <@{job_kwargs.get('author_id')}>"
|
|
|
|
# The Discord channel to send the message to
|
|
if job_kwargs.get("channel_id"):
|
|
msg += f"\n**Channel**: <#{job_kwargs.get('channel_id')}>"
|
|
|
|
# The Discord user to send the message to
|
|
if job_kwargs.get("user_id"):
|
|
msg += f"\n**User**: <@{job_kwargs.get('user_id')}>"
|
|
|
|
# The Discord guild to send the message to
|
|
if job_kwargs.get("guild_id"):
|
|
msg += f"\n**Guild**: {job_kwargs.get('guild_id')}"
|
|
|
|
logger.debug(f"Deletion message: {msg}")
|
|
|
|
self.job.remove()
|
|
await interaction.response.send_message(msg)
|
|
self.stop()
|
|
|
|
@discord.ui.button(label="Modify", style=discord.ButtonStyle.primary)
|
|
async def modify_button(self, interaction: discord.Interaction, button: Button) -> None: # noqa: ARG002
|
|
"""Modify the job.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
button: The button that was clicked.
|
|
"""
|
|
logger.info(f"Modifying job: {self.job.id}. Clicked by {interaction.user.name}")
|
|
if hasattr(self.job, "__getstate__"):
|
|
logger.debug(f"State: {self.job.__getstate__() if hasattr(self.job, '__getstate__') else 'No state'}")
|
|
|
|
modal = ModifyJobModal(self.job, self.scheduler)
|
|
await interaction.response.send_modal(modal)
|
|
|
|
@discord.ui.button(label="Pause/Resume", style=discord.ButtonStyle.secondary)
|
|
async def pause_button(self, interaction: discord.Interaction, button: Button) -> None:
|
|
"""Pause or resume the job.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
button: The button that was clicked.
|
|
"""
|
|
if hasattr(self.job, "next_run_time"):
|
|
if self.job.next_run_time is None:
|
|
logger.info(f"State: {self.job.__getstate__() if hasattr(self.job, '__getstate__') else 'No state'}")
|
|
self.job.resume()
|
|
status = "resumed"
|
|
button.label = "Pause"
|
|
else:
|
|
logger.info(f"State: {self.job.__getstate__() if hasattr(self.job, '__getstate__') else 'No state'}")
|
|
self.job.pause()
|
|
status = "paused"
|
|
button.label = "Resume"
|
|
else:
|
|
logger.error(f"Got a job without a next_run_time: {self.job.id}")
|
|
status: str = f"What is this? {self.job.__getstate__()}"
|
|
button.label = "What?"
|
|
|
|
self.update_buttons()
|
|
await interaction.response.edit_message(view=self)
|
|
|
|
job_kwargs: dict = self.job.kwargs or {}
|
|
job_msg: str = job_kwargs.get("message", "No message found")
|
|
job_author: int = job_kwargs.get("author_id", 0)
|
|
msg: str = f"Job '{job_msg}' has been {status} by <@{interaction.user.id}>. Job was created by <@{job_author}>."
|
|
|
|
# The time the job was supposed to run
|
|
if hasattr(self.job, "next_run_time"):
|
|
if self.job.next_run_time:
|
|
msg += f"\n**Next run time**: {self.job.next_run_time} ({calculate(self.job)})"
|
|
else:
|
|
msg += "\n**Next run time**: Paused"
|
|
msg += f"\n**Trigger**: {self.job.trigger}"
|
|
else:
|
|
msg += "\n**Next run time**: Pending"
|
|
|
|
await interaction.followup.send(msg)
|
|
|
|
def update_buttons(self) -> None:
|
|
"""Update the visibility of buttons based on job status."""
|
|
logger.debug(f"Updating buttons for job: {self.job.id}")
|
|
self.pause_button.label = "Resume" if self.job.next_run_time is None else "Pause"
|
|
|
|
logger.debug(f"Pause button disabled: {self.pause_button.disabled}")
|
|
logger.debug(f"Pause button label: {self.pause_button.label}")
|
|
|
|
async def interaction_check(self, interaction: discord.Interaction) -> bool: # noqa: ARG002
|
|
"""Check the interaction and update buttons before responding.
|
|
|
|
Args:
|
|
interaction: The interaction object for the command.
|
|
|
|
Returns:
|
|
bool: Whether the interaction is valid.
|
|
"""
|
|
logger.info(f"Checking interaction for job: {self.job.id}")
|
|
# self.update_buttons()
|
|
return True
|