feat: add HTTP monitor and style

Author: pascal-zarrad

discordgsm/games.csv

@@ -312,6 +312,7 @@ vietcong2,Vietcong 2,gamespy2,port=5001;port_query=19967
 vrising,V Rising,source,port=9876;port_query=9877
 
 warsow,Warsow,quake3,port=44400
+http,Website,http,
 wheeloftime,Wheel of Time,gamespy1,port=7777;port_query_offset=1
 wolfenstein2009,Wolfenstein 2009,doom3,port=27666
 wolfensteinet,Wolfenstein: Enemy Territory,quake3,port_query=27960

discordgsm/main.py

@@ -215,7 +215,7 @@ async def send_alert(server: Server, alert: Alert):
         content = None if not content else content
         username = 'Game Server Monitor Alert'
         avatar_url = 'https://avatars.githubusercontent.com/u/61296017'
- 
+
         async with aiohttp.ClientSession() as session:
             webhook = Webhook.from_url(webhook_url, session=session)
             await webhook.send(content, username=username, avatar_url=avatar_url, embed=alert_embed(server, alert))
@@ -276,6 +276,17 @@ def query_server_modal(game: GamedigGame, locale: Locale):
         query_extra['password'] = TextInput(label='Password',  placeholder='Query Password', default="User")
         modal.add_item(query_extra['username'])
         modal.add_item(query_extra['password'])
+    elif game['id'] == "http":
+        query_extra['website_name'] = TextInput(label="Display Name", placeholder="My Website")
+        query_extra['status_code'] = TextInput(label="Response Status Code", placeholder=200, default=200)
+        query_extra['response_content'] = TextInput(label="Response Content has... (regex)", placeholder=".*", default=".*")
+
+        modal.add_item(query_extra['website_name'])
+        modal.add_item(query_extra['status_code'])
+        modal.add_item(query_extra['response_content'])
+
+        modal.remove_item(query_param['port'])
+        query_param['port']._value = '0'
 
     return modal, query_param, query_extra
 
@@ -322,6 +333,9 @@ async def modal_on_submit(interaction: Interaction):
         # Create new server object
         server = Server.new(interaction.guild_id, interaction.channel_id, game_id, address, query_port, query_extra, result)
         style = Styles.get(server, 'Medium')
+        if game_id == 'http':
+            style = Styles.get(server, 'Website')
+
         server.style_id = style.id
         server.style_data = await style.default_style_data(None)
 
@@ -1043,7 +1057,7 @@ async def query_distinct_server(servers: list[Server]):
 
 
 async def get_hash_code(server: Server):
-    if server.game_id in ['discord', 'scpsl']:
+    if server.game_id in ['discord', 'scpsl', 'http']:
         host = server.address
     else:
         try:

discordgsm/protocols/__init__.py

@@ -40,5 +40,6 @@
 from .ut3_lan import UT3_LAN
 from .vcmp import Vcmp
 from .won import WON
+from .http import HTTP
 
 protocols = {str(protocol.name): protocol for protocol in Protocol.__subclasses__()}

discordgsm/protocols/http.py

@@ -0,0 +1,56 @@
+import time
+import re
+from typing import TYPE_CHECKING
+
+import aiohttp
+
+from discordgsm.logger import Logger
+
+from discordgsm.protocols.protocol import Protocol
+
+if TYPE_CHECKING:
+    from discordgsm.gamedig import GamedigResult
+
+
+class HTTP(Protocol):
+    name = "http"
+
+    async def query(self):
+        url, status_code, response_content, website_name = (
+            str(self.kv["host"]),
+            int(str(self.kv["status_code"])),
+            str(self.kv["response_content"]),
+            str(self.kv["website_name"]),
+        )
+
+        start = time.time()
+        async with aiohttp.ClientSession() as session:
+            async with session.get(url) as response:
+                status = response.status
+                content = await response.text()
+                end = time.time()
+
+        if not status == status_code:
+            raise Exception(f"Received unexpected status code {status}")
+
+        if not re.search(response_content, content):
+            raise Exception("Response body did not match provided regex!")
+
+        result: GamedigResult = {
+            "name": website_name,
+            "map": "",
+            "password": False,
+            "numplayers": 0,
+            "numbots": 0,
+            "maxplayers": -1,
+            "players": None,
+            "bots": None,
+            "connect": f"{url}",
+            "ping": int((end - start) * 1000),
+            "raw": {
+                status_code: status,
+                response_content: content
+            },
+        }
+
+        return result

discordgsm/styles/__init__.py

@@ -5,14 +5,15 @@
 from .large import Large
 from .medium import Medium
 from .small import Small
+from .website import Website
 from .style import Style
 
 if __name__ == '__main__':
     from server import Server
 else:
     from discordgsm.server import Server
 
-styles: List[Type[Style]] = [ExtraSmall, Small, Medium, Large, ExtraLarge]
+styles: List[Type[Style]] = [ExtraSmall, Small, Medium, Large, ExtraLarge, Website]
 _styles = {style.__name__: style for style in styles}
 
 

discordgsm/styles/style.py

@@ -89,6 +89,9 @@ async def default_style_data(self, locale: Optional[Locale]):
         elif gamedig.default_port(self.server.game_id) == 27015 and gamedig.game_port(self.server.result) == int(self.server.query_port):
             style_data['description'] = t('embed.description.connect', self.locale).format(url=f'steam://connect/{self.server.address}:{self.server.query_port}')
 
+        if self.server.game_id == 'http':
+            return style_data
+
         try:
             async with aiohttp.ClientSession() as session:
                 async with session.get(f'https://ipinfo.io/{socket.gethostbyname(self.server.address)}/country') as response:
@@ -128,6 +131,9 @@ def add_address_field(self, embed: Embed):
         if self.server.game_id == 'discord':
             name = t('modal.text_input.guild_id.label', self.locale)
             embed.add_field(name=name, value=f'`{self.server.address}`', inline=True)
+        elif self.server.game_id == 'http':
+            name = t("modal.text_input.http.label", self.locale)
+            embed.add_field(name=name, value=f'`{self.server.address}`', inline=True)
         elif game_port is None or game_port == int(self.server.query_port):
             name = t('embed.field.address:port.name', self.locale)
             embed.add_field(name=name, value=f'`{self.server.address}:{self.server.query_port}`', inline=True)

discordgsm/styles/website.py

@@ -0,0 +1,49 @@
+from typing import Dict
+
+from discord.ui import TextInput
+from discord import Color, Embed, Emoji, Locale, PartialEmoji, TextStyle
+
+from discordgsm.styles.style import Style
+from discordgsm.translator import t
+
+
+class Website(Style):
+    """Website style"""
+
+    @property
+    def display_name(self) -> str:
+        return t('style.website.display_name', self.locale)
+
+    @property
+    def description(self) -> str:
+        return t('style.website.description', self.locale)
+
+    @property
+    def default_edit_fields(self) -> Dict[str, TextInput]:
+        return {
+            'description': TextInput(
+                label=t('embed.text_input.description.label', self.locale),
+                style=TextStyle.long,
+                placeholder=t('embed.text_input.description.placeholder', self.locale),
+                default=self.server.style_data.get('description', ''),
+                required=False,
+                max_length=1024
+            ),
+            'fullname': TextInput(
+                label=t('embed.text_input.fullname.label', self.locale),
+                placeholder=t('embed.text_input.fullname.placeholder', self.locale),
+                default=self.server.style_data.get('fullname', ''),
+            )
+        }
+
+    def embed(self) -> Embed:
+        title, description, color = self.embed_data()
+        embed = Embed(title=title, description=description, color=color)
+
+        self.add_status_field(embed)
+        self.add_address_field(embed)
+        self.add_game_field(embed)
+
+        self.set_footer(embed)
+
+        return embed

discordgsm/translations/de.json

@@ -58,6 +58,7 @@
     "modal.text_input.guild_id.label": "Gilden-ID",
     "modal.text_input.webhook_url.label": "Webhook URL",
     "modal.text_input.webhook_content.label": "Webhook-Inhalt",
+    "modal.text_input.http.label": "URL",
     "embed.alert.description.test": "🧪 Dies ist ein Testalarm!",
     "embed.alert.description.online": "✅ Server ist wieder online!",
     "embed.alert.description.offline": "🚨 Server scheint ausgefallen zu sein!",
@@ -97,5 +98,7 @@
     "style.large.display_name": "Groß",
     "style.large.description": "Ein großformatiger Stil, der Serverinformationen und eine Spielerliste anzeigt.",
     "style.extra_large.display_name": "Extra Groß",
-    "style.extra_large.description": "Ein extra großformatiger Stil, der mit Bot-Liste angezeigt wird."
+    "style.extra_large.description": "Ein extra großformatiger Stil, der mit Bot-Liste angezeigt wird.",
+    "style.website.display_name": "Webseite",
+    "style.website.description": "Ein spezieller Style der nur mit dem Typ \"http\" genutzt werden sollte."
 }

discordgsm/translations/en-GB.json

@@ -58,6 +58,7 @@
     "modal.text_input.guild_id.label": "Guild ID",
     "modal.text_input.webhook_url.label": "Webhook URL",
     "modal.text_input.webhook_content.label": "Webhook Content",
+    "modal.text_input.http.label": "URL",
     "embed.alert.description.test": "🧪 This is a test alert!",
     "embed.alert.description.online": "✅ Your server is back online!",
     "embed.alert.description.offline": "🚨 Your server seems to be down!",
@@ -97,5 +98,7 @@
     "style.large.display_name": "Large",
     "style.large.description": "A large-sized style that shows server info and player list.",
     "style.extra_large.display_name": "Extra Large",
-    "style.extra_large.description": "An extra large-sized style that shows with bot list."
+    "style.extra_large.description": "An extra large-sized style that shows with bot list.",
+    "style.website.display_name": "Website",
+    "style.website.description": "A special type that should only being used with type \"http\"."
 }

discordgsm/translations/en-US.json

@@ -58,6 +58,7 @@
     "modal.text_input.guild_id.label": "Guild ID",
     "modal.text_input.webhook_url.label": "Webhook URL",
     "modal.text_input.webhook_content.label": "Webhook Content",
+    "modal.text_input.http.label": "URL",
     "embed.alert.description.test": "🧪 This is a test alert!",
     "embed.alert.description.online": "✅ Your server is back online!",
     "embed.alert.description.offline": "🚨 Your server seems to be down!",
@@ -97,5 +98,7 @@
     "style.large.display_name": "Large",
     "style.large.description": "A large-sized style that shows server info and player list.",
     "style.extra_large.display_name": "Extra Large",
-    "style.extra_large.description": "An extra large-sized style that shows with bot list."
+    "style.extra_large.description": "An extra large-sized style that shows with bot list.",
+    "style.website.display_name": "Website",
+    "style.website.description": "A special type that should only being used with type \"http\"."
 }