123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194 |
- import { remove } from 'fs-extra'
- import { join } from 'path'
- import { OrderItem, Transaction } from 'sequelize'
- import {
- AllowNull,
- BeforeDestroy,
- BelongsTo,
- Column,
- CreatedAt,
- DataType,
- ForeignKey,
- Is,
- Model,
- Scopes,
- Table,
- UpdatedAt
- } from 'sequelize-typescript'
- import { buildRemoteVideoBaseUrl } from '@server/helpers/activitypub'
- import { MVideoAccountLight, MVideoCaptionFormattable, MVideoCaptionVideo } from '@server/types/models'
- import { VideoCaption } from '../../../shared/models/videos/caption/video-caption.model'
- import { isVideoCaptionLanguageValid } from '../../helpers/custom-validators/video-captions'
- import { logger } from '../../helpers/logger'
- 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(() => ({
- [ScopeNames.WITH_VIDEO_UUID_AND_REMOTE]: {
- include: [
- {
- attributes: [ 'id', 'uuid', 'remote' ],
- model: VideoModel.unscoped(),
- required: true
- }
- ]
- }
- }))
- @Table({
- tableName: 'videoCaption',
- indexes: [
- {
- fields: [ 'videoId' ]
- },
- {
- fields: [ 'videoId', 'language' ],
- unique: true
- }
- ]
- })
- export class VideoCaptionModel extends Model {
- @CreatedAt
- createdAt: Date
- @UpdatedAt
- updatedAt: Date
- @AllowNull(false)
- @Is('VideoCaptionLanguage', value => throwIfNotValid(value, isVideoCaptionLanguageValid, 'language'))
- @Column
- language: string
- @AllowNull(true)
- @Column(DataType.STRING(CONSTRAINTS_FIELDS.COMMONS.URL.max))
- fileUrl: string
- @ForeignKey(() => VideoModel)
- @Column
- videoId: number
- @BelongsTo(() => VideoModel, {
- foreignKey: {
- allowNull: false
- },
- onDelete: 'CASCADE'
- })
- Video: VideoModel
- @BeforeDestroy
- static async removeFiles (instance: VideoCaptionModel) {
- if (!instance.Video) {
- instance.Video = await instance.$get('Video')
- }
- if (instance.isOwned()) {
- logger.info('Removing captions %s of video %s.', instance.Video.uuid, instance.language)
- try {
- await instance.removeCaptionFile()
- } catch (err) {
- logger.error('Cannot remove caption file of video %s.', instance.Video.uuid)
- }
- }
- return undefined
- }
- static loadByVideoIdAndLanguage (videoId: string | number, language: string): Promise<MVideoCaptionVideo> {
- const videoInclude = {
- model: VideoModel.unscoped(),
- attributes: [ 'id', 'remote', 'uuid' ],
- where: buildWhereIdOrUUID(videoId)
- }
- const query = {
- where: {
- language
- },
- include: [
- videoInclude
- ]
- }
- return VideoCaptionModel.findOne(query)
- }
- static insertOrReplaceLanguage (videoId: number, language: string, fileUrl: string, transaction: Transaction) {
- const values = {
- videoId,
- language,
- fileUrl
- }
- return VideoCaptionModel.upsert(values, { transaction, returning: true })
- .then(([ caption ]) => caption)
- }
- static listVideoCaptions (videoId: number): Promise<MVideoCaptionVideo[]> {
- const query = {
- order: [ [ 'language', 'ASC' ] ] as OrderItem[],
- where: {
- videoId
- }
- }
- return VideoCaptionModel.scope(ScopeNames.WITH_VIDEO_UUID_AND_REMOTE).findAll(query)
- }
- static getLanguageLabel (language: string) {
- return VIDEO_LANGUAGES[language] || 'Unknown'
- }
- static deleteAllCaptionsOfRemoteVideo (videoId: number, transaction: Transaction) {
- const query = {
- where: {
- videoId
- },
- transaction
- }
- return VideoCaptionModel.destroy(query)
- }
- isOwned () {
- return this.Video.remote === false
- }
- toFormattedJSON (this: MVideoCaptionFormattable): VideoCaption {
- return {
- language: {
- id: this.language,
- label: VideoCaptionModel.getLanguageLabel(this.language)
- },
- captionPath: this.getCaptionStaticPath()
- }
- }
- getCaptionStaticPath (this: MVideoCaptionFormattable) {
- return join(LAZY_STATIC_PATHS.VIDEO_CAPTIONS, this.getCaptionName())
- }
- getCaptionName (this: MVideoCaptionFormattable) {
- return `${this.Video.uuid}-${this.language}.vtt`
- }
- removeCaptionFile (this: MVideoCaptionFormattable) {
- return remove(CONFIG.STORAGE.CAPTIONS_DIR + this.getCaptionName())
- }
- getFileUrl (video: MVideoAccountLight) {
- 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())
- }
- }
|