PeerTube/server/models/activitypub/actor.ts

543 lines
12 KiB
TypeScript
Raw Normal View History

2017-12-14 17:38:41 +01:00
import { values } from 'lodash'
2018-01-03 10:12:36 +01:00
import { extname } from 'path'
2017-12-14 11:18:49 +01:00
import * as Sequelize from 'sequelize'
import {
AllowNull,
BelongsTo,
Column,
CreatedAt,
DataType,
DefaultScope,
ForeignKey,
HasMany,
HasOne,
Is,
Model,
Scopes,
Table,
UpdatedAt
2017-12-14 11:18:49 +01:00
} from 'sequelize-typescript'
2017-12-14 17:38:41 +01:00
import { ActivityPubActorType } from '../../../shared/models/activitypub'
2017-12-14 11:18:49 +01:00
import { Avatar } from '../../../shared/models/avatars/avatar.model'
2017-12-28 11:16:08 +01:00
import { activityPubContextify } from '../../helpers/activitypub'
2017-12-14 11:18:49 +01:00
import {
isActorFollowersCountValid,
isActorFollowingCountValid,
isActorPreferredUsernameValid,
isActorPrivateKeyValid,
2017-12-28 11:16:08 +01:00
isActorPublicKeyValid
} from '../../helpers/custom-validators/activitypub/actor'
import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
import { ACTIVITY_PUB, ACTIVITY_PUB_ACTOR_TYPES, CONSTRAINTS_FIELDS, WEBSERVER } from '../../initializers/constants'
2017-12-14 17:38:41 +01:00
import { AccountModel } from '../account/account'
2017-12-14 11:18:49 +01:00
import { AvatarModel } from '../avatar/avatar'
import { ServerModel } from '../server/server'
2019-03-19 14:13:53 +01:00
import { isOutdated, throwIfNotValid } from '../utils'
2017-12-14 17:38:41 +01:00
import { VideoChannelModel } from '../video/video-channel'
import { ActorFollowModel } from './actor-follow'
import { VideoModel } from '../video/video'
2019-08-20 19:05:31 +02:00
import {
MActor,
MActorAccountChannelId,
2019-08-21 14:31:57 +02:00
MActorAP,
2019-08-20 19:05:31 +02:00
MActorFormattable,
2019-08-21 14:31:57 +02:00
MActorFull,
MActorHost,
2019-08-20 19:05:31 +02:00
MActorServer,
MActorSummaryFormattable,
MActorWithInboxes
2019-08-20 19:05:31 +02:00
} from '../../typings/models'
2019-08-15 11:53:26 +02:00
import * as Bluebird from 'bluebird'
2017-12-14 11:18:49 +01:00
2017-12-14 17:38:41 +01:00
enum ScopeNames {
FULL = 'FULL'
}
2018-08-23 17:58:39 +02:00
export const unusedActorAttributesForAPI = [
'publicKey',
'privateKey',
'inboxUrl',
'outboxUrl',
'sharedInboxUrl',
'followersUrl',
'followingUrl',
2018-08-24 11:04:02 +02:00
'url',
'createdAt',
'updatedAt'
2018-08-23 17:58:39 +02:00
]
2019-04-23 09:50:57 +02:00
@DefaultScope(() => ({
2017-12-18 11:53:04 +01:00
include: [
{
2019-04-23 09:50:57 +02:00
model: ServerModel,
2017-12-18 11:53:04 +01:00
required: false
2017-12-29 19:10:13 +01:00
},
{
2019-04-23 09:50:57 +02:00
model: AvatarModel,
2017-12-29 19:10:13 +01:00
required: false
2017-12-18 11:53:04 +01:00
}
]
2019-04-23 09:50:57 +02:00
}))
@Scopes(() => ({
2017-12-14 17:38:41 +01:00
[ScopeNames.FULL]: {
include: [
{
2019-04-23 09:50:57 +02:00
model: AccountModel.unscoped(),
2017-12-14 17:38:41 +01:00
required: false
},
{
2019-04-23 09:50:57 +02:00
model: VideoChannelModel.unscoped(),
2018-09-11 16:27:07 +02:00
required: false,
include: [
{
2019-04-23 09:50:57 +02:00
model: AccountModel,
2018-09-11 16:27:07 +02:00
required: true
}
]
2017-12-18 11:53:04 +01:00
},
{
2019-04-23 09:50:57 +02:00
model: ServerModel,
2017-12-18 11:53:04 +01:00
required: false
2017-12-29 19:10:13 +01:00
},
{
2019-04-23 09:50:57 +02:00
model: AvatarModel,
2017-12-29 19:10:13 +01:00
required: false
2017-12-14 17:38:41 +01:00
}
2019-04-23 09:50:57 +02:00
]
2017-12-14 17:38:41 +01:00
}
2019-04-23 09:50:57 +02:00
}))
2017-12-14 11:18:49 +01:00
@Table({
2017-12-14 17:38:41 +01:00
tableName: 'actor',
indexes: [
2018-01-10 17:18:12 +01:00
{
2018-07-23 20:13:30 +02:00
fields: [ 'url' ],
unique: true
2018-01-10 17:18:12 +01:00
},
2017-12-14 17:38:41 +01:00
{
2017-12-19 10:34:56 +01:00
fields: [ 'preferredUsername', 'serverId' ],
2017-12-14 17:38:41 +01:00
unique: true
},
{
fields: [ 'inboxUrl', 'sharedInboxUrl' ]
2018-07-19 16:17:54 +02:00
},
2018-07-31 18:04:45 +02:00
{
fields: [ 'sharedInboxUrl' ]
},
2018-07-19 16:17:54 +02:00
{
fields: [ 'serverId' ]
},
{
fields: [ 'avatarId' ]
2018-07-23 20:13:30 +02:00
},
{
fields: [ 'followersUrl' ]
2017-12-14 17:38:41 +01:00
}
]
2017-12-14 11:18:49 +01:00
})
export class ActorModel extends Model<ActorModel> {
2017-12-14 17:38:41 +01:00
@AllowNull(false)
2019-04-23 09:50:57 +02:00
@Column(DataType.ENUM(...values(ACTIVITY_PUB_ACTOR_TYPES)))
2017-12-14 17:38:41 +01:00
type: ActivityPubActorType
2017-12-14 11:18:49 +01:00
@AllowNull(false)
2017-12-19 10:34:56 +01:00
@Is('ActorPreferredUsername', value => throwIfNotValid(value, isActorPreferredUsernameValid, 'actor preferred username'))
2017-12-14 11:18:49 +01:00
@Column
2017-12-19 10:34:56 +01:00
preferredUsername: string
2017-12-14 11:18:49 +01:00
@AllowNull(false)
@Is('ActorUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
2017-12-14 11:18:49 +01:00
url: string
@AllowNull(true)
2019-04-18 11:28:17 +02:00
@Is('ActorPublicKey', value => throwIfNotValid(value, isActorPublicKeyValid, 'public key', true))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PUBLIC_KEY.max))
2017-12-14 11:18:49 +01:00
publicKey: string
@AllowNull(true)
2019-04-18 11:28:17 +02:00
@Is('ActorPublicKey', value => throwIfNotValid(value, isActorPrivateKeyValid, 'private key', true))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PRIVATE_KEY.max))
2017-12-14 11:18:49 +01:00
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'))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
2017-12-14 11:18:49 +01:00
inboxUrl: string
2019-08-30 09:40:21 +02:00
@AllowNull(true)
@Is('ActorOutboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'outbox url', true))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
2017-12-14 11:18:49 +01:00
outboxUrl: string
@AllowNull(true)
@Is('ActorSharedInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'shared inbox url', true))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
2017-12-14 11:18:49 +01:00
sharedInboxUrl: string
2019-08-30 09:40:21 +02:00
@AllowNull(true)
@Is('ActorFollowersUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'followers url', true))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
2017-12-14 11:18:49 +01:00
followersUrl: string
2019-08-30 09:40:21 +02:00
@AllowNull(true)
@Is('ActorFollowingUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'following url', true))
2018-01-03 11:10:40 +01:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
2017-12-14 11:18:49 +01:00
followingUrl: string
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
@ForeignKey(() => AvatarModel)
@Column
avatarId: number
@BelongsTo(() => AvatarModel, {
foreignKey: {
allowNull: true
},
onDelete: 'set null',
hooks: true
2017-12-14 11:18:49 +01:00
})
Avatar: AvatarModel
2017-12-14 17:38:41 +01:00
@HasMany(() => ActorFollowModel, {
2017-12-14 11:18:49 +01:00
foreignKey: {
2017-12-14 17:38:41 +01:00
name: 'actorId',
2017-12-14 11:18:49 +01:00
allowNull: false
},
2018-12-26 10:36:24 +01:00
as: 'ActorFollowings',
2017-12-14 11:18:49 +01:00
onDelete: 'cascade'
})
ActorFollowing: ActorFollowModel[]
2017-12-14 11:18:49 +01:00
2017-12-14 17:38:41 +01:00
@HasMany(() => ActorFollowModel, {
2017-12-14 11:18:49 +01:00
foreignKey: {
2017-12-14 17:38:41 +01:00
name: 'targetActorId',
2017-12-14 11:18:49 +01:00
allowNull: false
},
as: 'ActorFollowers',
2017-12-14 11:18:49 +01:00
onDelete: 'cascade'
})
ActorFollowers: ActorFollowModel[]
2017-12-14 11:18:49 +01:00
@ForeignKey(() => ServerModel)
@Column
serverId: number
@BelongsTo(() => ServerModel, {
foreignKey: {
allowNull: true
},
onDelete: 'cascade'
})
Server: ServerModel
2017-12-14 17:38:41 +01:00
@HasOne(() => AccountModel, {
foreignKey: {
allowNull: true
},
onDelete: 'cascade',
hooks: true
2017-12-14 17:38:41 +01:00
})
Account: AccountModel
@HasOne(() => VideoChannelModel, {
foreignKey: {
allowNull: true
},
onDelete: 'cascade',
hooks: true
2017-12-14 17:38:41 +01:00
})
VideoChannel: VideoChannelModel
2019-08-15 11:53:26 +02:00
static load (id: number): Bluebird<MActor> {
2019-02-21 14:28:06 +01:00
return ActorModel.unscoped().findByPk(id)
2017-12-14 17:38:41 +01:00
}
2019-08-15 11:53:26 +02:00
static loadFull (id: number): Bluebird<MActorFull> {
return ActorModel.scope(ScopeNames.FULL).findByPk(id)
}
static loadFromAccountByVideoId (videoId: number, transaction: Sequelize.Transaction): Bluebird<MActor> {
const query = {
include: [
{
attributes: [ 'id' ],
model: AccountModel.unscoped(),
required: true,
include: [
{
attributes: [ 'id' ],
model: VideoChannelModel.unscoped(),
required: true,
2019-04-23 09:50:57 +02:00
include: [
{
attributes: [ 'id' ],
model: VideoModel.unscoped(),
required: true,
where: {
id: videoId
}
}
2019-04-23 09:50:57 +02:00
]
}
]
}
],
transaction
}
2019-04-23 09:50:57 +02:00
return ActorModel.unscoped().findOne(query)
}
2018-09-19 11:41:21 +02:00
static isActorUrlExist (url: string) {
const query = {
raw: true,
where: {
url
}
}
return ActorModel.unscoped().findOne(query)
.then(a => !!a)
}
2019-08-15 11:53:26 +02:00
static listByFollowersUrls (followersUrls: string[], transaction?: Sequelize.Transaction): Bluebird<MActorFull[]> {
2017-12-14 11:18:49 +01:00
const query = {
where: {
followersUrl: {
[ Sequelize.Op.in ]: followersUrls
}
},
transaction
}
2017-12-14 17:38:41 +01:00
return ActorModel.scope(ScopeNames.FULL).findAll(query)
}
2019-08-15 11:53:26 +02:00
static loadLocalByName (preferredUsername: string, transaction?: Sequelize.Transaction): Bluebird<MActorFull> {
2017-12-14 17:38:41 +01:00
const query = {
where: {
2017-12-19 10:34:56 +01:00
preferredUsername,
2017-12-14 17:38:41 +01:00
serverId: null
2018-08-17 15:45:42 +02:00
},
transaction
2017-12-14 17:38:41 +01:00
}
return ActorModel.scope(ScopeNames.FULL).findOne(query)
}
2019-08-15 11:53:26 +02:00
static loadByNameAndHost (preferredUsername: string, host: string): Bluebird<MActorFull> {
2017-12-14 17:38:41 +01:00
const query = {
where: {
2017-12-19 10:34:56 +01:00
preferredUsername
2017-12-14 17:38:41 +01:00
},
include: [
{
model: ServerModel,
required: true,
where: {
host
}
}
]
}
return ActorModel.scope(ScopeNames.FULL).findOne(query)
}
2019-08-15 11:53:26 +02:00
static loadByUrl (url: string, transaction?: Sequelize.Transaction): Bluebird<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)
}
2019-08-15 11:53:26 +02:00
static loadByUrlAndPopulateAccountAndChannel (url: string, transaction?: Sequelize.Transaction): Bluebird<MActorFull> {
2017-12-14 17:38:41 +01:00
const query = {
where: {
url
},
transaction
}
return ActorModel.scope(ScopeNames.FULL).findOne(query)
2017-12-14 11:18:49 +01:00
}
2018-01-12 11:47:45 +01:00
static incrementFollows (id: number, column: 'followersCount' | 'followingCount', by: number) {
2019-04-23 09:50:57 +02:00
return ActorModel.increment(column, {
2018-01-12 11:47:45 +01:00
by,
where: {
id
}
})
}
getSharedInbox (this: MActorWithInboxes) {
return this.sharedInboxUrl || this.inboxUrl
}
2019-08-20 19:05:31 +02:00
toFormattedSummaryJSON (this: MActorSummaryFormattable) {
2017-12-14 11:18:49 +01:00
let avatar: Avatar = null
if (this.Avatar) {
2017-12-29 19:10:13 +01:00
avatar = this.Avatar.toFormattedJSON()
2017-12-14 11:18:49 +01:00
}
return {
2018-01-04 11:19:16 +01:00
url: this.url,
name: this.preferredUsername,
2017-12-19 10:34:56 +01:00
host: this.getHost(),
2019-08-20 19:05:31 +02:00
avatar
}
}
toFormattedJSON (this: MActorFormattable) {
const base = this.toFormattedSummaryJSON()
return Object.assign(base, {
id: this.id,
2018-09-11 16:27:07 +02:00
hostRedundancyAllowed: this.getRedundancyAllowed(),
2017-12-14 11:18:49 +01:00
followingCount: this.followingCount,
followersCount: this.followersCount,
createdAt: this.createdAt,
updatedAt: this.updatedAt
2019-08-20 19:05:31 +02:00
})
2017-12-14 11:18:49 +01:00
}
toActivityPubObject (this: MActorAP, name: string) {
2017-12-29 19:10:13 +01:00
let icon = undefined
if (this.avatarId) {
const extension = extname(this.Avatar.filename)
icon = {
type: 'Image',
mediaType: extension === '.png' ? 'image/png' : 'image/jpeg',
url: this.getAvatarUrl()
}
}
2017-12-14 11:18:49 +01:00
const json = {
type: this.type,
2017-12-14 11:18:49 +01:00
id: this.url,
following: this.getFollowingUrl(),
followers: this.getFollowersUrl(),
2019-02-26 10:55:40 +01:00
playlists: this.getPlaylistsUrl(),
2017-12-14 11:18:49 +01:00
inbox: this.inboxUrl,
outbox: this.outboxUrl,
2017-12-19 10:34:56 +01:00
preferredUsername: this.preferredUsername,
2017-12-14 11:18:49 +01:00
url: this.url,
2017-12-19 10:34:56 +01:00
name,
2017-12-14 11:18:49 +01:00
endpoints: {
sharedInbox: this.sharedInboxUrl
},
publicKey: {
id: this.getPublicKeyUrl(),
owner: this.url,
publicKeyPem: this.publicKey
2017-12-29 19:10:13 +01:00
},
icon
2017-12-14 11:18:49 +01:00
}
return activityPubContextify(json)
}
getFollowerSharedInboxUrls (t: Sequelize.Transaction) {
const query = {
attributes: [ 'sharedInboxUrl' ],
include: [
{
attribute: [],
model: ActorFollowModel.unscoped(),
2017-12-14 11:18:49 +01:00
required: true,
2018-01-26 11:44:08 +01:00
as: 'ActorFollowing',
2017-12-14 11:18:49 +01:00
where: {
state: 'accepted',
2017-12-14 17:38:41 +01:00
targetActorId: this.id
2017-12-14 11:18:49 +01:00
}
}
],
transaction: t
}
return ActorModel.findAll(query)
.then(accounts => accounts.map(a => a.sharedInboxUrl))
}
getFollowingUrl () {
return this.url + '/following'
}
getFollowersUrl () {
return this.url + '/followers'
}
2019-02-26 10:55:40 +01:00
getPlaylistsUrl () {
return this.url + '/playlists'
}
2017-12-14 11:18:49 +01:00
getPublicKeyUrl () {
return this.url + '#main-key'
}
isOwned () {
return this.serverId === null
}
2017-12-19 10:34:56 +01:00
2019-08-20 19:05:31 +02:00
getWebfingerUrl (this: MActorServer) {
2017-12-19 10:34:56 +01:00
return 'acct:' + this.preferredUsername + '@' + this.getHost()
}
getIdentifier () {
return this.Server ? `${this.preferredUsername}@${this.Server.host}` : this.preferredUsername
}
2019-08-20 19:05:31 +02:00
getHost (this: MActorHost) {
2019-04-11 11:33:44 +02:00
return this.Server ? this.Server.host : WEBSERVER.HOST
2017-12-19 10:34:56 +01:00
}
2017-12-29 19:10:13 +01:00
2019-08-21 14:31:57 +02:00
getRedundancyAllowed () {
2018-09-11 16:27:07 +02:00
return this.Server ? this.Server.redundancyAllowed : false
}
2017-12-29 19:10:13 +01:00
getAvatarUrl () {
if (!this.avatarId) return undefined
2019-08-09 11:32:40 +02:00
return WEBSERVER.URL + this.Avatar.getStaticPath()
2017-12-29 19:10:13 +01:00
}
2018-01-04 14:04:02 +01:00
isOutdated () {
if (this.isOwned()) return false
2019-03-19 14:13:53 +01:00
return isOutdated(this, ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL)
2018-01-04 14:04:02 +01:00
}
2017-12-14 11:18:49 +01:00
}