import { values } from 'lodash'
import { extname } from 'path'
-import * as Sequelize from 'sequelize'
+import { literal, Op, Transaction } from 'sequelize'
import {
- AllowNull, BelongsTo, Column, CreatedAt, DataType, Default, DefaultScope, ForeignKey, HasMany, HasOne, Is, IsUUID, Model, Scopes,
- Table, UpdatedAt
+ 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 { 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,
+ 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, CONFIG, CONSTRAINTS_FIELDS } from '../../initializers'
+import { ACTIVITY_PUB, ACTIVITY_PUB_ACTOR_TYPES, CONSTRAINTS_FIELDS, SERVER_ACTOR_NAME, WEBSERVER } from '../../initializers/constants'
+import {
+ MActor,
+ MActorAccountChannelId,
+ MActorAP,
+ MActorFormattable,
+ MActorFull,
+ MActorHost,
+ MActorServer,
+ MActorSummaryFormattable,
+ MActorUrl,
+ MActorWithInboxes
+} from '../../types/models'
import { AccountModel } from '../account/account'
-import { AvatarModel } from '../avatar/avatar'
+import { ActorImageModel } from '../account/actor-image'
import { ServerModel } from '../server/server'
-import { throwIfNotValid } from '../utils'
+import { isOutdated, throwIfNotValid } from '../utils'
+import { VideoModel } from '../video/video'
import { VideoChannelModel } from '../video/video-channel'
import { ActorFollowModel } from './actor-follow'
FULL = 'FULL'
}
-@DefaultScope({
+export const unusedActorAttributesForAPI = [
+ 'publicKey',
+ 'privateKey',
+ 'inboxUrl',
+ 'outboxUrl',
+ 'sharedInboxUrl',
+ 'followersUrl',
+ 'followingUrl',
+ 'createdAt',
+ 'updatedAt'
+]
+
+@DefaultScope(() => ({
include: [
{
- model: () => ServerModel,
+ model: ServerModel,
required: false
},
{
- model: () => AvatarModel,
+ model: ActorImageModel,
+ as: 'Avatar',
required: false
}
]
-})
-@Scopes({
+}))
+@Scopes(() => ({
[ScopeNames.FULL]: {
include: [
{
- model: () => AccountModel.unscoped(),
+ model: AccountModel.unscoped(),
required: false
},
{
- model: () => VideoChannelModel.unscoped(),
- required: false
+ model: VideoChannelModel.unscoped(),
+ required: false,
+ include: [
+ {
+ model: AccountModel,
+ required: true
+ }
+ ]
},
{
- model: () => ServerModel,
+ model: ServerModel,
required: false
},
{
- model: () => AvatarModel,
+ model: ActorImageModel,
+ as: 'Avatar',
required: false
}
]
}
-})
+}))
@Table({
tableName: 'actor',
indexes: [
{
- fields: [ 'url' ]
+ fields: [ 'url' ],
+ unique: true
},
{
fields: [ 'preferredUsername', 'serverId' ],
- unique: true
+ 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<ActorModel> {
+export class ActorModel extends Model {
@AllowNull(false)
- @Column(DataType.ENUM(values(ACTIVITY_PUB_ACTOR_TYPES)))
+ @Column(DataType.ENUM(...values(ACTIVITY_PUB_ACTOR_TYPES)))
type: ActivityPubActorType
- @AllowNull(false)
- @Default(DataType.UUIDV4)
- @IsUUID(4)
- @Column(DataType.UUID)
- uuid: string
-
@AllowNull(false)
@Is('ActorPreferredUsername', value => throwIfNotValid(value, isActorPreferredUsernameValid, 'actor preferred username'))
@Column
url: string
@AllowNull(true)
- @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPublicKeyValid, 'public key'))
+ @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'))
+ @Is('ActorPublicKey', value => throwIfNotValid(value, isActorPrivateKeyValid, 'private key', true))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.PRIVATE_KEY.max))
privateKey: string
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
inboxUrl: string
- @AllowNull(false)
- @Is('ActorOutboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'outbox url'))
+ @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'))
+ @AllowNull(true)
+ @Is('ActorSharedInboxUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'shared inbox url', true))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
sharedInboxUrl: string
- @AllowNull(false)
- @Is('ActorFollowersUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'followers url'))
+ @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'))
+ @AllowNull(true)
+ @Is('ActorFollowingUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'following url', true))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.ACTORS.URL.max))
followingUrl: string
@UpdatedAt
updatedAt: Date
- @ForeignKey(() => AvatarModel)
+ @ForeignKey(() => ActorImageModel)
@Column
avatarId: number
- @BelongsTo(() => AvatarModel, {
+ @ForeignKey(() => ActorImageModel)
+ @Column
+ bannerId: number
+
+ @BelongsTo(() => ActorImageModel, {
foreignKey: {
+ name: 'avatarId',
allowNull: true
},
- onDelete: 'set null'
+ as: 'Avatar',
+ onDelete: 'set null',
+ hooks: true
})
- Avatar: AvatarModel
+ 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'
})
- AccountFollowing: ActorFollowModel[]
+ ActorFollowing: ActorFollowModel[]
@HasMany(() => ActorFollowModel, {
foreignKey: {
name: 'targetActorId',
allowNull: false
},
- as: 'followers',
+ as: 'ActorFollowers',
onDelete: 'cascade'
})
- AccountFollowers: ActorFollowModel[]
+ ActorFollowers: ActorFollowModel[]
@ForeignKey(() => ServerModel)
@Column
foreignKey: {
allowNull: true
},
- onDelete: 'cascade'
+ onDelete: 'cascade',
+ hooks: true
})
Account: AccountModel
foreignKey: {
allowNull: true
},
- onDelete: 'cascade'
+ onDelete: 'cascade',
+ hooks: true
})
VideoChannel: VideoChannelModel
- static load (id: number) {
- return ActorModel.unscoped().findById(id)
+ 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 listByFollowersUrls (followersUrls: string[], transaction?: Sequelize.Transaction) {
+ 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: {
- [ Sequelize.Op.in ]: followersUrls
+ [Op.in]: followersUrls
}
},
transaction
return ActorModel.scope(ScopeNames.FULL).findAll(query)
}
- static loadLocalByName (preferredUsername: string) {
- const query = {
- where: {
- preferredUsername,
- serverId: null
+ 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 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 loadByNameAndHost (preferredUsername: string, host: string) {
+ 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
return ActorModel.scope(ScopeNames.FULL).findOne(query)
}
- static loadByUrl (url: string, transaction?: Sequelize.Transaction) {
+ 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
return ActorModel.scope(ScopeNames.FULL).findOne(query)
}
- toFormattedJSON () {
- let avatar: Avatar = null
+ 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 {
- id: this.id,
url: this.url,
- uuid: this.uuid,
name: this.preferredUsername,
host: this.getHost(),
+ avatar
+ }
+ }
+
+ toFormattedJSON (this: MActorFormattable) {
+ const base = this.toFormattedSummaryJSON()
+
+ return Object.assign(base, {
+ id: this.id,
+ hostRedundancyAllowed: this.getRedundancyAllowed(),
followingCount: this.followingCount,
followersCount: this.followersCount,
- avatar,
createdAt: this.createdAt,
updatedAt: this.updatedAt
- }
+ })
}
- toActivityPubObject (name: string, type: 'Account' | 'Application' | 'VideoChannel') {
- let activityPubType
- if (type === 'Account') {
- activityPubType = 'Person' as 'Person'
- } else if (type === 'Application') {
- activityPubType = 'Application' as 'Application'
- } else { // VideoChannel
- activityPubType = 'Group' as 'Group'
- }
+ toActivityPubObject (this: MActorAP, name: string) {
+ let icon: ActivityIconObject
- let icon = undefined
if (this.avatarId) {
const extension = extname(this.Avatar.filename)
+
icon = {
type: 'Image',
mediaType: extension === '.png' ? 'image/png' : 'image/jpeg',
}
const json = {
- type: activityPubType,
+ type: this.type,
id: this.url,
following: this.getFollowingUrl(),
followers: this.getFollowersUrl(),
+ playlists: this.getPlaylistsUrl(),
inbox: this.inboxUrl,
outbox: this.outboxUrl,
preferredUsername: this.preferredUsername,
endpoints: {
sharedInbox: this.sharedInboxUrl
},
- uuid: this.uuid,
publicKey: {
id: this.getPublicKeyUrl(),
owner: this.url,
return activityPubContextify(json)
}
- getFollowerSharedInboxUrls (t: Sequelize.Transaction) {
+ getFollowerSharedInboxUrls (t: Transaction) {
const query = {
attributes: [ 'sharedInboxUrl' ],
include: [
{
- model: ActorFollowModel,
+ attribute: [],
+ model: ActorFollowModel.unscoped(),
required: true,
- as: 'followers',
+ as: 'ActorFollowing',
where: {
+ state: 'accepted',
targetActorId: this.id
}
}
return this.url + '/followers'
}
+ getPlaylistsUrl () {
+ return this.url + '/playlists'
+ }
+
getPublicKeyUrl () {
return this.url + '#main-key'
}
return this.serverId === null
}
- getWebfingerUrl () {
+ getWebfingerUrl (this: MActorServer) {
return 'acct:' + this.preferredUsername + '@' + this.getHost()
}
- getHost () {
- return this.Server ? this.Server.host : CONFIG.WEBSERVER.HOST
+ 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 CONFIG.WEBSERVER.URL + this.Avatar.getWebserverPath()
+ return WEBSERVER.URL + this.Avatar.getStaticPath()
}
isOutdated () {
if (this.isOwned()) return false
- const now = Date.now()
- const createdAtTime = this.createdAt.getTime()
- const updatedAtTime = this.updatedAt.getTime()
-
- return (now - createdAtTime) > ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL &&
- (now - updatedAtTime) > ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL
+ return isOutdated(this, ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL)
}
}
projects / github / Chocobozzz / PeerTube.git / blobdiff