Compare commits

...

4 commits

Author SHA1 Message Date
37cdca09ec
fix(pterodactyl): pylint fixes
Some checks failed
Actions / Lint Code (Ruff & Pylint) (pull_request) Failing after 19s
Actions / Build Documentation (MkDocs) (pull_request) Successful in 24s
2024-02-29 22:15:44 -05:00
84b0201662
docs(pterodactyl): added docs pages 2024-02-29 22:11:37 -05:00
839ead56eb
fix(pterodactyl): remove looping functionality from websocket.connect on line 62 as it's irrelevant now and was broken regardless 2024-02-29 22:07:22 -05:00
9e15730af9
fix(pterodactyl): cancel the task upon error 2024-02-29 22:06:59 -05:00
3 changed files with 64 additions and 51 deletions

View file

@ -0,0 +1,16 @@
# Pterodactyl
/// admonition | This project is in active development
type: warning
These docs are not complete yet, and there is a lot still to do.
///
Pterodactyl allows for connecting to a Pterodactyl server through websockets. It is intended primarily for use with Minecraft servers, as it allows for version & server platform-agnostic Discord integration, including console logging and two-way chat bridging.
## Installation
```bash
[p]repo add seacogs https://coastalcommits.com/SeaswimmerTheFsh/SeaCogs
[p]cog install seacogs pterodactyl
[p]cog load aurora
```

View file

@ -19,6 +19,8 @@ nav:
- Bible: bible.md
- Backup: backup.md
- Nerdify: nerdify.md
- Pterodactyl:
- pterodactyl/index.md
plugins:
- git-authors

View file

@ -59,8 +59,7 @@ class Pterodactyl(commands.Cog):
except exceptions.PterodactylApiError as e:
return self.logger.error('Failed to retrieve Pterodactyl websocket: %s', e)
async for websocket in websockets.connect(websocket_credentials['data']['socket'], origin=base_url, ping_timeout=60):
try:
async with websockets.connect(websocket_credentials['data']['socket'], origin=base_url, ping_timeout=60) as websocket:
self.logger.info("WebSocket connection established")
auth_message = json.dumps({"event": "auth", "args": [websocket_credentials['data']['token']]})
@ -72,7 +71,7 @@ class Pterodactyl(commands.Cog):
while True:
message = await websocket.recv()
if json.loads(message)['event'] in ['token expiring', 'token expired']:
if json.loads(message)['event'] in ('token expiring', 'token expired'):
self.logger.debug("Received token expiring/expired event. Refreshing token.")
websocket_credentials = client.servers.get_websocket(server_id)
auth_message = json.dumps({"event": "auth", "args": [websocket_credentials['data']['token']]})
@ -83,7 +82,7 @@ class Pterodactyl(commands.Cog):
self.logger.info("WebSocket authentication successful")
if json.loads(message)['event'] == 'console output' and await self.config.console_channel() is not None:
if current_status == 'running' or current_status == 'offline' or current_status == '':
if current_status in ('running', 'offline', ''):
content = self.remove_ansi_escape_codes(json.loads(message)['args'][0])
channel = self.bot.get_channel(await self.config.console_channel())
@ -107,10 +106,6 @@ class Pterodactyl(commands.Cog):
console = self.bot.get_channel(await self.config.console_channel())
if console is not None:
await console.send(f"Server status changed! `{json.loads(message)['args'][0]}`")
except (websockets.exceptions.ConnectionClosed) as e:
self.logger.info("WebSocket connection closed: %s", e)
websocket_credentials = client.servers.get_websocket(server_id)
continue
def remove_ansi_escape_codes(self, text: str) -> str:
ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
@ -122,9 +117,9 @@ class Pterodactyl(commands.Cog):
regex = await self.config.chat_regex()
match: Optional[re.Match[str]] = re.match(regex, text)
if match:
dict = {"time": match.group(1), "username": match.group(2), "message": match.group(3)}
self.logger.debug("Message is a chat message\n%s", json.dumps(dict))
return dict
groups = {"time": match.group(1), "username": match.group(2), "message": match.group(3)}
self.logger.debug("Message is a chat message\n%s", json.dumps(groups))
return groups
self.logger.debug("Message is not a chat message")
return False
@ -136,7 +131,6 @@ class Pterodactyl(commands.Cog):
if response.status == 200:
self.logger.debug("Player info retrieved for %s\n%s", username, json.dumps(await response.json()))
return await response.json()
else:
self.logger.error("Failed to retrieve player info for %s: %s", username, response.status)
return None
@ -170,8 +164,9 @@ class Pterodactyl(commands.Cog):
fut.result()
except asyncio.CancelledError:
pass
except Exception as e:
except Exception as e: # pylint: disable=broad-exception-caught
self.logger.error("WebSocket task has failed: %s", e, exc_info=e)
self.task.cancel()
self.task = self.get_task()
async def cog_load(self):