2019-05-17 22:41:16 +02:00
|
|
|
/**
|
|
|
|
* Class representing a script file.
|
|
|
|
*
|
|
|
|
* This does NOT represent a script that is actively running and
|
|
|
|
* being evaluated. See RunningScript for that
|
|
|
|
*/
|
2022-01-05 22:41:48 +01:00
|
|
|
import { calculateRamUsage, RamUsageEntry } from "./RamCalculations";
|
2021-03-11 09:02:05 +01:00
|
|
|
import { ScriptUrl } from "./ScriptUrl";
|
2019-03-05 02:40:28 +01:00
|
|
|
|
2022-07-15 01:00:10 +02:00
|
|
|
import { Generic_fromJSON, Generic_toJSON, IReviverValue, Reviver } from "../utils/JSONReviver";
|
2021-09-25 20:42:57 +02:00
|
|
|
import { roundToTwo } from "../utils/helpers/roundToTwo";
|
2022-07-20 04:44:45 +02:00
|
|
|
import { ScriptModule } from "./ScriptModule";
|
2019-03-03 04:15:10 +01:00
|
|
|
|
2019-06-03 02:17:27 +02:00
|
|
|
let globalModuleSequenceNumber = 0;
|
|
|
|
|
2022-01-20 22:11:48 +01:00
|
|
|
interface ScriptReference {
|
|
|
|
filename: string;
|
|
|
|
server: string;
|
|
|
|
}
|
2022-01-09 09:50:36 +01:00
|
|
|
|
2019-03-03 04:15:10 +01:00
|
|
|
export class Script {
|
2021-09-05 01:09:30 +02:00
|
|
|
// Code for this script
|
|
|
|
code = "";
|
|
|
|
|
|
|
|
// Filename for the script file
|
|
|
|
filename = "";
|
|
|
|
|
|
|
|
// url of the script if any, only for NS2.
|
|
|
|
url = "";
|
|
|
|
|
|
|
|
// The dynamic module generated for this script when it is run.
|
|
|
|
// This is only applicable for NetscriptJS
|
2022-07-20 04:44:45 +02:00
|
|
|
module: Promise<ScriptModule> | null = null;
|
2021-09-05 01:09:30 +02:00
|
|
|
|
|
|
|
// The timestamp when when the script was last updated.
|
|
|
|
moduleSequenceNumber: number;
|
|
|
|
|
|
|
|
// Only used with NS2 scripts; the list of dependency script filenames. This is constructed
|
|
|
|
// whenever the script is first evaluated, and therefore may be out of date if the script
|
|
|
|
// has been updated since it was last run.
|
|
|
|
dependencies: ScriptUrl[] = [];
|
2022-01-09 09:50:36 +01:00
|
|
|
dependents: ScriptReference[] = [];
|
2021-09-05 01:09:30 +02:00
|
|
|
|
|
|
|
// Amount of RAM this Script requres to run
|
|
|
|
ramUsage = 0;
|
2022-01-05 22:41:48 +01:00
|
|
|
ramUsageEntries?: RamUsageEntry[];
|
2021-09-05 01:09:30 +02:00
|
|
|
|
2022-08-20 00:21:31 +02:00
|
|
|
// Used to deconflict multiple simultaneous compilations.
|
|
|
|
queueCompile = false;
|
|
|
|
|
2021-10-07 23:55:49 +02:00
|
|
|
// hostname of server that this script is on.
|
2021-09-05 01:09:30 +02:00
|
|
|
server = "";
|
|
|
|
|
2022-08-29 08:41:17 +02:00
|
|
|
constructor(fn = "", code = "", server = "", otherScripts: Script[] = []) {
|
2021-09-05 01:09:30 +02:00
|
|
|
this.filename = fn;
|
|
|
|
this.code = code;
|
2021-10-07 23:55:49 +02:00
|
|
|
this.server = server; // hostname of server this script is on
|
2021-09-05 01:09:30 +02:00
|
|
|
this.moduleSequenceNumber = ++globalModuleSequenceNumber;
|
2022-08-29 08:41:17 +02:00
|
|
|
if (this.code !== "") {
|
|
|
|
this.updateRamUsage(otherScripts);
|
2021-04-30 05:52:56 +02:00
|
|
|
}
|
2021-09-05 01:09:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Download the script as a file
|
|
|
|
*/
|
|
|
|
download(): void {
|
2021-11-26 04:06:13 +01:00
|
|
|
const filename = this.filename;
|
2021-09-05 01:09:30 +02:00
|
|
|
const file = new Blob([this.code], { type: "text/plain" });
|
2022-07-20 08:36:21 +02:00
|
|
|
const a = document.createElement("a"),
|
|
|
|
url = URL.createObjectURL(file);
|
|
|
|
a.href = url;
|
|
|
|
a.download = filename;
|
|
|
|
document.body.appendChild(a);
|
|
|
|
a.click();
|
|
|
|
setTimeout(function () {
|
|
|
|
document.body.removeChild(a);
|
|
|
|
window.URL.revokeObjectURL(url);
|
|
|
|
}, 0);
|
2021-09-05 01:09:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Marks this script as having been updated. It will be recompiled next time something tries
|
|
|
|
* to exec it.
|
|
|
|
*/
|
|
|
|
markUpdated(): void {
|
2022-07-20 04:44:45 +02:00
|
|
|
this.module = null;
|
2021-09-05 01:09:30 +02:00
|
|
|
this.moduleSequenceNumber = ++globalModuleSequenceNumber;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Save a script from the script editor
|
|
|
|
* @param {string} code - The new contents of the script
|
|
|
|
* @param {Script[]} otherScripts - Other scripts on the server. Used to process imports
|
|
|
|
*/
|
2022-08-29 08:41:17 +02:00
|
|
|
saveScript(filename: string, code: string, hostname: string, otherScripts: Script[]): void {
|
2021-09-17 08:58:02 +02:00
|
|
|
// Update code and filename
|
2022-01-15 04:01:11 +01:00
|
|
|
this.code = Script.formatCode(code);
|
2021-09-17 08:58:02 +02:00
|
|
|
|
2021-09-25 07:06:17 +02:00
|
|
|
this.filename = filename;
|
2021-10-07 23:55:49 +02:00
|
|
|
this.server = hostname;
|
2022-08-29 08:41:17 +02:00
|
|
|
this.updateRamUsage(otherScripts);
|
2021-09-17 08:58:02 +02:00
|
|
|
this.markUpdated();
|
2022-01-09 09:50:36 +01:00
|
|
|
for (const dependent of this.dependents) {
|
2022-01-20 22:11:48 +01:00
|
|
|
const [dependentScript] = otherScripts.filter(
|
|
|
|
(s) => s.filename === dependent.filename && s.server == dependent.server,
|
|
|
|
);
|
2022-08-20 00:21:31 +02:00
|
|
|
dependentScript?.markUpdated();
|
2022-01-09 09:50:36 +01:00
|
|
|
}
|
2021-09-05 01:09:30 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Calculates and updates the script's RAM usage based on its code
|
|
|
|
* @param {Script[]} otherScripts - Other scripts on the server. Used to process imports
|
|
|
|
*/
|
2022-08-29 08:41:17 +02:00
|
|
|
updateRamUsage(otherScripts: Script[]): void {
|
|
|
|
const res = calculateRamUsage(this.code, otherScripts);
|
2022-01-05 22:41:48 +01:00
|
|
|
if (res.cost > 0) {
|
|
|
|
this.ramUsage = roundToTwo(res.cost);
|
|
|
|
this.ramUsageEntries = res.entries;
|
2021-05-01 09:17:31 +02:00
|
|
|
}
|
2021-10-08 20:05:47 +02:00
|
|
|
this.markUpdated();
|
2021-09-05 01:09:30 +02:00
|
|
|
}
|
|
|
|
|
2021-10-13 01:23:36 +02:00
|
|
|
imports(): string[] {
|
|
|
|
return [];
|
|
|
|
}
|
|
|
|
|
2021-09-05 01:09:30 +02:00
|
|
|
// Serialize the current object to a JSON save state
|
2022-07-15 01:00:10 +02:00
|
|
|
toJSON(): IReviverValue {
|
2021-09-05 01:09:30 +02:00
|
|
|
return Generic_toJSON("Script", this);
|
|
|
|
}
|
|
|
|
|
|
|
|
// Initializes a Script Object from a JSON save state
|
2022-07-15 01:00:10 +02:00
|
|
|
static fromJSON(value: IReviverValue): Script {
|
2021-12-13 01:39:53 +01:00
|
|
|
const s = Generic_fromJSON(Script, value.data);
|
|
|
|
// Force the url to blank from the save data. Urls are not valid outside the current browser page load.
|
|
|
|
s.url = "";
|
2022-01-09 09:50:36 +01:00
|
|
|
s.dependents = [];
|
2021-12-13 01:39:53 +01:00
|
|
|
return s;
|
2021-09-05 01:09:30 +02:00
|
|
|
}
|
2022-01-14 11:14:56 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Formats code: Removes the starting & trailing whitespace
|
|
|
|
* @param {string} code - The code to format
|
|
|
|
* @returns The formatted code
|
|
|
|
*/
|
2022-01-20 22:11:48 +01:00
|
|
|
static formatCode(code: string): string {
|
2022-01-14 11:14:56 +01:00
|
|
|
return code.replace(/^\s+|\s+$/g, "");
|
|
|
|
}
|
2019-03-03 04:15:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
Reviver.constructors.Script = Script;
|