Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-19 06:03:50 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4028 from Snarling/scpAndWriteDocFix

Browse Source 
NETSCRIPT: Update netscript definition file for scp, write, read, and flags
This commit is contained in:
hydroflame 2022-08-25 16:37:07 -03:00 committed by GitHub
commit 2463fc2012
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 68 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
src/NetscriptFunctions.ts
View File

@ -1465,47 +1465,42 @@ const base: InternalAPI<NS> = {
}, },
write: write:
(ctx: NetscriptContext) => (ctx: NetscriptContext) =>
(_port: unknown, _data: unknown = "", _mode: unknown = "a"): void => { (_filename: unknown, _data: unknown = "", _mode: unknown = "a"): void => {
const port = helpers.string(ctx, "port", _port); let fn = helpers.string(ctx, "handle", _filename);
const data = helpers.string(ctx, "data", _data); const data = helpers.string(ctx, "data", _data);
const mode = helpers.string(ctx, "mode", _mode); const mode = helpers.string(ctx, "mode", _mode);
if (isString(port)) { if (!isValidFilePath(fn)) throw helpers.makeRuntimeErrorMsg(ctx, `Invalid filepath: ${fn}`);
// Write to script or text file
let fn = port;
if (!isValidFilePath(fn)) throw helpers.makeRuntimeErrorMsg(ctx, `Invalid filepath: ${fn}`);
if (fn.lastIndexOf("/") === 0) fn = removeLeadingSlash(fn); if (fn.lastIndexOf("/") === 0) fn = removeLeadingSlash(fn);
const server = helpers.getServer(ctx, ctx.workerScript.hostname); const server = helpers.getServer(ctx, ctx.workerScript.hostname);
if (isScriptFilename(fn)) { if (isScriptFilename(fn)) {
// Write to script // Write to script
let script = ctx.workerScript.getScriptOnServer(fn, server); let script = ctx.workerScript.getScriptOnServer(fn, server);
if (script == null) { if (script == null) {
// Create a new script // Create a new script
script = new Script(Player, fn, String(data), server.hostname, server.scripts); script = new Script(Player, fn, String(data), server.hostname, server.scripts);
server.scripts.push(script); server.scripts.push(script);
return script.updateRamUsage(Player, server.scripts);
}
mode === "w" ? (script.code = String(data)) : (script.code += data);
return script.updateRamUsage(Player, server.scripts); return script.updateRamUsage(Player, server.scripts);
} else {
// Write to text file
const txtFile = getTextFile(fn, server);
if (txtFile == null) {
createTextFile(fn, String(data), server);
return;
}
if (mode === "w") {
txtFile.write(String(data));
} else {
txtFile.append(String(data));
}
} }
return; mode === "w" ? (script.code = String(data)) : (script.code += data);
return script.updateRamUsage(Player, server.scripts);
} else { } else {
throw helpers.makeRuntimeErrorMsg(ctx, `Invalid argument: ${port}`); // Write to text file
if (!fn.endsWith(".txt")) throw helpers.makeRuntimeErrorMsg(ctx, `Invalid filename: ${fn}`);
const txtFile = getTextFile(fn, server);
if (txtFile == null) {
createTextFile(fn, String(data), server);
return;
}
if (mode === "w") {
txtFile.write(String(data));
} else {
txtFile.append(String(data));
}
} }
return;
}, },
tryWritePort: tryWritePort:
(ctx: NetscriptContext) => (ctx: NetscriptContext) =>
@ -1545,33 +1540,27 @@ const base: InternalAPI<NS> = {
}, },
read: read:
(ctx: NetscriptContext) => (ctx: NetscriptContext) =>
(_port: unknown): string => { (_filename: unknown): string => {
const port = helpers.string(ctx, "port", _port); const fn = helpers.string(ctx, "filename", _filename);
if (isString(port)) { const server = GetServer(ctx.workerScript.hostname);
// Read from script or text file if (server == null) {
const fn = port; throw helpers.makeRuntimeErrorMsg(ctx, "Error getting Server. This is a bug. Report to dev.");
const server = GetServer(ctx.workerScript.hostname); }
if (server == null) { if (isScriptFilename(fn)) {
throw helpers.makeRuntimeErrorMsg(ctx, "Error getting Server. This is a bug. Report to dev."); // Read from script
} const script = ctx.workerScript.getScriptOnServer(fn, server);
if (isScriptFilename(fn)) { if (script == null) {
// Read from script return "";
const script = ctx.workerScript.getScriptOnServer(fn, server);
if (script == null) {
return "";
}
return script.code;
} else {
// Read from text file
const txtFile = getTextFile(fn, server);
if (txtFile !== null) {
return txtFile.text;
} else {
return "";
}
} }
return script.code;
} else { } else {
throw helpers.makeRuntimeErrorMsg(ctx, `Invalid argument: ${port}`); // Read from text file
const txtFile = getTextFile(fn, server);
if (txtFile !== null) {
return txtFile.text;
} else {
return "";
}
} }
}, },
peek: peek:

2
src/NetscriptFunctions/Flags.ts
View File

@ -4,7 +4,7 @@ import { ScriptArg } from "../Netscript/ScriptArg";
import { NetscriptContext } from "../Netscript/APIWrapper"; import { NetscriptContext } from "../Netscript/APIWrapper";
type FlagType = StringConstructor | NumberConstructor | BooleanConstructor | StringConstructor[]; type FlagType = StringConstructor | NumberConstructor | BooleanConstructor | StringConstructor[];
type FlagsRet = { [key: string]: ScriptArg }; type FlagsRet = { [key: string]: ScriptArg | string[] };
export function Flags(ctx: NetscriptContext | string[]): (data: unknown) => FlagsRet { export function Flags(ctx: NetscriptContext | string[]): (data: unknown) => FlagsRet {
const vargs = Array.isArray(ctx) ? ctx : ctx.workerScript.args; const vargs = Array.isArray(ctx) ? ctx : ctx.workerScript.args;
return (schema: unknown): FlagsRet => { return (schema: unknown): FlagsRet => {

42
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -5413,25 +5413,25 @@ export interface NS {
* ```ts * ```ts
* // NS2: * // NS2:
* //Copies foo.lit from the helios server to the home computer: * //Copies foo.lit from the helios server to the home computer:
* await ns.scp("foo.lit", "home", "helios" ); * ns.scp("foo.lit", "home", "helios" );
* *
* //Tries to copy three files from rothman-uni to home computer: * //Tries to copy three files from rothman-uni to home computer:
* files = ["foo1.lit", "foo2.script", "foo3.script"]; * files = ["foo1.lit", "foo2.script", "foo3.script"];
* await ns.scp(files, "home", "rothman-uni"); * ns.scp(files, "home", "rothman-uni");
* ``` * ```
* @example * @example
* ```ts * ```ts
* //ns2, copies files from home to a target server * //ns2, copies files from home to a target server
* const server = ns.args[0]; * const server = ns.args[0];
* const files = ["hack.js","weaken.js","grow.js"]; * const files = ["hack.js","weaken.js","grow.js"];
* await ns.scp(files, server, "home"); * ns.scp(files, server, "home");
* ``` * ```
* @param files - Filename or an array of filenames of script/literature files to copy. * @param files - Filename or an array of filenames of script/literature files to copy.
* @param source - Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.
* @param destination - Host of the destination server, which is the server to which the file will be copied. * @param destination - Host of the destination server, which is the server to which the file will be copied.
* @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. * @param source - Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.
* @returns True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed.
*/ */
scp(files: string | string[], destination: string, source?: string): Promise<boolean>; scp(files: string | string[], destination: string, source?: string): boolean;
/** /**
* List files on a server. * List files on a server.
@ -5971,20 +5971,20 @@ export interface NS {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* This function can be used to write data to a text file (.txt). * This function can be used to write data to a text file (.txt) or a script (.js or .script).
* *
* This function will write data to that text file. If the specified text file does not exist, * This function will write data to that file. If the specified file does not exist,
* then it will be created. The third argument mode, defines how the data will be written to * then it will be created. The third argument mode, defines how the data will be written to
* the text file. If *mode is set to “w”, then the data is written in “write” mode which means * the file. If *mode is set to “w”, then the data is written in “write” mode which means
* that it will overwrite all existing data on the text file. If mode is set to any other value * that it will overwrite all existing data on the file. If mode is set to any other value
* then the data will be written in “append” mode which means that the data will be added at the * then the data will be written in “append” mode which means that the data will be added at the
* end of the text file. * end of the file.
* *
* @param handle - Filename of the text file that will be written to. * @param filename - Name of the file to be written to.
* @param data - Data to write. * @param data - Data to write.
* @param mode - Defines the write mode. Only valid when writing to text files. * @param mode - Defines the write mode.
*/ */
write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): Promise<void>; write(filename: string, data?: string[] | number | string, mode?: "w" | "a"): void;
/** /**
* Attempt to write to a port. * Attempt to write to a port.
@ -6006,15 +6006,15 @@ export interface NS {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* This function is used to read data from a text file (.txt). * This function is used to read data from a text file (.txt) or script (.script, .js).
* *
* This function will return the data in the specified text * This function will return the data in the specified file.
* file. If the text file does not exist, an empty string will be returned. * If the file does not exist, an empty string will be returned.
* *
* @param handle - Filename to read from. * @param filename - Name of the file to be read.
* @returns Data in the specified text file. * @returns Data in the specified text file.
*/ */
read(handle: string): PortData; read(filename: string): string;
/** /**
* Get a copy of the data from a port without popping it. * Get a copy of the data from a port without popping it.
@ -6531,7 +6531,7 @@ export interface NS {
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true} * // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true}
* ``` * ```
*/ */
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg }; flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
/** /**
* Share your computer with your factions. * Share your computer with your factions.
@ -7358,5 +7358,5 @@ interface AutocompleteData {
servers: string[]; servers: string[];
scripts: string[]; scripts: string[];
txts: string[]; txts: string[];
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg }; flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
} }