322 lines
13 KiB
Python
322 lines
13 KiB
Python
from __future__ import annotations
|
|
import os
|
|
import logging
|
|
import json
|
|
import string
|
|
import copy
|
|
import sys
|
|
import subprocess
|
|
import factorio_rcon
|
|
|
|
import colorama
|
|
import asyncio
|
|
from queue import Queue
|
|
from CommonClient import CommonContext, server_loop, console_loop, ClientCommandProcessor, logger
|
|
from MultiServer import mark_raw
|
|
|
|
import Utils
|
|
import random
|
|
from NetUtils import RawJSONtoTextParser, NetworkItem, ClientStatus, JSONtoTextParser, JSONMessagePart
|
|
|
|
from worlds.factorio.Technologies import lookup_id_to_name
|
|
|
|
rcon_port = 24242
|
|
rcon_password = ''.join(random.choice(string.ascii_letters) for x in range(32))
|
|
|
|
logging.basicConfig(format='[%(name)s]: %(message)s', level=logging.INFO)
|
|
factorio_server_logger = logging.getLogger("FactorioServer")
|
|
options = Utils.get_options()
|
|
executable = options["factorio_options"]["executable"]
|
|
bin_dir = os.path.dirname(executable)
|
|
if not os.path.isdir(bin_dir):
|
|
raise FileNotFoundError(bin_dir)
|
|
if not os.path.exists(executable):
|
|
if os.path.exists(executable + ".exe"):
|
|
executable = executable + ".exe"
|
|
else:
|
|
raise FileNotFoundError(executable)
|
|
|
|
server_args = ("--rcon-port", rcon_port, "--rcon-password", rcon_password, *sys.argv[1:])
|
|
|
|
|
|
class FactorioCommandProcessor(ClientCommandProcessor):
|
|
ctx: FactorioContext
|
|
|
|
@mark_raw
|
|
def _cmd_factorio(self, text: str) -> bool:
|
|
"""Send the following command to the bound Factorio Server."""
|
|
if self.ctx.rcon_client:
|
|
result = self.ctx.rcon_client.send_command(text)
|
|
if result:
|
|
self.output(result)
|
|
return True
|
|
return False
|
|
|
|
def _cmd_connect(self, address: str = "") -> bool:
|
|
"""Connect to a MultiWorld Server"""
|
|
if not self.ctx.auth:
|
|
if self.ctx.rcon_client:
|
|
get_info(self.ctx, self.ctx.rcon_client) # retrieve current auth code
|
|
else:
|
|
self.output("Cannot connect to a server with unknown own identity, bridge to Factorio first.")
|
|
return super(FactorioCommandProcessor, self)._cmd_connect(address)
|
|
|
|
|
|
class FactorioContext(CommonContext):
|
|
command_processor = FactorioCommandProcessor
|
|
game = "Factorio"
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(FactorioContext, self).__init__(*args, **kwargs)
|
|
self.send_index = 0
|
|
self.rcon_client = None
|
|
self.awaiting_bridge = False
|
|
self.raw_json_text_parser = RawJSONtoTextParser(self)
|
|
self.factorio_json_text_parser = FactorioJSONtoTextParser(self)
|
|
|
|
async def server_auth(self, password_requested):
|
|
if password_requested and not self.password:
|
|
await super(FactorioContext, self).server_auth(password_requested)
|
|
|
|
await self.send_msgs([{"cmd": 'Connect',
|
|
'password': self.password, 'name': self.auth, 'version': Utils.version_tuple,
|
|
'tags': ['AP'],
|
|
'uuid': Utils.get_unique_identifier(), 'game': "Factorio"
|
|
}])
|
|
|
|
def on_print(self, args: dict):
|
|
logger.info(args["text"])
|
|
if self.rcon_client:
|
|
cleaned_text = args['text'].replace('"', '')
|
|
self.rcon_client.send_command(f"/sc game.print(\"[font=default-large-bold]Archipelago:[/font] "
|
|
f"{cleaned_text}\")")
|
|
|
|
def on_print_json(self, args: dict):
|
|
if not self.found_items and args.get("type", None) == "ItemSend" and args["receiving"] == args["sending"]:
|
|
pass # don't want info on other player's local pickups.
|
|
text = self.raw_json_text_parser(copy.deepcopy(args["data"]))
|
|
logger.info(text)
|
|
if self.rcon_client:
|
|
text = self.factorio_json_text_parser(args["data"])
|
|
cleaned_text = text.replace('"', '')
|
|
self.rcon_client.send_command(f"/sc game.print(\"[font=default-large-bold]Archipelago:[/font] "
|
|
f"{cleaned_text}\")")
|
|
|
|
@property
|
|
def savegame_name(self) -> str:
|
|
return f"AP_{self.seed_name}_{self.auth}.zip"
|
|
|
|
|
|
async def game_watcher(ctx: FactorioContext):
|
|
bridge_logger = logging.getLogger("FactorioWatcher")
|
|
from worlds.factorio.Technologies import lookup_id_to_name
|
|
try:
|
|
while not ctx.exit_event.is_set():
|
|
if ctx.awaiting_bridge and ctx.rcon_client:
|
|
ctx.awaiting_bridge = False
|
|
data = json.loads(ctx.rcon_client.send_command("/ap-sync"))
|
|
if data["slot_name"] != ctx.auth:
|
|
logger.warning(f"Connected World is not the expected one {data['slot_name']} != {ctx.auth}")
|
|
elif data["seed_name"] != ctx.seed_name:
|
|
logger.warning(f"Connected Multiworld is not the expected one {data['seed_name']} != {ctx.seed_name}")
|
|
else:
|
|
data = data["info"]
|
|
research_data = data["research_done"]
|
|
research_data = {int(tech_name.split("-")[1]) for tech_name in research_data}
|
|
victory = data["victory"]
|
|
|
|
if not ctx.finished_game and victory:
|
|
await ctx.send_msgs([{"cmd": "StatusUpdate", "status": ClientStatus.CLIENT_GOAL}])
|
|
ctx.finished_game = True
|
|
|
|
if ctx.locations_checked != research_data:
|
|
bridge_logger.info(
|
|
f"New researches done: "
|
|
f"{[lookup_id_to_name[rid] for rid in research_data - ctx.locations_checked]}")
|
|
ctx.locations_checked = research_data
|
|
await ctx.send_msgs([{"cmd": 'LocationChecks', "locations": tuple(research_data)}])
|
|
await asyncio.sleep(1)
|
|
|
|
except Exception as e:
|
|
logging.exception(e)
|
|
logging.error("Aborted Factorio Server Bridge")
|
|
|
|
|
|
def stream_factorio_output(pipe, queue, process):
|
|
def queuer():
|
|
while process.poll() is None:
|
|
text = pipe.readline().strip()
|
|
if text:
|
|
queue.put_nowait(text)
|
|
|
|
from threading import Thread
|
|
|
|
thread = Thread(target=queuer, name="Factorio Output Queue", daemon=True)
|
|
thread.start()
|
|
return thread
|
|
|
|
|
|
async def factorio_server_watcher(ctx: FactorioContext):
|
|
savegame_name = os.path.abspath(ctx.savegame_name)
|
|
if not os.path.exists(savegame_name):
|
|
logger.info(f"Creating savegame {savegame_name}")
|
|
subprocess.run((
|
|
executable, "--create", savegame_name, "--preset", "archipelago"
|
|
))
|
|
factorio_process = subprocess.Popen((executable, "--start-server", ctx.savegame_name,
|
|
*(str(elem) for elem in server_args)),
|
|
stderr=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stdin=subprocess.DEVNULL,
|
|
encoding="utf-8")
|
|
factorio_server_logger.info("Started Factorio Server")
|
|
factorio_queue = Queue()
|
|
stream_factorio_output(factorio_process.stdout, factorio_queue, factorio_process)
|
|
stream_factorio_output(factorio_process.stderr, factorio_queue, factorio_process)
|
|
try:
|
|
while not ctx.exit_event.is_set():
|
|
if factorio_process.poll():
|
|
factorio_server_logger.info("Factorio server has exited.")
|
|
ctx.exit_event.set()
|
|
|
|
while not factorio_queue.empty():
|
|
msg = factorio_queue.get()
|
|
factorio_server_logger.info(msg)
|
|
if not ctx.rcon_client and "Starting RCON interface at IP ADDR:" in msg:
|
|
ctx.rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password)
|
|
# trigger lua interface confirmation
|
|
ctx.rcon_client.send_command("/sc game.print('Starting Archipelago Bridge')")
|
|
ctx.rcon_client.send_command("/sc game.print('Starting Archipelago Bridge')")
|
|
if not ctx.awaiting_bridge and "Archipelago Bridge Data available for game tick " in msg:
|
|
ctx.awaiting_bridge = True
|
|
if ctx.rcon_client:
|
|
while ctx.send_index < len(ctx.items_received):
|
|
transfer_item: NetworkItem = ctx.items_received[ctx.send_index]
|
|
item_id = transfer_item.item
|
|
player_name = ctx.player_names[transfer_item.player]
|
|
if item_id not in lookup_id_to_name:
|
|
logging.error(f"Cannot send unknown item ID: {item_id}")
|
|
else:
|
|
item_name = lookup_id_to_name[item_id]
|
|
factorio_server_logger.info(f"Sending {item_name} to Nauvis from {player_name}.")
|
|
ctx.rcon_client.send_command(f'/ap-get-technology {item_name}\t{ctx.send_index}\t{player_name}')
|
|
ctx.send_index += 1
|
|
await asyncio.sleep(0.1)
|
|
|
|
except Exception as e:
|
|
logging.exception(e)
|
|
logging.error("Aborted Factorio Server Bridge")
|
|
ctx.rcon_client = None
|
|
ctx.exit_event.set()
|
|
|
|
finally:
|
|
factorio_process.terminate()
|
|
|
|
|
|
def get_info(ctx, rcon_client):
|
|
info = json.loads(rcon_client.send_command("/ap-rcon-info"))
|
|
ctx.auth = info["slot_name"]
|
|
ctx.seed_name = info["seed_name"]
|
|
|
|
|
|
async def factorio_spinup_server(ctx: FactorioContext):
|
|
savegame_name = os.path.abspath("Archipelago.zip")
|
|
if not os.path.exists(savegame_name):
|
|
logger.info(f"Creating savegame {savegame_name}")
|
|
subprocess.run((
|
|
executable, "--create", savegame_name
|
|
))
|
|
factorio_process = subprocess.Popen(
|
|
(executable, "--start-server", savegame_name, *(str(elem) for elem in server_args)),
|
|
stderr=subprocess.PIPE,
|
|
stdout=subprocess.PIPE,
|
|
stdin=subprocess.DEVNULL,
|
|
encoding="utf-8")
|
|
factorio_server_logger.info("Started Information Exchange Factorio Server")
|
|
factorio_queue = Queue()
|
|
stream_factorio_output(factorio_process.stdout, factorio_queue, factorio_process)
|
|
stream_factorio_output(factorio_process.stderr, factorio_queue, factorio_process)
|
|
rcon_client = None
|
|
try:
|
|
while not ctx.auth:
|
|
while not factorio_queue.empty():
|
|
msg = factorio_queue.get()
|
|
factorio_server_logger.info(msg)
|
|
if not rcon_client and "Starting RCON interface at IP ADDR:" in msg:
|
|
rcon_client = factorio_rcon.RCONClient("localhost", rcon_port, rcon_password)
|
|
get_info(ctx, rcon_client)
|
|
|
|
|
|
await asyncio.sleep(0.01)
|
|
|
|
except Exception as e:
|
|
logging.exception(e)
|
|
logging.error("Aborted Factorio Server Bridge")
|
|
ctx.exit_event.set()
|
|
|
|
else:
|
|
logger.info(f"Got World Information from AP Mod for seed {ctx.seed_name} in slot {ctx.auth}")
|
|
|
|
finally:
|
|
factorio_process.terminate()
|
|
|
|
|
|
async def main(ui=None):
|
|
ctx = FactorioContext(None, None, True)
|
|
ctx.server_task = asyncio.create_task(server_loop(ctx), name="ServerLoop")
|
|
if ui:
|
|
input_task = None
|
|
ui_app = ui(ctx)
|
|
ui_task = asyncio.create_task(ui_app.async_run(), name="UI")
|
|
else:
|
|
input_task = asyncio.create_task(console_loop(ctx), name="Input")
|
|
ui_task = None
|
|
factorio_server_task = asyncio.create_task(factorio_spinup_server(ctx), name="FactorioSpinupServer")
|
|
await factorio_server_task
|
|
factorio_server_task = asyncio.create_task(factorio_server_watcher(ctx), name="FactorioServer")
|
|
progression_watcher = asyncio.create_task(
|
|
game_watcher(ctx), name="FactorioProgressionWatcher")
|
|
|
|
await ctx.exit_event.wait()
|
|
ctx.server_address = None
|
|
|
|
await progression_watcher
|
|
await factorio_server_task
|
|
|
|
if ctx.server and not ctx.server.socket.closed:
|
|
await ctx.server.socket.close()
|
|
if ctx.server_task is not None:
|
|
await ctx.server_task
|
|
|
|
while ctx.input_requests > 0:
|
|
ctx.input_queue.put_nowait(None)
|
|
ctx.input_requests -= 1
|
|
|
|
if ui_task:
|
|
await ui_task
|
|
|
|
if input_task:
|
|
input_task.cancel()
|
|
|
|
|
|
class FactorioJSONtoTextParser(JSONtoTextParser):
|
|
def _handle_color(self, node: JSONMessagePart):
|
|
colors = node["color"].split(";")
|
|
for color in colors:
|
|
if color in {"red", "green", "blue", "orange", "yellow", "pink", "purple", "white", "black", "gray",
|
|
"brown", "cyan", "acid"}:
|
|
node["text"] = f"[color={color}]{node['text']}[/color]"
|
|
return self._handle_text(node)
|
|
elif color == "magenta":
|
|
node["text"] = f"[color=pink]{node['text']}[/color]"
|
|
return self._handle_text(node)
|
|
return self._handle_text(node)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
colorama.init()
|
|
loop = asyncio.get_event_loop()
|
|
loop.run_until_complete(main())
|
|
loop.close()
|
|
colorama.deinit()
|