1 import { sample } from 'lodash'
2 import { literal, Op, QueryTypes, Transaction, WhereOptions } from 'sequelize'
16 } from 'sequelize-typescript'
17 import { getServerActor } from '@server/models/application/application'
18 import { MActor, MVideoForRedundancyAPI, MVideoRedundancy, MVideoRedundancyAP, MVideoRedundancyVideo } from '@server/types/models'
19 import { AttributesOnly } from '@shared/core-utils'
20 import { VideoRedundanciesTarget } from '@shared/models/redundancy/video-redundancies-filters.model'
22 FileRedundancyInformation,
23 StreamingPlaylistRedundancyInformation,
25 } from '@shared/models/redundancy/video-redundancy.model'
26 import { CacheFileObject, VideoPrivacy } from '../../../shared'
27 import { VideoRedundancyStrategy, VideoRedundancyStrategyWithManual } from '../../../shared/models/redundancy'
28 import { isTestInstance } from '../../helpers/core-utils'
29 import { isActivityPubUrlValid, isUrlValid } from '../../helpers/custom-validators/activitypub/misc'
30 import { logger } from '../../helpers/logger'
31 import { CONFIG } from '../../initializers/config'
32 import { CONSTRAINTS_FIELDS, MIMETYPES } from '../../initializers/constants'
33 import { ActorModel } from '../actor/actor'
34 import { ServerModel } from '../server/server'
35 import { getSort, getVideoSort, parseAggregateResult, throwIfNotValid } from '../utils'
36 import { ScheduleVideoUpdateModel } from '../video/schedule-video-update'
37 import { VideoModel } from '../video/video'
38 import { VideoChannelModel } from '../video/video-channel'
39 import { VideoFileModel } from '../video/video-file'
40 import { VideoStreamingPlaylistModel } from '../video/video-streaming-playlist'
42 export enum ScopeNames {
43 WITH_VIDEO = 'WITH_VIDEO'
47 [ScopeNames.WITH_VIDEO]: {
50 model: VideoFileModel,
60 model: VideoStreamingPlaylistModel,
74 tableName: 'videoRedundancy',
77 fields: [ 'videoFileId' ]
88 export class VideoRedundancyModel extends Model<Partial<AttributesOnly<VideoRedundancyModel>>> {
101 @Is('VideoRedundancyFileUrl', value => throwIfNotValid(value, isUrlValid, 'fileUrl'))
102 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS_REDUNDANCY.URL.max))
106 @Is('VideoRedundancyUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
107 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS_REDUNDANCY.URL.max))
112 strategy: string // Only used by us
114 @ForeignKey(() => VideoFileModel)
118 @BelongsTo(() => VideoFileModel, {
124 VideoFile: VideoFileModel
126 @ForeignKey(() => VideoStreamingPlaylistModel)
128 videoStreamingPlaylistId: number
130 @BelongsTo(() => VideoStreamingPlaylistModel, {
136 VideoStreamingPlaylist: VideoStreamingPlaylistModel
138 @ForeignKey(() => ActorModel)
142 @BelongsTo(() => ActorModel, {
151 static async removeFile (instance: VideoRedundancyModel) {
152 if (!instance.isOwned()) return
154 if (instance.videoFileId) {
155 const videoFile = await VideoFileModel.loadWithVideo(instance.videoFileId)
157 const logIdentifier = `${videoFile.Video.uuid}-${videoFile.resolution}`
158 logger.info('Removing duplicated video file %s.', logIdentifier)
160 videoFile.Video.removeFile(videoFile, true)
161 .catch(err => logger.error('Cannot delete %s files.', logIdentifier, { err }))
164 if (instance.videoStreamingPlaylistId) {
165 const videoStreamingPlaylist = await VideoStreamingPlaylistModel.loadWithVideo(instance.videoStreamingPlaylistId)
167 const videoUUID = videoStreamingPlaylist.Video.uuid
168 logger.info('Removing duplicated video streaming playlist %s.', videoUUID)
170 videoStreamingPlaylist.Video.removeStreamingPlaylistFiles(videoStreamingPlaylist, true)
171 .catch(err => logger.error('Cannot delete video streaming playlist files of %s.', videoUUID, { err }))
177 static async loadLocalByFileId (videoFileId: number): Promise<MVideoRedundancyVideo> {
178 const actor = await getServerActor()
187 return VideoRedundancyModel.scope(ScopeNames.WITH_VIDEO).findOne(query)
190 static async listLocalByVideoId (videoId: number): Promise<MVideoRedundancyVideo[]> {
191 const actor = await getServerActor()
193 const queryStreamingPlaylist = {
199 model: VideoStreamingPlaylistModel.unscoped(),
203 model: VideoModel.unscoped(),
220 model: VideoFileModel,
236 VideoRedundancyModel.findAll(queryStreamingPlaylist),
237 VideoRedundancyModel.findAll(queryFiles)
238 ]).then(([ r1, r2 ]) => r1.concat(r2))
241 static async loadLocalByStreamingPlaylistId (videoStreamingPlaylistId: number): Promise<MVideoRedundancyVideo> {
242 const actor = await getServerActor()
247 videoStreamingPlaylistId
251 return VideoRedundancyModel.scope(ScopeNames.WITH_VIDEO).findOne(query)
254 static loadByIdWithVideo (id: number, transaction?: Transaction): Promise<MVideoRedundancyVideo> {
260 return VideoRedundancyModel.scope(ScopeNames.WITH_VIDEO).findOne(query)
263 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoRedundancy> {
271 return VideoRedundancyModel.findOne(query)
274 static async isLocalByVideoUUIDExists (uuid: string) {
275 const actor = await getServerActor()
279 attributes: [ 'id' ],
286 model: VideoFileModel,
302 return VideoRedundancyModel.findOne(query)
306 static async getVideoSample (p: Promise<VideoModel[]>) {
308 if (rows.length === 0) return undefined
310 const ids = rows.map(r => r.id)
311 const id = sample(ids)
313 return VideoModel.loadWithFiles(id, undefined, !isTestInstance())
316 static async findMostViewToDuplicate (randomizedFactor: number) {
317 const peertubeActor = await getServerActor()
321 attributes: [ 'id', 'views' ],
322 limit: randomizedFactor,
323 order: getVideoSort('-views'),
325 privacy: VideoPrivacy.PUBLIC,
327 ...this.buildVideoIdsForDuplication(peertubeActor)
330 VideoRedundancyModel.buildServerRedundancyInclude()
334 return VideoRedundancyModel.getVideoSample(VideoModel.unscoped().findAll(query))
337 static async findTrendingToDuplicate (randomizedFactor: number) {
338 const peertubeActor = await getServerActor()
342 attributes: [ 'id', 'views' ],
344 group: 'VideoModel.id',
345 limit: randomizedFactor,
346 order: getVideoSort('-trending'),
348 privacy: VideoPrivacy.PUBLIC,
350 ...this.buildVideoIdsForDuplication(peertubeActor)
353 VideoRedundancyModel.buildServerRedundancyInclude(),
355 VideoModel.buildTrendingQuery(CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS)
359 return VideoRedundancyModel.getVideoSample(VideoModel.unscoped().findAll(query))
362 static async findRecentlyAddedToDuplicate (randomizedFactor: number, minViews: number) {
363 const peertubeActor = await getServerActor()
367 attributes: [ 'id', 'publishedAt' ],
368 limit: randomizedFactor,
369 order: getVideoSort('-publishedAt'),
371 privacy: VideoPrivacy.PUBLIC,
376 ...this.buildVideoIdsForDuplication(peertubeActor)
379 VideoRedundancyModel.buildServerRedundancyInclude(),
381 // Required by publishedAt sort
383 model: ScheduleVideoUpdateModel.unscoped(),
389 return VideoRedundancyModel.getVideoSample(VideoModel.unscoped().findAll(query))
392 static async loadOldestLocalExpired (strategy: VideoRedundancyStrategy, expiresAfterMs: number): Promise<MVideoRedundancyVideo> {
393 const expiredDate = new Date()
394 expiredDate.setMilliseconds(expiredDate.getMilliseconds() - expiresAfterMs)
396 const actor = await getServerActor()
408 return VideoRedundancyModel.scope([ ScopeNames.WITH_VIDEO ]).findOne(query)
411 static async listLocalExpired () {
412 const actor = await getServerActor()
423 return VideoRedundancyModel.scope([ ScopeNames.WITH_VIDEO ]).findAll(query)
426 static async listRemoteExpired () {
427 const actor = await getServerActor()
441 return VideoRedundancyModel.scope([ ScopeNames.WITH_VIDEO ]).findAll(query)
444 static async listLocalOfServer (serverId: number) {
445 const actor = await getServerActor()
446 const buildVideoInclude = () => ({
452 model: VideoChannelModel.unscoped(),
457 model: ActorModel.unscoped(),
474 model: VideoFileModel,
476 include: [ buildVideoInclude() ]
479 model: VideoStreamingPlaylistModel,
481 include: [ buildVideoInclude() ]
486 return VideoRedundancyModel.findAll(query)
489 static listForApi (options: {
493 target: VideoRedundanciesTarget
496 const { start, count, sort, target, strategy } = options
497 const redundancyWhere: WhereOptions = {}
498 const videosWhere: WhereOptions = {}
499 let redundancySqlSuffix = ''
501 if (target === 'my-videos') {
502 Object.assign(videosWhere, { remote: false })
503 } else if (target === 'remote-videos') {
504 Object.assign(videosWhere, { remote: true })
505 Object.assign(redundancyWhere, { strategy: { [Op.ne]: null } })
506 redundancySqlSuffix = ' AND "videoRedundancy"."strategy" IS NOT NULL'
510 Object.assign(redundancyWhere, { strategy: strategy })
513 const videoFilterWhere = {
521 'SELECT "videoId" FROM "videoFile" ' +
522 'INNER JOIN "videoRedundancy" ON "videoRedundancy"."videoFileId" = "videoFile".id' +
523 redundancySqlSuffix +
532 'select "videoId" FROM "videoStreamingPlaylist" ' +
533 'INNER JOIN "videoRedundancy" ON "videoRedundancy"."videoStreamingPlaylistId" = "videoStreamingPlaylist".id' +
534 redundancySqlSuffix +
546 // /!\ On video model /!\
547 const findOptions = {
550 order: getSort(sort),
554 model: VideoFileModel,
557 model: VideoRedundancyModel.unscoped(),
559 where: redundancyWhere
565 model: VideoStreamingPlaylistModel.unscoped(),
568 model: VideoRedundancyModel.unscoped(),
570 where: redundancyWhere
573 model: VideoFileModel,
579 where: videoFilterWhere
582 // /!\ On video model /!\
583 const countOptions = {
584 where: videoFilterWhere
588 VideoModel.findAll(findOptions),
590 VideoModel.count(countOptions)
591 ]).then(([ data, total ]) => ({ total, data }))
594 static async getStats (strategy: VideoRedundancyStrategyWithManual) {
595 const actor = await getServerActor()
597 const sql = `WITH "tmp" AS ` +
599 `SELECT "videoFile"."size" AS "videoFileSize", "videoStreamingFile"."size" AS "videoStreamingFileSize", ` +
600 `"videoFile"."videoId" AS "videoFileVideoId", "videoStreamingPlaylist"."videoId" AS "videoStreamingVideoId"` +
601 `FROM "videoRedundancy" AS "videoRedundancy" ` +
602 `LEFT JOIN "videoFile" AS "videoFile" ON "videoRedundancy"."videoFileId" = "videoFile"."id" ` +
603 `LEFT JOIN "videoStreamingPlaylist" ON "videoRedundancy"."videoStreamingPlaylistId" = "videoStreamingPlaylist"."id" ` +
604 `LEFT JOIN "videoFile" AS "videoStreamingFile" ` +
605 `ON "videoStreamingPlaylist"."id" = "videoStreamingFile"."videoStreamingPlaylistId" ` +
606 `WHERE "videoRedundancy"."strategy" = :strategy AND "videoRedundancy"."actorId" = :actorId` +
609 `SELECT "videoFileVideoId" AS "videoId" FROM "tmp" ` +
610 `UNION SELECT "videoStreamingVideoId" AS "videoId" FROM "tmp" ` +
613 `COALESCE(SUM("videoFileSize"), '0') + COALESCE(SUM("videoStreamingFileSize"), '0') AS "totalUsed", ` +
614 `(SELECT COUNT("videoIds"."videoId") FROM "videoIds") AS "totalVideos", ` +
615 `COUNT(*) AS "totalVideoFiles" ` +
618 return VideoRedundancyModel.sequelize.query<any>(sql, {
619 replacements: { strategy, actorId: actor.id },
620 type: QueryTypes.SELECT
621 }).then(([ row ]) => ({
622 totalUsed: parseAggregateResult(row.totalUsed),
623 totalVideos: row.totalVideos,
624 totalVideoFiles: row.totalVideoFiles
628 static toFormattedJSONStatic (video: MVideoForRedundancyAPI): VideoRedundancy {
629 const filesRedundancies: FileRedundancyInformation[] = []
630 const streamingPlaylistsRedundancies: StreamingPlaylistRedundancyInformation[] = []
632 for (const file of video.VideoFiles) {
633 for (const redundancy of file.RedundancyVideos) {
634 filesRedundancies.push({
636 fileUrl: redundancy.fileUrl,
637 strategy: redundancy.strategy,
638 createdAt: redundancy.createdAt,
639 updatedAt: redundancy.updatedAt,
640 expiresOn: redundancy.expiresOn,
646 for (const playlist of video.VideoStreamingPlaylists) {
647 const size = playlist.VideoFiles.reduce((a, b) => a + b.size, 0)
649 for (const redundancy of playlist.RedundancyVideos) {
650 streamingPlaylistsRedundancies.push({
652 fileUrl: redundancy.fileUrl,
653 strategy: redundancy.strategy,
654 createdAt: redundancy.createdAt,
655 updatedAt: redundancy.updatedAt,
656 expiresOn: redundancy.expiresOn,
669 files: filesRedundancies,
670 streamingPlaylists: streamingPlaylistsRedundancies
676 if (this.VideoFile?.Video) return this.VideoFile.Video
678 if (this.VideoStreamingPlaylist?.Video) return this.VideoStreamingPlaylist.Video
684 return !!this.strategy
687 toActivityPubObject (this: MVideoRedundancyAP): CacheFileObject {
688 if (this.VideoStreamingPlaylist) {
691 type: 'CacheFile' as 'CacheFile',
692 object: this.VideoStreamingPlaylist.Video.url,
693 expires: this.expiresOn ? this.expiresOn.toISOString() : null,
696 mediaType: 'application/x-mpegURL',
704 type: 'CacheFile' as 'CacheFile',
705 object: this.VideoFile.Video.url,
706 expires: this.expiresOn ? this.expiresOn.toISOString() : null,
709 mediaType: MIMETYPES.VIDEO.EXT_MIMETYPE[this.VideoFile.extname] as any,
711 height: this.VideoFile.resolution,
712 size: this.VideoFile.size,
713 fps: this.VideoFile.fps
718 // Don't include video files we already duplicated
719 private static buildVideoIdsForDuplication (peertubeActor: MActor) {
720 const notIn = literal(
722 `SELECT "videoFile"."videoId" AS "videoId" FROM "videoRedundancy" ` +
723 `INNER JOIN "videoFile" ON "videoFile"."id" = "videoRedundancy"."videoFileId" ` +
724 `WHERE "videoRedundancy"."actorId" = ${peertubeActor.id} ` +
726 `SELECT "videoStreamingPlaylist"."videoId" AS "videoId" FROM "videoRedundancy" ` +
727 `INNER JOIN "videoStreamingPlaylist" ON "videoStreamingPlaylist"."id" = "videoRedundancy"."videoStreamingPlaylistId" ` +
728 `WHERE "videoRedundancy"."actorId" = ${peertubeActor.id} ` +
739 private static buildServerRedundancyInclude () {
742 model: VideoChannelModel.unscoped(),
747 model: ActorModel.unscoped(),
752 model: ServerModel.unscoped(),
755 redundancyAllowed: true