BOSS/src/cli/files-3ds.cmd.ts
Daniel López Guimaraes c17b68c45f
Some checks failed
Build and Publish Docker Image / Build and Publish Docker Image (amd64) (push) Has been cancelled
Build and Publish Docker Image / Build and Publish Docker Image (arm64) (push) Has been cancelled
fix(cli): Allow download of files with no payload content
2025-11-11 13:06:11 +00:00

206 lines
7.6 KiB
TypeScript

import fs from 'node:fs/promises';
import { pipeline } from 'node:stream/promises';
import { Readable } from 'node:stream';
import { request } from 'undici';
import { Command } from 'commander';
import { decrypt3DS } from '@pretendonetwork/boss-crypto';
import { PlatformType } from '@pretendonetwork/grpc/boss/v2/platform_type';
import { commandHandler, getCliContext } from './utils';
import { logOutputList, logOutputObject } from './output';
const listCmd = new Command('ls')
.description('List all task files in BOSS')
.argument('<app_id>', 'BOSS app to search in')
.argument('<task_id>', 'Task to search in')
.option('-c, --country [country]', 'Country to filter with')
.option('-l, --language [language]', 'Language to filter with')
.option('-a, --any', 'Shows any file regardless of country and language requirements')
.action(commandHandler<[string, string]>(async (cmd): Promise<void> => {
const [appId, taskId] = cmd.args;
const opts = cmd.opts<{ country?: string; language?: string; any: boolean }>();
const ctx = getCliContext();
const { files } = await ctx.grpc.listFilesCTR({
bossAppId: appId,
taskId: taskId,
country: opts.country,
language: opts.language,
any: opts.any
});
logOutputList(files, {
format: cmd.format,
onlyIncludeKeys: ['dataId', 'name', 'size'],
mapping: {
dataId: 'Data ID',
name: 'Name',
size: 'Size (bytes)'
}
});
}));
const viewCmd = new Command('view')
.description('Look up a specific task file')
.argument('<app_id>', 'BOSS app that contains the task')
.argument('<task_id>', 'Task that contains the task file')
.argument('<id>', 'Task file ID to lookup', BigInt)
.action(commandHandler<[string, string, bigint]>(async (cmd): Promise<void> => {
const [appId, taskId, dataId] = cmd.args;
const ctx = getCliContext();
const { files } = await ctx.grpc.listFilesCTR({
bossAppId: appId,
taskId: taskId,
any: true
});
const file = files.find(v => v.dataId === dataId);
if (!file) {
console.log(`Could not find task file with data ID ${dataId} in task ${taskId}`);
return;
}
logOutputObject({
dataId: file.dataId,
name: file.name,
size: file.size,
hash: file.hash,
supportedCountries: file.supportedCountries,
supportedLanguages: file.supportedLanguages,
attributes: file.attributes,
creatorPid: file.creatorPid,
payloadContents: file.payloadContents,
flags: file.flags,
createdAt: new Date(Number(file.createdTimestamp)),
updatedAt: new Date(Number(file.updatedTimestamp))
}, {
format: cmd.format
});
}));
const downloadCmd = new Command('download')
.description('Download a task file')
.argument('<app_id>', 'BOSS app that contains the task')
.argument('<task_id>', 'Task that contains the task file')
.argument('<id>', 'Task file ID to lookup', BigInt)
.option('-d, --decrypt', 'Decrypt the file before return')
.action(commandHandler<[string, string, bigint]>(async (cmd): Promise<void> => {
const [appId, taskId, dataId] = cmd.args;
const ctx = getCliContext();
const { files } = await ctx.grpc.listFilesCTR({
bossAppId: appId,
taskId: taskId,
any: true
});
const file = files.find(v => v.dataId === dataId);
if (!file) {
console.error(`Could not find task file with data ID ${dataId} in task ${taskId}`);
process.exit(1);
}
const npdl = ctx.getNpdlUrl();
const country = file.supportedCountries.length > 0 ? '/' + file.supportedCountries[0] : '';
const language = file.supportedLanguages.length > 0 ? '/' + file.supportedLanguages[0] : '';
const { body, statusCode } = await request(`${npdl.url}/p01/nsa/${file.bossAppId}/${file.taskId}${country}${language}/${file.name}`, {
headers: {
Host: npdl.host
}
});
if (statusCode > 299) {
console.error(`Failed to download: invalid status code (${statusCode})`);
process.exit(1);
}
const chunks: Buffer[] = [];
for await (const chunk of body) {
chunks.push(Buffer.from(chunk));
}
let buffer: Buffer = Buffer.concat(chunks);
if (cmd.opts().decrypt) {
const keys = ctx.get3DSKeys();
const decrypted = decrypt3DS(buffer, keys.aesKey);
// TODO - Handle multiple payloads
buffer = decrypted.payload_contents[0]?.content ?? Buffer.alloc(0);
}
await pipeline(Readable.from(buffer), process.stdout);
}));
const createCmd = new Command('create')
.description('Create a new task file')
.argument('<app_id>', 'BOSS app to store the task file in')
.argument('<task_id>', 'Task to store the task file in')
.requiredOption('--name <name>', 'Name of the task file')
.requiredOption('--title-id <titleId>', 'Target title ID of the payload')
.requiredOption('--content-datatype <contentDatatype>', 'Content datatype of the payload')
.requiredOption('--ns-data-id <nsDataId>', 'NS Data ID of the payload')
.requiredOption('--version <version>', 'Version of the payload')
.requiredOption('--file <file>', 'Path of the file to upload')
.option('--country <country...>', 'Countries for this task file')
.option('--lang <language...>', 'Languages for this task file')
.option('--attribute1 [attribute1]', 'Attribute 1 for this task file')
.option('--attribute2 [attribute2]', 'Attribute 2 for this task file')
.option('--attribute3 [attribute3]', 'Attribute 3 for this task file')
.option('--desc [desc]', 'Description for this task file')
.option('-m, --mark-arrived-privileged', 'Only notify of new content to privileged titles')
.option('-n, --no-payload', 'Make this task file have no payload contents')
.action(commandHandler<[string, string]>(async (cmd): Promise<void> => {
const [appId, taskId] = cmd.args;
// TODO - Handle multiple payload contents
const opts = cmd.opts<{ name: string; titleId: string; contentDatatype: string; nsDataId: string; version: string; file: string; country: string[]; lang: string[]; attribute1?: string; attribute2?: string; attribute3?: string; desc?: string; markArrivedPrivileged: boolean; payload: boolean }>();
const fileBuf = opts.payload ? await fs.readFile(opts.file) : Buffer.alloc(0);
const ctx = getCliContext();
const { file } = await ctx.grpc.uploadFileCTR({
taskId: taskId,
bossAppId: appId,
supportedCountries: opts.country,
supportedLanguages: opts.lang,
attributes: {
attribute1: opts.attribute1,
attribute2: opts.attribute2,
attribute3: opts.attribute3,
description: opts.desc
},
name: opts.name,
payloadContents: opts.payload
? [{
titleId: BigInt(parseInt(opts.titleId, 16)),
contentDatatype: Number(opts.contentDatatype),
nsDataId: Number(opts.nsDataId),
version: Number(opts.version),
content: fileBuf
}]
: [],
flags: {
markArrivedPrivileged: opts.markArrivedPrivileged
}
});
if (!file) {
console.log(`Failed to create file!`);
return;
}
console.log(`Created file with ID ${file.dataId}`);
}));
const deleteCmd = new Command('delete')
.description('Delete a task file')
.argument('<app_id>', 'BOSS app that contains the task')
.argument('<task_id>', 'Task that contains the task file')
.argument('<id>', 'Task file ID to delete', BigInt)
.action(commandHandler<[string, string, bigint]>(async (cmd): Promise<void> => {
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- I want to use destructuring
const [appId, _taskId, dataId] = cmd.args;
const ctx = getCliContext();
await ctx.grpc.deleteFile({
bossAppId: appId,
dataId: dataId,
platformType: PlatformType.PLATFORM_TYPE_CTR
});
console.log(`Deleted task file with ID ${dataId}`);
}));
export const file3DSCmd = new Command('file-3ds')
.description('Manage all the 3DS task files in BOSS')
.addCommand(listCmd)
.addCommand(createCmd)
.addCommand(deleteCmd)
.addCommand(downloadCmd)
.addCommand(viewCmd);