Move everything out of main.py
This commit is contained in:
0
discord_reminder_bot/commands/__init__.py
Normal file
0
discord_reminder_bot/commands/__init__.py
Normal file
116
discord_reminder_bot/commands/add.py
Normal file
116
discord_reminder_bot/commands/add.py
Normal file
@ -0,0 +1,116 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from loguru import logger
|
||||
|
||||
from discord_reminder_bot.parsers import calculate, parse_time
|
||||
from discord_reminder_bot.settings import scheduler
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import datetime
|
||||
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from discord.interactions import InteractionChannel
|
||||
|
||||
|
||||
async def add_reminder_job(
|
||||
interaction: discord.Interaction,
|
||||
message: str,
|
||||
time: str,
|
||||
channel: discord.TextChannel | None = None,
|
||||
user: discord.User | None = None,
|
||||
dm_and_current_channel: bool | None = None,
|
||||
) -> None:
|
||||
"""Adds a reminder job to the scheduler based on user input.
|
||||
|
||||
Schedules a message to be sent at a specified time either to a specific channel,
|
||||
a specific user via direct message, or both. It handles permission checks,
|
||||
time parsing, and job creation using the APScheduler instance.
|
||||
|
||||
Args:
|
||||
interaction: The discord interaction object initiated by the user command.
|
||||
message: The content of the reminder message to be sent.
|
||||
time: A string representing the date and time for the reminder.
|
||||
This string will be parsed to a datetime object.
|
||||
channel: The target text channel for the reminder. If None, defaults
|
||||
to the channel where the interaction occurred.
|
||||
user: The target user to send a direct message reminder to. If None,
|
||||
no direct message is scheduled.
|
||||
dm_and_current_channel: If True and a user is specified, sends the
|
||||
reminder to both the user's DM and the target channel. If False
|
||||
and a user is specified, only sends the DM. Defaults to None,
|
||||
behaving like False if only a user is specified, or sending only
|
||||
to the channel if no user is specified.
|
||||
|
||||
"""
|
||||
logger.info(f"New reminder from {interaction.user} ({interaction.user.id}) in {interaction.channel}")
|
||||
logger.info(f"Arguments: {locals()}")
|
||||
|
||||
# Check if we have access to the specified channel or the current channel
|
||||
target_channel: InteractionChannel | discord.TextChannel | None = channel or interaction.channel
|
||||
if target_channel and interaction.guild and not target_channel.permissions_for(interaction.guild.me).send_messages:
|
||||
await interaction.followup.send(content=f"I don't have permission to send messages in <#{target_channel.id}>.", ephemeral=True)
|
||||
|
||||
# Get the channel ID
|
||||
channel_id: int | None = channel.id if channel else (interaction.channel.id if interaction.channel else None)
|
||||
if not channel_id:
|
||||
await interaction.followup.send(content="Failed to get channel.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Ensure the guild is valid
|
||||
guild: discord.Guild | None = interaction.guild or None
|
||||
if not guild:
|
||||
await interaction.followup.send(content="Failed to get guild.", ephemeral=True)
|
||||
return
|
||||
|
||||
dm_message: str = ""
|
||||
if user:
|
||||
parsed_time: datetime.datetime | None = parse_time(date_to_parse=time)
|
||||
if not parsed_time:
|
||||
await interaction.followup.send(content=f"Failed to parse time: {time}.", ephemeral=True)
|
||||
return
|
||||
|
||||
user_reminder: Job = scheduler.add_job(
|
||||
func="discord_reminder_bot.main:send_to_user",
|
||||
trigger="date",
|
||||
run_date=parsed_time,
|
||||
kwargs={
|
||||
"user_id": user.id,
|
||||
"guild_id": guild.id,
|
||||
"message": message,
|
||||
},
|
||||
)
|
||||
logger.info(f"User reminder job created: {user_reminder} for {user.id} at {parsed_time}")
|
||||
|
||||
dm_message = f" and a DM to {user.display_name}"
|
||||
if not dm_and_current_channel:
|
||||
msg = (
|
||||
f"Hello {interaction.user.display_name},\n"
|
||||
f"I will send a DM to {user.display_name} at:\n"
|
||||
f"First run in {calculate(user_reminder)} with the message:\n**{message}**."
|
||||
)
|
||||
await interaction.followup.send(content=msg)
|
||||
return
|
||||
|
||||
# Create channel reminder job
|
||||
channel_job: Job = scheduler.add_job(
|
||||
func="discord_reminder_bot.main:send_to_channel",
|
||||
trigger="date",
|
||||
run_date=parse_time(date_to_parse=time),
|
||||
kwargs={
|
||||
"channel_id": channel_id,
|
||||
"message": message,
|
||||
"author_id": interaction.user.id,
|
||||
},
|
||||
)
|
||||
logger.info(f"Channel reminder job created: {channel_job} for {channel_id}")
|
||||
|
||||
msg: str = (
|
||||
f"Hello {interaction.user.display_name},\n"
|
||||
f"I will notify you in <#{channel_id}>{dm_message}.\n"
|
||||
f"First run in {calculate(channel_job)} with the message:\n**{message}**."
|
||||
)
|
||||
|
||||
await interaction.followup.send(content=msg)
|
96
discord_reminder_bot/commands/backup.py
Normal file
96
discord_reminder_bot/commands/backup.py
Normal file
@ -0,0 +1,96 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import datetime
|
||||
import json
|
||||
import tempfile
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import discord
|
||||
from loguru import logger
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
from discord.interactions import InteractionChannel
|
||||
|
||||
|
||||
async def backup_reminder_job(interaction: discord.Interaction, scheduler: AsyncIOScheduler, all_servers: bool) -> None:
|
||||
"""Backs up reminder jobs from the scheduler to a JSON file.
|
||||
|
||||
Exports jobs from the provided AsyncIOScheduler to a temporary JSON file.
|
||||
If `all_servers` is False, it filters the jobs to include only those
|
||||
associated with the guild where the command was invoked. This requires
|
||||
the invoking user to have administrator permissions in that guild.
|
||||
The resulting list of jobs (either all or filtered) is then written
|
||||
to another temporary JSON file and sent as an attachment via the
|
||||
interaction followup, along with a confirmation message.
|
||||
|
||||
Args:
|
||||
interaction: The discord interaction object that triggered the command.
|
||||
scheduler: The AsyncIOScheduler instance containing the jobs to back up.
|
||||
all_servers: If True, backs up jobs from all servers managed by the
|
||||
scheduler. If False, backs up only jobs associated with the
|
||||
server (guild) where the command was invoked.
|
||||
"""
|
||||
logger.info(f"Backing up reminders for {interaction.user} ({interaction.user.id}) in {interaction.channel}")
|
||||
logger.info(f"Arguments: {locals()}")
|
||||
|
||||
# Retrieve all jobs
|
||||
with tempfile.NamedTemporaryFile(mode="r+", delete=False, encoding="utf-8", suffix=".json") as temp_file:
|
||||
# Export jobs to a temporary file
|
||||
scheduler.export_jobs(temp_file.name)
|
||||
|
||||
# Load the exported jobs
|
||||
temp_file.seek(0)
|
||||
jobs_data = json.load(temp_file)
|
||||
|
||||
# Amount of jobs before filtering
|
||||
amount_of_jobs: int = len(jobs_data.get("jobs", []))
|
||||
|
||||
if not all_servers:
|
||||
interaction_channel: InteractionChannel | None = interaction.channel
|
||||
if not interaction_channel:
|
||||
await interaction.followup.send(content="Failed to get channel.", ephemeral=True)
|
||||
return
|
||||
|
||||
if not isinstance(interaction.user, discord.Member):
|
||||
await interaction.followup.send(content="Failed to get user.", ephemeral=True)
|
||||
return
|
||||
|
||||
is_admin: bool = interaction_channel.permissions_for(interaction.user).administrator
|
||||
if not is_admin:
|
||||
await interaction.followup.send(content="You must be an administrator to backup all servers.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Can't be 0 because that's the default value for jobs without a guild
|
||||
guild_id: int = interaction.guild.id if interaction.guild else -1
|
||||
channels_in_this_guild: list[int] = [c.id for c in interaction.guild.channels] if interaction.guild else []
|
||||
logger.debug(f"Guild ID: {guild_id}")
|
||||
|
||||
for job in jobs_data.get("jobs", []):
|
||||
# Check if the job is in the current guild
|
||||
job_guild_id = int(job.get("kwargs", {}).get("guild_id", 0))
|
||||
if job_guild_id and job_guild_id != guild_id:
|
||||
logger.debug(f"Skipping job: {job.get('id')} because it's not in the current guild.")
|
||||
jobs_data["jobs"].remove(job)
|
||||
|
||||
# Check if the channel is in the current guild
|
||||
if job.get("kwargs", {}).get("channel_id") not in channels_in_this_guild:
|
||||
logger.debug(f"Skipping job: {job.get('id')} because it's not in the current guild.")
|
||||
jobs_data["jobs"].remove(job)
|
||||
|
||||
msg: str = "All reminders in this server have been backed up." if not all_servers else "All reminders have been backed up."
|
||||
msg += "\nYou can restore them using `/remind restore`."
|
||||
|
||||
if not all_servers:
|
||||
msg += f"\nAmount of jobs on all servers: {amount_of_jobs}, in this server: {len(jobs_data.get('jobs', []))}"
|
||||
msg += "\nYou can use `/remind backup all_servers:True` to backup all servers."
|
||||
else:
|
||||
msg += f"\nAmount of jobs: {amount_of_jobs}"
|
||||
|
||||
# Write the data to a new file
|
||||
with tempfile.NamedTemporaryFile(mode="w", delete=False, encoding="utf-8", suffix=".json") as output_file:
|
||||
file_name: str = f"reminders-backup-{datetime.datetime.now(tz=scheduler.timezone)}.json"
|
||||
json.dump(jobs_data, output_file, indent=4)
|
||||
output_file.seek(0)
|
||||
|
||||
await interaction.followup.send(content=msg, file=discord.File(output_file.name, filename=file_name))
|
139
discord_reminder_bot/commands/cron.py
Normal file
139
discord_reminder_bot/commands/cron.py
Normal file
@ -0,0 +1,139 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import discord
|
||||
|
||||
from discord_reminder_bot.parsers import calculate
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
|
||||
logger: logging.Logger = logging.getLogger("discord_reminder_bot")
|
||||
|
||||
|
||||
async def cron_reminder_job(
|
||||
interaction: discord.Interaction,
|
||||
scheduler: AsyncIOScheduler,
|
||||
message: str,
|
||||
year: str | None = None,
|
||||
month: str | None = None,
|
||||
day: str | None = None,
|
||||
week: str | None = None,
|
||||
day_of_week: str | None = None,
|
||||
hour: str | None = None,
|
||||
minute: str | None = None,
|
||||
second: str | None = None,
|
||||
start_date: str | None = None,
|
||||
end_date: str | None = None,
|
||||
timezone: str | None = None,
|
||||
jitter: int | None = None,
|
||||
channel: discord.TextChannel | None = None,
|
||||
user: discord.User | None = None,
|
||||
dm_and_current_channel: bool | None = None,
|
||||
) -> None:
|
||||
"""Create a new cron job.
|
||||
|
||||
Args that are None will be defaulted to *.
|
||||
|
||||
Args:
|
||||
interaction (discord.Interaction): The interaction object for the command.
|
||||
scheduler (AsyncIOScheduler): The scheduler to add the job to.
|
||||
message (str): The content of the reminder.
|
||||
year (str): 4-digit year. Defaults to *.
|
||||
month (str): Month (1-12). Defaults to *.
|
||||
day (str): Day of the month (1-31). Defaults to *.
|
||||
week (str): ISO Week of the year (1-53). Defaults to *.
|
||||
day_of_week (str): Number or name of weekday (0-6 or mon,tue,wed,thu,fri,sat,sun).
|
||||
hour (str): Hour (0-23). Defaults to *.
|
||||
minute (str): Minute (0-59). Defaults to *.
|
||||
second (str): Second (0-59). Defaults to *.
|
||||
start_date (str): Earliest possible date/time to trigger on (inclusive). Will get parsed.
|
||||
end_date (str): Latest possible date/time to trigger on (inclusive). Will get parsed.
|
||||
timezone (str): Time zone to use for the date/time calculations Defaults to scheduler timezone.
|
||||
jitter (int, optional): Delay the job execution by jitter seconds at most.
|
||||
channel (discord.TextChannel, optional): The channel to send the reminder to. Defaults to current channel.
|
||||
user (discord.User, optional): Send reminder as a DM to this user. Defaults to None.
|
||||
dm_and_current_channel (bool, optional): If user is provided, send reminder as a DM to the user and in this channel. Defaults to only the user.
|
||||
"""
|
||||
# Log kwargs
|
||||
logger.info("New cron job from %s (%s) in %s", interaction.user, interaction.user.id, interaction.channel)
|
||||
logger.info("Cron job arguments: %s", locals())
|
||||
|
||||
# Get the channel ID
|
||||
channel_id: int | None = channel.id if channel else (interaction.channel.id if interaction.channel else None)
|
||||
if not channel_id:
|
||||
await interaction.followup.send(content="Failed to get channel.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Ensure the guild is valid
|
||||
guild: discord.Guild | None = interaction.guild or None
|
||||
if not guild:
|
||||
await interaction.followup.send(content="Failed to get guild.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Create user DM reminder job if user is specified
|
||||
dm_message: str = ""
|
||||
if user:
|
||||
user_reminder: Job = scheduler.add_job(
|
||||
func="discord_reminder_bot.main:send_to_user",
|
||||
trigger="cron",
|
||||
year=year,
|
||||
month=month,
|
||||
day=day,
|
||||
week=week,
|
||||
day_of_week=day_of_week,
|
||||
hour=hour,
|
||||
minute=minute,
|
||||
second=second,
|
||||
start_date=start_date,
|
||||
end_date=end_date,
|
||||
timezone=timezone,
|
||||
jitter=jitter,
|
||||
kwargs={
|
||||
"user_id": user.id,
|
||||
"guild_id": guild.id,
|
||||
"message": message,
|
||||
},
|
||||
)
|
||||
|
||||
dm_message = f" and a DM to {user.display_name}"
|
||||
if not dm_and_current_channel:
|
||||
await interaction.followup.send(
|
||||
content=f"Hello {interaction.user.display_name},\n"
|
||||
f"I will send a DM to {user.display_name} at:\n"
|
||||
f"First run in {calculate(user_reminder)} with the message:\n**{message}**.",
|
||||
)
|
||||
return
|
||||
|
||||
# Create channel reminder job
|
||||
channel_job: Job = scheduler.add_job(
|
||||
func="discord_reminder_bot.main:send_to_channel",
|
||||
trigger="cron",
|
||||
year=year,
|
||||
month=month,
|
||||
day=day,
|
||||
week=week,
|
||||
day_of_week=day_of_week,
|
||||
hour=hour,
|
||||
minute=minute,
|
||||
second=second,
|
||||
start_date=start_date,
|
||||
end_date=end_date,
|
||||
timezone=timezone,
|
||||
jitter=jitter,
|
||||
kwargs={
|
||||
"channel_id": channel_id,
|
||||
"message": message,
|
||||
"author_id": interaction.user.id,
|
||||
},
|
||||
)
|
||||
|
||||
await interaction.followup.send(
|
||||
content=f"Hello {interaction.user.display_name},\n"
|
||||
f"I will notify you in <#{channel_id}>{dm_message}.\n"
|
||||
f"First run in {calculate(channel_job)} with the message:\n**{message}**.",
|
||||
)
|
99
discord_reminder_bot/commands/event.py
Normal file
99
discord_reminder_bot/commands/event.py
Normal file
@ -0,0 +1,99 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import datetime
|
||||
|
||||
import discord
|
||||
from loguru import logger
|
||||
|
||||
from discord_reminder_bot.parsers import parse_time
|
||||
|
||||
|
||||
async def add_discord_event(
|
||||
interaction: discord.Interaction,
|
||||
message: str,
|
||||
event_start: str,
|
||||
event_end: str,
|
||||
location: str,
|
||||
reason: str | None = None,
|
||||
) -> None:
|
||||
"""Creates a new Discord scheduled event based on user input.
|
||||
|
||||
This command handles the creation of a scheduled event within the Discord guild
|
||||
where the interaction originated. It parses the provided start and end times,
|
||||
validates permissions, and creates the event using the Discord API. If the
|
||||
specified start time is in the past, it adjusts the start time to be slightly
|
||||
in the future and starts the event immediately.
|
||||
|
||||
Args:
|
||||
interaction: The discord interaction object representing the command invocation.
|
||||
message: The name or description for the scheduled event.
|
||||
event_start: A string representing the desired start time for the event.
|
||||
This string will be parsed into a datetime object.
|
||||
event_end: A string representing the desired end time for the event.
|
||||
This string will be parsed into a datetime object.
|
||||
location: A string specifying the location for the event (e.g., a URL or physical address).
|
||||
reason: An optional string providing a reason for the event creation,
|
||||
visible in the guild's audit log. Defaults to a standard message
|
||||
indicating the creator if None.
|
||||
"""
|
||||
logger.info(f"New event from {interaction.user} ({interaction.user.id}) in {interaction.channel}")
|
||||
logger.info(f"Arguments: {locals()}")
|
||||
|
||||
# Check if we have a valid guild
|
||||
guild: discord.Guild | None = interaction.guild
|
||||
if not guild:
|
||||
await interaction.followup.send(content="This command can only be used in a server.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Check if we have permission to create events
|
||||
if not guild.me.guild_permissions.create_events:
|
||||
await interaction.followup.send(content="I don't have permission to create events in this guild.", ephemeral=True)
|
||||
return
|
||||
|
||||
event_start_time: datetime.datetime | None = parse_time(date_to_parse=event_start)
|
||||
event_end_time: datetime.datetime | None = parse_time(date_to_parse=event_end)
|
||||
|
||||
if not event_start_time or not event_end_time:
|
||||
await interaction.followup.send(content=f"Failed to parse time: {event_start} or {event_end}.", ephemeral=True)
|
||||
return
|
||||
|
||||
# If event_start_time is in the past, make it now + 5 seconds
|
||||
start_immediately: bool = False
|
||||
if event_start_time < datetime.datetime.now(event_start_time.tzinfo):
|
||||
start_immediately = True
|
||||
event_start_time = datetime.datetime.now(event_start_time.tzinfo) + datetime.timedelta(seconds=5)
|
||||
await interaction.followup.send(content="Event start time was in the past. Starting event in 5 seconds instead.")
|
||||
|
||||
reason_msg: str = f"Event created by {interaction.user} ({interaction.user.id})."
|
||||
|
||||
event: discord.ScheduledEvent = await guild.create_scheduled_event(
|
||||
name=message,
|
||||
start_time=event_start_time,
|
||||
entity_type=discord.EntityType.external,
|
||||
privacy_level=discord.PrivacyLevel.guild_only,
|
||||
end_time=event_end_time,
|
||||
reason=reason or reason_msg,
|
||||
location=location,
|
||||
)
|
||||
|
||||
if start_immediately:
|
||||
await event.start()
|
||||
|
||||
msg: str = f"Event '{event.name}' created successfully!\n"
|
||||
|
||||
if event.start_time:
|
||||
msg += f"Start Time: <t:{int(event.start_time.timestamp())}:R>\n"
|
||||
|
||||
if event.end_time:
|
||||
msg += f"End Time: <t:{int(event.end_time.timestamp())}:R>\n"
|
||||
|
||||
if event.channel_id:
|
||||
msg += f"Channel: <#{event.channel_id}>\n"
|
||||
|
||||
if event.location:
|
||||
msg += f"Location: {event.location}\n"
|
||||
|
||||
if event.creator_id:
|
||||
msg += f"Created by: <@{event.creator_id}>"
|
||||
|
||||
await interaction.followup.send(content=msg)
|
135
discord_reminder_bot/commands/interval.py
Normal file
135
discord_reminder_bot/commands/interval.py
Normal file
@ -0,0 +1,135 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from discord_reminder_bot.parsers import calculate
|
||||
from discord_reminder_bot.settings import scheduler
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from discord.interactions import InteractionChannel
|
||||
|
||||
|
||||
logger: logging.Logger = logging.getLogger("discord_reminder_bot")
|
||||
|
||||
|
||||
async def interval_reminder_job(
|
||||
interaction: discord.Interaction,
|
||||
message: str,
|
||||
weeks: int = 0,
|
||||
days: int = 0,
|
||||
hours: int = 0,
|
||||
minutes: int = 0,
|
||||
seconds: int = 0,
|
||||
start_date: str | None = None,
|
||||
end_date: str | None = None,
|
||||
timezone: str | None = None,
|
||||
jitter: int | None = None,
|
||||
channel: discord.TextChannel | None = None,
|
||||
user: discord.User | None = None,
|
||||
dm_and_current_channel: bool | None = None,
|
||||
) -> None:
|
||||
"""Create a new reminder that triggers based on an interval.
|
||||
|
||||
Args:
|
||||
interaction (discord.Interaction): The interaction object for the command.
|
||||
message (str): The content of the reminder.
|
||||
weeks (int, optional): Number of weeks between each run. Defaults to 0.
|
||||
days (int, optional): Number of days between each run. Defaults to 0.
|
||||
hours (int, optional): Number of hours between each run. Defaults to 0.
|
||||
minutes (int, optional): Number of minutes between each run. Defaults to 0.
|
||||
seconds (int, optional): Number of seconds between each run. Defaults to 0.
|
||||
start_date (str, optional): Earliest possible date/time to trigger on (inclusive). Will get parsed.
|
||||
end_date (str, optional): Latest possible date/time to trigger on (inclusive). Will get parsed.
|
||||
timezone (str, optional): Time zone to use for the date/time calculations Defaults to scheduler timezone.
|
||||
jitter (int, optional): Delay the job execution by jitter seconds at most.
|
||||
channel (discord.TextChannel, optional): The channel to send the reminder to. Defaults to current channel.
|
||||
user (discord.User, optional): Send reminder as a DM to this user. Defaults to None.
|
||||
dm_and_current_channel (bool, optional): If user is provided, send reminder as a DM to the user and in this channel. Defaults to only the user.
|
||||
"""
|
||||
logger.info("New interval job from %s (%s) in %s", interaction.user, interaction.user.id, interaction.channel)
|
||||
logger.info("Arguments: %s", locals())
|
||||
|
||||
# Only allow intervals of 30 seconds or more so we don't spam the channel
|
||||
if weeks == days == hours == minutes == 0 and seconds < 30:
|
||||
await interaction.followup.send(content="Interval must be at least 30 seconds.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Check if we have access to the specified channel or the current channel
|
||||
target_channel: InteractionChannel | None = channel or interaction.channel
|
||||
if target_channel and interaction.guild and not target_channel.permissions_for(interaction.guild.me).send_messages:
|
||||
await interaction.followup.send(
|
||||
content=f"I don't have permission to send messages in <#{target_channel.id}>.",
|
||||
ephemeral=True,
|
||||
)
|
||||
|
||||
# Get the channel ID
|
||||
channel_id: int | None = channel.id if channel else (interaction.channel.id if interaction.channel else None)
|
||||
if not channel_id:
|
||||
await interaction.followup.send(content="Failed to get channel.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Ensure the guild is valid
|
||||
guild: discord.Guild | None = interaction.guild or None
|
||||
if not guild:
|
||||
await interaction.followup.send(content="Failed to get guild.", ephemeral=True)
|
||||
return
|
||||
|
||||
# Create user DM reminder job if user is specified
|
||||
dm_message: str = ""
|
||||
if user:
|
||||
dm_job: Job = scheduler.add_job(
|
||||
func="discord_reminder_bot.main:send_to_user",
|
||||
trigger="interval",
|
||||
weeks=weeks,
|
||||
days=days,
|
||||
hours=hours,
|
||||
minutes=minutes,
|
||||
seconds=seconds,
|
||||
start_date=start_date,
|
||||
end_date=end_date,
|
||||
timezone=timezone,
|
||||
jitter=jitter,
|
||||
kwargs={
|
||||
"user_id": user.id,
|
||||
"guild_id": guild.id,
|
||||
"message": message,
|
||||
},
|
||||
)
|
||||
|
||||
dm_message = f" and a DM to {user.display_name} "
|
||||
if not dm_and_current_channel:
|
||||
await interaction.followup.send(
|
||||
content=f"Hello {interaction.user.display_name},\n"
|
||||
f"I will send a DM to {user.display_name} at:\n"
|
||||
f"First run in {calculate(dm_job)} with the message:\n**{message}**.",
|
||||
)
|
||||
|
||||
# Create channel reminder job
|
||||
# TODO(TheLovinator): Test that "discord_reminder_bot.main:send_to_channel" is always there # noqa: TD003
|
||||
channel_job: Job = scheduler.add_job(
|
||||
func="discord_reminder_bot.main:send_to_channel",
|
||||
trigger="interval",
|
||||
weeks=weeks,
|
||||
days=days,
|
||||
hours=hours,
|
||||
minutes=minutes,
|
||||
seconds=seconds,
|
||||
start_date=start_date,
|
||||
end_date=end_date,
|
||||
timezone=timezone,
|
||||
jitter=jitter,
|
||||
kwargs={
|
||||
"channel_id": channel_id,
|
||||
"message": message,
|
||||
"author_id": interaction.user.id,
|
||||
},
|
||||
)
|
||||
|
||||
await interaction.followup.send(
|
||||
content=f"Hello {interaction.user.display_name},\n"
|
||||
f"I will notify you in <#{channel_id}>{dm_message}.\n"
|
||||
f"First run in {calculate(channel_job)} with the message:\n**{message}**.",
|
||||
)
|
53
discord_reminder_bot/commands/list.py
Normal file
53
discord_reminder_bot/commands/list.py
Normal file
@ -0,0 +1,53 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import discord
|
||||
from loguru import logger
|
||||
|
||||
from discord_reminder_bot.markdown_utils import generate_reminder_summary
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from apscheduler.job import Job
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
|
||||
|
||||
async def list_reminder_job(interaction: discord.Interaction, scheduler: AsyncIOScheduler) -> None:
|
||||
"""List all reminder jobs in the scheduler.
|
||||
|
||||
Args:
|
||||
interaction (discord.Interaction): The interaction object for the command.
|
||||
scheduler (AsyncIOScheduler): The scheduler to list the jobs from.
|
||||
"""
|
||||
user: discord.User | discord.Member = interaction.user
|
||||
if not isinstance(user, discord.Member):
|
||||
await interaction.followup.send(content="This command can only be used in a server.", ephemeral=True)
|
||||
return
|
||||
|
||||
channel = interaction.channel
|
||||
if not isinstance(channel, discord.TextChannel):
|
||||
await interaction.followup.send(content="This command can only be used in a text channel.", ephemeral=True)
|
||||
return
|
||||
|
||||
logger.info(f"Listing reminders for {user} ({user.id}) in {interaction.channel}")
|
||||
logger.info(f"Arguments: {locals()}")
|
||||
|
||||
jobs: list[Job] = scheduler.get_jobs()
|
||||
if not jobs:
|
||||
await interaction.followup.send(content="No scheduled jobs found in the database.", ephemeral=True)
|
||||
return
|
||||
|
||||
guild: discord.Guild | None = interaction.guild
|
||||
if not guild:
|
||||
await interaction.followup.send(content="Failed to get guild.", ephemeral=True)
|
||||
return
|
||||
|
||||
message: discord.InteractionMessage = await interaction.original_response()
|
||||
|
||||
job_summary: list[str] = generate_reminder_summary(ctx=interaction)
|
||||
|
||||
for i, msg in enumerate(job_summary):
|
||||
if i == 0:
|
||||
await message.edit(content=msg)
|
||||
else:
|
||||
await interaction.followup.send(content=msg)
|
44
discord_reminder_bot/commands/pause.py
Normal file
44
discord_reminder_bot/commands/pause.py
Normal file
@ -0,0 +1,44 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from apscheduler.jobstores.base import JobLookupError
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
|
||||
logger: logging.Logger = logging.getLogger("discord_reminder_bot")
|
||||
|
||||
|
||||
async def pause_reminder_job(interaction: discord.Interaction, job_id: str, scheduler: AsyncIOScheduler) -> None:
|
||||
"""Pauses a specific reminder job in the APScheduler.
|
||||
|
||||
This function attempts to find and pause a job identified by `job_id`
|
||||
within the provided `scheduler`. It logs the action and sends feedback
|
||||
to the user via the Discord interaction, indicating success or failure.
|
||||
|
||||
Args:
|
||||
interaction: The Discord interaction object representing the command invocation.
|
||||
job_id: The unique identifier of the reminder job to pause.
|
||||
scheduler: The AsyncIOScheduler instance managing the reminder jobs.
|
||||
"""
|
||||
logger.info("Pausing reminder with ID %s for %s (%s) in %s", job_id, interaction.user, interaction.user.id, interaction.channel)
|
||||
logger.debug("Arguments: %s", locals())
|
||||
|
||||
logger.debug("Attempting to pause job...")
|
||||
try:
|
||||
job: Job | None = scheduler.get_job(job_id)
|
||||
if not job:
|
||||
await interaction.followup.send(content=f"Reminder with ID {job_id} not found.", ephemeral=True)
|
||||
return
|
||||
scheduler.pause_job(job_id)
|
||||
logger.info("Paused job %s.", job_id)
|
||||
await interaction.followup.send(content=f"Reminder with ID {job_id} paused successfully.")
|
||||
except JobLookupError as e:
|
||||
logger.exception("Failed to pause job %s", job_id)
|
||||
await interaction.followup.send(content=f"Failed to pause reminder with ID {job_id}. {e}", ephemeral=True)
|
||||
|
||||
logger.info("Job %s paused in the scheduler.", job_id)
|
51
discord_reminder_bot/commands/remove.py
Normal file
51
discord_reminder_bot/commands/remove.py
Normal file
@ -0,0 +1,51 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from apscheduler.jobstores.base import JobLookupError
|
||||
from loguru import logger
|
||||
|
||||
from discord_reminder_bot.markdown_utils import generate_markdown_state
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
|
||||
|
||||
async def remove_reminder_job(interaction: discord.Interaction, job_id: str, scheduler: AsyncIOScheduler) -> None:
|
||||
"""Removes a specific reminder job from the scheduler based on its ID.
|
||||
|
||||
This function attempts to find a job associated with the given `job_id`
|
||||
within the provided `scheduler`. If the job exists, it is removed,
|
||||
and a confirmation message detailing the removed job's state is sent
|
||||
as a follow-up to the interaction. If the job cannot be found, or if
|
||||
an error occurs during the removal process (like `JobLookupError`),
|
||||
an appropriate error message is sent as an ephemeral follow-up.
|
||||
|
||||
Args:
|
||||
interaction (discord.Interaction): The Discord interaction object
|
||||
that triggered the command. Used for sending follow-up messages.
|
||||
job_id (str): The unique identifier of the reminder job to be removed.
|
||||
scheduler (AsyncIOScheduler): The APScheduler instance managing the
|
||||
scheduled reminder jobs.
|
||||
|
||||
"""
|
||||
logger.debug(f"Removing reminder with ID {job_id} for {interaction.user} ({interaction.user.id}) in {interaction.channel}")
|
||||
logger.debug(f"Arguments: {locals()}")
|
||||
|
||||
try:
|
||||
job: Job | None = scheduler.get_job(job_id)
|
||||
if not job:
|
||||
await interaction.followup.send(content=f"Reminder with ID {job_id} not found.", ephemeral=True)
|
||||
return
|
||||
scheduler.remove_job(job_id)
|
||||
logger.info(f"Removed job {job_id}. {job.__getstate__()}")
|
||||
await interaction.followup.send(
|
||||
content=f"Reminder with ID {job_id} removed successfully.\n{generate_markdown_state(job.__getstate__())}",
|
||||
)
|
||||
except JobLookupError as e:
|
||||
logger.exception(f"Failed to remove job {job_id}")
|
||||
await interaction.followup.send(content=f"Failed to remove reminder with ID {job_id}. {e}", ephemeral=True)
|
||||
|
||||
logger.info(f"Job {job_id} removed from the scheduler.")
|
129
discord_reminder_bot/commands/restore.py
Normal file
129
discord_reminder_bot/commands/restore.py
Normal file
@ -0,0 +1,129 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import logging
|
||||
import tempfile
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
import discord
|
||||
|
||||
from discord_reminder_bot.parsers import calculate
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
|
||||
logger: logging.Logger = logging.getLogger("discord_reminder_bot")
|
||||
|
||||
|
||||
async def restore_reminder_job(bot: discord.Client, interaction: discord.Interaction, scheduler: AsyncIOScheduler) -> None: # noqa: PLR0915
|
||||
"""Restores reminder jobs from a user-provided JSON backup file.
|
||||
|
||||
Prompts the user via the interaction followup to reply with a JSON file
|
||||
containing the backup data. Waits for a message reply from the same user
|
||||
in the same channel containing a single JSON attachment.
|
||||
Validates the reply and attachment. Downloads the JSON file to a temporary
|
||||
location, loads the job data, filters out any jobs that already exist in the
|
||||
scheduler (based on job ID), and imports the remaining jobs using
|
||||
`scheduler.import_jobs`.
|
||||
Finally, sends a confirmation message listing the newly added jobs or
|
||||
indicates if no new jobs were added.
|
||||
|
||||
Args:
|
||||
bot (discord.Client): The Discord bot client instance, used to wait for
|
||||
the user's reply message.
|
||||
interaction (discord.Interaction): The interaction object representing the
|
||||
command invocation. Used for sending messages back to the user.
|
||||
scheduler (AsyncIOScheduler): The APScheduler instance where the jobs
|
||||
will be restored.
|
||||
"""
|
||||
logger.info("Restoring reminders from file for %s (%s) in %s", interaction.user, interaction.user.id, interaction.channel)
|
||||
logger.info("Arguments: %s", locals())
|
||||
|
||||
# Tell to reply with the file to this message
|
||||
await interaction.followup.send(content="Please reply to this message with the backup file.")
|
||||
|
||||
# Get the old jobs
|
||||
old_jobs: list[Job] = scheduler.get_jobs()
|
||||
|
||||
# Wait for the reply
|
||||
while True:
|
||||
try:
|
||||
reply: discord.Message | None = await bot.wait_for("message", timeout=60, check=lambda m: m.author == interaction.user)
|
||||
except TimeoutError:
|
||||
edit_msg = "~~Please reply to this message with the backup file.~~\nTimed out after 60 seconds."
|
||||
await interaction.edit_original_response(content=edit_msg)
|
||||
return
|
||||
|
||||
if not reply:
|
||||
await interaction.followup.send(content="No reply found. Please try again.")
|
||||
continue
|
||||
|
||||
if not reply.channel:
|
||||
await interaction.followup.send(content="No channel found. Please try again.")
|
||||
continue
|
||||
|
||||
# Fetch the message by its ID to ensure we have the latest data
|
||||
reply = await reply.channel.fetch_message(reply.id)
|
||||
|
||||
if not reply or not reply.attachments:
|
||||
await interaction.followup.send(content="No file attached. Please try again.")
|
||||
continue
|
||||
break
|
||||
|
||||
# Get the attachment
|
||||
attachment: discord.Attachment = reply.attachments[0]
|
||||
if not attachment or not attachment.filename.endswith(".json"):
|
||||
await interaction.followup.send(
|
||||
content=f"Invalid file type. Should be a JSON file not '{attachment.filename}'. Please try again.",
|
||||
)
|
||||
return
|
||||
|
||||
jobs_already_exist: list[str] = []
|
||||
|
||||
# Save the file to a temporary file and import the jobs
|
||||
with tempfile.NamedTemporaryFile(mode="w+", delete=False, encoding="utf-8", suffix=".json") as temp_file:
|
||||
logger.info("Saving attachment to %s", temp_file.name)
|
||||
await attachment.save(Path(temp_file.name))
|
||||
|
||||
# Load the jobs data from the file
|
||||
temp_file.seek(0)
|
||||
jobs_data: dict = json.load(temp_file)
|
||||
|
||||
logger.info("Importing jobs from file")
|
||||
logger.debug("Jobs data: %s", jobs_data)
|
||||
|
||||
with tempfile.NamedTemporaryFile(mode="w+", delete=False, encoding="utf-8", suffix=".json") as temp_import_file:
|
||||
# We can't import jobs with the same ID so remove them from the JSON
|
||||
jobs = [job for job in jobs_data.get("jobs", []) if not scheduler.get_job(job.get("id"))]
|
||||
jobs_already_exist = [job.get("id") for job in jobs_data.get("jobs", []) if scheduler.get_job(job.get("id"))]
|
||||
jobs_data["jobs"] = jobs
|
||||
for job_id in jobs_already_exist:
|
||||
logger.debug("Skipping importing '%s' because it already exists in the db.", job_id)
|
||||
|
||||
logger.debug("Jobs data after filtering: %s", jobs_data)
|
||||
logger.info("Jobs already exist: %s", jobs_already_exist)
|
||||
|
||||
# Write the new data to a temporary file
|
||||
json.dump(jobs_data, temp_import_file)
|
||||
temp_import_file.seek(0)
|
||||
|
||||
# Import the jobs
|
||||
scheduler.import_jobs(temp_import_file.name)
|
||||
|
||||
# Get the new jobs
|
||||
new_jobs: list[Job] = scheduler.get_jobs()
|
||||
|
||||
# Get the difference
|
||||
added_jobs: list[Job] = [job for job in new_jobs if job not in old_jobs]
|
||||
|
||||
if added_jobs:
|
||||
msg: str = "Reminders restored successfully.\nAdded jobs:\n"
|
||||
for j in added_jobs:
|
||||
msg += f"* Message: **{j.kwargs.get('message', 'No message found')}** {calculate(j) or 'N/A'}\n"
|
||||
|
||||
await interaction.followup.send(content=msg)
|
||||
else:
|
||||
await interaction.followup.send(content="No new reminders were added.")
|
40
discord_reminder_bot/commands/unpause.py
Normal file
40
discord_reminder_bot/commands/unpause.py
Normal file
@ -0,0 +1,40 @@
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from apscheduler.jobstores.base import JobLookupError
|
||||
from loguru import logger
|
||||
|
||||
if TYPE_CHECKING:
|
||||
import discord
|
||||
from apscheduler.job import Job
|
||||
from apscheduler.schedulers.asyncio import AsyncIOScheduler
|
||||
|
||||
|
||||
async def unpause_reminder(interaction: discord.Interaction, job_id: str, scheduler: AsyncIOScheduler) -> None:
|
||||
"""Unpauses a scheduled reminder job.
|
||||
|
||||
Finds a job by its ID in the scheduler and resumes it. Sends feedback
|
||||
to the user via the interaction about the success or failure of the operation.
|
||||
|
||||
Args:
|
||||
interaction: The discord interaction object representing the command invocation.
|
||||
job_id: The unique identifier of the reminder job to unpause.
|
||||
scheduler: The scheduler instance to manage the job.
|
||||
"""
|
||||
logger.debug(f"Unpausing reminder with ID {job_id} for {interaction.user} ({interaction.user.id}) in {interaction.channel}")
|
||||
logger.debug(f"Arguments: {locals()}")
|
||||
|
||||
try:
|
||||
job: Job | None = scheduler.get_job(job_id)
|
||||
if not job:
|
||||
await interaction.followup.send(content=f"Reminder with ID {job_id} not found.", ephemeral=True)
|
||||
return
|
||||
scheduler.resume_job(job_id)
|
||||
logger.info(f"Unpaused job {job_id}.")
|
||||
await interaction.followup.send(content=f"Reminder with ID {job_id} unpaused successfully.")
|
||||
except JobLookupError as e:
|
||||
logger.exception(f"Failed to unpause job {job_id}")
|
||||
await interaction.followup.send(content=f"Failed to unpause reminder with ID {job_id}. {e}", ephemeral=True)
|
||||
|
||||
logger.info(f"Job {job_id} unpaused in the scheduler.")
|
Reference in New Issue
Block a user