import { literal, Op, QueryTypes, Transaction } from 'sequelize' import { AllowNull, BelongsTo, Column, CreatedAt, DataType, DefaultScope, ForeignKey, HasMany, HasOne, Is, Model, Scopes, Table, UpdatedAt } from 'sequelize-typescript' import { activityPubContextify } from '@server/lib/activitypub/context' import { getBiggestActorImage } from '@server/lib/actor-image' import { ModelCache } from '@server/models/model-cache' import { getLowercaseExtension } from '@shared/core-utils' import { ActivityIconObject, ActivityPubActorType, ActorImageType } from '@shared/models' import { AttributesOnly } from '@shared/typescript-utils' import { isActorFollowersCountValid, isActorFollowingCountValid, isActorPreferredUsernameValid, isActorPrivateKeyValid, isActorPublicKeyValid } from '../../helpers/custom-validators/activitypub/actor' import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc' import { ACTIVITY_PUB, ACTIVITY_PUB_ACTOR_TYPES, CONSTRAINTS_FIELDS, MIMETYPES, SERVER_ACTOR_NAME, WEBSERVER } from '../../initializers/constants' import { MActor, MActorAccountChannelId, MActorAPAccount, MActorAPChannel, MActorFollowersUrl, MActorFormattable, MActorFull, MActorHost, MActorId, MActorServer, MActorSummaryFormattable, MActorUrl, MActorWithInboxes } from '../../types/models' import { AccountModel } from '../account/account' import { getServerActor } from '../application/application' import { ServerModel } from '../server/server' import { isOutdated, throwIfNotValid } from '../utils' import { VideoModel } from '../video/video' import { VideoChannelModel } from '../video/video-channel' import { ActorFollowModel } from './actor-follow' import { ActorImageModel } from './actor-image' enum ScopeNames { FULL = 'FULL' } export const unusedActorAttributesForAPI = [ 'publicKey', 'privateKey', 'inboxUrl', 'outboxUrl', 'sharedInboxUrl', 'followersUrl', 'followingUrl' ] @DefaultScope(() => ({ include: [ { model: ServerModel, required: false }, { model: ActorImageModel, as: 'Avatars', required: false } ] })) @Scopes(() => ({ [ScopeNames.FULL]: { include: [ { model: AccountModel.unscoped(), required: false }, { model: VideoChannelModel.unscoped(), required: false, include: [ { model: AccountModel, required: true } ] }, { model: ServerModel, required: false }, { model: ActorImageModel, as: 'Avatars', required: false }, { model: ActorImageModel, as: 'Banners', required: false } ] } })) @Table({ tableName: 'actor', indexes: [ { fields: [ 'url' ], unique: true }, { fields: [ 'preferredUsername', 'serverId' ], unique: true, where: { serverId: { [Op.ne]: null } } }, { fields: [ 'preferredUsername' ], unique: true, where: { serverId: null } }, { fields: [ 'inboxUrl', 'sharedInboxUrl' ] }, { fields: [ 'sharedInboxUrl' ] }, { fields: [ 'serverId' ] }, { fields: [ 'followersUrl' ] } ] }) export class ActorModel extends Model>> { @AllowNull(false) @Column(DataType.ENUM(...Object.values(ACTIVITY_PUB_ACTOR_TYPES))) type: ActivityPubActorType @AllowNull(false) @Is('ActorPreferredUsername', value => throwIfNotValid(value, isActorPreferredUsernameValid, 'actor preferred username')) @Column preferredUsername: string @AllowNull(false) @Is('ActorUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url')) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) url: string @AllowNull(true) @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPublicKeyValid, 'public key', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PUBLIC_KEY.max)) publicKey: string @AllowNull(true) @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPrivateKeyValid, 'private key', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PRIVATE_KEY.max)) privateKey: string @AllowNull(false) @Is('ActorFollowersCount', value => throwIfNotValid(value, isActorFollowersCountValid, 'followers count')) @Column followersCount: number @AllowNull(false) @Is('ActorFollowersCount', value => throwIfNotValid(value, isActorFollowingCountValid, 'following count')) @Column followingCount: number @AllowNull(false) @Is('ActorInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'inbox url')) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) inboxUrl: string @AllowNull(true) @Is('ActorOutboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'outbox url', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) outboxUrl: string @AllowNull(true) @Is('ActorSharedInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'shared inbox url', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) sharedInboxUrl: string @AllowNull(true) @Is('ActorFollowersUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'followers url', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) followersUrl: string @AllowNull(true) @Is('ActorFollowingUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'following url', true)) @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max)) followingUrl: string @AllowNull(true) @Column remoteCreatedAt: Date @CreatedAt createdAt: Date @UpdatedAt updatedAt: Date @HasMany(() => ActorImageModel, { as: 'Avatars', onDelete: 'cascade', hooks: true, foreignKey: { allowNull: false }, scope: { type: ActorImageType.AVATAR } }) Avatars: ActorImageModel[] @HasMany(() => ActorImageModel, { as: 'Banners', onDelete: 'cascade', hooks: true, foreignKey: { allowNull: false }, scope: { type: ActorImageType.BANNER } }) Banners: ActorImageModel[] @HasMany(() => ActorFollowModel, { foreignKey: { name: 'actorId', allowNull: false }, as: 'ActorFollowings', onDelete: 'cascade' }) ActorFollowing: ActorFollowModel[] @HasMany(() => ActorFollowModel, { foreignKey: { name: 'targetActorId', allowNull: false }, as: 'ActorFollowers', onDelete: 'cascade' }) ActorFollowers: ActorFollowModel[] @ForeignKey(() => ServerModel) @Column serverId: number @BelongsTo(() => ServerModel, { foreignKey: { allowNull: true }, onDelete: 'cascade' }) Server: ServerModel @HasOne(() => AccountModel, { foreignKey: { allowNull: true }, onDelete: 'cascade', hooks: true }) Account: AccountModel @HasOne(() => VideoChannelModel, { foreignKey: { allowNull: true }, onDelete: 'cascade', hooks: true }) VideoChannel: VideoChannelModel static async load (id: number): Promise { const actorServer = await getServerActor() if (id === actorServer.id) return actorServer return ActorModel.unscoped().findByPk(id) } static loadFull (id: number): Promise { return ActorModel.scope(ScopeNames.FULL).findByPk(id) } static loadAccountActorFollowerUrlByVideoId (videoId: number, transaction: Transaction) { const query = `SELECT "actor"."id" AS "id", "actor"."followersUrl" AS "followersUrl" ` + `FROM "actor" ` + `INNER JOIN "account" ON "actor"."id" = "account"."actorId" ` + `INNER JOIN "videoChannel" ON "videoChannel"."accountId" = "account"."id" ` + `INNER JOIN "video" ON "video"."channelId" = "videoChannel"."id" AND "video"."id" = :videoId` const options = { type: QueryTypes.SELECT as QueryTypes.SELECT, replacements: { videoId }, plain: true as true, transaction } return ActorModel.sequelize.query(query, options) } static listByFollowersUrls (followersUrls: string[], transaction?: Transaction): Promise { const query = { where: { followersUrl: { [Op.in]: followersUrls } }, transaction } return ActorModel.scope(ScopeNames.FULL).findAll(query) } static loadLocalByName (preferredUsername: string, transaction?: Transaction): Promise { const fun = () => { const query = { where: { preferredUsername, serverId: null }, transaction } return ActorModel.scope(ScopeNames.FULL).findOne(query) } return ModelCache.Instance.doCache({ cacheType: 'local-actor-name', key: preferredUsername, // The server actor never change, so we can easily cache it whitelist: () => preferredUsername === SERVER_ACTOR_NAME, fun }) } static loadLocalUrlByName (preferredUsername: string, transaction?: Transaction): Promise { const fun = () => { const query = { attributes: [ 'url' ], where: { preferredUsername, serverId: null }, transaction } return ActorModel.unscoped().findOne(query) } return ModelCache.Instance.doCache({ cacheType: 'local-actor-name', key: preferredUsername, // The server actor never change, so we can easily cache it whitelist: () => preferredUsername === SERVER_ACTOR_NAME, fun }) } static loadByNameAndHost (preferredUsername: string, host: string): Promise { const query = { where: { preferredUsername }, include: [ { model: ServerModel, required: true, where: { host } } ] } return ActorModel.scope(ScopeNames.FULL).findOne(query) } static loadByUrl (url: string, transaction?: Transaction): Promise { const query = { where: { url }, transaction, include: [ { attributes: [ 'id' ], model: AccountModel.unscoped(), required: false }, { attributes: [ 'id' ], model: VideoChannelModel.unscoped(), required: false } ] } return ActorModel.unscoped().findOne(query) } static loadByUrlAndPopulateAccountAndChannel (url: string, transaction?: Transaction): Promise { const query = { where: { url }, transaction } return ActorModel.scope(ScopeNames.FULL).findOne(query) } static rebuildFollowsCount (ofId: number, type: 'followers' | 'following', transaction?: Transaction) { const sanitizedOfId = parseInt(ofId + '', 10) const where = { id: sanitizedOfId } let columnToUpdate: string let columnOfCount: string if (type === 'followers') { columnToUpdate = 'followersCount' columnOfCount = 'targetActorId' } else { columnToUpdate = 'followingCount' columnOfCount = 'actorId' } return ActorModel.update({ [columnToUpdate]: literal(`(SELECT COUNT(*) FROM "actorFollow" WHERE "${columnOfCount}" = ${sanitizedOfId} AND "state" = 'accepted')`) }, { where, transaction }) } static loadAccountActorByVideoId (videoId: number, transaction: Transaction): Promise { const query = { include: [ { attributes: [ 'id' ], model: AccountModel.unscoped(), required: true, include: [ { attributes: [ 'id', 'accountId' ], model: VideoChannelModel.unscoped(), required: true, include: [ { attributes: [ 'id', 'channelId' ], model: VideoModel.unscoped(), where: { id: videoId } } ] } ] } ], transaction } return ActorModel.unscoped().findOne(query) } getSharedInbox (this: MActorWithInboxes) { return this.sharedInboxUrl || this.inboxUrl } toFormattedSummaryJSON (this: MActorSummaryFormattable) { return { url: this.url, name: this.preferredUsername, host: this.getHost(), avatars: (this.Avatars || []).map(a => a.toFormattedJSON()), // TODO: remove, deprecated in 4.2 avatar: this.hasImage(ActorImageType.AVATAR) ? this.Avatars[0].toFormattedJSON() : undefined } } toFormattedJSON (this: MActorFormattable) { return { ...this.toFormattedSummaryJSON(), id: this.id, hostRedundancyAllowed: this.getRedundancyAllowed(), followingCount: this.followingCount, followersCount: this.followersCount, createdAt: this.getCreatedAt(), banners: (this.Banners || []).map(b => b.toFormattedJSON()), // TODO: remove, deprecated in 4.2 banner: this.hasImage(ActorImageType.BANNER) ? this.Banners[0].toFormattedJSON() : undefined } } toActivityPubObject (this: MActorAPChannel | MActorAPAccount, name: string) { let icon: ActivityIconObject let icons: ActivityIconObject[] let image: ActivityIconObject if (this.hasImage(ActorImageType.AVATAR)) { icon = getBiggestActorImage(this.Avatars).toActivityPubObject() icons = this.Avatars.map(a => a.toActivityPubObject()) } if (this.hasImage(ActorImageType.BANNER)) { const banner = getBiggestActorImage((this as MActorAPChannel).Banners) const extension = getLowercaseExtension(banner.filename) image = { type: 'Image', mediaType: MIMETYPES.IMAGE.EXT_MIMETYPE[extension], height: banner.height, width: banner.width, url: ActorImageModel.getImageUrl(banner) } } const json = { type: this.type, id: this.url, following: this.getFollowingUrl(), followers: this.getFollowersUrl(), playlists: this.getPlaylistsUrl(), inbox: this.inboxUrl, outbox: this.outboxUrl, preferredUsername: this.preferredUsername, url: this.url, name, endpoints: { sharedInbox: this.sharedInboxUrl }, publicKey: { id: this.getPublicKeyUrl(), owner: this.url, publicKeyPem: this.publicKey }, published: this.getCreatedAt().toISOString(), icon, icons, image } return activityPubContextify(json, 'Actor') } getFollowerSharedInboxUrls (t: Transaction) { const query = { attributes: [ 'sharedInboxUrl' ], include: [ { attribute: [], model: ActorFollowModel.unscoped(), required: true, as: 'ActorFollowing', where: { state: 'accepted', targetActorId: this.id } } ], transaction: t } return ActorModel.findAll(query) .then(accounts => accounts.map(a => a.sharedInboxUrl)) } getFollowingUrl () { return this.url + '/following' } getFollowersUrl () { return this.url + '/followers' } getPlaylistsUrl () { return this.url + '/playlists' } getPublicKeyUrl () { return this.url + '#main-key' } isOwned () { return this.serverId === null } getWebfingerUrl (this: MActorServer) { return 'acct:' + this.preferredUsername + '@' + this.getHost() } getIdentifier () { return this.Server ? `${this.preferredUsername}@${this.Server.host}` : this.preferredUsername } getHost (this: MActorHost) { return this.Server ? this.Server.host : WEBSERVER.HOST } getRedundancyAllowed () { return this.Server ? this.Server.redundancyAllowed : false } hasImage (type: ActorImageType) { const images = type === ActorImageType.AVATAR ? this.Avatars : this.Banners return Array.isArray(images) && images.length !== 0 } isOutdated () { if (this.isOwned()) return false return isOutdated(this, ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL) } getCreatedAt (this: MActorAPChannel | MActorAPAccount | MActorFormattable) { return this.remoteCreatedAt || this.createdAt } }