123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742 |
- import { ActorFollow, type FollowState } from '@peertube/peertube-models'
- import { isActivityPubUrlValid } from '@server/helpers/custom-validators/activitypub/misc.js'
- import { afterCommitIfTransaction } from '@server/helpers/database-utils.js'
- import { getServerActor } from '@server/models/application/application.js'
- import {
- MActor,
- MActorFollowActors,
- MActorFollowActorsDefault,
- MActorFollowActorsDefaultSubscription,
- MActorFollowFollowingHost,
- MActorFollowFormattable,
- MActorFollowSubscriptions
- } from '@server/types/models/index.js'
- import difference from 'lodash-es/difference.js'
- import { Attributes, FindOptions, IncludeOptions, Includeable, Op, QueryTypes, Transaction, WhereAttributeHash } from 'sequelize'
- import {
- AfterCreate,
- AfterDestroy,
- AfterUpdate,
- AllowNull,
- BelongsTo,
- Column,
- CreatedAt,
- DataType,
- Default,
- ForeignKey,
- Is,
- IsInt,
- Max, Table,
- UpdatedAt
- } from 'sequelize-typescript'
- import { logger } from '../../helpers/logger.js'
- import { ACTOR_FOLLOW_SCORE, CONSTRAINTS_FIELDS, FOLLOW_STATES, SERVER_ACTOR_NAME, SORTABLE_COLUMNS } from '../../initializers/constants.js'
- import { AccountModel } from '../account/account.js'
- import { ServerModel } from '../server/server.js'
- import { SequelizeModel, buildSQLAttributes, createSafeIn, getSort, searchAttribute, throwIfNotValid } from '../shared/index.js'
- import { doesExist } from '../shared/query.js'
- import { VideoChannelModel } from '../video/video-channel.js'
- import { ActorModel, unusedActorAttributesForAPI } from './actor.js'
- import { InstanceListFollowersQueryBuilder, ListFollowersOptions } from './sql/instance-list-followers-query-builder.js'
- import { InstanceListFollowingQueryBuilder, ListFollowingOptions } from './sql/instance-list-following-query-builder.js'
- @Table({
- tableName: 'actorFollow',
- indexes: [
- {
- fields: [ 'actorId' ]
- },
- {
- fields: [ 'targetActorId' ]
- },
- {
- fields: [ 'actorId', 'targetActorId' ],
- unique: true
- },
- {
- fields: [ 'score' ]
- },
- {
- fields: [ 'url' ],
- unique: true
- }
- ]
- })
- export class ActorFollowModel extends SequelizeModel<ActorFollowModel> {
- @AllowNull(false)
- @Column(DataType.ENUM(...Object.values(FOLLOW_STATES)))
- state: FollowState
- @AllowNull(false)
- @Default(ACTOR_FOLLOW_SCORE.BASE)
- @IsInt
- @Max(ACTOR_FOLLOW_SCORE.MAX)
- @Column
- score: number
- // Allow null because we added this column in PeerTube v3, and don't want to generate fake URLs of remote follows
- @AllowNull(true)
- @Is('ActorFollowUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
- url: string
- @CreatedAt
- createdAt: Date
- @UpdatedAt
- updatedAt: Date
- @ForeignKey(() => ActorModel)
- @Column
- actorId: number
- @BelongsTo(() => ActorModel, {
- foreignKey: {
- name: 'actorId',
- allowNull: false
- },
- as: 'ActorFollower',
- onDelete: 'CASCADE'
- })
- ActorFollower: Awaited<ActorModel>
- @ForeignKey(() => ActorModel)
- @Column
- targetActorId: number
- @BelongsTo(() => ActorModel, {
- foreignKey: {
- name: 'targetActorId',
- allowNull: false
- },
- as: 'ActorFollowing',
- onDelete: 'CASCADE'
- })
- ActorFollowing: Awaited<ActorModel>
- @AfterCreate
- @AfterUpdate
- static incrementFollowerAndFollowingCount (instance: ActorFollowModel, options: any) {
- return afterCommitIfTransaction(options.transaction, () => {
- return Promise.all([
- ActorModel.rebuildFollowsCount(instance.actorId, 'following'),
- ActorModel.rebuildFollowsCount(instance.targetActorId, 'followers')
- ])
- })
- }
- @AfterDestroy
- static decrementFollowerAndFollowingCount (instance: ActorFollowModel, options: any) {
- return afterCommitIfTransaction(options.transaction, () => {
- return Promise.all([
- ActorModel.rebuildFollowsCount(instance.actorId, 'following'),
- ActorModel.rebuildFollowsCount(instance.targetActorId, 'followers')
- ])
- })
- }
- // ---------------------------------------------------------------------------
- static getSQLAttributes (tableName: string, aliasPrefix = '') {
- return buildSQLAttributes({
- model: this,
- tableName,
- aliasPrefix
- })
- }
- // ---------------------------------------------------------------------------
- /*
- * @deprecated Use `findOrCreateCustom` instead
- */
- static findOrCreate (): any {
- throw new Error('Must not be called')
- }
- // findOrCreate has issues with actor follow hooks
- static async findOrCreateCustom (options: {
- byActor: MActor
- targetActor: MActor
- activityId: string
- state: FollowState
- transaction: Transaction
- }): Promise<[ MActorFollowActors, boolean ]> {
- const { byActor, targetActor, activityId, state, transaction } = options
- let created = false
- let actorFollow: MActorFollowActors = await ActorFollowModel.loadByActorAndTarget(byActor.id, targetActor.id, transaction)
- if (!actorFollow) {
- created = true
- actorFollow = await ActorFollowModel.create({
- actorId: byActor.id,
- targetActorId: targetActor.id,
- url: activityId,
- state
- }, { transaction })
- actorFollow.ActorFollowing = targetActor
- actorFollow.ActorFollower = byActor
- }
- return [ actorFollow, created ]
- }
- static removeFollowsOf (actorId: number, t?: Transaction) {
- const query = {
- where: {
- [Op.or]: [
- {
- actorId
- },
- {
- targetActorId: actorId
- }
- ]
- },
- transaction: t
- }
- return ActorFollowModel.destroy(query)
- }
- // Remove actor follows with a score of 0 (too many requests where they were unreachable)
- static async removeBadActorFollows () {
- const actorFollows = await ActorFollowModel.listBadActorFollows()
- const actorFollowsRemovePromises = actorFollows.map(actorFollow => actorFollow.destroy())
- await Promise.all(actorFollowsRemovePromises)
- const numberOfActorFollowsRemoved = actorFollows.length
- if (numberOfActorFollowsRemoved) logger.info('Removed bad %d actor follows.', numberOfActorFollowsRemoved)
- }
- static isFollowedBy (actorId: number, followerActorId: number) {
- const query = `SELECT 1 FROM "actorFollow" ` +
- `WHERE "actorId" = $followerActorId AND "targetActorId" = $actorId AND "state" = 'accepted' ` +
- `LIMIT 1`
- return doesExist(this.sequelize, query, { actorId, followerActorId })
- }
- static loadByActorAndTarget (actorId: number, targetActorId: number, t?: Transaction): Promise<MActorFollowActorsDefault> {
- const query = {
- where: {
- actorId,
- targetActorId
- },
- include: [
- {
- model: ActorModel,
- required: true,
- as: 'ActorFollower'
- },
- {
- model: ActorModel,
- required: true,
- as: 'ActorFollowing'
- }
- ],
- transaction: t
- }
- return ActorFollowModel.findOne(query)
- }
- static loadByActorAndTargetNameAndHostForAPI (options: {
- actorId: number
- targetName: string
- targetHost: string
- state?: FollowState
- transaction?: Transaction
- }): Promise<MActorFollowActorsDefaultSubscription> {
- const { actorId, targetHost, targetName, state, transaction } = options
- const actorFollowingPartInclude: IncludeOptions = {
- model: ActorModel,
- required: true,
- as: 'ActorFollowing',
- where: ActorModel.wherePreferredUsername(targetName),
- include: [
- {
- model: VideoChannelModel.unscoped(),
- required: false
- }
- ]
- }
- if (targetHost === null) {
- actorFollowingPartInclude.where['serverId'] = null
- } else {
- actorFollowingPartInclude.include.push({
- model: ServerModel,
- required: true,
- where: {
- host: targetHost
- }
- })
- }
- const where: WhereAttributeHash<Attributes<ActorFollowModel>> = { actorId }
- if (state) where.state = state
- const query: FindOptions<Attributes<ActorFollowModel>> = {
- where,
- include: [
- actorFollowingPartInclude,
- {
- model: ActorModel,
- required: true,
- as: 'ActorFollower'
- }
- ],
- transaction
- }
- return ActorFollowModel.findOne(query)
- }
- static listSubscriptionsOf (actorId: number, targets: { name: string, host?: string }[]): Promise<MActorFollowFollowingHost[]> {
- const whereTab = targets
- .map(t => {
- if (t.host) {
- return {
- [Op.and]: [
- ActorModel.wherePreferredUsername(t.name),
- { $host$: t.host }
- ]
- }
- }
- return {
- [Op.and]: [
- ActorModel.wherePreferredUsername(t.name),
- { $serverId$: null }
- ]
- }
- })
- const query = {
- attributes: [ 'id' ],
- where: {
- [Op.and]: [
- {
- [Op.or]: whereTab
- },
- {
- state: 'accepted',
- actorId
- }
- ]
- },
- include: [
- {
- attributes: [ 'preferredUsername' ],
- model: ActorModel.unscoped(),
- required: true,
- as: 'ActorFollowing',
- include: [
- {
- attributes: [ 'host' ],
- model: ServerModel.unscoped(),
- required: false
- }
- ]
- }
- ]
- }
- return ActorFollowModel.findAll(query)
- }
- static listInstanceFollowingForApi (options: ListFollowingOptions) {
- return Promise.all([
- new InstanceListFollowingQueryBuilder(this.sequelize, options).countFollowing(),
- new InstanceListFollowingQueryBuilder(this.sequelize, options).listFollowing()
- ]).then(([ total, data ]) => ({ total, data }))
- }
- static listFollowersForApi (options: ListFollowersOptions) {
- return Promise.all([
- new InstanceListFollowersQueryBuilder(this.sequelize, options).countFollowers(),
- new InstanceListFollowersQueryBuilder(this.sequelize, options).listFollowers()
- ]).then(([ total, data ]) => ({ total, data }))
- }
- static listSubscriptionsForApi (options: {
- actorId: number
- start: number
- count: number
- sort: string
- search?: string
- }) {
- const { actorId, start, count, sort } = options
- const where = {
- state: 'accepted',
- actorId
- }
- if (options.search) {
- Object.assign(where, {
- [Op.or]: [
- searchAttribute(options.search, '$ActorFollowing.preferredUsername$'),
- searchAttribute(options.search, '$ActorFollowing.VideoChannel.name$')
- ]
- })
- }
- const getQuery = (forCount: boolean) => {
- let channelInclude: Includeable[] = []
- if (forCount !== true) {
- channelInclude = [
- {
- attributes: {
- exclude: unusedActorAttributesForAPI
- },
- model: ActorModel,
- required: true
- },
- {
- model: AccountModel.unscoped(),
- required: true,
- include: [
- {
- attributes: {
- exclude: unusedActorAttributesForAPI
- },
- model: ActorModel,
- required: true
- }
- ]
- }
- ]
- }
- return {
- attributes: forCount === true
- ? []
- : SORTABLE_COLUMNS.USER_SUBSCRIPTIONS,
- distinct: true,
- offset: start,
- limit: count,
- order: getSort(sort),
- where,
- include: [
- {
- attributes: [ 'id' ],
- model: ActorModel.unscoped(),
- as: 'ActorFollowing',
- required: true,
- include: [
- {
- model: VideoChannelModel.unscoped(),
- required: true,
- include: channelInclude
- }
- ]
- }
- ]
- }
- }
- return Promise.all([
- ActorFollowModel.count(getQuery(true)),
- ActorFollowModel.findAll<MActorFollowSubscriptions>(getQuery(false))
- ]).then(([ total, rows ]) => ({
- total,
- data: rows.map(r => r.ActorFollowing.VideoChannel)
- }))
- }
- static async keepUnfollowedInstance (hosts: string[]) {
- const followerId = (await getServerActor()).id
- const query = {
- attributes: [ 'id' ],
- where: {
- actorId: followerId
- },
- include: [
- {
- attributes: [ 'id' ],
- model: ActorModel.unscoped(),
- required: true,
- as: 'ActorFollowing',
- where: {
- preferredUsername: SERVER_ACTOR_NAME
- },
- include: [
- {
- attributes: [ 'host' ],
- model: ServerModel.unscoped(),
- required: true,
- where: {
- host: {
- [Op.in]: hosts
- }
- }
- }
- ]
- }
- ]
- }
- const res = await ActorFollowModel.findAll(query)
- const followedHosts = res.map(row => row.ActorFollowing.Server.host)
- return difference(hosts, followedHosts)
- }
- // ---------------------------------------------------------------------------
- static listAcceptedFollowerUrlsForAP (actorIds: number[], t: Transaction, start?: number, count?: number) {
- return ActorFollowModel.createListAcceptedFollowForApiQuery({ type: 'followers', actorIds, t, start, count })
- .then(({ data, total }) => ({ total, data: data.map(d => d.selectionUrl) }))
- }
- static listAcceptedFollowerSharedInboxUrls (actorIds: number[], t: Transaction) {
- return ActorFollowModel.createListAcceptedFollowForApiQuery({
- type: 'followers',
- actorIds,
- t,
- columnUrl: 'sharedInboxUrl',
- distinct: true
- }).then(({ data, total }) => ({ total, data: data.map(d => d.selectionUrl) }))
- }
- static listAcceptedFollowersForExport (targetActorId: number) {
- const query = {
- where: {
- state: 'accepted',
- targetActorId
- },
- include: [
- {
- attributes: [ 'preferredUsername', 'url' ],
- model: ActorModel.unscoped(),
- required: true,
- as: 'ActorFollower',
- include: [
- {
- attributes: [ 'host' ],
- model: ServerModel.unscoped(),
- required: false
- }
- ]
- }
- ]
- }
- return ActorFollowModel.findAll(query)
- .then(data => {
- return data.map(f => ({
- createdAt: f.createdAt,
- followerHandle: f.ActorFollower.getFullIdentifier(),
- followerUrl: f.ActorFollower.url
- }))
- })
- }
- // ---------------------------------------------------------------------------
- static listAcceptedFollowingUrlsForApi (actorIds: number[], t: Transaction, start?: number, count?: number) {
- return ActorFollowModel.createListAcceptedFollowForApiQuery({ type: 'following', actorIds, t, start, count })
- .then(({ data, total }) => ({ total, data: data.map(d => d.selectionUrl) }))
- }
- static listAcceptedFollowingForExport (actorId: number) {
- const query = {
- where: {
- state: 'accepted',
- actorId
- },
- include: [
- {
- attributes: [ 'preferredUsername', 'url' ],
- model: ActorModel.unscoped(),
- required: true,
- as: 'ActorFollowing',
- include: [
- {
- attributes: [ 'host' ],
- model: ServerModel.unscoped(),
- required: false
- }
- ]
- }
- ]
- }
- return ActorFollowModel.findAll(query)
- .then(data => {
- return data.map(f => ({
- createdAt: f.createdAt,
- followingHandle: f.ActorFollowing.getFullIdentifier(),
- followingUrl: f.ActorFollowing.url
- }))
- })
- }
- // ---------------------------------------------------------------------------
- static async getStats () {
- const serverActor = await getServerActor()
- const totalInstanceFollowing = await ActorFollowModel.count({
- where: {
- actorId: serverActor.id,
- state: 'accepted'
- }
- })
- const totalInstanceFollowers = await ActorFollowModel.count({
- where: {
- targetActorId: serverActor.id,
- state: 'accepted'
- }
- })
- return {
- totalInstanceFollowing,
- totalInstanceFollowers
- }
- }
- static updateScore (inboxUrl: string, value: number, t?: Transaction) {
- const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
- 'WHERE id IN (' +
- 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
- 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."actorId" ' +
- `WHERE "actor"."inboxUrl" = '${inboxUrl}' OR "actor"."sharedInboxUrl" = '${inboxUrl}'` +
- ')'
- const options = {
- type: QueryTypes.BULKUPDATE,
- transaction: t
- }
- return ActorFollowModel.sequelize.query(query, options)
- }
- static async updateScoreByFollowingServers (serverIds: number[], value: number, t?: Transaction) {
- if (serverIds.length === 0) return
- const me = await getServerActor()
- const serverIdsString = createSafeIn(ActorFollowModel.sequelize, serverIds)
- const query = `UPDATE "actorFollow" SET "score" = LEAST("score" + ${value}, ${ACTOR_FOLLOW_SCORE.MAX}) ` +
- 'WHERE id IN (' +
- 'SELECT "actorFollow"."id" FROM "actorFollow" ' +
- 'INNER JOIN "actor" ON "actor"."id" = "actorFollow"."targetActorId" ' +
- `WHERE "actorFollow"."actorId" = ${me.Account.actorId} ` + // I'm the follower
- `AND "actor"."serverId" IN (${serverIdsString})` + // Criteria on followings
- ')'
- const options = {
- type: QueryTypes.BULKUPDATE,
- transaction: t
- }
- return ActorFollowModel.sequelize.query(query, options)
- }
- private static async createListAcceptedFollowForApiQuery (options: {
- type: 'followers' | 'following'
- actorIds: number[]
- t: Transaction
- start?: number
- count?: number
- columnUrl?: string // Default 'url'
- distinct?: boolean // Default false
- selectTotal?: boolean // Default true
- }) {
- const { type, actorIds, t, start, count, columnUrl = 'url', distinct = false, selectTotal = true } = options
- let firstJoin: string
- let secondJoin: string
- if (type === 'followers') {
- firstJoin = 'targetActorId'
- secondJoin = 'actorId'
- } else {
- firstJoin = 'actorId'
- secondJoin = 'targetActorId'
- }
- const selections: string[] = []
- selections.push(
- distinct === true
- ? `DISTINCT("Follows"."${columnUrl}") AS "selectionUrl"`
- : `"Follows"."${columnUrl}" AS "selectionUrl"`
- )
- if (selectTotal) selections.push('COUNT(*) AS "total"')
- const tasks: Promise<any>[] = []
- for (const selection of selections) {
- let query = 'SELECT ' + selection + ' FROM "actor" ' +
- 'INNER JOIN "actorFollow" ON "actorFollow"."' + firstJoin + '" = "actor"."id" ' +
- 'INNER JOIN "actor" AS "Follows" ON "actorFollow"."' + secondJoin + '" = "Follows"."id" ' +
- `WHERE "actor"."id" = ANY ($actorIds) AND "actorFollow"."state" = 'accepted' AND "Follows"."${columnUrl}" IS NOT NULL `
- if (count !== undefined) query += 'LIMIT ' + count
- if (start !== undefined) query += ' OFFSET ' + start
- const options = {
- bind: { actorIds },
- type: QueryTypes.SELECT,
- transaction: t
- }
- tasks.push(ActorFollowModel.sequelize.query(query, options))
- }
- const [ followers, resDataTotal ] = await Promise.all(tasks)
- return {
- data: followers.map(f => ({ selectionUrl: f.selectionUrl, createdAt: f.createdAt })) as { selectionUrl: string, createdAt: string }[],
- total: selectTotal
- ? parseInt(resDataTotal?.dataTotal?.[0]?.total || 0, 10)
- : undefined
- }
- }
- private static listBadActorFollows () {
- const query = {
- where: {
- score: {
- [Op.lte]: 0
- }
- },
- logging: false
- }
- return ActorFollowModel.findAll(query)
- }
- toFormattedJSON (this: MActorFollowFormattable): ActorFollow {
- const follower = this.ActorFollower.toFormattedJSON()
- const following = this.ActorFollowing.toFormattedJSON()
- return {
- id: this.id,
- follower,
- following,
- score: this.score,
- state: this.state,
- createdAt: this.createdAt,
- updatedAt: this.updatedAt
- }
- }
- }
|