1 import { difference } from 'lodash'
2 import { Attributes, FindOptions, Includeable, IncludeOptions, Op, QueryTypes, Transaction, WhereAttributeHash } from 'sequelize'
20 } from 'sequelize-typescript'
21 import { isActivityPubUrlValid } from '@server/helpers/custom-validators/activitypub/misc'
22 import { afterCommitIfTransaction } from '@server/helpers/database-utils'
23 import { getServerActor } from '@server/models/application/application'
27 MActorFollowActorsDefault,
28 MActorFollowActorsDefaultSubscription,
29 MActorFollowFollowingHost,
30 MActorFollowFormattable,
31 MActorFollowSubscriptions
32 } from '@server/types/models'
33 import { AttributesOnly } from '@shared/typescript-utils'
34 import { FollowState } from '../../../shared/models/actors'
35 import { ActorFollow } from '../../../shared/models/actors/follow.model'
36 import { logger } from '../../helpers/logger'
37 import { ACTOR_FOLLOW_SCORE, CONSTRAINTS_FIELDS, FOLLOW_STATES, SERVER_ACTOR_NAME, SORTABLE_COLUMNS } from '../../initializers/constants'
38 import { AccountModel } from '../account/account'
39 import { ServerModel } from '../server/server'
40 import { doesExist } from '../shared/query'
41 import { buildSQLAttributes, createSafeIn, getSort, searchAttribute, throwIfNotValid } from '../shared'
42 import { VideoChannelModel } from '../video/video-channel'
43 import { ActorModel, unusedActorAttributesForAPI } from './actor'
44 import { InstanceListFollowersQueryBuilder, ListFollowersOptions } from './sql/instance-list-followers-query-builder'
45 import { InstanceListFollowingQueryBuilder, ListFollowingOptions } from './sql/instance-list-following-query-builder'
48 tableName: 'actorFollow',
54 fields: [ 'targetActorId' ]
57 fields: [ 'actorId', 'targetActorId' ],
69 export class ActorFollowModel extends Model<Partial<AttributesOnly<ActorFollowModel>>> {
72 @Column(DataType.ENUM(...Object.values(FOLLOW_STATES)))
76 @Default(ACTOR_FOLLOW_SCORE.BASE)
78 @Max(ACTOR_FOLLOW_SCORE.MAX)
82 // Allow null because we added this column in PeerTube v3, and don't want to generate fake URLs of remote follows
84 @Is('ActorFollowUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
85 @Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
94 @ForeignKey(() => ActorModel)
98 @BelongsTo(() => ActorModel, {
106 ActorFollower: ActorModel
108 @ForeignKey(() => ActorModel)
110 targetActorId: number
112 @BelongsTo(() => ActorModel, {
114 name: 'targetActorId',
117 as: 'ActorFollowing',
120 ActorFollowing: ActorModel
124 static incrementFollowerAndFollowingCount (instance: ActorFollowModel, options: any) {
125 return afterCommitIfTransaction(options.transaction, () => {
127 ActorModel.rebuildFollowsCount(instance.actorId, 'following'),
128 ActorModel.rebuildFollowsCount(instance.targetActorId, 'followers')
134 static decrementFollowerAndFollowingCount (instance: ActorFollowModel, options: any) {
135 return afterCommitIfTransaction(options.transaction, () => {
137 ActorModel.rebuildFollowsCount(instance.actorId, 'following'),
138 ActorModel.rebuildFollowsCount(instance.targetActorId, 'followers')
143 // ---------------------------------------------------------------------------
145 static getSQLAttributes (tableName: string, aliasPrefix = '') {
146 return buildSQLAttributes({
153 // ---------------------------------------------------------------------------
156 * @deprecated Use `findOrCreateCustom` instead
158 static findOrCreate (): any {
159 throw new Error('Must not be called')
162 // findOrCreate has issues with actor follow hooks
163 static async findOrCreateCustom (options: {
168 transaction: Transaction
169 }): Promise<[ MActorFollowActors, boolean ]> {
170 const { byActor, targetActor, activityId, state, transaction } = options
173 let actorFollow: MActorFollowActors = await ActorFollowModel.loadByActorAndTarget(byActor.id, targetActor.id, transaction)
178 actorFollow = await ActorFollowModel.create({
180 targetActorId: targetActor.id,
186 actorFollow.ActorFollowing = targetActor
187 actorFollow.ActorFollower = byActor
190 return [ actorFollow, created ]
193 static removeFollowsOf (actorId: number, t?: Transaction) {
201 targetActorId: actorId
208 return ActorFollowModel.destroy(query)
211 // Remove actor follows with a score of 0 (too many requests where they were unreachable)
212 static async removeBadActorFollows () {
213 const actorFollows = await ActorFollowModel.listBadActorFollows()
215 const actorFollowsRemovePromises = actorFollows.map(actorFollow => actorFollow.destroy())
216 await Promise.all(actorFollowsRemovePromises)
218 const numberOfActorFollowsRemoved = actorFollows.length
220 if (numberOfActorFollowsRemoved) logger.info('Removed bad %d actor follows.', numberOfActorFollowsRemoved)
223 static isFollowedBy (actorId: number, followerActorId: number) {
224 const query = `SELECT 1 FROM "actorFollow" ` +
225 `WHERE "actorId" = $followerActorId AND "targetActorId" = $actorId AND "state" = 'accepted' ` +
228 return doesExist(this.sequelize, query, { actorId, followerActorId })
231 static loadByActorAndTarget (actorId: number, targetActorId: number, t?: Transaction): Promise<MActorFollowActorsDefault> {
252 return ActorFollowModel.findOne(query)
255 static loadByActorAndTargetNameAndHostForAPI (options: {
260 transaction?: Transaction
261 }): Promise<MActorFollowActorsDefaultSubscription> {
262 const { actorId, targetHost, targetName, state, transaction } = options
264 const actorFollowingPartInclude: IncludeOptions = {
267 as: 'ActorFollowing',
269 preferredUsername: targetName
273 model: VideoChannelModel.unscoped(),
279 if (targetHost === null) {
280 actorFollowingPartInclude.where['serverId'] = null
282 actorFollowingPartInclude.include.push({
291 const where: WhereAttributeHash<Attributes<ActorFollowModel>> = { actorId }
292 if (state) where.state = state
294 const query: FindOptions<Attributes<ActorFollowModel>> = {
297 actorFollowingPartInclude,
307 return ActorFollowModel.findOne(query)
310 static listSubscriptionsOf (actorId: number, targets: { name: string, host?: string }[]): Promise<MActorFollowFollowingHost[]> {
311 const whereTab = targets
317 $preferredUsername$: t.name
329 $preferredUsername$: t.name
339 attributes: [ 'id' ],
353 attributes: [ 'preferredUsername' ],
354 model: ActorModel.unscoped(),
356 as: 'ActorFollowing',
359 attributes: [ 'host' ],
360 model: ServerModel.unscoped(),
368 return ActorFollowModel.findAll(query)
371 static listInstanceFollowingForApi (options: ListFollowingOptions) {
373 new InstanceListFollowingQueryBuilder(this.sequelize, options).countFollowing(),
374 new InstanceListFollowingQueryBuilder(this.sequelize, options).listFollowing()
375 ]).then(([ total, data ]) => ({ total, data }))
378 static listFollowersForApi (options: ListFollowersOptions) {
380 new InstanceListFollowersQueryBuilder(this.sequelize, options).countFollowers(),
381 new InstanceListFollowersQueryBuilder(this.sequelize, options).listFollowers()
382 ]).then(([ total, data ]) => ({ total, data }))
385 static listSubscriptionsForApi (options: {
392 const { actorId, start, count, sort } = options
398 if (options.search) {
399 Object.assign(where, {
401 searchAttribute(options.search, '$ActorFollowing.preferredUsername$'),
402 searchAttribute(options.search, '$ActorFollowing.VideoChannel.name$')
407 const getQuery = (forCount: boolean) => {
408 let channelInclude: Includeable[] = []
410 if (forCount !== true) {
414 exclude: unusedActorAttributesForAPI
420 model: AccountModel.unscoped(),
425 exclude: unusedActorAttributesForAPI
436 attributes: forCount === true
438 : SORTABLE_COLUMNS.USER_SUBSCRIPTIONS,
442 order: getSort(sort),
446 attributes: [ 'id' ],
447 model: ActorModel.unscoped(),
448 as: 'ActorFollowing',
452 model: VideoChannelModel.unscoped(),
454 include: channelInclude
463 ActorFollowModel.count(getQuery(true)),
464 ActorFollowModel.findAll<MActorFollowSubscriptions>(getQuery(false))
465 ]).then(([ total, rows ]) => ({
467 data: rows.map(r => r.ActorFollowing.VideoChannel)
471 static async keepUnfollowedInstance (hosts: string[]) {
472 const followerId = (await getServerActor()).id
475 attributes: [ 'id' ],
481 attributes: [ 'id' ],
482 model: ActorModel.unscoped(),
484 as: 'ActorFollowing',
486 preferredUsername: SERVER_ACTOR_NAME
490 attributes: [ 'host' ],
491 model: ServerModel.unscoped(),
504 const res = await ActorFollowModel.findAll(query)
505 const followedHosts = res.map(row => row.ActorFollowing.Server.host)
507 return difference(hosts, followedHosts)
510 static listAcceptedFollowerUrlsForAP (actorIds: number[], t: Transaction, start?: number, count?: number) {
511 return ActorFollowModel.createListAcceptedFollowForApiQuery('followers', actorIds, t, start, count)
514 static listAcceptedFollowerSharedInboxUrls (actorIds: number[], t: Transaction) {
515 return ActorFollowModel.createListAcceptedFollowForApiQuery(
526 static listAcceptedFollowingUrlsForApi (actorIds: number[], t: Transaction, start?: number, count?: number) {
527 return ActorFollowModel.createListAcceptedFollowForApiQuery('following', actorIds, t, start, count)
530 static async getStats () {
531 const serverActor = await getServerActor()
533 const totalInstanceFollowing = await ActorFollowModel.count({
535 actorId: serverActor.id,
540 const totalInstanceFollowers = await ActorFollowModel.count({
542 targetActorId: serverActor.id,
548 totalInstanceFollowing,
549 totalInstanceFollowers
553 static updateScore (inboxUrl: string, value: number, t?: Transaction) {
554 const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
556 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
557 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."actorId" ' +
558 `WHERE "actor"."inboxUrl" = '${inboxUrl}' OR "actor"."sharedInboxUrl" = '${inboxUrl}'` +
562 type: QueryTypes.BULKUPDATE,
566 return ActorFollowModel.sequelize.query(query, options)
569 static async updateScoreByFollowingServers (serverIds: number[], value: number, t?: Transaction) {
570 if (serverIds.length === 0) return
572 const me = await getServerActor()
573 const serverIdsString = createSafeIn(ActorFollowModel.sequelize, serverIds)
575 const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
577 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
578 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."targetActorId" ' +
579 `WHERE "actorFollow"."actorId" = ${me.Account.actorId} ` + // I'm the follower
580 `AND "actor"."serverId" IN (${serverIdsString})` + // Criteria on followings
584 type: QueryTypes.BULKUPDATE,
588 return ActorFollowModel.sequelize.query(query, options)
591 private static async createListAcceptedFollowForApiQuery (
592 type: 'followers' | 'following',
600 let firstJoin: string
601 let secondJoin: string
603 if (type === 'followers') {
604 firstJoin = 'targetActorId'
605 secondJoin = 'actorId'
607 firstJoin = 'actorId'
608 secondJoin = 'targetActorId'
611 const selections: string[] = []
612 if (distinct === true) selections.push(`DISTINCT("Follows"."${columnUrl}") AS "selectionUrl"`)
613 else selections.push(`"Follows"."${columnUrl}" AS "selectionUrl"`)
615 selections.push('COUNT(*) AS "total"')
617 const tasks: Promise<any>[] = []
619 for (const selection of selections) {
620 let query = 'SELECT ' + selection + ' FROM "actor" ' +
621 'INNER JOIN "actorFollow" ON "actorFollow"."' + firstJoin + '" = "actor"."id" ' +
622 'INNER JOIN "actor" AS "Follows" ON "actorFollow"."' + secondJoin + '" = "Follows"."id" ' +
623 `WHERE "actor"."id" = ANY ($actorIds) AND "actorFollow"."state" = 'accepted' AND "Follows"."${columnUrl}" IS NOT NULL `
625 if (count !== undefined) query += 'LIMIT ' + count
626 if (start !== undefined) query += ' OFFSET ' + start
630 type: QueryTypes.SELECT,
633 tasks.push(ActorFollowModel.sequelize.query(query, options))
636 const [ followers, [ dataTotal ] ] = await Promise.all(tasks)
637 const urls: string[] = followers.map(f => f.selectionUrl)
641 total: dataTotal ? parseInt(dataTotal.total, 10) : 0
645 private static listBadActorFollows () {
655 return ActorFollowModel.findAll(query)
658 toFormattedJSON (this: MActorFollowFormattable): ActorFollow {
659 const follower = this.ActorFollower.toFormattedJSON()
660 const following = this.ActorFollowing.toFormattedJSON()
668 createdAt: this.createdAt,
669 updatedAt: this.updatedAt