Add self link

[rbdr/blog] / lib / blog.js

diff --git a/lib/blog.js b/lib/blog.js
index 8ae3e21a28884f1b091b1f3e4d221d0543481cf8..ca944cfbdfa2c55160aacfcf74dafbce63d5695f 100644 (file)
--- a/lib/blog.js
+++ b/lib/blog.js
@@ -1,12 +1,13 @@
 'use strict';
 
 'use strict';
 

-const { access, mkdir, readdir, readFile, rm, writeFile } = require('fs/promises');
+const { access, cp, mkdir, readdir, readFile, writeFile } = require('fs/promises');

 const { exec } = require('child_process');
 const { exec } = require('child_process');

-const { ncp } = require('ncp');
-const { join } = require('path');
+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');
 const ParseGemini = require('gemini-to-html/parse');
 const RenderGemini = require('gemini-to-html/render');
 const { debuglog, promisify } = require('util');

+const { ensureDirectoryExists, rmIfExists } = require('./utils');
+const { kFileNotFoundError } = require('./constants');

 
 // Generators for the Blog
 
 
 // Generators for the Blog
 


@@ -19,17 +20,19 @@ const TXTGenerator = require('./generators/txt');
 
 const GemlogArchiver = require('./archivers/gemlog');
 
 
 const GemlogArchiver = require('./archivers/gemlog');
 

+// Remote Handler
+
+const Remote = require('./remote');
+

 const internals = {
 
   // Promisified functions
   exec: promisify(exec),
 const internals = {
 
   // Promisified functions
   exec: promisify(exec),

-  ncp: promisify(ncp),

 
   debuglog: debuglog('blog'),
 
   // constants
 
 
   debuglog: debuglog('blog'),
 
   // constants
 

-  kFileNotFoundError: 'ENOENT',

   kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 
   kGeminiRe: /\.gmi$/i,
   kMetadataFilename: 'metadata.json',
 


@@ -56,44 +59,45 @@ module.exports = class Blog {
   }
 
   /**
   }
 
   /**

-   * Shifts the blog posts, adds the passed path to slot 0, and
+   * Shifts the blog posts, adds the passed file to slot 0, and

    * generates files.
    *
    * @function add
    * @memberof Blog
    * generates files.
    *
    * @function add
    * @memberof Blog

-   * @param {string} postLocation the path to the directory containing
-   * the post structure
+   * @param {string} postLocation the path to the blog post file

    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
   async add(postLocation) {
 
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
   async add(postLocation) {
 

-    await this._ensurePostsDirectoryExists();
+    await ensureDirectoryExists(this.postsDirectory);
+    try {
+      await this.syncDown();
+    }
+    catch {};

     await this._shift();
     await this._shift();

-    await mkdir(join(this.postsDirectory, '0'));
-    await this.update(postLocation);
+    const firstDirectory = join(this.postsDirectory, '0'); 
+    await rmIfExists(firstDirectory);
+    await ensureDirectoryExists(firstDirectory);
+    await this._update(postLocation);

   }
 
   /**
   }
 
   /**

-   * Adds the passed path to slot 0, and generates files.
+   * Update slot 0 with the passed gmi file, and generates files.

    *
    * @function update
    * @memberof Blog
    *
    * @function update
    * @memberof Blog

-   * @param {string} postLocation the path to the directory containing
-   * the post structure
+   * @param {string} postLocation the path to the blog post file

    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
   async update(postLocation) {
 
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
   async update(postLocation) {
 

-    const metadata = await this._getMetadata();
-    await this._ensurePostsDirectoryExists();
-    await this._copyPost(postLocation);
-    await this._writeMetadata(metadata);
-
-    await this._archive(postLocation);
-
-    await this.generate();
+    try {
+      await this.syncDown();
+    }
+    catch {};
+    const metadata = await this._update(postLocation);

   }
 
   /**
   }
 
   /**


@@ -104,9 +108,9 @@ module.exports = class Blog {
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */
    * @return {Promise<undefined>} empty promise, returns no value
    * @instance
    */

-  async publish(bucket) {
+  async publish(host) {

 
 

-    internals.debuglog(`Publishing to ${bucket}`);
+    internals.debuglog(`Publishing to ${host}`);

     try {
       await internals.exec('which aws');
     }
     try {
       await internals.exec('which aws');
     }


@@ -115,8 +119,8 @@ module.exports = class Blog {
     }
 
     try {
     }
 
     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}`);
+      internals.debuglog(`Copying ephemeral blog from ${this.staticDirectory}`);
+      await internals.exec(`rsync -r ${this.staticDirectory}/ ${host}`);

     }
     catch (err) {
       console.error('Failed to publish');
     }
     catch (err) {
       console.error('Failed to publish');


@@ -126,6 +130,112 @@ module.exports = class Blog {
     internals.debuglog('Finished publishing');
   }
 
     internals.debuglog('Finished publishing');
   }
 

+  /**
+   * 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) {
+
+    internals.debuglog(`Publishing archive to ${host}`);
+    try {
+      await internals.exec('which rsync');
+    }
+    catch (err) {
+      console.error('Please install rsync to publish the archive.');
+    }
+
+    try {
+      const gemlogPath = resolve(join(__dirname, '../', '.gemlog'));
+      internals.debuglog(`Copying 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');
+  }
+
+  /**
+   * Adds a remote
+   *
+   * @function addRemote
+   * @memberof Blog
+   * @return {Promise<undefined>} empty promise, returns no value
+   * @instance
+   */
+  async addRemote(remote) {
+    await Remote.add(this.remoteConfig, remote)
+  }
+
+  /**
+   * Removes a remote
+   *
+   * @function removeRemote
+   * @memberof Blog
+   * @return {Promise<undefined>} empty promise, returns no value
+   * @instance
+   */
+  async removeRemote() {
+    await Remote.remove(this.remoteConfig)
+  }
+
+
+  /**
+   * Pulls the posts and archive from the remote
+   *
+   * @function syncDown
+   * @memberof Blog
+   * @return {Promise<undefined>} empty promise, returns no value
+   * @instance
+   */
+  async syncDown() {
+    internals.debuglog('Pulling remote state');
+    await ensureDirectoryExists(this.postsDirectory);
+    await Remote.syncDown(this.remoteConfig, this.blogDirectory)
+    internals.debuglog('Pulled remote state');
+  }
+
+  /**
+   * Pushes the posts and archive to the remote
+   *
+   * @function syncUp
+   * @memberof Blog
+   * @return {Promise<undefined>} empty promise, returns no value
+   * @instance
+   */
+  async syncUp() {
+    internals.debuglog('Pushing remote state');
+    await ensureDirectoryExists(this.postsDirectory);
+    await Remote.syncUp(this.remoteConfig, this.blogDirectory)
+    internals.debuglog('Pushed remote state');
+  }
+
+  // Adds the passed path to slot 0, and generates files.
+
+  async _update(postLocation) {
+
+    const metadata = await this._getMetadata();
+    await ensureDirectoryExists(this.postsDirectory);
+    await this._copyPost(postLocation);
+    await this._writeMetadata(metadata);
+
+    await this._archive(postLocation);
+
+    await this.generate();
+    try {
+      await this.syncUp();
+    }
+    catch {};
+  }
+
+

   // Parses Gemini for each page, copies assets and generates index.
 
   async generate() {
   // Parses Gemini for each page, copies assets and generates index.
 
   async generate() {


@@ -154,7 +264,7 @@ module.exports = class Blog {
         posts.push(await this._readPost(i));
       }
       catch (error) {
         posts.push(await this._readPost(i));
       }
       catch (error) {

-        if (error.code === internals.kFileNotFoundError) {
+        if (error.code === kFileNotFoundError) {

           internals.debuglog(`Skipping ${i}`);
           continue;
         }
           internals.debuglog(`Skipping ${i}`);
           continue;
         }


@@ -196,21 +306,20 @@ module.exports = class Blog {
   async _shift() {
 
 
   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(`Archiving ${targetPath}`);
       const targetPath = join(this.postsDirectory, `${i}`);
       const sourcePath = join(this.postsDirectory, `${i - 1}`);
 
       try {
         internals.debuglog(`Archiving ${targetPath}`);

-        await rm(targetPath, { recursive: true });
-
+        await rmIfExists(targetPath);

         await access(sourcePath); // check the source path
 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);
         await access(sourcePath); // check the source path
 
         internals.debuglog(`Shifting blog post ${sourcePath} to ${targetPath}`);

-        await internals.ncp(sourcePath, targetPath);
+        await cp(sourcePath, targetPath, { recursive: true });

       }
       catch (error) {
       }
       catch (error) {

-        if (error.code === internals.kFileNotFoundError) {
+        if (error.code === kFileNotFoundError) {

           internals.debuglog(`Skipping ${sourcePath}: Does not exist.`);
           continue;
         }
           internals.debuglog(`Skipping ${sourcePath}: Does not exist.`);
           continue;
         }


@@ -225,19 +334,16 @@ module.exports = class Blog {
   async _archive() {
     internals.debuglog('Archiving post');
     const post = await this._readPost(0);
   async _archive() {
     internals.debuglog('Archiving post');
     const post = await this._readPost(0);

-    await this._ensureDirectoryExists(this.archiveDirectory);
+    await ensureDirectoryExists(this.archiveDirectory);

 
     const targetPath = join(this.archiveDirectory, post.id);
 
 
     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 internals.ncp(post.location, targetPath);
-      internals.debuglog(`Added ${post.location} to ${targetPath}`);
-    }
+    internals.debuglog(`Removing ${targetPath}`);
+    await rmIfExists(targetPath);
+    internals.debuglog(`Adding ${post.location} to ${targetPath}`);
+    await ensureDirectoryExists(targetPath);
+    await cp(post.location, targetPath, { recursive: true });
+    internals.debuglog(`Added ${post.location} to ${targetPath}`);

   }
 
   // Attempts to read existing metadata. Otherwise generates new set.
   }
 
   // Attempts to read existing metadata. Otherwise generates new set.


@@ -272,56 +378,19 @@ module.exports = class Blog {
     await writeFile(metadataTarget, JSON.stringify(metadata, null, 2));
   }
 
     await writeFile(metadataTarget, JSON.stringify(metadata, null, 2));
   }
 

-  // Copies a post directory to the latest slot.
+  // Copies a post file to the latest slot.

 
   async _copyPost(postLocation) {
 
 
   async _copyPost(postLocation) {
 

+    internals.debuglog(`Copying ${postLocation}`);

     const targetPath = join(this.postsDirectory, '0');
     const targetPath = join(this.postsDirectory, '0');

+    const postName = basename(postLocation);
+    const targetPost = join(targetPath, postName);

 
 

-    internals.debuglog(`Removing ${targetPath}`);
-    await rm(targetPath, { recursive: true });
-
-    internals.debuglog(`Adding ${postLocation} to ${targetPath}`);
-    await internals.ncp(postLocation, targetPath);
-  }
-
-  // Ensures a directory exists.
-
-  async _ensureDirectoryExists(directory) {
-
-    internals.debuglog(`Checking if ${directory} exists.`);
-    try {
-      await access(directory);
-    }
-    catch (error) {
-      if (error.code === internals.kFileNotFoundError) {
-        internals.debuglog('Creating posts directory');
-        await mkdir(directory);
-        return;
-      }
-
-      throw error;
-    }
-  }
-
-  // Ensures posts directory exists
-
-  async _ensurePostsDirectoryExists() {
-
-    return this._ensureDirectoryExists(this.postsDirectory);
-    internals.debuglog(`Checking if ${this.postsDirectory} exists.`);
-    try {
-      await access(this.postsDirectory);
-    }
-    catch (error) {
-      if (error.code === internals.kFileNotFoundError) {
-        internals.debuglog('Creating posts directory');
-        await mkdir(this.postsDirectory);
-        return;
-      }
-
-      throw error;
-    }
+    await rmIfExists(targetPath);
+    await ensureDirectoryExists(targetPath);
+    await cp(postLocation, targetPost, { recursive: true });
+    internals.debuglog(`Added ${postLocation} to ${targetPath}`);

   }
 
   // Looks for a `.gmi` file in the blog directory, and returns the path
   }
 
   // Looks for a `.gmi` file in the blog directory, and returns the path