From a0abc6819bb72e3b9dd6f9d8ecf4b99bff1aa2b5 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Wed, 17 May 2023 19:05:59 -0400 Subject: [PATCH 01/53] Initial webhook integration --- app/classes/shared/server.py | 13 +++++++++++++ app/classes/web/webhook_handler.py | 30 ++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+) create mode 100644 app/classes/web/webhook_handler.py diff --git a/app/classes/shared/server.py b/app/classes/shared/server.py index fa68eb62..9cecc6ce 100644 --- a/app/classes/shared/server.py +++ b/app/classes/shared/server.py @@ -31,6 +31,7 @@ from app.classes.shared.console import Console from app.classes.shared.helpers import Helpers from app.classes.shared.file_helpers import FileHelpers from app.classes.shared.null_writer import NullWriter +from app.classes.web.webhook_handler import WebhookHandler with redirect_stderr(NullWriter()): import psutil @@ -512,6 +513,9 @@ class ServerInstance: if self.process.poll() is None: logger.info(f"Server {self.name} running with PID {self.process.pid}") Console.info(f"Server {self.name} running with PID {self.process.pid}") + WebhookHandler.send_discord_webhook( + "Crafty Controller", f"{self.name} started!", 65354 + ) self.is_crashed = False self.stats_helper.server_crash_reset() self.record_server_stats() @@ -807,6 +811,9 @@ class ServerInstance: logger.info(f"Stopped Server {server_name} with PID {server_pid}") Console.info(f"Stopped Server {server_name} with PID {server_pid}") + WebhookHandler.send_discord_webhook( + "Crafty Controller", f"{self.name} was stopped!", 16748076 + ) # massive resetting of variables self.cleanup_server_object() @@ -890,6 +897,12 @@ class ServerInstance: f"The server {name} has crashed and will be restarted. " f"Restarting server" ) + + WebhookHandler.send_discord_webhook( + "Crafty Controller", + f"{self.name} crashed! Crafty Controller is attempting to start it back up!", + 16711680, + ) self.run_threaded_server(None) return True logger.critical( diff --git a/app/classes/web/webhook_handler.py b/app/classes/web/webhook_handler.py new file mode 100644 index 00000000..c972cff1 --- /dev/null +++ b/app/classes/web/webhook_handler.py @@ -0,0 +1,30 @@ +import json +import logging +import requests + +logger = logging.getLogger(__name__) + + +class WebhookHandler: + @staticmethod + def send_discord_webhook(title, message, color): + dataset = { + "username": "Crafty Webhooks", + "avatar_url": "https://docs.craftycontrol.com/img/favicon.ico", + "embeds": [ + { + "title": title, + "description": message, + "color": color, + } + ], + } + + logger.debug( + "Webhook response: " + + requests.post( + "https://discord.com/api/webhooks/1107017140004995081/leFCJ4g_Uw6ZwxaZXTLmi-L7njIFwVvFbf3JEHnAvUJAd90PoMknlivel0rosfnFed77", + data=json.dumps(dataset), + headers={"Content-type": "application/json"}, + ), + ) From 03cfdc0aa11159392f09ff7189f42ac6044d6748 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 12:00:03 -0400 Subject: [PATCH 02/53] Add perms for webhooks --- app/classes/web/panel_handler.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/app/classes/web/panel_handler.py b/app/classes/web/panel_handler.py index b7219ac6..cb6fd9cc 100644 --- a/app/classes/web/panel_handler.py +++ b/app/classes/web/panel_handler.py @@ -576,6 +576,7 @@ class PanelHandler(BaseHandler): "Files": EnumPermissionsServer.FILES, "Config": EnumPermissionsServer.CONFIG, "Players": EnumPermissionsServer.PLAYERS, + "Webhooks": EnumPermissionsServer.WEBHOOKS, } page_data[ "user_permissions" @@ -749,6 +750,17 @@ class PanelHandler(BaseHandler): page_data["history_stats"] = self.controller.servers.get_history_stats( server_id, days ) + if subpage == "webhooks": + if ( + not page_data["permissions"]["Webhooks"] + in page_data["user_permissions"] + ): + if not superuser: + self.redirect( + "/panel/error?error=Unauthorized access to Webhooks Config" + ) + return + page_data[""] def get_banned_players_html(): banned_players = self.controller.servers.get_banned_players(server_id) From e228f04345d6846151cfe0e8fd4c78aa8fb47b37 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 12:18:07 -0400 Subject: [PATCH 03/53] Remove permissions work --- app/classes/web/panel_handler.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/app/classes/web/panel_handler.py b/app/classes/web/panel_handler.py index 4297d698..692bcff4 100644 --- a/app/classes/web/panel_handler.py +++ b/app/classes/web/panel_handler.py @@ -576,7 +576,6 @@ class PanelHandler(BaseHandler): "Files": EnumPermissionsServer.FILES, "Config": EnumPermissionsServer.CONFIG, "Players": EnumPermissionsServer.PLAYERS, - "Webhooks": EnumPermissionsServer.WEBHOOKS, } page_data[ "user_permissions" @@ -752,7 +751,7 @@ class PanelHandler(BaseHandler): ) if subpage == "webhooks": if ( - not page_data["permissions"]["Webhooks"] + not page_data["permissions"]["Config"] in page_data["user_permissions"] ): if not superuser: @@ -760,7 +759,6 @@ class PanelHandler(BaseHandler): "/panel/error?error=Unauthorized access to Webhooks Config" ) return - page_data[""] def get_banned_players_html(): banned_players = self.controller.servers.get_banned_players(server_id) From b15477ca4ca894171885f4f26b476515d3d705ae Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 12:19:05 -0400 Subject: [PATCH 04/53] Add providers --- app/classes/web/webhook_handler.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/app/classes/web/webhook_handler.py b/app/classes/web/webhook_handler.py index c972cff1..15b48b34 100644 --- a/app/classes/web/webhook_handler.py +++ b/app/classes/web/webhook_handler.py @@ -6,6 +6,22 @@ logger = logging.getLogger(__name__) class WebhookHandler: + @staticmethod + def get_providers(): + return [ + "Discord", + "Home Assistant", + "Mattermost", + "Opsgenie", + "Signal", + "Slack", + "SMTP", + "Splunk", + "Teams", + "Telegram", + "Custom", + ] + @staticmethod def send_discord_webhook(title, message, color): dataset = { @@ -23,7 +39,7 @@ class WebhookHandler: logger.debug( "Webhook response: " + requests.post( - "https://discord.com/api/webhooks/1107017140004995081/leFCJ4g_Uw6ZwxaZXTLmi-L7njIFwVvFbf3JEHnAvUJAd90PoMknlivel0rosfnFed77", + "", data=json.dumps(dataset), headers={"Content-type": "application/json"}, ), From 7c72dfc241aba6724c8501a7a15f74550e8e6812 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 12:21:23 -0400 Subject: [PATCH 05/53] Add webhook front end --- .../panel/parts/m_server_controls_list.html | 3 + .../panel/parts/server_controls_list.html | 6 + .../templates/panel/server_webhooks.html | 280 ++++++++++++++++++ 3 files changed, 289 insertions(+) create mode 100644 app/frontend/templates/panel/server_webhooks.html diff --git a/app/frontend/templates/panel/parts/m_server_controls_list.html b/app/frontend/templates/panel/parts/m_server_controls_list.html index 63c6b98a..6c645881 100644 --- a/app/frontend/templates/panel/parts/m_server_controls_list.html +++ b/app/frontend/templates/panel/parts/m_server_controls_list.html @@ -31,6 +31,9 @@ {{ translate('serverDetails', 'playerControls', data['lang']) }} {% end %} {{ translate('serverDetails', 'metrics', data['lang']) }} + {% if data['permissions']['Config'] in data['user_permissions'] %} + Webhooks + {% end %} \ No newline at end of file diff --git a/app/frontend/templates/panel/parts/server_controls_list.html b/app/frontend/templates/panel/parts/server_controls_list.html index 4f5bb6b5..09c9b213 100644 --- a/app/frontend/templates/panel/parts/server_controls_list.html +++ b/app/frontend/templates/panel/parts/server_controls_list.html @@ -53,4 +53,10 @@ {{ translate('serverDetails', 'metrics', data['lang']) }} + {% if data['permissions']['Webhooks'] in data['user_permissions'] %} +
  • + + Webhooks +
    • + {% end %} \ No newline at end of file diff --git a/app/frontend/templates/panel/server_webhooks.html b/app/frontend/templates/panel/server_webhooks.html new file mode 100644 index 00000000..b8552401 --- /dev/null +++ b/app/frontend/templates/panel/server_webhooks.html @@ -0,0 +1,280 @@ +{% extends ../base.html %} + +{% block meta %} +{% end %} + +{% block title %}Crafty Controller - {{ translate('serverDetails', 'serverDetails', data['lang']) }}{% end %} + +{% block content %} + +
    + + +
    +
    +
    +

    + {{ translate('serverDetails', 'serverDetails', data['lang']) }} - {{ + data['server_stats']['server_id']['server_name'] }} +
    + UUID: {{ data['server_stats']['server_id']['server_uuid'] }} +

    +
    +
    + +
    + + + {% include "parts/details_stats.html" %} + +
    + +
    +
    +
    + + + {% include "parts/server_controls_list.html" %} + + + {% include "parts/m_server_controls_list.html" %} + + +
    +
    +
    +
    +

    {{ translate('serverSchedules', + 'scheduledTasks', data['lang']) }}

    + {% if data['user_data']['hints'] %} + + {% end %} +
    +
    +
    +
    +
    +
    +
    + +
    +
    +
    +
    + + + + +
    + + + +{% end %} + +{% block js %} + + + +{% end %} \ No newline at end of file From fb2bcd7e4eebf02d0a1dc702c5eeda34e20faf53 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 12:22:10 -0400 Subject: [PATCH 06/53] Fix permissions on webhooks nav --- app/frontend/templates/panel/parts/server_controls_list.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/frontend/templates/panel/parts/server_controls_list.html b/app/frontend/templates/panel/parts/server_controls_list.html index 09c9b213..39360f72 100644 --- a/app/frontend/templates/panel/parts/server_controls_list.html +++ b/app/frontend/templates/panel/parts/server_controls_list.html @@ -53,7 +53,7 @@ {{ translate('serverDetails', 'metrics', data['lang']) }} - {% if data['permissions']['Webhooks'] in data['user_permissions'] %} + {% if data['permissions']['Config'] in data['user_permissions'] %}
  • Webhooks From cc157f86bbd3408d1305d7615b26da72f78ec196 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 13:35:29 -0400 Subject: [PATCH 07/53] Setup webhooks database --- app/classes/models/management.py | 61 +++++++++++++++++++++++++++-- app/migrations/20230603_webhooks.py | 26 ++++++++++++ 2 files changed, 83 insertions(+), 4 deletions(-) create mode 100644 app/migrations/20230603_webhooks.py diff --git a/app/classes/models/management.py b/app/classes/models/management.py index 73a0d9f4..d7d93235 100644 --- a/app/classes/models/management.py +++ b/app/classes/models/management.py @@ -77,11 +77,14 @@ class HostStats(BaseModel): # ********************************************************************************** class Webhooks(BaseModel): id = AutoField() - name = CharField(max_length=64, unique=True, index=True) - method = CharField(default="POST") + server_id = IntegerField(null=True) + name = CharField(default="Custom Webhook", max_length=64) url = CharField(unique=True) - event = CharField(default="") - send_data = BooleanField(default=True) + webhook_type = CharField(default="Custom") + bot_name = CharField(default="Crafty Controller") + triggers = CharField(default="server_start,server_stop") + body = CharField(default="") + enabled = BooleanField(default=True) class Meta: table_name = "webhooks" @@ -501,3 +504,53 @@ class HelpersManagement: f"Not removing {dir_to_del} from excluded directories - " f"not in the excluded directory list for server ID {server_id}" ) + + +# ********************************************************************************** +# Webhooks Class +# ********************************************************************************** +class HelpersWebhooks: + def __init__(self, database): + self.database = database + + @staticmethod + def create_webhook( + server_id: int, + webhook_type: str, + name: str, + url: str, + bot_name: str, + body: str, + triggers: str, + enabled: bool, + ) -> int: + """Create a webhook in the database + + Args: + server_id: ID of a server this webhook will be married to + name: The name of the webhook + url: URL to the webhook + webhook_type: The provider this webhook will be sent to + bot name: The name that will appear when the webhook is sent + triggers: Server actions that will trigger this webhook + body: The message body of the webhook + enabled: Should Crafty trigger the webhook + + Returns: + int: The new webhooks's id + + Raises: + PeeweeException: If the webhook already exists + """ + return Webhooks.insert( + { + Webhooks.server_id: server_id, + Webhooks.name: name, + Webhooks.webhook_type: webhook_type, + Webhooks.url: url, + Webhooks.bot_name: bot_name, + Webhooks.body: body, + Webhooks.triggers: triggers, + Webhooks.enabled: enabled, + } + ).execute() diff --git a/app/migrations/20230603_webhooks.py b/app/migrations/20230603_webhooks.py new file mode 100644 index 00000000..6470d5fc --- /dev/null +++ b/app/migrations/20230603_webhooks.py @@ -0,0 +1,26 @@ +# Generated by database migrator +import peewee + + +def migrate(migrator, database, **kwargs): + migrator.drop_columns("webhooks", ["name", "method", "url", "event", "send_data"]) + migrator.add_columns( + "webhooks", + server_id=peewee.IntegerField(null=True), + webhook_type=peewee.CharField(default="Custom"), + name=peewee.CharField(default="Custom Webhook", max_length=64), + url=peewee.CharField(default=""), + bot_name=peewee.CharField(default="Crafty Controller"), + trigger=peewee.CharField(default="server_start,server_stop"), + body=peewee.CharField(default=""), + enabled=peewee.BooleanField(default=True), + ) + """ + Write your migrations here. + """ + + +def rollback(migrator, database, **kwargs): + """ + Write your rollback migrations here. + """ From 67a5e65b46492cdfd083f6178173fa319d8005bd Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 13:36:20 -0400 Subject: [PATCH 08/53] Remove webhooks --- app/classes/shared/server.py | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/app/classes/shared/server.py b/app/classes/shared/server.py index 9cecc6ce..ebaec284 100644 --- a/app/classes/shared/server.py +++ b/app/classes/shared/server.py @@ -31,7 +31,6 @@ from app.classes.shared.console import Console from app.classes.shared.helpers import Helpers from app.classes.shared.file_helpers import FileHelpers from app.classes.shared.null_writer import NullWriter -from app.classes.web.webhook_handler import WebhookHandler with redirect_stderr(NullWriter()): import psutil @@ -513,9 +512,6 @@ class ServerInstance: if self.process.poll() is None: logger.info(f"Server {self.name} running with PID {self.process.pid}") Console.info(f"Server {self.name} running with PID {self.process.pid}") - WebhookHandler.send_discord_webhook( - "Crafty Controller", f"{self.name} started!", 65354 - ) self.is_crashed = False self.stats_helper.server_crash_reset() self.record_server_stats() @@ -811,9 +807,6 @@ class ServerInstance: logger.info(f"Stopped Server {server_name} with PID {server_pid}") Console.info(f"Stopped Server {server_name} with PID {server_pid}") - WebhookHandler.send_discord_webhook( - "Crafty Controller", f"{self.name} was stopped!", 16748076 - ) # massive resetting of variables self.cleanup_server_object() @@ -898,11 +891,6 @@ class ServerInstance: f"Restarting server" ) - WebhookHandler.send_discord_webhook( - "Crafty Controller", - f"{self.name} crashed! Crafty Controller is attempting to start it back up!", - 16711680, - ) self.run_threaded_server(None) return True logger.critical( From 0adc129462ca680a644ab3676f9f3ddaba67d370 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 13:36:38 -0400 Subject: [PATCH 09/53] Inital commit for webhooks on frontend --- app/classes/web/panel_handler.py | 43 +++ .../templates/panel/server_webhook_edit.html | 261 ++++++++++++++++++ .../templates/panel/server_webhooks.html | 2 +- 3 files changed, 305 insertions(+), 1 deletion(-) create mode 100644 app/frontend/templates/panel/server_webhook_edit.html diff --git a/app/classes/web/panel_handler.py b/app/classes/web/panel_handler.py index 692bcff4..454cbd4d 100644 --- a/app/classes/web/panel_handler.py +++ b/app/classes/web/panel_handler.py @@ -25,6 +25,7 @@ from app.classes.controllers.roles_controller import RolesController from app.classes.shared.helpers import Helpers from app.classes.shared.main_models import DatabaseShortcuts from app.classes.web.base_handler import BaseHandler +from app.classes.web.webhook_handler import WebhookHandler logger = logging.getLogger(__name__) @@ -1039,6 +1040,48 @@ class PanelHandler(BaseHandler): template = "panel/panel_edit_user.html" + elif page == "add_webhook": + server_id = self.get_argument("id", None) + if server_id is None: + return self.redirect("/panel/error?error=Invalid Server ID") + server_obj = self.controller.servers.get_server_instance_by_id(server_id) + page_data["backup_failed"] = server_obj.last_backup_status() + server_obj = None + page_data["active_link"] = "webhooks" + page_data["server_data"] = self.controller.servers.get_server_data_by_id( + server_id + ) + page_data[ + "user_permissions" + ] = self.controller.server_perms.get_user_id_permissions_list( + exec_user["user_id"], server_id + ) + page_data["permissions"] = { + "Commands": EnumPermissionsServer.COMMANDS, + "Terminal": EnumPermissionsServer.TERMINAL, + "Logs": EnumPermissionsServer.LOGS, + "Schedule": EnumPermissionsServer.SCHEDULE, + "Backup": EnumPermissionsServer.BACKUP, + "Files": EnumPermissionsServer.FILES, + "Config": EnumPermissionsServer.CONFIG, + "Players": EnumPermissionsServer.PLAYERS, + } + page_data["server_stats"] = self.controller.servers.get_server_stats_by_id( + server_id + ) + page_data["server_stats"][ + "server_type" + ] = self.controller.servers.get_server_type_by_id(server_id) + page_data["new_webhook"] = True + page_data["providers"] = WebhookHandler.get_providers() + + if not EnumPermissionsServer.CONFIG in page_data["user_permissions"]: + if not superuser: + self.redirect("/panel/error?error=Unauthorized access To Webhooks") + return + + template = "panel/server_webhook_edit.html" + elif page == "add_schedule": server_id = self.get_argument("id", None) if server_id is None: diff --git a/app/frontend/templates/panel/server_webhook_edit.html b/app/frontend/templates/panel/server_webhook_edit.html new file mode 100644 index 00000000..8baed81f --- /dev/null +++ b/app/frontend/templates/panel/server_webhook_edit.html @@ -0,0 +1,261 @@ +{% extends ../base.html %} + +{% block meta %} +{% end %} + +{% block title %}Crafty Controller - {{ translate('serverDetails', 'serverDetails', data['lang']) }}{% end %} + +{% block content %} + +
    + + +
    +
    +
    +

    + {{ translate('serverDetails', 'serverDetails', data['lang']) }} - {{ + data['server_stats']['server_id']['server_name'] }} +
    + UUID: {{ data['server_stats']['server_id']['server_uuid'] }} +

    +
    +
    + +
    + + + {% include "parts/details_stats.html" %} + +
    + +
    +
    +
    + {% include "parts/server_controls_list.html" %} + +
    +
    + {% if data['new_webhook'] == True %} +
    + {% else %} + + {% end %} + +
    +
    + + +
    +
    + +
    +
    +
    +
    + + + +
    + + + {% end %} + + {% block js %} + + + {% end %} \ No newline at end of file diff --git a/app/frontend/templates/panel/server_webhooks.html b/app/frontend/templates/panel/server_webhooks.html index b8552401..e0342c4b 100644 --- a/app/frontend/templates/panel/server_webhooks.html +++ b/app/frontend/templates/panel/server_webhooks.html @@ -52,7 +52,7 @@ data-placement="bottom"> {% end %}
    From 50c515b2aa3f552b60a9a7f29d1e4630aba2e784 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 15:05:08 -0400 Subject: [PATCH 10/53] Add database methods --- .../controllers/management_controller.py | 29 ++++++++- app/classes/models/management.py | 64 +++++++++++++------ 2 files changed, 72 insertions(+), 21 deletions(-) diff --git a/app/classes/controllers/management_controller.py b/app/classes/controllers/management_controller.py index 7c423da9..71327c1c 100644 --- a/app/classes/controllers/management_controller.py +++ b/app/classes/controllers/management_controller.py @@ -1,7 +1,7 @@ import logging import queue -from app.classes.models.management import HelpersManagement +from app.classes.models.management import HelpersManagement, HelpersWebhooks from app.classes.models.servers import HelperServers logger = logging.getLogger(__name__) @@ -206,3 +206,30 @@ class ManagementController: @staticmethod def set_master_server_dir(server_dir): HelpersManagement.set_master_server_dir(server_dir) + + # ********************************************************************************** + # Webhooks Methods + # ********************************************************************************** + @staticmethod + def create_webhook(data): + return HelpersWebhooks.create_webhook(data) + + @staticmethod + def modify_webhook(webhook_id, data): + HelpersWebhooks.modify_webhook(webhook_id, data) + + @staticmethod + def get_webhook_by_id(webhook_id): + return HelpersWebhooks.get_webhook_by_id(webhook_id) + + @staticmethod + def get_webhooks_by_server(server_id): + return HelpersWebhooks.get_webhooks_by_server(server_id) + + @staticmethod + def delete_webhook(webhook_id): + HelpersWebhooks.delete_webhook(webhook_id) + + @staticmethod + def delete_webhook_by_server(server_id): + HelpersWebhooks.delete_webhooks_by_server(server_id) diff --git a/app/classes/models/management.py b/app/classes/models/management.py index d7d93235..6166dcd0 100644 --- a/app/classes/models/management.py +++ b/app/classes/models/management.py @@ -79,10 +79,10 @@ class Webhooks(BaseModel): id = AutoField() server_id = IntegerField(null=True) name = CharField(default="Custom Webhook", max_length=64) - url = CharField(unique=True) + url = CharField(default="") webhook_type = CharField(default="Custom") bot_name = CharField(default="Crafty Controller") - triggers = CharField(default="server_start,server_stop") + trigger = CharField(default="server_start,server_stop") body = CharField(default="") enabled = BooleanField(default=True) @@ -514,16 +514,7 @@ class HelpersWebhooks: self.database = database @staticmethod - def create_webhook( - server_id: int, - webhook_type: str, - name: str, - url: str, - bot_name: str, - body: str, - triggers: str, - enabled: bool, - ) -> int: + def create_webhook(create_data) -> int: """Create a webhook in the database Args: @@ -544,13 +535,46 @@ class HelpersWebhooks: """ return Webhooks.insert( { - Webhooks.server_id: server_id, - Webhooks.name: name, - Webhooks.webhook_type: webhook_type, - Webhooks.url: url, - Webhooks.bot_name: bot_name, - Webhooks.body: body, - Webhooks.triggers: triggers, - Webhooks.enabled: enabled, + Webhooks.server_id: create_data["server_id"], + Webhooks.name: create_data["name"], + Webhooks.webhook_type: create_data["webhook_type"], + Webhooks.url: create_data["url"], + Webhooks.bot_name: create_data["bot_name"], + Webhooks.body: create_data["body"], + Webhooks.trigger: create_data["trigger"], + Webhooks.enabled: create_data["enabled"], } ).execute() + + @staticmethod + def modify_webhook(webhook_id, updata): + Webhooks.update(updata).where(Webhooks.id == webhook_id).execute() + + @staticmethod + def get_webhook_by_id(webhook_id): + return model_to_dict(Webhooks.get(Webhooks.id == webhook_id)) + + @staticmethod + def get_webhooks_by_server(server_id): + data = {} + for webhook in ( + Webhooks.select().where(Webhooks.server_id == server_id).execute() + ): + data[str(webhook.id)] = { + "webhook_type": webhook.webhook_type, + "name": webhook.name, + "url": webhook.url, + "bot_name": webhook.bot_name, + "trigger": webhook.trigger, + "body": webhook.body, + "enabled": webhook.enabled, + } + return data + + @staticmethod + def delete_webhook(webhook_id): + Webhooks.delete().where(Webhooks.id == webhook_id).execute() + + @staticmethod + def delete_webhooks_by_server(server_id): + Webhooks.delete().where(Webhooks.server_id == server_id).execute() From f1ed96595d491e22e048b34b1abbbb1bfcfa5a21 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 15:05:21 -0400 Subject: [PATCH 11/53] Add first monitored actions --- app/classes/web/webhook_handler.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/classes/web/webhook_handler.py b/app/classes/web/webhook_handler.py index 15b48b34..7c1bc1c7 100644 --- a/app/classes/web/webhook_handler.py +++ b/app/classes/web/webhook_handler.py @@ -22,6 +22,10 @@ class WebhookHandler: "Custom", ] + @staticmethod + def get_monitored_actions(): + return ["server_start", "server_stop", "server_crash", "server_backup"] + @staticmethod def send_discord_webhook(title, message, color): dataset = { From cbd988ee5bd4e9071fbeae974c2eb71646f709a2 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 15:05:33 -0400 Subject: [PATCH 12/53] Add api routes --- app/classes/web/routes/api/api_handlers.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/app/classes/web/routes/api/api_handlers.py b/app/classes/web/routes/api/api_handlers.py index 29ee02c5..82a13168 100644 --- a/app/classes/web/routes/api/api_handlers.py +++ b/app/classes/web/routes/api/api_handlers.py @@ -32,6 +32,12 @@ from app.classes.web.routes.api.servers.server.tasks.task.children import ( from app.classes.web.routes.api.servers.server.tasks.task.index import ( ApiServersServerTasksTaskIndexHandler, ) +from app.classes.web.routes.api.servers.server.webhooks.index import ( + ApiServersServerWebhooksIndexHandler, +) +from app.classes.web.routes.api.servers.server.webhooks.webhook.index import ( + ApiServersServerWebhooksWebhookIndexHandler, +) from app.classes.web.routes.api.servers.server.users import ApiServersServerUsersHandler from app.classes.web.routes.api.users.index import ApiUsersIndexHandler from app.classes.web.routes.api.users.user.index import ApiUsersUserIndexHandler @@ -132,6 +138,16 @@ def api_handlers(handler_args): ApiServersServerStatsHandler, handler_args, ), + ( + r"/api/v2/servers/([0-9]+)/webhook/([0-9]+)/?", + ApiServersServerWebhooksWebhookIndexHandler, + handler_args, + ), + ( + r"/api/v2/servers/([0-9]+)/webhook/?", + ApiServersServerWebhooksIndexHandler, + handler_args, + ), ( r"/api/v2/servers/([0-9]+)/action/([a-z_]+)/?", ApiServersServerActionHandler, From 0877f650f44a5d7b88b6d2136eb8712a8253f48c Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 15:05:44 -0400 Subject: [PATCH 13/53] Add api methods --- .../api/servers/server/webhooks/index.py | 100 ++++++++++++ .../servers/server/webhooks/webhook/index.py | 152 ++++++++++++++++++ 2 files changed, 252 insertions(+) create mode 100644 app/classes/web/routes/api/servers/server/webhooks/index.py create mode 100644 app/classes/web/routes/api/servers/server/webhooks/webhook/index.py diff --git a/app/classes/web/routes/api/servers/server/webhooks/index.py b/app/classes/web/routes/api/servers/server/webhooks/index.py new file mode 100644 index 00000000..599a4f4c --- /dev/null +++ b/app/classes/web/routes/api/servers/server/webhooks/index.py @@ -0,0 +1,100 @@ +# TODO: create and read + +import json +import logging + +from jsonschema import ValidationError, validate +from app.classes.models.server_permissions import EnumPermissionsServer +from app.classes.web.base_api_handler import BaseApiHandler +from app.classes.web.webhook_handler import WebhookHandler + + +logger = logging.getLogger(__name__) +new_webhook_schema = { + "type": "object", + "properties": { + "webhook_type": {"type": "string", "enum": WebhookHandler.get_providers()}, + "name": {"type": "string"}, + "url": {"type": "string"}, + "bot_name": {"type": "string"}, + "trigger": {"type": "array"}, + "body": {"type": "string"}, + "enabled": { + "type": "boolean", + "default": True, + }, + }, + "additionalProperties": False, + "minProperties": 7, +} + + +class ApiServersServerWebhooksIndexHandler(BaseApiHandler): + def get(self, server_id: str): + auth_data = self.authenticate_user() + if not auth_data: + return + if ( + EnumPermissionsServer.CONFIG + not in self.controller.server_perms.get_user_id_permissions_list( + auth_data[4]["user_id"], server_id + ) + ): + # if the user doesn't have Schedule permission, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + self.finish_json( + 200, self.controller.management.get_webhooks_by_server(server_id) + ) + + def post(self, server_id: str): + auth_data = self.authenticate_user() + if not auth_data: + return + + try: + data = json.loads(self.request.body) + except json.decoder.JSONDecodeError as e: + return self.finish_json( + 400, {"status": "error", "error": "INVALID_JSON", "error_data": str(e)} + ) + + try: + validate(data, new_webhook_schema) + except ValidationError as e: + return self.finish_json( + 400, + { + "status": "error", + "error": "INVALID_JSON_SCHEMA", + "error_data": str(e), + }, + ) + + if server_id not in [str(x["server_id"]) for x in auth_data[0]]: + # if the user doesn't have access to the server, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + + if ( + EnumPermissionsServer.CONFIG + not in self.controller.server_perms.get_user_id_permissions_list( + auth_data[4]["user_id"], server_id + ) + ): + # if the user doesn't have Schedule permission, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + data["server_id"] = server_id + + self.controller.management.add_to_audit_log( + auth_data[4]["user_id"], + f"Edited server {server_id}: added webhook", + server_id, + self.get_remote_ip(), + ) + triggers = "" + for item in data["trigger"]: + string = item + "," + triggers += string + data["trigger"] = triggers + webhook_id = self.controller.management.create_webhook(data) + + self.finish_json(200, {"status": "ok", "data": {"webhook_id": webhook_id}}) diff --git a/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py b/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py new file mode 100644 index 00000000..370f7360 --- /dev/null +++ b/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py @@ -0,0 +1,152 @@ +# TODO: read and delete + +import json +import logging + +from croniter import croniter +from jsonschema import ValidationError, validate +from app.classes.models.server_permissions import EnumPermissionsServer +from app.classes.web.webhook_handler import WebhookHandler + +from app.classes.web.base_api_handler import BaseApiHandler + + +logger = logging.getLogger(__name__) + +task_patch_schema = { + "type": "object", + "properties": { + "webhook_type": {"type": "string", "enum": WebhookHandler.get_providers()}, + "name": {"type": "string"}, + "url": {"type": "string"}, + "bot_name": {"type": "string"}, + "trigger": {"type": "array"}, + "body": {"type": "string"}, + "enabled": { + "type": "boolean", + "default": True, + }, + }, + "additionalProperties": False, + "minProperties": 1, +} + + +class ApiServersServerWebhooksWebhookIndexHandler(BaseApiHandler): + def get(self, server_id: str, webhook_id: str): + auth_data = self.authenticate_user() + if not auth_data: + return + if ( + EnumPermissionsServer.CONFIG + not in self.controller.server_perms.get_user_id_permissions_list( + auth_data[4]["user_id"], server_id + ) + ): + # if the user doesn't have Schedule permission, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + if ( + not str(webhook_id) + in self.controller.management.get_webhooks_by_server(server_id).keys() + ): + return self.finish_json( + 400, {"status": "error", "error": "NO WEBHOOK FOUND"} + ) + self.finish_json(200, self.controller.management.get_webhook_by_id(webhook_id)) + + def delete(self, server_id: str, webhook_id: str): + auth_data = self.authenticate_user() + if not auth_data: + return + if ( + EnumPermissionsServer.CONFIG + not in self.controller.server_perms.get_user_id_permissions_list( + auth_data[4]["user_id"], server_id + ) + ): + # if the user doesn't have Schedule permission, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + + try: + self.controller.management.delete_webhook(webhook_id) + except Exception: + return self.finish_json( + 400, {"status": "error", "error": "NO WEBHOOK FOUND"} + ) + self.controller.management.add_to_audit_log( + auth_data[4]["user_id"], + f"Edited server {server_id}: removed webhook", + server_id, + self.get_remote_ip(), + ) + + return self.finish_json(200, {"status": "ok"}) + + def patch(self, server_id: str, task_id: str): + auth_data = self.authenticate_user() + if not auth_data: + return + + try: + data = json.loads(self.request.body) + except json.decoder.JSONDecodeError as e: + return self.finish_json( + 400, {"status": "error", "error": "INVALID_JSON", "error_data": str(e)} + ) + + try: + validate(data, task_patch_schema) + except ValidationError as e: + return self.finish_json( + 400, + { + "status": "error", + "error": "INVALID_JSON_SCHEMA", + "error_data": str(e), + }, + ) + + if server_id not in [str(x["server_id"]) for x in auth_data[0]]: + # if the user doesn't have access to the server, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + + if ( + EnumPermissionsServer.SCHEDULE + not in self.controller.server_perms.get_user_id_permissions_list( + auth_data[4]["user_id"], server_id + ) + ): + # if the user doesn't have Schedule permission, return an error + return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) + + # Checks to make sure some doofus didn't actually make the newly + # created task a child of itself. + if str(data.get("parent")) == str(task_id) and data.get("parent") is not None: + data["parent"] = None + + data["server_id"] = server_id + if data["cron_string"] != "" and not croniter.is_valid(data["cron_string"]): + return self.finish_json( + 405, + { + "status": "error", + "error": self.helper.translation.translate( + "error", + "cronFormat", + self.controller.users.get_user_lang_by_id( + auth_data[4]["user_id"] + ), + ), + }, + ) + self.tasks_manager.update_job(task_id, data) + + self.controller.management.add_to_audit_log( + auth_data[4]["user_id"], + f"Edited server {server_id}: updated schedule", + server_id, + self.get_remote_ip(), + ) + self.tasks_manager.reload_schedule_from_db() + + self.finish_json(200, {"status": "ok"}) From 0a2b8694acbef4d32ff87b51d64c2c581c0a2ca1 Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 15:24:28 -0400 Subject: [PATCH 14/53] Add webhook patch --- .../servers/server/webhooks/webhook/index.py | 32 ++++--------------- 1 file changed, 6 insertions(+), 26 deletions(-) diff --git a/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py b/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py index 370f7360..1cf588ff 100644 --- a/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py +++ b/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py @@ -13,7 +13,7 @@ from app.classes.web.base_api_handler import BaseApiHandler logger = logging.getLogger(__name__) -task_patch_schema = { +webhook_patch_schema = { "type": "object", "properties": { "webhook_type": {"type": "string", "enum": WebhookHandler.get_providers()}, @@ -82,7 +82,7 @@ class ApiServersServerWebhooksWebhookIndexHandler(BaseApiHandler): return self.finish_json(200, {"status": "ok"}) - def patch(self, server_id: str, task_id: str): + def patch(self, server_id: str, webhook_id: str): auth_data = self.authenticate_user() if not auth_data: return @@ -95,7 +95,7 @@ class ApiServersServerWebhooksWebhookIndexHandler(BaseApiHandler): ) try: - validate(data, task_patch_schema) + validate(data, webhook_patch_schema) except ValidationError as e: return self.finish_json( 400, @@ -111,7 +111,7 @@ class ApiServersServerWebhooksWebhookIndexHandler(BaseApiHandler): return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) if ( - EnumPermissionsServer.SCHEDULE + EnumPermissionsServer.CONFIG not in self.controller.server_perms.get_user_id_permissions_list( auth_data[4]["user_id"], server_id ) @@ -119,34 +119,14 @@ class ApiServersServerWebhooksWebhookIndexHandler(BaseApiHandler): # if the user doesn't have Schedule permission, return an error return self.finish_json(400, {"status": "error", "error": "NOT_AUTHORIZED"}) - # Checks to make sure some doofus didn't actually make the newly - # created task a child of itself. - if str(data.get("parent")) == str(task_id) and data.get("parent") is not None: - data["parent"] = None - data["server_id"] = server_id - if data["cron_string"] != "" and not croniter.is_valid(data["cron_string"]): - return self.finish_json( - 405, - { - "status": "error", - "error": self.helper.translation.translate( - "error", - "cronFormat", - self.controller.users.get_user_lang_by_id( - auth_data[4]["user_id"] - ), - ), - }, - ) - self.tasks_manager.update_job(task_id, data) + self.controller.management.modify_webhook(webhook_id, data) self.controller.management.add_to_audit_log( auth_data[4]["user_id"], - f"Edited server {server_id}: updated schedule", + f"Edited server {server_id}: updated webhook", server_id, self.get_remote_ip(), ) - self.tasks_manager.reload_schedule_from_db() self.finish_json(200, {"status": "ok"}) From 697c1392dc93640d4f7004dfa41e5ff8aac1d12b Mon Sep 17 00:00:00 2001 From: amcmanu3 Date: Sat, 3 Jun 2023 18:10:39 -0400 Subject: [PATCH 15/53] Add webhooks to frontend --- .../templates/panel/server_webhook_edit.html | 179 ++++++++-------- .../templates/panel/server_webhooks.html | 193 ++++++++++-------- 2 files changed, 185 insertions(+), 187 deletions(-) diff --git a/app/frontend/templates/panel/server_webhook_edit.html b/app/frontend/templates/panel/server_webhook_edit.html index 8baed81f..a9252bc5 100644 --- a/app/frontend/templates/panel/server_webhook_edit.html +++ b/app/frontend/templates/panel/server_webhook_edit.html @@ -6,7 +6,7 @@ {% block title %}Crafty Controller - {{ translate('serverDetails', 'serverDetails', data['lang']) }}{% end %} {% block content %} - +
    @@ -39,22 +39,61 @@ {% if data['new_webhook'] == True %}
    - {% else %} - - {% end %} - + {% for type in data['providers'] %} + + {% end %}

    +
    + + +
    +
    + + +
    +
    + + +
    +
    + + +
    +
    + + +
    +
    + + +
    @@ -68,6 +107,14 @@
    + {% end %} @@ -106,35 +153,30 @@ } const serverId = new URLSearchParams(document.location.search).get('id'); - const schId = new URLSearchParams(document.location.search).get('sch_id'); + const webhookId = new URLSearchParams(document.location.search).get('webhook_id'); $(document).ready(function () { console.log("ready!"); - $("#new_schedule_form").on("submit", async function (e) { + console.log('ready for JS!'); + $('.selectpicker').selectpicker("refresh"); + $("#new_webhook_form").on("submit", async function (e) { e.preventDefault(); var token = getCookie("_xsrf") - let schForm = document.getElementById("new_schedule_form"); + let webhookForm = document.getElementById("new_webhook_form"); + let select_val = JSON.stringify($('#trigger-select').val()); + select_val = JSON.parse(select_val); - let formData = new FormData(schForm); - formData.delete("difficulty"); + let formData = new FormData(webhookForm); //Create an object from the form data entries let formDataObject = Object.fromEntries(formData.entries()); //We need to make sure these are sent regardless of whether or not they're checked formDataObject.enabled = $("#enabled").prop('checked'); - formDataObject.one_time = $("#one_time").prop('checked'); - if ($("#difficulty").val() == "reaction"){ - formDataObject.interval_type = "reaction"; - } - if ($("#action").val() != "command"){ - formDataObject.command = formDataObject.action + "_server"; - } - if (formDataObject.cron_string != ""){ - formDataObject.interval_type = ''; - } + formDataObject.trigger = select_val; + console.log(formDataObject); // Format the plain form data as JSON let formDataJsonString = JSON.stringify(formDataObject, replacer); - let res = await fetch(`/api/v2/servers/${serverId}/tasks/`, { + let res = await fetch(`/api/v2/servers/${serverId}/webhook/`, { method: 'POST', headers: { 'X-XSRFToken': token, @@ -144,7 +186,7 @@ }); let responseData = await res.json(); if (responseData.status === "ok") { - window.location.href = `/panel/server_detail?id=${serverId}&subpage=schedules`; + window.location.href = `/panel/server_detail?id=${serverId}&subpage=webhooks`; } else { bootbox.alert({ @@ -156,32 +198,23 @@ $("#schedule_form").on("submit", async function (e) { e.preventDefault(); - var token = getCookie("_xsrf") - let schForm = document.getElementById("schedule_form"); + var token = getCookie("_xsrf"); + let webhookForm = document.getElementById("new_webhook_form"); + let select_val = JSON.stringify($('#trigger-select').val()); + select_val = JSON.parse(select_val); - let formData = new FormData(schForm); - formData.delete("difficulty"); + let formData = new FormData(webhookForm); //Create an object from the form data entries let formDataObject = Object.fromEntries(formData.entries()); //We need to make sure these are sent regardless of whether or not they're checked formDataObject.enabled = $("#enabled").prop('checked'); - formDataObject.one_time = $("#one_time").prop('checked'); - if ($("#difficulty").val() == "reaction"){ - formDataObject.interval_type = "reaction"; - } - if ($("#action").val() != "command"){ - formDataObject.command = formDataObject.action + "_server"; - } - if (formDataObject.cron_string != ""){ - formDataObject.interval_type = ''; - } + formDataObject.trigger = select_val; + console.log(formDataObject); // Format the plain form data as JSON let formDataJsonString = JSON.stringify(formDataObject, replacer); - console.log(formDataJsonString); - - let res = await fetch(`/api/v2/servers/${serverId}/tasks/${schId}`, { + let res = await fetch(`/api/v2/servers/${serverId}/webhooks/${webhookId}`, { method: 'PATCH', headers: { 'X-XSRFToken': token, @@ -191,7 +224,7 @@ }); let responseData = await res.json(); if (responseData.status === "ok") { - window.location.href = `/panel/server_detail?id=${serverId}&subpage=schedules`; + window.location.href = `/panel/server_detail?id=${serverId}&subpage=webhooks`; } else { bootbox.alert({ @@ -202,60 +235,8 @@ }); }); - - function yesnoCheck() { - if (document.getElementById('action').value == "command") { - document.getElementById("ifYes").style.display = "block"; - document.getElementById("command_input").required = true; - } else { - document.getElementById("ifYes").style.display = "none"; - document.getElementById("command_input").required = false; - } - } - function basicAdvanced() { - if (document.getElementById('difficulty').value == "advanced") { - document.getElementById("ifAdvanced").style.display = "block"; - document.getElementById("ifReaction").style.display = "none"; - document.getElementById("ifBasic").style.display = "none"; - document.getElementById("delay").required = false; - document.getElementById("parent").required = false; - document.getElementById("interval").required = false; - document.getElementById("time").required = false; - } else if (document.getElementById('difficulty').value == "reaction") { - document.getElementById("ifReaction").style.display = "block"; - document.getElementById("ifBasic").style.display = "none"; - document.getElementById("ifAdvanced").style.display = "none"; - document.getElementById("delay").required = true; - document.getElementById("parent").required = true; - document.getElementById("interval").required = false; - document.getElementById("time").required = false; - $("#cron").val(""); - } - else { - document.getElementById("ifAdvanced").style.display = "none"; - document.getElementById("ifReaction").style.display = "none"; - document.getElementById("ifBasic").style.display = "block"; - document.getElementById("delay").required = false; - document.getElementById("parent").required = false; - document.getElementById("interval").required = true; - document.getElementById("time").required = true; - $("#cron").val(""); - } - } - function ifDays() { - if (document.getElementById('interval_type').value == "days") { - document.getElementById("ifDays").style.display = "block"; - document.getElementById("time").required = true; - } else { - document.getElementById("ifDays").style.display = "none"; - document.getElementById("time").required = false; - } - } - - function startup() { - } - window.onload(startup()) + {% end %} \ No newline at end of file diff --git a/app/frontend/templates/panel/server_webhooks.html b/app/frontend/templates/panel/server_webhooks.html index e0342c4b..0357bf80 100644 --- a/app/frontend/templates/panel/server_webhooks.html +++ b/app/frontend/templates/panel/server_webhooks.html @@ -57,6 +57,51 @@ class="fas fa-pencil-alt">
    + + + + + + + + + + + + {% for webhook in data['webhooks'] %} + + + + + + + + {% end %} + +
    Name + Webhook TypeTrigger{{ translate('serverSchedules', 'enabled', + data['lang']) }}{{ translate('serverSchedules', 'edit', data['lang']) + }}
    +

    {{webhook.name}}

    +     		+

    {{webhook.webhook_type}}

    +     		+

    {{webhook.trigger}}

    +     		+ + + +
    +
    + + +
    @@ -118,21 +163,21 @@ } $(() => { - $('.schedule-enabled-toggle').bootstrapToggle({ + $('.webhook-enabled-toggle').bootstrapToggle({ on: 'Yes', off: 'No', onstyle: 'success', offstyle: 'danger', }) - $('.schedule-enabled-toggle').each(function () { - const enabled = JSON.parse(this.getAttribute('data-schedule-enabled')); + $('.webhook-enabled-toggle').each(function () { + const enabled = JSON.parse(this.getAttribute('data-webhook-enabled')); $(this).bootstrapToggle(enabled ? 'on' : 'off') }) - $('.schedule-enabled-toggle').change(function () { - const id = this.getAttribute('data-schedule-id'); + $('.webhook-enabled-toggle').change(function () { + const id = this.getAttribute('data-webhook-id'); const enabled = this.checked; - fetch(`/api/v2/servers/{{data['server_id']}}/tasks/${id}`, { + fetch(`/api/v2/servers/{{data['server_id']}}/webhook/${id}`, { method: 'PATCH', body: JSON.stringify({ enabled }), headers: { @@ -143,50 +188,6 @@ }) const serverId = new URLSearchParams(document.location.search).get('id') - - $(document).ready(function () { - console.log('ready for JS!') - $('#schedule_table').DataTable({ - 'order': [4, 'asc'], - } - ); - - }); - $(document).ready(function () { - console.log('ready for JS!') - $('#mini_schedule_table').DataTable({ - 'order': [2, 'asc'] - } - ); - document.getElementById('mini_schedule_table_wrapper').hidden = true; - }); - $(document).ready(function () { - $('[data-toggle="popover"]').popover(); - if ($(window).width() < 1000) { - $('.too_small').popover("show"); - document.getElementById('schedule_table_wrapper').hidden = true; - document.getElementById('mini_schedule_table_wrapper').hidden = false; - } - - }); - $(window).ready(function () { - $('body').click(function () { - $('.too_small').popover("hide"); - }); - }); - $(window).resize(function () { - // This will execute whenever the window is resized - if ($(window).width() < 1000) { - $('.too_small').popover("show"); - document.getElementById('schedule_table_wrapper').hidden = true; - document.getElementById('mini_schedule_table_wrapper').hidden = false; - } - else { - $('.too_small').popover("hide"); - document.getElementById('schedule_table_wrapper').hidden = false; - document.getElementById('mini_schedule_table_wrapper').hidden = true; - } // New width - }); diff --git a/app/migrations/20230603_webhooks.py b/app/migrations/20230603_webhooks.py index 6470d5fc..433ea9c1 100644 --- a/app/migrations/20230603_webhooks.py +++ b/app/migrations/20230603_webhooks.py @@ -13,6 +13,7 @@ def migrate(migrator, database, **kwargs): bot_name=peewee.CharField(default="Crafty Controller"), trigger=peewee.CharField(default="server_start,server_stop"), body=peewee.CharField(default=""), + color=peewee.CharField(default=""), enabled=peewee.BooleanField(default=True), ) """ diff --git a/app/translations/en_EN.json b/app/translations/en_EN.json index 46eab6ee..a1c56dd6 100644 --- a/app/translations/en_EN.json +++ b/app/translations/en_EN.json @@ -637,8 +637,9 @@ "url": "Webhook URL", "bot_name": "Bot Name", "webhook_body": "Webhook Body", + "color": "Select Color Accent", "areYouSureDel": "Are you sure you want to delete this webhook?", - "areYouSureRun": "Are you sure you want to test this websocket?", + "areYouSureRun": "Are you sure you want to test this webhook?", "edit": "Edit", "run": "Test Run Webhook", "new": "New Webhook", From a62252ed15c17fbd5d0f64ceb617950b15fa0024 Mon Sep 17 00:00:00 2001 From: Andrew Date: Thu, 28 Sep 2023 19:15:01 -0400 Subject: [PATCH 41/53] Allow custom bot naming --- app/classes/web/webhooks/discord_webhook.py | 7 ++++--- app/classes/web/webhooks/mattermost_webhook.py | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/app/classes/web/webhooks/discord_webhook.py b/app/classes/web/webhooks/discord_webhook.py index e63649a1..a60d63d0 100644 --- a/app/classes/web/webhooks/discord_webhook.py +++ b/app/classes/web/webhooks/discord_webhook.py @@ -3,7 +3,7 @@ from app.classes.web.webhooks.base_webhook import WebhookProvider class DiscordWebhook(WebhookProvider): - def _construct_discord_payload(self, server_name, title, message, color): + def _construct_discord_payload(self, server_name, title, message, color, bot_name): """ Constructs the payload required for sending a Discord webhook notification. @@ -30,7 +30,7 @@ class DiscordWebhook(WebhookProvider): headers = {"Content-type": "application/json"} payload = { - "username": self.WEBHOOK_USERNAME, + "username": bot_name, "avatar_url": self.WEBHOOK_PFP_URL, "embeds": [ { @@ -69,7 +69,8 @@ class DiscordWebhook(WebhookProvider): Exception: If there's an error in dispatching the webhook. """ color = kwargs.get("color", "#005cd1") # Default to a color if not provided. + bot_name = kwargs.get("bot_name", self.WEBHOOK_USERNAME) payload, headers = self._construct_discord_payload( - server_name, title, message, color + server_name, title, message, color, bot_name ) return self._send_request(url, payload, headers) diff --git a/app/classes/web/webhooks/mattermost_webhook.py b/app/classes/web/webhooks/mattermost_webhook.py index ecd3b3db..68e33f11 100644 --- a/app/classes/web/webhooks/mattermost_webhook.py +++ b/app/classes/web/webhooks/mattermost_webhook.py @@ -2,7 +2,7 @@ from app.classes.web.webhooks.base_webhook import WebhookProvider class MattermostWebhook(WebhookProvider): - def _construct_mattermost_payload(self, server_name, title, message): + def _construct_mattermost_payload(self, server_name, title, message, bot_name): """ Constructs the payload required for sending a Mattermost webhook notification. @@ -28,7 +28,7 @@ class MattermostWebhook(WebhookProvider): headers = {"Content-Type": "application/json"} payload = { "text": formatted_text, - "username": self.WEBHOOK_USERNAME, + "username": bot_name, "icon_url": self.WEBHOOK_PFP_URL, "props": { "card": ( @@ -65,7 +65,8 @@ class MattermostWebhook(WebhookProvider): - Mattermost's `config.json` setting is `"EnablePostUsernameOverride": true` - Mattermost's `config.json` setting is `"EnablePostIconOverride": true` """ + bot_name = kwargs.get("bot_name", self.WEBHOOK_USERNAME) payload, headers = self._construct_mattermost_payload( - server_name, title, message + server_name, title, message, bot_name ) return self._send_request(url, payload, headers) From 19d72e57665c48e150f86996c106d06339b90058 Mon Sep 17 00:00:00 2001 From: Andrew Date: Thu, 28 Sep 2023 19:26:21 -0400 Subject: [PATCH 42/53] Refactor test webhooks with data --- .../web/routes/api/servers/server/webhooks/webhook/index.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py b/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py index dad0953b..4b58011e 100644 --- a/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py +++ b/app/classes/web/routes/api/servers/server/webhooks/webhook/index.py @@ -175,10 +175,11 @@ class ApiServersServerWebhooksManagementIndexHandler(BaseApiHandler): server_name=self.controller.servers.get_server_data_by_id(server_id)[ "server_name" ], - title="Test Webhook", + title=f"Test Webhook: {webhook['name']}", url=webhook["url"], message=webhook["body"], - color="#4b00d1", # Prestigious purple! + color=webhook["color"], # Prestigious purple! + bot_name="Crafty Webhooks Tester", ) except Exception as e: self.finish_json(500, {"status": "error", "error": str(e)}) From e51b2bd0def9611f9b56959685692d56703d8523 Mon Sep 17 00:00:00 2001 From: Andrew Date: Thu, 28 Sep 2023 19:26:32 -0400 Subject: [PATCH 43/53] Add bot_name to send call --- app/classes/shared/server.py | 1 + 1 file changed, 1 insertion(+) diff --git a/app/classes/shared/server.py b/app/classes/shared/server.py index 33dc212e..412dc1ec 100644 --- a/app/classes/shared/server.py +++ b/app/classes/shared/server.py @@ -188,6 +188,7 @@ class ServerInstance: ) if res is not False and swebhook.enabled: webhook_provider.send( + bot_name=webhook["bot_name"], server_name=args[0].name, title=webhook["name"], url=webhook["url"], From 6a6ca166bc0a1e66cdd38b150a6a7b4c856163b9 Mon Sep 17 00:00:00 2001 From: Andrew Date: Thu, 28 Sep 2023 20:00:38 -0400 Subject: [PATCH 44/53] Accurately display enabled webhook status --- .../templates/panel/server_webhook_edit.html | 34 ++++++++++++++----- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/app/frontend/templates/panel/server_webhook_edit.html b/app/frontend/templates/panel/server_webhook_edit.html index a388bbf5..89974988 100644 --- a/app/frontend/templates/panel/server_webhook_edit.html +++ b/app/frontend/templates/panel/server_webhook_edit.html @@ -87,12 +87,12 @@ -
    - - +
    +
    + + +
    @@ -112,6 +112,20 @@