josh/src/main/js/Persistence.ts

import Cookies from "js-cookie";
import {Environment} from "./Environment";
import {Directory, FileSystem, Node} from "./FileSystem";
import {InputHistory} from "./InputHistory";
import {UserList} from "./UserList";


/**
 * Manages persistence of state.
 */
export class Persistence {
    /**
     * Removes all persistent storage.
     */
    static reset(): void {
        localStorage.removeItem("//files");
        localStorage.removeItem("//history");
        localStorage.removeItem("//version");
        sessionStorage.removeItem("//env");
        sessionStorage.removeItem("//has-updated");
        Cookies.remove("poweroff");
    }


    ///
    /// Long-term storage
    ///

    /**
     * Returns true if and only if a file system is stored in the persistent storage.
     *
     * @return true if and only if a file system is stored in the persistent storage
     */
    static hasFileSystem(): boolean {
        return localStorage.getItem("//files") !== null;
    }

    /**
     * Deserializes a file system from persistent storage, or returns the default file system if the deserialization
     * failed.
     *
     * @return the deserialized file system from persistent storage
     */
    static getFileSystem(): FileSystem {
        const fileString = localStorage.getItem("//files");
        if (fileString !== null) {
            try {
                const parsedFiles = Node.deserialize(fileString);
                if (parsedFiles instanceof Directory)
                    return new FileSystem(parsedFiles);
                else
                    console.warn("'files' cookie contains non-directory.");
            } catch (error) {
                console.warn("Failed to deserialize 'files' storage.", error);
            }
        }

        return new FileSystem();
    }

    /**
     * Persists the given file system.
     *
     * @param fileSystem the file system to persist
     */
    static setFileSystem(fileSystem: FileSystem): void {
        localStorage.setItem("//files", JSON.stringify(fileSystem.root));
    }

    /**
     * Deserializes a history from persistent storage, or returns the default history if the deserialization failed.
     *
     * @return the deserialized history from persistent storage
     */
    static getHistory(): InputHistory {
        try {
            return new InputHistory(JSON.parse(localStorage.getItem("//history") ?? "[]"));
        } catch (error) {
            console.warn("Failed to deserialize 'history' storage.", error);
            return new InputHistory();
        }
    }

    /**
     * Persists the given history.
     *
     * @param history the history to persist
     */
    static setHistory(history: InputHistory): void {
        localStorage.setItem("//history", JSON.stringify(history.entries));
    }

    /**
     * Returns the version number of the scripts that were used the last time the user visited the website.
     *
     * @return the version number from persistent storage
     */
    static getVersion(): string {
        return localStorage.getItem("//version") ?? "%%VERSION_NUMBER%%";
    }

    /**
     * Sets the version number of the scripts that were used the last time the user visited the website.
     *
     * @param version the version number of the scripts that were used the last time the user visited the website
     */
    static setVersion(version: string) {
        localStorage.setItem("//version", version);
    }


    ///
    /// Short-term storage
    ///

    /**
     * Returns `true` if and only if the server is "turned off".
     *
     * @return `true` if and only if the server is "turned off"
     */
    static getPoweroff(): boolean {
        try {
            return JSON.parse(Cookies.get("poweroff") ?? "false");
        } catch (error) {
            console.warn("Failed to deserialize 'poweroff' cookie.", error);
            return false;
        }
    }

    /**
     * Stores whether the server is "turned off".
     *
     * @param value whether the server is "turned off"
     */
    static setPoweroff(value: boolean): void {
        Cookies.set("poweroff", "" + value, {
            expires: new Date(new Date().setSeconds(new Date().getSeconds() + 30)),
            path: "/",
            secure: true,
            sameSite: "lax"
        });
    }

    /**
     * Deserializes an environment from persistent storage, or returns the default environment if the deserialization
     * failed.
     *
     * @param userList the list of users used to validate the `user` environment variable
     * @return the deserialized environment from persistent storage
     */
    static getEnvironment(userList: UserList): Environment {
        const environmentString = sessionStorage.getItem("//env") ?? "{}";

        let environment: Environment;
        try {
            environment = new Environment(["cwd", "home", "user", "status"], JSON.parse(environmentString));
        } catch (error) {
            console.warn("Failed to set environment from cookie.");
            environment = new Environment(["cwd", "home", "user", "status"]);
        }

        // Check user in environment
        if (!environment.has("user")) {
            environment.set("user", "florine");
        } else if (environment.get("user") !== "" && !userList.has(environment.get("user"))) {
            console.warn(`Invalid user '${environment.get("user")}' in environment.`);
            environment.set("user", "florine");
        }

        // Set home directory
        environment.set("home", userList.get(environment.get("user"))?.home ?? "/");

        // Check cwd in environment
        if (!environment.has("cwd"))
            environment.set("cwd", environment.get("home"));

        // Set status
        environment.set("status", "0");

        return environment;
    }

    /**
     * Persists the given environment.
     *
     * @param environment the environment to persist
     */
    static setEnvironment(environment: Environment): void {
        sessionStorage.setItem("//env", JSON.stringify(environment.variables));
    }

    /**
     * Returns `true` if and only if the terminal was updated in this session.
     *
     * @return `true` if and only if the terminal was updated in this session
     */
    static getWasUpdated(): boolean {
        try {
            return JSON.parse(sessionStorage.getItem("//has-updated") ?? "false");
        } catch (error) {
            console.warn("Failed to deserialize 'poweroff' cookie.", error);
            return false;
        }
    }

    /**
     * Stores whether the terminal was updated in this session.
     *
     * @param value whether the terminal was updated in this session
     */
    static setWasUpdated(value: boolean): void {
        sessionStorage.setItem("//has-updated", "" + value);
    }
}