PeerTube/server/models/activitypub/actor.ts

694 lines
16 KiB
TypeScript

import { values } from 'lodash'
import { extname } from 'path'
import { literal, Op, Transaction } from 'sequelize'
import {
AllowNull,
BelongsTo,
Column,
CreatedAt,
DataType,
DefaultScope,
ForeignKey,
HasMany,
HasOne,
Is,
Model,
Scopes,
Table,
UpdatedAt
} from 'sequelize-typescript'
import { ModelCache } from '@server/models/model-cache'
import { ActivityIconObject, ActivityPubActorType } from '../../../shared/models/activitypub'
import { ActorImage } from '../../../shared/models/actors/actor-image.model'
import { activityPubContextify } from '../../helpers/activitypub'
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,
MActorFormattable,
MActorFull,
MActorHost,
MActorServer,
MActorSummaryFormattable,
MActorUrl,
MActorWithInboxes
} from '../../types/models'
import { AccountModel } from '../account/account'
import { ActorImageModel } from '../account/actor-image'
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'
enum ScopeNames {
FULL = 'FULL'
}
export const unusedActorAttributesForAPI = [
'publicKey',
'privateKey',
'inboxUrl',
'outboxUrl',
'sharedInboxUrl',
'followersUrl',
'followingUrl',
'createdAt',
'updatedAt'
]
@DefaultScope(() => ({
include: [
{
model: ServerModel,
required: false
},
{
model: ActorImageModel,
as: 'Avatar',
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: 'Avatar',
required: false
},
{
model: ActorImageModel,
as: 'Banner',
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: [ 'avatarId' ]
},
{
fields: [ 'followersUrl' ]
}
]
})
export class ActorModel extends Model {
@AllowNull(false)
@Column(DataType.ENUM(...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
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
@ForeignKey(() => ActorImageModel)
@Column
avatarId: number
@ForeignKey(() => ActorImageModel)
@Column
bannerId: number
@BelongsTo(() => ActorImageModel, {
foreignKey: {
name: 'avatarId',
allowNull: true
},
as: 'Avatar',
onDelete: 'set null',
hooks: true
})
Avatar: ActorImageModel
@BelongsTo(() => ActorImageModel, {
foreignKey: {
name: 'bannerId',
allowNull: true
},
as: 'Banner',
onDelete: 'set null',
hooks: true
})
Banner: 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 load (id: number): Promise<MActor> {
return ActorModel.unscoped().findByPk(id)
}
static loadFull (id: number): Promise<MActorFull> {
return ActorModel.scope(ScopeNames.FULL).findByPk(id)
}
static loadFromAccountByVideoId (videoId: number, transaction: Transaction): Promise<MActor> {
const query = {
include: [
{
attributes: [ 'id' ],
model: AccountModel.unscoped(),
required: true,
include: [
{
attributes: [ 'id' ],
model: VideoChannelModel.unscoped(),
required: true,
include: [
{
attributes: [ 'id' ],
model: VideoModel.unscoped(),
required: true,
where: {
id: videoId
}
}
]
}
]
}
],
transaction
}
return ActorModel.unscoped().findOne(query)
}
static isActorUrlExist (url: string) {
const query = {
raw: true,
where: {
url
}
}
return ActorModel.unscoped().findOne(query)
.then(a => !!a)
}
static listByFollowersUrls (followersUrls: string[], transaction?: Transaction): Promise<MActorFull[]> {
const query = {
where: {
followersUrl: {
[Op.in]: followersUrls
}
},
transaction
}
return ActorModel.scope(ScopeNames.FULL).findAll(query)
}
static loadLocalByName (preferredUsername: string, transaction?: Transaction): Promise<MActorFull> {
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<MActorUrl> {
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<MActorFull> {
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<MActorAccountChannelId> {
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<MActorFull> {
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})`)
}, { where, transaction })
}
static loadAccountActorByVideoId (videoId: number): Promise<MActor> {
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
}
}
]
}
]
}
]
}
return ActorModel.unscoped().findOne(query)
}
getSharedInbox (this: MActorWithInboxes) {
return this.sharedInboxUrl || this.inboxUrl
}
toFormattedSummaryJSON (this: MActorSummaryFormattable) {
let avatar: ActorImage = null
if (this.Avatar) {
avatar = this.Avatar.toFormattedJSON()
}
return {
url: this.url,
name: this.preferredUsername,
host: this.getHost(),
avatar
}
}
toFormattedJSON (this: MActorFormattable) {
const base = this.toFormattedSummaryJSON()
let banner: ActorImage = null
if (this.Banner) {
banner = this.Banner.toFormattedJSON()
}
return Object.assign(base, {
id: this.id,
hostRedundancyAllowed: this.getRedundancyAllowed(),
followingCount: this.followingCount,
followersCount: this.followersCount,
banner,
createdAt: this.createdAt,
updatedAt: this.updatedAt
})
}
toActivityPubObject (this: MActorAPChannel | MActorAPAccount, name: string) {
let icon: ActivityIconObject
let image: ActivityIconObject
if (this.avatarId) {
const extension = extname(this.Avatar.filename)
icon = {
type: 'Image',
mediaType: MIMETYPES.IMAGE.EXT_MIMETYPE[extension],
height: this.Avatar.height,
width: this.Avatar.width,
url: this.getAvatarUrl()
}
}
if (this.bannerId) {
const banner = (this as MActorAPChannel).Banner
const extension = extname(banner.filename)
image = {
type: 'Image',
mediaType: MIMETYPES.IMAGE.EXT_MIMETYPE[extension],
height: banner.height,
width: banner.width,
url: this.getBannerUrl()
}
}
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
},
icon,
image
}
return activityPubContextify(json)
}
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
}
getAvatarUrl () {
if (!this.avatarId) return undefined
return WEBSERVER.URL + this.Avatar.getStaticPath()
}
getBannerUrl () {
if (!this.bannerId) return undefined
return WEBSERVER.URL + this.Banner.getStaticPath()
}
isOutdated () {
if (this.isOwned()) return false
return isOutdated(this, ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL)
}
}