@lexho111/plainblog 0.5.10 → 0.5.12

package/Blog.js

@@ -5,16 +5,11 @@ import { URLSearchParams } from "url";
 import Article from "./Article.js";
 import DatabaseModel from "./model/DatabaseModel.js";
 import { fetchData, postData } from "./model/APIModel.js";
-import { formatHTML, header, formatMarkdown, validate } from "./Formatter.js";
-import pkg from "./package.json" with { type: "json" };
+import { formatHTML, header, formatMarkdown, validate } from "./Formatter.js"; // import pkg from "./package.json" with { type: "json" };
 import path from "path";
 import { fileURLToPath } from "url";
-import { exec } from "child_process";
-import { promisify } from "util";
 import { compileStyles, mergeStyles } from "./build-styles.js";
 
-const execPromise = promisify(exec);
-
 export default class Blog {
   constructor() {
     this.database = {
@@ -22,33 +17,60 @@ export default class Blog {
       username: "user",
       password: "password",
       host: "localhost",
-      dbname: "blog.json",
+      dbname: "articles.txt", // x
     };
     this.#title = "";
-    this.articles = [];
-    this.filename = null;
+    this.#articles = [];
     this.#server = null;
     this.#password = "admin";
-    this.styles = "body { font-family: Arial; }";
-    this.scripts = "";
+    this.#styles = "body { font-family: Arial; }";
+    //this.scripts = "";
     this.compiledStyles = "";
-    this.compiledScripts = "";
+    //this.compiledScripts = "";
     this.reloadStylesOnGET = false;
     this.sessions = new Set();
 
-    const version = pkg.version;
-    console.log(`version: ${version}`);
+    this.#version = "0.0.1"; //pkg.version;
+    console.log(`version: ${this.#version}`);
+  }
+
+  /** @returns a json representation of the blog */
+  json() {
+    const serverInfo = this.#server
+      ? {
+          listening: this.#server.listening,
+          address: this.#server.address(),
+        }
+      : null;
+
+    const json = {
+      version: this.#version,
+      title: this.#title,
+      articles: this.#articles,
+      server: serverInfo,
+      compiledStyles: this.compiledStyles,
+      sessions: this.sessions,
+      database: this.database,
+      password: this.#password,
+      styles: this.#styles,
+      reloadStylesOnGET: this.reloadStylesOnGET,
+    };
+
+    return JSON.parse(JSON.stringify(json));
   }
 
   // Private fields
+  #version = null;
   #server = null;
   #password = null;
   #databaseModel;
   #isExternalAPI = false;
   #apiUrl = "";
   #title = "";
+  #articles = [];
+  #styles = "";
   #stylesHash = "";
-  #scriptsHash = "";
+  //#scriptsHash = "";
   #stylesheetPath = "";
 
   setTitle(title) {
@@ -60,7 +82,7 @@ export default class Blog {
   }
 
   setStyle(style) {
-    this.styles += style;
+    this.#styles += style;
   }
 
   set title(t) {
@@ -69,7 +91,7 @@ export default class Blog {
       this.#databaseModel = new DatabaseModel(this.database);
     }
     console.log(`connected to database`);
-    if(t != this.#title && t.length == 0)
+    if (t != this.#title && t.length == 0)
       this.#databaseModel.updateBlogTitle(t);
   }
 
@@ -81,6 +103,10 @@ export default class Blog {
     this.#password = x;
   }
 
+  /**
+   * allows you to inject a specific database implementation
+   * @param {*} adapter a database adapter like PostgresAdapter or SqliteAdapter
+   */
   setDatabaseAdapter(adapter) {
     if (!this.#databaseModel) {
       this.#databaseModel = new DatabaseModel(this.database);
@@ -88,112 +114,134 @@ export default class Blog {
     this.#databaseModel.setDatabaseAdapter(adapter);
   }
 
+  /**
+   * Appends CSS rules to the \<style\>-tag.
+   * @param {string} style - A string containing CSS rules.
+   */
   set style(style) {
-    this.styles += style;
+    this.#styles += style;
   }
 
+  /**
+   * Sets the path(s) to custom CSS or SCSS files to be compiled and used by the blog.
+   * @param {string|string[]} files - A single file path or an array of file paths.
+   */
   set stylesheetPath(files) {
     this.#stylesheetPath = files;
-    console.log(`this.#stylesheetPath: ${this.#stylesheetPath}`)
+    console.log(`this.#stylesheetPath: ${this.#stylesheetPath}`);
   }
 
   addArticle(article) {
-    this.articles.push(article);
+    this.#articles.push(article);
   }
 
-  isAuthenticated(req) {
-      if (!req.headers.cookie) return false;
-      const params = new URLSearchParams(req.headers.cookie.replace(/; /g, "&"));
-      return this.sessions.has(params.get("session"));
-    }
-  
-    async handleLogin(req, res) {
-      const body = await new Promise((resolve, reject) => {
-        let data = "";
-        req.on("data", (chunk) => (data += chunk.toString()));
-        req.on("end", () => resolve(data));
-        req.on("error", reject);
+  #isAuthenticated(req) {
+    if (!req.headers.cookie) return false;
+    const params = new URLSearchParams(req.headers.cookie.replace(/; /g, "&"));
+    return this.sessions.has(params.get("session"));
+  }
+
+  async #handleLogin(req, res) {
+    const body = await new Promise((resolve, reject) => {
+      let data = "";
+      req.on("data", (chunk) => (data += chunk.toString()));
+      req.on("end", () => resolve(data));
+      req.on("error", reject);
+    });
+    const params = new URLSearchParams(body);
+
+    if (params.get("password") === this.#password) {
+      const id = crypto.randomUUID();
+      this.sessions.add(id);
+      res.writeHead(303, {
+        "Set-Cookie": `session=${id}; HttpOnly; Path=/`,
+        Location: "/",
       });
-      const params = new URLSearchParams(body);
-  
-      if (params.get("password") === this.#password) {
-        const id = crypto.randomUUID();
-        this.sessions.add(id);
-        res.writeHead(303, {
-          "Set-Cookie": `session=${id}; HttpOnly; Path=/`,
-          Location: "/",
-        });
-        res.end();
-      } else {
-        res.writeHead(401, { "Content-Type": "text/html" });
-        res.end(`${header("My Blog")}
+      res.end();
+    } else {
+      res.writeHead(401, { "Content-Type": "text/html" });
+      res.end(`${header("My Blog")}
 <body>
 <h1>Unauthorized</h1><p>Please enter the password.<form method="POST">
 <input type="password" name="password" placeholder="Password" />
 <button style="margin: 2px;">Login</button></form>
 </body></html>`);
-      }
     }
-  
-    handleLogout(req, res) {
-      if (req.headers.cookie) {
-        const params = new URLSearchParams(req.headers.cookie.replace(/; /g, "&"));
-        const sessionId = params.get("session");
-        if (this.sessions.has(sessionId)) {
-          this.sessions.delete(sessionId);
-        }
+  }
+
+  #handleLogout(req, res) {
+    if (req.headers.cookie) {
+      const params = new URLSearchParams(
+        req.headers.cookie.replace(/; /g, "&")
+      );
+      const sessionId = params.get("session");
+      if (this.sessions.has(sessionId)) {
+        this.sessions.delete(sessionId);
       }
-      res.writeHead(303, {
-        "Set-Cookie": "session=; HttpOnly; Path=/; Max-Age=0",
-        Location: "/",
-      });
-      res.end();
     }
+    res.writeHead(303, {
+      "Set-Cookie": "session=; HttpOnly; Path=/; Max-Age=0",
+      Location: "/",
+    });
+    res.end();
+  }
 
   /** initializes database */
   async init() {
-    //await this.buildFrontend();
     //this.loadStyles();
     //this.loadScripts();
-    if(this.#stylesheetPath != null) {
-      await this.processStylesheets(this.#stylesheetPath);
+    // if there is a stylesheet path provided, process it
+    if (this.#stylesheetPath != null) {
+      // read file from stylesheet path, compare checksums and write to public/styles.min.css
+      await this.#processStylesheets(this.#stylesheetPath);
     }
-    if(!this.#stylesheetPath) { 
-      // compile and merge hardcoded styles with src/styles.css and write to file "styles.min.css"
+    if (!this.#stylesheetPath) {
+      // this.#styles
+      // src/styles.css
+      // compile and merge hardcoded styles in "this.#styles" with "src/styles.css" and write to file "styles.min.css"
       // which will be imported by webbrowser via '<link rel="stylesheet" href="styles.min.css"...'
-      
+
       const __filename = fileURLToPath(import.meta.url);
       const __dirname = path.dirname(__filename);
       const srcStylePath = path.join(__dirname, "src", "styles.css");
       const publicStylePath = path.join(__dirname, "public", "styles.min.css");
 
       let publicHash = null;
-      try {
-        const publicCSS = await fs.promises.readFile(publicStylePath, "utf8");
-        const match = publicCSS.match(/\/\* source-hash: ([a-f0-9]{64}) \*\//);
-        if (match) {
-          publicHash = match[1];
-        }
-      } catch (err) {
-        // public/styles.min.css doesn't exist, will be created.
-      }
-
       let srcStyles = "";
-      try {
-        srcStyles = await fs.promises.readFile(srcStylePath, "utf8");
-      } catch (err) {
-        // ignore if src/styles.css doesn't exist
-      }
 
-      const combinedStyles = this.styles + srcStyles;
-      const srcHash = crypto.createHash("sha256").update(combinedStyles).digest("hex");
+      await Promise.all([
+        fs.promises
+          .readFile(publicStylePath, "utf8")
+          .then((publicCSS) => {
+            const match = publicCSS.match(
+              /\/\* source-hash: ([a-f0-9]{64}) \*\//
+            );
+            if (match) publicHash = match[1];
+          })
+          .catch((err) => console.error(err)), // public/styles.min.css doesn't exist, will be created.
+        fs.promises
+          .readFile(srcStylePath, "utf8")
+          .then((content) => {
+            srcStyles = content;
+          })
+          .catch((err) => console.error(err)), // ignore if src/styles.css doesn't exist
+      ]);
+
+      const combinedStyles = this.#styles + srcStyles;
+      const srcHash = crypto
+        .createHash("sha256")
+        .update(combinedStyles)
+        .digest("hex");
 
       if (srcHash !== publicHash) {
         console.log("Styles have changed. Recompiling...");
-        const finalStyles = await mergeStyles(this.styles, srcStyles);
+        const finalStyles = await mergeStyles(this.#styles, srcStyles);
         try {
-          await fs.promises.mkdir(path.dirname(publicStylePath), { recursive: true });
-          await fs.promises.writeFile(publicStylePath, finalStyles + `\n/* source-hash: ${srcHash} */`);
+          //await fs.promises.mkdir(path.dirname(publicStylePath), { recursive: true });
+          await fs.promises.writeFile(
+            publicStylePath,
+            finalStyles + `\n/* source-hash: ${srcHash} */`
+          );
         } catch (err) {
           console.error("Failed to write styles to public folder:", err);
         }
@@ -201,7 +249,7 @@ export default class Blog {
     }
     if (this.#isExternalAPI) {
       console.log("external API");
-      await this.loadFromAPI();
+      await this.#loadFromAPI();
     } else {
       console.log(`database: ${this.database.type}`);
       if (!this.#databaseModel) {
@@ -209,17 +257,32 @@ export default class Blog {
       }
       console.log(`connected to database`);
       await this.#databaseModel.initialize();
-      const dbTitle = await this.#databaseModel.getBlogTitle();
-      const dbArticles = await this.#databaseModel.findAll();
-      //console.log(`articles: ${JSON.stringify(dbarticles)}`)
-      console.log(`dbArticles.length: ${dbArticles.length}`)
-      if(dbArticles.length == 0) {
-        dbArticles.push(new Article("Sample Entry #1", "Prow scuttle parrel provost Sail ho shrouds spirits boom mizzenmast yardarm. Pinnace holystone mizzenmast quarter crow's nest nipperkin grog yardarm hempen halter furl. Swab barque interloper chantey doubloon starboard grog black jack gangway rutters.", new Date()));
-        dbArticles.push(new Article("Sample Entry #2", "Deadlights jack lad schooner scallywag dance the hempen jig carouser broadside cable strike colors. Bring a spring upon her cable holystone blow the man down spanker Shiver me timbers to go on account lookout wherry doubloon chase. Belay yo-ho-ho keelhaul squiffy black spot yardarm spyglass sheet transom heave to.", new Date())); 
+      const [dbTitle, dbArticles] = await Promise.all([
+        this.#databaseModel.getBlogTitle(),
+        this.#databaseModel.findAll(),
+      ]);
+
+      if (dbArticles.length == 0) {
+        dbArticles.push(
+          new Article(
+            "Sample Entry #1",
+            "Prow scuttle parrel provost Sail ho shrouds spirits boom mizzenmast yardarm. Pinnace holystone mizzenmast quarter crow's nest nipperkin grog yardarm hempen halter furl. Swab barque interloper chantey doubloon starboard grog black jack gangway rutters.",
+            new Date()
+          )
+        );
+        dbArticles.push(
+          new Article(
+            "Sample Entry #2",
+            "Deadlights jack lad schooner scallywag dance the hempen jig carouser broadside cable strike colors. Bring a spring upon her cable holystone blow the man down spanker Shiver me timbers to go on account lookout wherry doubloon chase. Belay yo-ho-ho keelhaul squiffy black spot yardarm spyglass sheet transom heave to.",
+            new Date()
+          )
+        );
       }
-      if(this.reloadStylesOnGET) console.log("reload scripts and styles on GET-Request");
+      if (this.reloadStylesOnGET)
+        console.log("reload scripts and styles on GET-Request");
       let title = "";
-      if (this.#title != null && this.#title.length > 0) title = this.#title; // use blog title if set
+      if (this.#title != null && this.#title.length > 0)
+        title = this.#title; // use blog title if set
       else title = dbTitle; // use title from the database
       const responseData = { title: title, articles: dbArticles };
       this.#applyBlogData(responseData);
@@ -244,12 +307,16 @@ export default class Blog {
       const newArticleData = { title, content };
       try {
         // Save the new article to the database via the ApiServer
-        if (this.#databaseModel) await this.#databaseModel.save(newArticleData);
-        if (this.#isExternalAPI) await postData(this.#apiUrl, newArticleData);
+        const promises = [];
+        if (this.#databaseModel)
+          promises.push(this.#databaseModel.save(newArticleData));
+        if (this.#isExternalAPI)
+          promises.push(postData(this.#apiUrl, newArticleData));
+        await Promise.all(promises);
         // Add the article to the local list for immediate display
-        this.articles.unshift(new Article(title, content, new Date()));
+        this.#articles.unshift(new Article(title, content, new Date()));
         // remove sample entries
-        this.articles = this.articles.filter(
+        this.#articles = this.#articles.filter(
           (art) =>
             art.title !== "Sample Entry #1" && art.title !== "Sample Entry #2"
         );
@@ -286,18 +353,18 @@ export default class Blog {
 </body></html>`);
           return;
         } else if (req.method === "POST") {
-          await this.handleLogin(req, res);
+          await this.#handleLogin(req, res);
           return;
         }
       }
 
       if (req.url === "/logout") {
-        this.handleLogout(req, res);
+        this.#handleLogout(req, res);
         return;
       }
       // POST new article
       if (req.method === "POST" && req.url === "/") {
-        if (!this.isAuthenticated(req)) {
+        if (!this.#isAuthenticated(req)) {
           res.writeHead(403, { "Content-Type": "text/plain" });
           res.end("Forbidden");
           return;
@@ -308,14 +375,14 @@ export default class Blog {
         // load articles
 
         // reload styles and scripts on (every) request
-        if(this.reloadStylesOnGET) {
+        if (this.reloadStylesOnGET) {
           if (this.#stylesheetPath) {
-            await this.processStylesheets(this.#stylesheetPath);
+            await this.#processStylesheets(this.#stylesheetPath);
           }
         }
 
         let loggedin = false;
-        if (!this.isAuthenticated(req)) { 
+        if (!this.#isAuthenticated(req)) {
           // login
           loggedin = false;
         } else {
@@ -338,7 +405,10 @@ export default class Blog {
           const __filename = fileURLToPath(import.meta.url);
           const __dirname = path.dirname(__filename);
           const publicDir = path.join(__dirname, "public");
-          const parsedUrl = new URL(req.url, `http://${req.headers.host || "localhost"}`);
+          const parsedUrl = new URL(
+            req.url,
+            `http://${req.headers.host || "localhost"}`
+          );
           const filePath = path.join(publicDir, parsedUrl.pathname);
 
           if (filePath.startsWith(publicDir)) {
@@ -363,6 +433,7 @@ export default class Blog {
             }
           }
         } catch (err) {
+          console.error(err);
           // Continue to 404
         }
 
@@ -374,8 +445,11 @@ export default class Blog {
 
     this.#server = server;
 
-    return new Promise((resolve) => {
-      this.#server.listen(port, () => {
+    return new Promise((resolve, reject) => {
+      const errorHandler = (err) => reject(err);
+      this.#server.once("error", errorHandler);
+      this.#server.listen(port, "127.0.0.1", () => {
+        this.#server.removeListener("error", errorHandler);
         console.log(`server running at http://localhost:${port}/`);
         resolve(); // Resolve the promise when the server is listening
       });
@@ -385,12 +459,14 @@ export default class Blog {
   async closeServer() {
     return new Promise((resolve, reject) => {
       if (this.#server) {
+        // if server is running
         this.#server.close((err) => {
-          if (err) return reject(err);
+          if (err && err.code !== "ERR_SERVER_NOT_RUNNING") return reject(err);
           console.log("Server closed.");
           resolve();
         });
       } else {
+        // server is not running
         resolve(); // Nothing to close
       }
     });
@@ -398,19 +474,23 @@ export default class Blog {
 
   /** Populates the blog's title and articles from a data object. */
   #applyBlogData(data) {
-    this.articles = []; // Clear existing articles before loading new ones
+    this.#articles = []; // Clear existing articles before loading new ones
     this.#title = data.title;
-    // Assuming the API returns an array of objects with title and content
+    // Assuming data contains a title and an array of articles with title and content
     if (data.articles && Array.isArray(data.articles)) {
       for (const articleData of data.articles) {
-        const article = new Article(articleData.title, articleData.content, articleData.createdAt);
-        article.id = articleData.id;
+        const article = new Article(
+          articleData.title,
+          articleData.content,
+          articleData.createdAt
+        );
+        article.id = articleData.id; // TODO x
         this.addArticle(article);
       }
     }
   }
 
-  async loadFromAPI() {
+  async #loadFromAPI() {
     const data = await fetchData(this.#apiUrl);
     if (data) {
       this.#applyBlogData(data);
@@ -423,35 +503,40 @@ export default class Blog {
     const url = new URL(req.url, `http://${req.headers.host || "localhost"}`);
     const pathname = url.pathname;
 
-    if(req.method === "GET") {
-    if(pathname === "/api" || pathname === "/api/") {
-      res.writeHead(200, { "Content-Type": "application/json" });
-      const data = {
-        title: this.title
+    if (req.method === "GET") {
+      if (pathname === "/api" || pathname === "/api/") {
+        res.writeHead(200, { "Content-Type": "application/json" });
+        const data = {
+          title: this.title,
+        };
+        res.end(JSON.stringify(data));
+      }
+      // GET all blog data
+      if (pathname === "/api/articles") {
+        // Use 'offset' param as startId (filter) to get items starting at ID
+        const pStartID = parseInt(url.searchParams.get("startID"));
+        const startID = !isNaN(pStartID) ? pStartID : null;
+        const pEndID = parseInt(url.searchParams.get("endID"));
+        const endID = !isNaN(pEndID) ? pEndID : null;
+        const limit = parseInt(url.searchParams.get("limit")) || 10;
+        // controller
+        res.writeHead(200, { "Content-Type": "application/json" });
+        const dbArticles = await this.#databaseModel.findAll(
+          limit,
+          0,
+          startID,
+          endID
+        );
+        const responseData = {
+          title: this.title, // Keep the title from the original constant
+          articles: dbArticles,
+        };
+        res.end(JSON.stringify(responseData));
       }
-      res.end(JSON.stringify(data));
-    }
-    // GET all blog data
-    if (pathname === "/api/articles") {
-      // Use 'offset' param as startId (filter) to get items starting at ID
-      const pStartID = parseInt(url.searchParams.get("startID"));
-      const startID = !isNaN(pStartID) ? pStartID : null;
-      const pEndID = parseInt(url.searchParams.get("endID"));
-      const endID = !isNaN(pEndID) ? pEndID : null;
-      const limit = parseInt(url.searchParams.get("limit")) || 10;
-      // controller
-      res.writeHead(200, { "Content-Type": "application/json" });
-      const dbArticles = await this.#databaseModel.findAll(limit, 0, startID, endID);
-      const responseData = {
-        title: this.title, // Keep the title from the original constant
-        articles: dbArticles,
-      };
-      res.end(JSON.stringify(responseData));
-    }
 
-    // POST a new article
-  } else if (req.method === "POST" && pathname === "/api/articles") {
-      if (!this.isAuthenticated(req)) {
+      // POST a new article
+    } else if (req.method === "POST" && pathname === "/api/articles") {
+      if (!this.#isAuthenticated(req)) {
         res.writeHead(403, { "Content-Type": "application/json" });
         res.end(JSON.stringify({ error: "Forbidden" }));
         return;
@@ -481,7 +566,7 @@ export default class Blog {
   print() {
     const data = {
       title: this.title,
-      articles: this.articles,
+      articles: this.#articles,
     };
     const markdown = formatMarkdown(data);
     console.log(markdown);
@@ -491,12 +576,12 @@ export default class Blog {
   async toHTML(loggedin) {
     const data = {
       title: this.title,
-      articles: this.articles,
+      articles: this.#articles,
       loggedin,
-      login: ""
+      login: "",
     };
 
-    if(loggedin) data.login = `<a href="/logout">logout</a>`;
+    if (loggedin) data.login = `<a href="/logout">logout</a>`;
     else data.login = `<a href="/login">login</a>`;
 
     const html = formatHTML(data);
@@ -505,21 +590,21 @@ export default class Blog {
   }
 
   /**
-   * Loads files, generates checksums and compiles sass files to css if anything changed
+   * read files, compare checksums, compile and write to public/styles.min.css
    * @param {string[]} files - Array of css/scss file paths to process.
    */
-  async processStylesheets(files) {
-    console.log("process stylesheets")
-    
+  async #processStylesheets(files) {
+    console.log("process stylesheets");
+
     // Normalize input to array (handles string or array)
     // "file1.css" --> ["file1.css"]
     // ["file1.css", "file2.css",...]
     const fileList = Array.isArray(files) ? files : [files];
-
-    const __filename = fileURLToPath(import.meta.url);
-    const __dirname = path.dirname(__filename);
     const styleFiles = fileList.filter(
-      (f) => typeof f === "string" && (f.endsWith(".scss") || f.endsWith(".css")) && !f.endsWith(".min.css")
+      (f) =>
+        typeof f === "string" &&
+        (f.endsWith(".scss") || f.endsWith(".css")) &&
+        !f.endsWith(".min.css")
     );
     //const scriptFiles = files.filter((f) => f.endsWith(".js") && !f.endsWith(".min.js"));
 
@@ -529,7 +614,7 @@ export default class Blog {
       const fileData = await Promise.all(
         styleFiles.sort().map(async (f) => {
           const content = await fs.promises.readFile(f, "utf-8");
-          if(content == "") throw new Error("Invalid Filepath or empty file!");
+          if (content == "") throw new Error("Invalid Filepath or empty file!");
           return { path: f, content };
         })
       );
@@ -550,7 +635,7 @@ export default class Blog {
       if (currentHash !== this.#stylesHash) {
         console.log("Style assets have changed. Recompiling...");
         this.#stylesHash = currentHash;
-        
+
         // Compile styles using the standalone script from build-styles.js
         this.compiledStyles = await compileStyles(fileData);
 
@@ -558,13 +643,13 @@ export default class Blog {
         const __filename = fileURLToPath(import.meta.url);
         const __dirname = path.dirname(__filename);
         const publicDir = path.join(__dirname, "public");
-        
+
         await fs.promises.writeFile(
           path.join(publicDir, "styles.min.css"),
           this.compiledStyles + `\n/* source-hash: ${currentHash} */`
         );
       } else {
-        console.log("styles are up-to-date")
+        console.log("styles are up-to-date");
       }
     }
   }