server/models/actor/actor-follow.ts

   1 import { difference, values } from 'lodash'
   2 import { Includeable, IncludeOptions, Op, QueryTypes, Transaction } from 'sequelize'
   3 import {
   4   AfterCreate,
   5   AfterDestroy,
   6   AfterUpdate,
   7   AllowNull,
   8   BelongsTo,
   9   Column,
  10   CreatedAt,
  11   DataType,
  12   Default,
  13   ForeignKey,
  14   Is,
  15   IsInt,
  16   Max,
  17   Model,
  18   Table,
  19   UpdatedAt
  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'
  24 import {
  25   MActor,
  26   MActorFollowActors,
  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'
  46
  47 @Table({
  48   tableName: 'actorFollow',
  49   indexes: [
  50     {
  51       fields: [ 'actorId' ]
  52     },
  53     {
  54       fields: [ 'targetActorId' ]
  55     },
  56     {
  57       fields: [ 'actorId', 'targetActorId' ],
  58       unique: true
  59     },
  60     {
  61       fields: [ 'score' ]
  62     },
  63     {
  64       fields: [ 'url' ],
  65       unique: true
  66     }
  67   ]
  68 })
  69 export class ActorFollowModel extends Model<Partial<AttributesOnly<ActorFollowModel>>> {
  70
  71   @AllowNull(false)
  72   @Column(DataType.ENUM(...values(FOLLOW_STATES)))
  73   state: FollowState
  74
  75   @AllowNull(false)
  76   @Default(ACTOR_FOLLOW_SCORE.BASE)
  77   @IsInt
  78   @Max(ACTOR_FOLLOW_SCORE.MAX)
  79   @Column
  80   score: number
  81
  82   // Allow null because we added this column in PeerTube v3, and don't want to generate fake URLs of remote follows
  83   @AllowNull(true)
  84   @Is('ActorFollowUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
  85   @Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
  86   url: string
  87
  88   @CreatedAt
  89   createdAt: Date
  90
  91   @UpdatedAt
  92   updatedAt: Date
  93
  94   @ForeignKey(() => ActorModel)
  95   @Column
  96   actorId: number
  97
  98   @BelongsTo(() => ActorModel, {
  99     foreignKey: {
 100       name: 'actorId',
 101       allowNull: false
 102     },
 103     as: 'ActorFollower',
 104     onDelete: 'CASCADE'
 105   })
 106   ActorFollower: ActorModel
 107
 108   @ForeignKey(() => ActorModel)
 109   @Column
 110   targetActorId: number
 111
 112   @BelongsTo(() => ActorModel, {
 113     foreignKey: {
 114       name: 'targetActorId',
 115       allowNull: false
 116     },
 117     as: 'ActorFollowing',
 118     onDelete: 'CASCADE'
 119   })
 120   ActorFollowing: ActorModel
 121
 122   @AfterCreate
 123   @AfterUpdate
 124   static incrementFollowerAndFollowingCount (instance: ActorFollowModel, options: any) {
 125     return afterCommitIfTransaction(options.transaction, () => {
 126       return Promise.all([
 127         ActorModel.rebuildFollowsCount(instance.actorId, 'following'),
 128         ActorModel.rebuildFollowsCount(instance.targetActorId, 'followers')
 129       ])
 130     })
 131   }
 132
 133   @AfterDestroy
 134   static decrementFollowerAndFollowingCount (instance: ActorFollowModel, options: any) {
 135     return afterCommitIfTransaction(options.transaction, () => {
 136       return Promise.all([
 137         ActorModel.rebuildFollowsCount(instance.actorId, 'following'),
 138         ActorModel.rebuildFollowsCount(instance.targetActorId, 'followers')
 139       ])
 140     })
 141   }
 142
 143   /*
 144    * @deprecated Use `findOrCreateCustom` instead
 145   */
 146   static findOrCreate (): any {
 147     throw new Error('Must not be called')
 148   }
 149
 150   // findOrCreate has issues with actor follow hooks
 151   static async findOrCreateCustom (options: {
 152     byActor: MActor
 153     targetActor: MActor
 154     activityId: string
 155     state: FollowState
 156     transaction: Transaction
 157   }): Promise<[ MActorFollowActors, boolean ]> {
 158     const { byActor, targetActor, activityId, state, transaction } = options
 159
 160     let created = false
 161     let actorFollow: MActorFollowActors = await ActorFollowModel.loadByActorAndTarget(byActor.id, targetActor.id, transaction)
 162
 163     if (!actorFollow) {
 164       created = true
 165
 166       actorFollow = await ActorFollowModel.create({
 167         actorId: byActor.id,
 168         targetActorId: targetActor.id,
 169         url: activityId,
 170
 171         state
 172       }, { transaction })
 173
 174       actorFollow.ActorFollowing = targetActor
 175       actorFollow.ActorFollower = byActor
 176     }
 177
 178     return [ actorFollow, created ]
 179   }
 180
 181   static removeFollowsOf (actorId: number, t?: Transaction) {
 182     const query = {
 183       where: {
 184         [Op.or]: [
 185           {
 186             actorId
 187           },
 188           {
 189             targetActorId: actorId
 190           }
 191         ]
 192       },
 193       transaction: t
 194     }
 195
 196     return ActorFollowModel.destroy(query)
 197   }
 198
 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()
 202
 203     const actorFollowsRemovePromises = actorFollows.map(actorFollow => actorFollow.destroy())
 204     await Promise.all(actorFollowsRemovePromises)
 205
 206     const numberOfActorFollowsRemoved = actorFollows.length
 207
 208     if (numberOfActorFollowsRemoved) logger.info('Removed bad %d actor follows.', numberOfActorFollowsRemoved)
 209   }
 210
 211   static isFollowedBy (actorId: number, followerActorId: number) {
 212     const query = 'SELECT 1 FROM "actorFollow" WHERE "actorId" = $followerActorId AND "targetActorId" = $actorId LIMIT 1'
 213
 214     return doesExist(query, { actorId, followerActorId })
 215   }
 216
 217   static loadByActorAndTarget (actorId: number, targetActorId: number, t?: Transaction): Promise<MActorFollowActorsDefault> {
 218     const query = {
 219       where: {
 220         actorId,
 221         targetActorId
 222       },
 223       include: [
 224         {
 225           model: ActorModel,
 226           required: true,
 227           as: 'ActorFollower'
 228         },
 229         {
 230           model: ActorModel,
 231           required: true,
 232           as: 'ActorFollowing'
 233         }
 234       ],
 235       transaction: t
 236     }
 237
 238     return ActorFollowModel.findOne(query)
 239   }
 240
 241   static loadByActorAndTargetNameAndHostForAPI (
 242     actorId: number,
 243     targetName: string,
 244     targetHost: string,
 245     t?: Transaction
 246   ): Promise<MActorFollowActorsDefaultSubscription> {
 247     const actorFollowingPartInclude: IncludeOptions = {
 248       model: ActorModel,
 249       required: true,
 250       as: 'ActorFollowing',
 251       where: {
 252         preferredUsername: targetName
 253       },
 254       include: [
 255         {
 256           model: VideoChannelModel.unscoped(),
 257           required: false
 258         }
 259       ]
 260     }
 261
 262     if (targetHost === null) {
 263       actorFollowingPartInclude.where['serverId'] = null
 264     } else {
 265       actorFollowingPartInclude.include.push({
 266         model: ServerModel,
 267         required: true,
 268         where: {
 269           host: targetHost
 270         }
 271       })
 272     }
 273
 274     const query = {
 275       where: {
 276         actorId
 277       },
 278       include: [
 279         actorFollowingPartInclude,
 280         {
 281           model: ActorModel,
 282           required: true,
 283           as: 'ActorFollower'
 284         }
 285       ],
 286       transaction: t
 287     }
 288
 289     return ActorFollowModel.findOne(query)
 290   }
 291
 292   static listSubscriptionsOf (actorId: number, targets: { name: string, host?: string }[]): Promise<MActorFollowFollowingHost[]> {
 293     const whereTab = targets
 294       .map(t => {
 295         if (t.host) {
 296           return {
 297             [Op.and]: [
 298               {
 299                 $preferredUsername$: t.name
 300               },
 301               {
 302                 $host$: t.host
 303               }
 304             ]
 305           }
 306         }
 307
 308         return {
 309           [Op.and]: [
 310             {
 311               $preferredUsername$: t.name
 312             },
 313             {
 314               $serverId$: null
 315             }
 316           ]
 317         }
 318       })
 319
 320     const query = {
 321       attributes: [ 'id' ],
 322       where: {
 323         [Op.and]: [
 324           {
 325             [Op.or]: whereTab
 326           },
 327           {
 328             actorId
 329           }
 330         ]
 331       },
 332       include: [
 333         {
 334           attributes: [ 'preferredUsername' ],
 335           model: ActorModel.unscoped(),
 336           required: true,
 337           as: 'ActorFollowing',
 338           include: [
 339             {
 340               attributes: [ 'host' ],
 341               model: ServerModel.unscoped(),
 342               required: false
 343             }
 344           ]
 345         }
 346       ]
 347     }
 348
 349     return ActorFollowModel.findAll(query)
 350   }
 351
 352   static listInstanceFollowingForApi (options: ListFollowingOptions) {
 353     return Promise.all([
 354       new InstanceListFollowingQueryBuilder(this.sequelize, options).countFollowing(),
 355       new InstanceListFollowingQueryBuilder(this.sequelize, options).listFollowing()
 356     ]).then(([ total, data ]) => ({ total, data }))
 357   }
 358
 359   static listFollowersForApi (options: ListFollowersOptions) {
 360     return Promise.all([
 361       new InstanceListFollowersQueryBuilder(this.sequelize, options).countFollowers(),
 362       new InstanceListFollowersQueryBuilder(this.sequelize, options).listFollowers()
 363     ]).then(([ total, data ]) => ({ total, data }))
 364   }
 365
 366   static listSubscriptionsForApi (options: {
 367     actorId: number
 368     start: number
 369     count: number
 370     sort: string
 371     search?: string
 372   }) {
 373     const { actorId, start, count, sort } = options
 374     const where = {
 375       actorId
 376     }
 377
 378     if (options.search) {
 379       Object.assign(where, {
 380         [Op.or]: [
 381           searchAttribute(options.search, '$ActorFollowing.preferredUsername$'),
 382           searchAttribute(options.search, '$ActorFollowing.VideoChannel.name$')
 383         ]
 384       })
 385     }
 386
 387     const getQuery = (forCount: boolean) => {
 388       let channelInclude: Includeable[] = []
 389
 390       if (forCount !== true) {
 391         channelInclude = [
 392           {
 393             attributes: {
 394               exclude: unusedActorAttributesForAPI
 395             },
 396             model: ActorModel,
 397             required: true
 398           },
 399           {
 400             model: AccountModel.unscoped(),
 401             required: true,
 402             include: [
 403               {
 404                 attributes: {
 405                   exclude: unusedActorAttributesForAPI
 406                 },
 407                 model: ActorModel,
 408                 required: true
 409               }
 410             ]
 411           }
 412         ]
 413       }
 414
 415       return {
 416         attributes: forCount === true
 417           ? []
 418           : SORTABLE_COLUMNS.USER_SUBSCRIPTIONS,
 419         distinct: true,
 420         offset: start,
 421         limit: count,
 422         order: getSort(sort),
 423         where,
 424         include: [
 425           {
 426             attributes: [ 'id' ],
 427             model: ActorModel.unscoped(),
 428             as: 'ActorFollowing',
 429             required: true,
 430             include: [
 431               {
 432                 model: VideoChannelModel.unscoped(),
 433                 required: true,
 434                 include: channelInclude
 435               }
 436             ]
 437           }
 438         ]
 439       }
 440     }
 441
 442     return Promise.all([
 443       ActorFollowModel.count(getQuery(true)),
 444       ActorFollowModel.findAll<MActorFollowSubscriptions>(getQuery(false))
 445     ]).then(([ total, rows ]) => ({
 446       total,
 447       data: rows.map(r => r.ActorFollowing.VideoChannel)
 448     }))
 449   }
 450
 451   static async keepUnfollowedInstance (hosts: string[]) {
 452     const followerId = (await getServerActor()).id
 453
 454     const query = {
 455       attributes: [ 'id' ],
 456       where: {
 457         actorId: followerId
 458       },
 459       include: [
 460         {
 461           attributes: [ 'id' ],
 462           model: ActorModel.unscoped(),
 463           required: true,
 464           as: 'ActorFollowing',
 465           where: {
 466             preferredUsername: SERVER_ACTOR_NAME
 467           },
 468           include: [
 469             {
 470               attributes: [ 'host' ],
 471               model: ServerModel.unscoped(),
 472               required: true,
 473               where: {
 474                 host: {
 475                   [Op.in]: hosts
 476                 }
 477               }
 478             }
 479           ]
 480         }
 481       ]
 482     }
 483
 484     const res = await ActorFollowModel.findAll(query)
 485     const followedHosts = res.map(row => row.ActorFollowing.Server.host)
 486
 487     return difference(hosts, followedHosts)
 488   }
 489
 490   static listAcceptedFollowerUrlsForAP (actorIds: number[], t: Transaction, start?: number, count?: number) {
 491     return ActorFollowModel.createListAcceptedFollowForApiQuery('followers', actorIds, t, start, count)
 492   }
 493
 494   static listAcceptedFollowerSharedInboxUrls (actorIds: number[], t: Transaction) {
 495     return ActorFollowModel.createListAcceptedFollowForApiQuery(
 496       'followers',
 497       actorIds,
 498       t,
 499       undefined,
 500       undefined,
 501       'sharedInboxUrl',
 502       true
 503     )
 504   }
 505
 506   static listAcceptedFollowingUrlsForApi (actorIds: number[], t: Transaction, start?: number, count?: number) {
 507     return ActorFollowModel.createListAcceptedFollowForApiQuery('following', actorIds, t, start, count)
 508   }
 509
 510   static async getStats () {
 511     const serverActor = await getServerActor()
 512
 513     const totalInstanceFollowing = await ActorFollowModel.count({
 514       where: {
 515         actorId: serverActor.id
 516       }
 517     })
 518
 519     const totalInstanceFollowers = await ActorFollowModel.count({
 520       where: {
 521         targetActorId: serverActor.id
 522       }
 523     })
 524
 525     return {
 526       totalInstanceFollowing,
 527       totalInstanceFollowers
 528     }
 529   }
 530
 531   static updateScore (inboxUrl: string, value: number, t?: Transaction) {
 532     const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
 533       'WHERE id IN (' +
 534         'SELECT "actorFollow"."id" FROM "actorFollow" ' +
 535         'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."actorId" ' +
 536         `WHERE "actor"."inboxUrl" = '${inboxUrl}' OR "actor"."sharedInboxUrl" = '${inboxUrl}'` +
 537       ')'
 538
 539     const options = {
 540       type: QueryTypes.BULKUPDATE,
 541       transaction: t
 542     }
 543
 544     return ActorFollowModel.sequelize.query(query, options)
 545   }
 546
 547   static async updateScoreByFollowingServers (serverIds: number[], value: number, t?: Transaction) {
 548     if (serverIds.length === 0) return
 549
 550     const me = await getServerActor()
 551     const serverIdsString = createSafeIn(ActorFollowModel.sequelize, serverIds)
 552
 553     const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
 554       'WHERE id IN (' +
 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
 559       ')'
 560
 561     const options = {
 562       type: QueryTypes.BULKUPDATE,
 563       transaction: t
 564     }
 565
 566     return ActorFollowModel.sequelize.query(query, options)
 567   }
 568
 569   private static async createListAcceptedFollowForApiQuery (
 570     type: 'followers' | 'following',
 571     actorIds: number[],
 572     t: Transaction,
 573     start?: number,
 574     count?: number,
 575     columnUrl = 'url',
 576     distinct = false
 577   ) {
 578     let firstJoin: string
 579     let secondJoin: string
 580
 581     if (type === 'followers') {
 582       firstJoin = 'targetActorId'
 583       secondJoin = 'actorId'
 584     } else {
 585       firstJoin = 'actorId'
 586       secondJoin = 'targetActorId'
 587     }
 588
 589     const selections: string[] = []
 590     if (distinct === true) selections.push(`DISTINCT("Follows"."${columnUrl}") AS "selectionUrl"`)
 591     else selections.push(`"Follows"."${columnUrl}" AS "selectionUrl"`)
 592
 593     selections.push('COUNT(*) AS "total"')
 594
 595     const tasks: Promise<any>[] = []
 596
 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 `
 602
 603       if (count !== undefined) query += 'LIMIT ' + count
 604       if (start !== undefined) query += ' OFFSET ' + start
 605
 606       const options = {
 607         bind: { actorIds },
 608         type: QueryTypes.SELECT,
 609         transaction: t
 610       }
 611       tasks.push(ActorFollowModel.sequelize.query(query, options))
 612     }
 613
 614     const [ followers, [ dataTotal ] ] = await Promise.all(tasks)
 615     const urls: string[] = followers.map(f => f.selectionUrl)
 616
 617     return {
 618       data: urls,
 619       total: dataTotal ? parseInt(dataTotal.total, 10) : 0
 620     }
 621   }
 622
 623   private static listBadActorFollows () {
 624     const query = {
 625       where: {
 626         score: {
 627           [Op.lte]: 0
 628         }
 629       },
 630       logging: false
 631     }
 632
 633     return ActorFollowModel.findAll(query)
 634   }
 635
 636   toFormattedJSON (this: MActorFollowFormattable): ActorFollow {
 637     const follower = this.ActorFollower.toFormattedJSON()
 638     const following = this.ActorFollowing.toFormattedJSON()
 639
 640     return {
 641       id: this.id,
 642       follower,
 643       following,
 644       score: this.score,
 645       state: this.state,
 646       createdAt: this.createdAt,
 647       updatedAt: this.updatedAt
 648     }
 649   }
 650 }