X-Git-Url: https://git.r.bdr.sh/rbdr/blog/blobdiff_plain/6f72ad0f8b1d147a3d2e27db539a0e17ca2ac917..24de2f063e5dfcad0086d1dc81de3cf012a00e4c:/lib/blog.js

diff --git a/lib/blog.js b/lib/blog.js
index 6b3397f..6b831f7 100644
--- a/lib/blog.js
+++ b/lib/blog.js
@@ -1,33 +1,42 @@
 'use strict';
 
+const { access, mkdir, readdir, readFile, rm, writeFile } = require('fs/promises');
 const { exec } = require('child_process');
-const { access, mkdir, readdir, readFile, rmdir, writeFile } = require('fs/promises');
-const { template } = require('dot');
 const { ncp } = require('ncp');
-const { join } = require('path');
-const Marked = require('marked');
+const { basename, resolve, join } = require('path');
+const ParseGemini = require('gemini-to-html/parse');
+const RenderGemini = require('gemini-to-html/render');
 const { debuglog, promisify } = require('util');
 
+// Generators for the Blog
+
+const StaticGenerator = require('./generators/static');
+const HTMLGenerator = require('./generators/html');
+const RSSGenerator = require('./generators/rss');
+const TXTGenerator = require('./generators/txt');
+
+// Archiving Methods
+
+const GemlogArchiver = require('./archivers/gemlog');
+
 const internals = {
 
   // Promisified functions
+  exec: promisify(exec),
   ncp: promisify(ncp),
 
-  exec: promisify(exec),
   debuglog: debuglog('blog'),
 
   // constants
 
-  kAssetsDirectoryName: 'assets',
-  kIndexName: 'index.html',
   kFileNotFoundError: 'ENOENT',
-  kMarkdownRe: /\.md$/i,
+  kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 
   // Strings
 
   strings: {
-    markdownNotFound: 'Markdown file was not found in blog directory. Please update.'
+    geminiNotFound: 'Gemini file was not found in blog directory. Please update.'
   }
 };
 
@@ -36,7 +45,7 @@ const internals = {
  * updating posts, and handling the publishing.
  *
  * @class Blog
- * @param {Potluck.tConfiguration} config the initialization options to
+ * @param {Blog.tConfiguration} config the initialization options to
  * extend the instance
  */
 module.exports = class Blog {
@@ -61,6 +70,7 @@ module.exports = class Blog {
 
     await this._ensurePostsDirectoryExists();
     await this._shift();
+    await this._ensurePostsDirectoryExists(join(this.postsDirectory, '0'));
     await this.update(postLocation);
   }
 
@@ -81,7 +91,9 @@ module.exports = class Blog {
     await this._copyPost(postLocation);
     await this._writeMetadata(metadata);
 
-    await this._generate();
+    await this._archive(postLocation);
+
+    await this.generate();
   }
 
   /**
@@ -92,44 +104,86 @@ module.exports = class Blog {
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
-  publish() {
+  async publish(bucket) {
 
-    console.error('Publishing not yet implemented');
-    return Promise.resolve();
+    internals.debuglog(`Publishing to ${bucket}`);
+    try {
+      await internals.exec('which aws');
+    }
+    catch (err) {
+      console.error('Please install and configure AWS CLI to publish.');
+    }
+
+    try {
+      await internals.exec(`aws s3 sync --acl public-read --delete ${this.staticDirectory} s3://${bucket}`);
+      await internals.exec(`aws s3 cp --content-type 'text/plain; charset=utf-8 ' --acl public-read ${this.staticDirectory}/index.txt s3://${bucket}`);
+    }
+    catch (err) {
+      console.error('Failed to publish');
+      console.error(err.stderr);
+    }
+
+    internals.debuglog('Finished publishing');
   }
 
-  // Parses markdown for each page, copies assets and generates index.
+  /**
+   * Publishes the archive to a host using rsync. Currently assumes
+   * gemlog archive.
+   *
+   * @function publishArchive
+   * @memberof Blog
+   * @return {Promise<undefined>} empty promise, returns no value
+   * @instance
+   */
+  async publishArchive(host) {
 
-  async _generate() {
+    internals.debuglog(`Publishing archive to ${host}`);
+    try {
+      await internals.exec('which rsync');
+    }
+    catch (err) {
+      console.error('Please install rsync to publish the archive.');
+    }
 
-    const assetsTarget = join(this.staticDirectory, internals.kAssetsDirectoryName);
-    const indexTarget = join(this.staticDirectory, internals.kIndexName);
-    const indexLocation = join(this.templatesDirectory, internals.kIndexName);
-    const posts = [];
+    try {
+      const gemlogPath = resolve(join(__dirname, '../', '.gemlog'));
+      internals.debuglog(`Reading archive from ${gemlogPath}`);
+      await internals.exec(`rsync -r ${gemlogPath}/ ${host}`);
+    }
+    catch (err) {
+      console.error('Failed to publish archive');
+      console.error(err.stderr);
+    }
+
+    internals.debuglog('Finished publishing');
+  }
 
-    internals.debuglog(`Removing ${assetsTarget}`);
-    await rmdir(assetsTarget, { recursive: true });
+  // Parses Gemini for each page, copies assets and generates index.
 
-    for (let i = 0; i < this.maxPosts; ++i) {
-      const sourcePath = join(this.postsDirectory, `${i}`);
+  async generate() {
 
-      try {
-        await access(this.postsDirectory);
+    internals.debuglog('Generating output');
+
+    const posts = await this._readPosts();
 
-        const assetsSource = join(sourcePath, internals.kAssetsDirectoryName);
-        const postContentPath = await this._findBlogContent(sourcePath);
+    await StaticGenerator(this.postsDirectory, this.staticDirectory, posts);
+    await HTMLGenerator(this.templatesDirectory, this.staticDirectory, posts);
+    await RSSGenerator(this.templatesDirectory, this.staticDirectory, posts);
+    await TXTGenerator(this.templatesDirectory, this.staticDirectory, posts);
 
-        internals.debuglog(`Copying ${assetsSource} to ${assetsTarget}`);
-        await internals.ncp(assetsSource, assetsTarget);
+    await GemlogArchiver(this.archiveDirectory);
+  }
+
+  // Reads the posts into an array
 
-        internals.debuglog(`Reading ${postContentPath}`);
-        const postContent = await readFile(postContentPath, { encoding: 'utf8' });
+  async _readPosts() {
 
-        internals.debuglog('Parsing markdown');
-        posts.push({
-          html: Marked(postContent),
-          id: i + 1
-        });
+    internals.debuglog('Reading posts');
+    const posts = [];
+
+    for (let i = 0; i < this.maxPosts; ++i) {
+      try {
+        posts.push(await this._readPost(i));
       }
       catch (error) {
         if (error.code === internals.kFileNotFoundError) {
@@ -141,12 +195,32 @@ module.exports = class Blog {
       }
     }
 
-    internals.debuglog(`Reading ${indexLocation}`);
-    const indexTemplate = await readFile(indexLocation, { encoding: 'utf8' });
+    return posts;
+  }
+
+  // Reads an individual post
+
+  async _readPost(index=0) {
+      const postSourcePath = join(this.postsDirectory, `${index}`);
 
-    internals.debuglog('Generating HTML');
-    const indexHtml = template(indexTemplate)({ posts });
-    await writeFile(indexTarget, indexHtml);
+      internals.debuglog(`Reading ${postSourcePath}`);
+
+      await access(postSourcePath);
+
+      const metadata = await this._getMetadata(index);
+
+      const postContentPath = await this._findBlogContent(postSourcePath);
+      internals.debuglog(`Reading ${postContentPath}`);
+      const postContent = await readFile(postContentPath, { encoding: 'utf8' });
+
+      internals.debuglog('Parsing Gemini');
+      return {
+        ...metadata,
+        location: postSourcePath,
+        index,
+        html: RenderGemini(ParseGemini(postContent)),
+        raw: postContent
+      };
   }
 
   // Shift the posts, delete any remainder.
@@ -154,14 +228,13 @@ module.exports = class Blog {
   async _shift() {
 
 
-    for (let i = this.maxPosts - 1; i >= 0; --i) {
+    for (let i = this.maxPosts - 1; i >= 1; --i) {
       const targetPath = join(this.postsDirectory, `${i}`);
       const sourcePath = join(this.postsDirectory, `${i - 1}`);
 
       try {
-        internals.debuglog(`Removing ${targetPath}`);
-        await rmdir(targetPath, { recursive: true });
-
+        internals.debuglog(`Archiving ${targetPath}`);
+        await rm(targetPath, { recursive: true, force: true });
         await access(sourcePath); // check the source path
 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);
@@ -178,15 +251,36 @@ module.exports = class Blog {
     }
   }
 
+  // Moves older posts to the archive
+
+  async _archive() {
+    internals.debuglog('Archiving post');
+    const post = await this._readPost(0);
+    await this._ensureDirectoryExists(this.archiveDirectory);
+
+    const targetPath = join(this.archiveDirectory, post.id);
+
+    try {
+      internals.debuglog(`Removing ${targetPath}`);
+      await rm(targetPath, { recursive: true });
+    } 
+    finally {
+      internals.debuglog(`Adding ${post.location} to ${targetPath}`);
+      await this._ensureDirectoryExists(targetPath);
+      await internals.ncp(post.location, targetPath);
+      internals.debuglog(`Added ${post.location} to ${targetPath}`);
+    }
+  }
+
   // Attempts to read existing metadata. Otherwise generates new set.
 
-  async _getMetadata() {
+  async _getMetadata(index = 0) {
 
-    const metadataTarget = join(this.postsDirectory, '0', internals.kMetadataFilename);
+    const metadataTarget = join(this.postsDirectory, String(index), internals.kMetadataFilename);
 
     try {
       internals.debuglog(`Looking for metadata at ${metadataTarget}`);
-      return await readFile(metadataTarget);
+      return JSON.parse(await readFile(metadataTarget, { encoding: 'utf8' }));
     }
     catch (e) {
       internals.debuglog(`Metadata not found or unreadable. Generating new set.`);
@@ -196,7 +290,7 @@ module.exports = class Blog {
         createdOn
       };
 
-      return JSON.stringify(metadata, null, 2);
+      return metadata;
     }
   }
 
@@ -207,7 +301,7 @@ module.exports = class Blog {
 
     const metadataTarget = join(this.postsDirectory, '0', internals.kMetadataFilename);
     internals.debuglog(`Writing ${metadataTarget}`);
-    await writeFile(metadataTarget, metadata);
+    await writeFile(metadataTarget, JSON.stringify(metadata, null, 2));
   }
 
   // Copies a post directory to the latest slot.
@@ -215,26 +309,32 @@ module.exports = class Blog {
   async _copyPost(postLocation) {
 
     const targetPath = join(this.postsDirectory, '0');
+    const postName = basename(postLocation);
+    const targetPost = join(targetPath, postName);
 
     internals.debuglog(`Removing ${targetPath}`);
-    await rmdir(targetPath, { recursive: true });
-
-    internals.debuglog(`Adding ${postLocation} to ${targetPath}`);
-    await internals.ncp(postLocation, targetPath);
+    try {
+      await rm(targetPath, { recursive: true });
+    }
+    finally {
+      await this._ensureDirectoryExists(targetPath);
+      internals.debuglog(`Adding ${postLocation} to ${targetPost}`);
+      await internals.ncp(postLocation, targetPost);
+    }
   }
 
-  // Ensures the posts directory exists.
+  // Ensures a directory exists.
 
-  async _ensurePostsDirectoryExists() {
+  async _ensureDirectoryExists(directory) {
 
-    internals.debuglog(`Checking if ${this.postsDirectory} exists.`);
+    internals.debuglog(`Checking if ${directory} exists.`);
     try {
-      await access(this.postsDirectory);
+      await access(directory);
     }
     catch (error) {
       if (error.code === internals.kFileNotFoundError) {
-        internals.debuglog('Creating posts directory');
-        await mkdir(this.postsDirectory);
+        internals.debuglog(`Creating ${directory}`);
+        await mkdir(directory);
         return;
       }
 
@@ -242,21 +342,28 @@ module.exports = class Blog {
     }
   }
 
-  // Looks for a `.md` file in the blog directory, and returns the path
+  // Ensures posts directory exists
+
+  async _ensurePostsDirectoryExists() {
+
+    return this._ensureDirectoryExists(this.postsDirectory);
+  }
+
+  // Looks for a `.gmi` file in the blog directory, and returns the path
 
   async _findBlogContent(directory) {
 
     const entries = await readdir(directory);
 
-    const markdownEntries = entries
-      .filter((entry) => internals.kMarkdownRe.test(entry))
+    const geminiEntries = entries
+      .filter((entry) => internals.kGeminiRe.test(entry))
       .map((entry) => join(directory, entry));
 
-    if (markdownEntries.length > 0) {
-      internals.debuglog(`Found markdown file: ${markdownEntries[0]}`);
-      return markdownEntries[0];
+    if (geminiEntries.length > 0) {
+      internals.debuglog(`Found gemini file: ${geminiEntries[0]}`);
+      return geminiEntries[0];
     }
 
-    throw new Error(internals.strings.markdownNotFound);
+    throw new Error(internals.strings.geminiNotFound);
   }
 };