server/models/video/video-streaming-playlist.ts

   1 import { AllowNull, BelongsTo, Column, CreatedAt, DataType, ForeignKey, HasMany, Is, Model, Table, UpdatedAt } from 'sequelize-typescript'
   2 import { isVideoFileInfoHashValid } from '../../helpers/custom-validators/videos'
   3 import { throwIfNotValid } from '../utils'
   4 import { VideoModel } from './video'
   5 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
   6 import { VideoStreamingPlaylistType } from '../../../shared/models/videos/video-streaming-playlist.type'
   7 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
   8 import {
   9   CONSTRAINTS_FIELDS,
  10   MEMOIZE_LENGTH,
  11   MEMOIZE_TTL,
  12   P2P_MEDIA_LOADER_PEER_VERSION,
  13   STATIC_DOWNLOAD_PATHS,
  14   STATIC_PATHS
  15 } from '../../initializers/constants'
  16 import { join } from 'path'
  17 import { sha1 } from '../../helpers/core-utils'
  18 import { isArrayOf } from '../../helpers/custom-validators/misc'
  19 import { Op, QueryTypes } from 'sequelize'
  20 import { MStreamingPlaylist, MStreamingPlaylistVideo, MVideoFile } from '@server/types/models'
  21 import { VideoFileModel } from '@server/models/video/video-file'
  22 import { getTorrentFileName, getTorrentFilePath, getVideoFilename } from '@server/lib/video-paths'
  23 import * as memoizee from 'memoizee'
  24 import { remove } from 'fs-extra'
  25 import { logger } from '@server/helpers/logger'
  26
  27 @Table({
  28   tableName: 'videoStreamingPlaylist',
  29   indexes: [
  30     {
  31       fields: [ 'videoId' ]
  32     },
  33     {
  34       fields: [ 'videoId', 'type' ],
  35       unique: true
  36     },
  37     {
  38       fields: [ 'p2pMediaLoaderInfohashes' ],
  39       using: 'gin'
  40     }
  41   ]
  42 })
  43 export class VideoStreamingPlaylistModel extends Model<VideoStreamingPlaylistModel> {
  44   @CreatedAt
  45   createdAt: Date
  46
  47   @UpdatedAt
  48   updatedAt: Date
  49
  50   @AllowNull(false)
  51   @Column
  52   type: VideoStreamingPlaylistType
  53
  54   @AllowNull(false)
  55   @Is('PlaylistUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'playlist url'))
  56   @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
  57   playlistUrl: string
  58
  59   @AllowNull(false)
  60   @Is('VideoStreamingPlaylistInfoHashes', value => throwIfNotValid(value, v => isArrayOf(v, isVideoFileInfoHashValid), 'info hashes'))
  61   @Column(DataType.ARRAY(DataType.STRING))
  62   p2pMediaLoaderInfohashes: string[]
  63
  64   @AllowNull(false)
  65   @Column
  66   p2pMediaLoaderPeerVersion: number
  67
  68   @AllowNull(false)
  69   @Is('VideoStreamingSegmentsSha256Url', value => throwIfNotValid(value, isActivityPubUrlValid, 'segments sha256 url'))
  70   @Column
  71   segmentsSha256Url: string
  72
  73   @ForeignKey(() => VideoModel)
  74   @Column
  75   videoId: number
  76
  77   @BelongsTo(() => VideoModel, {
  78     foreignKey: {
  79       allowNull: false
  80     },
  81     onDelete: 'CASCADE'
  82   })
  83   Video: VideoModel
  84
  85   @HasMany(() => VideoFileModel, {
  86     foreignKey: {
  87       allowNull: true
  88     },
  89     onDelete: 'CASCADE'
  90   })
  91   VideoFiles: VideoFileModel[]
  92
  93   @HasMany(() => VideoRedundancyModel, {
  94     foreignKey: {
  95       allowNull: false
  96     },
  97     onDelete: 'CASCADE',
  98     hooks: true
  99   })
 100   RedundancyVideos: VideoRedundancyModel[]
 101
 102   static doesInfohashExistCached = memoizee(VideoStreamingPlaylistModel.doesInfohashExist, {
 103     promise: true,
 104     max: MEMOIZE_LENGTH.INFO_HASH_EXISTS,
 105     maxAge: MEMOIZE_TTL.INFO_HASH_EXISTS
 106   })
 107
 108   static doesInfohashExist (infoHash: string) {
 109     const query = 'SELECT 1 FROM "videoStreamingPlaylist" WHERE $infoHash = ANY("p2pMediaLoaderInfohashes") LIMIT 1'
 110     const options = {
 111       type: QueryTypes.SELECT as QueryTypes.SELECT,
 112       bind: { infoHash },
 113       raw: true
 114     }
 115
 116     return VideoModel.sequelize.query<object>(query, options)
 117               .then(results => results.length === 1)
 118   }
 119
 120   static buildP2PMediaLoaderInfoHashes (playlistUrl: string, files: unknown[]) {
 121     const hashes: string[] = []
 122
 123     // https://github.com/Novage/p2p-media-loader/blob/master/p2p-media-loader-core/lib/p2p-media-manager.ts#L115
 124     for (let i = 0; i < files.length; i++) {
 125       hashes.push(sha1(`${P2P_MEDIA_LOADER_PEER_VERSION}${playlistUrl}+V${i}`))
 126     }
 127
 128     return hashes
 129   }
 130
 131   static listByIncorrectPeerVersion () {
 132     const query = {
 133       where: {
 134         p2pMediaLoaderPeerVersion: {
 135           [Op.ne]: P2P_MEDIA_LOADER_PEER_VERSION
 136         }
 137       }
 138     }
 139
 140     return VideoStreamingPlaylistModel.findAll(query)
 141   }
 142
 143   static loadWithVideo (id: number) {
 144     const options = {
 145       include: [
 146         {
 147           model: VideoModel.unscoped(),
 148           required: true
 149         }
 150       ]
 151     }
 152
 153     return VideoStreamingPlaylistModel.findByPk(id, options)
 154   }
 155
 156   static getHlsPlaylistFilename (resolution: number) {
 157     return resolution + '.m3u8'
 158   }
 159
 160   static getMasterHlsPlaylistFilename () {
 161     return 'master.m3u8'
 162   }
 163
 164   static getHlsSha256SegmentsFilename () {
 165     return 'segments-sha256.json'
 166   }
 167
 168   static getHlsMasterPlaylistStaticPath (videoUUID: string) {
 169     return join(STATIC_PATHS.STREAMING_PLAYLISTS.HLS, videoUUID, VideoStreamingPlaylistModel.getMasterHlsPlaylistFilename())
 170   }
 171
 172   static getHlsPlaylistStaticPath (videoUUID: string, resolution: number) {
 173     return join(STATIC_PATHS.STREAMING_PLAYLISTS.HLS, videoUUID, VideoStreamingPlaylistModel.getHlsPlaylistFilename(resolution))
 174   }
 175
 176   static getHlsSha256SegmentsStaticPath (videoUUID: string) {
 177     return join(STATIC_PATHS.STREAMING_PLAYLISTS.HLS, videoUUID, VideoStreamingPlaylistModel.getHlsSha256SegmentsFilename())
 178   }
 179
 180   getStringType () {
 181     if (this.type === VideoStreamingPlaylistType.HLS) return 'hls'
 182
 183     return 'unknown'
 184   }
 185
 186   getVideoRedundancyUrl (baseUrlHttp: string) {
 187     return baseUrlHttp + STATIC_PATHS.REDUNDANCY + this.getStringType() + '/' + this.Video.uuid
 188   }
 189
 190   getTorrentDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
 191     return baseUrlHttp + STATIC_DOWNLOAD_PATHS.TORRENTS + getTorrentFileName(this, videoFile)
 192   }
 193
 194   getVideoFileDownloadUrl (videoFile: MVideoFile, baseUrlHttp: string) {
 195     return baseUrlHttp + STATIC_DOWNLOAD_PATHS.HLS_VIDEOS + getVideoFilename(this, videoFile)
 196   }
 197
 198   getVideoFileUrl (videoFile: MVideoFile, baseUrlHttp: string) {
 199     return baseUrlHttp + join(STATIC_PATHS.STREAMING_PLAYLISTS.HLS, this.Video.uuid, getVideoFilename(this, videoFile))
 200   }
 201
 202   getTorrentUrl (videoFile: MVideoFile, baseUrlHttp: string) {
 203     return baseUrlHttp + join(STATIC_PATHS.TORRENTS, getTorrentFileName(this, videoFile))
 204   }
 205
 206   getTrackerUrls (baseUrlHttp: string, baseUrlWs: string) {
 207     return [ baseUrlWs + '/tracker/socket', baseUrlHttp + '/tracker/announce' ]
 208   }
 209
 210   hasSameUniqueKeysThan (other: MStreamingPlaylist) {
 211     return this.type === other.type &&
 212       this.videoId === other.videoId
 213   }
 214
 215   removeTorrent (this: MStreamingPlaylistVideo, videoFile: MVideoFile) {
 216     const torrentPath = getTorrentFilePath(this, videoFile)
 217     return remove(torrentPath)
 218       .catch(err => logger.warn('Cannot delete torrent %s.', torrentPath, { err }))
 219   }
 220 }