server/models/account/account-video-rate.ts

   1 import { values } from 'lodash'
   2 import { FindOptions, Op, QueryTypes, Transaction } from 'sequelize'
   3 import { AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
   4 import {
   5   MAccountVideoRate,
   6   MAccountVideoRateAccountUrl,
   7   MAccountVideoRateAccountVideo,
   8   MAccountVideoRateFormattable
   9 } from '@server/types/models/video/video-rate'
  10 import { AttributesOnly } from '@shared/core-utils'
  11 import { AccountVideoRate } from '../../../shared'
  12 import { VideoRateType } from '../../../shared/models/videos'
  13 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
  14 import { CONSTRAINTS_FIELDS, VIDEO_RATE_TYPES } from '../../initializers/constants'
  15 import { ActorModel } from '../actor/actor'
  16 import { buildLocalAccountIdsIn, getSort, throwIfNotValid } from '../utils'
  17 import { VideoModel } from '../video/video'
  18 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from '../video/video-channel'
  19 import { AccountModel } from './account'
  20
  21 /*
  22   Account rates per video.
  23 */
  24 @Table({
  25   tableName: 'accountVideoRate',
  26   indexes: [
  27     {
  28       fields: [ 'videoId', 'accountId' ],
  29       unique: true
  30     },
  31     {
  32       fields: [ 'videoId' ]
  33     },
  34     {
  35       fields: [ 'accountId' ]
  36     },
  37     {
  38       fields: [ 'videoId', 'type' ]
  39     },
  40     {
  41       fields: [ 'url' ],
  42       unique: true
  43     }
  44   ]
  45 })
  46 export class AccountVideoRateModel extends Model<Partial<AttributesOnly<AccountVideoRateModel>>> {
  47
  48   @AllowNull(false)
  49   @Column(DataType.ENUM(...values(VIDEO_RATE_TYPES)))
  50   type: VideoRateType
  51
  52   @AllowNull(false)
  53   @Is('AccountVideoRateUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
  54   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_RATES.URL.max))
  55   url: string
  56
  57   @CreatedAt
  58   createdAt: Date
  59
  60   @UpdatedAt
  61   updatedAt: Date
  62
  63   @ForeignKey(() => VideoModel)
  64   @Column
  65   videoId: number
  66
  67   @BelongsTo(() => VideoModel, {
  68     foreignKey: {
  69       allowNull: false
  70     },
  71     onDelete: 'CASCADE'
  72   })
  73   Video: VideoModel
  74
  75   @ForeignKey(() => AccountModel)
  76   @Column
  77   accountId: number
  78
  79   @BelongsTo(() => AccountModel, {
  80     foreignKey: {
  81       allowNull: false
  82     },
  83     onDelete: 'CASCADE'
  84   })
  85   Account: AccountModel
  86
  87   static load (accountId: number, videoId: number, transaction?: Transaction): Promise<MAccountVideoRate> {
  88     const options: FindOptions = {
  89       where: {
  90         accountId,
  91         videoId
  92       }
  93     }
  94     if (transaction) options.transaction = transaction
  95
  96     return AccountVideoRateModel.findOne(options)
  97   }
  98
  99   static loadByAccountAndVideoOrUrl (accountId: number, videoId: number, url: string, t?: Transaction): Promise<MAccountVideoRate> {
 100     const options: FindOptions = {
 101       where: {
 102         [Op.or]: [
 103           {
 104             accountId,
 105             videoId
 106           },
 107           {
 108             url
 109           }
 110         ]
 111       }
 112     }
 113     if (t) options.transaction = t
 114
 115     return AccountVideoRateModel.findOne(options)
 116   }
 117
 118   static listByAccountForApi (options: {
 119     start: number
 120     count: number
 121     sort: string
 122     type?: string
 123     accountId: number
 124   }) {
 125     const query: FindOptions = {
 126       offset: options.start,
 127       limit: options.count,
 128       order: getSort(options.sort),
 129       where: {
 130         accountId: options.accountId
 131       },
 132       include: [
 133         {
 134           model: VideoModel,
 135           required: true,
 136           include: [
 137             {
 138               model: VideoChannelModel.scope({ method: [ VideoChannelScopeNames.SUMMARY, { withAccount: true } as SummaryOptions ] }),
 139               required: true
 140             }
 141           ]
 142         }
 143       ]
 144     }
 145     if (options.type) query.where['type'] = options.type
 146
 147     return AccountVideoRateModel.findAndCountAll(query)
 148   }
 149
 150   static listRemoteRateUrlsOfLocalVideos () {
 151     const query = `SELECT "accountVideoRate".url FROM "accountVideoRate" ` +
 152       `INNER JOIN account ON account.id = "accountVideoRate"."accountId" ` +
 153       `INNER JOIN actor ON actor.id = account."actorId" AND actor."serverId" IS NOT NULL ` +
 154       `INNER JOIN video ON video.id = "accountVideoRate"."videoId" AND video.remote IS FALSE`
 155
 156     return AccountVideoRateModel.sequelize.query<{ url: string }>(query, {
 157       type: QueryTypes.SELECT,
 158       raw: true
 159     }).then(rows => rows.map(r => r.url))
 160   }
 161
 162   static loadLocalAndPopulateVideo (
 163     rateType: VideoRateType,
 164     accountName: string,
 165     videoId: number,
 166     t?: Transaction
 167   ): Promise<MAccountVideoRateAccountVideo> {
 168     const options: FindOptions = {
 169       where: {
 170         videoId,
 171         type: rateType
 172       },
 173       include: [
 174         {
 175           model: AccountModel.unscoped(),
 176           required: true,
 177           include: [
 178             {
 179               attributes: [ 'id', 'url', 'followersUrl', 'preferredUsername' ],
 180               model: ActorModel.unscoped(),
 181               required: true,
 182               where: {
 183                 preferredUsername: accountName,
 184                 serverId: null
 185               }
 186             }
 187           ]
 188         },
 189         {
 190           model: VideoModel.unscoped(),
 191           required: true
 192         }
 193       ]
 194     }
 195     if (t) options.transaction = t
 196
 197     return AccountVideoRateModel.findOne(options)
 198   }
 199
 200   static loadByUrl (url: string, transaction: Transaction) {
 201     const options: FindOptions = {
 202       where: {
 203         url
 204       }
 205     }
 206     if (transaction) options.transaction = transaction
 207
 208     return AccountVideoRateModel.findOne(options)
 209   }
 210
 211   static listAndCountAccountUrlsByVideoId (rateType: VideoRateType, videoId: number, start: number, count: number, t?: Transaction) {
 212     const query = {
 213       offset: start,
 214       limit: count,
 215       where: {
 216         videoId,
 217         type: rateType
 218       },
 219       transaction: t,
 220       include: [
 221         {
 222           attributes: [ 'actorId' ],
 223           model: AccountModel.unscoped(),
 224           required: true,
 225           include: [
 226             {
 227               attributes: [ 'url' ],
 228               model: ActorModel.unscoped(),
 229               required: true
 230             }
 231           ]
 232         }
 233       ]
 234     }
 235
 236     return AccountVideoRateModel.findAndCountAll<MAccountVideoRateAccountUrl>(query)
 237   }
 238
 239   static cleanOldRatesOf (videoId: number, type: VideoRateType, beforeUpdatedAt: Date) {
 240     return AccountVideoRateModel.sequelize.transaction(async t => {
 241       const query = {
 242         where: {
 243           updatedAt: {
 244             [Op.lt]: beforeUpdatedAt
 245           },
 246           videoId,
 247           type,
 248           accountId: {
 249             [Op.notIn]: buildLocalAccountIdsIn()
 250           }
 251         },
 252         transaction: t
 253       }
 254
 255       await AccountVideoRateModel.destroy(query)
 256
 257       return VideoModel.updateRatesOf(videoId, type, t)
 258     })
 259   }
 260
 261   toFormattedJSON (this: MAccountVideoRateFormattable): AccountVideoRate {
 262     return {
 263       video: this.Video.toFormattedJSON(),
 264       rating: this.type
 265     }
 266   }
 267 }