@evanp/activitypub-bot 0.31.1 → 0.32.0

package/bin/activitypub-bot.js

@@ -32,6 +32,7 @@ Options:
   --delivery <number>        Number of background delivery workers
   --distribution <number>    Number of background distribution workers
   --index-file <path>        HTML page to show at root path
+  --profile-file <path>      HTML page to show for bot profiles
   -h, --help                 Show this help
 `)
   process.exit(0)
@@ -47,6 +48,7 @@ const parseNumber = (value) => {
 const baseDir = dirname(fileURLToPath(import.meta.url))
 const DEFAULT_BOTS_CONFIG_FILE = resolve(baseDir, '..', 'bots', 'index.js')
 const DEFAULT_INDEX_FILE = resolve(baseDir, '..', 'web', 'index.html')
+const DEFAULT_PROFILE_FILE = resolve(baseDir, '..', 'web', 'profile.html')
 
 const DATABASE_URL = normalize(values['database-url']) || process.env.DATABASE_URL || 'sqlite::memory:'
 const ORIGIN = normalize(values.origin) || process.env.ORIGIN || 'https://activitypubbot.test'
@@ -60,6 +62,7 @@ const LOG_LEVEL =
 const DELIVERY = parseNumber(values.delivery) || parseNumber(process.env.DELIVERY) || 2
 const DISTRIBUTION = parseNumber(values.distribution) || parseNumber(process.env.DISTRIBUTION) || 8
 const INDEX_FILE = values['index-file'] || process.env.INDEX_FILE || DEFAULT_INDEX_FILE
+const PROFILE_FILE = values['profile-file'] || process.env.PROFILE_FILE || DEFAULT_PROFILE_FILE
 
 const bots = (await import(BOTS_CONFIG_FILE)).default
 
@@ -70,7 +73,8 @@ const app = await makeApp({
   logLevel: LOG_LEVEL,
   deliveryWorkerCount: DELIVERY,
   distributionWorkerCount: DISTRIBUTION,
-  indexFileName: INDEX_FILE
+  indexFileName: INDEX_FILE,
+  profileFileName: PROFILE_FILE
 })
 
 const server = app.listen(parseInt(PORT), () => {

package/lib/app.js

@@ -27,6 +27,8 @@ import inboxRouter from './routes/inbox.js'
 import healthRouter from './routes/health.js'
 import webfingerRouter from './routes/webfinger.js'
 import sharedInboxRouter from './routes/sharedinbox.js'
+import profileRouter from './routes/profile.js'
+import proxyRouter from './routes/proxy.js'
 import { BotContext } from './botcontext.js'
 import { Transformer } from './microsyntax.js'
 import { HTTPSignatureAuthenticator } from './httpsignatureauthenticator.js'
@@ -42,8 +44,9 @@ import DoNothingBot from './bots/donothing.js'
 
 const currentDir = dirname(fileURLToPath(import.meta.url))
 const DEFAULT_INDEX_FILENAME = resolve(currentDir, '..', 'web', 'index.html')
+const DEFAULT_PROFILE_FILENAME = resolve(currentDir, '..', 'web', 'profile.html')
 
-export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent', deliveryWorkerCount = 2, distributionWorkerCount = 8, indexFileName = DEFAULT_INDEX_FILENAME }) {
+export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent', deliveryWorkerCount = 2, distributionWorkerCount = 8, indexFileName = DEFAULT_INDEX_FILENAME, profileFileName = DEFAULT_PROFILE_FILENAME }) {
   const logger = Logger({
     level: logLevel
   })
@@ -188,7 +191,8 @@ export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent',
     origin,
     deliverer,
     deliveryWorkers,
-    indexFileName
+    indexFileName,
+    profileFileName
   }
 
   app.use(HTTPLogger({
@@ -207,12 +211,15 @@ export async function makeApp ({ databaseUrl, origin, bots, logLevel = 'silent',
       req.rawBodyText = buf.toString(encoding || 'utf8')
     }
   }))
+  app.use(express.urlencoded({ extended: true }))
 
   // These should not check HTTP Signature even if provided
 
-  app.use('/', serverRouter)
   app.use('/', healthRouter)
+  app.use('/', serverRouter)
+  app.use('/', profileRouter)
   app.use('/', webfingerRouter)
+  app.use('/', proxyRouter)
 
   // These should check HTTP Signature if provided
 

package/lib/bot.js

@@ -1,13 +1,32 @@
+const DEFAULT_FULLNAME = 'Bot'
+const DEFAULT_DESCRIPTION = 'Default bot'
+
 export default class Bot {
   #context = null
   #username = null
   #checkSignature
+  #fullname
+  #description
+  #icon
+  #image
 
   constructor (username, options = {}) {
     this.#username = username
     this.#checkSignature = ('checkSignature' in options)
       ? options.checkSignature
       : true
+    this.#fullname = ('fullname' in options)
+      ? options.fullname
+      : DEFAULT_FULLNAME
+    this.#description = ('description' in options)
+      ? options.description
+      : DEFAULT_DESCRIPTION
+    this.#icon = ('icon' in options)
+      ? options.icon
+      : null
+    this.#image = ('image' in options)
+      ? options.image
+      : null
   }
 
   async initialize (context) {
@@ -18,11 +37,19 @@ export default class Bot {
   }
 
   get fullname () {
-    return 'Bot'
+    return this.#fullname
   }
 
   get description () {
-    return 'A default, do-nothing bot.'
+    return this.#description
+  }
+
+  get icon () {
+    return this.#icon
+  }
+
+  get image () {
+    return this.#image
   }
 
   get username () {

package/lib/bots/donothing.js

@@ -4,20 +4,11 @@ const DEFAULT_FULLNAME = 'Do Nothing Bot'
 const DEFAULT_DESCRIPTION = 'A bot that does nothing.'
 
 export default class DoNothingBot extends Bot {
-  #fullname
-  #description
-
   constructor (username, options = {}) {
-    super(username, options)
-    this.#fullname = options.fullname || DEFAULT_FULLNAME
-    this.#description = options.description || DEFAULT_DESCRIPTION
-  }
-
-  get fullname () {
-    return this.#fullname
-  }
-
-  get description () {
-    return this.#description
+    super(username, {
+      fullname: DEFAULT_FULLNAME,
+      description: DEFAULT_DESCRIPTION,
+      ...options
+    })
   }
 }

package/lib/routes/profile.js

@@ -0,0 +1,18 @@
+import express from 'express'
+import createHttpError from 'http-errors'
+import BotMaker from '../botmaker.js'
+
+const router = express.Router()
+
+router.get('/profile/:username', async (req, res, next) => {
+  const { username } = req.params
+  const { profileFileName, bots } = req.app.locals
+  const bot = await BotMaker.makeBot(bots, username)
+  if (!bot) {
+    return next(createHttpError(404, `User ${username} not found`))
+  }
+  res.type('html')
+  res.sendFile(profileFileName)
+})
+
+export default router

package/lib/routes/proxy.js

@@ -0,0 +1,50 @@
+import express from 'express'
+
+import as2 from '../activitystreams.js'
+import createHttpError from 'http-errors'
+
+const router = express.Router()
+
+router.options('/shared/proxy', (req, res) => {
+  const { origin } = req.app.locals
+  res.set('Allow', 'POST')
+  res.set('Access-Control-Allow-Origin', origin)
+  res.status(200).end()
+})
+
+router.post('/shared/proxy', async (req, res, next) => {
+  const { client, logger, origin } = req.app.locals
+  const { id } = req.body
+
+  if (!id) {
+    return next(createHttpError(400, 'Missing id parameter'))
+  }
+
+  let url
+
+  try {
+    url = new URL(id)
+  } catch (error) {
+    return next(createHttpError(400, 'id must be an URL'))
+  }
+
+  if (url.protocol !== 'https:') {
+    return next(createHttpError(400, 'id must be an https: URL'))
+  }
+
+  let obj
+
+  try {
+    obj = await client.get(id)
+  } catch (err) {
+    logger.warn({ err, id }, 'Error fetching object in proxy')
+    return next(createHttpError(400, `Error fetching object ${id}`))
+  }
+
+  res.status(200)
+  res.set('Access-Control-Allow-Origin', origin)
+  res.type(as2.mediaType)
+  res.end(await obj.write())
+})
+
+export default router

package/lib/routes/user.js

@@ -1,3 +1,4 @@
+import { fileURLToPath } from 'node:url'
 import express from 'express'
 import as2 from '../activitystreams.js'
 import createHttpError from 'http-errors'
@@ -5,6 +6,23 @@ import BotMaker from '../botmaker.js'
 
 const router = express.Router()
 
+async function toLink (url, formatter, username, type) {
+  if (!url) {
+    return null
+  }
+  if (url.protocol === 'file:') {
+    return {
+      href: formatter.format({ username, type }),
+      type: 'Link'
+    }
+  } else {
+    return {
+      href: url.href,
+      type: 'Link'
+    }
+  }
+}
+
 router.get('/user/:username', async (req, res, next) => {
   const { username } = req.params
   const { actorStorage, keyStorage, formatter, bots, origin } = req.app.locals
@@ -34,6 +52,13 @@ router.get('/user/:username', async (req, res, next) => {
     },
     endpoints: {
       sharedInbox: `${origin}/shared/inbox`
+    },
+    icon: await toLink(bot.icon, formatter, username, 'icon'),
+    image: await toLink(bot.image, formatter, username, 'image'),
+    url: {
+      href: formatter.format({ username, type: 'profile' }),
+      type: 'Link',
+      mediaType: 'text/html'
     }
   })
   res.status(200)
@@ -71,4 +96,48 @@ router.get('/user/:username/publickey', async (req, res, next) => {
   res.end(body)
 })
 
+router.get('/user/:username/icon', async (req, res, next) => {
+  const { username } = req.params
+  const { bots } = req.app.locals
+  const bot = await BotMaker.makeBot(bots, username)
+  if (!bot) {
+    return next(createHttpError(404, `User ${username} not found`))
+  }
+  if (!bot.icon) {
+    return next(createHttpError(404, `No icon for ${username} found`))
+  }
+
+  if (typeof bot.icon !== 'object' || !(bot.icon instanceof URL)) {
+    return next(createHttpError(500, 'Incorrect image format from bot'))
+  }
+
+  if (bot.icon.protocol === 'file:') {
+    res.sendFile(fileURLToPath(bot.icon))
+  } else {
+    res.redirect(307, bot.icon)
+  }
+})
+
+router.get('/user/:username/image', async (req, res, next) => {
+  const { username } = req.params
+  const { bots } = req.app.locals
+  const bot = await BotMaker.makeBot(bots, username)
+  if (!bot) {
+    return next(createHttpError(404, `User ${username} not found`))
+  }
+  if (!bot.image) {
+    return next(createHttpError(404, `No image for ${username} found`))
+  }
+
+  if (typeof bot.image !== 'object' || !(bot.image instanceof URL)) {
+    return next(createHttpError(500, 'Incorrect image format from bot'))
+  }
+
+  if (bot.image.protocol === 'file:') {
+    res.sendFile(fileURLToPath(bot.image))
+  } else {
+    res.redirect(307, bot.image)
+  }
+})
+
 export default router

package/lib/routes/webfinger.js

@@ -23,6 +23,11 @@ async function botWebfinger (username, req, res, next) {
         rel: 'self',
         type: 'application/activity+json',
         href: formatter.format({ username })
+      },
+      {
+        rel: 'http://webfinger.net/rel/profile-page',
+        type: 'text/html',
+        href: formatter.format({ username, type: 'profile' })
       }
     ]
   })

package/lib/urlformatter.js

@@ -15,6 +15,8 @@ export class UrlFormatter {
     let base = null
     if (server) {
       return this.format({ username: this.#hostname, type, nanoid, collection, page, server: false })
+    } else if (username && type && type === 'profile') {
+      return `${this.#origin}/profile/${username}`
     } else if (username) {
       base = `${this.#origin}/user/${username}`
     } else {
@@ -22,10 +24,10 @@ export class UrlFormatter {
     }
     let major = null
     if (type) {
-      if (nanoid) {
-        major = `${base}/${type.toLowerCase()}/${nanoid}`
-      } else if (type === 'publickey') {
+      if (['publickey', 'icon', 'image'].includes(type)) {
         major = `${base}/${type.toLowerCase()}`
+      } else if (nanoid) {
+        major = `${base}/${type.toLowerCase()}/${nanoid}`
       } else {
         throw new Error('Cannot format URL without nanoid')
       }
@@ -42,10 +44,6 @@ export class UrlFormatter {
     } else {
       url = major
     }
-    // For the base case, we want a trailing slash.
-    if (url === this.#origin) {
-      url = `${url}/actor`
-    }
     return url
   }
 
@@ -72,6 +70,10 @@ export class UrlFormatter {
       parts.username = pathParts[1]
       pathParts = pathParts.slice(2)
       parts.server = (parts.username === this.#hostname)
+    } else if (pathParts.length > 0 && pathParts[0] === 'profile') {
+      parts.username = pathParts[1]
+      parts.type = 'profile'
+      return parts
     }
     if (pathParts.length > 0) {
       if (USER_COLLECTIONS.includes(pathParts[0])) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanp/activitypub-bot",
-  "version": "0.31.1",
+  "version": "0.32.0",
   "description": "server-side ActivityPub bot framework",
   "type": "module",
   "main": "lib/index.js",

package/web/profile.html

@@ -0,0 +1,72 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>activitypub.bot</title>
+  <script type="module" src="https://unpkg.com/@socialwebfoundation/ap-components"></script>
+  <style>
+    body { max-width: 60ch; margin: 0 auto; padding: 1rem; }
+  </style>
+</head>
+
+<body>
+  <p id="breadcrumb"></p>
+  <main>
+    <section id="account"></section>
+  </main>
+
+  <script type="module">
+    import { ActivityPubElement } from "https://unpkg.com/@socialwebfoundation/ap-components";
+
+    const cache = new Map();
+
+    function wrap(json) {
+      return {
+        ok: true,
+        async json() {
+          return json
+        }
+      }
+    }
+
+    function addObjectIdLink(objectId) {
+      const link = document.createElement('link')
+      link.rel = 'alternate'
+      link.type = 'application/activity+json'
+      link.href = objectId
+      document.head.appendChild(link)
+    }
+
+    window.onload = () => {
+      const page = document.location
+      ActivityPubElement.fetchFunction = async (url, options) => {
+        const u = new URL(url)
+        if (u.origin == page.origin) {
+          return await fetch(u, options)
+        } else {
+          return await fetch('/shared/proxy', {
+              method: "POST",
+              headers: {
+                "Content-Type": "application/x-www-form-urlencoded"
+              },
+              body: new URLSearchParams({ id: url }),
+            });
+        }
+      }
+
+      document.getElementById('breadcrumb').innerHTML = `&larr; <a href="${page.origin}/">${page.host}</a>`
+
+      const username = page.pathname.split('/')[2]
+      const objectId = `${page.origin}/user/${username}`
+      addObjectIdLink(objectId)
+      const account = document.getElementById("account");
+      customElements.whenDefined('ap-actor-page').then(() => {
+        account.innerHTML = `<ap-actor-page object-id="${objectId}"></ap-actor-page>`;
+      });
+    };
+  </script>
+</body>
+
+</html>