-import { join } from 'path'
+import { values } from 'lodash'
+import { extname } from 'path'
import * as Sequelize from 'sequelize'
import {
- AllowNull, BelongsTo, Column, CreatedAt, DataType, Default, ForeignKey, HasMany, Is, IsUUID, Model, Table,
+ AllowNull,
+ BelongsTo,
+ Column,
+ CreatedAt,
+ DataType,
+ DefaultScope,
+ ForeignKey,
+ HasMany,
+ HasOne,
+ Is,
+ Model,
+ Scopes,
+ Table,
UpdatedAt
} from 'sequelize-typescript'
+import { ActivityPubActorType } from '../../../shared/models/activitypub'
import { Avatar } from '../../../shared/models/avatars/avatar.model'
-import { activityPubContextify } from '../../helpers'
+import { activityPubContextify } from '../../helpers/activitypub'
import {
- isActivityPubUrlValid,
isActorFollowersCountValid,
- isActorFollowingCountValid, isActorPreferredUsernameValid,
+ isActorFollowingCountValid,
+ isActorPreferredUsernameValid,
isActorPrivateKeyValid,
isActorPublicKeyValid
-} from '../../helpers/custom-validators/activitypub'
-import { isUserUsernameValid } from '../../helpers/custom-validators/users'
-import { AVATARS_DIR, CONFIG, CONSTRAINTS_FIELDS } from '../../initializers'
-import { AccountFollowModel } from '../account/account-follow'
+} 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'
+import { AccountModel } from '../account/account'
import { AvatarModel } from '../avatar/avatar'
import { ServerModel } from '../server/server'
-import { throwIfNotValid } from '../utils'
+import { isOutdated, throwIfNotValid } from '../utils'
+import { VideoChannelModel } from '../video/video-channel'
+import { ActorFollowModel } from './actor-follow'
+import { VideoModel } from '../video/video'
+import {
+ MActor,
+ MActorAccountChannelId,
+ MActorAP,
+ MActorFormattable,
+ MActorFull,
+ MActorHost,
+ MActorServer,
+ MActorSummaryFormattable
+} from '../../typings/models'
+import * as Bluebird from 'bluebird'
+
+enum ScopeNames {
+ FULL = 'FULL'
+}
+export const unusedActorAttributesForAPI = [
+ 'publicKey',
+ 'privateKey',
+ 'inboxUrl',
+ 'outboxUrl',
+ 'sharedInboxUrl',
+ 'followersUrl',
+ 'followingUrl',
+ 'url',
+ 'createdAt',
+ 'updatedAt'
+]
+
+@DefaultScope(() => ({
+ include: [
+ {
+ model: ServerModel,
+ required: false
+ },
+ {
+ model: AvatarModel,
+ 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: AvatarModel,
+ required: false
+ }
+ ]
+ }
+}))
@Table({
- tableName: 'actor'
+ tableName: 'actor',
+ indexes: [
+ {
+ fields: [ 'url' ],
+ unique: true
+ },
+ {
+ fields: [ 'preferredUsername', 'serverId' ],
+ unique: true
+ },
+ {
+ fields: [ 'inboxUrl', 'sharedInboxUrl' ]
+ },
+ {
+ fields: [ 'sharedInboxUrl' ]
+ },
+ {
+ fields: [ 'serverId' ]
+ },
+ {
+ fields: [ 'avatarId' ]
+ },
+ {
+ fields: [ 'followersUrl' ]
+ }
+ ]
})
export class ActorModel extends Model<ActorModel> {
@AllowNull(false)
- @Default(DataType.UUIDV4)
- @IsUUID(4)
- @Column(DataType.UUID)
- uuid: string
+ @Column(DataType.ENUM(...values(ACTIVITY_PUB_ACTOR_TYPES)))
+ type: ActivityPubActorType
@AllowNull(false)
- @Is('ActorName', value => throwIfNotValid(value, isActorPreferredUsernameValid, 'actor name'))
+ @Is('ActorPreferredUsername', value => throwIfNotValid(value, isActorPreferredUsernameValid, 'actor preferred username'))
@Column
- name: string
+ preferredUsername: string
@AllowNull(false)
@Is('ActorUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.URL.max))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
url: string
@AllowNull(true)
- @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPublicKeyValid, 'public key'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.PUBLIC_KEY.max))
+ @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'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.PRIVATE_KEY.max))
+ @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPrivateKeyValid, 'private key', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PRIVATE_KEY.max))
privateKey: string
@AllowNull(false)
@AllowNull(false)
@Is('ActorInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'inbox url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.URL.max))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
inboxUrl: string
- @AllowNull(false)
- @Is('ActorOutboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'outbox url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.URL.max))
+ @AllowNull(true)
+ @Is('ActorOutboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'outbox url', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
outboxUrl: string
@AllowNull(false)
@Is('ActorSharedInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'shared inbox url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.URL.max))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
sharedInboxUrl: string
- @AllowNull(false)
- @Is('ActorFollowersUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'followers url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.URL.max))
+ @AllowNull(true)
+ @Is('ActorFollowersUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'followers url', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
followersUrl: string
- @AllowNull(false)
- @Is('ActorFollowingUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'following url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTOR.URL.max))
+ @AllowNull(true)
+ @Is('ActorFollowingUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'following url', true))
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
followingUrl: string
@CreatedAt
foreignKey: {
allowNull: true
},
- onDelete: 'cascade'
+ onDelete: 'set null',
+ hooks: true
})
Avatar: AvatarModel
- @HasMany(() => AccountFollowModel, {
+ @HasMany(() => ActorFollowModel, {
foreignKey: {
- name: 'accountId',
+ name: 'actorId',
allowNull: false
},
+ as: 'ActorFollowings',
onDelete: 'cascade'
})
- AccountFollowing: AccountFollowModel[]
+ ActorFollowing: ActorFollowModel[]
- @HasMany(() => AccountFollowModel, {
+ @HasMany(() => ActorFollowModel, {
foreignKey: {
- name: 'targetAccountId',
+ name: 'targetActorId',
allowNull: false
},
- as: 'followers',
+ as: 'ActorFollowers',
onDelete: 'cascade'
})
- AccountFollowers: AccountFollowModel[]
+ ActorFollowers: ActorFollowModel[]
@ForeignKey(() => ServerModel)
@Column
})
Server: ServerModel
- static listByFollowersUrls (followersUrls: string[], transaction?: Sequelize.Transaction) {
+ @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): Bluebird<MActor> {
+ return ActorModel.unscoped().findByPk(id)
+ }
+
+ 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,
+ 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?: Sequelize.Transaction): Bluebird<MActorFull[]> {
const query = {
where: {
followersUrl: {
transaction
}
- return ActorModel.findAll(query)
+ return ActorModel.scope(ScopeNames.FULL).findAll(query)
+ }
+
+ static loadLocalByName (preferredUsername: string, transaction?: Sequelize.Transaction): Bluebird<MActorFull> {
+ const query = {
+ where: {
+ preferredUsername,
+ serverId: null
+ },
+ transaction
+ }
+
+ return ActorModel.scope(ScopeNames.FULL).findOne(query)
}
- toFormattedJSON () {
+ static loadByNameAndHost (preferredUsername: string, host: string): Bluebird<MActorFull> {
+ const query = {
+ where: {
+ preferredUsername
+ },
+ include: [
+ {
+ model: ServerModel,
+ required: true,
+ where: {
+ host
+ }
+ }
+ ]
+ }
+
+ return ActorModel.scope(ScopeNames.FULL).findOne(query)
+ }
+
+ 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)
+ }
+
+ static loadByUrlAndPopulateAccountAndChannel (url: string, transaction?: Sequelize.Transaction): Bluebird<MActorFull> {
+ const query = {
+ where: {
+ url
+ },
+ transaction
+ }
+
+ return ActorModel.scope(ScopeNames.FULL).findOne(query)
+ }
+
+ static incrementFollows (id: number, column: 'followersCount' | 'followingCount', by: number) {
+ return ActorModel.increment(column, {
+ by,
+ where: {
+ id
+ }
+ })
+ }
+
+ toFormattedSummaryJSON (this: MActorSummaryFormattable) {
let avatar: Avatar = null
if (this.Avatar) {
- avatar = {
- path: join(AVATARS_DIR.ACCOUNT, this.Avatar.filename),
- createdAt: this.Avatar.createdAt,
- updatedAt: this.Avatar.updatedAt
- }
+ avatar = this.Avatar.toFormattedJSON()
}
- let host = CONFIG.WEBSERVER.HOST
- let score: number
- if (this.Server) {
- host = this.Server.host
- score = this.Server.score
+ return {
+ url: this.url,
+ name: this.preferredUsername,
+ host: this.getHost(),
+ avatar
}
+ }
- return {
+ toFormattedJSON (this: MActorFormattable) {
+ const base = this.toFormattedSummaryJSON()
+
+ return Object.assign(base, {
id: this.id,
- host,
- score,
+ hostRedundancyAllowed: this.getRedundancyAllowed(),
followingCount: this.followingCount,
followersCount: this.followersCount,
- avatar
- }
+ createdAt: this.createdAt,
+ updatedAt: this.updatedAt
+ })
}
- toActivityPubObject (name: string, uuid: string, type: 'Account' | 'VideoChannel') {
+ toActivityPubObject (this: MActorAP, name: string) {
let activityPubType
- if (type === 'Account') {
- activityPubType = this.serverId ? 'Application' as 'Application' : 'Person' as 'Person'
- } else { // VideoChannel
- activityPubType = 'Group'
+
+ 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()
+ }
}
const json = {
- type,
+ type: this.type,
id: this.url,
following: this.getFollowingUrl(),
followers: this.getFollowersUrl(),
+ playlists: this.getPlaylistsUrl(),
inbox: this.inboxUrl,
outbox: this.outboxUrl,
- preferredUsername: name,
+ preferredUsername: this.preferredUsername,
url: this.url,
name,
endpoints: {
sharedInbox: this.sharedInboxUrl
},
- uuid,
publicKey: {
id: this.getPublicKeyUrl(),
owner: this.url,
publicKeyPem: this.publicKey
- }
+ },
+ icon
}
return activityPubContextify(json)
attributes: [ 'sharedInboxUrl' ],
include: [
{
- model: AccountFollowModel,
+ attribute: [],
+ model: ActorFollowModel.unscoped(),
required: true,
- as: 'followers',
+ as: 'ActorFollowing',
where: {
- targetAccountId: this.id
+ state: 'accepted',
+ targetActorId: this.id
}
}
],
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()
+ }
+
+ isOutdated () {
+ if (this.isOwned()) return false
+
+ return isOutdated(this, ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL)
+ }
}
projects / github / Chocobozzz / PeerTube.git / blobdiff