RcGcDw/extensions/hooks/buttons.py

#  This file is part of Recent changes Goat compatible Discord webhook (RcGcDw).
#
#  RcGcDw is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  RcGcDw is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with RcGcDw.  If not, see <http://www.gnu.org/licenses/>.
from typing import Optional

from src.api.context import Context
from src.discord.message import DiscordMessage, DiscordMessageMetadata
from src.api.hook import post_hook
from src.configloader import settings

# The webhook used for RcGcDw need to be controlled by a Discord application running https://github.com/Markus-Rost/rcgcdw-buttons
# You can use https://www.wikibot.de/interactions to create a Discord webhook to be used for RcGcDw that supports buttons.
# {
#     "hooks": {
#         "buttons": {
#             "block": "Block user",
#             "blocknotalk": "Block user (disable talk)",
#             "delete": "Delete",
#             "filerevert": "Revert",
#             "move": "Move back",
#             "rollback": "Rollback",
#             "thank": "Thank user",
#             "undo": "Undo"
#         }
#     }
# }
action_buttons = settings.get("hooks", {}).get("buttons", {})


def add_button(message: DiscordMessage, custom_id: str, label, style=2, emoji: Optional[dict] = None):
    if len(custom_id) > 100 or not len(label):
        return
    if "components" not in message.webhook_object:
        message.webhook_object["components"] = [{"type": 1, "components": []}]
    if len(message.webhook_object["components"][-1]["components"]) >= 5:
        message.webhook_object["components"].append({"type": 1, "components": []})
    message.webhook_object["components"][-1]["components"].append(
        {"type": 2, "custom_id": custom_id, "style": style, "label": label, "emoji": emoji})


@post_hook
def buttons_hook(message: DiscordMessage, metadata: DiscordMessageMetadata, context: Context, change: dict):
    if not len(action_buttons) or context.feed_type == "discussion":
        return
    BUTTON_PREFIX = context.client.WIKI_SCRIPT_PATH[len(context.client.WIKI_JUST_DOMAIN):]
    if context.event != "suppressed":
        if "blocknotalk" in action_buttons:
            add_button(message,
                    BUTTON_PREFIX + " blocknotalk " + ("#" + str(change["userid"]) if change["userid"] else change["user"]),
                    action_buttons["blocknotalk"], 4, {"id": None, "name": "🚧"})
        if "block" in action_buttons:
            add_button(message,
                    BUTTON_PREFIX + " block " + ("#" + str(change["userid"]) if change["userid"] else change["user"]),
                    action_buttons["block"], 4, {"id": None, "name": "🚧"})
    if context.feed_type != "recentchanges":
        return
    if "delete" in action_buttons and context.event in ("new", "upload/upload"):
        add_button(message, BUTTON_PREFIX + " delete " + str(change["pageid"]),
                   action_buttons["delete"], 4, {"id": None, "name": "🗑️"})
    if "filerevert" in action_buttons and context.event in ("upload/overwrite", "upload/revert") and context.image_data:
        found_cur = False
        for revision in context.image_data.get("imageinfo", []):
            if found_cur:
                add_button(message, BUTTON_PREFIX + " file " + str(change["pageid"]) + " " + revision["archivename"].split("!")[0],
                    action_buttons["filerevert"], 2, {"id": None, "name": "🔂"})
                break
            if revision["timestamp"] == change["logparams"]["img_timestamp"]:  # find the correct revision corresponding for this log entry
                found_cur = True
    if "move" in action_buttons and context.event in ("move/move", "move/move_redir"):
        add_button(message, BUTTON_PREFIX + " move " + str(change["pageid"]) + " " + change["title"],
            action_buttons["move"], 2, {"id": None, "name": "🔂"})
    if "rollback" in action_buttons and context.event == "edit":
        add_button(message, BUTTON_PREFIX + " rollback " + str(change["pageid"]) + " " + (
            "#" + str(change["userid"]) if change["userid"] else change["user"]),
                   action_buttons["rollback"], 1, {"id": None, "name": "🔁"})
    if "undo" in action_buttons and context.event == "edit":
        add_button(message, BUTTON_PREFIX + " undo " + str(change["pageid"]) + " " + str(change["revid"]),
            action_buttons["undo"], 2, {"id": None, "name": "🔂"})
    if "thank" in action_buttons and context.event != "suppressed":
        if change["type"] == "log":
            add_button(message, BUTTON_PREFIX + " thank log " + str(change["logid"]),
                action_buttons["thank"], 3, {"id": None, "name": "👍"})
        else:
            add_button(message, BUTTON_PREFIX + " thank rev " + str(change["revid"]),
                action_buttons["thank"], 3, {"id": None, "name": "👍"})