Fix live ending banner

[github/Chocobozzz/PeerTube.git] / server / models / video / video-caption.ts

diff --git a/server/models/video/video-caption.ts b/server/models/video/video-caption.ts
index a01565851d2d0bfc621c33ceefec5fb1b949eb52..bfdec73e9849012947ab2af3ad88e19dbb43f80b 100644 (file)
--- a/server/models/video/video-caption.ts
+++ b/server/models/video/video-caption.ts
@@ -1,3 +1,5 @@
+import { remove } from 'fs-extra'
+import { join } from 'path'
 import { OrderItem, Transaction } from 'sequelize'
 import {
   AllowNull,
@@ -5,6 +7,7 @@ import {
   BelongsTo,
   Column,
   CreatedAt,
+  DataType,
   ForeignKey,
   Is,
   Model,
@@ -12,15 +15,15 @@ import {
   Table,
   UpdatedAt
 } from 'sequelize-typescript'
-import { buildWhereIdOrUUID, 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 { LAZY_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'
@@ -30,7 +33,7 @@ export enum ScopeNames {
   [ScopeNames.WITH_VIDEO_UUID_AND_REMOTE]: {
     include: [
       {
-        attributes: [ 'uuid', 'remote' ],
+        attributes: [ 'id', 'uuid', 'remote' ],
         model: VideoModel.unscoped(),
         required: true
       }
@@ -41,6 +44,10 @@ export enum ScopeNames {
 @Table({
   tableName: 'videoCaption',
   indexes: [
+    {
+      fields: [ 'filename' ],
+      unique: true
+    },
     {
       fields: [ 'videoId' ]
     },
@@ -50,7 +57,7 @@ export enum ScopeNames {
     }
   ]
 })
-export class VideoCaptionModel extends Model<VideoCaptionModel> {
+export class VideoCaptionModel extends Model {
   @CreatedAt
   createdAt: Date
 
@@ -62,6 +69,14 @@ export class VideoCaptionModel extends Model<VideoCaptionModel> {
   @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
@@ -77,23 +92,23 @@ export class VideoCaptionModel extends Model<VideoCaptionModel> {
   @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' ],
@@ -112,17 +127,31 @@ export class VideoCaptionModel extends Model<VideoCaptionModel> {
     return VideoCaptionModel.findOne(query)
   }
 
-  static insertOrReplaceLanguage (videoId: number, language: string, transaction: 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 }) as any) // FIXME: typings
-      .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' ] ] as OrderItem[],
       where: {
@@ -148,11 +177,15 @@ export class VideoCaptionModel extends Model<VideoCaptionModel> {
     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,
@@ -162,15 +195,19 @@ export class VideoCaptionModel extends Model<VideoCaptionModel> {
     }
   }
 
-  getCaptionStaticPath () {
-    return join(LAZY_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
   }
 }