1 import { difference, values } from 'lodash'
2 import { IncludeOptions, Op, QueryTypes, Transaction, WhereOptions } 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 { CONFIG } from '@server/initializers/config'
24 import { getServerActor } from '@server/models/application/application'
28 MActorFollowActorsDefault,
29 MActorFollowActorsDefaultSubscription,
30 MActorFollowFollowingHost,
31 MActorFollowFormattable,
32 MActorFollowSubscriptions
33 } from '@server/types/models'
34 import { AttributesOnly } from '@shared/core-utils'
35 import { ActivityPubActorType } from '@shared/models'
36 import { FollowState } from '../../../shared/models/actors'
37 import { ActorFollow } from '../../../shared/models/actors/follow.model'
38 import { logger } from '../../helpers/logger'
39 import { ACTOR_FOLLOW_SCORE, CONSTRAINTS_FIELDS, FOLLOW_STATES, SERVER_ACTOR_NAME } from '../../initializers/constants'
40 import { AccountModel } from '../account/account'
41 import { ServerModel } from '../server/server'
42 import { doesExist } from '../shared/query'
43 import { createSafeIn, getFollowsSort, getSort, searchAttribute, throwIfNotValid } from '../utils'
44 import { VideoChannelModel } from '../video/video-channel'
45 import { ActorModel, unusedActorAttributesForAPI } from './actor'
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('Should 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 listSubscribedIn (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 listFollowingForApi (options: {
358 actorType?: ActivityPubActorType
361 const { id, start, count, sort, search, state, actorType } = options
363 const followWhere = state ? { state } : {}
364 const followingWhere: WhereOptions = {}
367 Object.assign(followWhere, {
369 searchAttribute(options.search, '$ActorFollowing.preferredUsername$'),
370 searchAttribute(options.search, '$ActorFollowing.Server.host$')
376 Object.assign(followingWhere, { type: actorType })
383 order: getFollowsSort(sort),
396 as: 'ActorFollowing',
398 where: followingWhere,
409 return ActorFollowModel.findAndCountAll<MActorFollowActorsDefault>(query)
410 .then(({ rows, count }) => {
418 static listFollowersForApi (options: {
424 actorType?: ActivityPubActorType
427 const { actorId, start, count, sort, search, state, actorType } = options
429 const followWhere = state ? { state } : {}
430 const followerWhere: WhereOptions = {}
433 Object.assign(followWhere, {
435 searchAttribute(search, '$ActorFollower.preferredUsername$'),
436 searchAttribute(search, '$ActorFollower.Server.host$')
442 Object.assign(followerWhere, { type: actorType })
449 order: getFollowsSort(sort),
456 where: followerWhere,
466 as: 'ActorFollowing',
475 return ActorFollowModel.findAndCountAll<MActorFollowActorsDefault>(query)
476 .then(({ rows, count }) => {
484 static listSubscriptionsForApi (options: {
491 const { actorId, start, count, sort } = options
496 if (options.search) {
497 Object.assign(where, {
499 searchAttribute(options.search, '$ActorFollowing.preferredUsername$'),
500 searchAttribute(options.search, '$ActorFollowing.VideoChannel.name$')
510 order: getSort(sort),
514 attributes: [ 'id' ],
515 model: ActorModel.unscoped(),
516 as: 'ActorFollowing',
520 model: VideoChannelModel.unscoped(),
525 exclude: unusedActorAttributesForAPI
531 model: AccountModel.unscoped(),
536 exclude: unusedActorAttributesForAPI
550 return ActorFollowModel.findAndCountAll<MActorFollowSubscriptions>(query)
551 .then(({ rows, count }) => {
553 data: rows.map(r => r.ActorFollowing.VideoChannel),
559 static async keepUnfollowedInstance (hosts: string[]) {
560 const followerId = (await getServerActor()).id
563 attributes: [ 'id' ],
569 attributes: [ 'id' ],
570 model: ActorModel.unscoped(),
572 as: 'ActorFollowing',
574 preferredUsername: SERVER_ACTOR_NAME
578 attributes: [ 'host' ],
579 model: ServerModel.unscoped(),
592 const res = await ActorFollowModel.findAll(query)
593 const followedHosts = res.map(row => row.ActorFollowing.Server.host)
595 return difference(hosts, followedHosts)
598 static listAcceptedFollowerUrlsForAP (actorIds: number[], t: Transaction, start?: number, count?: number) {
599 return ActorFollowModel.createListAcceptedFollowForApiQuery('followers', actorIds, t, start, count)
602 static listAcceptedFollowerSharedInboxUrls (actorIds: number[], t: Transaction) {
603 return ActorFollowModel.createListAcceptedFollowForApiQuery(
614 static listAcceptedFollowingUrlsForApi (actorIds: number[], t: Transaction, start?: number, count?: number) {
615 return ActorFollowModel.createListAcceptedFollowForApiQuery('following', actorIds, t, start, count)
618 static async getStats () {
619 const serverActor = await getServerActor()
621 const totalInstanceFollowing = await ActorFollowModel.count({
623 actorId: serverActor.id
627 const totalInstanceFollowers = await ActorFollowModel.count({
629 targetActorId: serverActor.id
634 totalInstanceFollowing,
635 totalInstanceFollowers
639 static updateScore (inboxUrl: string, value: number, t?: Transaction) {
640 const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
642 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
643 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."actorId" ' +
644 `WHERE "actor"."inboxUrl" = '${inboxUrl}' OR "actor"."sharedInboxUrl" = '${inboxUrl}'` +
648 type: QueryTypes.BULKUPDATE,
652 return ActorFollowModel.sequelize.query(query, options)
655 static async updateScoreByFollowingServers (serverIds: number[], value: number, t?: Transaction) {
656 if (serverIds.length === 0) return
658 const me = await getServerActor()
659 const serverIdsString = createSafeIn(ActorFollowModel.sequelize, serverIds)
661 const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
663 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
664 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."targetActorId" ' +
665 `WHERE "actorFollow"."actorId" = ${me.Account.actorId} ` + // I'm the follower
666 `AND "actor"."serverId" IN (${serverIdsString})` + // Criteria on followings
670 type: QueryTypes.BULKUPDATE,
674 return ActorFollowModel.sequelize.query(query, options)
677 private static async createListAcceptedFollowForApiQuery (
678 type: 'followers' | 'following',
686 let firstJoin: string
687 let secondJoin: string
689 if (type === 'followers') {
690 firstJoin = 'targetActorId'
691 secondJoin = 'actorId'
693 firstJoin = 'actorId'
694 secondJoin = 'targetActorId'
697 const selections: string[] = []
698 if (distinct === true) selections.push(`DISTINCT("Follows"."${columnUrl}") AS "selectionUrl"`)
699 else selections.push(`"Follows"."${columnUrl}" AS "selectionUrl"`)
701 selections.push('COUNT(*) AS "total"')
703 const tasks: Promise<any>[] = []
705 for (const selection of selections) {
706 let query = 'SELECT ' + selection + ' FROM "actor" ' +
707 'INNER JOIN "actorFollow" ON "actorFollow"."' + firstJoin + '" = "actor"."id" ' +
708 'INNER JOIN "actor" AS "Follows" ON "actorFollow"."' + secondJoin + '" = "Follows"."id" ' +
709 `WHERE "actor"."id" = ANY ($actorIds) AND "actorFollow"."state" = 'accepted' AND "Follows"."${columnUrl}" IS NOT NULL `
711 if (count !== undefined) query += 'LIMIT ' + count
712 if (start !== undefined) query += ' OFFSET ' + start
716 type: QueryTypes.SELECT,
719 tasks.push(ActorFollowModel.sequelize.query(query, options))
722 const [ followers, [ dataTotal ] ] = await Promise.all(tasks)
723 const urls: string[] = followers.map(f => f.selectionUrl)
727 total: dataTotal ? parseInt(dataTotal.total, 10) : 0
731 private static listBadActorFollows () {
741 return ActorFollowModel.findAll(query)
744 toFormattedJSON (this: MActorFollowFormattable): ActorFollow {
745 const follower = this.ActorFollower.toFormattedJSON()
746 const following = this.ActorFollowing.toFormattedJSON()
754 createdAt: this.createdAt,
755 updatedAt: this.updatedAt