server/models/video/video-channel-sync.ts

   1 import { Op } from 'sequelize'
   2 import {
   3   AllowNull,
   4   BelongsTo,
   5   Column,
   6   CreatedAt,
   7   DataType,
   8   Default,
   9   DefaultScope,
  10   ForeignKey,
  11   Is,
  12   Model,
  13   Table,
  14   UpdatedAt
  15 } from 'sequelize-typescript'
  16 import { isUrlValid } from '@server/helpers/custom-validators/activitypub/misc'
  17 import { isVideoChannelSyncStateValid } from '@server/helpers/custom-validators/video-channel-syncs'
  18 import { CONSTRAINTS_FIELDS, VIDEO_CHANNEL_SYNC_STATE } from '@server/initializers/constants'
  19 import { MChannelSync, MChannelSyncChannel, MChannelSyncFormattable } from '@server/types/models'
  20 import { VideoChannelSync, VideoChannelSyncState } from '@shared/models'
  21 import { AttributesOnly } from '@shared/typescript-utils'
  22 import { AccountModel } from '../account/account'
  23 import { UserModel } from '../user/user'
  24 import { getChannelSyncSort, throwIfNotValid } from '../shared'
  25 import { VideoChannelModel } from './video-channel'
  26
  27 @DefaultScope(() => ({
  28   include: [
  29     {
  30       model: VideoChannelModel, // Default scope includes avatar and server
  31       required: true
  32     }
  33   ]
  34 }))
  35 @Table({
  36   tableName: 'videoChannelSync',
  37   indexes: [
  38     {
  39       fields: [ 'videoChannelId' ]
  40     }
  41   ]
  42 })
  43 export class VideoChannelSyncModel extends Model<Partial<AttributesOnly<VideoChannelSyncModel>>> {
  44
  45   @AllowNull(false)
  46   @Default(null)
  47   @Is('VideoChannelExternalChannelUrl', value => throwIfNotValid(value, isUrlValid, 'externalChannelUrl', true))
  48   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_CHANNEL_SYNCS.EXTERNAL_CHANNEL_URL.max))
  49   externalChannelUrl: string
  50
  51   @CreatedAt
  52   createdAt: Date
  53
  54   @UpdatedAt
  55   updatedAt: Date
  56
  57   @ForeignKey(() => VideoChannelModel)
  58   @Column
  59   videoChannelId: number
  60
  61   @BelongsTo(() => VideoChannelModel, {
  62     foreignKey: {
  63       allowNull: false
  64     },
  65     onDelete: 'cascade'
  66   })
  67   VideoChannel: VideoChannelModel
  68
  69   @AllowNull(false)
  70   @Default(VideoChannelSyncState.WAITING_FIRST_RUN)
  71   @Is('VideoChannelSyncState', value => throwIfNotValid(value, isVideoChannelSyncStateValid, 'state'))
  72   @Column
  73   state: VideoChannelSyncState
  74
  75   @AllowNull(true)
  76   @Column(DataType.DATE)
  77   lastSyncAt: Date
  78
  79   static listByAccountForAPI (options: {
  80     accountId: number
  81     start: number
  82     count: number
  83     sort: string
  84   }) {
  85     const getQuery = (forCount: boolean) => {
  86       const videoChannelModel = forCount
  87         ? VideoChannelModel.unscoped()
  88         : VideoChannelModel
  89
  90       return {
  91         offset: options.start,
  92         limit: options.count,
  93         order: getChannelSyncSort(options.sort),
  94         include: [
  95           {
  96             model: videoChannelModel,
  97             required: true,
  98             where: {
  99               accountId: options.accountId
 100             }
 101           }
 102         ]
 103       }
 104     }
 105
 106     return Promise.all([
 107       VideoChannelSyncModel.unscoped().count(getQuery(true)),
 108       VideoChannelSyncModel.unscoped().findAll(getQuery(false))
 109     ]).then(([ total, data ]) => ({ total, data }))
 110   }
 111
 112   static countByAccount (accountId: number) {
 113     const query = {
 114       include: [
 115         {
 116           model: VideoChannelModel.unscoped(),
 117           required: true,
 118           where: {
 119             accountId
 120           }
 121         }
 122       ]
 123     }
 124
 125     return VideoChannelSyncModel.unscoped().count(query)
 126   }
 127
 128   static loadWithChannel (id: number): Promise<MChannelSyncChannel> {
 129     return VideoChannelSyncModel.findByPk(id)
 130   }
 131
 132   static async listSyncs (): Promise<MChannelSync[]> {
 133     const query = {
 134       include: [
 135         {
 136           model: VideoChannelModel.unscoped(),
 137           required: true,
 138           include: [
 139             {
 140               model: AccountModel.unscoped(),
 141               required: true,
 142               include: [ {
 143                 attributes: [],
 144                 model: UserModel.unscoped(),
 145                 required: true,
 146                 where: {
 147                   videoQuota: {
 148                     [Op.ne]: 0
 149                   },
 150                   videoQuotaDaily: {
 151                     [Op.ne]: 0
 152                   }
 153                 }
 154               } ]
 155             }
 156           ]
 157         }
 158       ]
 159     }
 160     return VideoChannelSyncModel.unscoped().findAll(query)
 161   }
 162
 163   toFormattedJSON (this: MChannelSyncFormattable): VideoChannelSync {
 164     return {
 165       id: this.id,
 166       state: {
 167         id: this.state,
 168         label: VIDEO_CHANNEL_SYNC_STATE[this.state]
 169       },
 170       externalChannelUrl: this.externalChannelUrl,
 171       createdAt: this.createdAt.toISOString(),
 172       channel: this.VideoChannel.toFormattedSummaryJSON(),
 173       lastSyncAt: this.lastSyncAt?.toISOString()
 174     }
 175   }
 176 }