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

260 lines
6.6 KiB
TypeScript
Raw Normal View History

import { AccountVideoRate, type VideoRateType } from '@peertube/peertube-models'
import { AttributesOnly } from '@peertube/peertube-typescript-utils'
2019-08-20 19:05:31 +02:00
import {
MAccountVideoRate,
MAccountVideoRateAccountUrl,
MAccountVideoRateAccountVideo,
MAccountVideoRateFormattable
} from '@server/types/models/index.js'
import { FindOptions, Op, QueryTypes, Transaction } from 'sequelize'
import { AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc.js'
import { CONSTRAINTS_FIELDS, VIDEO_RATE_TYPES } from '../../initializers/constants.js'
import { ActorModel } from '../actor/actor.js'
import { getSort, throwIfNotValid } from '../shared/index.js'
import { SummaryOptions, VideoChannelModel, ScopeNames as VideoChannelScopeNames } from '../video/video-channel.js'
import { VideoModel } from '../video/video.js'
import { AccountModel } from './account.js'
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
/*
Account rates per video.
*/
@Table({
tableName: 'accountVideoRate',
indexes: [
2017-03-08 21:35:43 +01:00
{
2017-12-12 17:53:50 +01:00
fields: [ 'videoId', 'accountId' ],
unique: true
2018-07-23 20:13:30 +02:00
},
{
fields: [ 'videoId' ]
},
{
fields: [ 'accountId' ]
},
{
fields: [ 'videoId', 'type' ]
2018-11-14 15:01:28 +01:00
},
{
fields: [ 'url' ],
unique: true
2017-03-08 21:35:43 +01:00
}
2017-12-12 17:53:50 +01:00
]
})
2021-05-12 14:09:04 +02:00
export class AccountVideoRateModel extends Model<Partial<AttributesOnly<AccountVideoRateModel>>> {
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
@AllowNull(false)
2022-08-17 15:36:03 +02:00
@Column(DataType.ENUM(...Object.values(VIDEO_RATE_TYPES)))
2017-12-12 17:53:50 +01:00
type: VideoRateType
2017-05-22 20:58:25 +02:00
2018-11-14 15:01:28 +01:00
@AllowNull(false)
@Is('AccountVideoRateUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_RATES.URL.max))
url: string
2017-12-12 17:53:50 +01:00
@CreatedAt
createdAt: Date
2017-05-22 20:58:25 +02:00
2017-12-12 17:53:50 +01:00
@UpdatedAt
updatedAt: Date
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
@ForeignKey(() => VideoModel)
@Column
videoId: number
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
@BelongsTo(() => VideoModel, {
2017-03-08 21:35:43 +01:00
foreignKey: {
allowNull: false
},
onDelete: 'CASCADE'
})
Video: Awaited<VideoModel>
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
@ForeignKey(() => AccountModel)
@Column
accountId: number
@BelongsTo(() => AccountModel, {
2017-03-08 21:35:43 +01:00
foreignKey: {
allowNull: false
},
onDelete: 'CASCADE'
})
Account: Awaited<AccountModel>
2017-03-08 21:35:43 +01:00
2020-12-08 14:30:29 +01:00
static load (accountId: number, videoId: number, transaction?: Transaction): Promise<MAccountVideoRate> {
2019-04-18 11:28:17 +02:00
const options: FindOptions = {
2017-12-12 17:53:50 +01:00
where: {
accountId,
videoId
}
2017-03-08 21:35:43 +01:00
}
2017-12-12 17:53:50 +01:00
if (transaction) options.transaction = transaction
2017-03-08 21:35:43 +01:00
2017-12-12 17:53:50 +01:00
return AccountVideoRateModel.findOne(options)
}
2020-12-08 14:30:29 +01:00
static loadByAccountAndVideoOrUrl (accountId: number, videoId: number, url: string, t?: Transaction): Promise<MAccountVideoRate> {
2019-08-01 10:15:28 +02:00
const options: FindOptions = {
where: {
2020-01-31 16:56:52 +01:00
[Op.or]: [
2019-08-01 10:15:28 +02:00
{
accountId,
videoId
},
{
url
}
]
}
}
2019-08-15 11:53:26 +02:00
if (t) options.transaction = t
2019-08-01 10:15:28 +02:00
return AccountVideoRateModel.findOne(options)
}
static listByAccountForApi (options: {
2020-01-31 16:56:52 +01:00
start: number
count: number
sort: string
type?: string
accountId: number
}) {
const getQuery = (forCount: boolean) => {
const query: FindOptions = {
offset: options.start,
limit: options.count,
order: getSort(options.sort),
where: {
accountId: options.accountId
}
}
if (options.type) query.where['type'] = options.type
if (forCount !== true) {
query.include = [
{
model: VideoModel,
required: true,
include: [
{
model: VideoChannelModel.scope({ method: [ VideoChannelScopeNames.SUMMARY, { withAccount: true } as SummaryOptions ] }),
required: true
}
]
}
]
}
return query
}
return Promise.all([
AccountVideoRateModel.count(getQuery(true)),
AccountVideoRateModel.findAll(getQuery(false))
]).then(([ total, data ]) => ({ total, data }))
}
static listRemoteRateUrlsOfLocalVideos () {
const query = `SELECT "accountVideoRate".url FROM "accountVideoRate" ` +
`INNER JOIN account ON account.id = "accountVideoRate"."accountId" ` +
`INNER JOIN actor ON actor.id = account."actorId" AND actor."serverId" IS NOT NULL ` +
`INNER JOIN video ON video.id = "accountVideoRate"."videoId" AND video.remote IS FALSE`
return AccountVideoRateModel.sequelize.query<{ url: string }>(query, {
type: QueryTypes.SELECT,
raw: true
}).then(rows => rows.map(r => r.url))
}
2019-08-15 11:53:26 +02:00
static loadLocalAndPopulateVideo (
rateType: VideoRateType,
accountName: string,
videoId: number,
2019-08-15 11:53:26 +02:00
t?: Transaction
2020-12-08 14:30:29 +01:00
): Promise<MAccountVideoRateAccountVideo> {
2019-04-18 11:28:17 +02:00
const options: FindOptions = {
2018-11-14 15:01:28 +01:00
where: {
videoId,
type: rateType
},
include: [
{
model: AccountModel.unscoped(),
required: true,
include: [
{
2019-08-15 11:53:26 +02:00
attributes: [ 'id', 'url', 'followersUrl', 'preferredUsername' ],
2018-11-14 15:01:28 +01:00
model: ActorModel.unscoped(),
required: true,
where: {
[Op.and]: [
ActorModel.wherePreferredUsername(accountName),
{ serverId: null }
]
2018-11-14 15:01:28 +01:00
}
}
]
},
{
model: VideoModel.unscoped(),
required: true
}
]
}
2019-08-15 11:53:26 +02:00
if (t) options.transaction = t
2018-11-14 15:01:28 +01:00
return AccountVideoRateModel.findOne(options)
}
static loadByUrl (url: string, transaction: Transaction) {
2019-04-18 11:28:17 +02:00
const options: FindOptions = {
2018-11-14 15:01:28 +01:00
where: {
url
}
}
if (transaction) options.transaction = transaction
return AccountVideoRateModel.findOne(options)
}
static listAndCountAccountUrlsByVideoId (rateType: VideoRateType, videoId: number, start: number, count: number, t?: Transaction) {
const query = {
offset: start,
limit: count,
where: {
videoId,
type: rateType
},
transaction: t,
include: [
{
attributes: [ 'actorId' ],
model: AccountModel.unscoped(),
required: true,
include: [
{
attributes: [ 'url' ],
model: ActorModel.unscoped(),
required: true
}
]
}
]
}
return Promise.all([
AccountVideoRateModel.count(query),
AccountVideoRateModel.findAll<MAccountVideoRateAccountUrl>(query)
]).then(([ total, data ]) => ({ total, data }))
}
2019-03-19 16:23:02 +01:00
2019-08-20 19:05:31 +02:00
toFormattedJSON (this: MAccountVideoRateFormattable): AccountVideoRate {
return {
video: this.Video.toFormattedJSON(),
rating: this.type
}
}
2017-03-08 21:35:43 +01:00
}