From 54897c1447890327772771f631bed7fc90b7b486 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Wed, 8 Jun 2022 22:26:08 +0200 Subject: [PATCH 1/8] Fix deserializing to a smaller inventory Void excess slots when deserializing an inventory to a target that has fewer slots than what was serialized. This fixs inventory sync failing when a stored inventory has trash slots in use but the player does not have the slots unlocked. --- packages/slave/modules/clusterio/serialize.lua | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/slave/modules/clusterio/serialize.lua b/packages/slave/modules/clusterio/serialize.lua index f9a77da0..b03557cf 100644 --- a/packages/slave/modules/clusterio/serialize.lua +++ b/packages/slave/modules/clusterio/serialize.lua @@ -281,8 +281,11 @@ function serialize.deserialize_inventory(inventory, serialized) local repeat_count = entry.r or 0 for offset = 0, repeat_count do - -- XXX what if the inventory is smaller on this instance? local index = base_index + offset + if index > #inventory then + print("Error: Inventory index out of bounds deserializing inventory, voiding excess slots") + break + end local slot = inventory[index] if entry.f then local call_success, call_return = pcall(inventory.set_filter, index, entry.f) From ddf15f9b92ad8be48a9df3aa5e2792babe7c5906 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Wed, 8 Jun 2022 22:43:58 +0200 Subject: [PATCH 2/8] Add option to turn on authentication server bans Factorio 1.1.40 added a feature to use a centralized banlist maintained by Wube. For the dedicated server this needs to be turned on with the command line flag --use-authserver-bans. --- packages/lib/config/definitions.js | 6 ++++++ packages/lib/factorio/server.js | 6 ++++++ packages/slave/slave.js | 1 + 3 files changed, 13 insertions(+) diff --git a/packages/lib/config/definitions.js b/packages/lib/config/definitions.js index 608ce496..35e28eb8 100644 --- a/packages/lib/config/definitions.js +++ b/packages/lib/config/definitions.js @@ -277,6 +277,12 @@ FactorioGroup.define({ type: "boolean", initial_value: false, }); +FactorioGroup.define({ + name: "enable_authserver_bans", + description: "Turn on Factorio.com based multiplayer bans.", + type: "boolean", + initial_value: false, +}); FactorioGroup.define({ name: "settings", description: "Settings overridden in server-settings.json", diff --git a/packages/lib/factorio/server.js b/packages/lib/factorio/server.js index cbe6bb39..a199f04e 100644 --- a/packages/lib/factorio/server.js +++ b/packages/lib/factorio/server.js @@ -429,6 +429,8 @@ class FactorioServer extends events.EventEmitter { * @param {number} options.rconPort - TCP port to use for RCON. * @param {string} options.rconPassword - Password use for RCON. * @param {boolean} options.enableWhitelist - Turn on whitelisting. + * @param {boolean} options.enableAuthserverBans - + * Enable Factorio.com based multiplayer bans. * @param {boolean} options.verboseLogging - Enable verbose logging. * @param {boolean} options.stripPaths - Strip paths in the console. * @param {number} options.maxConcurrentCommands - @@ -457,6 +459,8 @@ class FactorioServer extends events.EventEmitter { this.rconPassword = options.rconPassword; /** Enable player whitelist */ this.enableWhitelist = options.enableWhitelist; + /** Enable Factorio.com based multiplayer bans **/ + this.enableAuthserverBans = options.enableAuthserverBans; /** Enable verbose logging */ this.verboseLogging = options.verboseLogging; /** Maximum number of RCON commands transmitted in parallel on the RCON connection */ @@ -828,6 +832,7 @@ class FactorioServer extends events.EventEmitter { "--rcon-port", this.rconPort, "--rcon-password", this.rconPassword, ...(this.enableWhitelist ? ["--use-server-whitelist"] : []), + ...(this.enableAuthserverBans ? ["--use-authserver-bans"] : []), ...(this.verboseLogging ? ["--verbose"] : []), ], { @@ -872,6 +877,7 @@ class FactorioServer extends events.EventEmitter { "--rcon-port", this.rconPort, "--rcon-password", this.rconPassword, ...(this.enableWhitelist ? ["--use-server-whitelist"] : []), + ...(this.enableAuthserverBans ? ["--use-authserver-bans"] : []), ...(this.verboseLogging ? ["--verbose"] : []), ], { diff --git a/packages/slave/slave.js b/packages/slave/slave.js index db3d0281..586152ec 100755 --- a/packages/slave/slave.js +++ b/packages/slave/slave.js @@ -167,6 +167,7 @@ class Instance extends libLink.Link { rconPort: this.config.get("factorio.rcon_port"), rconPassword: this.config.get("factorio.rcon_password"), enableWhitelist: this.config.get("factorio.enable_whitelist"), + enableAuthserverBans: this.config.get("factorio.enable_authserver_bans"), verboseLogging: this.config.get("factorio.verbose_logging"), stripPaths: this.config.get("factorio.strip_paths"), maxConcurrentCommands: this.config.get("factorio.max_concurrent_commands"), From 3e836c1dd3f40c32b4cb814901a9c2a1734dc927 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Wed, 8 Jun 2022 23:26:33 +0200 Subject: [PATCH 3/8] Fix web interface breaking when disabling plugins Fix incorrect logic to set up plugins in the web interface causing an emptry plugin to be atempted to be loaded when a plugin was disabled. --- packages/web_ui/src/bootstrap.jsx | 41 ++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/packages/web_ui/src/bootstrap.jsx b/packages/web_ui/src/bootstrap.jsx index e64be130..e6f3bbb0 100644 --- a/packages/web_ui/src/bootstrap.jsx +++ b/packages/web_ui/src/bootstrap.jsx @@ -25,7 +25,7 @@ async function loadScript(url) { return result; } -async function loadPlugins() { +async function loadPluginInfos() { let response = await fetch(`${webRoot}api/plugins`); let pluginList; if (response.ok) { @@ -36,7 +36,7 @@ async function loadPlugins() { pluginList = []; } - let plugins = new Map(); + let pluginInfos = []; await __webpack_init_sharing__("default"); for (let meta of pluginList) { if (meta.web.error) { @@ -51,26 +51,43 @@ async function loadPlugins() { } await container.init(__webpack_share_scopes__.default); let pluginInfo = (await container.get("./info"))(); - let pluginPackage = (await container.get("./package.json"))(); + pluginInfo.container = container; + pluginInfo.package = (await container.get("./package.json"))(); + pluginInfo.enabled = meta.enabled; + pluginInfos.push(pluginInfo); + } catch (err) { + logger.error(`Failed to load plugin info for ${meta.name}`); + if (err.stack) { + logger.error(err.stack); + } + } + } + return pluginInfos; +} + +async function loadPlugins(pluginInfos) { + let plugins = new Map(); + for (let pluginInfo of pluginInfos) { + if (!pluginInfo.enabled) { + continue; + } + try { let WebPluginClass = libPlugin.BaseWebPlugin; - if (meta.enabled && pluginInfo.webEntrypoint) { - let webModule = (await container.get(pluginInfo.webEntrypoint))(); + if (pluginInfo.webEntrypoint) { + let webModule = (await pluginInfo.container.get(pluginInfo.webEntrypoint))(); if (!webModule.WebPlugin) { throw new Error("Plugin webEntrypoint does not export WebPlugin class"); } WebPluginClass = webModule.WebPlugin; } - let plugin = new WebPluginClass(container, pluginPackage, pluginInfo, logger); + let plugin = new WebPluginClass(pluginInfo.container, pluginInfo.package, pluginInfo, logger); await plugin.init(); plugins.set(pluginInfo.name, plugin); } catch (err) { - if (err.message) { - meta.web.error = err.message; - } - logger.error(`Failed to load plugin ${meta.name}`); + logger.error(`Failed to load plugin ${pluginInfo.name}`); if (err.stack) { logger.error(err.stack); } @@ -84,10 +101,10 @@ export default async function bootstrap() { level: "verbose", format: new WebConsoleFormat(), })); - let plugins = await loadPlugins(); - let pluginInfos = [...plugins.values()].map(p => p.info); + let pluginInfos = await loadPluginInfos(); libConfig.registerPluginConfigGroups(pluginInfos); libConfig.finalizeConfigs(); + let plugins = await loadPlugins(pluginInfos); let wsUrl = new URL(window.webRoot, document.location); wsUrl.protocol = wsUrl.protocol.replace("http", "ws"); From c5a0c0a87353d2e3272faf31268f9c238b781ed7 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Thu, 9 Jun 2022 00:52:27 +0200 Subject: [PATCH 4/8] Migrate to new syntax The use of children to is deprecated, convert existing code to use the new items={...} syntax. --- .../src/components/InstanceViewPage.jsx | 48 +++++++++++-------- packages/web_ui/src/components/SiteLayout.jsx | 39 +++++++++------ 2 files changed, 54 insertions(+), 33 deletions(-) diff --git a/packages/web_ui/src/components/InstanceViewPage.jsx b/packages/web_ui/src/components/InstanceViewPage.jsx index 3b3e26c0..e544bb60 100644 --- a/packages/web_ui/src/components/InstanceViewPage.jsx +++ b/packages/web_ui/src/components/InstanceViewPage.jsx @@ -92,7 +92,35 @@ export default function InstanceViewPage(props) { ; } + let instanceButtonMenuItems = []; + if (account.hasPermission("core.instance.export_data")) { + instanceButtonMenuItems.push({ + disabled: exportingData || instance.status !== "stopped", + key: "export", + label: "Export data", + }); + } + if (account.hasPermission("core.instance.kill")) { + instanceButtonMenuItems.push({ + disabled: ["unknown", "unassigned", "stopped"].includes(instance["status"]), + key: "kill", + label: "Kill process", + }); + } + if (account.hasPermission("core.instance.delete")) { + if (instanceButtonMenuItems.length) { + instanceButtonMenuItems.push({ type: "divider" }); + } + instanceButtonMenuItems.push({ + disabled: !["unknown", "unassigned", "stopped"].includes(instance["status"]), + danger: true, + key: "delete", + icon: , + label: "Delete", + }); + } let instanceButtonsMenu = { if (key === "export") { setExportingData(true); @@ -125,25 +153,7 @@ export default function InstanceViewPage(props) { }); } }} - > - {account.hasPermission("core.instance.export_data") && Export data} - {account.hasPermission("core.instance.kill") && Kill process} - {account.hasPermission("core.instance.delete") && <> - - } - >Delete - } - ; + />; let instanceButtons = { account.hasAnyPermission("core.instance.start", "core.instance.stop") diff --git a/packages/web_ui/src/components/SiteLayout.jsx b/packages/web_ui/src/components/SiteLayout.jsx index 5a547205..f6c192fa 100644 --- a/packages/web_ui/src/components/SiteLayout.jsx +++ b/packages/web_ui/src/components/SiteLayout.jsx @@ -26,11 +26,20 @@ export default function SiteLayout(props) { return null; } - let accountMenu = - { history.push(`/users/${account.name}/view`); }}>{account.name} - - { account.logOut(); }}>Log out - ; + let accountMenu = { + if (key === "user") { + history.push(`/users/${account.name}/view`); + } else if (key === "logout") { + account.logout(); + } + }} + items={[ + { label: account.name, key: "user" }, + { type: "divider" }, + { label: "Log out", danger: true, key: "logout" }, + ]} + />; let combinedPages = [...pages]; for (let plugin of plugins.values()) { @@ -49,13 +58,13 @@ export default function SiteLayout(props) { group = []; menuGroups.set(sidebarGroup, group); } - group.push({sidebarName}); + group.push({ label: sidebarName, key: path }); } else { - menuItems.push({sidebarName}); + menuItems.push({ label: sidebarName, key: path }); } } for (let [name, group] of menuGroups) { - menuItems.push({group}); + menuItems.push({ type: "group", label: name, children: group, key: name }); } return @@ -63,9 +72,12 @@ export default function SiteLayout(props) {
Clusterio { webUiPackage.version } - - Dashboard - + history.push(key)} - > - {menuItems} - + items={menuItems} + /> From 654465e4eb89bea29bae033bb06360ea4b1b3166 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Thu, 9 Jun 2022 00:53:12 +0200 Subject: [PATCH 5/8] Fix LogConsole using duplicated keys Fix past lines loaded from the log containing keys that clash with new items logged. --- packages/web_ui/src/components/LogConsole.jsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/web_ui/src/components/LogConsole.jsx b/packages/web_ui/src/components/LogConsole.jsx index 60b90bea..fdb9f93a 100644 --- a/packages/web_ui/src/components/LogConsole.jsx +++ b/packages/web_ui/src/components/LogConsole.jsx @@ -76,7 +76,7 @@ export default function LogConsole(props) { limit: 400, order: "desc", }).then(result => { - setPastLines(result.log.map((info, index) => formatLog(info, index)).reverse()); + setPastLines(result.log.map((info, index) => formatLog(info, -index - 1)).reverse()); }).catch(err => { setPastLines([{`Error loading log: ${err.message}`}
]); }); From 7e9604a2542123da820b852260ad2c7ea548fc60 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Sun, 19 Jun 2022 16:38:02 +0200 Subject: [PATCH 6/8] Fix LogConsole scroll anchor trasmutation Fix react mutating the scroll anchor element in LogConsole into a log line and breaking scroll anchoring to the bottom as a result. --- packages/web_ui/src/components/LogConsole.jsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/web_ui/src/components/LogConsole.jsx b/packages/web_ui/src/components/LogConsole.jsx index fdb9f93a..1da47591 100644 --- a/packages/web_ui/src/components/LogConsole.jsx +++ b/packages/web_ui/src/components/LogConsole.jsx @@ -100,7 +100,7 @@ export default function LogConsole(props) { {pastLines} {lines} -
+
; } From 430a64722e5947270806812de1e71ff6bfa67bc6 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Sun, 19 Jun 2022 17:03:08 +0200 Subject: [PATCH 7/8] Use empty slots as end for logistics requests Count up to 100 empty slots past the last seen slot with data in it before stopping to look for personal logistics slots in inventory_sync. Allows unlimeted amount of logistics request slots to be used for heavily modded games. --- plugins/inventory_sync/module/serialize.lua | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/plugins/inventory_sync/module/serialize.lua b/plugins/inventory_sync/module/serialize.lua index 820d4559..e0e264a8 100644 --- a/plugins/inventory_sync/module/serialize.lua +++ b/plugins/inventory_sync/module/serialize.lua @@ -75,9 +75,11 @@ function serialize.serialize_personal_logistic_slots(player) local serialized = nil -- Serialize personal logistic slots - for i = 1, 200 do -- Nobody will have more than 200 logistic slots, right? + local last_valid = 0 + for i = 1, 65536 do local slot = player.get_personal_logistic_slot(i) - if slot.name ~= nil then + if slot.name then + last_valid = i if not serialized then serialized = {} end @@ -86,6 +88,10 @@ function serialize.serialize_personal_logistic_slots(player) min = slot.min, max = slot.max, } + + -- Stop after 100 empty slots + elseif last_valid + 100 <= i then + break end end @@ -98,10 +104,9 @@ function serialize.deserialize_personal_logistic_slots(player, serialized) end -- Load personal logistic slots - for i = 1, 200 do - local slot = serialized[tostring(i)] -- 1 is empty to force array to be spare + for i, slot in pairs(serialized) do if slot ~= nil then - player.set_personal_logistic_slot(i, slot) + player.set_personal_logistic_slot(tonumber(i), slot) end end end From 105f99ced38ae83ba82025b54970dfdac1ed2c80 Mon Sep 17 00:00:00 2001 From: Hornwitser Date: Sun, 19 Jun 2022 19:51:22 +0200 Subject: [PATCH 8/8] Preserve entered vehicle on inventory sync Save vehicle the player is driving before downloading the inventory and restore the player position to this vehicle if possible. --- .../module/download_inventory.lua | 38 +++++++++++++++---- .../inventory_sync/module/inventory_sync.lua | 11 ++++-- 2 files changed, 37 insertions(+), 12 deletions(-) diff --git a/plugins/inventory_sync/module/download_inventory.lua b/plugins/inventory_sync/module/download_inventory.lua index 4f4b3897..30b0edf4 100644 --- a/plugins/inventory_sync/module/download_inventory.lua +++ b/plugins/inventory_sync/module/download_inventory.lua @@ -3,6 +3,32 @@ local ensure_character = require("modules/inventory_sync/ensure_character") local serialize = require("modules/inventory_sync/serialize") local load_crafting_queue = require("modules/inventory_sync/load_crafting_queue") + +local can_enter_vehicle = { + [defines.controllers.character] = true, + [defines.controllers.god] = true, + [defines.controllers.editor] = true, +} + +local function restore_position(record, player) + if record.vehicle and record.vehicle.valid and can_enter_vehicle[player.controller_type] then + player.teleport(record.vehicle.position, record.vehicle.surface) + player.driving = true + + -- Teleport to safe location if unable to enter vehicle + if not player.driving and player.controller_type == defines.controllers.character then + local safe_position = record.vehicle.surface.find_non_colliding_position( + player.character.name, player.position, 32, 1/8 + ) + if safe_position then + player.teleport(safe_position, player.surface) + end + end + elseif record.surface and record.position then + player.teleport(record.position, record.surface) + end +end + local function download_inventory(player_name, data, number, total) local player = game.get_player(player_name) if player == nil then @@ -33,10 +59,8 @@ local function download_inventory(player_name, data, number, total) -- Give the player a character and pretend that's the synced player data ensure_character(player) - -- Restore player position in case they moved while being spectator - if record.surface and record.position then - player.teleport(record.position, record.surface) - end + -- Restore player position and driving state + restore_position(record, player) global.inventory_sync.active_downloads[player_name] = nil player_record.dirty = player.connected @@ -87,10 +111,8 @@ local function download_inventory(player_name, data, number, total) local serialized_player = game.json_to_table(record.data) serialize.deserialize_player(player, serialized_player) - -- Restore player position in case they moved while being spectator - if record.surface and record.position then - player.teleport(record.position, record.surface) - end + -- Restore player position and driving state + restore_position(record, player) -- Load crafting queue if player.character then diff --git a/plugins/inventory_sync/module/inventory_sync.lua b/plugins/inventory_sync/module/inventory_sync.lua index ef7af9c1..5adca874 100644 --- a/plugins/inventory_sync/module/inventory_sync.lua +++ b/plugins/inventory_sync/module/inventory_sync.lua @@ -310,13 +310,16 @@ function inventory_sync.initiate_inventory_download(player, player_record, gener -- If this is a synced player turn them into a spectator while the -- player data is downloading if player_record.sync then - local character = player.character - player.set_controller({ type = defines.controllers.spectator }) - if character ~= nil then character.destroy() end - -- Store original position to teleport back to record.surface = player.surface record.position = player.position + if player.driving then + record.vehicle = player.vehicle + end + + local character = player.character + player.set_controller({ type = defines.controllers.spectator }) + if character ~= nil then character.destroy() end -- Indicate this state shouldn't be persisted player_record.dirty = false