diff --git a/packages/controller/src/ControlConnection.ts b/packages/controller/src/ControlConnection.ts index a2b81ac5..410e1fd9 100644 --- a/packages/controller/src/ControlConnection.ts +++ b/packages/controller/src/ControlConnection.ts @@ -70,6 +70,7 @@ export default class ControlConnection extends BaseConnection { this.handle(lib.ControllerStopRequest, this.handleControllerStopRequest.bind(this)); this.handle(lib.ControllerRestartRequest, this.handleControllerRestartRequest.bind(this)); + this.handle(lib.ControllerUpdateRequest, this.handleControllerUpdateRequest.bind(this)); this.handle(lib.ControllerConfigGetRequest, this.handleControllerConfigGetRequest.bind(this)); this.handle(lib.ControllerConfigSetFieldRequest, this.handleControllerConfigSetFieldRequest.bind(this)); this.handle(lib.ControllerConfigSetPropRequest, this.handleControllerConfigSetPropRequest.bind(this)); @@ -119,7 +120,7 @@ export default class ControlConnection extends BaseConnection { this.handle(lib.UserDeleteRequest, this.handleUserDeleteRequest.bind(this)); this.handle(lib.UserBulkImportRequest, this.handleUserBulkImportRequest.bind(this)); this.handle(lib.UserBulkExportRequest, this.handleUserBulkExportRequest.bind(this)); - this.handle(lib.RemoteUpdateRequest, this.handleRemoteUpdateRequest.bind(this)); + this.handle(lib.PluginListRequest, this.handlePluginListRequest.bind(this)); this.handle(lib.PluginUpdateRequest, this.handlePluginUpdateRequest.bind(this)); this.handle(lib.PluginInstallRequest, this.handlePluginInstallRequest.bind(this)); this.handle(lib.DebugDumpWsRequest, this.handleDebugDumpWsRequest.bind(this)); @@ -1052,7 +1053,7 @@ export default class ControlConnection extends BaseConnection { return usersToSend; } - async handleRemoteUpdateRequest(request: lib.RemoteUpdateRequest) { + async handleControllerUpdateRequest(request: lib.ControllerUpdateRequest) { if (!this._controller.config.get("controller.allow_remote_updates")) { throw new lib.RequestError("Remote updates are disabled on this machine"); } @@ -1063,21 +1064,18 @@ export default class ControlConnection extends BaseConnection { if (!this._controller.config.get("controller.allow_plugin_updates")) { throw new lib.RequestError("Plugin updates are disabled on this machine"); } - if (!this._controller.pluginInfos.some(plugin => plugin.npmPackage === request.pluginPackage)) { - throw new lib.RequestError(`Plugin ${request.pluginPackage} is not installed on this machine`); - } - return lib.updatePackage(request.pluginPackage); + return await lib.handlePluginUpdate(request.pluginPackage, this._controller.pluginInfos); } async handlePluginInstallRequest(request: lib.PluginInstallRequest) { if (!this._controller.config.get("controller.allow_plugin_install")) { throw new lib.RequestError("Plugin installs are disabled on this machine"); } - const npmRequest = await fetch(`https://www.npmjs.com/package/${encodeURI(request.pluginPackage)}`); - if (!npmRequest.ok) { - throw new lib.RequestError(`Unknown plugin: ${request.pluginPackage}`); - } - return lib.installPackage(request.pluginPackage); + return await lib.handlePluginInstall(request.pluginPackage); + } + + async handlePluginListRequest(request: lib.PluginListRequest) { + return this._controller.pluginInfos.map(pluginInfo => lib.PluginDetails.fromNodeEnvInfo(pluginInfo)); } async handleDebugDumpWsRequest(request: lib.DebugDumpWsRequest) { diff --git a/packages/ctl/src/commands.ts b/packages/ctl/src/commands.ts index 836bb2a8..23d60619 100644 --- a/packages/ctl/src/commands.ts +++ b/packages/ctl/src/commands.ts @@ -100,7 +100,7 @@ controllerCommands.add(new lib.Command({ yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); }], handler: async function(args: { restart: boolean }, control: Control) { - await control.sendTo("controller", new lib.RemoteUpdateRequest()); + await control.send(new lib.ControllerUpdateRequest()); if (args.restart) { await control.send(new lib.ControllerRestartRequest()); } else { @@ -108,34 +108,6 @@ controllerCommands.add(new lib.Command({ } }, })); -controllerCommands.add(new lib.Command({ - definition: ["update-plugin", "Update a plugin on the controller", (yargs) => { - yargs.positional("plugin", { describe: "Plugin to update", type: "string" }); - yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); - }], - handler: async function(args: { plugin: string, restart: boolean }, control: Control) { - await control.sendTo("controller", new lib.PluginUpdateRequest(args.plugin)); - if (args.restart) { - await control.send(new lib.ControllerRestartRequest()); - } else { - print("Plugin updated; a restart is required to apply the changes."); - } - }, -})); -controllerCommands.add(new lib.Command({ - definition: ["install-plugin", "Install a plugin on the controller", (yargs) => { - yargs.positional("plugin", { describe: "Plugin to install", type: "string" }); - yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); - }], - handler: async function(args: { plugin: string, restart: boolean }, control: Control) { - await control.sendTo("controller", new lib.PluginInstallRequest(args.plugin)); - if (args.restart) { - await control.send(new lib.ControllerRestartRequest()); - } else { - print("Plugin installed; a restart is required to apply the changes."); - } - }, -})); const controllerConfigCommands = new lib.CommandTree({ name: "config", alias: ["c"], description: "controller config management", @@ -275,6 +247,35 @@ controllerPluginCommands.add(new lib.Command({ print(asTable(response.body)); }, })); +controllerPluginCommands.add(new lib.Command({ + definition: ["update ", "Update a plugin on the controller", (yargs) => { + yargs.positional("plugin", { describe: "Plugin to update", type: "string" }); + yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); + }], + handler: async function(args: { plugin: string, restart: boolean }, control: Control) { + await control.sendTo("controller", new lib.PluginUpdateRequest(args.plugin)); + if (args.restart) { + await control.send(new lib.ControllerRestartRequest()); + } else { + print("Plugin updated; a restart is required to apply the changes."); + } + }, +})); +controllerPluginCommands.add(new lib.Command({ + definition: ["install ", "Install a plugin on the controller", (yargs) => { + yargs.positional("plugin", { describe: "Plugin to install", type: "string" }); + yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); + }], + handler: async function(args: { plugin: string, restart: boolean }, control: Control) { + await control.sendTo("controller", new lib.PluginInstallRequest(args.plugin)); + if (args.restart) { + await control.send(new lib.ControllerRestartRequest()); + } else { + print("Plugin installed; a restart is required to apply the changes."); + } + }, +})); + controllerCommands.add(controllerPluginCommands); @@ -370,7 +371,7 @@ hostCommands.add(new lib.Command({ }], handler: async function(args: { host: string, restart: boolean }, control: Control) { let hostId = await lib.resolveHost(control, args.host); - await control.sendTo({ hostId }, new lib.RemoteUpdateRequest()); + await control.sendTo({ hostId }, new lib.HostUpdateRequest()); if (args.restart) { await control.sendTo({ hostId }, new lib.HostRestartRequest()); } else { @@ -378,38 +379,7 @@ hostCommands.add(new lib.Command({ } }, })); -hostCommands.add(new lib.Command({ - definition: ["update-plugin", "Update a plugin on a host", (yargs) => { - yargs.positional("host", { describe: "Host to update on", type: "string" }); - yargs.positional("plugin", { describe: "Plugin to update", type: "string" }); - yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); - }], - handler: async function(args: { host: string, plugin: string, restart: boolean }, control: Control) { - let hostId = await lib.resolveHost(control, args.host); - await control.sendTo({ hostId }, new lib.PluginUpdateRequest(args.plugin)); - if (args.restart) { - await control.sendTo({ hostId }, new lib.HostRestartRequest()); - } else { - print("Plugin updated; a restart is required to apply the changes."); - } - }, -})); -hostCommands.add(new lib.Command({ - definition: ["install-plugin", "Install a plugin on a host", (yargs) => { - yargs.positional("host", { describe: "Host to install on", type: "string" }); - yargs.positional("plugin", { describe: "Plugin to install", type: "string" }); - yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); - }], - handler: async function(args: { host: string, plugin: string, restart: boolean }, control: Control) { - let hostId = await lib.resolveHost(control, args.host); - await control.sendTo({ hostId }, new lib.PluginInstallRequest(args.plugin)); - if (args.restart) { - await control.sendTo({ hostId }, new lib.HostRestartRequest()); - } else { - print("Plugin installed; a restart is required to apply the changes."); - } - }, -})); + const hostConfigCommands = new lib.CommandTree({ name: "config", alias: ["c"], description: "Host config management", @@ -552,9 +522,60 @@ hostConfigCommands.add(new lib.Command({ } }, })); + hostCommands.add(hostConfigCommands); +const hostPluginCommands = new lib.CommandTree({ + name: "plugin", alias: ["p"], description: "host plugin inspection", +}); +hostPluginCommands.add(new lib.Command({ + definition: ["list ", "List plugins on a host", (yargs) => { + yargs.positional("host", { describe: "Host to list for", type: "string" }); + }], + handler: async function(args: { host: string }, control: Control) { + let hostId = await lib.resolveHost(control, args.host); + const plugins = await control.sendTo({ hostId }, new lib.PluginListRequest()); + print(asTable(plugins.map(p => ({ + title: p.title, version: p.version, npmPackage: p.npmPackage, + })))); + }, +})); +hostPluginCommands.add(new lib.Command({ + definition: ["update ", "Update a plugin on a host", (yargs) => { + yargs.positional("host", { describe: "Host to update on", type: "string" }); + yargs.positional("plugin", { describe: "Plugin to update", type: "string" }); + yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); + }], + handler: async function(args: { host: string, plugin: string, restart: boolean }, control: Control) { + let hostId = await lib.resolveHost(control, args.host); + await control.sendTo({ hostId }, new lib.PluginUpdateRequest(args.plugin)); + if (args.restart) { + await control.sendTo({ hostId }, new lib.HostRestartRequest()); + } else { + print("Plugin updated; a restart is required to apply the changes."); + } + }, +})); +hostPluginCommands.add(new lib.Command({ + definition: ["install ", "Install a plugin on a host", (yargs) => { + yargs.positional("host", { describe: "Host to install on", type: "string" }); + yargs.positional("plugin", { describe: "Plugin to install", type: "string" }); + yargs.option("restart", { alias: "r", type: "boolean", description: "Restart after update" }); + }], + handler: async function(args: { host: string, plugin: string, restart: boolean }, control: Control) { + let hostId = await lib.resolveHost(control, args.host); + await control.sendTo({ hostId }, new lib.PluginInstallRequest(args.plugin)); + if (args.restart) { + await control.sendTo({ hostId }, new lib.HostRestartRequest()); + } else { + print("Plugin installed; a restart is required to apply the changes."); + } + }, +})); +hostCommands.add(hostPluginCommands); + + const instanceCommands = new lib.CommandTree({ name: "instance", alias: ["i"], description: "Instance management", }); diff --git a/packages/host/src/Host.ts b/packages/host/src/Host.ts index e2450007..4cf0df72 100644 --- a/packages/host/src/Host.ts +++ b/packages/host/src/Host.ts @@ -371,17 +371,23 @@ export default class Host extends lib.Link { this.handle(lib.HostStopRequest, this.handleHostStopRequest.bind(this)); this.handle(lib.HostRestartRequest, this.handleHostRestartRequest.bind(this)); + this.handle(lib.HostUpdateRequest, this.handleHostUpdateRequest.bind(this)); this.handle(lib.HostConfigGetRequest, this.handleHostConfigGetRequest.bind(this)); this.handle(lib.HostConfigSetFieldRequest, this.handleHostConfigSetFieldRequest.bind(this)); this.handle(lib.HostConfigSetPropRequest, this.handleHostConfigSetPropRequest.bind(this)); + this.handle(lib.HostMetricsRequest, this.handleHostMetricsRequest.bind(this)); this.handle(lib.SyncUserListsEvent, this.handleSyncUserListsEvent.bind(this)); + this.handle(lib.SystemInfoRequest, this.handleSystemInfoRequest.bind(this)); + this.handle(lib.PluginListRequest, this.handlePluginListRequest.bind(this)); + this.handle(lib.PluginUpdateRequest, this.handlePluginUpdateRequest.bind(this)); + this.handle(lib.PluginInstallRequest, this.handlePluginInstallRequest.bind(this)); + this.snoopEvent(lib.InstanceAdminlistUpdateEvent, this.handleAdminlistUpdateEvent.bind(this)); this.snoopEvent(lib.InstanceBanlistUpdateEvent, this.handleBanlistUpdateEvent.bind(this)); this.snoopEvent(lib.InstanceWhitelistUpdateEvent, this.handleWhitelistUpdateEvent.bind(this)); + this.handle(lib.InstanceAssignInternalRequest, this.handleInstanceAssignInternalRequest.bind(this)); this.handle(lib.InstanceUnassignInternalRequest, this.handleInstanceUnassignInternalRequest.bind(this)); - this.handle(lib.SystemInfoRequest, this.handleSystemInfoRequest.bind(this)); - this.handle(lib.HostMetricsRequest, this.handleHostMetricsRequest.bind(this)); this.fallbackRequest( lib.InstanceSaveDetailsListRequest, this.fallbackInstanceSaveDetailsListRequest.bind(this), ); @@ -392,9 +398,6 @@ export default class Host extends lib.Link { this.handle(lib.InstancePullSaveRequest, this.handleInstancePullSaveRequest.bind(this)); this.handle(lib.InstancePushSaveRequest, this.handleInstancePushSaveRequest.bind(this)); this.handle(lib.InstanceDeleteInternalRequest, this.handleInstanceDeleteInternalRequest.bind(this)); - this.handle(lib.RemoteUpdateRequest, this.handleRemoteUpdateRequest.bind(this)); - this.handle(lib.PluginUpdateRequest, this.handlePluginUpdateRequest.bind(this)); - this.handle(lib.PluginInstallRequest, this.handlePluginInstallRequest.bind(this)); } async loadPlugins() { @@ -1046,7 +1049,7 @@ export default class Host extends lib.Link { await fs.remove(instanceInfo.path); } - async handleRemoteUpdateRequest(request: lib.RemoteUpdateRequest) { + async handleHostUpdateRequest(request: lib.HostUpdateRequest) { if (!this.config.get("host.allow_remote_updates")) { throw new lib.RequestError("Remote updates are disabled on this machine"); } @@ -1057,21 +1060,18 @@ export default class Host extends lib.Link { if (!this.config.get("host.allow_plugin_updates")) { throw new lib.RequestError("Plugin updates are disabled on this machine"); } - if (!this.pluginInfos.some(plugin => plugin.npmPackage === request.pluginPackage)) { - throw new lib.RequestError(`Plugin ${request.pluginPackage} is not installed on this machine`); - } - return lib.updatePackage(request.pluginPackage); + return await lib.handlePluginUpdate(request.pluginPackage, this.pluginInfos); } async handlePluginInstallRequest(request: lib.PluginInstallRequest) { if (!this.config.get("host.allow_plugin_install")) { throw new lib.RequestError("Plugin installs are disabled on this machine"); } - const npmRequest = await fetch(`https://www.npmjs.com/package/${encodeURI(request.pluginPackage)}`); - if (!npmRequest.ok) { - throw new lib.RequestError(`Unknown plugin: ${request.pluginPackage}`); - } - return lib.installPackage(request.pluginPackage); + return await lib.handlePluginInstall(request.pluginPackage); + } + + async handlePluginListRequest(request: lib.PluginListRequest) { + return this.pluginInfos.map(pluginInfo => lib.PluginDetails.fromNodeEnvInfo(pluginInfo)); } sendHostUpdate() { diff --git a/packages/lib/src/data/index.ts b/packages/lib/src/data/index.ts index 931f75fc..d3f781cf 100644 --- a/packages/lib/src/data/index.ts +++ b/packages/lib/src/data/index.ts @@ -21,4 +21,5 @@ export * from "./messages_host"; export * from "./messages_instance"; export * from "./messages_mod"; export * from "./messages_user"; +export * from "./messages_plugin"; export * from "./version"; diff --git a/packages/lib/src/data/messages_controller.ts b/packages/lib/src/data/messages_controller.ts index 7d7f40d2..9be91bc6 100644 --- a/packages/lib/src/data/messages_controller.ts +++ b/packages/lib/src/data/messages_controller.ts @@ -19,6 +19,14 @@ export class ControllerRestartRequest { static permission = "core.controller.restart" as const; } +export class ControllerUpdateRequest { + declare ["constructor"]: typeof ControllerUpdateRequest; + static type = "request" as const; + static src = "control" as const; + static dst = "controller" as const; + static permission = "core.controller.update" as const; +} + export class ControllerConfigGetRequest { declare ["constructor"]: typeof ControllerConfigGetRequest; static type = "request" as const; @@ -352,58 +360,6 @@ export class SystemInfoUpdateEvent { } } -export class RemoteUpdateRequest { - declare ["constructor"]: typeof RemoteUpdateRequest; - static type = "request" as const; - static src = "control" as const; - static dst = ["controller", "host"] as const; - static permission = "core.rce.remote_update"; -} - -export class PluginUpdateRequest { - declare ["constructor"]: typeof PluginUpdateRequest; - static type = "request" as const; - static src = "control" as const; - static dst = ["controller", "host"] as const; - static permission = "core.rce.plugin_update"; - - constructor( - public pluginPackage: string, - ) {} - - static jsonSchema = Type.String(); - - static fromJSON(json: Static) { - return new this(json); - } - - toJSON() { - return this.pluginPackage; - } -} - -export class PluginInstallRequest { - declare ["constructor"]: typeof PluginInstallRequest; - static type = "request" as const; - static src = "control" as const; - static dst = ["controller", "host"] as const; - static permission = "core.rce.plugin_install"; - - constructor( - public pluginPackage: string, - ) {} - - static jsonSchema = Type.String(); - - static fromJSON(json: Static) { - return new this(json); - } - - toJSON() { - return this.pluginPackage; - } -} - export class DebugDumpWsRequest { declare ["constructor"]: typeof DebugDumpWsRequest; static type = "request" as const; diff --git a/packages/lib/src/data/messages_host.ts b/packages/lib/src/data/messages_host.ts index 5061724d..66399f19 100644 --- a/packages/lib/src/data/messages_host.ts +++ b/packages/lib/src/data/messages_host.ts @@ -19,6 +19,14 @@ export class HostRestartRequest { static permission = "core.host.restart" as const; } +export class HostUpdateRequest { + declare ["constructor"]: typeof HostUpdateRequest; + static type = "request" as const; + static src = ["control", "controller"] as const; + static dst = "host" as const; + static permission = "core.host.update" as const; +} + export class HostConfigGetRequest { declare ["constructor"]: typeof HostConfigGetRequest; static type = "request" as const; diff --git a/packages/lib/src/data/messages_plugin.ts b/packages/lib/src/data/messages_plugin.ts new file mode 100644 index 00000000..09bf687e --- /dev/null +++ b/packages/lib/src/data/messages_plugin.ts @@ -0,0 +1,87 @@ +import { Type, Static } from "@sinclair/typebox"; +import { jsonArray } from "./composites"; +import { PluginNodeEnvInfo } from "../plugin"; + +/* This is similar to other plugin definitions but with lots removed */ +export class PluginDetails { + constructor( + public name: string, + public title: string, + public version: string, + public description?: string, + public npmPackage?: string, + ) {} + + static jsonSchema = Type.Object({ + name: Type.String(), + title: Type.String(), + version: Type.String(), + description: Type.Optional(Type.String()), + npmPackage: Type.Optional(Type.String()), + }); + + static fromJSON(json: Static) { + return new this(json.name, json.title, json.version, json.description, json.npmPackage); + } + + static fromNodeEnvInfo(pluginInfo: PluginNodeEnvInfo) { + return new this( + pluginInfo.name, pluginInfo.title, + pluginInfo.version, pluginInfo.description, + pluginInfo.npmPackage, + ); + } +} + +export class PluginListRequest { + declare ["constructor"]: typeof PluginListRequest; + static type = "request" as const; + static src = "control" as const; + static dst = ["controller", "host"] as const; + static permission = "core.plugin.list"; + static Response = jsonArray(PluginDetails); +} + +export class PluginUpdateRequest { + declare ["constructor"]: typeof PluginUpdateRequest; + static type = "request" as const; + static src = "control" as const; + static dst = ["controller", "host"] as const; + static permission = "core.plugin.update"; + + constructor( + public pluginPackage: string, + ) {} + + static jsonSchema = Type.String(); + + static fromJSON(json: Static) { + return new this(json); + } + + toJSON() { + return this.pluginPackage; + } +} + +export class PluginInstallRequest { + declare ["constructor"]: typeof PluginInstallRequest; + static type = "request" as const; + static src = "control" as const; + static dst = ["controller", "host"] as const; + static permission = "core.plugin.install"; + + constructor( + public pluginPackage: string, + ) {} + + static jsonSchema = Type.String(); + + static fromJSON(json: Static) { + return new this(json); + } + + toJSON() { + return this.pluginPackage; + } +} diff --git a/packages/lib/src/link/messages.ts b/packages/lib/src/link/messages.ts index 4e800b47..5d4977c1 100644 --- a/packages/lib/src/link/messages.ts +++ b/packages/lib/src/link/messages.ts @@ -4,6 +4,7 @@ import * as host from "../data/messages_host"; import * as instance from "../data/messages_instance"; import * as mod from "../data/messages_mod"; import * as user from "../data/messages_user"; +import * as plugin from "../data/messages_plugin"; import * as subscriptions from "../subscriptions"; import type { RequestClass, EventClass } from "./link"; @@ -19,6 +20,7 @@ export const dataClasses: (RequestClass | EventClass) controller.ControllerStopRequest, controller.ControllerRestartRequest, + controller.ControllerUpdateRequest, controller.ControllerConfigGetRequest, controller.ControllerConfigSetFieldRequest, controller.ControllerConfigSetPropRequest, @@ -30,9 +32,6 @@ export const dataClasses: (RequestClass | EventClass) controller.LogMessageEvent, controller.SystemInfoRequest, controller.SystemInfoUpdateEvent, - controller.RemoteUpdateRequest, - controller.PluginUpdateRequest, - controller.PluginInstallRequest, controller.DebugDumpWsRequest, controller.DebugWsMessageEvent, @@ -40,6 +39,7 @@ export const dataClasses: (RequestClass | EventClass) host.HostStopRequest, host.HostRestartRequest, + host.HostUpdateRequest, host.HostConfigGetRequest, host.HostConfigSetFieldRequest, host.HostConfigSetPropRequest, @@ -125,4 +125,8 @@ export const dataClasses: (RequestClass | EventClass) user.UserUpdatesEvent, user.UserBulkImportRequest, user.UserBulkExportRequest, + + plugin.PluginListRequest, + plugin.PluginUpdateRequest, + plugin.PluginInstallRequest, ]; diff --git a/packages/lib/src/permissions.ts b/packages/lib/src/permissions.ts index 27ff3263..478f9039 100644 --- a/packages/lib/src/permissions.ts +++ b/packages/lib/src/permissions.ts @@ -131,6 +131,11 @@ definePermission({ title: "Restart controller", description: "Restart the Node.js controller process if the system is set up for restarting.", }); +definePermission({ + name: "core.controller.update", + title: "Update controller", + description: "Remotely update the controller if the controller allows for remote updates.", +}); definePermission({ name: "core.controller.get_config", title: "Get controller config", @@ -160,6 +165,11 @@ definePermission({ title: "Restart Hosts", description: "Restart Node.js host processes if the system they run on are set up for restarting.", }); +definePermission({ + name: "core.host.update", + title: "Update Hosts", + description: "Remotely update a host if the host allows for remote updates.", +}); definePermission({ name: "core.host.get_config", title: "Get host configs", @@ -526,19 +536,19 @@ definePermission({ }); definePermission({ - name: "core.rce.remote_update", - title: "Clusterio remote update", - description: "Start a remote update of the clusterio packages", + name: "core.plugin.list", + title: "Lust plugins", + description: "List all installed plugins on a machine.", }); definePermission({ - name: "core.rce.plugin_update", - title: "Plugin remote update", - description: "Start a remote update of a third party plugin package", + name: "core.plugin.update", + title: "Update plugin", + description: "Remotely update a plugin if the target allows remote updates of plugins.", }); definePermission({ - name: "core.rce.plugin_install", - title: "Plugin remote install", - description: "Start a remote install of a third party plugin package", + name: "core.plugin.install", + title: "Install plugin", + description: "Remotely install a plugin if the target allows remote installs of plugins.", }); definePermission({ diff --git a/packages/lib/src/rce_ops.ts b/packages/lib/src/rce_ops.ts index 87ad5baa..220a7b42 100644 --- a/packages/lib/src/rce_ops.ts +++ b/packages/lib/src/rce_ops.ts @@ -2,6 +2,8 @@ import util from "util"; import path from "path"; import { exec } from "child_process"; import { logger } from "./logging"; +import { RequestError } from "./errors"; +import { PluginNodeEnvInfo } from "./plugin"; const execAsync = util.promisify(exec); async function isDev() { @@ -24,3 +26,29 @@ export async function updatePackage(name: string) { export async function installPackage(name: string) { return logExec(`npm install --save ${name}`); } + +export async function handlePluginUpdate(pluginName: string, pluginInfos: PluginNodeEnvInfo[]) { + if (!pluginInfos.some(plugin => plugin.npmPackage === pluginName)) { + throw new RequestError(`Plugin ${pluginName} is not installed on this machine`); + } + + return await updatePackage(pluginName); +} + +export async function handlePluginInstall(pluginName: string) { + if (pluginName.length > 214 || /[^a-zA-z0-9\-_.+@\/]/.test(pluginName)) { + // https://docs.npmjs.com/cli/v11/configuring-npm/package-json#name + // https://www.npmjs.com/package/validate-npm-package-name + throw new RequestError(`Invalid plugin name: ${pluginName}`); + } + + const packageName = encodeURI(pluginName); + const npmRequest = await fetch(`https://registry.npmjs.com/${packageName}`, { + method: "HEAD", + }); + if (!npmRequest.ok) { + throw new RequestError(`Unknown plugin: ${packageName}`); + } + + return await installPackage(packageName); +} diff --git a/packages/web_ui/src/components/ControllerPage.tsx b/packages/web_ui/src/components/ControllerPage.tsx index 6d59e1bc..3133ed6f 100644 --- a/packages/web_ui/src/components/ControllerPage.tsx +++ b/packages/web_ui/src/components/ControllerPage.tsx @@ -67,7 +67,7 @@ export default function ControllerPage() { } { - hasNpmButtonPermission() + hasNpmButtonPermission(true) && } } diff --git a/packages/web_ui/src/components/HostViewPage.tsx b/packages/web_ui/src/components/HostViewPage.tsx index 9b1a247d..794e8e23 100644 --- a/packages/web_ui/src/components/HostViewPage.tsx +++ b/packages/web_ui/src/components/HostViewPage.tsx @@ -103,7 +103,7 @@ export default function HostViewPage() { } { - hasNpmButtonPermission() + hasNpmButtonPermission(false) && } ; diff --git a/packages/web_ui/src/components/NpmButton.tsx b/packages/web_ui/src/components/NpmButton.tsx index 26d4b361..42d5be00 100644 --- a/packages/web_ui/src/components/NpmButton.tsx +++ b/packages/web_ui/src/components/NpmButton.tsx @@ -1,4 +1,4 @@ -import { useContext, useState } from "react"; +import { useContext, useEffect, useState } from "react"; import { Button, Checkbox, Form, FormInstance, Input, Modal, Radio, Select } from "antd"; import * as lib from "@clusterio/lib"; @@ -17,7 +17,10 @@ function NpmRemoteUpdate({ setApplyAction, form, target }: NpmActionProps) { const control = useContext(ControlContext); setApplyAction(async () => { - await control.sendTo(target, new lib.RemoteUpdateRequest()); + if (target === "controller") { + return await control.send(new lib.ControllerUpdateRequest()); + } + return await control.sendTo(target, new lib.HostUpdateRequest()); }); return <> @@ -26,6 +29,7 @@ function NpmRemoteUpdate({ setApplyAction, form, target }: NpmActionProps) { function NpmPluginUpdate({ setApplyAction, form, target }: NpmActionProps) { const control = useContext(ControlContext); + const [plugins, setPlugins] = useState([]); setApplyAction(async () => { const values = form.getFieldsValue(); @@ -35,27 +39,28 @@ function NpmPluginUpdate({ setApplyAction, form, target }: NpmActionProps) { await control.sendTo(target, new lib.PluginUpdateRequest(values.plugin)); }); - return <> - - - - ; + useEffect(() => { + control.sendTo(target, new lib.PluginListRequest()).then(newPlugins => { + setPlugins(newPlugins); + }).catch(notifyErrorHandler("Error fetching role list")); + }, [target]); - // eslint-disable-next-line multiline-comment-style - /* TODO Allow control access to plugins on hosts return <>