Support mod portal downloads

This commit is contained in:
Danielv123 committed 2025-04-11 22:19:11 +02:00
1 parent 2936973a75
commit de8a7ef884
6 files changed
+184 -55

No files matched your search

+30 -37
View File
@@ -65,7 +65,7 @@ interface ModPortalResponse {
}
const MOD_PORTAL_API_URL = "https://mods.factorio.com/api/mods";
const MOD_PORTAL_MAX_PAGE_SIZE = 10000; // Or largest allowed by API
const MOD_PORTAL_MAX_PAGE_SIZE = 1000; // Or largest allowed by API
export default class ModStore extends TypedEventEmitter<keyof ModStoreEvents, ModStoreEvents> {
constructor(
@@ -266,8 +266,6 @@ export default class ModStore extends TypedEventEmitter<keyof ModStoreEvents, Mo
) {
if (releases.length === 0) { }
// releases.find() // work on this
const latestRelease = releases.find(release => release.version === version);
if (latestRelease === undefined) {
@@ -280,7 +278,7 @@ export default class ModStore extends TypedEventEmitter<keyof ModStoreEvents, Mo
const fileName = `${this.modsDirectory}/${latestRelease.file_name}.tmp`;
await ModStore.downloadFile(url, fileName);
await fs.rename(fileName, `${this.modsDirectory}/${latestRelease.file_name}`);
this.addMod(await this.loadFile(`${this.modsDirectory}/${latestRelease.file_name}`));
this.addMod(await this.loadFile(latestRelease.file_name));
}
private async downloadModsChunk(
@@ -473,43 +471,38 @@ export default class ModStore extends TypedEventEmitter<keyof ModStoreEvents, Mo
let allMods: ModDetails[] = [];
let hasMorePages = true;
try {
while (hasMorePages) {
const url = new URL(MOD_PORTAL_API_URL);
url.searchParams.set("page_size", String(MOD_PORTAL_MAX_PAGE_SIZE));
url.searchParams.set("version", factorioVersion);
url.searchParams.set("page", String(currentPage));
url.searchParams.set("hide_deprecated", String(hide_deprecated));
while (hasMorePages) {
const url = new URL(MOD_PORTAL_API_URL);
url.searchParams.set("page_size", String(MOD_PORTAL_MAX_PAGE_SIZE));
url.searchParams.set("version", factorioVersion);
url.searchParams.set("page", String(currentPage));
url.searchParams.set("hide_deprecated", String(hide_deprecated));
logger.verbose(`Fetching mod portal page ${currentPage}: ${url.toString()}`);
const response = await fetch(url.toString());
logger.verbose(`Fetching mod portal page ${currentPage}: ${url.toString()}`);
const response = await fetch(url.toString());
if (!response.ok) {
let errorDetail = "";
try {
errorDetail = await response.text();
} catch (bodyError) {
logger.warn("Failed to read response body for failed portal request");
}
let errorMessage = `Mod portal fetch page ${currentPage} failed: `;
errorMessage += `${response.status} ${response.statusText}`;
if (errorDetail) {
errorMessage += ` - ${errorDetail}`;
}
throw new Error(errorMessage);
if (!response.ok) {
let errorDetail = "";
try {
errorDetail = await response.text();
} catch (bodyError) {
logger.warn("Failed to read response body for failed portal request");
}
const data = await response.json() as ModPortalResponse;
allMods = allMods.concat(data.results);
hasMorePages = currentPage < data.pagination.page_count;
currentPage += 1;
let errorMessage = `Mod portal fetch page ${currentPage} failed: `;
errorMessage += `${response.status} ${response.statusText}`;
if (errorDetail) {
errorMessage += ` - ${errorDetail}`;
}
throw new Error(errorMessage);
}
logger.info(`Successfully fetched ${allMods.length} mods for Factorio version ${factorioVersion}.`);
return allMods;
} catch (err: any) {
logger.error(err);
throw new Error(err);
const data = await response.json() as ModPortalResponse;
allMods = allMods.concat(data.results);
hasMorePages = currentPage < data.pagination.page_count;
currentPage += 1;
}
logger.info(`Successfully fetched ${allMods.length} mods for Factorio version ${factorioVersion}.`);
return allMods;
}
}
+36
View File
@@ -355,3 +355,39 @@ export class ModUpdatesEvent {
return new this(json.updates.map(update => ModInfo.fromJSON(update)));
}
}
/**
* Request mods to be downloaded from the Factorio mod portal to the controller.
*
* The controller handles the actual download process asynchronously.
* Requires Factorio credentials to be configured on the controller if the portal
* requires authentication for downloads.
*
* @param name - Name of the mod to download.
* @param version - Version of the mod to download.
* @param factorioVersion - Factorio version context for the download.
*/
export class ModPortalDownloadRequest {
declare ["constructor"]: typeof ModPortalDownloadRequest;
static type = "request" as const;
static src = "control" as const;
static dst = "controller" as const;
static permission = "core.mod.download_from_portal" as const;
static Response = ModInfo;
constructor(
public name: string,
public version: string,
public factorioVersion: string,
) { }
static jsonSchema = Type.Object({
"name": Type.String(),
"version": Type.String(),
"factorioVersion": Type.String(),
});
static fromJSON(json: Static<typeof this.jsonSchema>) {
return new this(json.name, json.version, json.factorioVersion);
}
}
+1
View File
@@ -102,6 +102,7 @@ export const dataClasses: (RequestClass<unknown, unknown> | EventClass<unknown>)
mod.ModDeleteRequest,
mod.ModPackUpdatesEvent,
mod.ModUpdatesEvent,
mod.ModPortalDownloadRequest,
user.PermissionListRequest,
user.RoleListRequest,
+7 -1
View File
@@ -387,7 +387,7 @@ definePermission({
});
definePermission({
name: "core.mod.upload",
title: "Upload mod",
title: "Upload mods",
description: "Upload mods to the controller.",
});
definePermission({
@@ -401,6 +401,12 @@ definePermission({
title: "Delete mod",
description: "Delete mods stored on the controller.",
});
definePermission({
name: "core.mod.download_from_portal",
title: "Download mods from portal",
description: "Allow downloading mods directly from the Factorio mod portal to the controller.",
grantByDefault: true,
});
definePermission({
name: "core.permission.list",