mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-17 23:33:12 +09:00
# Conflicts: # packages/lib/src/data/messages_plugin.ts # packages/web_ui/src/components/PluginViewPage.tsx # test/lib/plugin.js
112 lines
4.2 KiB
TypeScript
112 lines
4.2 KiB
TypeScript
import React, { useEffect, useContext, useState } from "react";
|
|
import { useParams } from "react-router-dom";
|
|
import { Alert, Descriptions, Spin } from "antd";
|
|
|
|
import type { PluginWebApi } from "@clusterio/lib";
|
|
|
|
import ControlContext from "./ControlContext";
|
|
import PageLayout from "./PageLayout";
|
|
import PageHeader from "./PageHeader";
|
|
import notify from "../util/notify";
|
|
|
|
export default function PluginViewPage() {
|
|
let params = useParams();
|
|
const control = useContext(ControlContext);
|
|
let [pluginList, setPluginList] = useState<PluginWebApi[]>();
|
|
let pluginName = String(params.name);
|
|
|
|
useEffect(() => {
|
|
(async () => {
|
|
let response = await fetch(`${webRoot}api/plugins`);
|
|
if (response.ok) {
|
|
setPluginList(await response.json());
|
|
} else {
|
|
notify("Failed to load plugin list");
|
|
}
|
|
})();
|
|
}, []);
|
|
|
|
const loadedPlugin = control.loadedPlugins.get(pluginName);
|
|
const pluginInfo = control.pluginInfos.get(pluginName);
|
|
const pluginTitle = pluginInfo ? pluginInfo.title : pluginName;
|
|
let nav = [{ name: "Plugins", path: "/plugins" }, { name: pluginTitle }];
|
|
if (!pluginList) {
|
|
return <PageLayout nav={nav}>
|
|
<Descriptions bordered size="small" title={pluginTitle} />
|
|
<Spin size="large" />
|
|
</PageLayout>;
|
|
}
|
|
|
|
let pluginMeta = pluginList.find(p => p.name === pluginName);
|
|
if (!pluginMeta) {
|
|
return <PageLayout nav={nav}>
|
|
<PageHeader title="Plugin not found" />
|
|
<p>Plugin with name {pluginName} was not found on the controller.</p>
|
|
</PageLayout>;
|
|
}
|
|
|
|
const pluginError = pluginMeta.web.error ?? pluginInfo?.error;
|
|
const hasWebModule = Boolean(pluginMeta.web.main || pluginMeta.web.error);
|
|
if (!loadedPlugin) {
|
|
return <PageLayout nav={nav}>
|
|
<Descriptions bordered size="small" title={pluginTitle}>
|
|
<Descriptions.Item label="Version">{pluginMeta.version}</Descriptions.Item>
|
|
<Descriptions.Item label="Loaded in Web UI" span={2}>
|
|
{hasWebModule ? "No" : "No web module"}
|
|
</Descriptions.Item>
|
|
<Descriptions.Item label="Loaded on controller">{pluginMeta.loaded ? "Yes" : "No"}</Descriptions.Item>
|
|
<Descriptions.Item label="Enabled on controller" span={2}>
|
|
{pluginMeta.enabled ? "Yes" : "No"}
|
|
</Descriptions.Item>
|
|
</Descriptions>
|
|
{pluginError && <Alert
|
|
style={{
|
|
marginTop: "1em",
|
|
}}
|
|
message={pluginError}
|
|
description={
|
|
"The web interface was unable to load the webpack module for this plugin. This is "+
|
|
"usually due to an incorrect or missing webpack build for the plugin. Due to the "+
|
|
"module not being loaded, the configs and web controls defined by this plugin may "+
|
|
"not be available in the web interface."
|
|
}
|
|
type="error"
|
|
showIcon
|
|
/>}
|
|
</PageLayout>;
|
|
}
|
|
|
|
return <PageLayout nav={nav}>
|
|
<Descriptions bordered size="small" title={pluginTitle}>
|
|
<Descriptions.Item label="Version">{pluginMeta.version}</Descriptions.Item>
|
|
<Descriptions.Item label="Loaded in Web UI" span={2}>Yes</Descriptions.Item>
|
|
<Descriptions.Item label="Loaded on controller">{pluginMeta.loaded ? "Yes" : "No"}</Descriptions.Item>
|
|
<Descriptions.Item label="Enabled on controller" span={2}>
|
|
{pluginMeta.enabled ? "Yes" : "No"}
|
|
</Descriptions.Item>
|
|
<Descriptions.Item label="Description" span={3}>{loadedPlugin.description}</Descriptions.Item>
|
|
{loadedPlugin.package.homepage ? <Descriptions.Item label="Homepage" span={3}>
|
|
<a href={loadedPlugin.package.homepage}>{loadedPlugin.package.homepage}</a>
|
|
</Descriptions.Item> : null}
|
|
{loadedPlugin.package.author ? <Descriptions.Item label="Author" span={3}>
|
|
{loadedPlugin.package.author}
|
|
</Descriptions.Item> : null}
|
|
<Descriptions.Item label="License" span={3}>{loadedPlugin.package.license}</Descriptions.Item>
|
|
</Descriptions>
|
|
{pluginMeta.version !== loadedPlugin.package.version ? <Alert
|
|
style={{
|
|
marginTop: "1em",
|
|
}}
|
|
message="Version missmatch detected"
|
|
description={
|
|
`The version of the web interface module for this plugin (${loadedPlugin.package.version}) `+
|
|
`does not match the version running on the controller (${pluginMeta.version}), `+
|
|
"spurious errors may occur. This usually happens when the plugin is updated but the "+
|
|
"controller has not been restarted yet, but may also be due to an outdated build."
|
|
}
|
|
type="warning"
|
|
showIcon
|
|
/> : null}
|
|
</PageLayout>;
|
|
}
|