+import { remove } from 'fs-extra'
+import { join } from 'path'
import { OrderItem, Transaction } from 'sequelize'
import {
AllowNull,
Table,
UpdatedAt
} from 'sequelize-typescript'
-import { buildWhereIdOrUUID, throwIfNotValid } from '../utils'
-import { VideoModel } from './video'
-import { isVideoCaptionLanguageValid } from '../../helpers/custom-validators/video-captions'
+import { MVideo, MVideoCaption, MVideoCaptionFormattable, MVideoCaptionVideo } from '@server/types/models'
+import { buildUUID } from '@shared/extra-utils'
+import { AttributesOnly } from '@shared/typescript-utils'
import { VideoCaption } from '../../../shared/models/videos/caption/video-caption.model'
-import { CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, VIDEO_LANGUAGES, WEBSERVER } 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 * as Bluebird from 'bluebird'
-import { MVideoAccountLight, MVideoCaptionFormattable, MVideoCaptionVideo } from '@server/typings/models'
-import { buildRemoteVideoBaseUrl } from '@server/helpers/activitypub'
+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'
@Table({
tableName: 'videoCaption',
indexes: [
+ {
+ fields: [ 'filename' ],
+ unique: true
+ },
{
fields: [ 'videoId' ]
},
}
]
})
-export class VideoCaptionModel extends Model<VideoCaptionModel> {
+export class VideoCaptionModel extends Model<Partial<AttributesOnly<VideoCaptionModel>>> {
@CreatedAt
createdAt: Date
@Column
language: string
+ @AllowNull(false)
+ @Column
+ filename: string
+
@AllowNull(true)
@Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
fileUrl: string
Video: VideoModel
@BeforeDestroy
- static async removeFiles (instance: VideoCaptionModel) {
+ static async removeFiles (instance: VideoCaptionModel, options) {
if (!instance.Video) {
- instance.Video = await instance.$get('Video')
+ instance.Video = await instance.$get('Video', { transaction: options.transaction })
}
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): Bluebird<MVideoCaptionVideo> {
+ static loadByVideoIdAndLanguage (videoId: string | number, language: string, transaction?: Transaction): Promise<MVideoCaptionVideo> {
const videoInclude = {
model: VideoModel.unscoped(),
attributes: [ 'id', 'remote', 'uuid' ],
},
include: [
videoInclude
- ]
+ ],
+ transaction
}
return VideoCaptionModel.findOne(query)
}
- static insertOrReplaceLanguage (videoId: number, language: string, fileUrl: string, transaction: Transaction) {
- const values = {
- videoId,
- language,
- fileUrl
+ static loadWithVideoByFilename (filename: string): Promise<MVideoCaptionVideo> {
+ const query = {
+ where: {
+ filename
+ },
+ include: [
+ {
+ model: VideoModel.unscoped(),
+ attributes: [ 'id', 'remote', 'uuid' ]
+ }
+ ]
}
- return VideoCaptionModel.upsert(values, { transaction, returning: true })
- .then(([ caption ]) => caption)
+ return VideoCaptionModel.findOne(query)
+ }
+
+ static async insertOrReplaceLanguage (caption: MVideoCaption, transaction: Transaction) {
+ const existing = await VideoCaptionModel.loadByVideoIdAndLanguage(caption.videoId, caption.language, transaction)
+
+ // Delete existing file
+ if (existing) await existing.destroy({ transaction })
+
+ return caption.save({ transaction })
}
- static listVideoCaptions (videoId: number): Bluebird<MVideoCaptionVideo[]> {
+ static listVideoCaptions (videoId: number, transaction?: Transaction): Promise<MVideoCaptionVideo[]> {
const query = {
order: [ [ 'language', 'ASC' ] ] as OrderItem[],
where: {
videoId
- }
+ },
+ transaction
}
return VideoCaptionModel.scope(ScopeNames.WITH_VIDEO_UUID_AND_REMOTE).findAll(query)
return VideoCaptionModel.destroy(query)
}
+ static generateCaptionName (language: string) {
+ return `${buildUUID()}-${language}.vtt`
+ }
+
isOwned () {
return this.Video.remote === false
}
id: this.language,
label: VideoCaptionModel.getLanguageLabel(this.language)
},
- captionPath: this.getCaptionStaticPath()
+ captionPath: this.getCaptionStaticPath(),
+ updatedAt: this.updatedAt.toISOString()
}
}
- getCaptionStaticPath (this: MVideoCaptionFormattable) {
- return join(LAZY_STATIC_PATHS.VIDEO_CAPTIONS, this.getCaptionName())
+ getCaptionStaticPath (this: MVideoCaption) {
+ return join(LAZY_STATIC_PATHS.VIDEO_CAPTIONS, this.filename)
}
- getCaptionName (this: MVideoCaptionFormattable) {
- return `${this.Video.uuid}-${this.language}.vtt`
+ removeCaptionFile (this: MVideoCaption) {
+ return remove(CONFIG.STORAGE.CAPTIONS_DIR + this.filename)
}
- removeCaptionFile (this: MVideoCaptionFormattable) {
- return remove(CONFIG.STORAGE.CAPTIONS_DIR + this.getCaptionName())
- }
-
- getFileUrl (video: MVideoAccountLight) {
+ getFileUrl (video: MVideo) {
if (!this.Video) this.Video = video as VideoModel
if (video.isOwned()) return WEBSERVER.URL + this.getCaptionStaticPath()
- if (this.fileUrl) return this.fileUrl
- // Fallback if we don't have a file URL
- return buildRemoteVideoBaseUrl(video, this.getCaptionStaticPath())
+ return this.fileUrl
+ }
+
+ isEqual (this: MVideoCaption, other: MVideoCaption) {
+ if (this.fileUrl) return this.fileUrl === other.fileUrl
+
+ return this.filename === other.filename
}
}