/* jslint node: true */ 'use strict'; // ENiGMA½ const { Errors } = require('../enig_error.js'); const UserProps = require('../user_property'); const { ActivityStreamsContext, webFingerProfileUrl, makeUserUrl, isValidLink, makeSharedInboxUrl, userNameFromSubject, } = require('./util'); const Log = require('../logger').log; const { queryWebFinger } = require('../webfinger'); const EnigAssert = require('../enigma_assert'); const ActivityPubSettings = require('./settings'); const ActivityPubObject = require('./object'); const { ActivityStreamMediaType } = require('./const'); const apDb = require('../database').dbs.activitypub; const Config = require('../config').get; // deps const _ = require('lodash'); const mimeTypes = require('mime-types'); const { getJson } = require('../http_util.js'); const { getISOTimestampString } = require('../database.js'); const moment = require('moment'); const paths = require('path'); const ActorCacheTTL = moment.duration(1, 'day'); // https://www.w3.org/TR/activitypub/#actor-objects module.exports = class Actor extends ActivityPubObject { constructor(obj) { super(obj); } isValid() { if (!super.isValid()) { return false; } if (!Actor.WellKnownActorTypes.includes(this.type)) { return false; } const linksValid = Actor.WellKnownLinkTypes.every(l => { // must be valid if present & non-empty if (this[l] && !isValidLink(this[l])) { return false; } return true; }); if (!linksValid) { return false; } return true; } static get WellKnownActorTypes() { return ['Person', 'Group', 'Organization', 'Service', 'Application']; } static get WellKnownLinkTypes() { return ['inbox', 'outbox', 'following', 'followers']; } static fromLocalUser(user, webServer, cb) { const userActorId = user.getProperty(UserProps.ActivityPubActorId); if (!userActorId) { return cb( Errors.MissingProperty( `User missing '${UserProps.ActivityPubActorId}' property` ) ); } const userSettings = ActivityPubSettings.fromUser(user); const addImage = (o, t) => { const url = userSettings[t]; if (url) { const fn = paths.basename(url); const mt = mimeTypes.contentType(fn); if (mt) { o[t] = { mediaType: mt, type: 'Image', url, }; } } }; const obj = { '@context': [ ActivityStreamsContext, 'https://w3id.org/security/v1', // :TODO: add support { bbsInfo: { '@id': 'bbs:bbsInfo', '@type': '@id', }, }, ], id: userActorId, type: 'Person', preferredUsername: user.username, name: userSettings.showRealName ? user.getSanitizedName('real') : user.username, endpoints: { sharedInbox: makeSharedInboxUrl(webServer), }, inbox: makeUserUrl(webServer, user, '/ap/users/') + '/inbox', outbox: makeUserUrl(webServer, user, '/ap/users/') + '/outbox', followers: makeUserUrl(webServer, user, '/ap/users/') + '/followers', following: makeUserUrl(webServer, user, '/ap/users/') + '/following', summary: user.getProperty(UserProps.AutoSignature) || '', url: webFingerProfileUrl(webServer, user), manuallyApprovesFollowers: userSettings.manuallyApprovesFollowers, discoverable: userSettings.discoverable, // :TODO: we can start to define BBS related stuff with the community perhaps // attachment: [ // { // name: 'SomeNetwork Address', // type: 'PropertyValue', // value: 'Mateo@21:1/121', // }, // ], bbsInfo: { boardName: Config().general.boardName, memberSince: user.getProperty(UserProps.AccountCreated), affiliations: user.getProperty(UserProps.Affiliations) || '', }, }; addImage(obj, 'icon'); addImage(obj, 'image'); const publicKeyPem = user.getProperty(UserProps.PublicActivityPubSigningKey); if (!_.isEmpty(publicKeyPem)) { obj.publicKey = { id: userActorId + '#main-key', owner: userActorId, publicKeyPem, }; EnigAssert( !_.isEmpty(user.getProperty(UserProps.PrivateActivityPubSigningKey)), 'User has public key but no private key!' ); } else { Log.warn( { username: user.username }, `No public key (${UserProps.PublicActivityPubSigningKey}) for user "${user.username}"` ); } return cb(null, new Actor(obj)); } static fromId(id, cb) { Actor._fromCache(id, (err, actor, subject) => { if (!err) { // cache hit return cb(null, actor, subject); } // cache miss: attempt to fetch & populate Actor._fromWebFinger(id, (err, actor, subject) => { if (err) { return cb(err); } if (subject) { subject = `@${userNameFromSubject(subject)}`; // e.g. @Username@host.com } else if (!_.isEmpty(actor)) { subject = actor.id; // best we can do for now } // deliver result to caller cb(err, actor, subject); // cache our entry if (actor) { apDb.run( `REPLACE INTO actor_cache (actor_id, actor_json, subject, timestamp) VALUES (?, ?, ?, ?);`, [id, JSON.stringify(actor), subject, getISOTimestampString()], err => { if (err) { // :TODO: log me } } ); } }); }); } static _fromRemoteQuery(id, cb) { const headers = { Accept: ActivityStreamMediaType, }; getJson(id, { headers }, (err, actor) => { if (err) { return cb(err); } actor = new Actor(actor); if (!actor.isValid()) { return cb(Errors.Invalid('Invalid Actor')); } return cb(null, actor); }); } static _fromCache(id, cb) { apDb.get( `SELECT rowid, actor_json, subject, timestamp, FROM actor_cache WHERE actor_id = ? OR subject = ? LIMIT 1;`, [id, id], (err, row) => { if (err) { return cb(err); } if (!row) { return cb(Errors.DoesNotExist()); } const timestamp = moment(row.timestamp); if (moment().isAfter(timestamp.add(ActorCacheTTL))) { apDb.run( `DELETE FROM actor_cache WHERE rowid = ?;`, [row.rowid], err => { if (err) { // :TODO: Log me } return cb(Errors.Expired('The cache entry is expired')); } ); } const obj = ActivityPubObject.fromJsonString(row.actor_json); if (!obj || !obj.isValid()) { return cb(Errors.Invalid('Failed to create ActivityPub object')); } const actor = new Actor(obj); if (!actor.isValid()) { return cb(Errors.Invalid('Failed to create Actor object')); } const subject = row.subject || actor.id; return cb(null, actor, subject); } ); } static _fromWebFinger(actorQuery, cb) { queryWebFinger(actorQuery, (err, res) => { if (err) { return cb(err); } // we need a link with 'application/activity+json' const links = res.links; if (!Array.isArray(links)) { return cb(Errors.DoesNotExist('No "links" object in WebFinger response')); } const activityLink = links.find(l => { return l.type === ActivityStreamMediaType && l.href?.length > 0; }); if (!activityLink) { return cb( Errors.DoesNotExist('No Activity link found in WebFinger response') ); } // we can now query the href value for an Actor return Actor._fromRemoteQuery(activityLink.href, (err, actor) => { return cb(err, actor, res.subject); }); }); } };