mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-18 23:33:12 +09:00
Merge pull request #712 from O2theC/auto-mod-update - basic mod portal integration
Add mod portal integration and mod downloads to the web interface
This commit is contained in:
10 files changed
+1834
-15
No files matched your search
@@ -1,8 +1,12 @@
|
||||
import React, { Fragment, useState, useContext } from "react";
|
||||
import React, { Fragment, useState, useContext, useEffect, useMemo } from "react";
|
||||
import { useNavigate } from "react-router-dom";
|
||||
import { Button, Form, Input, Modal, Popconfirm, Space, Table, Typography, Upload } from "antd";
|
||||
import ImportOutlined from "@ant-design/icons/ImportOutlined";
|
||||
import PlusOutlined from "@ant-design/icons/PlusOutlined";
|
||||
import {
|
||||
Button, Form, Input, Modal, Popconfirm, Space, Table, Typography, Upload, Alert, Select, Tooltip, notification,
|
||||
} from "antd";
|
||||
import {
|
||||
ImportOutlined, PlusOutlined, SearchOutlined, DownloadOutlined,
|
||||
} from "@ant-design/icons";
|
||||
import { Static } from "@sinclair/typebox";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
@@ -21,6 +25,12 @@ import UploadButton from "./UploadButton";
|
||||
|
||||
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
|
||||
|
||||
// Define the allowed Factorio versions based on the lib schema
|
||||
type FactorioVersion = Static<(typeof lib.ModPortalGetAllRequest)["allowedVersions"][number]>;
|
||||
|
||||
// Type alias for the mod structure derived from the library response
|
||||
type ModPortalModType = InstanceType<typeof lib.ModPortalGetAllRequest.Response>["mods"][number];
|
||||
|
||||
function ImportModPackButton() {
|
||||
let control = useContext(ControlContext);
|
||||
let navigate = useNavigate();
|
||||
@@ -129,6 +139,375 @@ function CreateModPackButton() {
|
||||
</>;
|
||||
}
|
||||
|
||||
function SearchModsButton() {
|
||||
const control = useContext(ControlContext);
|
||||
const account = useAccount();
|
||||
const [open, setOpen] = useState(false);
|
||||
const [form] = Form.useForm();
|
||||
const [searchText, setSearchText] = useState("");
|
||||
const [factorioVersion, setFactorioVersion] = useState<FactorioVersion>("2.0");
|
||||
|
||||
// State for all mods fetched from backend
|
||||
const [allMods, setAllMods] = useState<ModPortalModType[]>([]);
|
||||
const [loading, setLoading] = useState<boolean>(false);
|
||||
const [error, setError] = useState<Error | null>(null);
|
||||
|
||||
// State for client-side pagination and sorting
|
||||
const [page, setPage] = useState(1);
|
||||
const [pageSize, setPageSize] = useState(10);
|
||||
const [sort, setSort] = useState<string>("name");
|
||||
const [sortOrder, setSortOrder] = useState<"asc" | "desc">("asc");
|
||||
|
||||
// Function to handle download from Mod Portal to Controller
|
||||
const handleControllerDownload = (
|
||||
modName: string,
|
||||
modTitle: string | undefined,
|
||||
modVersion: string | undefined,
|
||||
portalFactorioVersion: FactorioVersion,
|
||||
) => {
|
||||
if (modVersion) {
|
||||
control.send(
|
||||
new lib.ModPortalDownloadRequest(
|
||||
modName,
|
||||
modVersion,
|
||||
portalFactorioVersion
|
||||
)
|
||||
).then(() => {
|
||||
notification.success({
|
||||
message: "Download started",
|
||||
description: `${modTitle || modName} v${
|
||||
modVersion
|
||||
} is being downloaded to the controller.`,
|
||||
});
|
||||
}).catch(
|
||||
notifyErrorHandler("Error starting mod download")
|
||||
);
|
||||
}
|
||||
};
|
||||
|
||||
// Fetch all mods from backend when modal opens or version changes
|
||||
useEffect(() => {
|
||||
if (!open || !factorioVersion) {
|
||||
setAllMods([]); // Clear mods if modal closed or no version
|
||||
return;
|
||||
}
|
||||
|
||||
setLoading(true);
|
||||
setError(null);
|
||||
let canceled = false;
|
||||
|
||||
control.send(
|
||||
new lib.ModPortalGetAllRequest(factorioVersion)
|
||||
).then((response: any) => {
|
||||
if (canceled) { return; }
|
||||
setAllMods(response.mods || []);
|
||||
setLoading(false);
|
||||
}).catch(err => {
|
||||
if (canceled) { return; }
|
||||
notifyErrorHandler("Error fetching mods from portal")(err);
|
||||
setError(err);
|
||||
setAllMods([]);
|
||||
setLoading(false);
|
||||
});
|
||||
|
||||
// eslint-disable-next-line consistent-return
|
||||
return () => {
|
||||
canceled = true;
|
||||
};
|
||||
// Re-fetch when modal opens or factorio version changes
|
||||
}, [open, factorioVersion, control]);
|
||||
|
||||
|
||||
// Memoize the filtered, sorted, and paginated mods (logic remains the same)
|
||||
const displayedMods = useMemo(() => {
|
||||
let filtered = allMods;
|
||||
|
||||
// Apply search filter (case-insensitive)
|
||||
if (searchText) {
|
||||
const lowerSearchText = searchText.toLowerCase();
|
||||
filtered = filtered.filter(mod => mod.name.toLowerCase().includes(lowerSearchText)
|
||||
|| mod.title.toLowerCase().includes(lowerSearchText)
|
||||
);
|
||||
}
|
||||
|
||||
// Apply sorting
|
||||
if (sort && sortOrder) {
|
||||
filtered = [...filtered].sort((a, b) => {
|
||||
let aValue: any = a[sort as keyof ModPortalModType] ?? "";
|
||||
let bValue: any = b[sort as keyof ModPortalModType] ?? "";
|
||||
|
||||
// Handle specific types if necessary (e.g., numbers, dates)
|
||||
if (sort === "downloads_count") {
|
||||
aValue = a.downloads_count ?? 0;
|
||||
bValue = b.downloads_count ?? 0;
|
||||
return sortOrder === "asc" ? aValue - bValue : bValue - aValue;
|
||||
}
|
||||
|
||||
// Default string comparison
|
||||
const comparison = strcmp(String(aValue), String(bValue));
|
||||
return sortOrder === "asc" ? comparison : -comparison;
|
||||
});
|
||||
}
|
||||
|
||||
// Apply pagination
|
||||
const startIndex = (page - 1) * pageSize;
|
||||
return filtered.slice(startIndex, startIndex + pageSize);
|
||||
|
||||
}, [allMods, searchText, sort, sortOrder, page, pageSize]);
|
||||
|
||||
// Calculate total results based on the filtered list *before* pagination (logic remains the same)
|
||||
const totalResults = useMemo(() => {
|
||||
let filtered = allMods;
|
||||
if (searchText) {
|
||||
const lowerSearchText = searchText.toLowerCase();
|
||||
filtered = filtered.filter(mod => mod.name.toLowerCase().includes(lowerSearchText)
|
||||
|| mod.title.toLowerCase().includes(lowerSearchText)
|
||||
);
|
||||
}
|
||||
return filtered.length;
|
||||
}, [allMods, searchText]);
|
||||
|
||||
// Update search text and factorio version from form
|
||||
const handleSearch = (changedValues: any, allValues: any) => {
|
||||
const nameValue = allValues.name;
|
||||
const versionValue = allValues.factorioVersion as FactorioVersion | undefined;
|
||||
|
||||
// Only trigger state updates if values actually changed
|
||||
if (nameValue !== searchText) {
|
||||
setSearchText(nameValue || "");
|
||||
}
|
||||
if (versionValue && versionValue !== factorioVersion) {
|
||||
setFactorioVersion(versionValue);
|
||||
setAllMods([]); // Clear mods when version changes, useEffect will fetch new ones
|
||||
setLoading(true); // Show loading indicator immediately
|
||||
}
|
||||
// Reset page only if search text or version changed
|
||||
if (nameValue !== searchText || (versionValue && versionValue !== factorioVersion)) {
|
||||
setPage(1);
|
||||
}
|
||||
};
|
||||
|
||||
// Update pagination and sorting state when table changes (logic remains the same)
|
||||
const handleTableChange = (
|
||||
pagination: any,
|
||||
filters: any,
|
||||
sorter: any
|
||||
) => {
|
||||
if (pagination.current !== page) {
|
||||
setPage(pagination.current);
|
||||
}
|
||||
if (pagination.pageSize !== pageSize) {
|
||||
setPageSize(pagination.pageSize);
|
||||
setPage(1); // Reset to first page if page size changes
|
||||
}
|
||||
|
||||
// Update sort state if sorter exists and has changed
|
||||
if (sorter.field && (sorter.field !== sort || sorter.order !== (sortOrder === "asc" ? "ascend" : "descend"))) {
|
||||
setSort(sorter.field);
|
||||
setSortOrder(sorter.order === "ascend" ? "asc" : "desc");
|
||||
setPage(1); // Reset to first page on sort change
|
||||
} else if (!sorter.field && sort !== "name") { // Reset only if not already default
|
||||
// Clear sort if column header clicked without order - default to name ascending
|
||||
setSort("name");
|
||||
setSortOrder("asc");
|
||||
setPage(1);
|
||||
}
|
||||
};
|
||||
|
||||
// Helper to get antd sort order format (logic remains the same)
|
||||
const getColumnSortOrder = (columnKey: string): "ascend" | "descend" | undefined => {
|
||||
if (sort === columnKey) {
|
||||
return sortOrder === "asc" ? "ascend" : "descend";
|
||||
}
|
||||
return undefined;
|
||||
};
|
||||
|
||||
return <>
|
||||
<Button icon={<SearchOutlined />} onClick={() => { setOpen(true); }}>Search</Button>
|
||||
<Modal
|
||||
title="Search Mod Portal"
|
||||
open={open}
|
||||
onCancel={() => { setOpen(false); }}
|
||||
width={1000}
|
||||
footer={[
|
||||
<Button key="close" onClick={() => { setOpen(false); }}>
|
||||
Close
|
||||
</Button>,
|
||||
]}
|
||||
>
|
||||
<Form
|
||||
form={form}
|
||||
layout="horizontal"
|
||||
labelCol={{ span: 6 }}
|
||||
wrapperCol={{ span: 18 }}
|
||||
onValuesChange={handleSearch}
|
||||
initialValues={{ factorioVersion: factorioVersion, name: searchText }}
|
||||
>
|
||||
<Form.Item name="name" label="Filter by Name or Title">
|
||||
<Input placeholder="Start typing to filter..." />
|
||||
</Form.Item>
|
||||
<Form.Item
|
||||
name="factorioVersion"
|
||||
label="Factorio Version"
|
||||
>
|
||||
<Select>
|
||||
{lib.ModPortalGetAllRequest.allowedVersions.map((literalSchema: any) => (
|
||||
<Select.Option
|
||||
key={literalSchema.const}
|
||||
value={literalSchema.const}
|
||||
>
|
||||
{literalSchema.const}
|
||||
</Select.Option>
|
||||
)).reverse()}
|
||||
</Select>
|
||||
</Form.Item>
|
||||
</Form>
|
||||
|
||||
{/* Display error message if fetching failed */}
|
||||
{error && <Alert
|
||||
message="Error Fetching Mods"
|
||||
description={error.message}
|
||||
type="error"
|
||||
showIcon
|
||||
style={{ marginBottom: 16 }}
|
||||
/>}
|
||||
|
||||
<Table
|
||||
dataSource={displayedMods}
|
||||
rowKey={record => record.name}
|
||||
loading={loading}
|
||||
onChange={handleTableChange}
|
||||
pagination={{
|
||||
current: page,
|
||||
pageSize: pageSize,
|
||||
total: totalResults,
|
||||
showSizeChanger: true,
|
||||
pageSizeOptions: ["10", "20", "50", "100"],
|
||||
}}
|
||||
expandable={{
|
||||
expandedRowRender: record => (
|
||||
<div>
|
||||
<p><strong>Summary:</strong> {record.summary ?? "N/A"}</p>
|
||||
<p><strong>Downloads:</strong> {record.downloads_count?.toLocaleString() ?? "N/A"}</p>
|
||||
<p><strong>Latest Release:</strong></p>
|
||||
{record.latest_release ? (
|
||||
<ul>
|
||||
<li>Version: {record.latest_release.version ?? "N/A"}</li>
|
||||
<li>
|
||||
Factorio Version: {
|
||||
record.latest_release.info_json?.factorio_version ?? "N/A"
|
||||
}
|
||||
</li>
|
||||
<li>
|
||||
Released: {
|
||||
record.latest_release.released_at
|
||||
? new Date(record.latest_release.released_at).toLocaleString()
|
||||
: "N/A"
|
||||
}
|
||||
</li>
|
||||
</ul>
|
||||
) : <p>No release information available.</p>}
|
||||
{account.hasPermission("core.mod.download_from_portal") && record.latest_release && (
|
||||
<Button
|
||||
onClick={() => {
|
||||
handleControllerDownload(
|
||||
record.name,
|
||||
record.title,
|
||||
record.latest_release!.version,
|
||||
factorioVersion
|
||||
);
|
||||
}}
|
||||
disabled={!record.latest_release?.version}
|
||||
>
|
||||
Download Latest Version
|
||||
</Button>
|
||||
)}
|
||||
</div>
|
||||
),
|
||||
}}
|
||||
columns={[
|
||||
// Columns remain largely the same
|
||||
{
|
||||
title: "Name",
|
||||
dataIndex: "name",
|
||||
key: "name",
|
||||
sorter: true,
|
||||
sortOrder: getColumnSortOrder("name"),
|
||||
},
|
||||
{
|
||||
title: "Title",
|
||||
dataIndex: "title",
|
||||
key: "title",
|
||||
sorter: true,
|
||||
sortOrder: getColumnSortOrder("title"),
|
||||
},
|
||||
{
|
||||
title: "Author",
|
||||
dataIndex: "owner",
|
||||
key: "owner",
|
||||
sorter: true,
|
||||
sortOrder: getColumnSortOrder("owner"),
|
||||
},
|
||||
{
|
||||
title: "Downloads",
|
||||
dataIndex: "downloads_count",
|
||||
key: "downloads_count",
|
||||
sorter: true,
|
||||
sortOrder: getColumnSortOrder("downloads_count"),
|
||||
align: "right",
|
||||
render: (count) => count?.toLocaleString() ?? "N/A",
|
||||
},
|
||||
{
|
||||
title: "Latest Version",
|
||||
key: "version",
|
||||
render: (_, record) => record.latest_release?.version ?? "N/A",
|
||||
},
|
||||
{
|
||||
title: "Actions",
|
||||
key: "actions",
|
||||
align: "center",
|
||||
render: (_, record) => (
|
||||
<Space>
|
||||
<Tooltip title="Open in Factorio Mod Portal">
|
||||
<a
|
||||
href={`https://mods.factorio.com/mod/${record.name}`}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<Button type="text">
|
||||
<img
|
||||
src="https://mods.factorio.com/static/favicon.ico"
|
||||
alt="Factorio Mod Portal"
|
||||
/>
|
||||
</Button>
|
||||
</a>
|
||||
</Tooltip>
|
||||
{account.hasPermission("core.mod.download_from_portal") && record.latest_release && (
|
||||
<Tooltip title="Download to Controller">
|
||||
<Button
|
||||
type="text"
|
||||
icon={<DownloadOutlined />}
|
||||
disabled={!record.latest_release.version}
|
||||
onClick={() => {
|
||||
handleControllerDownload(
|
||||
record.name,
|
||||
record.title,
|
||||
record.latest_release!.version,
|
||||
factorioVersion
|
||||
);
|
||||
}}
|
||||
/>
|
||||
</Tooltip>
|
||||
)}
|
||||
</Space>
|
||||
),
|
||||
},
|
||||
]}
|
||||
/>
|
||||
</Modal>
|
||||
</>;
|
||||
}
|
||||
|
||||
export default function ModsPage() {
|
||||
let account = useAccount();
|
||||
let control = useContext(ControlContext);
|
||||
@@ -223,7 +602,10 @@ export default function ModsPage() {
|
||||
},
|
||||
})}
|
||||
/>
|
||||
<SectionHeader title="Stored Mods" extra={uploadButton} />
|
||||
<SectionHeader title="Stored Mods" extra={<Space>
|
||||
<SearchModsButton />
|
||||
{uploadButton}
|
||||
</Space>} />
|
||||
|
||||
<Upload.Dragger
|
||||
className="save-list-dragger"
|
||||
|
||||
Reference in new issue
Block a user