File size: 36,022 Bytes
8622a0e 98ae3eb 8622a0e 6771d3c 8622a0e 8462771 8622a0e 98ae3eb 8622a0e 6771d3c 8622a0e 98ae3eb 8622a0e 98ae3eb 8622a0e 98ae3eb 8622a0e 98ae3eb 8622a0e 98ae3eb 8462771 98ae3eb 8462771 98ae3eb 8462771 98ae3eb 8622a0e 98ae3eb 8622a0e 8462771 8622a0e 98ae3eb 8462771 a21a948 8622a0e 8462771 8622a0e 98ae3eb 8622a0e 6771d3c 98ae3eb 6771d3c 38a8ea0 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 98ae3eb 6771d3c 98ae3eb 6771d3c 98ae3eb 6771d3c 98ae3eb 6771d3c 98ae3eb 6771d3c 8622a0e 6771d3c 98ae3eb 6771d3c 8622a0e 6771d3c 98ae3eb 6771d3c 98ae3eb 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 98ae3eb 6771d3c 98ae3eb 6771d3c 8622a0e 98ae3eb 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 98ae3eb 6771d3c 8462771 98ae3eb 6771d3c 98ae3eb 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 98ae3eb 6771d3c 98ae3eb 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 6771d3c 8622a0e 9b0dc42 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 |
import asyncio
from collections import deque
import json
import os
from typing import Callable
import aiohttp
from aiohttp.resolver import AsyncResolver
from cryptography.fernet import Fernet
import discord
from discord.ext import commands, tasks
from utils.AiohttpManager import AiohttpManager, APIRequestError
import utils.config as config
import utils.datasets as datasets
import utils.helpers as helpers
import utils.keepalive as keepalive
"""<-- VARIABLES -->"""
# Environment variables
bot_token = os.environ["DISCORD_BOT_TOKEN"] # Discord bot token
dataset_id = os.environ["DATASET_ID"] # ID of the HF dataset
hf_api_key = os.environ["HF_API_KEY"] # HF API key to access the dataset
fernet = Fernet(os.environ["FERNET_KEY"].encode()) # Fernet key
nameservers = os.getenv("NAMESERVERS") # Comma separated nameservers to use for gateway connection, if applicable
# Other variables
aiohttp_manager = AiohttpManager()
user_data_changed = False # Global
user_data = datasets.load_dataset(dataset_id, config.datafile_name, hf_api_key) # Global
"""<-- MISC FUNCTIONS -->"""
def change_interval_calc() -> int:
"""Length of user_data times x, unless len(user_data) is 0 then default to y."""
return (
len(user_data) * config.delay_amounts["per_user"]
if len(user_data) > 0 else config.delay_amounts["per_loop_default"]
)
def filter_user_data(exclude: set[str]) -> list[dict]:
"""Don't write any of the excluded properties."""
return [
{
key: value for key, value in user.items()
if (key not in exclude)
}
for user in user_data
]
async def convert_identifier(identifier: str, convert_to: str, api_key: str) -> str:
"""Convert id to username and vice versa."""
try:
data = await aiohttp_manager.read_api(config.user_api_url.format(identifier=identifier), api_key)
await asyncio.sleep(config.delay_amounts["per_convert"])
if not data:
helpers.log(f"User not found with identifier: {identifier}")
raise ValueError(f"User not found with identifier: {identifier}")
helpers.log(f"{identifier} converted to {convert_to}: {data[convert_to]}") # DEBUG
return data[convert_to]
except KeyError as e:
helpers.log(f"Error during identifier convert getting {convert_to} from {data}:", e)
raise
except APIRequestError as e: # handle edge case http codes
helpers.log("Edge case http code handler during identifier convert:", e)
raise
def get_user(ctx: commands.Context | discord.Message) -> dict | None:
"""Get the user from user_data."""
for user in user_data:
if ctx.author.id == int(user["id"]):
return user
def is_registered() -> Callable[[commands.Context], bool]:
"""Registration check decorator."""
async def func(ctx: commands.Context) -> bool:
user = get_user(ctx)
if not user:
await ctx.send(config.welcome_msg)
return bool(user)
return commands.check(func)
async def register_user(api_key: str, message: discord.Message) -> None:
"""Register the user."""
global user_data_changed
try: # Read API to see if API key was valid
elements = await aiohttp_manager.read_api(config.notif_api_url, api_key)
except APIRequestError as e: # handle edge case http codes
helpers.log(f"Edge case http code handler during registration of user id {message.author.id} ({message.author}):", e)
await message.channel.send(
"Uh oh, there was an error during registration. Please try again later "
"(if it doesn't resolve on its own soon, please join the bot's "
f"[Discord server](<{config.discord_url}>) and report the bug!)"
)
return
if elements: # If API key was valid
user = {
"id": message.author.id,
"api_key": fernet.encrypt(api_key.encode()).decode(),
"important": {
"actor.username": {},
"type": [],
"attachments.score.id": []
},
"override": False,
"paused": False,
"sendhere": {
"bool": False
},
"object": message.author,
"processed_ids": deque(reversed([element['id'] for element in elements]), maxlen=config.notif_cache_length)
}
user_data.append(user)
await message.channel.send(
"Successfully registered! (If you didn't mean to do this, use the command `!flatnotifs unregister`. "
"To learn how to start setting rules, use the command `!flatnotifs help` )"
)
user_data_changed = True
else:
await message.channel.send(
"Please try again and provide a valid personal token "
"(double check that the token is still valid and has the notifications.readonly scope!)"
)
"""<-- MAIN -->"""
async def main():
"""<-- INSTANTIATE DISCORD BOT -->"""
intents = discord.Intents.default()
intents.message_content = True
resolver = AsyncResolver(nameservers=nameservers.split(",") if nameservers else nameservers)
connector = aiohttp.TCPConnector(resolver=resolver)
bot = commands.Bot(
command_prefix="!flatnotifs ",
case_insensitive=True,
strip_after_prefix=True,
help_command=None,
intents=intents,
connector=connector,
)
"""<-- LOOPS -->"""
@tasks.loop(hours=24)
async def aiohttp_refresh_loop() -> None:
"""Refresh the aiohttp session every 24 hours."""
await aiohttp_manager.refresh_session()
@tasks.loop(seconds=60)
async def check_notifs_loop() -> None:
"""Check notifications every change_interval_calc seconds."""
check_notifs_loop.change_interval(seconds=change_interval_calc())
global user_data_changed
if user_data_changed: # Update dataset
filtered_user_data = filter_user_data(exclude={"object", "processed_ids", "channel"})
datasets.update_dataset(filtered_user_data, dataset_id, config.datafile_name, hf_api_key)
user_data_changed = False
for user in user_data:
if not user["paused"]:
# Get the newest element and element list
api_key = fernet.decrypt(user["api_key"].encode()).decode()
excluded = False
try:
elements = await aiohttp_manager.read_api(config.notif_api_url, api_key)
except APIRequestError as e: # handle edge case http codes
helpers.log("Edge case http code handler:", e)
continue
if not user["object"]: # Try to fetch user object if it hasn't been set yet
try:
user["object"] = await bot.fetch_user(user["id"])
except Exception as e:
user["paused"] = True
helpers.log(f"Error, user id {user['id']} ({user['object']}) not found:", e)
continue
if not user["processed_ids"] or not elements: # Check if user processed ids set and that there are elements
user["paused"] = True
user_data_changed = True
await user["object"].send(config.check_err_msg)
continue
for element in elements:
# Break if element already processed (everything after is also already processed)
if element['id'] in user["processed_ids"]:
break
# Iterate through important rules, append to triggered_rules
is_important = False
triggered_rules = []
for category, values in user["important"].items():
nested_category = ("actor.id" if category == "actor.username" else category).split('.') # split by dots
# Iterate until you reach the bottom nested category; if not found, continue to next rule
value = element
for k in nested_category:
value = value.get(k, None)
if value is None:
break
if value is None:
continue
# Check if excluded
if ("-"+value) in values:
excluded = True
if category == "actor.username": # If actor.username
if values["-"+value] != element['actor']['username']: # Update username if changed
helpers.log("Updated", values["-"+value], "to", element['actor']['username']) # DEBUG
values["-"+value] = element['actor']['username']
user_data_changed = True
val = values["-"+value]
else:
val = value
triggered_rules.append(category + ": -" + val)
if not user["override"]:
break
# Check if included
if ("+"+value) in values:
if not excluded:
is_important = True
if category == "actor.username": # If actor.username
if values["+"+value] != element['actor']['username']: # Update username if changed
helpers.log("Updated", values["+"+value], "to", element['actor']['username']) # DEBUG
values["+"+value] = element['actor']['username']
user_data_changed = True
val = values["+"+value]
else:
val = value
triggered_rules.append(category + ": +" + val)
helpers.log(
f"{element['actor']['printableName']}: {element['type']}, ID-{element['id']} "
f"{'is' if is_important else 'is not'} categorized as important"
f"{' by rule(s): ' + str(triggered_rules) if is_important else '.'}"
) # DEBUG
# Output once all rules have been iterated through
if is_important or user["override"]:
# Set url if applicable
if element['type'] == "scoreComment":
url = element['attachments']['score']['htmlUrl'] + "#c-" + element['attachments']['scoreComment'] + "\n"
elif element['type'] in {"scorePublication", "scoreStar", "scoreInvitation"}:
url = element['attachments']['score']['htmlUrl'] + "\n"
elif element['type'] == "userFollow":
url = element['actor']['htmlUrl'] + "\n"
else:
url = ""
# Compose message
m = (
f"{helpers.esc_md(element['actor']['printableName'])}: {helpers.esc_md(element['type'])} [(Open on Flat)]({url})\n"
f"-# Rule(s): {helpers.esc_md(str(triggered_rules))}"
)
# Send to user's specified channel if configured else send to user
if user["sendhere"]["bool"]:
try:
await user["channel"].send(f"{user['object'].mention + ' ' if user['sendhere']['mention'] else ''}{m}")
except Exception as e:
helpers.log(f"Unable to find specified channel for user id {user['id']} ({user['object']}):", e)
user["sendhere"]["bool"] = False
await user["object"].send(config.channel_err_msg)
await user["object"].send(m)
else:
await user["object"].send(m)
# Add id to the list of processed ids
user["processed_ids"].append(element['id'])
await asyncio.sleep(config.delay_amounts["per_user"]) # wait between checks
"""<-- EVENT HANDLERS -->"""
@bot.event
async def on_ready() -> None:
"""Prepare on Discord bot startup."""
helpers.log("Bot has connected to Discord! :3")
# Start the aiohttp_refresh task
helpers.log("Starting aiohttp_refresh_loop...")
try:
aiohttp_refresh_loop.start()
except RuntimeError as e:
helpers.log("Error starting aiohttp_refresh_loop:", e)
helpers.log("Processing users...")
for user in user_data:
try: # Set users and check the user channel can be reached if specified
user["object"] = await bot.fetch_user(user["id"])
try:
if user["sendhere"]["bool"]:
user["channel"] = await bot.fetch_channel(user["sendhere"]["channel_id"])
except Exception as e:
helpers.log(f"Unable to find specified channel for user id {user['id']} ({user['object']}):", e)
user["sendhere"]["bool"] = False
await user["object"].send(config.channel_err_msg)
except Exception as e:
raise Exception(f"Error getting user id {user['id']} ({user['object']}) or user not found:", e)
try: # Set processed ids per user
api_key = fernet.decrypt(user["api_key"].encode()).decode()
elements = await aiohttp_manager.read_api(config.notif_api_url, api_key)
user["processed_ids"] = deque(reversed([element['id'] for element in elements]), maxlen=config.notif_cache_length)
except Exception as e:
try:
helpers.log(f"Unable to check notifications for user id {user['id']} ({user['object']}):", e)
user["paused"] = True
await user["object"].send(config.check_err_msg)
except Exception as e2:
raise Exception(f"Error sending 'unable to check notifications' message to user id {user['id']} ({user['object']}):", e2)
await asyncio.sleep(config.delay_amounts["per_user_startup"]) # wait between checks
# Set bot status
helpers.log(f"{len(user_data)} user(s) on startup")
await bot.change_presence(
status=discord.Status.online,
activity=discord.Game(name="with the Flat.io API")
)
# Start the check_notifs_loop
helpers.log("Starting check_notifs_loop...")
try:
check_notifs_loop.start()
except RuntimeError as e:
helpers.log("Error starting check_notifs_loop:", e)
@bot.event
async def on_message(message: discord.Message) -> None:
"""Handle registration, then pass to command handlers."""
message_content = message.content.split()
# If no message_content (for example, an image or embed), isn't prefixed with !flatnotifs, or is bot user, return
if not message_content or message_content[0] != "!flatnotifs" or message.author.id == bot.user.id:
return
# Get user; if not registered, prompt the user to register
user = get_user(message)
if not user:
if len(message_content) < 3 or not (message_content[1] == "getstarted"):
# message_content[1] and message_content[2] must exist and only valid command is getstarted
await message.channel.send(config.welcome_msg)
return
if not isinstance(message.channel, discord.DMChannel): # Make sure is in DMs
await message.channel.send("`!flatnotifs getstarted` must be used in DMs!")
return
api_key = message_content[2] # Register with provided API key
await register_user(api_key, message)
return
# Make sure there is a command after !flatnotifs (i.e. message_content[1] must exist)
if len(message_content) < 2:
await message.channel.send(
"Hello to you too! <3\n"
"(!flatnotifs is not a valid command by itself; use `!flatnotifs help` for a list of valid commands.)"
)
else: # Process command
await bot.process_commands(message)
@bot.event
async def on_command_error(ctx: commands.Context, error: discord.ext.commands.errors.CommandError):
"""Handle command errors."""
if isinstance(error, discord.ext.commands.errors.CommandNotFound):
await ctx.send(
"Whoops! That command was invalid.\n"
"(Use `!flatnotifs help` for a list of valid commands. Make sure the command is spelled correctly!)"
)
else:
helpers.log(f"There was an unknown command error for user id {ctx.author.id} ({ctx.author}):", error)
"""<-- COMMAND HANDLERS -->"""
@bot.command(description="Add a rule.")
@is_registered()
async def addrule(ctx: commands.Context, include_exclude: str | None = None, category: str | None = None, *input_values: str) -> None:
if not include_exclude:
await ctx.send(
"Please try again and provide include/exclude and a category and value in this format: "
"`!flatnotifs addrule include/exclude category value` (include/exclude was missing)"
)
return
if not category or not input_values:
await ctx.send(
"Please try again and provide include/exclude and a category and value in this format: "
"`!flatnotifs addrule include/exclude category value` (category or value was missing)"
)
return
global user_data_changed
user = get_user(ctx)
api_key = fernet.decrypt(user["api_key"].encode()).decode()
for input_value in input_values:
if category == "actor.username": # If actor.username, convert username to id
try:
input_value_id = await convert_identifier(input_value, "id", api_key)
except ValueError as e:
await ctx.send(
f"User not found with username {helpers.esc_md(input_value)}. "
"Please try again and provide a valid username."
)
return
except Exception as e:
await ctx.send(
"Uh oh, there was an error during addrule. Please try again later "
"(if it doesn't resolve on its own soon, please join the bot's "
f"[Discord server](<{config.discord_url}>) and report the bug!)"
)
return
else:
input_value_id = input_value
if include_exclude == "include":
temp = "+"+input_value_id
elif include_exclude == "exclude":
temp = "-"+input_value_id
else:
await ctx.send(
"Please try again and provide include/exclude and a category and value in this format: "
"`!flatnotifs addrule include/exclude category value` (first argument was not include or exclude)"
)
return
if category in user["important"]:
if category == "actor.username": # If actor.username, is a dict instead of a list
user["important"][category][temp] = input_value # user_id: user_name
else:
user["important"][category].append(temp)
await ctx.send(f"Rule {helpers.esc_md(category)}: {helpers.esc_md(input_value)} added")
user_data_changed = True
else:
await ctx.send(f"Category {helpers.esc_md(category)} not found")
@bot.command(description="Remove a rule.")
@is_registered()
async def removerule(ctx: commands.Context, *input_values: str) -> None:
if not input_values:
await ctx.send("Please try again and provide a value in this format: `!flatnotifs removerule value`")
return
global user_data_changed
user = get_user(ctx)
api_key = fernet.decrypt(user["api_key"].encode()).decode()
for input_value in input_values:
found = False
for category, values in user["important"].items():
if category == "actor.username": # If actor.username, convert username to id
try: # Invert the keys and values, then search
input_value_id = dict(zip(values.values(), values.keys()))[input_value][1:] # Remove the + or - before conversion
except KeyError as e: # If it doesn't exist, convert
try:
input_value_id = await convert_identifier(input_value, "id", api_key)
except ValueError as e:
input_value_id = input_value
except Exception as e:
await ctx.send(
"Uh oh, there was an error during removerule. Please try again later "
"(if it doesn't resolve on its own soon, please join the bot's "
f"[Discord server](<{config.discord_url}>) and report the bug!)"
)
return
else:
input_value_id = input_value
for v in [("+"+input_value_id), ("-"+input_value_id)]: # +value and -value
if v in values:
if category == "actor.username": # If actor.username, is a dict instead of a list
values.pop(v)
else:
values.remove(v)
found = True
await ctx.send(f"Rule {helpers.esc_md(input_value)} removed from {helpers.esc_md(category)}")
user_data_changed = True
break
if not found:
await ctx.send(f"Rule {helpers.esc_md(input_value)} not found")
@bot.command(description="Activate/deactivate overriding of all rules.")
@is_registered()
async def override(ctx: commands.Context) -> None:
global user_data_changed
user = get_user(ctx)
if user["override"]:
await ctx.send(
"Override disabled (You will now only be notified of notifications that "
"match your specified filters. Re-enable by using `!flatnotifs override`)"
)
else:
await ctx.send(
"Override enabled (You will now be notified of all notifications. "
"Disable by using `!flatnotifs override`)"
)
user["override"] = not user["override"]
user_data_changed = True
@bot.command(description="Pause/unpause notifications.")
@is_registered()
async def pause(ctx: commands.Context) -> None:
global user_data_changed
user = get_user(ctx)
if not user["paused"]:
await ctx.send("Notifications paused (You will not be notified of any notifications. Unpause by using `!flatnotifs pause`)")
user["paused"] = True
user_data_changed = True
else:
try:
api_key = fernet.decrypt(user["api_key"].encode()).decode()
elements = await aiohttp_manager.read_api(config.notif_api_url, api_key)
user["processed_ids"] = deque(reversed([element['id'] for element in elements]), maxlen=config.notif_cache_length)
user["paused"] = False
user_data_changed = True
await ctx.send("Notifications unpaused (You will now resume being notified of notifications. Pause by using `!flatnotifs pause`)")
except Exception as e:
try:
helpers.log(f"Unable to check notifications for user id {user['id']} ({user['object']}):", e)
user["paused"] = True
user_data_changed = True
await ctx.send(config.check_err_msg)
except Exception as e2:
raise Exception(
"Error sending 'unable to check notifications on unpause' "
f"message to user id {user['id']} ({user['object']}):", e2
)
@bot.command(description="Change your notification send channel to current channel.")
@is_registered()
async def sendhere(ctx: commands.Context, mention_flag: str | None = None) -> None:
global user_data_changed
user = get_user(ctx)
if user["sendhere"]["bool"]:
user["sendhere"]["bool"] = False
await ctx.send("Successfully changed your notification channel back to default (your DMs)")
user_data_changed = True
else:
if isinstance(ctx.channel, discord.DMChannel): # Check that it's not DMs
await ctx.send("sendhere can only be set in non-DM channels.")
return
if not mention_flag or (mention_flag.lower() not in {"mention", "nomention"}): # Validate mention_flag
await ctx.send("Please try again and provide mention or nomention in this format: `!flatnotifs sendhere mention/nomention`")
return
await ctx.send( # Ask for confirmation
"Are you sure you want to switch your notification send channel to here? (Y/N)\n"
"If this is a public channel, that means anyone can see the notifications that the bot sends you."
)
def check(m: discord.Message) -> bool:
"""Function to check that it's still the same user in the same channel"""
return m.author.id == ctx.author.id and m.channel.id == ctx.channel.id
try: # Wait 30 sec for a message that meets the check() requirement
msg = await bot.wait_for("message", check=check, timeout=30)
except Exception as e:
helpers.log("Sendhere timeout:", e)
await ctx.send("Cancelling sendhere (no response for 30 sec)")
return
else:
if msg.content.upper() == "Y": # Change user's notification channel
try:
user["sendhere"]["channel_id"] = ctx.channel.id
user["channel"] = ctx.channel
user["sendhere"]["mention"] = (mention_flag.lower() == "mention") # Given it was validated, if not mention then nomention
await user["channel"].send(
"Successfully changed your notification channel to this channel. "
"You can disable this at any time using !flatnotifs sendhere"
)
user["sendhere"]["bool"] = True # Don't change bool unless everything went smoothly
user_data_changed = True
except Exception as e:
helpers.log(f"Error setting sendhere for user id {user['id']} ({user['object']}):", e)
await ctx.send(
"Uh oh, there was an error during sendhere. Please try again later "
"(if it doesn't resolve on its own soon, please join the bot's "
f"[Discord server](<{config.discord_url}>) and report the bug!)"
)
else:
await ctx.send("Cancelling sendhere (received a response other than 'Y')")
@bot.command(description="Unregister, permanently deleting your rules and API key from the bot.")
@is_registered()
async def unregister(ctx: commands.Context) -> None:
global user_data_changed
user = get_user(ctx)
await ctx.send( # Ask for confirmation
"Are you sure you want to unregister? (Y/N)\n"
"Unregistering means that you will lose any rules that you have set and will no longer receive notifications from this bot. "
"Only unregister if you don't want to receive notifications from this bot anymore or if you need to change your personal token."
)
def check(m: discord.Message) -> bool:
"""Function to check that it's still the same user in the same channel"""
return m.author.id == ctx.author.id and m.channel.id == ctx.channel.id
try: # Wait 30 sec for a message that meets the check() requirement
msg = await bot.wait_for("message", check=check, timeout=30)
except Exception as e:
helpers.log("Unregister timeout:", e)
await ctx.send("Cancelling unregister (no response for 30 sec)")
return
else:
if msg.content.upper() == "Y": # Unregister the user
try:
user_data.remove(user)
await ctx.send("Successfully unregistered. You can re-register by using the command !flatnotifs getstarted")
user_data_changed = True
except Exception as e:
helpers.log(f"Error unregistering for user id {user['id']} ({user['object']}):", e)
await ctx.send(
"Uh oh, there was an error during unregister. Please try again later "
"(if it doesn't resolve on its own soon, please join the bot's "
f"[Discord server](<{config.discord_url}>) and report the bug!)"
)
else:
await ctx.send("Cancelling unregister (received a response other than 'Y')")
@bot.command(description="Update your personal token.")
@is_registered()
async def updatetoken(ctx: commands.Context, api_key: str | None = None) -> None:
if not isinstance(ctx.channel, discord.DMChannel): # Make sure is in DMs
await ctx.send("`!flatnotifs updatetoken` must be used in DMs!")
return
if api_key is None:
await ctx.send("Please provide your new personal token.")
return
global user_data_changed
user = get_user(ctx)
await ctx.send( # Ask for confirmation
"Are you sure you want to update your personal token? (Y/N)\n"
"Updating your personal token will invalidate your old token. "
"Make sure your new personal token is valid!"
)
def check(m: discord.Message) -> bool:
"""Function to check that it's still the same user in the same channel"""
return m.author.id == ctx.author.id and m.channel.id == ctx.channel.id
try: # Wait 30 sec for a message that meets the check() requirement
msg = await bot.wait_for("message", check=check, timeout=30)
except Exception as e:
helpers.log("Updatetoken timeout:", e)
await ctx.send("Cancelling updatetoken (no response for 30 sec)")
return
else:
if msg.content.upper() == "Y": # Update the user's token
try: # Read API to see if API key was valid
elements = await aiohttp_manager.read_api(config.notif_api_url, api_key)
except APIRequestError as e: # handle edge case http codes
helpers.log(f"Edge case http code handler during updatetoken of user id {ctx.author.id} ({ctx.author}):", e)
await ctx.send(
"Uh oh, there was an error during updatetoken. Please try again later "
"(if it doesn't resolve on its own soon, please join the bot's "
f"[Discord server](<{config.discord_url}>) and report the bug!)"
)
return
if elements: # If API key was valid
user["api_key"] = fernet.encrypt(api_key.encode()).decode()
user["processed_ids"] = deque(reversed([element['id'] for element in elements]), maxlen=config.notif_cache_length)
await ctx.send("Successfully updated your personal token!")
user_data_changed = True
helpers.log(f"User id {user['id']} ({user['object']}) updated token, newest element on startup is ID-{elements[0]['id']}") # DEBUG
else:
await ctx.send(
"Please try again and provide a valid personal token "
"(double check that the token is still valid and has the notifications.readonly scope!)"
)
else:
await ctx.send("Cancelling updatetoken (received a response other than 'Y')")
@bot.command(description="Show all rules that you have set.")
@is_registered()
async def rules(ctx: commands.Context) -> None:
global user_data_changed
user = get_user(ctx)
important = { # Only get the usernames
key: [user_id[0]+user_name for user_id, user_name in values.items()] if key == "actor.username" else values # Add the + or - back to the username
for key, values in user["important"].items()
}
# chr(10) is used in place \n to ensure compatibility with older versions of Python that don't allow escape chars in an f-string
await ctx.author.send(
f"Rules: {helpers.esc_md(json.dumps(important, indent=4))}"
f"{chr(10)+'Override is currently enabled (disable by using !flatnotifs override)' if user['override'] else ''}"
f"{chr(10)+'Notifications are currently paused (unpause by using !flatnotifs pause)' if user['paused'] else ''}"
)
@bot.command(description="Show the version of the bot.")
@is_registered()
async def version(ctx: commands.Context) -> None:
await ctx.send(config.version_msg)
@bot.command(description="Show all valid commands.")
@is_registered()
async def help(ctx: commands.Context) -> None:
# split into two messages because of Discord message max length
await ctx.send(config.help_msg[0])
await ctx.send(config.help_msg[1])
@bot.command(description="Sync the command tree.")
@commands.is_owner()
async def sync(ctx: commands.Context) -> None:
synced = await bot.tree.sync()
await ctx.send(f"Synced {len(synced)} command(s)")
@bot.hybrid_command(description="Hello world!")
async def hello(ctx: commands.Context) -> None:
await ctx.send("Hello world!")
# Start within event loop
await bot.start(bot_token)
if __name__ == "__main__":
# Start keepalive and run Discord bot
keepalive.run()
asyncio.run(main())
# If CTRL-C, clean up
asyncio.run(aiohttp_manager.close_session())
|