X-Git-Url: https://git.r.bdr.sh/rbdr/blog/blobdiff_plain/d3f282a164e44f54678cdb45aad7a09c8a92b89e..0307770b088afcc207bc5d84c63f8b681db0aebf:/lib/blog.js diff --git a/lib/blog.js b/lib/blog.js index d2acbb4..e1a76a8 100644 --- a/lib/blog.js +++ b/lib/blog.js @@ -1,28 +1,26 @@ -'use strict'; - -const { access, cp, mkdir, readdir, readFile, writeFile } = require('fs/promises'); -const { exec } = require('child_process'); -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 { ensureDirectoryExists, rmIfExists } = require('./utils'); -const { kFileNotFoundError } = require('./constants'); +import { access, cp, readdir, readFile, writeFile } from 'fs/promises'; +import { exec } from 'child_process'; +import { basename, join } from 'path'; +import ParseGemini from 'gemini-to-html/parse.js'; +import RenderGemini from 'gemini-to-html/render.js'; +import { debuglog, promisify } from 'util'; +import { ensureDirectoryExists, rmIfExists } from './utils.js'; +import { kFileNotFoundError } from './constants.js'; // Generators for the Blog -const StaticGenerator = require('./generators/static'); -const HTMLGenerator = require('./generators/html'); -const RSSGenerator = require('./generators/rss'); -const TXTGenerator = require('./generators/txt'); +import StaticGenerator from './generators/static.js'; +import HTMLGenerator from './generators/html.js'; +import RSSGenerator from './generators/rss.js'; +import TXTGenerator from './generators/txt.js'; // Archiving Methods -const GemlogArchiver = require('./archivers/gemlog'); +import GemlogArchiver from './archivers/gemlog.js'; // Remote Handler -const Remote = require('./remote'); +import Remote from './remote.js'; const internals = { @@ -51,7 +49,7 @@ const internals = { * @param {Blog.tConfiguration} config the initialization options to * extend the instance */ -module.exports = class Blog { +export default class Blog { constructor(config) { @@ -59,13 +57,12 @@ 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 - * @param {string} postLocation the path to the directory containing - * the post structure + * @param {string} postLocation the path to the blog post file * @return {Promise} empty promise, returns no value * @instance */ @@ -75,21 +72,21 @@ module.exports = class Blog { try { await this.syncDown(); } - catch {}; + catch {} + await this._shift(); - const firstDirectory = join(this.postsDirectory, '0'); + 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 - * @param {string} postLocation the path to the directory containing - * the post structure + * @param {string} postLocation the path to the blog post file * @return {Promise} empty promise, returns no value * @instance */ @@ -98,8 +95,9 @@ module.exports = class Blog { try { await this.syncDown(); } - catch {}; - const metadata = await this._update(); + catch {} + + await this._update(postLocation); } /** @@ -110,19 +108,19 @@ module.exports = class Blog { * @return {Promise} 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'); + await internals.exec('which rsync'); } catch (err) { - console.error('Please install and configure AWS CLI to publish.'); + console.error('Please install and configure rsync 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}`); + internals.debuglog(`Copying ephemeral blog from ${this.blogOutputDirectory}`); + await internals.exec(`rsync -r ${this.blogOutputDirectory}/ ${host}`); } catch (err) { console.error('Failed to publish'); @@ -152,9 +150,8 @@ module.exports = class Blog { } try { - const gemlogPath = resolve(join(__dirname, '../', '.gemlog')); - internals.debuglog(`Reading archive from ${gemlogPath}`); - await internals.exec(`rsync -r ${gemlogPath}/ ${host}`); + internals.debuglog(`Copying archive from ${this.archiveOutputDirectory}`); + await internals.exec(`rsync -r ${this.archiveOutputDirectory}/ ${host}`); } catch (err) { console.error('Failed to publish archive'); @@ -173,7 +170,9 @@ module.exports = class Blog { * @instance */ async addRemote(remote) { - await Remote.add(this.remoteConfig, remote) + + await ensureDirectoryExists(this.configDirectory); + await Remote.add(this.remoteConfig, remote); } /** @@ -185,7 +184,8 @@ module.exports = class Blog { * @instance */ async removeRemote() { - await Remote.remove(this.remoteConfig) + + await Remote.remove(this.remoteConfig); } @@ -198,8 +198,10 @@ module.exports = class Blog { * @instance */ async syncDown() { + internals.debuglog('Pulling remote state'); - await Remote.syncDown(this.remoteConfig, this.blogDirectory) + await ensureDirectoryExists(this.dataDirectory); + await Remote.syncDown(this.remoteConfig, this.dataDirectory); internals.debuglog('Pulled remote state'); } @@ -212,8 +214,10 @@ module.exports = class Blog { * @instance */ async syncUp() { + internals.debuglog('Pushing remote state'); - await Remote.syncUp(this.remoteConfig, this.blogDirectory) + await ensureDirectoryExists(this.dataDirectory); + await Remote.syncUp(this.remoteConfig, this.dataDirectory); internals.debuglog('Pushed remote state'); } @@ -232,7 +236,7 @@ module.exports = class Blog { try { await this.syncUp(); } - catch {}; + catch {} } @@ -244,12 +248,24 @@ module.exports = class Blog { const posts = await this._readPosts(); - 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); + // Start from a clean slate. + await rmIfExists(this.blogOutputDirectory); + await ensureDirectoryExists(this.blogOutputDirectory); + + // Run each generator + await StaticGenerator(this.staticDirectory, this.blogOutputDirectory, posts); + await HTMLGenerator(await this._templateDirectoryFor('index.html'), this.blogOutputDirectory, posts); + await RSSGenerator(await this._templateDirectoryFor('feed.xml'), this.blogOutputDirectory, posts); + await TXTGenerator(await this._templateDirectoryFor('index.txt'), this.blogOutputDirectory, posts); - await GemlogArchiver(this.archiveDirectory); + // Start from a clean slate. + await rmIfExists(this.archiveOutputDirectory); + await ensureDirectoryExists(this.archiveOutputDirectory); + await ensureDirectoryExists(this.archiveDirectory); + + // Run each archiver + await GemlogArchiver(await this._templateDirectoryFor('index.gmi'), this.archiveDirectory, this.archiveOutputDirectory); + // TODO: GopherArchiver } // Reads the posts into an array @@ -278,27 +294,28 @@ module.exports = class Blog { // Reads an individual post - async _readPost(index=0) { - const postSourcePath = join(this.postsDirectory, `${index}`); + async _readPost(index = 0) { - internals.debuglog(`Reading ${postSourcePath}`); + const postSourcePath = join(this.postsDirectory, `${index}`); - await access(postSourcePath); + internals.debuglog(`Reading ${postSourcePath}`); - const metadata = await this._getMetadata(index); + await access(postSourcePath); - const postContentPath = await this._findBlogContent(postSourcePath); - internals.debuglog(`Reading ${postContentPath}`); - const postContent = await readFile(postContentPath, { encoding: 'utf8' }); + const metadata = await this._getMetadata(index); - internals.debuglog('Parsing Gemini'); - return { - ...metadata, - location: postSourcePath, - index, - html: RenderGemini(ParseGemini(postContent)), - raw: postContent - }; + 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. @@ -332,6 +349,7 @@ module.exports = class Blog { // Moves older posts to the archive async _archive() { + internals.debuglog('Archiving post'); const post = await this._readPost(0); await ensureDirectoryExists(this.archiveDirectory); @@ -378,18 +396,17 @@ module.exports = class Blog { 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) { + internals.debuglog(`Copying ${postLocation}`); const targetPath = join(this.postsDirectory, '0'); const postName = basename(postLocation); const targetPost = join(targetPath, postName); - internals.debuglog(`Removing ${targetPath}`); await rmIfExists(targetPath); await ensureDirectoryExists(targetPath); - internals.debuglog(`Adding ${postLocation} to ${targetPost}`); await cp(postLocation, targetPost, { recursive: true }); internals.debuglog(`Added ${postLocation} to ${targetPath}`); } @@ -411,4 +428,21 @@ module.exports = class Blog { throw new Error(internals.strings.geminiNotFound); } -}; + + // Gets the template directory for a given template. + async _templateDirectoryFor(template) { + + try { + await access(join(this.templatesDirectory, template)); + return this.templatesDirectory; + } + catch (error) { + if (error.code === kFileNotFoundError) { + internals.debuglog(`No custom template for ${template}`); + return this.defaultTemplatesDirectory; + } + + throw error; + } + } +}