PeerTube/server/models/video/video-import.ts

199 lines
5.0 KiB
TypeScript
Raw Normal View History

import { WhereOptions } from 'sequelize'
import {
2018-08-02 17:48:50 +02:00
AfterUpdate,
AllowNull,
BelongsTo,
Column,
CreatedAt,
DataType,
Default,
DefaultScope,
ForeignKey,
Is,
Model,
Table,
UpdatedAt
} from 'sequelize-typescript'
2021-05-11 11:15:29 +02:00
import { afterCommitIfTransaction } from '@server/helpers/database-utils'
2020-12-08 14:30:29 +01:00
import { MVideoImportDefault, MVideoImportFormattable } from '@server/types/models/video/video-import'
2021-12-24 10:14:47 +01:00
import { VideoImport, VideoImportState } from '@shared/models'
import { AttributesOnly } from '@shared/typescript-utils'
2020-12-08 14:30:29 +01:00
import { isVideoImportStateValid, isVideoImportTargetUrlValid } from '../../helpers/custom-validators/video-imports'
2018-08-06 17:13:39 +02:00
import { isVideoMagnetUriValid } from '../../helpers/custom-validators/videos'
2020-12-08 14:30:29 +01:00
import { CONSTRAINTS_FIELDS, VIDEO_IMPORT_STATES } from '../../initializers/constants'
2021-05-11 11:15:29 +02:00
import { UserModel } from '../user/user'
2020-12-08 14:30:29 +01:00
import { getSort, throwIfNotValid } from '../utils'
import { ScopeNames as VideoModelScopeNames, VideoModel } from './video'
2019-04-23 09:50:57 +02:00
@DefaultScope(() => ({
include: [
{
2019-04-23 09:50:57 +02:00
model: UserModel.unscoped(),
2018-08-07 10:07:53 +02:00
required: true
},
{
2019-08-15 11:53:26 +02:00
model: VideoModel.scope([
VideoModelScopeNames.WITH_ACCOUNT_DETAILS,
VideoModelScopeNames.WITH_TAGS,
VideoModelScopeNames.WITH_THUMBNAILS
]),
2018-08-07 10:07:53 +02:00
required: false
}
]
2019-04-23 09:50:57 +02:00
}))
@Table({
tableName: 'videoImport',
indexes: [
{
fields: [ 'videoId' ],
unique: true
2018-08-07 10:07:53 +02:00
},
{
fields: [ 'userId' ]
}
]
})
2021-05-12 14:09:04 +02:00
export class VideoImportModel extends Model<Partial<AttributesOnly<VideoImportModel>>> {
@CreatedAt
createdAt: Date
@UpdatedAt
updatedAt: Date
2018-08-06 17:13:39 +02:00
@AllowNull(true)
@Default(null)
2019-04-18 11:28:17 +02:00
@Is('VideoImportTargetUrl', value => throwIfNotValid(value, isVideoImportTargetUrlValid, 'targetUrl', true))
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_IMPORTS.URL.max))
targetUrl: string
2018-08-06 17:13:39 +02:00
@AllowNull(true)
@Default(null)
2019-04-18 11:28:17 +02:00
@Is('VideoImportMagnetUri', value => throwIfNotValid(value, isVideoMagnetUriValid, 'magnetUri', true))
2018-08-06 17:13:39 +02:00
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_IMPORTS.URL.max)) // Use the same constraints than URLs
magnetUri: string
@AllowNull(true)
@Default(null)
@Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEO_IMPORTS.TORRENT_NAME.max))
torrentName: string
@AllowNull(false)
@Default(null)
@Is('VideoImportState', value => throwIfNotValid(value, isVideoImportStateValid, 'state'))
@Column
state: VideoImportState
@AllowNull(true)
@Default(null)
@Column(DataType.TEXT)
error: string
2018-08-07 10:07:53 +02:00
@ForeignKey(() => UserModel)
@Column
userId: number
@BelongsTo(() => UserModel, {
foreignKey: {
allowNull: false
},
onDelete: 'cascade'
})
User: UserModel
@ForeignKey(() => VideoModel)
@Column
videoId: number
@BelongsTo(() => VideoModel, {
foreignKey: {
2018-08-02 17:48:50 +02:00
allowNull: true
},
2018-08-02 17:48:50 +02:00
onDelete: 'set null'
})
Video: VideoModel
2018-08-02 17:48:50 +02:00
@AfterUpdate
static deleteVideoIfFailed (instance: VideoImportModel, options) {
if (instance.state === VideoImportState.FAILED) {
2021-02-09 11:22:42 +01:00
return afterCommitIfTransaction(options.transaction, () => instance.Video.destroy())
2018-08-02 17:48:50 +02:00
}
return undefined
}
2020-12-08 14:30:29 +01:00
static loadAndPopulateVideo (id: number): Promise<MVideoImportDefault> {
2019-02-21 14:28:06 +01:00
return VideoImportModel.findByPk(id)
}
static listUserVideoImportsForApi (options: {
userId: number
start: number
count: number
sort: string
targetUrl?: string
}) {
const { userId, start, count, sort, targetUrl } = options
const where: WhereOptions = { userId }
if (targetUrl) where['targetUrl'] = targetUrl
2018-08-02 17:48:50 +02:00
const query = {
2018-08-03 16:23:45 +02:00
distinct: true,
2018-08-02 17:48:50 +02:00
include: [
{
2020-04-15 14:15:44 +02:00
attributes: [ 'id' ],
2018-08-07 10:07:53 +02:00
model: UserModel.unscoped(), // FIXME: Without this, sequelize try to COUNT(DISTINCT(*)) which is an invalid SQL query
required: true
2018-08-02 17:48:50 +02:00
}
2018-08-07 10:07:53 +02:00
],
offset: start,
limit: count,
order: getSort(sort),
where
2018-08-02 17:48:50 +02:00
}
return Promise.all([
VideoImportModel.unscoped().count(query),
VideoImportModel.findAll<MVideoImportDefault>(query)
]).then(([ total, data ]) => ({ total, data }))
2018-08-02 17:48:50 +02:00
}
getTargetIdentifier () {
return this.targetUrl || this.magnetUri || this.torrentName
}
2019-08-20 19:05:31 +02:00
toFormattedJSON (this: MVideoImportFormattable): VideoImport {
const videoFormatOptions = {
completeDescription: true,
additionalAttributes: { state: true, waitTranscoding: true, scheduledUpdate: true }
}
2018-08-02 17:48:50 +02:00
const video = this.Video
? Object.assign(this.Video.toFormattedJSON(videoFormatOptions), { tags: this.Video.Tags.map(t => t.name) })
2018-08-02 17:48:50 +02:00
: undefined
return {
2018-08-03 09:27:30 +02:00
id: this.id,
2018-08-07 09:54:36 +02:00
targetUrl: this.targetUrl,
2018-08-07 09:54:36 +02:00
magnetUri: this.magnetUri,
torrentName: this.torrentName,
2018-08-02 17:48:50 +02:00
state: {
id: this.state,
label: VideoImportModel.getStateLabel(this.state)
},
2018-08-03 09:27:30 +02:00
error: this.error,
2018-08-02 17:48:50 +02:00
updatedAt: this.updatedAt.toISOString(),
createdAt: this.createdAt.toISOString(),
video
}
}
2018-08-02 17:48:50 +02:00
private static getStateLabel (id: number) {
return VIDEO_IMPORT_STATES[id] || 'Unknown'
}
}