///
/**
* Offline MathCoach-API falls notwendig bereitstellen. Dabei wird das Dateisystem durch den
* LocalStorage des Browsers implementiert - einige Features der IDE (beispielsweise
* der Navigator) sind nicht verfügbar und führen keine Aktionen durch.
*
* **Hinweis**: Wenn die echte MathCoach-API der IDE verfügbar ist, hat der Aufruf
* dieser Funktion keinen Seiteneffekt.
*
* @param contextFileExtension Datei-Erweiterung der Kontext-Datei
*
*/
export function enableOfflineUsageIfNecessary(contextFileExtension: string = "dummy.json"): boolean {
const fileIdentifier = (file: MathCoach.File) => `mock-file://${file.owner}@${file.part}/${file.path}`;
const traceMethod = (method: string, args?: any[]) => console.log(["[MC MOCK API]", " ", method, "(", (args ? args : [""]).join(","), ")"].join(""));
class MockAPI implements MathCoach.Api {
public ide: MathCoach.IdeApi = {
async getContextFile(): Promise {
traceMethod("MC.ide.getContextFile");
return {
owner: "jdoe",
path: `/file.${contextFileExtension}`,
part: "vfs"
}
},
async getUserName(): Promise {
traceMethod("MC.ide.getUserName");
return "jdoe"
},
fs: {
async readFile(file: MathCoach.File) {
traceMethod("MC.ide.fs.readFile", [JSON.stringify(file)]);
return localStorage.getItem(fileIdentifier(file)) || "";
},
async writeFile(file: MathCoach.File, text: string) {
traceMethod("MC.ide.fs.writeFile", [JSON.stringify(file), JSON.stringify(`...${text.length} chars...`)]);
return localStorage.setItem(fileIdentifier(file), text);
}
},
navigator: {
async navigateTo(link: string, forceOpen?: boolean) {
traceMethod("MC.ide.navigator.navigateTo", [JSON.stringify(link), JSON.stringify(forceOpen ? true : false)]);
},
async navigateToExercise(file: MathCoach.File, forceOpen?: boolean) {
traceMethod("MC.ide.navigator.navigateToExercise", [JSON.stringify(file), JSON.stringify(forceOpen ? true : false)]);
}
}
};
public async isReady(): Promise {
traceMethod("MC.isReady()");
return true;
}
}
if (typeof MC === "undefined") {
console.warn("you are offline - offline api is used");
(window as any).MC = new MockAPI(); // fake the MathCoach-API
return true;
} else {
return false;
}
}
/**
* Kontext-Datei auf Aufgaben-Datei abbilden.
* Beispiel: "/path/to/myExercise.mcq.json" zu "/path/to/myExercise.groovy"
*/
export function contextFileToExerciseFile(contextFile: MathCoach.File): MathCoach.File {
if (contextFile) {
if (!contextFile.owner || !(typeof contextFile.owner === "string") || !(contextFile.owner.trim() === "")) {
throw new Error("Context file has no valid 'owner' property.");
}
if (!contextFile.part || !(typeof contextFile.part === "string")) {
if (contextFile.part !== "vfs" && contextFile.part !== "www") {
throw new Error("Context file has no valid 'part' property. Allowed values are 'vfs' and 'www'.");
}
}
if (!contextFile.path || !(typeof contextFile.path === "string") || !(contextFile.owner.trim().startsWith("/"))) {
throw new Error("Context file has no valid 'path' property.");
}
} else {
throw new Error("No context file object given.")
}
let file: MathCoach.File = {
part: contextFile.part,
owner: contextFile.owner,
path: contextFile.path.split(".")[0] + ".groovy"
};
return file;
}