ENHANCEMENTS:

- /doc can generate firewall rules now

Author: karel26

core/data/const.py

@@ -56,9 +56,10 @@ class PortType(Enum):
 
 class Port:
 
-    def __init__(self, port: int, typ: PortType):
+    def __init__(self, port: int, typ: PortType, *, public: bool = False):
         self.port = port
         self.typ = typ
+        self.public = public
 
     def __repr__(self):
         return f'{self.port}/{self.typ.value}'

core/data/impl/nodeimpl.py

@@ -1692,7 +1692,7 @@ async def info(self) -> dict:
 
         node_dict = {
             "Node": self.node.name,
-            "Listen Port": repr(self.node.listen_port),
+            "Listen Port": self.node.listen_port,
             "Public IP": self.node.public_ip,
             "Bot Version": f"{self.node.bot_version}.{self.node.sub_version}",
             "DCS Branch": self.dcs_branch,
@@ -1711,6 +1711,6 @@ async def info(self) -> dict:
             if not service:
                 continue
             for key, value in service.get_ports().items():
-                node_dict[key] = repr(value)
+                node_dict[key] = value
 
         return node_dict

core/data/instance.py

@@ -49,7 +49,7 @@ def dcs_port(self) -> Port:
                              f"You need to run this server as Administrator!")
         elif port > 65535:
             raise FatalException(f"The DCS port of instance {self.name} is > 65535!")
-        return Port(port, PortType.BOTH)
+        return Port(port, PortType.BOTH, public=True)
 
     @property
     def webgui_port(self) -> Port:
@@ -59,7 +59,7 @@ def webgui_port(self) -> Port:
                              f"You need to run this server as Administrator!")
         elif webgui_port > 65535:
             raise FatalException(f"The WebGUI-port of instance {self.name} is > 65535!")
-        return Port(webgui_port, PortType.TCP)
+        return Port(webgui_port, PortType.TCP, public=True)
 
     @property
     def bot_port(self) -> Port:

core/utils/__init__.py

@@ -8,6 +8,7 @@
 from core.utils.discord import *
 from core.utils.helper import *
 from core.utils.mizedit import *
+from core.utils.network import *
 from core.utils.os import *
 from core.utils.performance import *
 from core.utils.squadrons import *

core/utils/network.py

@@ -0,0 +1,51 @@
+from core import Port, PortType
+from typing import Iterable
+
+__all__ = ["generate_firewall_rules"]
+
+
+def fw_rule(port: int, protocol: str, name: str, description: str) -> str:
+    """
+    Returns a single New-NetFirewallRule command string.
+    """
+    cmd = (
+        f'New-NetFirewallRule '
+        f'-DisplayName "{name}" '
+        f'-Direction Inbound '
+        f'-Action Allow '
+        f'-Protocol {protocol} '
+        f'-LocalPort {port} '
+        f'-Profile Any '
+        f'-Description "{description}"'
+    )
+    return cmd
+
+def generate_firewall_rules(ports: Iterable[Port]) -> str:
+    """
+    Write a PowerShell script that adds inbound rules for the given ports.
+    """
+    lines = [
+        "# ------------------------------------------------------------",
+        "# Auto‑generated PowerShell script to add inbound firewall rules",
+        "# Run this script **as Administrator** in PowerShell.",
+        "# ------------------------------------------------------------",
+        "",
+        "Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force",
+        ""
+    ]
+
+    for p in ports:
+        if p.typ is PortType.BOTH:
+            # Create two separate rules
+            for proto in (PortType.TCP, PortType.UDP):
+                name = f"Allow {p.port}/{proto.value.lower()}"
+                desc = f"Auto‑generated rule for inbound {p.port}/{proto.value.lower()}"
+                lines.append(fw_rule(p.port, proto.value, name, desc))
+                lines.append("")  # blank line for readability
+        else:
+            name = f"Allow {p.port}/{p.typ.value.lower()}"
+            desc = f"Auto‑generated rule for inbound {p.port}/{p.typ.value.lower()}"
+            lines.append(fw_rule(p.port, p.typ.value, name, desc))
+            lines.append("")
+
+    return "\n".join(lines)

extensions/lardoon/extension.py

@@ -226,5 +226,5 @@ async def schedule(self):
     @override
     def get_ports(self) -> dict[str, Port]:
         return {
-            "Lardoon": Port(self.config['bind'].split(':')[1], PortType.TCP)
+            "Lardoon": Port(self.config['bind'].split(':')[1], PortType.TCP, public=True)
         } if self.enabled else {}

extensions/lotatc/extension.py

@@ -375,6 +375,6 @@ async def schedule(self):
     @override
     def get_ports(self) -> dict[str, Port]:
         return {
-            "LotAtc": Port(self.locals.get('port', 10310), PortType.TCP),
+            "LotAtc": Port(self.locals.get('port', 10310), PortType.TCP, public=True),
             "LotAtc JSON Server Port": Port(self.locals.get('lotatc_inst.options', {}).get('jsonserver_port', 8081), PortType.TCP)
         } if self.enabled else {}

extensions/olympus/extension.py

@@ -340,6 +340,6 @@ def shutdown(self, *, quiet: bool = False) -> bool:
     def get_ports(self) -> dict[str, Port]:
         return {
             "Olympus " + self.backend_tag.capitalize(): Port(self.config.get(self.backend_tag, {}).get('port', 4512), PortType.TCP),
-            "Olympus " + self.frontend_tag.capitalize(): Port(self.config.get(self.frontend_tag, {}).get('port', 3000), PortType.TCP),
+            "Olympus " + self.frontend_tag.capitalize(): Port(self.config.get(self.frontend_tag, {}).get('port', 3000), PortType.TCP, public=True),
             "Olympus WSPort": Port(self.config.get('audio', {}).get('WSPort', 4000), PortType.TCP)
         } if self.enabled else {}

extensions/sneaker/extension.py

@@ -186,5 +186,5 @@ async def render(self, param: dict | None = None) -> dict:
     @override
     def get_ports(self) -> dict[str, Port]:
         return {
-            "Sneaker": Port(self.config['bind'].split(':')[1], PortType.TCP)
+            "Sneaker": Port(self.config['bind'].split(':')[1], PortType.TCP, public=True)
         } if self.enabled else {}

extensions/srs/extension.py

@@ -624,7 +624,7 @@ async def schedule(self):
     def get_ports(self) -> dict[str, Port]:
         if self.enabled:
             rc: dict[str, Port] = {
-                "SRS Port": Port(self.locals['Server Settings']['SERVER_PORT'], PortType.BOTH)
+                "SRS Port": Port(self.locals['Server Settings']['SERVER_PORT'], PortType.BOTH, public=True)
             }
             if self.locals['General Settings'].get('LOTATC_EXPORT_ENABLED', False):
                 rc["LotAtc Export Port"] = Port(self.locals['General Settings'].get('LOTATC_EXPORT_PORT', 10712), PortType.UDP)