-import * as Sequelize from 'sequelize'
+import { remove } from 'fs-extra'
+import { join } from 'path'
+import { OrderItem, Transaction } from 'sequelize'
import {
AllowNull,
BeforeDestroy,
BelongsTo,
Column,
CreatedAt,
+ DataType,
ForeignKey,
Is,
Model,
Table,
UpdatedAt
} from 'sequelize-typescript'
-import { throwIfNotValid } from '../utils'
-import { VideoModel } from './video'
-import { isVideoCaptionLanguageValid } from '../../helpers/custom-validators/video-captions'
+import { v4 as uuidv4 } from 'uuid'
+import { MVideo, MVideoCaption, MVideoCaptionFormattable, MVideoCaptionVideo } from '@server/types/models'
import { VideoCaption } from '../../../shared/models/videos/caption/video-caption.model'
-import { STATIC_PATHS, VIDEO_LANGUAGES } from '../../initializers/constants'
-import { join } from 'path'
+import { isVideoCaptionLanguageValid } from '../../helpers/custom-validators/video-captions'
import { logger } from '../../helpers/logger'
-import { remove } from 'fs-extra'
import { CONFIG } from '../../initializers/config'
+import { CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, VIDEO_LANGUAGES, WEBSERVER } from '../../initializers/constants'
+import { buildWhereIdOrUUID, throwIfNotValid } from '../utils'
+import { VideoModel } from './video'
export enum ScopeNames {
WITH_VIDEO_UUID_AND_REMOTE = 'WITH_VIDEO_UUID_AND_REMOTE'
}
-@Scopes({
+@Scopes(() => ({
[ScopeNames.WITH_VIDEO_UUID_AND_REMOTE]: {
include: [
{
- attributes: [ 'uuid', 'remote' ],
- model: () => VideoModel.unscoped(),
+ attributes: [ 'id', 'uuid', 'remote' ],
+ model: VideoModel.unscoped(),
required: true
}
]
}
-})
+}))
@Table({
tableName: 'videoCaption',
indexes: [
+ {
+ fields: [ 'filename' ],
+ unique: true
+ },
{
fields: [ 'videoId' ]
},
}
]
})
-export class VideoCaptionModel extends Model<VideoCaptionModel> {
+export class VideoCaptionModel extends Model {
@CreatedAt
createdAt: Date
@Column
language: string
+ @AllowNull(false)
+ @Column
+ filename: string
+
+ @AllowNull(true)
+ @Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
+ fileUrl: string
+
@ForeignKey(() => VideoModel)
@Column
videoId: number
@BeforeDestroy
static async removeFiles (instance: VideoCaptionModel) {
if (!instance.Video) {
- instance.Video = await instance.$get('Video') as VideoModel
+ instance.Video = await instance.$get('Video')
}
if (instance.isOwned()) {
- logger.info('Removing captions %s of video %s.', instance.Video.uuid, instance.language)
+ logger.info('Removing caption %s.', instance.filename)
try {
await instance.removeCaptionFile()
} catch (err) {
- logger.error('Cannot remove caption file of video %s.', instance.Video.uuid)
+ logger.error('Cannot remove caption file %s.', instance.filename)
}
}
return undefined
}
- static loadByVideoIdAndLanguage (videoId: string | number, language: string) {
+ static loadByVideoIdAndLanguage (videoId: string | number, language: string): Promise<MVideoCaptionVideo> {
const videoInclude = {
model: VideoModel.unscoped(),
attributes: [ 'id', 'remote', 'uuid' ],
- where: { }
+ where: buildWhereIdOrUUID(videoId)
}
- if (typeof videoId === 'string') videoInclude.where['uuid'] = videoId
- else videoInclude.where['id'] = videoId
-
const query = {
where: {
language
return VideoCaptionModel.findOne(query)
}
- static insertOrReplaceLanguage (videoId: number, language: string, transaction: Sequelize.Transaction) {
- const values = {
- videoId,
- language
+ static loadWithVideoByFilename (filename: string): Promise<MVideoCaptionVideo> {
+ const query = {
+ where: {
+ filename
+ },
+ include: [
+ {
+ model: VideoModel.unscoped(),
+ attributes: [ 'id', 'remote', 'uuid' ]
+ }
+ ]
}
- return VideoCaptionModel.upsert<VideoCaptionModel>(values, { transaction, returning: true })
- .then(([ caption ]) => caption)
+ return VideoCaptionModel.findOne(query)
}
- static listVideoCaptions (videoId: number) {
+ static async insertOrReplaceLanguage (caption: MVideoCaption, transaction: Transaction) {
+ const existing = await VideoCaptionModel.loadByVideoIdAndLanguage(caption.videoId, caption.language)
+ // Delete existing file
+ if (existing) await existing.destroy({ transaction })
+
+ return caption.save({ transaction })
+ }
+
+ static listVideoCaptions (videoId: number): Promise<MVideoCaptionVideo[]> {
const query = {
- order: [ [ 'language', 'ASC' ] ],
+ order: [ [ 'language', 'ASC' ] ] as OrderItem[],
where: {
videoId
}
return VIDEO_LANGUAGES[language] || 'Unknown'
}
- static deleteAllCaptionsOfRemoteVideo (videoId: number, transaction: Sequelize.Transaction) {
+ static deleteAllCaptionsOfRemoteVideo (videoId: number, transaction: Transaction) {
const query = {
where: {
videoId
return VideoCaptionModel.destroy(query)
}
+ static generateCaptionName (language: string) {
+ return `${uuidv4()}-${language}.vtt`
+ }
+
isOwned () {
return this.Video.remote === false
}
- toFormattedJSON (): VideoCaption {
+ toFormattedJSON (this: MVideoCaptionFormattable): VideoCaption {
return {
language: {
id: this.language,
}
}
- getCaptionStaticPath () {
- return join(STATIC_PATHS.VIDEO_CAPTIONS, this.getCaptionName())
+ getCaptionStaticPath (this: MVideoCaption) {
+ return join(LAZY_STATIC_PATHS.VIDEO_CAPTIONS, this.filename)
}
- getCaptionName () {
- return `${this.Video.uuid}-${this.language}.vtt`
+ removeCaptionFile (this: MVideoCaption) {
+ return remove(CONFIG.STORAGE.CAPTIONS_DIR + this.filename)
}
- removeCaptionFile () {
- return remove(CONFIG.STORAGE.CAPTIONS_DIR + this.getCaptionName())
+ getFileUrl (video: MVideo) {
+ if (!this.Video) this.Video = video as VideoModel
+
+ if (video.isOwned()) return WEBSERVER.URL + this.getCaptionStaticPath()
+
+ return this.fileUrl
}
}