1 import Bluebird from 'bluebird'
2 import { remove } from 'fs-extra'
3 import { maxBy, minBy } from 'lodash'
4 import { join } from 'path'
5 import { FindOptions, Includeable, IncludeOptions, Op, QueryTypes, ScopeOptions, Sequelize, Transaction, WhereOptions } from 'sequelize'
26 } from 'sequelize-typescript'
27 import { getPrivaciesForFederation, isPrivacyForFederation, isStateForFederation } from '@server/helpers/video'
28 import { LiveManager } from '@server/lib/live/live-manager'
29 import { removeHLSFileObjectStorageByFilename, removeHLSObjectStorage, removeWebTorrentObjectStorage } from '@server/lib/object-storage'
30 import { tracer } from '@server/lib/opentelemetry/tracing'
31 import { getHLSDirectory, getHLSRedundancyDirectory, getHlsResolutionPlaylistFilename } from '@server/lib/paths'
32 import { VideoPathManager } from '@server/lib/video-path-manager'
33 import { isVideoInPrivateDirectory } from '@server/lib/video-privacy'
34 import { getServerActor } from '@server/models/application/application'
35 import { ModelCache } from '@server/models/shared/model-cache'
36 import { buildVideoEmbedPath, buildVideoWatchPath, pick } from '@shared/core-utils'
37 import { ffprobePromise, getAudioStream, hasAudioStream, uuidToShort } from '@shared/extra-utils'
51 VideoStreamingPlaylistType
52 } from '@shared/models'
53 import { AttributesOnly } from '@shared/typescript-utils'
54 import { peertubeTruncate } from '../../helpers/core-utils'
55 import { isActivityPubUrlValid } from '../../helpers/custom-validators/activitypub/misc'
56 import { exists, isBooleanValid, isUUIDValid } from '../../helpers/custom-validators/misc'
58 isVideoDescriptionValid,
64 } from '../../helpers/custom-validators/videos'
65 import { getVideoStreamDimensionsInfo } from '../../helpers/ffmpeg'
66 import { logger } from '../../helpers/logger'
67 import { CONFIG } from '../../initializers/config'
68 import { ACTIVITY_PUB, API_VERSION, CONSTRAINTS_FIELDS, LAZY_STATIC_PATHS, STATIC_PATHS, WEBSERVER } from '../../initializers/constants'
69 import { sendDeleteVideo } from '../../lib/activitypub/send'
72 MChannelAccountDefault,
75 MStreamingPlaylistFilesVideo,
80 MVideoAccountLightBlacklistAllFiles,
85 MVideoFormattableDetails,
91 MVideoThumbnailBlacklist,
94 } from '../../types/models'
95 import { MThumbnail } from '../../types/models/video/thumbnail'
96 import { MVideoFile, MVideoFileStreamingPlaylistVideo } from '../../types/models/video/video-file'
97 import { VideoAbuseModel } from '../abuse/video-abuse'
98 import { AccountModel } from '../account/account'
99 import { AccountVideoRateModel } from '../account/account-video-rate'
100 import { ActorModel } from '../actor/actor'
101 import { ActorImageModel } from '../actor/actor-image'
102 import { VideoRedundancyModel } from '../redundancy/video-redundancy'
103 import { ServerModel } from '../server/server'
104 import { TrackerModel } from '../server/tracker'
105 import { VideoTrackerModel } from '../server/video-tracker'
106 import { buildTrigramSearchIndex, buildWhereIdOrUUID, getVideoSort, isOutdated, setAsUpdated, throwIfNotValid } from '../shared'
107 import { UserModel } from '../user/user'
108 import { UserVideoHistoryModel } from '../user/user-video-history'
109 import { VideoViewModel } from '../view/video-view'
111 videoFilesModelToFormattedJSON,
112 VideoFormattingJSONOptions,
113 videoModelToActivityPubObject,
114 videoModelToFormattedDetailsJSON,
115 videoModelToFormattedJSON
116 } from './formatter/video-format-utils'
117 import { ScheduleVideoUpdateModel } from './schedule-video-update'
119 BuildVideosListQueryOptions,
120 DisplayOnlyForFollowerOptions,
121 VideoModelGetQueryBuilder,
122 VideosIdListQueryBuilder,
123 VideosModelListQueryBuilder
125 import { TagModel } from './tag'
126 import { ThumbnailModel } from './thumbnail'
127 import { VideoBlacklistModel } from './video-blacklist'
128 import { VideoCaptionModel } from './video-caption'
129 import { ScopeNames as VideoChannelScopeNames, SummaryOptions, VideoChannelModel } from './video-channel'
130 import { VideoCommentModel } from './video-comment'
131 import { VideoFileModel } from './video-file'
132 import { VideoImportModel } from './video-import'
133 import { VideoJobInfoModel } from './video-job-info'
134 import { VideoLiveModel } from './video-live'
135 import { VideoPlaylistElementModel } from './video-playlist-element'
136 import { VideoShareModel } from './video-share'
137 import { VideoSourceModel } from './video-source'
138 import { VideoStreamingPlaylistModel } from './video-streaming-playlist'
139 import { VideoTagModel } from './video-tag'
141 export enum ScopeNames {
143 WITH_ACCOUNT_DETAILS = 'WITH_ACCOUNT_DETAILS',
144 WITH_TAGS = 'WITH_TAGS',
145 WITH_WEBTORRENT_FILES = 'WITH_WEBTORRENT_FILES',
146 WITH_SCHEDULED_UPDATE = 'WITH_SCHEDULED_UPDATE',
147 WITH_BLACKLISTED = 'WITH_BLACKLISTED',
148 WITH_STREAMING_PLAYLISTS = 'WITH_STREAMING_PLAYLISTS',
149 WITH_IMMUTABLE_ATTRIBUTES = 'WITH_IMMUTABLE_ATTRIBUTES',
150 WITH_USER_HISTORY = 'WITH_USER_HISTORY',
151 WITH_THUMBNAILS = 'WITH_THUMBNAILS'
154 export type ForAPIOptions = {
157 videoPlaylistId?: number
159 withAccountBlockerIds?: number[]
163 [ScopeNames.WITH_IMMUTABLE_ATTRIBUTES]: {
164 attributes: [ 'id', 'url', 'uuid', 'remote' ]
166 [ScopeNames.FOR_API]: (options: ForAPIOptions) => {
167 const include: Includeable[] = [
169 model: VideoChannelModel.scope({
171 VideoChannelScopeNames.SUMMARY, {
173 withAccountBlockerIds: options.withAccountBlockerIds
180 attributes: [ 'type', 'filename' ],
181 model: ThumbnailModel,
186 const query: FindOptions = {}
196 if (options.videoPlaylistId) {
198 model: VideoPlaylistElementModel.unscoped(),
201 videoPlaylistId: options.videoPlaylistId
206 query.include = include
210 [ScopeNames.WITH_THUMBNAILS]: {
213 model: ThumbnailModel,
218 [ScopeNames.WITH_ACCOUNT_DETAILS]: {
221 model: VideoChannelModel.unscoped(),
226 exclude: [ 'privateKey', 'publicKey' ]
228 model: ActorModel.unscoped(),
232 attributes: [ 'host' ],
233 model: ServerModel.unscoped(),
237 model: ActorImageModel,
244 model: AccountModel.unscoped(),
248 model: ActorModel.unscoped(),
250 exclude: [ 'privateKey', 'publicKey' ]
255 attributes: [ 'host' ],
256 model: ServerModel.unscoped(),
260 model: ActorImageModel,
272 [ScopeNames.WITH_TAGS]: {
273 include: [ TagModel ]
275 [ScopeNames.WITH_BLACKLISTED]: {
278 attributes: [ 'id', 'reason', 'unfederated' ],
279 model: VideoBlacklistModel,
284 [ScopeNames.WITH_WEBTORRENT_FILES]: (withRedundancies = false) => {
285 let subInclude: any[] = []
287 if (withRedundancies === true) {
290 attributes: [ 'fileUrl' ],
291 model: VideoRedundancyModel.unscoped(),
300 model: VideoFileModel,
308 [ScopeNames.WITH_STREAMING_PLAYLISTS]: (withRedundancies = false) => {
309 const subInclude: IncludeOptions[] = [
311 model: VideoFileModel,
316 if (withRedundancies === true) {
318 attributes: [ 'fileUrl' ],
319 model: VideoRedundancyModel.unscoped(),
327 model: VideoStreamingPlaylistModel.unscoped(),
335 [ScopeNames.WITH_SCHEDULED_UPDATE]: {
338 model: ScheduleVideoUpdateModel.unscoped(),
343 [ScopeNames.WITH_USER_HISTORY]: (userId: number) => {
347 attributes: [ 'currentTime' ],
348 model: UserVideoHistoryModel.unscoped(),
361 buildTrigramSearchIndex('video_name_trigram', 'name'),
363 { fields: [ 'createdAt' ] },
366 { name: 'publishedAt', order: 'DESC' },
367 { name: 'id', order: 'ASC' }
370 { fields: [ 'duration' ] },
373 { name: 'views', order: 'DESC' },
374 { name: 'id', order: 'ASC' }
377 { fields: [ 'channelId' ] },
379 fields: [ 'originallyPublishedAt' ],
381 originallyPublishedAt: {
387 fields: [ 'category' ], // We don't care videos with an unknown category
395 fields: [ 'licence' ], // We don't care videos with an unknown licence
403 fields: [ 'language' ], // We don't care videos with an unknown language
411 fields: [ 'nsfw' ], // Most of the videos are not NSFW
417 fields: [ 'remote' ], // Only index local videos
432 export class VideoModel extends Model<Partial<AttributesOnly<VideoModel>>> {
435 @Default(DataType.UUIDV4)
437 @Column(DataType.UUID)
441 @Is('VideoName', value => throwIfNotValid(value, isVideoNameValid, 'name'))
457 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.LANGUAGE.max))
461 @Is('VideoPrivacy', value => throwIfNotValid(value, isVideoPrivacyValid, 'privacy'))
463 privacy: VideoPrivacy
466 @Is('VideoNSFW', value => throwIfNotValid(value, isBooleanValid, 'NSFW boolean'))
472 @Is('VideoDescription', value => throwIfNotValid(value, isVideoDescriptionValid, 'description', true))
473 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.DESCRIPTION.max))
478 @Is('VideoSupport', value => throwIfNotValid(value, isVideoSupportValid, 'support', true))
479 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.SUPPORT.max))
483 @Is('VideoDuration', value => throwIfNotValid(value, isVideoDurationValid, 'duration'))
518 @Is('VideoUrl', value => throwIfNotValid(value, isActivityPubUrlValid, 'url'))
519 @Column(DataType.STRING(CONSTRAINTS_FIELDS.VIDEOS.URL.max))
524 commentsEnabled: boolean
528 downloadEnabled: boolean
532 waitTranscoding: boolean
536 @Is('VideoState', value => throwIfNotValid(value, isVideoStateValid, 'state'))
547 @Default(DataType.NOW)
554 originallyPublishedAt: Date
556 @ForeignKey(() => VideoChannelModel)
560 @BelongsTo(() => VideoChannelModel, {
566 VideoChannel: VideoChannelModel
568 @BelongsToMany(() => TagModel, {
569 foreignKey: 'videoId',
570 through: () => VideoTagModel,
575 @BelongsToMany(() => TrackerModel, {
576 foreignKey: 'videoId',
577 through: () => VideoTrackerModel,
580 Trackers: TrackerModel[]
582 @HasMany(() => ThumbnailModel, {
590 Thumbnails: ThumbnailModel[]
592 @HasMany(() => VideoPlaylistElementModel, {
599 VideoPlaylistElements: VideoPlaylistElementModel[]
601 @HasOne(() => VideoSourceModel, {
608 VideoSource: VideoSourceModel
610 @HasMany(() => VideoAbuseModel, {
617 VideoAbuses: VideoAbuseModel[]
619 @HasMany(() => VideoFileModel, {
627 VideoFiles: VideoFileModel[]
629 @HasMany(() => VideoStreamingPlaylistModel, {
637 VideoStreamingPlaylists: VideoStreamingPlaylistModel[]
639 @HasMany(() => VideoShareModel, {
646 VideoShares: VideoShareModel[]
648 @HasMany(() => AccountVideoRateModel, {
655 AccountVideoRates: AccountVideoRateModel[]
657 @HasMany(() => VideoCommentModel, {
665 VideoComments: VideoCommentModel[]
667 @HasMany(() => VideoViewModel, {
674 VideoViews: VideoViewModel[]
676 @HasMany(() => UserVideoHistoryModel, {
683 UserVideoHistories: UserVideoHistoryModel[]
685 @HasOne(() => ScheduleVideoUpdateModel, {
692 ScheduleVideoUpdate: ScheduleVideoUpdateModel
694 @HasOne(() => VideoBlacklistModel, {
701 VideoBlacklist: VideoBlacklistModel
703 @HasOne(() => VideoLiveModel, {
710 VideoLive: VideoLiveModel
712 @HasOne(() => VideoImportModel, {
719 VideoImport: VideoImportModel
721 @HasMany(() => VideoCaptionModel, {
728 ['separate' as any]: true
730 VideoCaptions: VideoCaptionModel[]
732 @HasOne(() => VideoJobInfoModel, {
739 VideoJobInfo: VideoJobInfoModel
742 static async sendDelete (instance: MVideoAccountLight, options) {
743 if (!instance.isOwned()) return undefined
745 // Lazy load channels
746 if (!instance.VideoChannel) {
747 instance.VideoChannel = await instance.$get('VideoChannel', {
752 transaction: options.transaction
753 }) as MChannelAccountDefault
756 return sendDeleteVideo(instance, options.transaction)
760 static async removeFiles (instance: VideoModel, options) {
761 const tasks: Promise<any>[] = []
763 logger.info('Removing files of video %s.', instance.url)
765 if (instance.isOwned()) {
766 if (!Array.isArray(instance.VideoFiles)) {
767 instance.VideoFiles = await instance.$get('VideoFiles', { transaction: options.transaction })
770 // Remove physical files and torrents
771 instance.VideoFiles.forEach(file => {
772 tasks.push(instance.removeWebTorrentFile(file))
775 // Remove playlists file
776 if (!Array.isArray(instance.VideoStreamingPlaylists)) {
777 instance.VideoStreamingPlaylists = await instance.$get('VideoStreamingPlaylists', { transaction: options.transaction })
780 for (const p of instance.VideoStreamingPlaylists) {
781 tasks.push(instance.removeStreamingPlaylistFiles(p))
785 // Do not wait video deletion because we could be in a transaction
787 .then(() => logger.info('Removed files of video %s.', instance.url))
788 .catch(err => logger.error('Some errors when removing files of video %s in before destroy hook.', instance.uuid, { err }))
794 static stopLiveIfNeeded (instance: VideoModel) {
795 if (!instance.isLive) return
797 logger.info('Stopping live of video %s after video deletion.', instance.uuid)
799 LiveManager.Instance.stopSessionOf(instance.id, null)
803 static invalidateCache (instance: VideoModel) {
804 ModelCache.Instance.invalidateCache('video', instance.id)
808 static async saveEssentialDataToAbuses (instance: VideoModel, options) {
809 const tasks: Promise<any>[] = []
811 if (!Array.isArray(instance.VideoAbuses)) {
812 instance.VideoAbuses = await instance.$get('VideoAbuses', { transaction: options.transaction })
814 if (instance.VideoAbuses.length === 0) return undefined
817 logger.info('Saving video abuses details of video %s.', instance.url)
819 if (!instance.Trackers) instance.Trackers = await instance.$get('Trackers', { transaction: options.transaction })
820 const details = instance.toFormattedDetailsJSON()
822 for (const abuse of instance.VideoAbuses) {
823 abuse.deletedVideo = details
824 tasks.push(abuse.save({ transaction: options.transaction }))
827 await Promise.all(tasks)
830 static listLocalIds (): Promise<number[]> {
832 attributes: [ 'id' ],
839 return VideoModel.findAll(query)
840 .then(rows => rows.map(r => r.id))
843 static listAllAndSharedByActorForOutbox (actorId: number, start: number, count: number) {
844 function getRawQuery (select: string) {
845 const queryVideo = 'SELECT ' + select + ' FROM "video" AS "Video" ' +
846 'INNER JOIN "videoChannel" AS "VideoChannel" ON "VideoChannel"."id" = "Video"."channelId" ' +
847 'INNER JOIN "account" AS "Account" ON "Account"."id" = "VideoChannel"."accountId" ' +
848 'WHERE "Account"."actorId" = ' + actorId
849 const queryVideoShare = 'SELECT ' + select + ' FROM "videoShare" AS "VideoShare" ' +
850 'INNER JOIN "video" AS "Video" ON "Video"."id" = "VideoShare"."videoId" ' +
851 'WHERE "VideoShare"."actorId" = ' + actorId
853 return `(${queryVideo}) UNION (${queryVideoShare})`
856 const rawQuery = getRawQuery('"Video"."id"')
857 const rawCountQuery = getRawQuery('COUNT("Video"."id") as "total"')
863 order: getVideoSort('-createdAt', [ 'Tags', 'name', 'ASC' ]),
866 [Op.in]: Sequelize.literal('(' + rawQuery + ')')
868 [Op.or]: getPrivaciesForFederation()
872 attributes: [ 'filename', 'language', 'fileUrl' ],
873 model: VideoCaptionModel.unscoped(),
877 attributes: [ 'id', 'url' ],
878 model: VideoShareModel.unscoped(),
880 // We only want videos shared by this actor
895 attributes: [ 'id', 'url' ],
896 model: ActorModel.unscoped()
901 model: VideoChannelModel.unscoped(),
905 attributes: [ 'name' ],
906 model: AccountModel.unscoped(),
910 attributes: [ 'id', 'url', 'followersUrl' ],
911 model: ActorModel.unscoped(),
917 attributes: [ 'id', 'url', 'followersUrl' ],
918 model: ActorModel.unscoped(),
924 model: VideoStreamingPlaylistModel.unscoped(),
928 model: VideoFileModel,
933 VideoLiveModel.unscoped(),
939 return Bluebird.all([
940 VideoModel.scope(ScopeNames.WITH_THUMBNAILS).findAll(query),
941 VideoModel.sequelize.query<{ total: string }>(rawCountQuery, { type: QueryTypes.SELECT })
942 ]).then(([ rows, totals ]) => {
943 // totals: totalVideos + totalVideoShares
945 let totalVideoShares = 0
946 if (totals[0]) totalVideos = parseInt(totals[0].total, 10)
947 if (totals[1]) totalVideoShares = parseInt(totals[1].total, 10)
949 const total = totalVideos + totalVideoShares
957 static async listPublishedLiveUUIDs () {
959 attributes: [ 'uuid' ],
963 state: VideoState.PUBLISHED
967 const result = await VideoModel.findAll(options)
969 return result.map(v => v.uuid)
972 static listUserVideosForApi (options: {
982 const { accountId, channelId, start, count, sort, search, isLive } = options
984 function buildBaseQuery (forCount: boolean): FindOptions {
985 const where: WhereOptions = {}
989 [Op.iLike]: '%' + search + '%'
993 if (exists(isLive)) {
994 where.isLive = isLive
997 const channelWhere = channelId
1005 order: getVideoSort(sort),
1009 ? VideoChannelModel.unscoped()
1010 : VideoChannelModel,
1012 where: channelWhere,
1016 ? AccountModel.unscoped()
1031 const countQuery = buildBaseQuery(true)
1032 const findQuery = buildBaseQuery(false)
1034 const findScopes: (string | ScopeOptions)[] = [
1035 ScopeNames.WITH_SCHEDULED_UPDATE,
1036 ScopeNames.WITH_BLACKLISTED,
1037 ScopeNames.WITH_THUMBNAILS
1040 return Promise.all([
1041 VideoModel.count(countQuery),
1042 VideoModel.scope(findScopes).findAll<MVideoForUser>(findQuery)
1043 ]).then(([ count, rows ]) => {
1051 static async listForApi (options: {
1059 include?: VideoInclude
1061 hasFiles?: boolean // default false
1062 hasWebtorrentFiles?: boolean
1063 hasHLSFiles?: boolean
1065 categoryOneOf?: number[]
1066 licenceOneOf?: number[]
1067 languageOneOf?: string[]
1068 tagsOneOf?: string[]
1069 tagsAllOf?: string[]
1070 privacyOneOf?: VideoPrivacy[]
1073 videoChannelId?: number
1075 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1077 videoPlaylistId?: number
1079 trendingDays?: number
1081 user?: MUserAccountId
1082 historyOfUser?: MUserId
1084 countVideos?: boolean
1088 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1089 VideoModel.throwIfPrivacyOneOfWithoutUser(options.privacyOneOf, options.user)
1091 const trendingDays = options.sort.endsWith('trending')
1092 ? CONFIG.TRENDING.VIDEOS.INTERVAL_DAYS
1095 let trendingAlgorithm: string
1096 if (options.sort.endsWith('hot')) trendingAlgorithm = 'hot'
1097 if (options.sort.endsWith('best')) trendingAlgorithm = 'best'
1099 const serverActor = await getServerActor()
1101 const queryOptions = {
1116 'displayOnlyForFollower',
1124 'hasWebtorrentFiles',
1128 serverAccountIdForBlock: serverActor.Account.id,
1133 return VideoModel.getAvailableForApi(queryOptions, options.countVideos)
1136 static async searchAndPopulateAccountAndServer (options: {
1144 include?: VideoInclude
1146 categoryOneOf?: number[]
1147 licenceOneOf?: number[]
1148 languageOneOf?: string[]
1149 tagsOneOf?: string[]
1150 tagsAllOf?: string[]
1151 privacyOneOf?: VideoPrivacy[]
1153 displayOnlyForFollower: DisplayOnlyForFollowerOptions | null
1155 user?: MUserAccountId
1157 hasWebtorrentFiles?: boolean
1158 hasHLSFiles?: boolean
1163 startDate?: string // ISO 8601
1164 endDate?: string // ISO 8601
1165 originallyPublishedStartDate?: string
1166 originallyPublishedEndDate?: string
1168 durationMin?: number // seconds
1169 durationMax?: number // seconds
1172 VideoModel.throwIfPrivateIncludeWithoutUser(options.include, options.user)
1173 VideoModel.throwIfPrivacyOneOfWithoutUser(options.privacyOneOf, options.user)
1175 const serverActor = await getServerActor()
1177 const queryOptions = {
1196 'originallyPublishedStartDate',
1197 'originallyPublishedEndDate',
1201 'hasWebtorrentFiles',
1204 'displayOnlyForFollower'
1206 serverAccountIdForBlock: serverActor.Account.id
1209 return VideoModel.getAvailableForApi(queryOptions)
1212 static countLives (options: {
1214 mode: 'published' | 'not-ended'
1218 remote: options.remote,
1220 state: options.mode === 'not-ended'
1221 ? { [Op.ne]: VideoState.LIVE_ENDED }
1222 : { [Op.eq]: VideoState.PUBLISHED }
1226 return VideoModel.count(query)
1229 static countVideosUploadedByUserSince (userId: number, since: Date) {
1233 model: VideoChannelModel.unscoped(),
1237 model: AccountModel.unscoped(),
1241 model: UserModel.unscoped(),
1259 return VideoModel.unscoped().count(options)
1262 static countLivesOfAccount (accountId: number) {
1268 [Op.ne]: VideoState.LIVE_ENDED
1274 model: VideoChannelModel.unscoped(),
1282 return VideoModel.count(options)
1285 static load (id: number | string, transaction?: Transaction): Promise<MVideoThumbnail> {
1286 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1288 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails' })
1291 static loadWithBlacklist (id: number | string, transaction?: Transaction): Promise<MVideoThumbnailBlacklist> {
1292 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1294 return queryBuilder.queryVideo({ id, transaction, type: 'thumbnails-blacklist' })
1297 static loadImmutableAttributes (id: number | string, t?: Transaction): Promise<MVideoImmutable> {
1300 where: buildWhereIdOrUUID(id),
1304 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1307 return ModelCache.Instance.doCache({
1308 cacheType: 'load-video-immutable-id',
1315 static loadByUrlImmutableAttributes (url: string, transaction?: Transaction): Promise<MVideoImmutable> {
1317 const query: FindOptions = {
1324 return VideoModel.scope(ScopeNames.WITH_IMMUTABLE_ATTRIBUTES).findOne(query)
1327 return ModelCache.Instance.doCache({
1328 cacheType: 'load-video-immutable-url',
1335 static loadOnlyId (id: number | string, transaction?: Transaction): Promise<MVideoId> {
1336 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1338 return queryBuilder.queryVideo({ id, transaction, type: 'id' })
1341 static loadWithFiles (id: number | string, transaction?: Transaction, logging?: boolean): Promise<MVideoWithAllFiles> {
1342 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1344 return queryBuilder.queryVideo({ id, transaction, type: 'all-files', logging })
1347 static loadByUrl (url: string, transaction?: Transaction): Promise<MVideoThumbnail> {
1348 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1350 return queryBuilder.queryVideo({ url, transaction, type: 'thumbnails' })
1353 static loadByUrlAndPopulateAccount (url: string, transaction?: Transaction): Promise<MVideoAccountLightBlacklistAllFiles> {
1354 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1356 return queryBuilder.queryVideo({ url, transaction, type: 'account-blacklist-files' })
1359 static loadFull (id: number | string, t?: Transaction, userId?: number): Promise<MVideoFullLight> {
1360 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1362 return queryBuilder.queryVideo({ id, transaction: t, type: 'full', userId })
1365 static loadForGetAPI (parameters: {
1367 transaction?: Transaction
1369 }): Promise<MVideoDetails> {
1370 const { id, transaction, userId } = parameters
1371 const queryBuilder = new VideoModelGetQueryBuilder(VideoModel.sequelize)
1373 return queryBuilder.queryVideo({ id, transaction, type: 'api', userId })
1376 static async getStats () {
1377 const serverActor = await getServerActor()
1379 let totalLocalVideoViews = await VideoModel.sum('views', {
1385 // Sequelize could return null...
1386 if (!totalLocalVideoViews) totalLocalVideoViews = 0
1388 const baseOptions = {
1391 sort: '-publishedAt',
1393 displayOnlyForFollower: {
1394 actorId: serverActor.id,
1399 const { total: totalLocalVideos } = await VideoModel.listForApi({
1405 const { total: totalVideos } = await VideoModel.listForApi(baseOptions)
1409 totalLocalVideoViews,
1414 static incrementViews (id: number, views: number) {
1415 return VideoModel.increment('views', {
1423 static updateRatesOf (videoId: number, type: VideoRateType, count: number, t: Transaction) {
1424 const field = type === 'like'
1428 const rawQuery = `UPDATE "video" SET "${field}" = :count WHERE "video"."id" = :videoId`
1430 return AccountVideoRateModel.sequelize.query(rawQuery, {
1432 replacements: { videoId, rateType: type, count },
1433 type: QueryTypes.UPDATE
1437 static syncLocalRates (videoId: number, type: VideoRateType, t: Transaction) {
1438 const field = type === 'like'
1442 const rawQuery = `UPDATE "video" SET "${field}" = ` +
1444 'SELECT COUNT(id) FROM "accountVideoRate" WHERE "accountVideoRate"."videoId" = "video"."id" AND type = :rateType' +
1446 'WHERE "video"."id" = :videoId'
1448 return AccountVideoRateModel.sequelize.query(rawQuery, {
1450 replacements: { videoId, rateType: type },
1451 type: QueryTypes.UPDATE
1455 static checkVideoHasInstanceFollow (videoId: number, followerActorId: number) {
1456 // Instances only share videos
1457 const query = 'SELECT 1 FROM "videoShare" ' +
1458 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "videoShare"."actorId" ' +
1459 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "videoShare"."videoId" = $videoId ' +
1461 'SELECT 1 FROM "video" ' +
1462 'INNER JOIN "videoChannel" ON "videoChannel"."id" = "video"."channelId" ' +
1463 'INNER JOIN "account" ON "account"."id" = "videoChannel"."accountId" ' +
1464 'INNER JOIN "actorFollow" ON "actorFollow"."targetActorId" = "account"."actorId" ' +
1465 'WHERE "actorFollow"."actorId" = $followerActorId AND "actorFollow"."state" = \'accepted\' AND "video"."id" = $videoId ' +
1469 type: QueryTypes.SELECT as QueryTypes.SELECT,
1470 bind: { followerActorId, videoId },
1474 return VideoModel.sequelize.query(query, options)
1475 .then(results => results.length === 1)
1478 static bulkUpdateSupportField (ofChannel: MChannel, t: Transaction) {
1481 channelId: ofChannel.id
1486 return VideoModel.update({ support: ofChannel.support }, options)
1489 static getAllIdsFromChannel (videoChannel: MChannelId): Promise<number[]> {
1491 attributes: [ 'id' ],
1493 channelId: videoChannel.id
1497 return VideoModel.findAll(query)
1498 .then(videos => videos.map(v => v.id))
1501 // threshold corresponds to how many video the field should have to be returned
1502 static async getRandomFieldSamples (field: 'category' | 'channelId', threshold: number, count: number) {
1503 const serverActor = await getServerActor()
1505 const queryOptions: BuildVideosListQueryOptions = {
1506 attributes: [ `"${field}"` ],
1507 group: `GROUP BY "${field}"`,
1508 having: `HAVING COUNT("${field}") >= ${threshold}`,
1512 serverAccountIdForBlock: serverActor.Account.id,
1513 displayOnlyForFollower: {
1514 actorId: serverActor.id,
1519 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
1521 return queryBuilder.queryVideoIds(queryOptions)
1522 .then(rows => rows.map(r => r[field]))
1525 static buildTrendingQuery (trendingDays: number) {
1529 model: VideoViewModel,
1534 [Op.gte as any]: new Date(new Date().getTime() - (24 * 3600 * 1000) * trendingDays)
1540 private static async getAvailableForApi (
1541 options: BuildVideosListQueryOptions,
1543 ): Promise<ResultList<VideoModel>> {
1544 const span = tracer.startSpan('peertube.VideoModel.getAvailableForApi')
1546 function getCount () {
1547 if (countVideos !== true) return Promise.resolve(undefined)
1549 const countOptions = Object.assign({}, options, { isCount: true })
1550 const queryBuilder = new VideosIdListQueryBuilder(VideoModel.sequelize)
1552 return queryBuilder.countVideoIds(countOptions)
1555 function getModels () {
1556 if (options.count === 0) return Promise.resolve([])
1558 const queryBuilder = new VideosModelListQueryBuilder(VideoModel.sequelize)
1560 return queryBuilder.queryVideos(options)
1563 const [ count, rows ] = await Promise.all([ getCount(), getModels() ])
1573 private static throwIfPrivateIncludeWithoutUser (include: VideoInclude, user: MUserAccountId) {
1574 if (VideoModel.isPrivateInclude(include) && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1575 throw new Error('Try to filter all-local but user cannot see all videos')
1579 private static throwIfPrivacyOneOfWithoutUser (privacyOneOf: VideoPrivacy[], user: MUserAccountId) {
1580 if (privacyOneOf && !user?.hasRight(UserRight.SEE_ALL_VIDEOS)) {
1581 throw new Error('Try to choose video privacies but user cannot see all videos')
1585 private static isPrivateInclude (include: VideoInclude) {
1586 return include & VideoInclude.BLACKLISTED ||
1587 include & VideoInclude.BLOCKED_OWNER ||
1588 include & VideoInclude.NOT_PUBLISHED_STATE
1592 return !!this.VideoBlacklist
1596 return this.VideoChannel.Account.Actor.Server?.isBlocked() || this.VideoChannel.Account.isBlocked()
1599 getQualityFileBy<T extends MVideoWithFile> (this: T, fun: (files: MVideoFile[], it: (file: MVideoFile) => number) => MVideoFile) {
1600 const files = this.getAllFiles()
1601 const file = fun(files, file => file.resolution)
1602 if (!file) return undefined
1605 return Object.assign(file, { Video: this })
1608 if (file.videoStreamingPlaylistId) {
1609 const streamingPlaylistWithVideo = Object.assign(this.VideoStreamingPlaylists[0], { Video: this })
1611 return Object.assign(file, { VideoStreamingPlaylist: streamingPlaylistWithVideo })
1614 throw new Error('File is not associated to a video of a playlist')
1617 getMaxQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1618 return this.getQualityFileBy(maxBy)
1621 getMinQualityFile<T extends MVideoWithFile> (this: T): MVideoFileVideo | MVideoFileStreamingPlaylistVideo {
1622 return this.getQualityFileBy(minBy)
1625 getWebTorrentFile<T extends MVideoWithFile> (this: T, resolution: number): MVideoFileVideo {
1626 if (Array.isArray(this.VideoFiles) === false) return undefined
1628 const file = this.VideoFiles.find(f => f.resolution === resolution)
1629 if (!file) return undefined
1631 return Object.assign(file, { Video: this })
1634 hasWebTorrentFiles () {
1635 return Array.isArray(this.VideoFiles) === true && this.VideoFiles.length !== 0
1638 async addAndSaveThumbnail (thumbnail: MThumbnail, transaction?: Transaction) {
1639 thumbnail.videoId = this.id
1641 const savedThumbnail = await thumbnail.save({ transaction })
1643 if (Array.isArray(this.Thumbnails) === false) this.Thumbnails = []
1645 this.Thumbnails = this.Thumbnails.filter(t => t.id !== savedThumbnail.id)
1646 this.Thumbnails.push(savedThumbnail)
1650 if (Array.isArray(this.Thumbnails) === false) return undefined
1652 return this.Thumbnails.find(t => t.type === ThumbnailType.MINIATURE)
1656 return !!this.getPreview()
1660 if (Array.isArray(this.Thumbnails) === false) return undefined
1662 return this.Thumbnails.find(t => t.type === ThumbnailType.PREVIEW)
1666 return this.remote === false
1669 getWatchStaticPath () {
1670 return buildVideoWatchPath({ shortUUID: uuidToShort(this.uuid) })
1673 getEmbedStaticPath () {
1674 return buildVideoEmbedPath(this)
1677 getMiniatureStaticPath () {
1678 const thumbnail = this.getMiniature()
1679 if (!thumbnail) return null
1681 return join(STATIC_PATHS.THUMBNAILS, thumbnail.filename)
1684 getPreviewStaticPath () {
1685 const preview = this.getPreview()
1686 if (!preview) return null
1688 // We use a local cache, so specify our cache endpoint instead of potential remote URL
1689 return join(LAZY_STATIC_PATHS.PREVIEWS, preview.filename)
1692 toFormattedJSON (this: MVideoFormattable, options?: VideoFormattingJSONOptions): Video {
1693 return videoModelToFormattedJSON(this, options)
1696 toFormattedDetailsJSON (this: MVideoFormattableDetails): VideoDetails {
1697 return videoModelToFormattedDetailsJSON(this)
1700 getFormattedVideoFilesJSON (includeMagnet = true): VideoFile[] {
1701 let files: VideoFile[] = []
1703 if (Array.isArray(this.VideoFiles)) {
1704 const result = videoFilesModelToFormattedJSON(this, this.VideoFiles, { includeMagnet })
1705 files = files.concat(result)
1708 for (const p of (this.VideoStreamingPlaylists || [])) {
1709 const result = videoFilesModelToFormattedJSON(this, p.VideoFiles, { includeMagnet })
1710 files = files.concat(result)
1716 toActivityPubObject (this: MVideoAP): VideoObject {
1717 return videoModelToActivityPubObject(this)
1720 getTruncatedDescription () {
1721 if (!this.description) return null
1723 const maxLength = CONSTRAINTS_FIELDS.VIDEOS.TRUNCATED_DESCRIPTION.max
1724 return peertubeTruncate(this.description, { length: maxLength })
1728 let files: MVideoFile[] = []
1730 if (Array.isArray(this.VideoFiles)) {
1731 files = files.concat(this.VideoFiles)
1734 if (Array.isArray(this.VideoStreamingPlaylists)) {
1735 for (const p of this.VideoStreamingPlaylists) {
1736 if (Array.isArray(p.VideoFiles)) {
1737 files = files.concat(p.VideoFiles)
1745 probeMaxQualityFile () {
1746 const file = this.getMaxQualityFile()
1747 const videoOrPlaylist = file.getVideoOrStreamingPlaylist()
1749 return VideoPathManager.Instance.makeAvailableVideoFile(file.withVideoOrPlaylist(videoOrPlaylist), async originalFilePath => {
1750 const probe = await ffprobePromise(originalFilePath)
1752 const { audioStream } = await getAudioStream(originalFilePath, probe)
1753 const hasAudio = await hasAudioStream(originalFilePath, probe)
1759 ...await getVideoStreamDimensionsInfo(originalFilePath, probe)
1764 getDescriptionAPIPath () {
1765 return `/api/${API_VERSION}/videos/${this.uuid}/description`
1768 getHLSPlaylist (): MStreamingPlaylistFilesVideo {
1769 if (!this.VideoStreamingPlaylists) return undefined
1771 const playlist = this.VideoStreamingPlaylists.find(p => p.type === VideoStreamingPlaylistType.HLS)
1772 if (!playlist) return undefined
1774 return playlist.withVideo(this)
1777 setHLSPlaylist (playlist: MStreamingPlaylist) {
1778 const toAdd = [ playlist ] as [ VideoStreamingPlaylistModel ]
1780 if (Array.isArray(this.VideoStreamingPlaylists) === false || this.VideoStreamingPlaylists.length === 0) {
1781 this.VideoStreamingPlaylists = toAdd
1785 this.VideoStreamingPlaylists = this.VideoStreamingPlaylists
1786 .filter(s => s.type !== VideoStreamingPlaylistType.HLS)
1790 removeWebTorrentFile (videoFile: MVideoFile, isRedundancy = false) {
1791 const filePath = isRedundancy
1792 ? VideoPathManager.Instance.getFSRedundancyVideoFilePath(this, videoFile)
1793 : VideoPathManager.Instance.getFSVideoFileOutputPath(this, videoFile)
1795 const promises: Promise<any>[] = [ remove(filePath) ]
1796 if (!isRedundancy) promises.push(videoFile.removeTorrent())
1798 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1799 promises.push(removeWebTorrentObjectStorage(videoFile))
1802 return Promise.all(promises)
1805 async removeStreamingPlaylistFiles (streamingPlaylist: MStreamingPlaylist, isRedundancy = false) {
1806 const directoryPath = isRedundancy
1807 ? getHLSRedundancyDirectory(this)
1808 : getHLSDirectory(this)
1810 await remove(directoryPath)
1812 if (isRedundancy !== true) {
1813 const streamingPlaylistWithFiles = streamingPlaylist as MStreamingPlaylistFilesVideo
1814 streamingPlaylistWithFiles.Video = this
1816 if (!Array.isArray(streamingPlaylistWithFiles.VideoFiles)) {
1817 streamingPlaylistWithFiles.VideoFiles = await streamingPlaylistWithFiles.$get('VideoFiles')
1820 // Remove physical files and torrents
1822 streamingPlaylistWithFiles.VideoFiles.map(file => file.removeTorrent())
1825 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1826 await removeHLSObjectStorage(streamingPlaylist.withVideo(this))
1831 async removeStreamingPlaylistVideoFile (streamingPlaylist: MStreamingPlaylist, videoFile: MVideoFile) {
1832 const filePath = VideoPathManager.Instance.getFSHLSOutputPath(this, videoFile.filename)
1833 await videoFile.removeTorrent()
1834 await remove(filePath)
1836 const resolutionFilename = getHlsResolutionPlaylistFilename(videoFile.filename)
1837 await remove(VideoPathManager.Instance.getFSHLSOutputPath(this, resolutionFilename))
1839 if (videoFile.storage === VideoStorage.OBJECT_STORAGE) {
1840 await removeHLSFileObjectStorageByFilename(streamingPlaylist.withVideo(this), videoFile.filename)
1841 await removeHLSFileObjectStorageByFilename(streamingPlaylist.withVideo(this), resolutionFilename)
1845 async removeStreamingPlaylistFile (streamingPlaylist: MStreamingPlaylist, filename: string) {
1846 const filePath = VideoPathManager.Instance.getFSHLSOutputPath(this, filename)
1847 await remove(filePath)
1849 if (streamingPlaylist.storage === VideoStorage.OBJECT_STORAGE) {
1850 await removeHLSFileObjectStorageByFilename(streamingPlaylist.withVideo(this), filename)
1855 if (this.isOwned()) return false
1857 return isOutdated(this, ACTIVITY_PUB.VIDEO_REFRESH_INTERVAL)
1860 hasPrivacyForFederation () {
1861 return isPrivacyForFederation(this.privacy)
1864 hasStateForFederation () {
1865 return isStateForFederation(this.state)
1868 isNewVideo (newPrivacy: VideoPrivacy) {
1869 return this.hasPrivacyForFederation() === false && isPrivacyForFederation(newPrivacy) === true
1872 setAsRefreshed (transaction?: Transaction) {
1873 return setAsUpdated({ sequelize: this.sequelize, table: 'video', id: this.id, transaction })
1876 // ---------------------------------------------------------------------------
1878 requiresAuth (options: {
1880 checkBlacklist: boolean
1882 const { urlParamId, checkBlacklist } = options
1884 if (this.privacy === VideoPrivacy.PRIVATE || this.privacy === VideoPrivacy.INTERNAL) {
1888 if (this.privacy === VideoPrivacy.UNLISTED) {
1889 if (urlParamId && !isUUIDValid(urlParamId)) return true
1894 if (checkBlacklist && this.VideoBlacklist) return true
1896 if (this.privacy !== VideoPrivacy.PUBLIC) {
1897 throw new Error(`Unknown video privacy ${this.privacy} to know if the video requires auth`)
1903 hasPrivateStaticPath () {
1904 return isVideoInPrivateDirectory(this.privacy)
1907 // ---------------------------------------------------------------------------
1909 async setNewState (newState: VideoState, isNewVideo: boolean, transaction: Transaction) {
1910 if (this.state === newState) throw new Error('Cannot use same state ' + newState)
1912 this.state = newState
1914 if (this.state === VideoState.PUBLISHED && isNewVideo) {
1915 this.publishedAt = new Date()
1918 await this.save({ transaction })
1921 getBandwidthBits (this: MVideo, videoFile: MVideoFile) {
1922 if (!this.duration) throw new Error(`Cannot get bandwidth bits because video ${this.url} has duration of 0`)
1924 return Math.ceil((videoFile.size * 8) / this.duration)
1928 if (this.isOwned()) {
1930 WEBSERVER.URL + '/tracker/announce',
1931 WEBSERVER.WS + '://' + WEBSERVER.HOSTNAME + ':' + WEBSERVER.PORT + '/tracker/socket'
1935 return this.Trackers.map(t => t.url)