1 import { difference, values } from 'lodash'
2 import { Includeable, IncludeOptions, Op, QueryTypes, Transaction } 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 { createSafeIn, getSort, searchAttribute, throwIfNotValid } from '../utils'
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(...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')
144 * @deprecated Use `findOrCreateCustom` instead
146 static findOrCreate (): any {
147 throw new Error('Must not be called')
150 // findOrCreate has issues with actor follow hooks
151 static async findOrCreateCustom (options: {
156 transaction: Transaction
157 }): Promise<[ MActorFollowActors, boolean ]> {
158 const { byActor, targetActor, activityId, state, transaction } = options
161 let actorFollow: MActorFollowActors = await ActorFollowModel.loadByActorAndTarget(byActor.id, targetActor.id, transaction)
166 actorFollow = await ActorFollowModel.create({
168 targetActorId: targetActor.id,
174 actorFollow.ActorFollowing = targetActor
175 actorFollow.ActorFollower = byActor
178 return [ actorFollow, created ]
181 static removeFollowsOf (actorId: number, t?: Transaction) {
189 targetActorId: actorId
196 return ActorFollowModel.destroy(query)
199 // Remove actor follows with a score of 0 (too many requests where they were unreachable)
200 static async removeBadActorFollows () {
201 const actorFollows = await ActorFollowModel.listBadActorFollows()
203 const actorFollowsRemovePromises = actorFollows.map(actorFollow => actorFollow.destroy())
204 await Promise.all(actorFollowsRemovePromises)
206 const numberOfActorFollowsRemoved = actorFollows.length
208 if (numberOfActorFollowsRemoved) logger.info('Removed bad %d actor follows.', numberOfActorFollowsRemoved)
211 static isFollowedBy (actorId: number, followerActorId: number) {
212 const query = 'SELECT 1 FROM "actorFollow" WHERE "actorId" = $followerActorId AND "targetActorId" = $actorId LIMIT 1'
214 return doesExist(query, { actorId, followerActorId })
217 static loadByActorAndTarget (actorId: number, targetActorId: number, t?: Transaction): Promise<MActorFollowActorsDefault> {
221 targetActorId: targetActorId
238 return ActorFollowModel.findOne(query)
241 static loadByActorAndTargetNameAndHostForAPI (
246 ): Promise<MActorFollowActorsDefaultSubscription> {
247 const actorFollowingPartInclude: IncludeOptions = {
250 as: 'ActorFollowing',
252 preferredUsername: targetName
256 model: VideoChannelModel.unscoped(),
262 if (targetHost === null) {
263 actorFollowingPartInclude.where['serverId'] = null
265 actorFollowingPartInclude.include.push({
279 actorFollowingPartInclude,
289 return ActorFollowModel.findOne(query)
292 static listSubscriptionsOf (actorId: number, targets: { name: string, host?: string }[]): Promise<MActorFollowFollowingHost[]> {
293 const whereTab = targets
299 $preferredUsername$: t.name
311 $preferredUsername$: t.name
321 attributes: [ 'id' ],
334 attributes: [ 'preferredUsername' ],
335 model: ActorModel.unscoped(),
337 as: 'ActorFollowing',
340 attributes: [ 'host' ],
341 model: ServerModel.unscoped(),
349 return ActorFollowModel.findAll(query)
352 static listInstanceFollowingForApi (options: ListFollowingOptions) {
354 new InstanceListFollowingQueryBuilder(this.sequelize, options).countFollowing(),
355 new InstanceListFollowingQueryBuilder(this.sequelize, options).listFollowing()
356 ]).then(([ total, data ]) => ({ total, data }))
359 static listFollowersForApi (options: ListFollowersOptions) {
361 new InstanceListFollowersQueryBuilder(this.sequelize, options).countFollowers(),
362 new InstanceListFollowersQueryBuilder(this.sequelize, options).listFollowers()
363 ]).then(([ total, data ]) => ({ total, data }))
366 static listSubscriptionsForApi (options: {
373 const { actorId, start, count, sort } = options
378 if (options.search) {
379 Object.assign(where, {
381 searchAttribute(options.search, '$ActorFollowing.preferredUsername$'),
382 searchAttribute(options.search, '$ActorFollowing.VideoChannel.name$')
387 const getQuery = (forCount: boolean) => {
388 let channelInclude: Includeable[] = []
390 if (forCount !== true) {
394 exclude: unusedActorAttributesForAPI
400 model: AccountModel.unscoped(),
405 exclude: unusedActorAttributesForAPI
416 attributes: forCount === true
418 : SORTABLE_COLUMNS.USER_SUBSCRIPTIONS,
422 order: getSort(sort),
426 attributes: [ 'id' ],
427 model: ActorModel.unscoped(),
428 as: 'ActorFollowing',
432 model: VideoChannelModel.unscoped(),
434 include: channelInclude
443 ActorFollowModel.count(getQuery(true)),
444 ActorFollowModel.findAll<MActorFollowSubscriptions>(getQuery(false))
445 ]).then(([ total, rows ]) => ({
447 data: rows.map(r => r.ActorFollowing.VideoChannel)
451 static async keepUnfollowedInstance (hosts: string[]) {
452 const followerId = (await getServerActor()).id
455 attributes: [ 'id' ],
461 attributes: [ 'id' ],
462 model: ActorModel.unscoped(),
464 as: 'ActorFollowing',
466 preferredUsername: SERVER_ACTOR_NAME
470 attributes: [ 'host' ],
471 model: ServerModel.unscoped(),
484 const res = await ActorFollowModel.findAll(query)
485 const followedHosts = res.map(row => row.ActorFollowing.Server.host)
487 return difference(hosts, followedHosts)
490 static listAcceptedFollowerUrlsForAP (actorIds: number[], t: Transaction, start?: number, count?: number) {
491 return ActorFollowModel.createListAcceptedFollowForApiQuery('followers', actorIds, t, start, count)
494 static listAcceptedFollowerSharedInboxUrls (actorIds: number[], t: Transaction) {
495 return ActorFollowModel.createListAcceptedFollowForApiQuery(
506 static listAcceptedFollowingUrlsForApi (actorIds: number[], t: Transaction, start?: number, count?: number) {
507 return ActorFollowModel.createListAcceptedFollowForApiQuery('following', actorIds, t, start, count)
510 static async getStats () {
511 const serverActor = await getServerActor()
513 const totalInstanceFollowing = await ActorFollowModel.count({
515 actorId: serverActor.id
519 const totalInstanceFollowers = await ActorFollowModel.count({
521 targetActorId: serverActor.id
526 totalInstanceFollowing,
527 totalInstanceFollowers
531 static updateScore (inboxUrl: string, value: number, t?: Transaction) {
532 const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
534 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
535 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."actorId" ' +
536 `WHERE "actor"."inboxUrl" = '${inboxUrl}' OR "actor"."sharedInboxUrl" = '${inboxUrl}'` +
540 type: QueryTypes.BULKUPDATE,
544 return ActorFollowModel.sequelize.query(query, options)
547 static async updateScoreByFollowingServers (serverIds: number[], value: number, t?: Transaction) {
548 if (serverIds.length === 0) return
550 const me = await getServerActor()
551 const serverIdsString = createSafeIn(ActorFollowModel.sequelize, serverIds)
553 const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
555 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
556 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."targetActorId" ' +
557 `WHERE "actorFollow"."actorId" = ${me.Account.actorId} ` + // I'm the follower
558 `AND "actor"."serverId" IN (${serverIdsString})` + // Criteria on followings
562 type: QueryTypes.BULKUPDATE,
566 return ActorFollowModel.sequelize.query(query, options)
569 private static async createListAcceptedFollowForApiQuery (
570 type: 'followers' | 'following',
578 let firstJoin: string
579 let secondJoin: string
581 if (type === 'followers') {
582 firstJoin = 'targetActorId'
583 secondJoin = 'actorId'
585 firstJoin = 'actorId'
586 secondJoin = 'targetActorId'
589 const selections: string[] = []
590 if (distinct === true) selections.push(`DISTINCT("Follows"."${columnUrl}") AS "selectionUrl"`)
591 else selections.push(`"Follows"."${columnUrl}" AS "selectionUrl"`)
593 selections.push('COUNT(*) AS "total"')
595 const tasks: Promise<any>[] = []
597 for (const selection of selections) {
598 let query = 'SELECT ' + selection + ' FROM "actor" ' +
599 'INNER JOIN "actorFollow" ON "actorFollow"."' + firstJoin + '" = "actor"."id" ' +
600 'INNER JOIN "actor" AS "Follows" ON "actorFollow"."' + secondJoin + '" = "Follows"."id" ' +
601 `WHERE "actor"."id" = ANY ($actorIds) AND "actorFollow"."state" = 'accepted' AND "Follows"."${columnUrl}" IS NOT NULL `
603 if (count !== undefined) query += 'LIMIT ' + count
604 if (start !== undefined) query += ' OFFSET ' + start
608 type: QueryTypes.SELECT,
611 tasks.push(ActorFollowModel.sequelize.query(query, options))
614 const [ followers, [ dataTotal ] ] = await Promise.all(tasks)
615 const urls: string[] = followers.map(f => f.selectionUrl)
619 total: dataTotal ? parseInt(dataTotal.total, 10) : 0
623 private static listBadActorFollows () {
633 return ActorFollowModel.findAll(query)
636 toFormattedJSON (this: MActorFollowFormattable): ActorFollow {
637 const follower = this.ActorFollower.toFormattedJSON()
638 const following = this.ActorFollowing.toFormattedJSON()
646 createdAt: this.createdAt,
647 updatedAt: this.updatedAt