@vandenberghinc/volt 1.1.2

package/backend/src/blacklist.ts

@@ -0,0 +1,69 @@
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+
+import { vlib } from "@vinc";
+
+// ---------------------------------------------------------
+// Blacklist.
+
+export class Blacklist {
+
+    private api_key: string;
+    private cache: Map<string, boolean>;
+
+    constructor({
+    	api_key, // honey pot api key
+		_server,
+	}: {
+        api_key: string,
+        _server: any,
+    }) {
+
+		// Checks.
+		vlib.Scheme.verify({object: arguments[0], check_unknown: true, scheme: {
+            api_key: "string",
+        }});
+
+		// Arguments.
+		this.api_key = api_key;
+
+		// Attributes.
+		this.cache = new Map();
+    }
+
+    // Verify, returns true on allowed and false on not allowed.
+    async verify(ip: string): Promise<boolean> {
+
+        throw new Error("Deprecated");
+
+    	if (this.cache.has(ip)) {
+    		return this.cache.get(ip) as boolean;
+    	}
+    	let result;
+        await new Promise<void>((resolve) => {
+            // @ts-expect-error
+            dns.resolveTxt(
+                `${this.api_key}.${ip.split('.').reverse().join('.')}.dnsbl.httpbl.org`,
+                (error, records) => {
+                    if (error) {
+                        result = true;
+                        console.error(error);
+                    } else {
+                    	result = true;
+                        console.log(records);
+                    }
+                    resolve();
+                },
+            );
+        })
+        this.cache.set(ip, result);
+        return result;
+    }
+}
+
+// ---------------------------------------------------------
+// Exports.
+
+module.exports = Blacklist;

package/backend/src/cli.js

@@ -0,0 +1,245 @@
+#!/usr/bin/env node
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+
+// ---------------------------------------------------------
+// Imports.
+
+import { vlib } from "@vinc";
+import { vhighlight } from "@vinc";
+import * as volt from "./volt.js";
+
+// ---------------------------------------------------------
+// Global constants.
+
+const CONFIG_PATHS = [
+    "./server.json",
+    "./server.js",
+    "./server/server.json",
+    "./server/server.js",
+];
+
+// ---------------------------------------------------------
+// CLI.
+
+// Initialize the server.
+const initialize_server = async (path = null, source = "") => {
+    if (source == null) {
+        source = "";
+    }
+    if (path == null) {
+        path = CONFIG_PATHS.iterate((subpath) => {
+            let path = new vlib.Path(source + subpath);
+            path = path.abs();
+            if (path.exists()) {
+                return path;
+            }
+        })
+        if (path == null) {
+            throw Error(`Unable to find a configuration file, either specify a the path to the configuration file using argument "--config". Or create a configuration file at one of the following sub paths: ${CONFIG_PATHS.join(", ")}.`);
+        }
+    }
+    else {
+        path = new vlib.Path(path);
+    }
+    if (!path.exists()) {
+        throw new Error(`Server source path "${path.str()}" does not exist.`)
+    }
+    if (path.extension() == ".js") {
+        let config;
+        try {
+            config = (await import(path.abs().str())).default;
+        } catch (e) {
+            throw new Error(`Failed to import "${path.str()}": ${e.message}`)
+        }
+        if (config.server) {
+            config = config.server;
+        }
+        if (config instanceof volt.Server) { return {path, server: config}; }
+        return {path, server: new volt.Server(config)}
+    
+    } else {
+        return {path, server: new volt.Server(path.load_sync({type: "object"}))};
+    }
+}
+
+// Create the CLI.
+/*  @docs:
+ *  @lang: CLI
+ *  @name: CLI
+ *  @title: VWeb CLI
+ *  @description: The VWeb CLI.
+ *  @usage: 
+ *      @CLI:
+ *          $ volt --start
+ */
+const cli = new vlib.CLI({
+    name: "volt",
+    description: 
+`The volt cli. The cli must be able to access the initialized server instance or its configuration object. This can be achieved in two ways.
+
+1. A JSON file can be used to create the settings for the server.
+   The file can reside at the following project locations:
+       ./server.json
+       ./server/server.json
+
+2. Using a JavaScript configuration file.
+   The JS server file must export an object with the server's settings (parameters) or an initialized instance of volt.Server.
+   Both objects must either be exported as 'module.exports = server' or as 'module.exports = {server: server}'.
+   The file can reside at the following project locations:
+       ./server.js
+       ./server/server.js
+`,
+    version: "1.1.1",
+    commands: [
+
+        // Start.
+        /*  @docs:
+         *  @lang: CLI
+         *  @parent: CLI
+         *  @title: Start
+         *  @name: --start
+         *  @description: Start the website (daemon).
+         *  @param:
+         *      @name: --source
+         *      @type: string
+         *      @desc: The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.
+         *      @con_required: true
+         *  @param:
+         *      @name: --config
+         *      @type: string
+         *      @desc: The path to the configuration file.
+         *      @con_required: true
+         *  @param:
+         *      @name: --daemon
+         *      @type: boolean
+         *      @desc: Flag to start the service daemon.
+         *      @con_required: true
+         *  @usage: 
+         *      @CLI:
+         *          $ cd path/to/my/website && volt --start
+         *          $ volt --start --source path/to/my/website
+         *          $ volt --start --config path/to/my/website/config.js
+         */
+        {
+            id: "--start",
+            description: "Start the website (daemon).",
+            examples: {
+                "Start": "cd path/to/my/website && volt --start",
+                "Start": "volt --start --source path/to/my/website",
+                "Start": "volt --start --config path/to/my/website/config.js",
+            },
+            args: [
+                {id: "--source", type: "string", description: `The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.`},
+                {id: "--config", type: "string", description: `The path to the configuration file.`},
+                {id: "--daemon", type: "boolean", description: `Flag to start the service daemon.`},
+                {id: "--preview", type: "string", description: `Enable a preview browser in development mode.`},
+            ],
+            callback: async ({
+                source = null,
+                config = null,
+                daemon = false,
+                preview = null,
+            }) => {
+                const {path, server} = await initialize_server(config, source);
+                if (preview == null && vlib.cli.present("--preview")) {
+                    preview = "chrome";
+                }
+                if (preview) {
+                    await server.start_browser_preview(preview)
+                }
+
+                // Service daemon.
+                if (daemon) {
+
+                    // Server daemon.
+                    if (server.db.daemon) {
+                        await server.db.daemon.stop()
+                        if (server.db.daemon.exists()) {
+                            await server.db.daemon.update()
+                        } else {
+                            await server.db.daemon.create()
+                        }
+                        await server.db.daemon.start()
+                    }
+
+                    // Server daemon.
+                    if (!server.daemon) { cli.throw_error("The server service daemon is disabled."); }
+                    await server.daemon.stop()
+                    if (server.daemon.exists()) {
+                        await server.daemon.update()
+                    } else {
+                        await server.daemon.create()
+                    }
+                    await server.daemon.start()
+                }
+
+                // Development server.
+                else {
+                    if (server.file_watcher) {
+                        server.file_watcher.config = path.str();
+                    }
+                    await server.start();
+                }
+            }
+        },
+
+        // Stop.
+        /*  @docs:
+         *  @lang: CLI
+         *  @parent: CLI
+         *  @title: Stop
+         *  @name: --stop
+         *  @description: Stop the website service daemon.
+         *  @param:
+         *      @name: --source
+         *      @type: string
+         *      @desc: The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.
+         *      @con_required: true
+         *  @param:
+         *      @name: --config
+         *      @type: string
+         *      @desc: The path to the configuration file.
+         *      @con_required: true
+         *  @usage: 
+         *      @CLI:
+         *          $ volt --stop
+         *          $ volt --stop --source path/to/my/website
+         *          $ volt --stop --config path/to/my/website/config.js
+         */
+        {
+            id: "--stop",
+            description: "Stop the website service daemon.",
+            examples: {
+                "Stop": "cd path/to/my/website && volt --stop",
+                "Stop": "volt --stop --source path/to/my/website",
+                "Stop": "volt --stop --config path/to/my/website/config.js",
+            },
+            args: [
+                {id: "--source", type: "string", description: `The source path to the website, the configuration file will be automatically loaded. It must reside at one of the default config sub paths.`},
+                {id: "--config", type: "string", description: `The path to the configuration file.`},
+            ],
+            callback: async ({
+                source = null,
+                config = null,
+            }) => {
+                const {server} = await initialize_server(config, source);
+
+                // Server daemon.
+                if (server.db.daemon) {
+                    await server.db.daemon.stop()
+                }
+
+                // Server daemon.
+                if (!server.daemon) { cli.throw_error("The server service daemon is disabled."); }
+                await server.daemon.stop()
+            }
+        },
+
+    ],
+});
+
+// Start.
+cli.start();